Aruba Central Next Gen icon

Aruba Central Next Gen

Consume Aruba Central Next Gen API

Actions408

Scope Management → Remove Devices from Device Collection

AI-generated

Overview

This node operation removes specified devices from a device collection within the Scope Management resource of the Aruba Central Next Gen API. It is useful for managing device collections by dynamically updating their membership, such as removing devices that are no longer relevant or needed in a particular scope. For example, an administrator can remove devices by their serial numbers from a specific device collection identified by its scope ID.

Use Case Examples

  1. Remove devices with serial numbers SN123456 and SN789012 from a device collection with scope ID abc123-def456 in the Configuration domain.
  2. Use debug mode to enable detailed logs for troubleshooting the removal process.

Properties

Name Meaning
Debug Mode Whether to enable detailed debug logs for troubleshooting.
Domain API domain to interact with, such as monitoring, configuration, interfaces, routing, network services, security, management, or system.
Source Scope ID The scopeId of the device collection to remove devices from.
Devices Comma-separated list of device serial numbers to remove from the device collection.

Output

JSON

  • removedDevices - List or confirmation of devices removed from the device collection.
  • operationStatus - Status of the remove devices operation, indicating success or failure.

Dependencies

  • Aruba Central Next Gen API with OAuth2 authentication

Troubleshooting

  • Ensure the provided Source Scope ID is correct and exists in the system.
  • Verify that the device serial numbers are valid and currently part of the device collection.
  • Enable Debug Mode to get detailed logs for troubleshooting issues.
  • Common error messages may include authorization errors if the OAuth2 credentials are invalid or expired, or validation errors if required parameters are missing or malformed.

Discussion