Aruba Central icon

Aruba Central

Interact with the Aruba Central API

Actions95

Switch → Get VLAN Info for CX Switch

AI-generated

Overview

This node interacts with the Aruba Central API to retrieve VLAN information for a specified CX switch within the monitoring domain. It is useful for network administrators who need to monitor VLAN configurations and statuses on Aruba CX switches. For example, it can be used to fetch VLAN details filtered by VLAN name, ID, port tagging, jumbo frame status, voice or IGMP enablement, VLAN type, primary VLAN ID, and VLAN status, with options to sort results and limit the number of returned entries.

Use Case Examples

  1. A network admin wants to get all VLANs configured on a specific CX switch to verify network segmentation.
  2. Filtering VLANs by name or ID to troubleshoot connectivity issues related to specific VLANs on a CX switch.
  3. Checking if jumbo frames or voice VLANs are enabled on a switch to ensure proper network performance and QoS.

Properties

Name Meaning
Domain The domain of the Aruba Central API to interact with, here specifically 'monitoring' for network device monitoring.
Serial Serial number of the CX switch to get VLAN info for.
Return All Whether to return all VLAN results or only up to a given limit.
Limit Maximum number of VLAN results to return if 'Return All' is false.
Additional Fields Optional filters and parameters to refine VLAN info retrieval, such as VLAN name, ID, tagged/untagged ports, jumbo/voice/IGMP enabled status, VLAN type, primary VLAN ID, VLAN status, sorting options, and whether to calculate total VLANs.

Output

JSON

  • vlanId - The unique identifier of the VLAN.
  • 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 VLAN features are enabled.
  • 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.

Dependencies

  • Aruba Central API with OAuth2 authentication

Troubleshooting

  • Ensure the serial number of the CX switch is correct and the device is reachable in Aruba Central.
  • Verify that the OAuth2 credentials for Aruba Central API are valid and have sufficient permissions to access monitoring data.
  • If filtering by additional fields, confirm that 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 values, and network access.

Links

Discussion