Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)

Latest

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Setting STP Mode to MST

DME

Copy
POST http://<IP_Address>/api/mo/sys/stp/inst.json
{
  "stpInst": {
    "attributes": {
      "mode": "mst"
    }
  }
}
Response
{
    imdata": []
}

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.

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-installation-and-configuration-guides-list.html/

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

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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 Rapid PVST

This example sets STP mode to support Rapid PVST.

Note: The property information for this example was added in Release 9.3(3).

MO	DN
stpInst	sys/stp/inst

stpInst Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Enabling or Disabling MST Spanning Tree Simulation

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

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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 the Spanning Tree Port Type to extchp-edge

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

MO	DN
stpInst	sys/stp/inst

stpInst Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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 the Spanning Tree Port Type to network

This example changes the spanning tree port type to 'network'.

Note: The property information for this example was added in Release 9.3(3).

MO	DN
stpInst	sys/stp/inst

stpInst Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

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

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

MO	DN
stpInst	sys/stp/inst

stpInst Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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 the Spanning Tree Port Type to None ("")

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

MO	DN
stpInst	sys/stp/inst

stpInst Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Enabling or Disabling Spanning Tree Protocol on a VLAN

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

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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 an Interface Port Type

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

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Configuring the Bridge Priority for the Spanning Tree

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

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Deleting the Bridge Priority for the Spanning Tree

CLI Commands

no spanning-tree mst 7-9 priority 61440

Note: The property information for this example was added in Release 9.3(3).

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

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Configuring the Forward Delay for the Spanning Tree

CLI Commands

spanning-tree mst forward-time 25

Note: The property information for this example was added in Release 9.3(3).

MO	DN
stpInst	sys/stp/inst
stpMstEntity	sys/stp/inst/mstent

stpMstEntity Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Deleting the Forward Delay for the Spanning Tree

CLI Commands

no spanning-tree mst forward-time 25

Note: The property information for this example was added in Release 9.3(3).

MO	DN
stpInst	sys/stp/inst
stpMstEntity	sys/stp/inst/mstent

stpMstEntity Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Configuring the the Hello Interval for the Spanning Tree

CLI Commands

spanning-tree mst hello-time 7

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystem	sys
stpEntity	sys/stp
stpInst	sys/stp/inst
stpMstEntity	sys/stp/inst/mstent

stpMstEntity Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Deleting the Hello Interval for the Spanning Tree

CLI Commands

no spanning-tree mst hello-time 7

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystem	sys
stpEntity	sys/stp
stpInst	sys/stp/inst
stpMstEntity	sys/stp/inst/mstent

stpMstEntity Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Configuring the Max Age Interval for the Spanning Tree

CLI Commands

spanning-tree mst max-age 25

Note: The property information for this example was added in Release 9.3(3).

MO	DN
stpInst	sys/stp/inst
stpMstEntity	sys/stp/inst/mstent

stpMstEntity Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Deleting the Max Age Interval for the Spanning Tree

CLI Commands

no spanning-tree mst max-age 25

Note: The property information for this example was added in Release 9.3(3).

MO	DN
stpInst	sys/stp/inst
stpMstEntity	sys/stp/inst/mstent

stpMstEntity Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Configuring the Max Hops Value for the Spanning Tree

CLI Commands

spanning-tree mst max-hops 125

Note: The property information for this example was added in Release 9.3(3).

MO	DN
stpInst	sys/stp/inst
stpMstEntity	sys/stp/inst/mstent

stpMstEntity Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Deleting the Max Hops Value for the Spanning Tree

CLI Commands

no spanning-tree mst max-hops 125

Note: The property information for this example was added in Release 9.3(3).

MO	DN
stpInst	sys/stp/inst
stpMstEntity	sys/stp/inst/mstent

stpMstEntity Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Enabling Spanning Tree Domain

CLI Commands

spanning-tree domain enable

Note: The property information for this example was added in Release 9.3(3).

MO	DN
stpEntity	sys/stp
stpInst	sys/stp/inst

stpInst Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Disabling Spanning Tree Domain

CLI Commands

spanning-tree domain disable

Note: The property information for this example was added in Release 9.3(3).

MO	DN
stpEntity	sys/stp
stpInst	sys/stp/inst

stpInst Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Deleting an Enabled Spanning Tree Domain

CLI Commands

no spanning-tree domain enable

