Aruba Central Next Gen icon

Aruba Central Next Gen

Consume Aruba Central Next Gen API

Actions408

Scope Management → Get Scope Hierarchy

AI-generated

Overview

This node operation retrieves the hierarchy information for a specified scope within the Aruba Central Next Gen API, specifically under the Scope Management resource. It is useful for users who need to understand the organizational structure or relationships of devices, sites, or groups within their network configuration. For example, a network administrator might use this to get the hierarchy of a site or device group to manage configurations or monitor network segments effectively.

Use Case Examples

  1. Retrieve the hierarchy of a specific site to visualize its nested devices and sub-sites.
  2. Get the organizational structure of device groups to apply configuration policies accordingly.

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.
Scope ID The scopeId for which to retrieve hierarchy information.
Scope Type The type of scope, such as device, site, site collection, device groups, or organization.

Output

JSON

  • scopeHierarchy - The hierarchical structure information of the specified scope.

Dependencies

  • Aruba Central Next Gen API with OAuth2 authentication

Troubleshooting

  • Ensure the provided Scope ID is valid and exists in the Aruba Central system to avoid errors.
  • Verify that the selected Domain and Scope Type are compatible and correctly set for the operation.
  • Enable Debug Mode to get detailed logs if the node execution fails for better troubleshooting.

Discussion