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

Configuring a vPC Domain
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"
}}}]}}

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.

MODN
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 NameData TypeDescriptionValues
autoRecoverynw:AdminSt
(scalar:Enum8)
Auto RecoverySELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
delayRestoreSVIvpc:DelayRestoreSVI
(scalar:Uint16)
Delay restore for SVI
RANGE: [1 , 3600]
DEFAULT: 10
excludeSVIvpc:ExcludeSVI
(l2:VlanBitmap)
SVI List excluded from suspension when dual-active
grcflCnstncyChcknw:AdminSt
(scalar:Enum8)
Graceful Type-1 Consistency CheckSELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled
idvpc:DomId
(scalar:Uint16)
Domain id
RANGE: [1 , 1000]
peerGwnw:AdminSt
(scalar:Enum8)
Peer GatewaySELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
peerSwitchnw:AdminSt
(scalar:Enum8)
vPC pair switchesSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
rolePriovpc:RolePrio
(scalar:Uint16)
role priority
RANGE: [1 , 65535]
DEFAULT: 32667
sysMacaddress:MAC
system macValue must match MM:MM:MM:SS:SS:SS format
sysPriovpc: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 NameData TypeDescriptionValues
destIpaddress:Ip
destination addressValue 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
POST http://<IP_Address>/api/node/mo/sys/vpc/inst/dom.json
{
  "vpcKeepalive": {
    "children": [
      {
        "vpcPeerLink": {
          "attributes": {
            "id": "po10"
          }
        }
      }
    ]
  }
}

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


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.

MODN
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 NameData TypeDescriptionValues
idnw: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

Moving Other Port Channels into a vPC
POST http://<IP_Address>/api/node/mo/sys/vpc/inst/dom/if-20.json
{
  "vpcIf": {
    "attributes": {
      "id": "20"
    },
    "children": [
      {
        "vpcRsVpcConf": {
          "attributes": {
            "tDn": "sys/intf/aggr-[po10]"
          }
        }
      }
    ]
  }
}

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


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.

MODN
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 NameData TypeDescriptionValues
idvpc: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 NameData TypeDescriptionValues
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

Configuring Address Synchronization
POST http://<IP_Address>/api/node/mo/sys/intf/aggr-[po13].json
{
  "pcAggrIf": {
    "attributes": {
      "id": "po13"
    }
  }
}

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


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.

MODN
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 NameData TypeDescriptionValues
idnw: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

Configuring a vPC Role Priority
POST http://<mgmt0_IP>/api/mo/sys/vpc/inst.json
{
  "vpcInst": {
    "children": [
      {
        "vpcDom": {
          "attributes": {
            "id": "123",
            "rolePrio": "123"
}}}]}}
{
    "imdata": []
}
<System>
  <vpc-items>
    <inst-items>
      <dom-items>
        <id>123</id>
        <rolePrio>123</rolePrio>
      </dom-items>
    </inst-items>
  </vpc-items>
</System>

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


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.

MODN
vpcInst sys/vpc/inst
vpcDom sys/vpc/inst/dom


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 NameData TypeDescriptionValues
idvpc:DomId
(scalar:Uint16)
Domain id
RANGE: [1 , 1000]
rolePriovpc: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

Deleting a vPC Role Priority
POST http://<mgmt0_IP>/api/mo/sys/vpc/inst.json
{
  "vpcInst": {
    "children": [
      {
        "vpcDom": {
          "attributes": {
            "id": "123",
            "rolePrio": "32667"
}}}]}}
{
    "imdata": []
}
<System>
  <vpc-items>
    <inst-items>
      <dom-items>
        <id>123</id>
        <rolePrio>32667</rolePrio>
      </dom-items>
    </inst-items>
  </vpc-items>
</System>

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
 no role priority

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.

