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

Configuring a vPC Domain

DME

Copy
POST http://<IP_Address>/api/node/mo/sys/vpc/inst/dom.json
{
  "vpcDom": {
    "attributes": {
      "autoRecovery": "enabled",
      "delayRestoreSVI": "333",
      "excludeSVI": "555",
      "grcflCnstncyChck": "enabled",
      "id": "1",
      "peerGw": "enabled",
      "peerSwitch": "enabled",
      "rolePrio": "222",
      "sysMac": "00:03:00:04:00:05",
      "sysPrio": "111"
    },
    "children": [
      {
        "vpcKeepalive": {
          "attributes": {
            "destIp": "192.0.20.11"
}}}]}}

Configuring Virtual Port Channels

A virtual port channel (vPC) allows links that are physically connected to two different Cisco Nexus 9000 Series devices to appear as a single port channel by a third device (see figure). The third device can be a switch, server, or any other networking device that supports port channels. A vPC can provide Layer 2 multipathing, which allows you to create redundancy and increase the bisectional bandwidth by enabling multiple parallel paths between nodes and allowing load balancing traffic.

For more information, see the Cisco Nexus 9000 Series NX-OS Interfaces Configuration Guide:

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

Configuring a vPC Domain

This example:

Ensures that VLAN interface 555 does not go down on the vPC secondary device when the vPC peer link fails
Enables graceful consistency checking
Configures vPC peer devices to act as peer gateways
Configures a pure vPC peer switch topology
Manually configures the VPC peer device role
Manually configures a VPC domain MAC address
Manually configures the system priority

CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

vpc domain 1
auto-recovery
delay restore interface-vlan 333
dual-active exclude interface-vlan 555
graceful consistency-check
peer-gateway
peer-switch
role priority 222
system-mac 3.4.5
system-priority 111
peer-keepalive destination 192.0.20.11

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
vpcDom	sys/vpc/inst/dom
vpcKeepalive	sys/vpc/inst/dom/keepalive

vpcDom Properties

The following table contains information about the vpcDom 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
autoRecovery	nw:AdminSt (scalar:Enum8)	Auto Recovery	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
delayRestoreSVI	vpc:DelayRestoreSVI (scalar:Uint16)	Delay restore for SVI	RANGE: [1 , 3600] DEFAULT: 10
excludeSVI	vpc:ExcludeSVI (l2:VlanBitmap)	SVI List excluded from suspension when dual-active
grcflCnstncyChck	nw:AdminSt (scalar:Enum8)	Graceful Type-1 Consistency Check	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled
id	vpc:DomId (scalar:Uint16)	Domain id	RANGE: [1 , 1000]
peerGw	nw:AdminSt (scalar:Enum8)	Peer Gateway	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
peerSwitch	nw:AdminSt (scalar:Enum8)	vPC pair switches	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
rolePrio	vpc:RolePrio (scalar:Uint16)	role priority	RANGE: [1 , 65535] DEFAULT: 32667
sysMac	address:MAC	system mac	Value must match MM:MM:MM:SS:SS:SS format
sysPrio	vpc:SysPrio (scalar:Uint16)	system priority	RANGE: [1 , 65535] DEFAULT: 32667

vpcKeepalive Properties

The following table contains information about the vpcKeepalive 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
destIp	address:Ip	destination address	Value must match ipv4 or ipv6 known format

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

Creating the vPC Peer Link

Configures the selected port channel as the vPC peer link.

Prerequisites:

The port-channel must already exist. See Configuring Port Channels for detailed information about port channels.

CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

interface port-channel 10
vpc peer-link

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

MO	DN
vpcKeepalive	sys/vpc/inst/dom/keepalive
vpcPeerLink	sys/vpc/inst/dom/keepalive/peerlink

vpcPeerLink Properties

The following table contains information about the vpcPeerLink 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

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

Moving Other Port Channels into a vPC

This example configures the selected port channel into the vPC to connect to the downstream device.

Prerequisites:

The port-channel must already exist. See Configuring Port Channels for detailed information about port channels.

CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

interface port-channel 10
vpc 20

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

MO	DN
vpcIf	sys/vpc/inst/dom/if-{id}
vpcRsVpcConf	sys/vpc/inst/dom/if-{id}/rsvpcConf

vpcIf Properties

The following table contains information about the vpcIf 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	vpc:Id (scalar:Uint16)	The vPC interface identifier.	RANGE: [1 , 16384]

vpcRsVpcConf Properties

The following table contains information about the vpcRsVpcConf 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
tDn	reln:Dn reference:BinRef	null

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 Address Synchronization

IPv4 and IPv6 ND address synchronization supports faster convergence of address tables between the vPC peers.

CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

ip arp synchronize

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

MO	DN
pcAggrIf	sys/intf/aggr-{[id]}

pcAggrIf Properties

The following table contains information about the pcAggrIf 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

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 vPC Role Priority

Note: Change will take effect after user has performed one of the following:

Triggered "vpc role preempt" (non-disruptive - no traffic loss on STP root switch)
Re-initd the vPC peer-link (disruptive)

Warning: vPCs will be flapped on current primary vPC switch while attempting option 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.

vpc domain 123
role priority 123

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

MO	DN
vpcInst	sys/vpc/inst
vpcDom	sys/vpc/inst/dom

vpcDom Properties

Property Name	Data Type	Description	Values
id	vpc:DomId (scalar:Uint16)	Domain id	RANGE: [1 , 1000]
rolePrio	vpc:RolePrio (scalar:Uint16)	role priority	RANGE: [1 , 65535] DEFAULT: 32667

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 vPC Role Priority

Note: Change will take effect after user has performed one of the following:

Triggered "vpc role preempt" (non-disruptive - no traffic loss on STP root switch)
Re-initd the vPC peer-link (disruptive)

Warning: vPCs will be flapped on current primary vPC switch while attempting option 2.

CLI Commands

vpc domain 123
no role priority

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

MO	DN
vpcInst	sys/vpc/inst
vpcDom	sys/vpc/inst/dom

vpcDom Properties

Property Name	Data Type	Description	Values
id	vpc:DomId (scalar:Uint16)	Domain id	RANGE: [1 , 1000]
rolePrio	vpc:RolePrio (scalar:Uint16)	role priority	RANGE: [1 , 65535] DEFAULT: 32667

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 How Frequently to Print the Syslog

CLI Commands

vpc domain 123
layer3 peer-router syslog interval 123

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

MO	DN
vpcInst	sys/vpc/inst
vpcDom	sys/vpc/inst/dom

vpcDom Properties

Property Name	Data Type	Description	Values
id	vpc:DomId (scalar:Uint16)	Domain id	RANGE: [1 , 1000]
l3PeerRouterSyslog	nw:AdminSt (scalar:Enum8)	L3 Peer Router Syslog	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
l3PeerRouterSyslogInterval	vpc:L3PeerRouterSyslogInterval (scalar:Uint16)	L3 Peer Router Syslog Interval	RANGE: [1 , 3600] DEFAULT: 3600

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 Layer 3 Protocol Syslog

Deleting a Print Layer 3 Protocol Syslog

CLI Commands

vpc domain 123
no layer3 peer-router syslog

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

MO	DN
vpcInst	sys/vpc/inst
vpcDom	sys/vpc/inst/dom

vpcDom Properties

Property Name	Data Type	Description	Values
id	vpc:DomId (scalar:Uint16)	Domain id	RANGE: [1 , 1000]
l3PeerRouterSyslog	nw:AdminSt (scalar:Enum8)	L3 Peer Router Syslog	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
l3PeerRouterSyslogInterval	vpc:L3PeerRouterSyslogInterval (scalar:Uint16)	L3 Peer Router Syslog Interval	RANGE: [1 , 3600] DEFAULT: 3600

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 No Change for TTL of Packets Destined to the Peer

CLI Commands

vpc domain 123
layer3 peer-router

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

MO	DN
vpcInst	sys/vpc/inst
vpcDom	sys/vpc/inst/dom

vpcDom Properties

Property Name	Data Type	Description	Values
id	vpc:DomId (scalar:Uint16)	Domain id	RANGE: [1 , 1000]
l3PeerRouter	nw:AdminSt (scalar:Enum8)	L3 Peer Router	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

Disabling No Change for TTL of Packets Destined to the Peer

CLI Commands

vpc domain 123
no layer3 peer-router

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

MO	DN
vpcInst	sys/vpc/inst
vpcDom	sys/vpc/inst/dom

vpcDom Properties

