Aruba Central icon

Aruba Central

Interact with the Aruba Central API

Actions95

Switch → Get VLAN Info of the Switch

AI-generated

Overview

This node interacts with the Aruba Central API to retrieve VLAN information for a specific network switch. It is useful for network administrators who need to monitor or manage VLAN configurations on switches within their network. For example, it can be used to fetch VLAN details such as VLAN ID, name, tagged and untagged ports, and status for a given switch identified by its serial number.

Use Case Examples

  1. A network admin wants to get all VLANs configured on a particular switch to verify network segmentation.
  2. An automated workflow retrieves VLAN info to monitor VLAN status and detect any configuration issues.

Properties

Name Meaning
Domain The domain of the Aruba Central API to use, such as monitoring, configuration, or inventory.
Serial Serial number of the 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 when Return All is false.
Additional Fields Optional filters and parameters to refine the VLAN query, such as VLAN name, VLAN 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 name of the VLAN.
  • taggedPorts - List of ports tagged for this VLAN.
  • untaggedPorts - List of ports untagged for this VLAN.
  • isJumboEnabled - Indicates if jumbo frames are enabled on the VLAN.
  • isVoiceEnabled - Indicates if voice VLAN is enabled.
  • isIgmpEnabled - Indicates if IGMP is enabled on the VLAN.
  • type - Type of the VLAN.
  • primaryVlanId - Primary VLAN ID if applicable.
  • status - Status of the VLAN (e.g., Up or Down).

Dependencies

  • Aruba Central API with OAuth2 authentication

Troubleshooting

  • Ensure the serial number provided is correct and the switch is registered in Aruba Central.
  • Verify that the OAuth2 credentials for Aruba Central API are valid and have sufficient permissions.
  • If the node returns an error about limits, check the 'Limit' parameter and adjust accordingly.
  • If no VLANs are returned, verify the filters in 'Additional Fields' are correct and match existing VLANs.

Discussion