Aruba CX icon

Aruba CX

Interact with Aruba CX Switch REST API

VLANs → Update

AI-generated

Summary

Updates an existing VLAN on an Aruba CX switch.

Inputs

  • hostOverride — Optional: Override the hostname from credentials (useful when looping over multiple switches).
  • vlanId (required) — ID of the VLAN to update (1‑4094).
  • vlanDescription — Description of the VLAN.
  • admin — Administrative state of the VLAN. Options: 'up' or 'down'.
  • type — Type of the VLAN. Options: 'static' or 'dynamic'.
  • voice — Whether to set the VLAN as a voice VLAN.

Output shape

array of objects

Returns the updated VLAN resource as provided by the Aruba CX REST API (typically a single-item array containing the VLAN JSON).

Examples

Example 1: Change VLAN 10 description and bring it up

Set VLAN ID = 10, VLAN Description = 'Guest Network', Admin State = 'Up'

Discussion