Aruba Central icon

Aruba Central

Interact with the Aruba Central API

Actions95

Swarm → Get Swarms

AI-generated

Overview

This node interacts with the Aruba Central API to retrieve information about Swarms within the specified domain. It is useful for network administrators who want to monitor or manage Swarms, which are groups of network devices or clients, across different domains such as Monitoring or Firmware. For example, a user can fetch all Swarms in the Monitoring domain with filters like status or swarm name, or limit the number of results returned.

Use Case Examples

  1. Retrieve all Swarms in the Monitoring domain to monitor network device groups.
  2. Fetch a limited number of Swarms in the Firmware domain filtered by device group name for firmware management.

Properties

Name Meaning
Domain Specifies the domain of the Aruba Central API to target, such as Monitoring or Firmware.
Return All Whether to return all results or only up to a given limit. Available for Monitoring and Firmware domains.
Limit Maximum number of results to return when Return All is false. Different default and max values depending on domain.
Additional Fields Optional filters and parameters to refine the Swarms query, varying by domain. For Monitoring domain, includes filters like status, public IP address, fields to return, sorting, swarm name, and whether to calculate total Swarms. For Firmware domain, includes filtering by group name.

Output

JSON

  • swarm_id - Unique identifier of the Swarm.
  • status - Current status of the Swarm.
  • ip_address - IP address of the Swarm.
  • public_ip_address - Public IP address of the Swarm.
  • firmware_version - Firmware version running on the Swarm devices.

Dependencies

  • Aruba Central API with OAuth2 authentication

Troubleshooting

  • Ensure the OAuth2 credentials for Aruba Central API are correctly configured and valid.
  • If the node returns an error about limits, check the 'Limit' parameter and 'Return All' setting to avoid exceeding API restrictions.
  • Filter parameters in 'Additional Fields' must be valid and supported by the API; invalid filters may cause errors.
  • Network connectivity issues to Aruba Central API can cause execution failures; verify network access.

Links

Discussion