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:
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.
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:
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:
Creating the vPC Peer Link
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.
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:
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:
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.
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:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring 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.
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:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring a 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.
MO | DN |
---|---|
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 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:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting a 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.
MO | DN |
---|---|
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 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:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring 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.
MO | DN |
---|---|
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 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:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting a 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.
MO | DN |
---|---|
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 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:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring 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.
MO | DN |
---|---|
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 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:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Disabling 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.
MO | DN |
---|---|
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 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:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Enabling 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.
MO | DN |
---|---|
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 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:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Disabling 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.
MO | DN |
---|---|
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 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:
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:
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.
MO | DN |
---|---|
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 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:
|
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 |
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:
|
ipv6CfsSync | nw:AdminSt scalar:Enum8 | IPv6 CFS synchronize | SELECTION:
|
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:
|
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 |
virtualIp | address:Ip | vpc virtual IP address (vIP) | Value must match ipv4 or ipv6 known format |
vpcCfgFailedBmp | scalar:Bitmask64 | null | SELECTION:
|
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:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring Suspend when the vPC Secondary Peerlink Goes Down
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.
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:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting Suspend when the vPC Secondary Peerlink Goes Down
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.
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 |
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:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring 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.
MO | DN |
---|---|
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 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:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting 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.
MO | DN |
---|---|
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 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:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring 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.
MO | DN |
---|---|
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 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:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting 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.
MO | DN |
---|---|
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 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:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring 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.
MO | DN |
---|---|
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 Name | Data Type | Description | Values |
---|---|---|---|
id | vpc: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 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:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring 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.
MO | DN |
---|---|
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 Name | Data Type | Description | Values |
---|---|---|---|
id | vpc: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 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:
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: