Aruba Central Next Gen icon

Aruba Central Next Gen

Consume Aruba Central Next Gen API

Actions408

VLANs & Networks → Get All Named VLANs

AI-generated

Overview

This node operation retrieves all named VLANs from the Aruba Central Next Gen API within the VLANs & Networks resource. It supports filtering and pagination options to customize the data retrieval, such as view type (library or local), object type (local, shared, or both), scope ID, persona filter, effective configuration flag, detailed information flag, limit on the number of items, and offset for pagination. This operation is useful for network administrators who need to list and manage VLAN configurations programmatically.

Use Case Examples

  1. A network administrator wants to fetch all named VLANs in the configuration domain to audit VLAN settings.
  2. An automation workflow retrieves VLANs with detailed information for compliance reporting.
  3. A script fetches VLANs with pagination to process large VLAN datasets in batches.

Properties

Name Meaning
Debug Mode Whether to enable detailed debug logs for troubleshooting.
Domain API domain to interact with, such as monitoring, configuration, interfaces, routing, network services, security, management, or system.
View Type Type of view for retrieving objects, either library objects or local objects (requires scope ID).
Object Type Filter by object type: local only, shared only, or both.
Scope ID Scope ID required when view type is LOCAL.
Persona Persona filter for configuration profiles.
Effective Whether to retrieve effective configuration.
Detailed Whether to include detailed information.
Limit Maximum number of items to return, between 1 and 1000.
Offset Number of items to skip for pagination, minimum 0.

Output

JSON

  • id - Unique identifier of the VLAN.
  • name - Name of the VLAN.
  • description - Description of the VLAN.
  • vlanId - VLAN ID number.
  • scopeId - Scope identifier if applicable.
  • persona - Persona associated with the VLAN configuration.
  • effective - Flag indicating if the configuration is effective.
  • detailedInfo - Detailed information about the VLAN if requested.

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 no VLANs, verify the domain and additional field filters such as view type, object type, and scope ID are correctly set.
  • Enable Debug Mode to get detailed logs for troubleshooting API request and response issues.
  • Common error messages include authentication failures, invalid scope ID when using LOCAL view type, and exceeding API rate limits. Verify credentials, input parameters, and API usage limits to resolve these errors.

Links

Discussion