RESTAPI Manual
Layer 2
MSTP
33 min
multiple spanning tree protocol urls summary urls summary url get post patch put delete /rest/v1/running/mstp y n y n n /rest/v1/running/mstp/global y y y y y /rest/v1/running/mstp/instances/{id} y y y y y /rest/v1/running/mstp/instances/{id}/ports/{name} y y y y y /rest/v1/running/mstp/ports/{name} y y y y y /rest/v1/rpc/show mstp bridge n y n n n /rest/v1/rpc/show mstp brief n y n n n /rest/v1/rpc/show mstp interface n y n n n /rest/v1/rpc/show mstp mstconfid n y n n n /rest/v1/rpc/show mstp status n y n n n /rest/v1/rpc/show mstp tree n y n n n /rest/v1/rpc/show mstp treeport n y n n n examples examples show mstp bridge show mstp bridge post https //{switch ip}/rest/v1/rpc/show mstp bridge show mstp brief show mstp brief post https //{switch ip}/rest/v1/rpc/show mstp brief { "name" "ethernet12" } show mstp interface show mstp interface post https //{switch ip}/rest/v1/rpc/show mstp interface { "name" "ethernet12" } show mstp mstconfid show mstp mstconfid post https //{switch ip}/rest/v1/rpc/show mstp mstconfid show mstp status show mstp status post https //{switch ip}/rest/v1/rpc/show mstp status show mstp tree show mstp tree post https //{switch ip}/rest/v1/rpc/show mstp tree { "instance" "10" } show mstp treeport show mstp treeport post https //{switch ip}/rest/v1/rpc/show mstp treeport { "name" "ethernet12", "instance" "10" } get all mstp information get all mstp information get https //{switch ip}/rest/v1/running/mstp create a global mstp create a global mstp post https //{switch ip}/rest/v1/running/mstp/global { "name" "112233445566", "enabled" "false", "forward delay" 20, "hello time" 10, "max age" 30 } create an mstp instance create an mstp instance post https //{switch ip}/rest/v1/running/mstp/instances/1/ports { "name" "ethernet12", "internal cost" 200, "priority" 10 } create a port for mstp instance create a port for mstp instance post https //{switch ip}/rest/v1/running/mstp/instances/1/ports { "name" "ethernet12", "internal cost" 200, "priority" 10 } create an mstp port create an mstp port post https //{switch ip}/rest/v1/running/mstp/ports { "name" "ethernet12", "external cost" 10, "edge port" "true", "auto edge port" "false", "bpdu filter" "false", "bpdu guard" "false" } properties descriptions properties descriptions mstp global mstp global tree diagrams + rw mstp + rw global \| + rw name? \| + ro mode? \| + rw enabled? \| + rw forward delay? \| + rw hello time? \| + rw max age? + rw instances \| + rw instance \[id] \| + rw id \| + rw priority? \| + rw vlans \| + rw ports \| + rw port \[name] \| + rw name \| + rw internal cost? \| + rw priority? + rw ports + rw port \[name] + rw name + rw external cost? + rw edge port? + rw auto edge port? + rw bpdu filter? + rw bpdu guard? table of properties table of properties name required type/range description mstp m path only node, has no configurable value multi spanning tree protocol configuration global m (sub property of mstp) path only node, has no configurable value global configuration name o string (sub property of global) mst region name mode ro string (sub property of global) currently only mstp mode is supported, not configurable default value "mstp" enabled o "true" "false" (sub property of global) mstp status, true means mstp is enabled, false means mstp is disabled default value "false" forward delay o 4 30 (sub property of global) delay time for device state migration, in seconds default value 15 hello time o 1 10 (sub property of global) mstp hello time, in seconds default value 2 max age o 10 1000000 (sub property of global) a parameter used to determine whether a configuration message has been stored in the device for an out of date period of time, and the device will discard the out of date configuration message, in seconds default value 20 mstp instances mstp instances tree diagrams + rw mstp + rw instances \| + rw instance \[id] \| + rw id \| + rw priority? \| + rw vlans \| + rw ports \| + rw port \[name] \| + rw name \| + rw internal cost? \| + rw priority? table of properties name required type/range description mstp m path only node, has no configurable value multi spanning tree protocol configuration instances m (sub property of mstp) path only node, has no configurable value multi spanning tree protocol configuration id m 0 63 (sub property of instances) mstp instance id priority o 0 15 (sub property of instances) mstp region priority, once mstp is enabled the value is set to 8 by default default value 8 vlans o 1 4094 (sub property of instances) vlan id ports m (sub property of instances) path only node, has no configurable value name m ethernet name portchannel0000 9999 (sub property of ports) port name internal cost o 0 4294967295 (sub property of ports) the port internal path cost for the msti default value 200000000 priority o 0 15 (sub property of ports) the port priority for the msti default value 8 mstp ports mstp ports \# tree diagrams + rw mstp + rw ports + rw port \[name] + rw name + rw external cost? + rw edge port? + rw auto edge port? + rw bpdu filter? + rw bpdu guard? table of properties name required type/range description mstp m path only node, has no configurable value multi spanning tree protocol configuration ports m (sub property of mstp) path only node, has no configurable value enclosing container for the list of interface references name m ethernet name portchannel0000 9999 (sub property of ports) interface name external cost o 0 4294967295 (sub property of ports) the port external path cost for the cist default value 200000000 edge port o "true" "false" (sub property of ports) indicates that the interface is configured as an edge port edge ports are characterized by the fact that they connect directly to end devices and not to other network devices default value "false" auto edge port o "true" "false" (sub property of ports) automatic selection of edge port default value "true" bpdu filter o "true" "false" (sub property of ports) when set true, this feature can prevent the transmission of bpdu (bridge protocol data unit) packets on the interface, which is typically used to optimize network performance or enhance network security in specific scenarios default value "false" bpdu guard o "true" "false" (sub property of ports) when a port receives a bpdu message, if bpdu protection is enabled the port will be forced to set to the non forwarding state to prevent potential loop problems default value "false" show mstp status show mstp status \# tree diagrams + x show mstp status \| + ro output \| + ro data? table of properties name required type/range description show mstp status m path only node, has no configurable value show mstp instance port status data ro \<anydata> (sub property of output) show mstp interface show mstp interface tree diagrams + x show mstp interface \| + w input \| | + w name? \| + ro output \| + ro data? table of properties table of properties name required type/range description show mstp interface m path only node, has no configurable value show mstp interface configuration and status name o ethernet name portchannel0000 9999 (sub property of input) data ro \<anydata> (sub property of output) show mstp brief show mstp brief tree diagrams + x show mstp brief \| + w input \| | + w name? \| + ro output \| + ro data? table of properties table of properties name required type/range description show mstp brief m path only node, has no configurable value show port state for the cist name o ethernet name portchannel0000 9999 (sub property of input) data ro \<anydata> (sub property of output) show mstp bridge show mstp bridge tree diagrams + x show mstp bridge \| + ro output \| + ro data? table of properties table of properties name required type/range description show mstp bridge m path only node, has no configurable value show bridge state for the cist data ro \<anydata> (sub property of output) mstp ports mstp ports tree diagrams + x show mstp tree \| + w input \| | + w instance? \| + ro output \| + ro data? table of properties table of properties name required type/range description show mstp tree m path only node, has no configurable value show bridge state for the given msti instance o 0 63 (sub property of input) data ro \<anydata> (sub property of output) show mstp mstconfid show mstp mstconfid tree diagrams + x show mstp mstconfid \| + ro output \| + ro data? table of properties table of properties name required type/range description show mstp mstconfid m path only node, has no configurable value show mstp mstconfid data ro \<anydata> (sub property of output) show mstp treeport show mstp treeport tree diagrams + x show mstp treeport + w input \| + w name? \| + w instance? + ro output + ro data? table of properties table of properties name required type/range description show mstp treeport m path only node, has no configurable value show port detailed state for the given msti name o ethernet name portchannel0000 9999 (sub property of input) instance o 0 63 (sub property of input) data ro \<anydata> (sub property of output)