MODN
vpcInst sys/vpc/inst
vpcDom sys/vpc/inst/dom


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 NameData TypeDescriptionValues
idvpc:DomId
(scalar:Uint16)
Domain id
RANGE: [1 , 1000]
rolePriovpc: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

Configuring How Frequently to Print the Syslog
POST http://<mgmt0_IP>/api/mo/sys/vpc/inst.json
{
  "vpcInst": {
    "children": [
      {
        "vpcDom": {
          "attributes": {
            "id": "123",
            "l3PeerRouterSyslog": "enabled",
            "l3PeerRouterSyslogInterval": "123"
}}}]}}
{
    imdata:[]
}
<System>
  <vpc-items>
    <inst-items>
      <dom-items>
        <id>123</id>
        <l3PeerRouterSyslog>enabled</l3PeerRouterSyslog>
        <l3PeerRouterSyslogInterval>123</l3PeerRouterSyslogInterval>
      </dom-items>
    </inst-items>
  </vpc-items>
</System>


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

vpc domain 123
 layer3 peer-router syslog interval 123

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


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
vpcInst sys/vpc/inst
vpcDom sys/vpc/inst/dom


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 NameData TypeDescriptionValues
idvpc:DomId
(scalar:Uint16)
Domain id
RANGE: [1 , 1000]
l3PeerRouterSyslognw:AdminSt
(scalar:Enum8)
L3 Peer Router SyslogSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
l3PeerRouterSyslogIntervalvpc: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
POST http://<mgmt0_IP>/api/mo/sys/vpc/inst.json
{
  "vpcInst": {
    "children": [
      {
        "vpcDom": {
          "attributes": {
            "id": "123",
            "l3PeerRouterSyslog": "disabled",
            "l3PeerRouterSyslogInterval": "3600"
}}}]}}
{
    imdata:[]
}
<System>
  <vpc-items>
    <inst-items>
      <dom-items>
        <id>123</id>
        <l3PeerRouterSyslog>disabled</l3PeerRouterSyslog>
        <l3PeerRouterSyslogInterval>3600</l3PeerRouterSyslogInterval>
      </dom-items>
    </inst-items>
  </vpc-items>
</System>


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

vpc domain 123
 no layer3 peer-router syslog

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.

MODN
vpcInst sys/vpc/inst
vpcDom sys/vpc/inst/dom


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 NameData TypeDescriptionValues
idvpc:DomId
(scalar:Uint16)
Domain id
RANGE: [1 , 1000]
l3PeerRouterSyslognw:AdminSt
(scalar:Enum8)
L3 Peer Router SyslogSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
l3PeerRouterSyslogIntervalvpc: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

Configuring No Change for TTL of Packets Destined to the Peer
POST http://<mgmt0_IP>/api/mo/sys/vpc/inst.json
{
  "vpcInst": {
    "children": [
      {
        "vpcDom": {
          "attributes": {
            "id": "123",
            "l3PeerRouter": "enabled"
}}}]}}
{
    imdata:[]
}
<System>
  <vpc-items>
    <inst-items>
      <dom-items>
        <id>123</id>
        <l3PeerRouter>enabled</l3PeerRouter>
      </dom-items>
    </inst-items>
  </vpc-items>
</System>


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

vpc domain 123
 layer3 peer-router

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.

MODN
vpcInst sys/vpc/inst
vpcDom sys/vpc/inst/dom


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 NameData TypeDescriptionValues
idvpc:DomId
(scalar:Uint16)
Domain id
RANGE: [1 , 1000]
l3PeerRouternw:AdminSt
(scalar:Enum8)
L3 Peer RouterSELECTION:
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

Disabling No Change for TTL of Packets Destined to the Peer
POST http://<mgmt0_IP>/api/mo/sys/vpc/inst.json
{
  "vpcInst": {
    "children": [
      {
        "vpcDom": {
          "attributes": {
            "id": "123",
            "l3PeerRouter": "disabled"
}}}]}}
{
    imdata:[]
}
<System>
  <vpc-items>
    <inst-items>
      <dom-items>
        <id>123</id>
        <l3PeerRouter>disabled</l3PeerRouter>
      </dom-items>
    </inst-items>
  </vpc-items>
</System>


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

vpc domain 123
 no layer3 peer-router

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.

MODN
vpcInst sys/vpc/inst
vpcDom sys/vpc/inst/dom


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 NameData TypeDescriptionValues
idvpc:DomId
(scalar:Uint16)
Domain id
RANGE: [1 , 1000]
l3PeerRouternw:AdminSt
(scalar:Enum8)
L3 Peer RouterSELECTION:
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

Enabling Fast Convergence on a vPC Domain
POST http://<mgmt0_IP>/api/mo/sys/vpc/inst.json
{
  "vpcInst": {
    "children": [
      {
        "vpcDom": {
          "attributes": {
            "fastConvergence": "enabled",
            "id": "5"
}}}]}}
{
    imdata:[]
}
<System>
  <vpc-items>
    <inst-items>
      <dom-items>
        <fastConvergence>enabled</fastConvergence>
        <id>5</id>
      </dom-items>
    </inst-items>
  </vpc-items>
</System>


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

vpc domain 5
 fast-convergence

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.

MODN
vpcInst sys/vpc/inst
vpcDom sys/vpc/inst/dom


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 NameData TypeDescriptionValues
fastConvergencenw:AdminSt
(scalar:Enum8)
Fast ConvergenceSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
idvpc: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

Disabling Fast Convergence on a vPC Domain
POST http://<mgmt0_IP>/api/mo/sys/vpc/inst.json
{
  "vpcInst": {
    "children": [
      {
        "vpcDom": {
          "attributes": {
            "fastConvergence": "disabled",
            "id": "5"
}}}]}}
{
    imdata:[]
}
<System>
  <vpc-items>
    <inst-items>
      <dom-items>
        <fastConvergence>disabled</fastConvergence>
        <id>5</id>
      </dom-items>
    </inst-items>
  </vpc-items>
</System>


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

vpc domain 5
 no fast-convergence

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.

MODN
vpcInst sys/vpc/inst
vpcDom sys/vpc/inst/dom


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 NameData TypeDescriptionValues
fastConvergencenw:AdminSt
(scalar:Enum8)
Fast ConvergenceSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
idvpc: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

Querying the vPC Domain
HTTP GET http://<IP_Address>/api/node/mo/sys/vpc/inst/dom.json
{
  "totalCount": "1",
  "imdata": [
    {
      "vpcDom": {
        "attributes": {
          "adminSt": "enabled",
          "autoRecovery": "disabled",
          "autoRecoveryIntvl": "240",
          "batchedVpcInv": "",
          "childAction": "",
          "compatQual": "1102512194",
          "compatQualStr": "Consistency Check Not Performed",
          "compatSt": "fail",
          "deadIntvl": "200",
          "delayPeerLinkBringup": "0",
          "delayRestoreSVI": "10",
          "delayRestoreVPC": "30",
          "dn": "sys/vpc/inst/dom",
          "dualActiveSt": "false",
          "excludeSVI": "",
          "grcflCnstncyChck": "disabled",
          "id": "1",
          "ipv4CfsSync": "disabled",
          "ipv6CfsSync": "disabled",
          "issuFromVer": "",
          "issuToVer": "",
          "lacpRole": "election-not-done",
          "localMAC": "74:26:AC:EC:91:87",
          "localPrio": "0",
          "modTs": "2016-10-13T13:42:24.010+00:00",
          "monPolDn": "",
          "name": "",
          "oldRole": "election-not-done",
          "operRole": "election-not-done",
          "operSt": "configured-master",
          "orphanPortList": "0",
          "peerGw": "enabled",
          "peerIp": "0.0.0.0",
          "peerMAC": "00:00:00:00:00:00",
          "peerPrio": "0",
          "peerSt": "down",
          "peerStQual": "success",
          "peerSwitch": "disabled",
          "peerVersion": "23",
          "persistentOnReload": "true",
          "rolePrio": "3",
          "status": "",
          "summOperRole": "election-not-done",
          "sysMac": "00:03:02:02:01:01",
          "sysPrio": "11",
          "track": "0",
          "type2CompatQual": "1102512194",
          "type2CompatQualStr": "Consistency Check Not Performed",
          "type2CompatSt": "fail",
          "vIpAnnounceDelay": "45",
          "virtualIp": "0.0.0.0",
          "vpcCfgFailedBmp": "",
          "vpcCfgFailedTs": "00:00:00:00.000",
          "vpcCfgState": "0",
          "vpcMAC": "00:00:00:00:00:00",
          "vpcPrio": "32667"
}}}]}

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.

MODN
vpcDom sys/vpc/inst/dom


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 NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
vPC suspend locallySELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled
autoRecoverynw:AdminSt
(scalar:Enum8)
Auto RecoverySELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
autoRecoveryIntvlvpc:AutoRecoveryIntvl
(scalar:Uint32)
Auto Recovery interval
RANGE: [60 , 3600]
DEFAULT: 240
batchedVpcInvvpc: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
  • compatQualvpc:CompatQual
    (scalar:Uint32)
    Compatibility reason codeRANGE: [0, 4294967295]
    compatQualStrstring:Basic
    Compatibility reason code stringA sequence of characters
    compatStvpc:CompatSt
    (scalar:Enum8)
    Compatibility statusSELECTION:
    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
  • delayPeerLinkBringupvpc:DelayPeerLinkBringup
    (scalar:Uint16)
    Peer link delay timer
    RANGE: [0 , 7200]
    DEFAULT: 0
    delayRestoreSVIvpc:DelayRestoreSVI
    (scalar:Uint16)
    Delay restore for SVI
    RANGE: [1 , 3600]
    DEFAULT: 10
    delayRestoreVPCvpc: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.
    dualActiveStvpc:DualActiveSt
    (scalar:Enum8)
    Dual Active StatusSELECTION:
    0 - false
    1 - true
    excludeSVIvpc:ExcludeSVI
    (l2:VlanBitmap)
    SVI List excluded from suspension when dual-active
    grcflCnstncyChcknw:AdminSt
    (scalar:Enum8)
    Graceful Type-1 Consistency CheckSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: enabled
    idvpc:DomId
    (scalar:Uint16)
    Domain id
    RANGE: [1 , 1000]
    ipv4CfsSync
    nw:AdminSt
    scalar:Enum8
    IPv4 CFS synchronizeSELECTION:
  • 1 - enabled
  • 2 - disabled
  • DEFAULT: disabled(2)
  • ipv6CfsSync
    nw:AdminSt
    scalar:Enum8
    IPv6 CFS synchronizeSELECTION:
  • 1 - enabled
  • 2 - disabled
  • DEFAULT: disabled(2)
  • issuFromVerstring:Basic
    issu from versionA sequence of characters
    issuToVerstring:Basic
    issu to versionA sequence of characters
    lacpRolevpc:Role
    (scalar:Enum8)
    lacp roleSELECTION:
    0 - election-not-done
    1 - master
    2 - slave
    DEFAULT: election-not-done
    localMACaddress:MAC
    local system macValue must match MM:MM:MM:SS:SS:SS format
    localPriovpc:SysPrio
    (scalar:Uint16)
    local system priority
    RANGE: [1 , 65535]
    DEFAULT: 32667
    modTsmo: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.
    namenaming:Name256
    (string:Basic)
    The name of the object.
    MAX SIZE: 63
    oldRolevpc:Role
    (scalar:Enum8)
    old roleSELECTION:
    0 - election-not-done
    1 - master
    2 - slave
    DEFAULT: election-not-done
    operRolevpc:Role
    (scalar:Enum8)
    roleSELECTION:
    0 - election-not-done
    1 - master
    2 - slave
    DEFAULT: election-not-done
    operStvpc:DomOperSt
    (scalar:Bitmask8)
    various operational stateSELECTION:
    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.
    peerGwnw:AdminSt
    (scalar:Enum8)
    Peer GatewaySELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    peerIpaddress:Ip
    vpc peer IP addressValue must match ipv4 or ipv6 known format
    peerMACaddress:MAC
    peer system macValue must match MM:MM:MM:SS:SS:SS format
    peerPriovpc:SysPrio
    (scalar:Uint16)
    peer system priority
    RANGE: [1 , 65535]
    DEFAULT: 32667
    peerStvpc:PeerSt
    (scalar:Enum8)
    Peer stateSELECTION:
    0 - noCfg
    1 - down
    2 - up
    peerStQualvpc:PeerStQual
    (scalar:Enum8)
    Peer status reason codeSELECTION:
    0 - success
    1 - uplinks-down
    2 - route-down
    3 - peer-unrch
    4 - compat-fail
    5 - election-err
    6 - oob-not-up
    peerSwitchnw:AdminSt
    (scalar:Enum8)
    vPC pair switchesSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    peerVersionvpc:PeerVersion
    (scalar:Uint32)
    peer versionRANGE: [0, 4294967295]
    persistentOnReload
    mo:Persistent
    scalar:Enum8
    NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
  • rolePriovpc:RolePrio
    (scalar:Uint16)
    role priority
    RANGE: [1 , 65535]
    DEFAULT: 32667
    statusmo:ModificationStatus
    (scalar:Bitmask32)
    The upgrade status. This property is for internal use only.SELECTION:
    2 - created
    4 - modified
    8 - deleted
    16 - replaced
    summOperRolevpc:SummRole
    (scalar:Enum8)
    Summarized Oper RoleSELECTION:
    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
    sysMacaddress:MAC
    system macValue must match MM:MM:MM:SS:SS:SS format
    sysPriovpc:SysPrio
    (scalar:Uint16)
    system priority
    RANGE: [1 , 65535]
    DEFAULT: 32667
    trackvpc:Track
    (scalar:Uint16)
    Tracking object to suspend vPC if object goes down
    RANGE: [0 , 500]
    DEFAULT: 0
    type2CompatQualvpc:CompatQual
    (scalar:Uint32)
    Type-2 compatibility reason codeRANGE: [0, 4294967295]
    type2CompatQualStrstring:Basic
    Type-2 compatibility reason code stringA sequence of characters
    type2CompatStvpc:CompatSt
    (scalar:Enum8)
    Type-2 Compatibility StatusSELECTION:
    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
  • virtualIpaddress: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
    vpcMACaddress:MAC
    vpc system macValue must match MM:MM:MM:SS:SS:SS format
    vpcPriovpc: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 
    
    POST http://<mgmt0_IP>/api/mo/sys.json
    
    {
      "topSystem": {
        "children": [
          {
            "interfaceEntity": {
              "children": [
                {
                  "l1PhysIf": {
                    "attributes": {
                      "id": "eth1/8",
                      "medium": "p2p"
                    }
                  }
                }
              ]
            }
          },
          {
            "vpcEntity": {
              "children": [
                {
                  "vpcInst": {
                    "children": [
                      {
                        "vpcOrphanPort": {
                          "attributes": {
                            "id": "eth1/8"
                          }
                        }
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
    
    {
        imdata:[]
    }
    
    <System>
      <intf-items>
        <phys-items>
          <PhysIf-list>
            <id>eth1/8</id>
            <medium>p2p</medium>
          </PhysIf-list>
        </phys-items>
      </intf-items>
      <vpc-items>
        <inst-items>
          <orphan-items>
            <OrphanPort-list>
              <id>eth1/8</id>
            </OrphanPort-list>
          </orphan-items>
        </inst-items>
      </vpc-items>
    </System>
    

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


    CLI Commands

    The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

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

    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.

    MODN
    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 NameData TypeDescriptionValues
    idnw:IfId
    (base:IfIndex)
    An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
    mediuml1: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 NameData TypeDescriptionValues
    idnw: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 
    
    POST http://<mgmt0_IP>/api/mo/sys.json
    
    {
      "topSystem": {
        "children": [
          {
            "interfaceEntity": {
              "children": [
                {
                  "l1PhysIf": {
                    "attributes": {
                      "id": "eth1/8",
                      "medium": "p2p"
                    }
                  }
                }
              ]
            }
          },
          {
            "vpcEntity": {
              "children": [
                {
                  "vpcInst": {
                    "children": [
                      {
                        "vpcOrphanPort": {
                          "attributes": {
                            "id": "eth1/8",
                            "status": "deleted"
                          }
                        }
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
    
    {
        imdata:[]
    }
    
    <System>
      <intf-items>
        <phys-items>
          <PhysIf-list>
            <id>eth1/8</id>
            <medium>p2p</medium>
          </PhysIf-list>
        </phys-items>
      </intf-items>
      <vpc-items>
        <inst-items>
          <orphan-items>
            <OrphanPort-list xc:operation="delete">
              <id>eth1/8</id>
            </OrphanPort-list>
          </orphan-items>
        </inst-items>
      </vpc-items>
    </System>
    

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


    CLI Commands

    The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

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


    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.

    MODN
    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 NameData TypeDescriptionValues
    idnw:IfId
    (base:IfIndex)
    An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
    mediuml1: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 NameData TypeDescriptionValues
    idnw:IfId
    (base:IfIndex)
    An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
    statusmo: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

    Configuring BPDU Version 2 Source MAC Address
    
    POST http://<mgmt0_IP>/api/mo/sys/vpc/inst.json
    
    {
      "vpcInst": {
        "children": [
          {
            "vpcDom": {
              "attributes": {
                "id": "123",
                "macBpduSrcVer2": "yes"
    }}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <vpc-items>
        <inst-items>
          <dom-items>
            <id>123</id>
            <macBpduSrcVer2>true</macBpduSrcVer2>
          </dom-items>
        </inst-items>
      </vpc-items>
    </System>
    

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


    CLI Commands

    The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

    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.

    MODN
    vpcDom sys/vpc/inst/dom
    vpcInst sys/vpc/inst


    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 NameData TypeDescriptionValues
    idvpc:DomId
    (scalar:Uint16)
    Domain id
    RANGE: [1 , 1000]
    macBpduSrcVer2scalar:Bool
    Version 2 bpdu source mac-addressSELECTION: 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

    Deleting BPDU Version 2 Source MAC Address
    
    POST http://<mgmt0_IP>/api/mo/sys/vpc/inst.json
    
    {
      "vpcInst": {
        "children": [
          {
            "vpcDom": {
              "attributes": {
                "id": "123",
                "macBpduSrcVer2": "no"
    }}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <vpc-items>
        <inst-items>
          <dom-items>
            <id>123</id>
            <macBpduSrcVer2>false</macBpduSrcVer2>
          </dom-items>
        </inst-items>
      </vpc-items>
    </System>
    

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


    CLI Commands

    The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

    vpc domain 123
     no 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.

    MODN
    vpcDom sys/vpc/inst/dom
    vpcInst sys/vpc/inst


    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 NameData TypeDescriptionValues
    idvpc:DomId
    (scalar:Uint16)
    Domain id
    RANGE: [1 , 1000]
    macBpduSrcVer2scalar:Bool
    Version 2 bpdu source mac-addressSELECTION: 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

    Configuring vPC Orphan Port Delay Bring-up Timer
    
    POST http://<mgmt0_IP>/api/mo/sys/vpc/inst.json
    
    {
      "vpcInst": {
        "children": [
          {
            "vpcDom": {
              "attributes": {
                "delayRestoreOrphanPort": "1",
                "id": "123"
    }}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <vpc-items>
        <inst-items>
          <dom-items>
            <delayRestoreOrphanPort>1</delayRestoreOrphanPort>
            <id>123</id>
          </dom-items>
        </inst-items>
      </vpc-items>
    </System>
    

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


    CLI Commands

    The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

    vpc domain 123
     delay restore orphan-port 1


    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.

    MODN
    vpcDom sys/vpc/inst/dom
    vpcInst sys/vpc/inst


    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 NameData TypeDescriptionValues
    delayRestoreOrphanPortvpc:DelayRestoreOrphanPort
    (scalar:Uint16)
    Delay restore for orphan ports
    RANGE: [0 , 300]
    DEFAULT: 0
    idvpc: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

    Deleting vPC Orphan Port Delay Bring-up Timer
    
    POST http://<mgmt0_IP>/api/mo/sys/vpc/inst.json
    
    {
      "vpcInst": {
        "children": [
          {
            "vpcDom": {
              "attributes": {
                "delayRestoreOrphanPort": "0",
                "id": "123"
    }}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <vpc-items>
        <inst-items>
          <dom-items>
            <delayRestoreOrphanPort>0</delayRestoreOrphanPort>
            <id>123</id>
          </dom-items>
        </inst-items>
      </vpc-items>
    </System>
    

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


    CLI Commands

    The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

    vpc domain 123
     no delay restore orphan-port 1


    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.

    MODN
    vpcDom sys/vpc/inst/dom
    vpcInst sys/vpc/inst


    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 NameData TypeDescriptionValues
    delayRestoreOrphanPortvpc:DelayRestoreOrphanPort
    (scalar:Uint16)
    Delay restore for orphan ports
    RANGE: [0 , 300]
    DEFAULT: 0
    idvpc: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)

     Configuring Keepalive with a Peer Switch on a vPC Domain (for IPv4) 
    
    POST http://<mgmt0_IP>/api/mo/sys/vpc/inst.json
    
    {
      "vpcInst": {
        "children": [
          {
            "vpcDom": {
              "attributes": {
                "id": "123"
              },
              "children": [
                {
                  "vpcKeepalive": {
                    "attributes": {
                      "destIp": "1.2.3.4",
                      "flushTout": "4",
                      "interval": "5846",
                      "srcIp": "1.2.3.4",
                      "timeout": "20",
                      "tosByte": "1",
                      "tosCfgType": "tos-byte",
                      "udpPort": "23096",
                      "vrf": "SampleString_123"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <vpc-items>
        <inst-items>
          <dom-items>
            <id>123</id>
            <keepalive-items>
              <destIp>1.2.3.4</destIp>
              <flushTout>4</flushTout>
              <interval>5846</interval>
              <srcIp>1.2.3.4</srcIp>
              <timeout>20</timeout>
              <tosByte>1</tosByte>
              <tosCfgType>tos-byte</tosCfgType>
              <udpPort>23096</udpPort>
              <vrf>SampleString_123</vrf>
            </keepalive-items>
          </dom-items>
        </inst-items>
      </vpc-items>
    </System>
    

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


    CLI Commands

    The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

    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

    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.

    MODN
    vpcInst sys/vpc/inst
    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 NameData TypeDescriptionValues
    idvpc:DomId
    (scalar:Uint16)
    Domain id
    RANGE: [1 , 1000]


    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 NameData TypeDescriptionValues
    destIpaddress:Ip
    destination addressValue must match ipv4 or ipv6 known format
    flushToutvpc:FlushTout
    (scalar:Uint32)
    flush timeout
    RANGE: [3 , 10]
    DEFAULT: 3
    intervalvpc:KeepaliveInterval
    (scalar:Uint32)
    interval
    RANGE: [400 , 10000]
    DEFAULT: 1000
    srcIpaddress:Ip
    source addressValue must match ipv4 or ipv6 known format
    timeoutvpc:KeepaliveTout
    (scalar:Uint32)
    timeout
    RANGE: [3 , 20]
    DEFAULT: 5
    tosBytevpc:TosByte
    (scalar:UByte)
    tos byte
    RANGE: [0 , 255]
    DEFAULT: 0
    tosCfgTypevpc:TosCfgType
    (scalar:Enum8)
    tos config typeSELECTION:
    0 - noCfg
    1 - tos-byte
    2 - tos-value
    3 - tos-type
    4 - precedence-type
    5 - precedence-value
    DEFAULT: noCfg
    udpPortcomm:Port
    (scalar:Uint32)
    port number
    RANGE: [1 , 65535]
    vrfl3:VrfName
    (string:Basic)
    vrf nameA 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)

     Configuring Keepalive with a Peer Switch on a vPC Domain (for IPv6) 
    
    POST http://<mgmt0_IP>/api/mo/sys/vpc/inst.json
    
    {
      "vpcInst": {
        "children": [
          {
            "vpcDom": {
              "attributes": {
                "id": "123"
              },
              "children": [
                {
                  "vpcKeepalive": {
                    "attributes": {
                      "destIp": "1:2::3:4",
                      "flushTout": "8",
                      "interval": "3495",
                      "srcIp": "1:2::3:4",
                      "timeout": "8",
                      "tosByte": "1",
                      "tosCfgType": "tos-byte",
                      "udpPort": "32562",
                      "vrf": "SampleString_123"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <vpc-items>
        <inst-items>
          <dom-items>
            <id>123</id>
            <keepalive-items>
              <destIp>1:2::3:4</destIp>
              <flushTout>8</flushTout>
              <interval>3495</interval>
              <srcIp>1:2::3:4</srcIp>
              <timeout>8</timeout>
              <tosByte>1</tosByte>
              <tosCfgType>tos-byte</tosCfgType>
              <udpPort>32562</udpPort>
              <vrf>SampleString_123</vrf>
            </keepalive-items>
          </dom-items>
        </inst-items>
      </vpc-items>
    </System>
    

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


    CLI Commands

    The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

    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

    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.

    MODN
    vpcInst sys/vpc/inst
    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 NameData TypeDescriptionValues
    idvpc:DomId
    (scalar:Uint16)
    Domain id
    RANGE: [1 , 1000]


    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 NameData TypeDescriptionValues
    destIpaddress:Ip
    destination addressValue must match ipv4 or ipv6 known format
    flushToutvpc:FlushTout
    (scalar:Uint32)
    flush timeout
    RANGE: [3 , 10]
    DEFAULT: 3
    intervalvpc:KeepaliveInterval
    (scalar:Uint32)
    interval
    RANGE: [400 , 10000]
    DEFAULT: 1000
    srcIpaddress:Ip
    source addressValue must match ipv4 or ipv6 known format
    timeoutvpc:KeepaliveTout
    (scalar:Uint32)
    timeout
    RANGE: [3 , 20]
    DEFAULT: 5
    tosBytevpc:TosByte
    (scalar:UByte)
    tos byte
    RANGE: [0 , 255]
    DEFAULT: 0
    tosCfgTypevpc:TosCfgType
    (scalar:Enum8)
    tos config typeSELECTION:
    0 - noCfg
    1 - tos-byte
    2 - tos-value
    3 - tos-type
    4 - precedence-type
    5 - precedence-value
    DEFAULT: noCfg
    udpPortcomm:Port
    (scalar:Uint32)
    port number
    RANGE: [1 , 65535]
    vrfl3:VrfName
    (string:Basic)
    vrf nameA 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