Aruba Central icon

Aruba Central

Interact with the Aruba Central API

Actions95

Switch → Get VLAN Info of the Switch Stack

AI-generated

Overview

This node interacts with the Aruba Central API to retrieve VLAN information for a specified switch stack within the monitoring domain. It is useful for network administrators who need to monitor and manage VLAN configurations on switch stacks, enabling them to filter and sort VLAN data based on various criteria such as VLAN name, ID, port tagging, and status. For example, it can be used to get detailed VLAN info for troubleshooting or inventory purposes in a network managed by Aruba Central.

Use Case Examples

  1. Retrieve all VLANs for a specific switch stack to audit network segmentation.
  2. Filter VLANs by name or ID to quickly find relevant VLAN configurations.
  3. Sort VLANs by name in ascending or descending order for organized reporting.

Properties

Name Meaning
Domain Specifies the domain of the Aruba Central API to use, e.g., monitoring.
Stack ID The identifier of the switch stack to retrieve 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 the VLAN query, such as VLAN name, ID, tagged/untagged ports, jumbo/voice/IGMP enabled status, VLAN type, primary VLAN ID, status, sorting order, and whether to calculate total VLANs.

Output

JSON

  • vlanId - The VLAN identifier.
  • name - The name of the VLAN.
  • status - The operational status of the VLAN (e.g., Up or Down).
  • taggedPorts - List of ports tagged with this VLAN.
  • untaggedPorts - List of ports untagged with this VLAN.
  • isJumboEnabled - Indicates if jumbo frames are enabled on the VLAN.
  • isVoiceEnabled - Indicates if voice traffic is enabled on the VLAN.
  • isIgmpEnabled - Indicates if IGMP is enabled on the VLAN.
  • type - The type/category of the VLAN.
  • primaryVlanId - The primary VLAN ID associated with this VLAN.
  • totalVlans - Total number of VLANs if calculated.

Dependencies

  • Aruba Central API with OAuth2 authentication

Troubleshooting

  • Ensure the Stack ID is correct and the switch stack exists in Aruba Central.
  • Verify that the OAuth2 credentials for Aruba Central API are valid and have necessary permissions.
  • If filtering by additional fields, ensure the filter values are valid and correctly formatted.
  • Common error messages may include authentication failures, invalid parameters, or network connectivity issues. Check logs for detailed error messages and enable continueOnFail to handle errors gracefully.

Links

Discussion