Property Name	Data Type	Description	Values
id	vpc:DomId (scalar:Uint16)	Domain id	RANGE: [1 , 1000]
l3PeerRouter	nw:AdminSt (scalar:Enum8)	L3 Peer Router	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

Enabling Fast Convergence on a vPC Domain

CLI Commands

vpc domain 5
fast-convergence

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

MO	DN
vpcInst	sys/vpc/inst
vpcDom	sys/vpc/inst/dom

vpcDom Properties

Property Name	Data Type	Description	Values
fastConvergence	nw:AdminSt (scalar:Enum8)	Fast Convergence	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
id	vpc:DomId (scalar:Uint16)	Domain id	RANGE: [1 , 1000]

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 Fast Convergence on a vPC Domain

CLI Commands

vpc domain 5
no fast-convergence

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

MO	DN
vpcInst	sys/vpc/inst
vpcDom	sys/vpc/inst/dom

vpcDom Properties

Property Name	Data Type	Description	Values
fastConvergence	nw:AdminSt (scalar:Enum8)	Fast Convergence	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
id	vpc:DomId (scalar:Uint16)	Domain id	RANGE: [1 , 1000]

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

Querying the vPC Domain

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

MO	DN
vpcDom	sys/vpc/inst/dom

vpcDom Properties

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt (scalar:Enum8)	vPC suspend locally	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled
autoRecovery	nw:AdminSt (scalar:Enum8)	Auto Recovery	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
autoRecoveryIntvl	vpc:AutoRecoveryIntvl (scalar:Uint32)	Auto Recovery interval	RANGE: [60 , 3600] DEFAULT: 240
batchedVpcInv	vpc:BatchedVpcInv (scalar:Bitmask32)	batched vpc inventory
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent DEFAULT: 0
compatQual	vpc:CompatQual (scalar:Uint32)	Compatibility reason code	RANGE: [0, 4294967295]
compatQualStr	string:Basic	Compatibility reason code string	A sequence of characters
compatSt	vpc:CompatSt (scalar:Enum8)	Compatibility status	SELECTION: 0 - pass 1 - fail 2 - notDone DEFAULT: notDone
deadIntvl	vpc:DeadIntvl scalar:Uint32	Peer dead interval	RANGE: Min: (long)5l Max: (long)600l DEFAULT: 200u
delayPeerLinkBringup	vpc:DelayPeerLinkBringup (scalar:Uint16)	Peer link delay timer	RANGE: [0 , 7200] DEFAULT: 0
delayRestoreSVI	vpc:DelayRestoreSVI (scalar:Uint16)	Delay restore for SVI	RANGE: [1 , 3600] DEFAULT: 10
delayRestoreVPC	vpc:DelayRestoreVPC (scalar:Uint16)	Delay restore for vPC links	RANGE: [1 , 3600] DEFAULT: 30
dn	reference:BinRef	A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
dualActiveSt	vpc:DualActiveSt (scalar:Enum8)	Dual Active Status	SELECTION: 0 - false 1 - true
excludeSVI	vpc:ExcludeSVI (l2:VlanBitmap)	SVI List excluded from suspension when dual-active
grcflCnstncyChck	nw:AdminSt (scalar:Enum8)	Graceful Type-1 Consistency Check	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled
id	vpc:DomId (scalar:Uint16)	Domain id	RANGE: [1 , 1000]
ipv4CfsSync	nw:AdminSt scalar:Enum8	IPv4 CFS synchronize	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled(2)
ipv6CfsSync	nw:AdminSt scalar:Enum8	IPv6 CFS synchronize	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled(2)
issuFromVer	string:Basic	issu from version	A sequence of characters
issuToVer	string:Basic	issu to version	A sequence of characters
lacpRole	vpc:Role (scalar:Enum8)	lacp role	SELECTION: 0 - election-not-done 1 - master 2 - slave DEFAULT: election-not-done
localMAC	address:MAC	local system mac	Value must match MM:MM:MM:SS:SS:SS format
localPrio	vpc:SysPrio (scalar:Uint16)	local system priority	RANGE: [1 , 65535] DEFAULT: 32667
modTs	mo:TStamp (scalar:Date)	The time when this object was last modified.	SELECTION: 0 - never DEFAULT: never
monPolDn	reference:BinRef	The monitoring policy attached to this observable object.
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63
oldRole	vpc:Role (scalar:Enum8)	old role	SELECTION: 0 - election-not-done 1 - master 2 - slave DEFAULT: election-not-done
operRole	vpc:Role (scalar:Enum8)	role	SELECTION: 0 - election-not-done 1 - master 2 - slave DEFAULT: election-not-done
operSt	vpc:DomOperSt (scalar:Bitmask8)	various operational state	SELECTION: 0 - not-applicable 1 - sticky-master 2 - vpcs-reinited 4 - local-in-upgrade 8 - peer-in-upgrade 16 - configured-master DEFAULT: not-applicable
orphanPortList	vpc:OrphanPortList scalar:Uint32	Orphan port config. This is the list of orphan ports to be brought down when all uplinks are lost.
peerGw	nw:AdminSt (scalar:Enum8)	Peer Gateway	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
peerIp	address:Ip	vpc peer IP address	Value must match ipv4 or ipv6 known format
peerMAC	address:MAC	peer system mac	Value must match MM:MM:MM:SS:SS:SS format
peerPrio	vpc:SysPrio (scalar:Uint16)	peer system priority	RANGE: [1 , 65535] DEFAULT: 32667
peerSt	vpc:PeerSt (scalar:Enum8)	Peer state	SELECTION: 0 - noCfg 1 - down 2 - up
peerStQual	vpc:PeerStQual (scalar:Enum8)	Peer status reason code	SELECTION: 0 - success 1 - uplinks-down 2 - route-down 3 - peer-unrch 4 - compat-fail 5 - election-err 6 - oob-not-up
peerSwitch	nw:AdminSt (scalar:Enum8)	vPC pair switches	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
peerVersion	vpc:PeerVersion (scalar:Uint32)	peer version	RANGE: [0, 4294967295]
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
rolePrio	vpc:RolePrio (scalar:Uint16)	role priority	RANGE: [1 , 65535] DEFAULT: 32667
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
summOperRole	vpc:SummRole (scalar:Enum8)	Summarized Oper Role	SELECTION: 0 - election-not-done 1 - cfg-master-oper-master 2 - cfg-master-oper-slave 3 - cfg-slave-oper-master 4 - cfg-slave-oper-slave DEFAULT: election-not-done
sysMac	address:MAC	system mac	Value must match MM:MM:MM:SS:SS:SS format
sysPrio	vpc:SysPrio (scalar:Uint16)	system priority	RANGE: [1 , 65535] DEFAULT: 32667
track	vpc:Track (scalar:Uint16)	Tracking object to suspend vPC if object goes down	RANGE: [0 , 500] DEFAULT: 0
type2CompatQual	vpc:CompatQual (scalar:Uint32)	Type-2 compatibility reason code	RANGE: [0, 4294967295]
type2CompatQualStr	string:Basic	Type-2 compatibility reason code string	A sequence of characters
type2CompatSt	vpc:CompatSt (scalar:Enum8)	Type-2 Compatibility Status	SELECTION: 0 - pass 1 - fail 2 - notDone DEFAULT: notDone
vIpAnnounceDelay	vpc:VIpAnnounceDelay scalar:Uint16	vpc virtual IP address announcement delay	RANGE: Min: 30 Max: 600 DEFAULT: 45
virtualIp	address:Ip	vpc virtual IP address (vIP)	Value must match ipv4 or ipv6 known format
vpcCfgFailedBmp	scalar:Bitmask64	null	SELECTION: -9223372036854775808ull - vpc:DommodTs_failed_flag 1024ull - vpc:DomexcludeSVI_failed_flag 1048576ull - vpc:DompeerGWExcludeVLAN_failed_flag 128ull - vpc:DomdelayRestoreSVI_failed_flag 131072ull - vpc:DommacBpduSrcVer2_failed_flag 134217728ull - vpc:Domtrack_failed_flag 16384ull - vpc:Doml3PeerRouter_failed_flag 16777216ull - vpc:DomrolePrio_failed_flag 16ull - vpc:DomdeadIntvl_failed_flag 1ull - vpc:Domname_failed_flag 2048ull - vpc:DomfastConvergence_failed_flag 2097152ull - vpc:DompeerGw_failed_flag 2305843009213693952ull - vpc:Domuid_failed_flag 256ull - vpc:DomdelayRestoreVPC_failed_flag 262144ull - vpc:DommonPolDn_failed_flag 268435456ull - vpc:DomvIpAnnounceDelay_failed_flag 2ull - vpc:DomadminSt_failed_flag 32768ull - vpc:Doml3PeerRouterSyslog_failed_flag 32ull - vpc:DomdelayPeerLinkBringup_failed_flag 33554432ull - vpc:DomsysMac_failed_flag 4096ull - vpc:DomgrcflCnstncyChck_failed_flag 4194304ull - vpc:DompeerIp_failed_flag 4611686018427387904ull - vpc:DompersistentOnReload_failed_flag 4ull - vpc:DomautoRecovery_failed_flag 512ull - vpc:Domdscp_failed_flag 524288ull - vpc:DomorphanPortList_failed_flag 536870912ull - vpc:DomvirtualIp_failed_flag 64ull - vpc:DomdelayRestoreOrphanPort_failed_flag 65536ull - vpc:Doml3PeerRouterSyslogInterval_failed_flag 67108864ull - vpc:DomsysPrio_failed_flag 8192ull - vpc:Domid_failed_flag 8388608ull - vpc:DompeerSwitch_failed_flag 8ull - vpc:DomautoRecoveryIntvl_failed_flag DEFAULT: 0
vpcCfgFailedTs	scalar:Uint64	null
vpcCfgState	scalar:UByte	null
vpcMAC	address:MAC	vpc system mac	Value must match MM:MM:MM:SS:SS:SS format
vpcPrio	vpc:SysPrio (scalar:Uint16)	vpc system priority	RANGE: [1 , 65535] DEFAULT: 32667

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 Suspend when the vPC Secondary Peerlink Goes Down

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

CLI Commands

interface ethernet 1/8
medium p2p
vpc orphan-port suspend

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

MO	DN
topSystem	sys
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-{[id]}
vpcEntity	sys/vpc
vpcInst	sys/vpc/inst
vpcOrphanPort	sys/vpc/inst/orphan-{[id]}

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
medium	l1:Medium (scalar:Enum8)	The administrative port medium type.	SELECTION: 1 - broadcast 2 - p2p DEFAULT: broadcast

vpcOrphanPort Properties

The following table contains information about the vpcOrphanPort 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

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 Suspend when the vPC Secondary Peerlink Goes Down

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

CLI Commands

interface ethernet 1/8
medium p2p
no vpc orphan-port suspend

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

MO	DN
topSystem	sys
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-{[id]}
vpcEntity	sys/vpc
vpcInst	sys/vpc/inst
vpcOrphanPort	sys/vpc/inst/orphan-{[id]}

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
medium	l1:Medium (scalar:Enum8)	The administrative port medium type.	SELECTION: 1 - broadcast 2 - p2p DEFAULT: broadcast

vpcOrphanPort 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
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

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 BPDU Version 2 Source MAC Address

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

CLI Commands

vpc domain 123
mac-address bpdu source version 2

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
vpcDom	sys/vpc/inst/dom
vpcInst	sys/vpc/inst

