Aruba CX icon

Aruba CX

Interact with Aruba CX Switch REST API

VLANs → Get

AI-generated

Summary

Get VLAN details

Inputs

  • Host Override — Optional hostname override for the switch (useful when looping over multiple devices).
  • Domain (required) — API domain; fixed to 'System'.
  • VLAN ID (required) — The VLAN identifier to retrieve (1‑4094).
  • Filters — Optional filters to control the response detail level.

Output shape

array of VLAN objects

Each item corresponds to the requested VLAN, containing fields as determined by the selected filters (depth, selector, attributes).

Examples

Example 1: Retrieve basic info for VLAN 10

Set VLAN ID = 10, leave filters at defaults (Depth = 1).

Discussion