RESTAPI Manual
Layer 2
LLDP
18 min
link layer discovery protocol urls summary urls summary 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 ethernet n y n n n /rest/v1/rpc/show lldp local summary n y n n n /rest/v1/rpc/show lldp neighbor interface ethernet n y n n n /rest/v1/rpc/show lldp neighbor summary n y n n n examples examples show lldp local interface ethernet show lldp local interface ethernet post https //{switch ip}/rest/v1/rpc/show lldp local interface ethernet { "port" "ethernet1" } show lldp local summary show lldp local summary post https //{switch ip}/rest/v1/rpc/show lldp local summary show lldp neighbor interface ethernet show lldp neighbor interface ethernet post https //{switch ip}/rest/v1/rpc/show lldp neighbor interface ethernet { "port" "ethernet1" } show lldp neighbor summary show lldp neighbor summary post https //{switch ip}/rest/v1/rpc/show lldp neighbor summary modify lldp global modify lldp global 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" } create a lldp port create a lldp port post https //{switch ip}/rest/v1/running/lldp ports/ethernet1 {"status" "rx only"} modify a lldp port modify a lldp port patch https //{switch ip}/rest/v1/running/lldp ports/ethernet1 {"status" "rx and tx"} properties descriptions properties descriptions lldp ports lldp ports 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 "eth0" (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 lldp global lldp global 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" show lldp local summary show lldp local summary tree diagrams + x show lldp local summary \| + ro output \| + ro text? table of properties name required type/range description show lldp local summary m path only node, has no configurable value show lldp summary configuration text ro string (sub property of output) show lldp local interface ethernet show lldp local interface ethernet tree diagrams + x show lldp local interface ethernet \| + w input \| | + w port? \| + ro output \| + ro text? table of properties name required type/range description show lldp local interface ethernet m path only node, has no configurable value show lldp configuration of specific interface port o ethernet name (sub property of input) the name of the port text ro string (sub property of output) show lldp neighbor summary show lldp neighbor summary tree diagrams + x show lldp neighbor summary \| + ro output \| + ro text? table of properties name required type/range description show lldp neighbor summary m path only node, has no configurable value show lldp neighbor summary information text ro string (sub property of output) show lldp neighbor interface ethernet show lldp neighbor interface ethernet tree diagrams + x show lldp neighbor interface ethernet + w input \| + w port? + ro output + ro text? table of properties name required type/range description show lldp neighbor interface ethernet m path only node, has no configurable value show lldp neighbor information of specific interface port o ethernet name (sub property of input) the name of the port text ro string (sub property of output)