Note: The property information for this example was added in Release 9.3(3).

MO	DN
stpEntity	sys/stp
stpInst	sys/stp/inst

stpInst Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Configuring a Spanning-Tree Domain

Example: <description>

CLI Commands

spanning-tree domain 123

Note: The property information for this example was added in Release 9.3(3).

MO	DN
stpEntity	sys/stp
stpInst	sys/stp/inst

stpInst Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Enabling Portfast

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

MO	DN
topSystem	sys
stpEntity	sys/stp
stpInst	sys/stp/inst
stpIf	sys/stp/inst/if-{[id]}

stpIf Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Disabling Portfast

CLI Commands

interface ethernet 1/27
no spanning-tree port type edge

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystem	sys
stpEntity	sys/stp
stpInst	sys/stp/inst
stpIf	sys/stp/inst/if-{[id]}

stpIf Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Configuring VLAN Switch Spanning Trees

Note: This example was added in Release 9.2(2).

CLI Commands

spanning-tree vlan 1

Note: The property information for this example was added in Release 9.3(3).

MO	DN
stpInst	sys/stp/inst
stpVlan	sys/stp/inst/vlan-{id}

stpVlan Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Deleting VLAN Switch Spanning Trees

Note: This example was added in Release 9.2(2).

CLI Commands

no spanning-tree vlan 1

Note: The property information for this example was added in Release 9.3(3).

MO	DN
stpInst	sys/stp/inst
stpVlan	sys/stp/inst/vlan-{id}

stpVlan Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Configuring Multiple Spanning Tree (Setting the Switch as Primary Root and the Hello-Time Interval)

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

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

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

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Deleting a Multiple Spanning Tree Configuration

Note: This example was added in Release 9.2(2).

CLI Commands

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

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

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Configuring Bridge-Domain Switch Spanning Trees

Note: This example was added in Release 9.3(1).

CLI Commands

spanning-tree bridge-domain 2,4-5

MO	DN
stpEntity	sys/stp
stpInst	sys/stp/inst
stpVlan	sys/stp/inst/vlan-5
topSystem	sys

stpVlan Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Deleting Bridge-Domain Switch Spanning Trees

Note: This example was added in Release 9.3(1).

CLI Commands

no spanning-tree bridge-domain 2,4-5

MO	DN
stpEntity	sys/stp
stpInst	sys/stp/inst
stpVlan	sys/stp/inst/vlan-5
topSystem	sys

stpVlan Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Configuring Line Card ISSU as Nondisruptive

Note: This example was added in Release 9.3(1).

CLI Commands

spanning-tree lc-issu non-disruptive

MO	DN
stpEntity	sys/stp
stpInst	sys/stp/inst

stpInst Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Deleting Line Card ISSU as Nondisruptive

Note: This example was added in Release 9.3(1).

CLI Commands

no spanning-tree lc-issu non-disruptive

MO	DN
stpEntity	sys/stp
stpInst	sys/stp/inst

stpInst Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Configuring Pre-Standard MST BPDU Transmission on Port

Note: This example was added in Release 9.3(1).

CLI Commands

interface ethernet 1/2
switchport
spanning-tree mst pre-standard

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

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Deleting Pre-Standard MST BPDU Transmission on Port

Note: This example was added in Release 9.3(1).

CLI Commands

interface ethernet 1/2
switchport
no spanning-tree mst pre-standard

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

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

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Configuring PVST Simulation

Note: This example was added in Release 9.3(1).

CLI Commands

interface ethernet 1/2
switchport
spanning-tree mst simulate pvst

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

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

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Deleting PVST Simulation

Note: This example was added in Release 9.3(1).

CLI Commands

interface ethernet 1/2
switchport
no spanning-tree mst simulate pvst

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

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

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Configuring Line Card ISSU as Auto

Note: This example was added in Release 9.3(1).

CLI Commands

interface ethernet 1/2
switchport
spanning-tree lc-issu auto

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

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

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Deleting Line Card ISSU as Auto

Note: This example was added in Release 9.3(1).

CLI Commands

interface ethernet 1/2
switchport
no spanning-tree lc-issu auto

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

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

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Configuring the Bridge Priority for the Spanning Tree (VLAN Switch)

Note: This example was added in Release 9.3(3).

CLI Commands

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Deleting the Bridge Priority for the Spanning Tree (VLAN Switch)