vpcDom Properties

Property Name	Data Type	Description	Values
id	vpc:DomId (scalar:Uint16)	Domain id	RANGE: [1 , 1000]
macBpduSrcVer2	scalar:Bool	Version 2 bpdu source mac-address	SELECTION: true or false DEFAULT: false

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 BPDU Version 2 Source MAC Address

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

CLI Commands

vpc domain 123
no mac-address bpdu source version 2

Verifying a DME Configuration

MO	DN
vpcDom	sys/vpc/inst/dom
vpcInst	sys/vpc/inst

vpcDom Properties

Property Name	Data Type	Description	Values
id	vpc:DomId (scalar:Uint16)	Domain id	RANGE: [1 , 1000]
macBpduSrcVer2	scalar:Bool	Version 2 bpdu source mac-address	SELECTION: true or false DEFAULT: false

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 vPC Orphan Port Delay Bring-up Timer

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

CLI Commands

vpc domain 123
delay restore orphan-port 1

Verifying a DME Configuration

MO	DN
vpcDom	sys/vpc/inst/dom
vpcInst	sys/vpc/inst

vpcDom Properties

Property Name	Data Type	Description	Values
delayRestoreOrphanPort	vpc:DelayRestoreOrphanPort (scalar:Uint16)	Delay restore for orphan ports	RANGE: [0 , 300] DEFAULT: 0
id	vpc:DomId (scalar:Uint16)	Domain id	RANGE: [1 , 1000]

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 vPC Orphan Port Delay Bring-up Timer

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

