Aruba CX icon

Aruba CX

Interact with Aruba CX Switch REST API

LLDP Neighbors → List Interface Neighbors

AI-generated

Summary

List LLDP interface neighbors for a specified host and interface, optionally limiting results and applying filters.

Inputs

  • hostOverride — Optional override of the hostname from credentials to target a specific switch.
  • domain (required) — Domain of the Aruba CX API (currently only "System").
  • interfaceId (required) — Interface name (e.g., 1/1/1, vlan10) for which to list LLDP neighbors.
  • returnAll — If true, returns all matching results; otherwise respects the Limit setting.
  • limit — Maximum number of results to return when returnAll is false (1-1000).
  • filters — Collection of filter options such as depth, selector, and attributes to refine the query.

Output shape

a list of LLDP neighbor items

Each item contains neighbor details like system name, chassis ID, port ID, and optionally selected configuration, status, or statistics; the response does not include error envelopes on success.

Examples

Example 1: Fetch up to 50 LLDP neighbors on interface 1/1/1 with configuration and status details.

Set Interface to "1/1/1", Limit to 50, enable Filters with Selector "configuration,status", and leave Return All disabled.

Discussion