Aruba Central icon

Aruba Central

Interact with the Aruba Central API

Actions95

Switch → Get VLAN Info of the CX Switch Stack

AI-generated

Overview

This node interacts with the Aruba Central API to retrieve VLAN information for a specified CX switch stack within the monitoring domain. It is useful for network administrators who need to monitor VLAN configurations and statuses on Aruba CX switch stacks. For example, it can be used to fetch VLAN details such as VLAN ID, name, tagged and untagged ports, and status for network monitoring and troubleshooting purposes.

Use Case Examples

  1. Retrieve all VLANs for a specific CX switch stack to audit network segmentation.
  2. Filter VLANs by name or ID to check specific VLAN configurations.
  3. Limit the number of VLANs returned to manage data volume in monitoring dashboards.

Properties

Name Meaning
Domain The domain of the Aruba Central API to interact with, here set to 'monitoring' for VLAN info retrieval.
Stack ID The identifier of the CX switch stack to get VLAN information for.
Return All Whether to return all VLAN results or limit the number of results.
Limit Maximum number of VLAN results to return when 'Return All' is false.
Additional Fields Optional filters and parameters to refine VLAN queries, such as VLAN name, ID, tagged/untagged ports, jumbo/voice/IGMP enabled status, VLAN type, primary VLAN ID, VLAN status, sorting order, and whether to calculate total VLANs.

Output

JSON

  • vlanId - The VLAN identifier.
  • name - The VLAN name.
  • taggedPorts - List of ports tagged in the VLAN.
  • untaggedPorts - List of ports untagged in the VLAN.
  • isJumboEnabled - Indicates if jumbo frames are enabled for the VLAN.
  • isVoiceEnabled - Indicates if voice VLAN is enabled.
  • isIgmpEnabled - Indicates if IGMP is enabled for the VLAN.
  • type - Type of the VLAN.
  • primaryVlanId - Primary VLAN ID if applicable.
  • status - Operational status of the VLAN (e.g., Up or Down).

Dependencies

  • Aruba Central API with OAuth2 authentication

Troubleshooting

  • Ensure the Stack ID is correct and the switch stack is accessible in Aruba Central.
  • Verify that the OAuth2 credentials for Aruba Central API are valid and have sufficient permissions.
  • If filtering by additional fields, ensure the filter values are valid and supported by the API.
  • Common error messages may include authentication failures, invalid parameters, or network connectivity issues. Resolving these typically involves checking credentials, input parameters, and network access.

Links

Discussion