Actions95
- Access Point Actions
- Client Actions
- Events Actions
- Gateway Actions
- Label Actions
- Mobility Controller Actions
- Network Actions
- Site Actions
- Swarm Actions
- Switch Actions
- List Switches
- Get VLAN Info of the Switch
- Get VLAN Info for CX Switch
- Get VLAN Info of the Switch Stack
- Get VLAN Info of the CX Switch Stack
- Get Switch Port PoE Info
- Get Switch Port PoE Info for CX Switch
- Get Switch PoE Info
- Get Switch PoE Info for CX Switch
- Get Switch VSX Info for CX Switch
- Get LLDP Device Neighbor Info for CX Switch
- Get LLDP Device Neighbor Info for CX Switch Stack
- Switch Bandwidth Usage
- Top N Switches
- Switch Details
- Delete Switch
- Switch Ports Details
- Get Ports Details for CX Switch
- Switch Chassis Details
- Switch Ports Bandwidth Usage
- Ports Bandwidth Usage for CX Switch
- Switch Ports Errors
- CX Switch Ports Errors
- Switch Stack Port Details
- CX Switch Stack Port Details
- List Switch Stacks
- Switch Stack Details
- Delete Switch Stack
- VPN Actions
Switch → List Switches
AI-generatedOverview
This node interacts with the Aruba Central API to list network switches within the Monitoring domain. It is useful for network administrators who want to retrieve detailed or filtered information about switches managed by Aruba Central, such as their status, group, labels, stack ID, and other attributes. Practical examples include generating reports on switch inventory, monitoring switch health, or filtering switches by site or status.
Use Case Examples
- Retrieve all switches in the Monitoring domain to monitor network health.
- Filter switches by group or label to generate targeted reports.
- Limit the number of switches returned for performance optimization.
- Sort switches by serial number or MAC address for organized display.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the Aruba Central API to interact with, here set to 'monitoring' for switch monitoring. |
| Return All | Determines whether to return all switch results or limit the number of results. |
| Limit | Maximum number of switch results to return when 'Return All' is false. |
| Additional Fields | Optional filters and parameters to refine the switch list, such as group, label, stack ID, status, fields to return, calculation options, public IP address, site, and sorting preferences. |
Output
JSON
switches- Array of switch objects with details as per the requested fields and filters.total- Total number of switches if 'Calculate Total' is enabled.clientCount- Client count per switch if 'Calculate Client Count' is enabled.
Dependencies
- Aruba Central API with OAuth2 authentication
Troubleshooting
- Ensure the OAuth2 credentials for Aruba Central API are correctly configured and valid.
- Check that the domain is set to 'monitoring' for the List Switches operation.
- Verify that filter values such as group, label, and site exist in the Aruba Central environment to avoid empty results.
- If the node returns an error, check the error message for API rate limits or permission issues.
- When 'Return All' is false, ensure the limit is within the allowed range (1-1000).
Links
- Aruba Central API Documentation - Official API documentation for Aruba Central, useful for understanding available endpoints and parameters.