CLI Commands

vpc domain 123
no delay restore orphan-port 1

Verifying a DME Configuration

MO	DN
vpcDom	sys/vpc/inst/dom
vpcInst	sys/vpc/inst

vpcDom Properties

Property Name	Data Type	Description	Values
delayRestoreOrphanPort	vpc:DelayRestoreOrphanPort (scalar:Uint16)	Delay restore for orphan ports	RANGE: [0 , 300] DEFAULT: 0
id	vpc:DomId (scalar:Uint16)	Domain id	RANGE: [1 , 1000]

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 Keepalive with a Peer Switch on a vPC Domain (for IPv4)

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

CLI Commands

vpc domain 123
peer-keepalive destination 1.2.3.4 source 1.2.3.4 udp-port 23096 vrf SampleString_123 tos-byte 1 interval 5846 timeout 20 hold-timeout 4

Verifying a DME Configuration

MO	DN
vpcInst	sys/vpc/inst
vpcDom	sys/vpc/inst/dom
vpcKeepalive	sys/vpc/inst/dom/keepalive

vpcDom Properties

Property Name	Data Type	Description	Values
id	vpc:DomId (scalar:Uint16)	Domain id	RANGE: [1 , 1000]

vpcKeepalive Properties

Property Name	Data Type	Description	Values
destIp	address:Ip	destination address	Value must match ipv4 or ipv6 known format
flushTout	vpc:FlushTout (scalar:Uint32)	flush timeout	RANGE: [3 , 10] DEFAULT: 3
interval	vpc:KeepaliveInterval (scalar:Uint32)	interval	RANGE: [400 , 10000] DEFAULT: 1000
srcIp	address:Ip	source address	Value must match ipv4 or ipv6 known format
timeout	vpc:KeepaliveTout (scalar:Uint32)	timeout	RANGE: [3 , 20] DEFAULT: 5
tosByte	vpc:TosByte (scalar:UByte)	tos byte	RANGE: [0 , 255] DEFAULT: 0
tosCfgType	vpc:TosCfgType (scalar:Enum8)	tos config type	SELECTION: 0 - noCfg 1 - tos-byte 2 - tos-value 3 - tos-type 4 - precedence-type 5 - precedence-value DEFAULT: noCfg
udpPort	comm:Port (scalar:Uint32)	port number	RANGE: [1 , 65535]
vrf	l3:VrfName (string:Basic)	vrf name	A sequence of characters

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 Keepalive with a Peer Switch on a vPC Domain (for IPv6)

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

CLI Commands

vpc domain 123
peer-keepalive destination 1:2::3:4 source 1:2::3:4 udp-port 32562 vrf SampleString_123 tos-byte 1 interval 3495 timeout 8 hold-timeout 8

Verifying a DME Configuration

MO	DN
vpcInst	sys/vpc/inst
vpcDom	sys/vpc/inst/dom
vpcKeepalive	sys/vpc/inst/dom/keepalive

vpcDom Properties

Property Name	Data Type	Description	Values
id	vpc:DomId (scalar:Uint16)	Domain id	RANGE: [1 , 1000]

vpcKeepalive Properties

Property Name	Data Type	Description	Values
destIp	address:Ip	destination address	Value must match ipv4 or ipv6 known format
flushTout	vpc:FlushTout (scalar:Uint32)	flush timeout	RANGE: [3 , 10] DEFAULT: 3
interval	vpc:KeepaliveInterval (scalar:Uint32)	interval	RANGE: [400 , 10000] DEFAULT: 1000
srcIp	address:Ip	source address	Value must match ipv4 or ipv6 known format
timeout	vpc:KeepaliveTout (scalar:Uint32)	timeout	RANGE: [3 , 20] DEFAULT: 5
tosByte	vpc:TosByte (scalar:UByte)	tos byte	RANGE: [0 , 255] DEFAULT: 0
tosCfgType	vpc:TosCfgType (scalar:Enum8)	tos config type	SELECTION: 0 - noCfg 1 - tos-byte 2 - tos-value 3 - tos-type 4 - precedence-type 5 - precedence-value DEFAULT: noCfg
udpPort	comm:Port (scalar:Uint32)	port number	RANGE: [1 , 65535]
vrf	l3:VrfName (string:Basic)	vrf name	A sequence of characters

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