Aruba CX icon

Aruba CX

Interact with Aruba CX Switch REST API

Interfaces → Get

AI-generated

Summary

Get an Aruba CX interface by ID, optionally applying filters for depth, selector, and attributes.

Inputs

  • hostOverride — Optional: Override the hostname from credentials (useful for loops with multiple switches)
  • domain (required) — Domain of the Aruba CX API
  • interfaceId (required) — ID of the interface (e.g., 1/1/1, lag1, vlan10)
  • filters — Filters

Output shape

a list of interface objects

Each object returns interface details; optional fields such as depth, selector, and attributes may be included based on the filter values; pagination is not used

Examples

Example 1: Retrieve a specific interface

Set Domain to System, Interface ID to 1/1/1, optionally set Filters.depth=1, selector='configuration', attributes='name,admin,link_state'

Example 2: List all interfaces with default filters

Leave Interface ID empty, use default Filters (depth=1), no selector or attributes

Discussion