Configuring STP
STP provides a loop-free network at the Layer 2 level. Layer 2 LAN ports send and receive STP frames, which are called Bridge Protocol Data Units (BPDUs), at regular intervals. Network devices do not forward these frames but use the frames to construct a loop-free path.
802.1D is the original standard for STP, and many improvements have enhanced the basic loop-free STP. You can create a separate loop-free path for each VLAN, which is named Per VLAN Spanning Tree (PVST+). Additionally, the entire standard was reworked to make the loop-free convergence process faster to keep up with the faster equipment. This STP standard with faster convergence is the 802.1w standard, which is known as Rapid Spanning Tree (RSTP). Now, these faster convergence times are available as you create STP for each VLAN, which is known as Per VLAN Rapid Spanning Tree (Rapid PVST+).
Finally, the 802.1s standard, Multiple Spanning Trees (MST), allows you to map multiple VLANs into a single spanning tree instance. Each instance runs an independent spanning tree topology.
Although the software can interoperate with legacy 802.1D systems, the system runs Rapid PVST+ and MST. Rapid PVST+ is the default STP protocol for Cisco Nexus devices.
Note: Cisco NX-OS uses the extended system ID and MAC address reduction; you cannot disable these features.
In addition, Cisco has created some proprietary features to enhance the spanning tree activities.
For more information about security features, see the Cisco Nexus 9000 Series NX-OS Layer 2 Switching Configuration Guide.
Configuring STP Settings
NX-API REST supports the following spanning-tree protocol (STP) settings:
spanning-tree mode <stp-mode> | no spanning-tree mode [<stp-mode>]
[no] spanning-tree mst simulate pvst global
[no] spanning-tree port type edge bpduguard default
[no] spanning-tree port type edge bpdufilter default
[no] spanning-tree port type edge edge default
[no] spanning-tree port type edge network default
[no] spanning-tree vlan <vlan-id>
[no] spanning-tree vlan <vlan-id> forward-time <seconds>
[no] spanning-tree vlan <vlan-id> hello-time <seconds>
[no] spanning-tree vlan <vlan-id> max-age <seconds>
[no] spanning-tree vlan <vlan-id> priority <prio>
spanning-tree port type <port-type> | no spanning-tree port [<port-type>]
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload: https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html
Setting STP Mode to MST
Setting STP Mode to MST
POST http://<IP_Address>/api/mo/sys/stp/inst.json
{
"stpInst": {
"attributes": {
"mode": "mst"
}
}
}
{
imdata": []
}
This example sets STP mode to support Multiple Spanning Trees (MST):
When you issue an POST to configure STP, an stpInst object (/sys/stp/inst) is created in the MIT. Under this object, objects are created for each interface included in the spanning tree, and an stpMstEntity object (syst/stp/inst/mstent) is created, which holds the MST configuration.
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpInst | sys/stp/inst |
stpInst Properties
The following table contains information about the stpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
mode | stp:Mode (scalar:Enum8) | SELECTION: 1 - mst 2 - pvrst DEFAULT: pvrst |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Setting STP Mode to Rapid PVST
Setting STP Mode to Rapid PVST
POST http://<IP_Address>/api/mo/sys/stp/inst.json
{
"stpInst": {
"attributes": {
"mode": "pvrst"
}
}
}
{
imdata": []
}
This example sets STP mode to support Rapid PVST.
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpInst | sys/stp/inst |
stpInst Properties
The following table contains information about the stpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
mode | stp:Mode (scalar:Enum8) | SELECTION: 1 - mst 2 - pvrst DEFAULT: pvrst |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Enabling or Disabling MST Spanning Tree Simulation
Enabling or Disabling MST Spanning Tree Simulation
POST http://<IP_Address>/api/mo/sys/stp/inst/mstent.json
{
"stpMstEntity": {
"attributes": {
"simulate": "enabled"
}
}
}
{
imdata": []
}
This example enables MST spanning tree simulation. To disable MST Spanning Tree simulation, set the "simulate" value to "disabled."
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpMstEntity | sys/stp/inst/mstent |
stpMstEntity Properties
The following table contains information about the stpMstEntity properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
simulate | stp:Simulate (scalar:Enum8) | spanning tree simulation | SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Setting the Spanning Tree Port Type to extchp-edge
Setting the Spanning Tree Port Type to extchp-edge
POST http://<IP_Address>/api/mo/sys/stp/inst.json
{
"stpInst": {
"attributes": {
"ctrl": "extchp-edge"
}
}
}
{
imdata": []
}
This example changes the spanning tree port type to 'extchp-edge'.
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpInst | sys/stp/inst |
stpInst Properties
The following table contains information about the stpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
ctrl | nw:InstCtrl (scalar:Bitmask64) | The control state. | SELECTION: 1 - stateful-ha DEFAULT: normal |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Setting the Spanning Tree Port Type to network
Setting the Spanning Tree Port Type to network
POST http://<IP_Address>/api/mo/sys/stp/inst.json
{
"stpInst": {
"attributes": {
"ctrl": "network"
}
}
}
{
imdata": []
}
This example changes the spanning tree port type to 'network'.
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpInst | sys/stp/inst |
stpInst Properties
The following table contains information about the stpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
ctrl | nw:InstCtrl (scalar:Bitmask64) | The control state. | SELECTION: 1 - stateful-ha DEFAULT: normal |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Enabling Additional Settings for the Spanning Tree Port Type
This section uses payload examples to demonstrate how to enable additional settings for the spanning tree port type.
Setting the Spanning Tree Port Type to extchp-bpdu-filter
Setting the Spanning Tree Port Type to extchp-bpdu-filter
POST http://<IP_Address>/api/mo/sys/stp/inst.json
{
"stpInst": {
"attributes": {
"ctrl": "extchp-bpdu-filter"
}
}
}
{
"imdata": []
}
You can provide additional settings for the "ctrl" object to enable additional settings for the spanning tree port type. For example, you can set the value to:
- "extchp-bpdu-guard"
- "extchp-bpdu-filter"
- "" - This specifies a port type of "none"
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpInst | sys/stp/inst |
stpInst Properties
The following table contains information about the stpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
ctrl | nw:InstCtrl (scalar:Bitmask64) | The control state. | SELECTION: 1 - stateful-ha DEFAULT: normal |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Setting the Spanning Tree Port Type to None ("")
Setting the Spanning Tree Port Type to None ("")
{
"stpInst": {
"attributes": {
"ctrl": ""
}
}
}
{
"imdata": []
}
You can provide additional settings for the "ctrl" object to enable additional settings for the spanning tree port type. For example, you can set the value to:
- "extchp-bpdu-guard"
- "extchp-bpdu-filter"
- "" - This specifies a port type of "none"
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpInst | sys/stp/inst |
stpInst Properties
The following table contains information about the stpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
ctrl | nw:InstCtrl (scalar:Bitmask64) | The control state. | SELECTION: 1 - stateful-ha DEFAULT: normal |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Enabling or Disabling Spanning Tree Protocol on a VLAN
Enabling or Disabling Spanning Tree Protocol on a VLAN
POST http://<IP_Address>/api/mo/sys/stp/inst/vlan-33.json
{
"stpVlan": {
"attributes": {
"adminSt": "enabled"
}
}
}
{
imdata": []
}
To enable STP, set the "adminSt" value to "enabled." To disable STP, set the "adminSt" value to "disabled".
This example enables STP on VLAN 33.
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpVlan | sys/stp/inst/vlan-{id} |
stpVlan Properties
The following table contains information about the stpVlan properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
adminSt | nw:AdminSt (scalar:Enum8) | Admin State | SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Setting an Interface Port Type
Setting an Interface Port Type
POST http://<IP_Address>/api/mo/sys/stp/inst/if-[eth5/1].json
{
"stpIf": {
"attributes": {
"mode": "network"
}
}
}
{
"imdata": []
}
This example sets the interface port type on the eth5/1 interface to 'network'.
By changing the value of the "mode" parameter, you can specify other interface port type values; for example:
- "edge"
- "normal"
- "default"
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpIf | sys/stp/inst/if-{[id]} |
stpIf Properties
The following table contains information about the stpIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
mode | stp:IfMode (scalar:Enum8) | Port mode | SELECTION: 0 - default 1 - edge 2 - network 3 - normal 4 - trunk DEFAULT: default |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring the Bridge Priority for the Spanning Tree
Configuring the Bridge Priority for the Spanning Tree
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"stpEntity": {
"children": [
{
"stpInst": {
"children": [
{
"stpMstEntity": {
"children": [
{
"stpMstDom": {
"attributes": {
"id": "9",
"priority": "61440"
}
}
},
{
"stpMstDom": {
"attributes": {
"id": "7",
"priority": "61440"
}
}
},
{
"stpMstDom": {
"attributes": {
"id": "8",
"priority": "61440"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<mstent-items>
<mst-items>
<MstDom-list>
<id>9</id>
<priority>61440</priority>
</MstDom-list>
<MstDom-list>
<id>7</id>
<priority>61440</priority>
</MstDom-list>
<MstDom-list>
<id>8</id>
<priority>61440</priority>
</MstDom-list>
</mst-items>
</mstent-items>
</inst-items>
</stp-items>
</System>
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
spanning-tree mst 7-9 priority 61440
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
topSystem | sys |
stpEntity | sys/stp |
stpInst | sys/stp/inst |
stpMstEntity | sys/stp/inst/mstent |
stpMstDom | sys/stp/inst/mstent/mst-{id} |
stpMstDom Properties
The following table contains information about the stpMstDom properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | stp:MstId (scalar:Uint16) | Id | RANGE: [0 , 4094] DEFAULT: 0 |
priority | stp:BridgePriority (scalar:Uint16) | Bridge Priority | RANGE: [0 , 61440] DEFAULT: 32768 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting the Bridge Priority for the Spanning Tree
Deleting the Bridge Priority for the Spanning Tree
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"stpEntity": {
"children": [
{
"stpInst": {
"children": [
{
"stpMstEntity": {
"children": [
{
"stpMstDom": {
"attributes": {
"id": "9",
"priority": "32768"
}
}
},
{
"stpMstDom": {
"attributes": {
"id": "7",
"priority": "32768"
}
}
},
{
"stpMstDom": {
"attributes": {
"id": "8",
"priority": "32768"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<mstent-items>
<mst-items>
<MstDom-list>
<id>9</id>
<priority>32768</priority>
</MstDom-list>
<MstDom-list>
<id>7</id>
<priority>32768</priority>
</MstDom-list>
<MstDom-list>
<id>8</id>
<priority>32768</priority>
</MstDom-list>
</mst-items>
</mstent-items>
</inst-items>
</stp-items>
</System>
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
no spanning-tree mst 7-9 priority 61440
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
topSystem | sys |
stpEntity | sys/stp |
stpInst | sys/stp/inst |
stpMstEntity | sys/stp/inst/mstent |
stpMstDom | sys/stp/inst/mstent/mst-{id} |
stpMstDom Properties
The following table contains information about the stpMstDom properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | stp:MstId (scalar:Uint16) | Id | RANGE: [0 , 4094] DEFAULT: 0 |
priority | stp:BridgePriority (scalar:Uint16) | Bridge Priority | RANGE: [0 , 61440] DEFAULT: 32768 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring the Forward Delay for the Spanning Tree
Configuring the Forward Delay for the Spanning Tree
POST http://<mgmt0_IP>/api/mo/sys/stp/inst.json
{
"stpInst": {
"children": [
{
"stpMstEntity": {
"attributes": {
"fwdTime": "25"
}}}]}}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<mstent-items>
<fwdTime>25</fwdTime>
</mstent-items>
</inst-items>
</stp-items>
</System>
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
spanning-tree mst forward-time 25
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpInst | sys/stp/inst |
stpMstEntity | sys/stp/inst/mstent |
stpMstEntity Properties
The following table contains information about the stpMstEntity properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
fwdTime | stp:FwdTime (scalar:UByte) | STP forward delay | RANGE: [4 , 30] DEFAULT: 15 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting the Forward Delay for the Spanning Tree
Deleting the Forward Delay for the Spanning Tree
POST http://<mgmt0_IP>/api/mo/sys/stp/inst.json
{
"stpInst": {
"children": [
{
"stpMstEntity": {
"attributes": {
"fwdTime": "15"
}}}]}}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<mstent-items>
<fwdTime>15</fwdTime>
</mstent-items>
</inst-items>
</stp-items>
</System>
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
no spanning-tree mst forward-time 25
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpInst | sys/stp/inst |
stpMstEntity | sys/stp/inst/mstent |
stpMstEntity Properties
The following table contains information about the stpMstEntity properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
fwdTime | stp:FwdTime (scalar:UByte) | STP forward delay | RANGE: [4 , 30] DEFAULT: 15 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring the the Hello Interval for the Spanning Tree
Configuring the the Hello Interval for the Spanning Tree
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"stpEntity": {
"children": [
{
"stpInst": {
"children": [
{
"stpMstEntity": {
"attributes": {
"helloTime": "7"
}
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<mstent-items>
<helloTime>7</helloTime>
</mstent-items>
</inst-items>
</stp-items>
</System>
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
spanning-tree mst hello-time 7
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
topSystem | sys |
stpEntity | sys/stp |
stpInst | sys/stp/inst |
stpMstEntity | sys/stp/inst/mstent |
stpMstEntity Properties
The following table contains information about the stpMstEntity properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
helloTime | stp:HelloTime (scalar:UByte) | STP Hello interval | RANGE: [1 , 10] DEFAULT: 2 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting the Hello Interval for the Spanning Tree
Deleting the Hello Interval for the Spanning Tree
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"stpEntity": {
"children": [
{
"stpInst": {
"children": [
{
"stpMstEntity": {
"attributes": {
"helloTime": "2"
}
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<mstent-items>
<helloTime>2</helloTime>
</mstent-items>
</inst-items>
</stp-items>
</System>
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
no spanning-tree mst hello-time 7
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
topSystem | sys |
stpEntity | sys/stp |
stpInst | sys/stp/inst |
stpMstEntity | sys/stp/inst/mstent |
stpMstEntity Properties
The following table contains information about the stpMstEntity properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
helloTime | stp:HelloTime (scalar:UByte) | STP Hello interval | RANGE: [1 , 10] DEFAULT: 2 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring the Max Age Interval for the Spanning Tree
Configuring the Max Age Interval for the Spanning Tree
POST http://<mgmt0_IP>/api/mo/sys/stp/inst.json
{
"stpInst": {
"children": [
{
"stpMstEntity": {
"attributes": {
"maxAge": "25"
}}}]}}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<mstent-items>
<maxAge>25</maxAge>
</mstent-items>
</inst-items>
</stp-items>
</System>
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
spanning-tree mst max-age 25
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpInst | sys/stp/inst |
stpMstEntity | sys/stp/inst/mstent |
stpMstEntity Properties
The following table contains information about the stpMstEntity properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
maxAge | stp:MaxAge (scalar:UByte) | STP max age interval | RANGE: [6 , 40] DEFAULT: 20 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting the Max Age Interval for the Spanning Tree
Deleting the Max Age Interval for the Spanning Tree
POST http://<mgmt0_IP>/api/mo/sys/stp/inst.json
{
"stpInst": {
"children": [
{
"stpMstEntity": {
"attributes": {
"maxAge": "20"
}}}]}}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<mstent-items>
<maxAge>20</maxAge>
</mstent-items>
</inst-items>
</stp-items>
</System>
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
no spanning-tree mst max-age 25
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpInst | sys/stp/inst |
stpMstEntity | sys/stp/inst/mstent |
stpMstEntity Properties
The following table contains information about the stpMstEntity properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
maxAge | stp:MaxAge (scalar:UByte) | STP max age interval | RANGE: [6 , 40] DEFAULT: 20 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring the Max Hops Value for the Spanning Tree
Configuring the Max Hops Value for the Spanning Tree
POST http://<mgmt0_IP>/api/mo/sys/stp/inst.json
{
"stpInst": {
"children": [
{
"stpMstEntity": {
"attributes": {
"maxHops": "125"
}}}]}}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<mstent-items>
<maxHops>125</maxHops>
</mstent-items>
</inst-items>
</stp-items>
</System>
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
spanning-tree mst max-hops 125
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpInst | sys/stp/inst |
stpMstEntity | sys/stp/inst/mstent |
stpMstEntity Properties
The following table contains information about the stpMstEntity properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
maxHops | stp:MaxHops (scalar:UByte) | STP mst max hops | RANGE: [1 , 255] DEFAULT: 20 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting the Max Hops Value for the Spanning Tree
Deleting the Max Hops Value for the Spanning Tree
POST http://<mgmt0_IP>/api/mo/sys/stp/inst.json
{
"stpInst": {
"children": [
{
"stpMstEntity": {
"attributes": {
"maxHops": "20"
}}}]}}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<mstent-items>
<maxHops>20</maxHops>
</mstent-items>
</inst-items>
</stp-items>
</System>
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
no spanning-tree mst max-hops 125
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpInst | sys/stp/inst |
stpMstEntity | sys/stp/inst/mstent |
stpMstEntity Properties
The following table contains information about the stpMstEntity properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
maxHops | stp:MaxHops (scalar:UByte) | STP mst max hops | RANGE: [1 , 255] DEFAULT: 20 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Enabling Spanning Tree Domain
Enabling Spanning Tree Domain
POST http://<mgmt0_IP>/api/mo/sys/stp.json
{
"stpEntity": {
"children": [
{
"stpInst": {
"attributes": {
"l2GStpDomId": "0"
}}}]}}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<l2GStpDomId>0</l2GStpDomId>
</inst-items>
</stp-items>
</System>
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
spanning-tree domain enable
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpEntity | sys/stp |
stpInst | sys/stp/inst |
stpInst Properties
The following table contains information about the stpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
l2GStpDomId | stp:L2GStpDomId (scalar:Uint32) | spanning tree L2 Gateway Domain Id | RANGE: [0 , 200000000] DEFAULT: 1024 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Disabling Spanning Tree Domain
Disabling Spanning Tree Domain
POST http://<mgmt0_IP>/api/mo/sys/stp.json
{
"stpEntity": {
"children": [
{
"stpInst": {
"attributes": {
"l2GStpDomId": "1024"
}}}]}}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<l2GStpDomId>1024</l2GStpDomId>
</inst-items>
</stp-items>
</System>
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
spanning-tree domain disable
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpEntity | sys/stp |
stpInst | sys/stp/inst |
stpInst Properties
The following table contains information about the stpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
l2GStpDomId | stp:L2GStpDomId (scalar:Uint32) | spanning tree L2 Gateway Domain Id | RANGE: [0 , 200000000] DEFAULT: 1024 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting an Enabled Spanning Tree Domain
Deleting an Enabled Spanning Tree Domain
POST http://<mgmt0_IP>/api/mo/sys/stp.json
{
"stpEntity": {
"children": [
{
"stpInst": {
"attributes": {
"l2GStpDomId": "1024"
}}}]}}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<l2GStpDomId>1024</l2GStpDomId>
</inst-items>
</stp-items>
</System>
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
no spanning-tree domain enable
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpEntity | sys/stp |
stpInst | sys/stp/inst |
stpInst Properties
The following table contains information about the stpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
l2GStpDomId | stp:L2GStpDomId (scalar:Uint32) | spanning tree L2 Gateway Domain Id | RANGE: [0 , 200000000] DEFAULT: 1024 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring a Spanning-Tree Domain
Example: <description>
POST http://<mgmt0_IP>/api/mo/sys/stp.json
{
"stpEntity": {
"children": [
{
"stpInst": {
"attributes": {
"l2GStpDomId": "123"
}}}]}}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<l2GStpDomId>123</l2GStpDomId>
</inst-items>
</stp-items>
</System>
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
spanning-tree domain 123
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpEntity | sys/stp |
stpInst | sys/stp/inst |
stpInst Properties
The following table contains information about the stpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
l2GStpDomId | stp:L2GStpDomId (scalar:Uint32) | spanning tree L2 Gateway Domain Id | RANGE: [0 , 200000000] DEFAULT: 1024 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Enabling Portfast
Enabling Portfast
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"stpEntity": {
"children": [
{
"stpInst": {
"children": [
{
"stpIf": {
"attributes": {
"id": "eth1/27",
"mode": "edge"
}
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
POST: http://<IP_Address>/restconf/data/Cisco-NX-OS-device:
<stp-items>
<inst-items>
<if-items>
<If-list>
<id>eth1/27</id>
<mode>edge</mode>
</If-list>
</if-items>
</inst-items>
</stp-items>
</System>
CLI Commands
interface ethernet 1/27
spanning-tree port type edge
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the opt-left corner of the pane on the right to view the JSON payload. Click the YANG tab to view the xML payload.
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
topSystem | sys |
stpEntity | sys/stp |
stpInst | sys/stp/inst |
stpIf | sys/stp/inst/if-{[id]} |
stpIf Properties
The following table contains information about the stpIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
mode | stp:IfMode (scalar:Enum8) | Port mode | SELECTION: 0 - default 1 - edge 2 - network 3 - normal 4 - trunk DEFAULT: default |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Disabling Portfast
Disabling Portfast
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"stpEntity": {
"children": [
{
"stpInst": {
"children": [
{
"stpIf": {
"attributes": {
"id": "eth1/27",
"mode": "default"
}
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
POST: http://<IP_Address>/restconf/data/Cisco-NX-OS-device:
<stp-items>
<inst-items>
<if-items>
<If-list>
<id>eth1/27</id>
<mode>default</mode>
</If-list>
</if-items>
</inst-items>
</stp-items>
</System>
CLI Commands
interface ethernet 1/27
no spanning-tree port type edge
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the opt-left corner of the pane on the right to view the JSON payload. Click the YANG tab to view the xML payload.
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
topSystem | sys |
stpEntity | sys/stp |
stpInst | sys/stp/inst |
stpIf | sys/stp/inst/if-{[id]} |
stpIf Properties
The following table contains information about the stpIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
mode | stp:IfMode (scalar:Enum8) | Port mode | SELECTION: 0 - default 1 - edge 2 - network 3 - normal 4 - trunk DEFAULT: default |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring VLAN Switch Spanning Trees
Configuring VLAN Switch Spanning Trees
POST http://<mgmt0_IP>/api/mo/sys/stp/inst.json
{
"stpInst": {
"children": [
{
"stpVlan": {
"attributes": {
"adminSt": "enabled",
"id": "1"
}}}]}}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<vlan-items>
<Vlan-list>
<id>1</id>
<adminSt>enabled</adminSt>
</Vlan-list>
</vlan-items>
</inst-items>
</stp-items>
</System>
Note: This example was added in Release 9.2(2).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
spanning-tree vlan 1
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpInst | sys/stp/inst |
stpVlan | sys/stp/inst/vlan-{id} |
stpVlan Properties
The following table contains information about the stpVlan properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
adminSt | nw:AdminSt (scalar:Enum8) | Admin State | SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled |
id | stp:VlanId (scalar:Uint16) | Access Encapsulation | RANGE: [1 , 4096] DEFAULT: 1 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting VLAN Switch Spanning Trees
Deleting VLAN Switch Spanning Trees
POST http://<mgmt0_IP>/api/mo/sys/stp/inst.json
{
"stpInst": {
"children": [
{
"stpVlan": {
"attributes": {
"adminSt": "disabled",
"id": "1"
}}}]}}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<vlan-items>
<Vlan-list>
<id>1</id>
<adminSt>disabled</adminSt>
</Vlan-list>
</vlan-items>
</inst-items>
</stp-items>
</System>
Note: This example was added in Release 9.2(2).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
no spanning-tree vlan 1
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpInst | sys/stp/inst |
stpVlan | sys/stp/inst/vlan-{id} |
stpVlan Properties
The following table contains information about the stpVlan properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
adminSt | nw:AdminSt (scalar:Enum8) | Admin State | SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled |
id | stp:VlanId (scalar:Uint16) | Access Encapsulation | RANGE: [1 , 4096] DEFAULT: 1 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring Multiple Spanning Tree (Setting the Switch as Primary Root and the Hello-Time Interval)
Configuring Multiple Spanning Tree (Setting the Switch as Primary Root and the Hello-Time Interval)
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"stpEntity": {
"children": [
{
"stpInst": {
"children": [
{
"stpMstEntity": {
"children": [
{
"stpMstDom": {
"attributes": {
"diameter": "2",
"id": "9",
"rootMode": "enabled",
"rootType": "primary"
}
}
},
{
"stpMstDom": {
"attributes": {
"diameter": "2",
"id": "7",
"rootMode": "enabled",
"rootType": "primary"
}
}
},
{
"stpMstDom": {
"attributes": {
"diameter": "2",
"id": "8",
"rootMode": "enabled",
"rootType": "primary"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<mstent-items>
<mst-items>
<MstDom-list>
<id>9</id>
<diameter>2</diameter>
<rootMode>enabled</rootMode>
<rootType>primary</rootType>
</MstDom-list>
<MstDom-list>
<id>7</id>
<diameter>2</diameter>
<rootMode>enabled</rootMode>
<rootType>primary</rootType>
</MstDom-list>
<MstDom-list>
<id>8</id>
<diameter>2</diameter>
<rootMode>enabled</rootMode>
<rootType>primary</rootType>
</MstDom-list>
</mst-items>
</mstent-items>
</inst-items>
</stp-items>
</System>
Options for configuring the switch as root:
- primary - Configure this switch as primary root for this spanning tree
- secondary - Configure this switch as secondary root
Note: This example was added in Release 9.2(2).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
spanning-tree mst 7-9 root primary diameter 2 hello-time 7
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
topSystem | sys |
stpEntity | sys/stp |
stpInst | sys/stp/inst |
stpMstEntity | sys/stp/inst/mstent |
stpMstDom | sys/stp/inst/mstent/mst-{id} |
stpMstDom Properties
The following table contains information about the stpMstDom properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
diameter | stp:Diameter (scalar:UByte) | Network Diameter | RANGE: [2 , 7] DEFAULT: 2 |
id | stp:MstId (scalar:Uint16) | Id | RANGE: [0 , 4094] DEFAULT: 0 |
rootMode | stp:RootMode (scalar:Enum8) | Bridge Root Config mode | SELECTION: 0 - disabled 1 - enabled DEFAULT: disabled |
rootType | stp:RootType (scalar:Enum8) | Bridge Root Type | SELECTION: 0 - none 1 - primary 2 - secondary DEFAULT: none |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting a Multiple Spanning Tree Configuration
Deleting a Multiple Spanning Tree Configuration
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"stpEntity": {
"children": [
{
"stpInst": {
"children": [
{
"stpMstEntity": {
"children": [
{
"stpMstDom": {
"attributes": {
"id": "9",
"rootMode": "enabled",
"rootType": "none"
}
}
},
{
"stpMstDom": {
"attributes": {
"id": "7",
"rootMode": "enabled",
"rootType": "none"
}
}
},
{
"stpMstDom": {
"attributes": {
"id": "8",
"rootMode": "enabled",
"rootType": "none"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<mstent-items>
<mst-items>
<MstDom-list>
<id>9</id>
<rootMode>enabled</rootMode>
<rootType>none</rootType>
</MstDom-list>
<MstDom-list>
<id>7</id>
<rootMode>enabled</rootMode>
<rootType>none</rootType>
</MstDom-list>
<MstDom-list>
<id>8</id>
<rootMode>enabled</rootMode>
<rootType>none</rootType>
</MstDom-list>
</mst-items>
</mstent-items>
</inst-items>
</stp-items>
</System>
Note: This example was added in Release 9.2(2).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
no spanning-tree mst 7-9 root primary diameter 2 hello-time 7
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
topSystem | sys |
stpEntity | sys/stp |
stpInst | sys/stp/inst |
stpMstEntity | sys/stp/inst/mstent |
stpMstDom | sys/stp/inst/mstent/mst-{id} |
stpMstDom Properties
The following table contains information about the stpMstDom properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | stp:MstId (scalar:Uint16) | Id | RANGE: [0 , 4094] DEFAULT: 0 |
rootMode | stp:RootMode (scalar:Enum8) | Bridge Root Config mode | SELECTION: 0 - disabled 1 - enabled DEFAULT: disabled |
rootType | stp:RootType (scalar:Enum8) | Bridge Root Type | SELECTION: 0 - none 1 - primary 2 - secondary DEFAULT: none |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring Bridge-Domain Switch Spanning Trees
Configuring Bridge-Domain Switch Spanning Trees
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"stpEntity": {
"children": [
{
"stpInst": {
"children": [
{
"stpVlan": {
"attributes": {
"adminSt": "enabled",
"id": "5"
}
}
},
{
"stpVlan": {
"attributes": {
"adminSt": "enabled",
"id": "4"
}
}
},
{
"stpVlan": {
"attributes": {
"adminSt": "enabled",
"id": "2"
}
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<vlan-items>
<Vlan-list>
<id>5</id>
<adminSt>1</adminSt>
</Vlan-list>
<Vlan-list>
<id>4</id>
<adminSt>1</adminSt>
</Vlan-list>
<Vlan-list>
<id>2</id>
<adminSt>1</adminSt>
</Vlan-list>
</vlan-items>
</inst-items>
</stp-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
spanning-tree bridge-domain 2,4-5
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpEntity | sys/stp |
stpInst | sys/stp/inst |
stpVlan | sys/stp/inst/vlan-5 |
topSystem | sys |
stpVlan Properties
The following table contains information about the stpVlan properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
adminSt | nw:AdminSt (scalar:Enum8) | Admin State | SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled |
id | stp:VlanId (scalar:Uint16) | Access Encapsulation | RANGE: [1 , 4096] DEFAULT: 1 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting Bridge-Domain Switch Spanning Trees
Deleting Bridge-Domain Switch Spanning Trees
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"stpEntity": {
"children": [
{
"stpInst": {
"children": [
{
"stpVlan": {
"attributes": {
"adminSt": "disabled",
"id": "5"
}
}
},
{
"stpVlan": {
"attributes": {
"adminSt": "disabled",
"id": "4"
}
}
},
{
"stpVlan": {
"attributes": {
"adminSt": "disabled",
"id": "2"
}
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<vlan-items>
<Vlan-list>
<id>5</id>
<adminSt>2</adminSt>
</Vlan-list>
<Vlan-list>
<id>4</id>
<adminSt>2</adminSt>
</Vlan-list>
<Vlan-list>
<id>2</id>
<adminSt>2</adminSt>
</Vlan-list>
</vlan-items>
</inst-items>
</stp-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
no spanning-tree bridge-domain 2,4-5
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpEntity | sys/stp |
stpInst | sys/stp/inst |
stpVlan | sys/stp/inst/vlan-5 |
topSystem | sys |
stpVlan Properties
The following table contains information about the stpVlan properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
adminSt | nw:AdminSt (scalar:Enum8) | Admin State | SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled |
id | stp:VlanId (scalar:Uint16) | Access Encapsulation | RANGE: [1 , 4096] DEFAULT: 1 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring Line Card ISSU as Nondisruptive
Configuring Line Card ISSU as Nondisruptive
POST http://<mgmt0_IP>/api/mo/sys/stp.json
{
"stpEntity": {
"children": [
{
"stpInst": {
"attributes": {
"lcIssu": "non-disruptive"
}}}]}}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<lcIssu>2</lcIssu>
</inst-items>
</stp-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
spanning-tree lc-issu non-disruptive
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpEntity | sys/stp |
stpInst | sys/stp/inst |
stpInst Properties
The following table contains information about the stpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
lcIssu | stp:LcIssu (scalar:Enum8) | Linecard ISSU type | SELECTION: 0 - default 1 - disruptive 2 - non-disruptive 3 - auto DEFAULT: default |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting Line Card ISSU as Nondisruptive
Deleting Line Card ISSU as Nondisruptive
POST http://<mgmt0_IP>/api/mo/sys/stp.json
{
"stpEntity": {
"children": [
{
"stpInst": {
"attributes": {
"lcIssu": "default"
}}}]}}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<lcIssu>0</lcIssu>
</inst-items>
</stp-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
no spanning-tree lc-issu non-disruptive
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpEntity | sys/stp |
stpInst | sys/stp/inst |
stpInst Properties
The following table contains information about the stpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
lcIssu | stp:LcIssu (scalar:Enum8) | Linecard ISSU type | SELECTION: 0 - default 1 - disruptive 2 - non-disruptive 3 - auto DEFAULT: default |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring Pre-Standard MST BPDU Transmission on Port
Configuring Pre-Standard MST BPDU Transmission on Port
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"stpEntity": {
"children": [
{
"stpInst": {
"children": [
{
"stpIf": {
"attributes": {
"id": "eth1/2",
"prestdCfg": "enabled"
}
}
}
]
}
}
]
}
},
{
"interfaceEntity": {
"children": [
{
"l1PhysIf": {
"attributes": {
"id": "eth1/2",
"layer": "Layer2",
"userCfgdFlags": "admin_layer"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<if-items>
<If-list>
<id>eth1/2</id>
<prestdCfg>1</prestdCfg>
</If-list>
</if-items>
</inst-items>
</stp-items>
<intf-items>
<phys-items>
<PhysIf-list>
<id>eth1/2</id>
<layer>1</layer>
<userCfgdFlags>admin_layer</userCfgdFlags>
</PhysIf-list>
</phys-items>
</intf-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface ethernet 1/2
switchport
spanning-tree mst pre-standard
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
interfaceEntity | sys/intf |
l1PhysIf | sys/intf/phys-[eth1/2] |
stpEntity | sys/stp |
stpIf | sys/stp/inst/if-[eth1/2] |
stpInst | sys/stp/inst |
topSystem | sys |
l1PhysIf Properties
The following table contains information about the l1PhysIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
layer | l1:Layer (scalar:Enum8) | Administrative port layer | SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: pltfmDfltLayer |
userCfgdFlags | l1:userCfgdFlags (scalar:Bitmask8) | Port User Config Flags | SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none |
stpIf Properties
The following table contains information about the stpIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
prestdCfg | stp:AdminSt (scalar:Enum8) | Port mst prestd | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting Pre-Standard MST BPDU Transmission on Port
Deleting Pre-Standard MST BPDU Transmission on Port
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"stpEntity": {
"children": [
{
"stpInst": {
"children": [
{
"stpIf": {
"attributes": {
"id": "eth1/2",
"prestdCfg": "disabled"
}
}
}
]
}
}
]
}
},
{
"interfaceEntity": {
"children": [
{
"l1PhysIf": {
"attributes": {
"id": "eth1/2",
"layer": "Layer2",
"userCfgdFlags": "admin_layer"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<if-items>
<If-list>
<id>eth1/2</id>
<prestdCfg>2</prestdCfg>
</If-list>
</if-items>
</inst-items>
</stp-items>
<intf-items>
<phys-items>
<PhysIf-list>
<id>eth1/2</id>
<layer>1</layer>
<userCfgdFlags>admin_layer</userCfgdFlags>
</PhysIf-list>
</phys-items>
</intf-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface ethernet 1/2
switchport
no spanning-tree mst pre-standard
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
interfaceEntity | sys/intf |
l1PhysIf | sys/intf/phys-[eth1/2] |
stpEntity | sys/stp |
stpIf | sys/stp/inst/if-[eth1/2] |
stpInst | sys/stp/inst |
topSystem | sys |
l1PhysIf Properties
The following table contains information about the l1PhysIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
layer | l1:Layer (scalar:Enum8) | Administrative port layer | SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: pltfmDfltLayer |
userCfgdFlags | l1:userCfgdFlags (scalar:Bitmask8) | Port User Config Flags | SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none |
stpIf Properties
The following table contains information about the stpIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
prestdCfg | stp:AdminSt (scalar:Enum8) | Port mst prestd | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring PVST Simulation
Configuring PVST Simulation
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"stpEntity": {
"children": [
{
"stpInst": {
"children": [
{
"stpIf": {
"attributes": {
"id": "eth1/2",
"simulatePvst": "enabled"
}
}
}
]
}
}
]
}
},
{
"interfaceEntity": {
"children": [
{
"l1PhysIf": {
"attributes": {
"id": "eth1/2",
"layer": "Layer2",
"userCfgdFlags": "admin_layer"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<if-items>
<If-list>
<id>eth1/2</id>
<simulatePvst>1</simulatePvst>
</If-list>
</if-items>
</inst-items>
</stp-items>
<intf-items>
<phys-items>
<PhysIf-list>
<id>eth1/2</id>
<layer>1</layer>
<userCfgdFlags>admin_layer</userCfgdFlags>
</PhysIf-list>
</phys-items>
</intf-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface ethernet 1/2
switchport
spanning-tree mst simulate pvst
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
interfaceEntity | sys/intf |
l1PhysIf | sys/intf/phys-[eth1/2] |
stpEntity | sys/stp |
stpIf | sys/stp/inst/if-[eth1/2] |
stpInst | sys/stp/inst |
topSystem | sys |
l1PhysIf Properties
The following table contains information about the l1PhysIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
layer | l1:Layer (scalar:Enum8) | Administrative port layer | SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: pltfmDfltLayer |
userCfgdFlags | l1:userCfgdFlags (scalar:Bitmask8) | Port User Config Flags | SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none |
stpIf Properties
The following table contains information about the stpIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
simulatePvst | stp:SimulateIf (scalar:Enum8) | Port simulate pvst | SELECTION: 0 - default 1 - enabled 2 - disabled DEFAULT: default |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting PVST Simulation
Deleting PVST Simulation
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"stpEntity": {
"children": [
{
"stpInst": {
"children": [
{
"stpIf": {
"attributes": {
"id": "eth1/2",
"simulatePvst": "default"
}
}
}
]
}
}
]
}
},
{
"interfaceEntity": {
"children": [
{
"l1PhysIf": {
"attributes": {
"id": "eth1/2",
"layer": "Layer2",
"userCfgdFlags": "admin_layer"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<if-items>
<If-list>
<id>eth1/2</id>
<simulatePvst>0</simulatePvst>
</If-list>
</if-items>
</inst-items>
</stp-items>
<intf-items>
<phys-items>
<PhysIf-list>
<id>eth1/2</id>
<layer>1</layer>
<userCfgdFlags>admin_layer</userCfgdFlags>
</PhysIf-list>
</phys-items>
</intf-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface ethernet 1/2
switchport
no spanning-tree mst simulate pvst
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
interfaceEntity | sys/intf |
l1PhysIf | sys/intf/phys-[eth1/2] |
stpEntity | sys/stp |
stpIf | sys/stp/inst/if-[eth1/2] |
stpInst | sys/stp/inst |
topSystem | sys |
l1PhysIf Properties
The following table contains information about the l1PhysIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
layer | l1:Layer (scalar:Enum8) | Administrative port layer | SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: pltfmDfltLayer |
userCfgdFlags | l1:userCfgdFlags (scalar:Bitmask8) | Port User Config Flags | SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none |
stpIf Properties
The following table contains information about the stpIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
simulatePvst | stp:SimulateIf (scalar:Enum8) | Port simulate pvst | SELECTION: 0 - default 1 - enabled 2 - disabled DEFAULT: default |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring Line Card ISSU as Auto
Configuring Line Card ISSU as Auto
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"stpEntity": {
"children": [
{
"stpInst": {
"children": [
{
"stpIf": {
"attributes": {
"id": "eth1/2",
"lcIssu": "auto"
}
}
}
]
}
}
]
}
},
{
"interfaceEntity": {
"children": [
{
"l1PhysIf": {
"attributes": {
"id": "eth1/2",
"layer": "Layer2",
"userCfgdFlags": "admin_layer"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<if-items>
<If-list>
<id>eth1/2</id>
<lcIssu>3</lcIssu>
</If-list>
</if-items>
</inst-items>
</stp-items>
<intf-items>
<phys-items>
<PhysIf-list>
<id>eth1/2</id>
<layer>1</layer>
<userCfgdFlags>admin_layer</userCfgdFlags>
</PhysIf-list>
</phys-items>
</intf-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface ethernet 1/2
switchport
spanning-tree lc-issu auto
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
interfaceEntity | sys/intf |
l1PhysIf | sys/intf/phys-[eth1/2] |
stpEntity | sys/stp |
stpIf | sys/stp/inst/if-[eth1/2] |
stpInst | sys/stp/inst |
topSystem | sys |
l1PhysIf Properties
The following table contains information about the l1PhysIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
layer | l1:Layer (scalar:Enum8) | Administrative port layer | SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: pltfmDfltLayer |
userCfgdFlags | l1:userCfgdFlags (scalar:Bitmask8) | Port User Config Flags | SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none |
stpIf Properties
The following table contains information about the stpIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
lcIssu | stp:LcIssu (scalar:Enum8) | Port lc issu | SELECTION: 0 - default 1 - disruptive 2 - non-disruptive 3 - auto DEFAULT: default |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting Line Card ISSU as Auto
Deleting Line Card ISSU as Auto
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"stpEntity": {
"children": [
{
"stpInst": {
"children": [
{
"stpIf": {
"attributes": {
"id": "eth1/2",
"lcIssu": "default"
}
}
}
]
}
}
]
}
},
{
"interfaceEntity": {
"children": [
{
"l1PhysIf": {
"attributes": {
"id": "eth1/2",
"layer": "Layer2",
"userCfgdFlags": "admin_layer"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<if-items>
<If-list>
<id>eth1/2</id>
<lcIssu>0</lcIssu>
</If-list>
</if-items>
</inst-items>
</stp-items>
<intf-items>
<phys-items>
<PhysIf-list>
<id>eth1/2</id>
<layer>1</layer>
<userCfgdFlags>admin_layer</userCfgdFlags>
</PhysIf-list>
</phys-items>
</intf-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface ethernet 1/2
switchport
no spanning-tree lc-issu auto
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
interfaceEntity | sys/intf |
l1PhysIf | sys/intf/phys-[eth1/2] |
stpEntity | sys/stp |
stpIf | sys/stp/inst/if-[eth1/2] |
stpInst | sys/stp/inst |
topSystem | sys |
l1PhysIf Properties
The following table contains information about the l1PhysIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
layer | l1:Layer (scalar:Enum8) | Administrative port layer | SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: pltfmDfltLayer |
userCfgdFlags | l1:userCfgdFlags (scalar:Bitmask8) | Port User Config Flags | SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none |
stpIf Properties
The following table contains information about the stpIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
lcIssu | stp:LcIssu (scalar:Enum8) | Port lc issu | SELECTION: 0 - default 1 - disruptive 2 - non-disruptive 3 - auto DEFAULT: default |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring the Bridge Priority for the Spanning Tree (VLAN Switch)
Configuring the Bridge Priority for the Spanning Tree (VLAN Switch)
POST http://<mgmt0_IP>/api/mo/sys/stp/inst/pseudo.json
{
"stpPseudoInfo": {
"children": [
{
"stpVlanInst": {
"attributes": {
"designatedBridgePriority": "4096",
"id": "113"
}}}]}}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<pseudo-items>
<vlan-items>
<VlanInst-list>
<id>113</id>
<designatedBridgePriority>4096</designatedBridgePriority>
</VlanInst-list>
</vlan-items>
</pseudo-items>
</inst-items>
</stp-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
spanning-tree pseudo-information
vlan 113 designated priority 4096
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpPseudoInfo | sys/stp/inst/pseudo |
stpVlanInst | sys/stp/inst/pseudo/vlan-113 |
stpVlanInst Properties
The following table contains information about the stpVlanInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
designatedBridgePriority | stp:Priority (scalar:Enum8) | Designated Bridge Priority | SELECTION: 0 - 0 1 - 4096 2 - 8192 3 - 12288 4 - 16384 5 - 20480 6 - 24576 7 - 28672 8 - 32768 9 - 36864 10 - 40960 11 - 45056 12 - 49152 13 - 53248 14 - 57344 15 - 61440 DEFAULT: 32768 |
id | stp:VlanId (scalar:Uint16) | Access Encapsulation | RANGE: [1 , 4096] DEFAULT: 1 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting the Bridge Priority for the Spanning Tree (VLAN Switch)
Deleting the Bridge Priority for the Spanning Tree (VLAN Switch)
POST http://<mgmt0_IP>/api/mo/sys/stp/inst/pseudo.json
{
"stpPseudoInfo": {
"children": [
{
"stpVlanInst": {
"attributes": {
"designatedBridgePriority": "32768",
"id": "113"
}}}]}}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<pseudo-items>
<vlan-items>
<VlanInst-list>
<id>113</id>
<designatedBridgePriority>32768</designatedBridgePriority>
</VlanInst-list>
</vlan-items>
</pseudo-items>
</inst-items>
</stp-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
spanning-tree pseudo-information
no vlan 113 designated priority 4096
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpPseudoInfo | sys/stp/inst/pseudo |
stpVlanInst | sys/stp/inst/pseudo/vlan-113 |
stpVlanInst Properties
The following table contains information about the stpVlanInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
designatedBridgePriority | stp:Priority (scalar:Enum8) | Designated Bridge Priority | SELECTION: 0 - 0 1 - 4096 2 - 8192 3 - 12288 4 - 16384 5 - 20480 6 - 24576 7 - 28672 8 - 32768 9 - 36864 10 - 40960 11 - 45056 12 - 49152 13 - 53248 14 - 57344 15 - 61440 DEFAULT: 32768 |
id | stp:VlanId (scalar:Uint16) | Access Encapsulation | RANGE: [1 , 4096] DEFAULT: 1 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
CLEAR DOMAIN STATS
clear domain stats
POST http://<mgmt0_IP>/api/mo/sys/action.json
{
"actionLSubj": {
"attributes": {
"dn": "sys/action/lsubj-[sys]"
}
"children" : [{
"stpInstClearStatLTask": {
"attributes": {
"adminSt": "start",
"dn": "sys/action/lsubj-[sys]/stpInstClearStatLTask",
"freq": "one-shot"
}
}
}]
}
}
Note: This example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
actionLSubj | sys/action/lsubj-{[oDn]} |
stpInstClearStatLTask | sys/action/lsubj-{[oDn]}/stpInstClearStatLTask |
actionLSubj Properties
The following table contains information about the actionLSubj properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
dn | reference:BinRef | A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module. |
stpInstClearStatLTask Properties
The following table contains information about the stpInstClearStatLTask properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
adminSt | action:AdminSt scalar:Enum8 | The administrative state of the object or policy. | SELECTION:
|
dn | reference:BinRef | A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module. | |
freq | action:Freq scalar:Time | Frequency at which tasks are executed | SELECTION:
|
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Confirming Clear Domain Stats
Confirming Clear Domain Stats
GET http://<mgmt0_IP>/api/mo/sys/action.json?query-target=subtree
{
"totalCount": "4",
"imdata": [
{
"stpInstClearStatLTask": {
"attributes": {
"adminSt": "unknown",
"childAction": "",
"descr": "",
"dn": "sys/action/lsubj-[sys]/stpInstClearStatLTask",
"freq": "one-shot",
"modTs": "2019-12-16T22:35:04.644+00:00",
"peerClassId": "stpInstClearStatRslt",
"rSz": "100",
"rTm": "00:00:00:00.000",
"startTs": "never",
"status": "",
"type": "clear"
}
}
},
{
"stpInstClearStatRslt": {
"attributes": {
"ack": "no",
"childAction": "",
"descr": "SUCCESS",
"dn": "sys/action/lsubj-[sys]/stpInstClearStatRslt",
"endTs": "never",
"modTs": "never",
"operSt": "completed",
"peerClassId": "stpInstClearStatLTask",
"qual": "",
"rSz": "100",
"rTm": "00:00:00:00.000",
"startTs": "never",
"status": "",
"type": "clear"
}
}
}
}
Note: This example was added in Release 9.3(3).
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpInstClearStatLTask | sys/action/lsubj-{[oDn]}/stpInstClearStatLTask |
stpInstClearStatRslt | sys/action/lsubj-{[oDn]}/stpInstClearStatRslt |
stpInstClearStatLTask Properties
The following table contains information about the stpInstClearStatLTask properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
adminSt | action:AdminSt scalar:Enum8 | The administrative state of the object or policy. | SELECTION:
|
childAction | mo:ModificationChildAction scalar:Bitmask32 | Delete or ignore. For internal use only. | SELECTION:
|
descr | action:Descr string:Basic | RANGE: Min: "0" Max: "128" | |
dn | reference:BinRef | A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module. | |
freq | action:Freq scalar:Time | Frequency at which tasks are executed | SELECTION:
|
modTs | mo:TStamp scalar:Date | The time when this object was last modified. | SELECTION:
|
peerClassId | mo:MoClassId | The BGP neighbor. | DEFAULT: stpInstClearStatRslt |
rSz | action:RetentionSize scalar:Uint16 | The retention size of the task results. | RANGE:
Min: 1
Max: 1024 |
rTm | action:RetentionTime scalar:Time | The retention time of the task results. | |
startTs | mo:TStamp scalar:Date | The date and time when the task began. | SELECTION:
|
status | mo:ModificationStatus scalar:Bitmask32 | The upgrade status. This property is for internal use only. | SELECTION:
|
type | action:Type scalar:Enum8 | The specific type of the object or component. | SELECTION:
|
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring the Bridge Priority for the Spanning Tree (MST Config)
Configuring the Bridge Priority for the Spanning Tree (MST Config)
POST http://<mgmt0_IP>/api/mo/sys/stp/inst/pseudo.json
{
"stpPseudoInfo": {
"children": [
{
"stpMstInst": {
"attributes": {
"designatedPriority": "4096",
"id": "100"
}}}]}}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<pseudo-items>
<mstinst-items>
<MstInst-list>
<id>100</id>
<designatedPriority>4096</designatedPriority>
</MstInst-list>
</mstinst-items>
</pseudo-items>
</inst-items>
</stp-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
spanning-tree pseudo-information
mst 100 designated priority 4096
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpPseudoInfo | sys/stp/inst/pseudo |
stpMstInst | sys/stp/inst/pseudo/mstinst-100 |
stpMstInst Properties
The following table contains information about the stpMstInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
designatedPriority | stp:BridgePriority (scalar:Uint16) | Designated Priority | RANGE: [0 , 61440] DEFAULT: 32768 |
id | stp:MstId (scalar:Uint16) | Mst Instance Id | RANGE: [0 , 4094] DEFAULT: 0 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting the Bridge Priority for the Spanning Tree (MST Config)
Deleting the Bridge Priority for the Spanning Tree (MST Config)
POST http://<mgmt0_IP>/api/mo/sys/stp/inst/pseudo.json
{
"stpPseudoInfo": {
"children": [
{
"stpMstInst": {
"attributes": {
"designatedPriority": "32768",
"id": "100"
}}}]}}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<pseudo-items>
<mstinst-items>
<MstInst-list>
<id>100</id>
<designatedPriority>32768</designatedPriority>
</MstInst-list>
</mstinst-items>
</pseudo-items>
</inst-items>
</stp-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
spanning-tree pseudo-information
no mst 100 designated priority 4096
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpPseudoInfo | sys/stp/inst/pseudo |
stpMstInst | sys/stp/inst/pseudo/mstinst-100 |
stpMstInst Properties
The following table contains information about the stpMstInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
designatedPriority | stp:BridgePriority (scalar:Uint16) | Designated Priority | RANGE: [0 , 61440] DEFAULT: 32768 |
id | stp:MstId (scalar:Uint16) | Mst Instance Id | RANGE: [0 , 4094] DEFAULT: 0 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring the Root Bridge Priority for the Spanning Tree (MST Config)
Configuring the Root Bridge Priority for the Spanning Tree (MST Config)
POST http://<mgmt0_IP>/api/mo/sys/stp/inst/pseudo.json
{
"stpPseudoInfo": {
"children": [
{
"stpMstInst": {
"attributes": {
"id": "100",
"rootPriority": "4096"
}}}]}}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<pseudo-items>
<mstinst-items>
<MstInst-list>
<id>100</id>
<rootPriority>4096</rootPriority>
</MstInst-list>
</mstinst-items>
</pseudo-items>
</inst-items>
</stp-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
spanning-tree pseudo-information
mst 100 root priority 4096
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpPseudoInfo | sys/stp/inst/pseudo |
stpMstInst | sys/stp/inst/pseudo/mstinst-100 |
stpMstInst Properties
The following table contains information about the stpMstInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | stp:MstId (scalar:Uint16) | Mst Instance Id | RANGE: [0 , 4094] DEFAULT: 0 |
rootPriority | stp:BridgePriority (scalar:Uint16) | Root Priority | RANGE: [0 , 61440] DEFAULT: 32768 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting the Root Bridge Priority for the Spanning Tree (MST Config)
Deleting the Root Bridge Priority for the Spanning Tree (MST Config)
POST http://<mgmt0_IP>/api/mo/sys/stp/inst/pseudo.json
{
"stpPseudoInfo": {
"children": [
{
"stpMstInst": {
"attributes": {
"id": "100",
"rootPriority": "32768"
}}}]}}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<pseudo-items>
<mstinst-items>
<MstInst-list>
<id>100</id>
<rootPriority>32768</rootPriority>
</MstInst-list>
</mstinst-items>
</pseudo-items>
</inst-items>
</stp-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
spanning-tree pseudo-information
no mst 100 root priority 4096
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpPseudoInfo | sys/stp/inst/pseudo |
stpMstInst | sys/stp/inst/pseudo/mstinst-100 |
stpMstInst Properties
The following table contains information about the stpMstInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | stp:MstId (scalar:Uint16) | Mst Instance Id | RANGE: [0 , 4094] DEFAULT: 0 |
rootPriority | stp:BridgePriority (scalar:Uint16) | Root Priority | RANGE: [0 , 61440] DEFAULT: 32768 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring the Root Bridge Priority for the Spanning Tree (VLAN Switch)
Configuring the Root Bridge Priority for the Spanning Tree (VLAN Switch)
POST http://<mgmt0_IP>/api/mo/sys/stp/inst/pseudo.json
{
"stpPseudoInfo": {
"children": [
{
"stpVlanInst": {
"attributes": {
"id": "1042",
"rootBridgePriority": "4096"
}}}]}}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<pseudo-items>
<vlan-items>
<VlanInst-list>
<id>1042</id>
<rootBridgePriority>4096</rootBridgePriority>
</VlanInst-list>
</vlan-items>
</pseudo-items>
</inst-items>
</stp-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
spanning-tree pseudo-information
vlan 1042 root priority 4096
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpPseudoInfo | sys/stp/inst/pseudo |
stpVlanInst | sys/stp/inst/pseudo/vlan-1042 |
stpVlanInst Properties
The following table contains information about the stpVlanInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | stp:VlanId (scalar:Uint16) | Access Encapsulation | RANGE: [1 , 4096] DEFAULT: 1 |
rootBridgePriority | stp:Priority (scalar:Enum8) | Root Bridge Priority | SELECTION: 0 - 0 1 - 4096 2 - 8192 3 - 12288 4 - 16384 5 - 20480 6 - 24576 7 - 28672 8 - 32768 9 - 36864 10 - 40960 11 - 45056 12 - 49152 13 - 53248 14 - 57344 15 - 61440 DEFAULT: 32768 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting the Root Bridge Priority for the Spanning Tree (VLAN Switch)
Deleting the Root Bridge Priority for the Spanning Tree (VLAN Switch)
POST http://<mgmt0_IP>/api/mo/sys/stp/inst/pseudo.json
{
"stpPseudoInfo": {
"children": [
{
"stpVlanInst": {
"attributes": {
"id": "1042",
"rootBridgePriority": "32768"
}}}]}}
{
imdata:[]
}
<System>
<stp-items>
<inst-items>
<pseudo-items>
<vlan-items>
<VlanInst-list>
<id>1042</id>
<rootBridgePriority>32768</rootBridgePriority>
</VlanInst-list>
</vlan-items>
</pseudo-items>
</inst-items>
</stp-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
spanning-tree pseudo-information
no vlan 1042 root priority 4096
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
stpPseudoInfo | sys/stp/inst/pseudo |
stpVlanInst | sys/stp/inst/pseudo/vlan-1042 |
stpVlanInst Properties
The following table contains information about the stpVlanInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | stp:VlanId (scalar:Uint16) | Access Encapsulation | RANGE: [1 , 4096] DEFAULT: 1 |
rootBridgePriority | stp:Priority (scalar:Enum8) | Root Bridge Priority | SELECTION: 0 - 0 1 - 4096 2 - 8192 3 - 12288 4 - 16384 5 - 20480 6 - 24576 7 - 28672 8 - 32768 9 - 36864 10 - 40960 11 - 45056 12 - 49152 13 - 53248 14 - 57344 15 - 61440 DEFAULT: 32768 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide: