MSTP

Multiple Spanning Tree Protocol.

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

Show mstp bridge

POST HTTPS://{switch IP}/rest/v1/rpc/show-mstp-bridge

Show mstp brief

POST HTTPS://{switch IP}/rest/v1/rpc/show-mstp-brief
{
    "name": "Ethernet12"
}

Show mstp interface

POST HTTPS://{switch IP}/rest/v1/rpc/show-mstp-interface
{
    "name": "Ethernet12"
}

Show mstp mstconfid

POST HTTPS://{switch IP}/rest/v1/rpc/show-mstp-mstconfid

Show mstp status

POST HTTPS://{switch IP}/rest/v1/rpc/show-mstp-status

Show mstp tree

POST HTTPS://{switch IP}/rest/v1/rpc/show-mstp-tree
{
    "instance": "10"
}

Show mstp treeport

POST HTTPS://{switch IP}/rest/v1/rpc/show-mstp-treeport
{
    "name": "Ethernet12",
    "instance": "10"
}

Get all MSTP information.

GET HTTPS://{switch IP}/rest/v1/running/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.

POST HTTPS://{switch IP}/rest/v1/running/mstp/instances/1/ports
{
    "name": "Ethernet12",
    "internal-cost": 200,
    "priority": 10
}

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.

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

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

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

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 Lag1..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

#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 Lag1..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

#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		(sub-property of output)

Show mstp interface

Tree Diagrams

    +---x show-mstp-interface
    |  +---w input
    |  |  +---w name?
    |  +--ro output
    |     +--ro data?

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 Lag1..9999	(sub-property of input)
data	RO		(sub-property of output)

Show mstp brief

Tree Diagrams

    +---x show-mstp-brief
    |  +---w input
    |  |  +---w name?
    |  +--ro output
    |     +--ro data?

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 Lag1..9999	(sub-property of input)
data	RO		(sub-property of output)

Show mstp bridge

Tree Diagrams

    +---x show-mstp-bridge
    |  +--ro output
    |     +--ro data?

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		(sub-property of output)

MSTP Ports

Tree Diagrams

    +---x show-mstp-tree
    |  +---w input
    |  |  +---w instance?
    |  +--ro output
    |     +--ro data?

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		(sub-property of output)

Show mstp mstconfid

Tree Diagrams

    +---x show-mstp-mstconfid
    |  +--ro output
    |     +--ro data?

Table of Properties

Name	Required	Type/Range	Description
show-mstp-mstconfid	M		Path-only node, has no configurable value. Show MSTP mstconfid.
data	RO		(sub-property of output)

Show mstp treeport

Tree Diagrams

    +---x show-mstp-treeport
       +---w input
       |  +---w name?
       |  +---w instance?
       +--ro output
          +--ro data?

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 Lag1..9999	(sub-property of input)
instance	O	0..63	(sub-property of input)
data	RO		(sub-property of output)