Note: This example was added in Release 9.3(3).

CLI Commands

spanning-tree pseudo-information
no vlan 113 designated priority 4096

Verifying a DME Configuration

MO	DN
stpPseudoInfo	sys/stp/inst/pseudo
stpVlanInst	sys/stp/inst/pseudo/vlan-113

stpVlanInst Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

CLEAR DOMAIN STATS

clear domain stats

Note: This example was added in Release 9.3(3).

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: 0 - unknown 1 - start 2 - stop 3 - suspend DEFAULT: unknown(0)
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: 0ull - one-shot DEFAULT: 0

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Confirming Clear Domain Stats

Note: This example was added in Release 9.3(3).

Note: The property information for this example was added in Release 9.3(3).

MO	DN
stpInstClearStatLTask	sys/action/lsubj-{[oDn]}/stpInstClearStatLTask
stpInstClearStatRslt	sys/action/lsubj-{[oDn]}/stpInstClearStatRslt

stpInstClearStatLTask Properties

Property Name	Data Type	Description	Values
adminSt	action:AdminSt scalar:Enum8	The administrative state of the object or policy.	SELECTION: 0 - unknown 1 - start 2 - stop 3 - suspend DEFAULT: unknown(0)
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent DEFAULT: 0
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: 0ull - one-shot DEFAULT: 0
modTs	mo:TStamp scalar:Date	The time when this object was last modified.	SELECTION: 0ull - never DEFAULT: never(0ull)
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 DEFAULT: 100
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: 0ull - never DEFAULT: never(0ull)
status	mo:ModificationStatus scalar:Bitmask32	The upgrade status. This property is for internal use only.	SELECTION: 16u - replaced 2u - created 4u - modified 8u - deleted DEFAULT: 0
type	action:Type scalar:Enum8	The specific type of the object or component.	SELECTION: 1 - clear 2 - reset 3 - reload 4 - locate 5 - install 6 - test 7 - collect 8 - interface-in-service DEFAULT: clear(1)

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Configuring the Bridge Priority for the Spanning Tree (MST Config)

Note: This example was added in Release 9.3(3).

CLI Commands

spanning-tree pseudo-information
mst 100 designated priority 4096

Verifying a DME Configuration

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Deleting the Bridge Priority for the Spanning Tree (MST Config)

Note: This example was added in Release 9.3(3).

CLI Commands

spanning-tree pseudo-information
no mst 100 designated priority 4096

Verifying a DME Configuration

MO	DN
stpPseudoInfo	sys/stp/inst/pseudo
stpMstInst	sys/stp/inst/pseudo/mstinst-100

stpMstInst Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Configuring the Root Bridge Priority for the Spanning Tree (MST Config)

Note: This example was added in Release 9.3(3).

CLI Commands

spanning-tree pseudo-information
mst 100 root priority 4096

Verifying a DME Configuration

MO	DN
stpPseudoInfo	sys/stp/inst/pseudo
stpMstInst	sys/stp/inst/pseudo/mstinst-100

stpMstInst Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Deleting the Root Bridge Priority for the Spanning Tree (MST Config)

Note: This example was added in Release 9.3(3).

CLI Commands

spanning-tree pseudo-information
no mst 100 root priority 4096

Verifying a DME Configuration

MO	DN
stpPseudoInfo	sys/stp/inst/pseudo
stpMstInst	sys/stp/inst/pseudo/mstinst-100

stpMstInst Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Configuring the Root Bridge Priority for the Spanning Tree (VLAN Switch)

Note: This example was added in Release 9.3(3).

CLI Commands

spanning-tree pseudo-information
vlan 1042 root priority 4096

Verifying a DME Configuration

MO	DN
stpPseudoInfo	sys/stp/inst/pseudo
stpVlanInst	sys/stp/inst/pseudo/vlan-1042

stpVlanInst Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

Deleting the Root Bridge Priority for the Spanning Tree (VLAN Switch)

Note: This example was added in Release 9.3(3).

CLI Commands

spanning-tree pseudo-information
no vlan 1042 root priority 4096

Verifying a DME Configuration

MO	DN
stpPseudoInfo	sys/stp/inst/pseudo
stpVlanInst	sys/stp/inst/pseudo/vlan-1042

stpVlanInst Properties

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:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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