Get LLDP Neighbor Status for Element (v2.0)

GET 
/sdwan/v2.0/api/elements/:element_id/lldp_neighbors/status

List all the lldp neighbor(s) status for an element.

Request

Path Parameters

element_id stringrequired

The element ID.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

id string

The ID.

items LldpNeighborsState[]
Array [
element_id string
The element ID.
id string
The ID.
interface_id string
The interface ID.
lldp_neighbors_state InterfaceLldpNeighborsState[]
Details of the LLDP neighbors state.
Array [
asset_id string
The LLDP asset ID.
chassis_id string
The authentication type. Only closed mode and single host authentication is supported.
device_class string
The device class.
device_description string
The device description.
device_name string
The name of the device.
firmware_revision string
The firmware revision.
hardware_revision string
The hardware revision.
ip_address string
The Ip address of the LLDP neighbors.
mac_address string
Mac Address
manufacturer_name string
The name of the manufacturer.
model_name string
The device model name.
power_priority string
The power usage priority.
power_required float
The powere required.
power_source string
The power source.
power_type string
The power type.
serial_number string
The serial number.
software_revision string
The software revision.
username string
Username
]
lldp_state string
The lldp state.
lldp_type string
The lldp type.
]

Example (from schema)

{
  "count": 0,
  "id": "string",
  "items": [
    {
      "element_id": "string",
      "id": "string",
      "interface_id": "string",
      "lldp_neighbors_state": [
        {
          "asset_id": "string",
          "chassis_id": "string",
          "device_class": "string",
          "device_description": "string",
          "device_name": "string",
          "firmware_revision": "string",
          "hardware_revision": "string",
          "ip_address": "string",
          "mac_address": "string",
          "manufacturer_name": "string",
          "model_name": "string",
          "power_priority": "string",
          "power_required": 0,
          "power_source": "string",
          "power_type": "string",
          "serial_number": "string",
          "software_revision": "string",
          "username": "string"
        }
      ],
      "lldp_state": "string",
      "lldp_type": "string"
    }
  ]
}

404

Not Found

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "LLDP_NEIGHBORS_STATE_NOT_FOUND"
      }
    ]
  }
}

Loading...