Aruba Central Next Gen icon

Aruba Central Next Gen

Consume Aruba Central Next Gen API

Actions408

VLANs & Networks → Create Layer2 VLAN

AI-generated

Overview

This node operation creates a Layer 2 VLAN in the Aruba Central Next Gen system. It is useful for network administrators who need to programmatically manage VLAN configurations, such as setting VLAN IDs, names, descriptions, and additional VLAN properties like administrative state, VRF, and QinQ settings. Practical examples include automating VLAN setup for new network segments or updating VLAN configurations across multiple devices.

Use Case Examples

  1. Creating a VLAN with a specific VLAN ID and name for a guest network.
  2. Enabling or disabling a VLAN administratively on a Switch CX device.
  3. Setting a VLAN as a QinQ S-VLAN for advanced network segmentation.

Properties

Name Meaning
Debug Mode Whether to enable detailed debug logs for troubleshooting.
Domain API domain to interact with, such as monitoring or configuration domains.
VLAN ID VLAN identifier (1-4094).
VLAN Name VLAN name (max 32 characters), supported on Switch CX and PVOS.
Description Description of the VLAN (max 256 characters).
Additional Fields Additional optional VLAN configuration fields.

Output

JSON

  • vlanId - The VLAN identifier created or managed.
  • vlanName - The name assigned to the VLAN.
  • descriptionAlias - Description or alias for the VLAN.
  • enable - Administrative state of the VLAN (enabled or disabled).
  • vrf - VRF name associated with the VLAN.
  • qinqSvlan - Indicates if the VLAN is set as a QinQ S-VLAN.
  • voiceEnableAlias - Alias for voice enable/disable management on the VLAN.
  • objectType - Type of VLAN object created (LOCAL or SHARED).
  • scopeId - Scope ID for local VLAN objects.
  • persona - Persona for local VLAN objects.

Dependencies

  • An API key credential for Aruba Central Next Gen OAuth2 authentication

Troubleshooting

  • Common issues include invalid VLAN ID values outside the range 1-4094, which will cause the API to reject the request.
  • Missing required fields such as VLAN ID or domain selection can cause errors.
  • If objectType is set to LOCAL, scopeId and persona must be provided; otherwise, the operation will fail.
  • Debug mode can be enabled to get detailed logs for troubleshooting errors.

Discussion