Aruba CXInstall

Summary

Retrieves a list of interface configurations, statuses, or statistics from an Aruba CX switch.

Inputs

• hostOverride — Optional hostname or IP address to override the host defined in credentials.
• domain (required) — Domain of the Aruba CX API (currently only 'System' is supported).
• returnAll — Whether to return all results or only up to a given limit.
• limit — Max number of results to return (default 100).
• filters — Optional collection of filters: 'depth' (1-3) for details, 'selector' for configuration/status/statistics, and 'attributes' for specific columns.

Output shape

A list of items, each containing interface details including name, description, type, and current state.

The 'returnAll' and 'limit' parameters control pagination. The 'filters' object allows specific control over depth, selector, and returned attributes.

Examples

Example 1: Retrieve all interfaces with full configuration details.

Set 'returnAll' to true. Add 'filters' with 'depth': 3 and 'selector': 'configuration'.

Example 2: Get a list of up to 50 interfaces showing only name and link state.

Set 'limit' to 50. Add 'filters' with 'attributes': 'name,link_state'.