Aruba Central Next Gen icon

Aruba Central Next Gen

Consume Aruba Central Next Gen API

Actions408

VLANs & Networks → Get All Layer2 VLANs

AI-generated

Overview

This node operation retrieves all Layer 2 VLANs from the Aruba Central Next Gen API within the VLANs & Networks resource. It is useful for network administrators who need to fetch VLAN configurations for monitoring or configuration purposes. For example, it can be used to list VLANs for auditing network segmentation or for integrating VLAN data into network management workflows.

Use Case Examples

  1. Fetch all Layer 2 VLANs with default settings to review VLAN configurations.
  2. Retrieve VLANs with detailed information and pagination to manage large network environments.

Properties

Name Meaning
Debug Mode Whether to enable detailed debug logs for troubleshooting.
Domain API domain to interact with, such as monitoring or configuration.
Additional Fields Optional parameters to filter and customize the VLAN retrieval, including view type, object type, scope ID, persona, effective configuration, detailed info, limit, and offset for pagination.

Output

JSON

  • id - Unique identifier of the VLAN.
  • name - Name of the VLAN.
  • vlanId - VLAN ID number.
  • description - Description of the VLAN.
  • scopeId - Scope ID associated with the VLAN.
  • persona - Persona associated with the VLAN.
  • effective - Indicates if the configuration is effective.
  • detailed - Indicates if detailed information is included.

Dependencies

  • Aruba Central Next Gen API with OAuth2 authentication

Troubleshooting

  • Ensure the OAuth2 API credentials are correctly configured and have the necessary permissions to access VLAN data.
  • If the node returns an error related to scope ID, verify that the scope ID is provided when the view type is set to LOCAL.
  • Check network connectivity to Aruba Central API endpoints to avoid timeout or connection errors.
  • Enable Debug Mode to get detailed logs for troubleshooting issues during execution.

Discussion