Aruba Central Next Gen icon

Aruba Central Next Gen

Consume Aruba Central Next Gen API

Actions408

VLANs & Networks → Get Layer2 VLAN

AI-generated

Overview

This node interacts with the Aruba Central Next Gen API to retrieve details of a specific Layer 2 VLAN within the VLANs & Networks resource domain. It is useful for network administrators who need to fetch VLAN configuration details programmatically, such as VLAN ID, name, and associated settings, to automate network management or integrate with other systems.

Use Case Examples

  1. Retrieve VLAN details for VLAN ID 10 in the Configuration domain to verify network segmentation.
  2. Fetch VLAN information to audit VLAN configurations across multiple sites.

Properties

Name Meaning
Debug Mode Enable detailed debug logs for troubleshooting the node execution.
Domain Select the API domain to interact with, such as Monitoring, Configuration, Interfaces, etc. For this operation, Configuration domain is relevant.
VLAN ID ID of the VLAN to retrieve, must be between 1 and 4094. This is required to specify which VLAN's details to fetch.

Output

JSON

  • vlanId - The ID of the VLAN retrieved.
  • vlanName - The name of the VLAN.
  • vlanDescription - Description or notes about the VLAN.
  • vlanStatus - Status of the VLAN (e.g., active, inactive).
  • associatedInterfaces - List of network interfaces associated with the VLAN.

Dependencies

  • Aruba Central Next Gen API with OAuth2 authentication

Troubleshooting

  • Ensure the VLAN ID is within the valid range (1-4094) to avoid validation errors.
  • Verify that the selected domain is 'Configuration' when performing this operation, as VLAN retrieval is domain-specific.
  • Enable Debug Mode to get detailed logs if the node execution fails for better troubleshooting.
  • Common errors include authentication failures due to invalid or expired OAuth2 tokens, which require re-authentication.
  • Network connectivity issues to the Aruba Central API endpoint can cause timeouts or failures; verify network access.

Links

Discussion