LLDP

link layer discovery protocol \<font color="#1d50a2">urls summary\</font> url get post patch put delete /rest/v1/running/lldp global y n y n n /rest/v1/running/lldp ports/{ifname} y y y n y /rest/v1/rpc/show lldp local interface n y n n n /rest/v1/rpc/show lldp local summary n y n n n /rest/v1/rpc/show lldp neighbor interface n y n n n /rest/v1/rpc/show lldp neighbor summary n y n n n \<font color="#1d50a2">examples\</font> \<font color="#1d50a2">show lldp local interface\</font> post https //{switch ip}/rest/v1/rpc/show lldp local interface { "port" "ethernet1" } response { "lldp local interface" \[ { "local port" "ethernet1", "via" "unknown", "age" "20565 days, 07 38 58", "device" "leaf 174", "device id" "00 01 02 03 04 05", "device descr" "sonic software version sonic v3 1r0500p01t10 hwsku cx308p 48y n distribution debian 11 11 kernel 5 10 0 8 2 amd64", "device mgmt ip" "10 250 0 174", "device mgmt iface" "2", "port id" "ethernet1", "port id type" "local", "port descr" "y1", "port ttl" "120", "capability" \[ { "type" "bridge", "enabled" true }, { "type" "router", "enabled" true }, { "type" "wlan", "enabled" false }, { "type" "station", "enabled" false } ] } ] } \<font color="#1d50a2">show lldp local summary\</font> post https //{switch ip}/rest/v1/rpc/show lldp local summary response { "lldp local summary" { "tx delay" "30", "tx delay ms" "30000", "tx hold" "4", "max neighbors" "32", "rx only" "no", "mgmt pattern" "10 250 0 174", "iface pattern" "ethernet ,eth0", "perm iface pattern" "(none)", "cid pattern" "eth0", "cid string" "00 01 02 03 04 05", "description" "sonic software version sonic v3 1r0500p01t10 hwsku cx308p 48y n distribution debian 11 11 kernel 5 10 0 8 2 amd64", "platform" "linux", "hostname" "leaf 174", "advertise version" "yes", "ifdescr update" "no", "iface promisc" "no", "lldpmed no inventory" "yes", "lldpmed faststart" "yes", "lldpmed faststart interval" "1", "bond slave src mac type" "local", "lldp portid type" "ifname", "lldp agent type" "unknown" } } \<font color="#1d50a2">show lldp neighbor interface\</font> post https //{switch ip}/rest/v1/rpc/show lldp neighbor interface { "port" "ethernet13" } response { "lldp neighbor interface" \[ { "local port" "ethernet13", "via" "lldp", "rid" "1121", "age" "1 day, 01 06 10", "remote device" "sonic 172", "remote device id" "60\ eb 5a 01 10 83", "remote device descr" "sonic software version sonic v3 1r0409p00 hwsku cx308p 48y n distribution debian 12 13 kernel 6 1 0 29 2 amd64", "remote device mgmt ip" "10 250 0 172", "remote device mgmt iface" "", "remote port id" "ethernet12", "remote port id type" "ifname", "remote port descr" "y13", "remote port ttl" "120", "capability" \[ { "type" "bridge", "enabled" true }, { "type" "router", "enabled" true }, { "type" "wlan", "enabled" false }, { "type" "station", "enabled" false } ], "vlan list" \[ { "vlan id" "", "value" "", "pvid" false } ] } ] } \<font color="#1d50a2">show lldp neighbor summary\</font> post https //{switch ip}/rest/v1/rpc/show lldp neighbor summary response { "lldp neighbor summary" \[ { "local port" "ethernet1", "remote device" "sonic 172", "remote port id" "ethernet12", "capability" "br", "remote port descr" "y13" }, { "local port" "ethernet25", "remote device" "sonic", "remote port id" "ethernet14", "capability" "br", "remote port descr" "y14" }, { "local port" "ethernet26", "remote device" "sonic", "remote port id" "ethernet15", "capability" "br", "remote port descr" "y15" } ] } \<font color="#1d50a2">modify lldp global\</font> patch https //{switch ip}/rest/v1/running/lldp global { "include vlan" "false", "global portid subtype" "local", "message tx interval" 7, "message tx hold multiplier" 8, "management address advertisement" "false", "capabilities advertisement" "false", "admin status" "false" } \<font color="#1d50a2">create a lldp port\</font> post https //{switch ip}/rest/v1/running/lldp ports/ethernet1 {"status" "rx only"} \<font color="#1d50a2">modify a lldp port\</font> patch https //{switch ip}/rest/v1/running/lldp ports/ethernet1 {"status" "rx and tx"} \<font color="#1d50a2">properties descriptions\</font> \<font color="#1d50a2">lldp ports\</font> tree diagrams + rw lldp ports \| + rw lldp port \[ifname] \| + rw ifname \| + ro local portid? \| + rw status? \| + ro portid subtype? table of properties name required type/range description lldp ports m path only node, has no configurable value lldp parameters ifname m ethernet name "mgmt0" (sub property of lldp ports) port name of current port local portid ro string (sub property of lldp ports) alias of current port status o "tx only" "rx only" "rx and tx" "disabled" (sub property of lldp ports) administrative status of the local lldp agent default value "rx and tx" portid subtype ro "ifname" "macaddress" "local" (sub property of lldp ports) type of portid \<font color="#1d50a2">lldp global\</font> tree diagrams + rw lldp global + rw include vlan? + rw global portid subtype? + rw message tx interval? + rw message tx hold multiplier? + rw management address advertisement? + rw capabilities advertisement? + rw admin status? table of properties name required type/range description lldp global m path only node, has no configurable value include vlan o "true" "false" (sub property of lldp global) carry the vlan id of the interface in the message default value "true" global portid subtype o "local" "ifname" "macaddress" (sub property of lldp global) type of portid default value "local" message tx interval o 5 32768 (sub property of lldp global) time interval in timer ticks between transmissions during normal transmission periods (i e , txfast is zero) default value 30 message tx hold multiplier o 2 10 (sub property of lldp global) multiplier of msg tx interval default value 4 management address advertisement o "true" "false" (sub property of lldp global) lldp management address advertisement default value "true" capabilities advertisement o "true" "false" (sub property of lldp global) lldp capabilities advertisement default value "true" admin status o "true" "false" (sub property of lldp global) administrative status of all port default value "true" \<font color="#1d50a2">show lldp local summary\</font> tree diagrams + x show lldp local summary \| + ro output \| + ro lldp local summary \| + ro tx delay? \| + ro tx delay ms? \| + ro tx hold? \| + ro max neighbors? \| + ro rx only? \| + ro mgmt pattern? \| + ro iface pattern? \| + ro perm iface pattern? \| + ro cid pattern? \| + ro cid string? \| + ro description? \| + ro platform? \| + ro hostname? \| + ro advertise version? \| + ro ifdescr update? \| + ro iface promisc? \| + ro lldpmed no inventory? \| + ro lldpmed faststart? \| + ro lldpmed faststart interval? \| + ro bond slave src mac type? \| + ro lldp portid type? \| + ro lldp agent type? table of properties name required type/range description show lldp local summary m path only node, has no configurable value show lldp summary configuration lldp local summary ro (sub property of output) path only node, has no configurable value lldp local summary configuration information tx delay ro string (sub property of lldp local summary) transmit delay in seconds tx delay ms ro string (sub property of lldp local summary) transmit delay in milliseconds tx hold ro string (sub property of lldp local summary) transmit hold multiplier max neighbors ro string (sub property of lldp local summary) maximum number of neighbors to store rx only ro string (sub property of lldp local summary) whether receive only mode is enabled mgmt pattern ro string (sub property of lldp local summary) pattern for management addresses iface pattern ro string (sub property of lldp local summary) interface pattern for lldp enabled ports perm iface pattern ro string (sub property of lldp local summary) permanent interface pattern cid pattern ro string (sub property of lldp local summary) interface pattern for chassis id cid string ro string (sub property of lldp local summary) override chassis id value description ro string (sub property of lldp local summary) override system description platform ro string (sub property of lldp local summary) override platform information hostname ro string (sub property of lldp local summary) override system name (hostname) advertise version ro string (sub property of lldp local summary) whether to advertise software version ifdescr update ro string (sub property of lldp local summary) whether to update interface descriptions iface promisc ro string (sub property of lldp local summary) whether promiscuous mode is enabled on managed interfaces lldpmed no inventory ro string (sub property of lldp local summary) whether lldp med inventory is disabled lldpmed faststart ro string (sub property of lldp local summary) whether lldp med fast start mechanism is enabled lldpmed faststart interval ro string (sub property of lldp local summary) lldp med fast start interval bond slave src mac type ro string (sub property of lldp local summary) source mac type for lldp frames on bond slaves lldp portid type ro string (sub property of lldp local summary) port id tlv subtype for lldp frames lldp agent type ro string (sub property of lldp local summary) lldp agent type \<font color="#1d50a2">show lldp local interface ethernet\</font> tree diagrams + x show lldp local interface \| + w input \| | + w port? \| + ro output \| + ro lldp local interface \[local port] \| + ro local port \| + ro via? \| + ro age? \| + ro device? \| + ro device id? \| + ro device descr? \| + ro device mgmt ip? \| + ro device mgmt iface? \| + ro port id? \| + ro port id type? \| + ro port descr? \| + ro port ttl? \| + ro capability \[type] \| + ro type \| + ro enabled? table of properties \<font color="#0c121d">name\</font> \<font color="#0c121d">required\</font> \<font color="#0c121d">type/range\</font> \<font color="#0c121d">description\</font> show lldp local interface m path only node, has no configurable value show lldp configuration of specific interface port m ethernet name or mgmt0 (sub property of input) the name of the port lldp local interface ro string (sub property of output) path only node, has no configurable value local port lldp interface information local port ro string (sub property of lldp local interface) local interface name via ro string (sub property of lldp local interface) protocol via which information was learned (e g , lldp) age ro string (sub property of lldp local interface) age of the connection information device ro string (sub property of lldp local interface) device system name device id ro string (sub property of lldp local interface) device chassis id device descr ro string (sub property of lldp local interface) device system description device mgmt ip ro string (sub property of lldp local interface) device management ip address device mgmt iface ro string (sub property of lldp local interface) device management interface index port id ro string (sub property of lldp local interface) port id or name port id type ro string (sub property of lldp local interface) type of port id (e g , ifname, local) port descr ro string (sub property of lldp local interface) port description port ttl ro string (sub property of lldp local interface) port time to live capability ro string (sub property of lldp local interface) path only node, has no configurable value list of device capabilities with their enabled status type ro string (sub property of capability) capability type (e g , bridge, router, wlan, station) enabled ro "true" "false" (sub property of capability) whether this capability is enabled \<font color="#1d50a2">show lldp neighbor summary\</font> tree diagrams + x show lldp neighbor summary \| + ro output \| + ro lldp neighbor summary \[local port] \| + ro local port \| + ro remote device? \| + ro remote port id? \| + ro capability? \| + ro remote port descr? table of properties \<font color="#0c121d">name\</font> \<font color="#0c121d">required\</font> \<font color="#0c121d">type/range\</font> \<font color="#0c121d">description\</font> show lldp neighbor summary m path only node, has no configurable value show lldp neighbor summary information lldp neighbor summary ro (sub property of output) path only node, has no configurable value local port for learning lldp information local port ro string (sub property of lldp neighbor summary) local interface name depends on port id subtype remote device ro string (sub property of lldp neighbor summary) remote device system name remote port id ro string (sub property of lldp neighbor summary) remote port id or name capability ro 'b' or 'r' or 'br' (sub property of lldp neighbor summary) 'b' for bridge, 'r' for router remote port descr ro string (sub property of lldp neighbor summary) remote port description \<font color="#1d50a2">show lldp neighbor interface ethernet\</font> tree diagrams + x show lldp neighbor interface + w input \| + w port? + ro output + ro lldp neighbor interface \[local port] + ro local port + ro via? + ro rid? + ro age? + ro remote device? + ro remote device id? + ro remote device descr? + ro remote device mgmt ip? + ro remote device mgmt iface? + ro remote port id? + ro remote port id type? + ro remote port descr? + ro remote port ttl? + ro capability \[type] \| + ro type \| + ro enabled? + ro vlan list \[] + ro vlan id? + ro value? + ro pvid? table of properties \<font color="#0c121d">name\</font> \<font color="#0c121d">required\</font> \<font color="#0c121d">type/range\</font> \<font color="#0c121d">description\</font> show lldp neighbor interface m path only node, has no configurable value show lldp neighbor information of specific interface port m ethernet name or mgmt0 (sub property of input) the name of the port lldp neighbor interface ro (sub property of output) path only node, has no configurable value local port for learning lldp neighbor information local port ro string (sub property of lldp neighbor interface) local interface name depends on port id subtype via ro string (sub property of lldp neighbor interface) protocol via which information was learned (e g , lldp) rid ro string (sub property of lldp neighbor interface) remote identifier age ro string (sub property of lldp neighbor interface) age of the connection information remote device ro string (sub property of lldp neighbor interface) remote device system name remote device id ro string (sub property of lldp neighbor interface) remote device chassis id remote device descr ro string (sub property of lldp neighbor interface) remote device system description remote device mgmt ip ro string (sub property of lldp neighbor interface) remote device management ip address remote device mgmt iface ro string (sub property of lldp neighbor interface) remote device management interface index remote port id ro string (sub property of lldp neighbor interface) remote port id or name remote port id type ro string (sub property of lldp neighbor interface) type of remote port id (e g , ifname, local) remote port descr ro string (sub property of lldp neighbor interface) remote port description remote port ttl ro string (sub property of lldp neighbor interface) remote port time to live capability ro (sub property of lldp neighbor interface) path only node, has no configurable value list of device capabilities with their enabled status type ro string (sub property of capability) capability type (e g , bridge, router, wlan, station) enabled ro "true" "false" (sub property of capability) whether this capability is enabled vlan list ro (sub property of lldp neighbor interface) path only node, has no configurable value list of vlans advertised by remote device can be a single vlan or multiple vlans vlan id ro string (sub property of vlan list) vlan id advertised by remote device value ro string (sub property of vlan list) vlan name advertised by remote device pvid ro "true" "false" (sub property of vlan list) whether this is the pvid (primary vlan id)