Aruba Central icon

Aruba Central

Interact with the Aruba Central API

Actions95

Swarm → Get Swarm

AI-generated

Overview

This node interacts with the Aruba Central API to retrieve detailed information about a specific Swarm within the network monitoring domain. It is useful for network administrators who need to fetch data about a particular Swarm by its ID, enabling monitoring and management of network device groups or clusters.

Use Case Examples

  1. A network admin wants to get the status and details of a Swarm identified by its ID in the monitoring domain to analyze network performance.
  2. An automated workflow retrieves Swarm information to trigger alerts or further processing based on the Swarm's state.

Properties

Name Meaning
Domain Specifies the domain of the Aruba Central API to interact with, such as monitoring, firmware, or configuration. For this operation, it defaults to 'monitoring'.
Swarm_id The unique identifier of the Swarm to retrieve. This is required to specify which Swarm's information to fetch in the monitoring domain.

Output

JSON

  • swarmId - The ID of the retrieved Swarm
  • swarmDetails - Detailed information about the Swarm, including its status, devices, and other relevant metadata

Dependencies

  • Aruba Central API with OAuth2 authentication

Troubleshooting

  • Common issues include providing an invalid or non-existent Swarm ID, which results in an error from the API indicating the Swarm was not found.
  • Authentication failures due to invalid or expired OAuth2 credentials can prevent the node from executing successfully.
  • Network connectivity issues to the Aruba Central API endpoint can cause timeouts or failures.

Discussion