networking_switch_port_lldp_neighbors

Fetch the LLDP neighbors seen on a switch port
get/v1/system/hardware/rack-switch-port/{rack_id}/{switch_location}/{port}/lldp/neighbors

Path Parameters

port

A name to use when selecting switch ports.

Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'. Names cannot be a UUID, but they may contain a UUID. They can be at most 63 characters long.

rack_id

A rack id to use when selecting switch ports.

switch_location

A switch location to use when selecting switch ports.

Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'. Names cannot be a UUID, but they may contain a UUID. They can be at most 63 characters long.

Query Parameters

limit

Maximum number of items returned by a single call

page_token

Token returned by previous call to retrieve the subsequent page

sort_by

Supported set of sort modes for scanning by id only.

Currently, we only support scanning in ascending order.

Responses

Object
items

list of items on this page of results

Information about LLDP advertisements from other network entities directly connected to a switch port. This structure contains both metadata about when and where the neighbor was seen, as well as the specific information the neighbor was advertising.

Object
chassis_id

The LLDP chassis identifier advertised by the neighbor

first_seen

Initial sighting of this LldpNeighbor

last_seen

Most recent sighting of this LldpNeighbor

link_description

The LLDP link description advertised by the neighbor

link_name

The LLDP link name advertised by the neighbor

local_port

The port on which the neighbor was seen

management_ip

The LLDP management IP(s) advertised by the neighbor

Object
addr

interface_num

oid
system_description

The LLDP system description advertised by the neighbor

system_name

The LLDP system name advertised by the neighbor

next_page

token used to fetch the next page of results (if any)