Configuring VRRS Pathways
You can configure a Virtual Router Redundancy Service (VRRS) pathway. In scaled environments, VRRS pathways should be used in combination with VRRPv3 control groups.
For more information, see the Cisco Nexus 9000 Series NX-OS Unicast Routing Configuration Guide:
https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-installation-and-configuration-guides-list.html/
Configuring an IP Address
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface ethernet 1/2
vrrs pathway TAG_1
address 1:2::3: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 |
topSystem |
sys |
vrrpv3Entity |
sys/vrrpv3 |
vrrpv3Inst |
sys/vrrpv3/inst |
vrrpv3Interface |
sys/vrrpv3/inst/if-[eth1/2] |
vrrpv3VrrsPathway |
sys/vrrpv3/inst/if-[eth1/2]/vrrs-pw-TAG_1 |
vrrpv3PwAddr |
sys/vrrpv3/inst/if-[eth1/2]/vrrs-pw-TAG_1/addr-[1:2::3:4] |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-[eth1/2] |
vrrpv3Interface Properties
The following table contains information about the vrrpv3Interface 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 |
vrrpv3VrrsPathway Properties
The following table contains information about the vrrpv3VrrsPathway 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 |
tag | string:Basic
| Name of vrrs tag which pathway will follow | MAX SIZE: 48 |
vrrpv3PwAddr Properties
The following table contains information about the vrrpv3PwAddr 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 |
addr | address:Ip
| IPvX address for vrrs pathway | Value must match ipv4 or ipv6 known format |
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 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html
Deleting an IP Address
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface ethernet 1/2
vrrs pathway TAG_1
no address 1:2::3: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 |
topSystem |
sys |
vrrpv3Entity |
sys/vrrpv3 |
vrrpv3Inst |
sys/vrrpv3/inst |
vrrpv3Interface |
sys/vrrpv3/inst/if-[eth1/2] |
vrrpv3VrrsPathway |
sys/vrrpv3/inst/if-[eth1/2]/vrrs-pw-TAG_1 |
vrrpv3PwAddr |
sys/vrrpv3/inst/if-[eth1/2]/vrrs-pw-TAG_1/addr-[1:2::3:4] |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-[eth1/2] |
vrrpv3Interface Properties
The following table contains information about the vrrpv3Interface 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 |
vrrpv3VrrsPathway Properties
The following table contains information about the vrrpv3VrrsPathway 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 |
tag | string:Basic
| Name of vrrs tag which pathway will follow | MAX SIZE: 48 |
vrrpv3PwAddr Properties
The following table contains information about the vrrpv3PwAddr 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 |
addr | address:Ip
| IPvX address for vrrs pathway | Value must match ipv4 or ipv6 known format |
status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
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 |
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 an IP Address
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface ethernet 1/2
vrrs pathway TAG_1
address 1:2::3: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 |
topSystem |
sys |
vrrpv3Entity |
sys/vrrpv3 |
vrrpv3Inst |
sys/vrrpv3/inst |
vrrpv3Interface |
sys/vrrpv3/inst/if-[eth1/2] |
vrrpv3VrrsPathway |
sys/vrrpv3/inst/if-[eth1/2]/vrrs-pw-TAG_1 |
vrrpv3PwAddr |
sys/vrrpv3/inst/if-[eth1/2]/vrrs-pw-TAG_1/addr-[1:2::3:4] |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-[eth1/2] |
vrrpv3Interface Properties
The following table contains information about the vrrpv3Interface 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 |
vrrpv3VrrsPathway Properties
The following table contains information about the vrrpv3VrrsPathway 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 |
tag | string:Basic
| Name of vrrs tag which pathway will follow | MAX SIZE: 48 |
vrrpv3PwAddr Properties
The following table contains information about the vrrpv3PwAddr 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 |
addr | address:Ip
| IPvX address for vrrs pathway | Value must match ipv4 or ipv6 known format |
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 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html
Deleting an IP Address
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface ethernet 1/2
vrrs pathway TAG_1
no address 1:2::3: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 |
topSystem |
sys |
vrrpv3Entity |
sys/vrrpv3 |
vrrpv3Inst |
sys/vrrpv3/inst |
vrrpv3Interface |
sys/vrrpv3/inst/if-[eth1/2] |
vrrpv3VrrsPathway |
sys/vrrpv3/inst/if-[eth1/2]/vrrs-pw-TAG_1 |
vrrpv3PwAddr |
sys/vrrpv3/inst/if-[eth1/2]/vrrs-pw-TAG_1/addr-[1:2::3:4] |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-[eth1/2] |
vrrpv3Interface Properties
The following table contains information about the vrrpv3Interface 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 |
vrrpv3VrrsPathway Properties
The following table contains information about the vrrpv3VrrsPathway 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 |
tag | string:Basic
| Name of vrrs tag which pathway will follow | MAX SIZE: 48 |
vrrpv3PwAddr Properties
The following table contains information about the vrrpv3PwAddr 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 |
addr | address:Ip
| IPvX address for vrrs pathway | Value must match ipv4 or ipv6 known format |
status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
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 |
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 Group Description
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface ethernet 1/2
vrrs pathway TAG_1
description SampleString_123
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 |
vrrpv3Entity |
sys/vrrpv3 |
vrrpv3Inst |
sys/vrrpv3/inst |
vrrpv3Interface |
sys/vrrpv3/inst/if-[eth1/2] |
vrrpv3VrrsPathway |
sys/vrrpv3/inst/if-[eth1/2]/vrrs-pw-TAG_1 |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-[eth1/2] |
vrrpv3Interface Properties
The following table contains information about the vrrpv3Interface 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 |
vrrpv3VrrsPathway Properties
The following table contains information about the vrrpv3VrrsPathway 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 |
description | vrrpv3:Desc (string:Basic) | Description string for vrrs pathway | MAX SIZE: 80 |
tag | string:Basic
| Name of vrrs tag which pathway will follow | MAX SIZE: 48 |
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 |
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 Mac Address
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface ethernet 1/2
vrrs pathway TAG_1
no description SampleString_123
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 |
vrrpv3Entity |
sys/vrrpv3 |
vrrpv3Inst |
sys/vrrpv3/inst |
vrrpv3Interface |
sys/vrrpv3/inst/if-[eth1/2] |
vrrpv3VrrsPathway |
sys/vrrpv3/inst/if-[eth1/2]/vrrs-pw-TAG_1 |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-[eth1/2] |
vrrpv3Interface Properties
The following table contains information about the vrrpv3Interface 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 |
vrrpv3VrrsPathway Properties
The following table contains information about the vrrpv3VrrsPathway 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 |
tag | string:Basic
| Name of vrrs tag which pathway will follow | MAX SIZE: 48 |
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 |
descr | naming:Descr1024 (string:Basic) | descr | MAX SIZE: 254 |
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html
Deleting a Mac Address
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface ethernet 1/2
vrrs pathway TAG_1
mac address d8b1.9071.e903
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 |
vrrpv3Entity |
sys/vrrpv3 |
vrrpv3Inst |
sys/vrrpv3/inst |
vrrpv3Interface |
sys/vrrpv3/inst/if-[eth1/2] |
vrrpv3VrrsPathway |
sys/vrrpv3/inst/if-[eth1/2]/vrrs-pw-TAG_1 |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-[eth1/2] |
vrrpv3Interface Properties
The following table contains information about the vrrpv3Interface 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 |
vrrpv3VrrsPathway Properties
The following table contains information about the vrrpv3VrrsPathway 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 |
mac | address:MAC
| Configured virtual MAC address for the Pathway | Value must match MM:MM:MM:SS:SS:SS format |
tag | string:Basic
| Name of vrrs tag which pathway will follow | MAX SIZE: 48 |
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 |
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 Pathway Shutdown
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface ethernet 1/2
vrrs pathway TAG_1
no mac address d8b1.9071.e903
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 |
vrrpv3Entity |
sys/vrrpv3 |
vrrpv3Inst |
sys/vrrpv3/inst |
vrrpv3Interface |
sys/vrrpv3/inst/if-[eth1/2] |
vrrpv3VrrsPathway |
sys/vrrpv3/inst/if-[eth1/2]/vrrs-pw-TAG_1 |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-[eth1/2] |
vrrpv3Interface Properties
The following table contains information about the vrrpv3Interface 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 |
vrrpv3VrrsPathway Properties
The following table contains information about the vrrpv3VrrsPathway 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 |
mac | address:MAC
| Configured virtual MAC address for the Pathway | Value must match MM:MM:MM:SS:SS:SS format |
tag | string:Basic
| Name of vrrs tag which pathway will follow | MAX SIZE: 48 |
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 |
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 Pathway Shutdown
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface ethernet 1/2
vrrs pathway TAG_1
shutdown
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 |
vrrpv3Entity |
sys/vrrpv3 |
vrrpv3Inst |
sys/vrrpv3/inst |
vrrpv3Interface |
sys/vrrpv3/inst/if-[eth1/2] |
vrrpv3VrrsPathway |
sys/vrrpv3/inst/if-[eth1/2]/vrrs-pw-TAG_1 |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-[eth1/2] |
vrrpv3Interface Properties
The following table contains information about the vrrpv3Interface 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 |
vrrpv3VrrsPathway Properties
The following table contains information about the vrrpv3VrrsPathway 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 | vrrpv3:State (scalar:Enum8) | Administrative state for vrrs pathway | SELECTION: 0 - disabled 1 - enabled DEFAULT: enabled |
tag | string:Basic
| Name of vrrs tag which pathway will follow | MAX SIZE: 48 |
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 |
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 Pathway Shutdown
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface ethernet 1/2
vrrs pathway TAG_1
no shutdown
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 |
vrrpv3Entity |
sys/vrrpv3 |
vrrpv3Inst |
sys/vrrpv3/inst |
vrrpv3Interface |
sys/vrrpv3/inst/if-[eth1/2] |
vrrpv3VrrsPathway |
sys/vrrpv3/inst/if-[eth1/2]/vrrs-pw-TAG_1 |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-[eth1/2] |
vrrpv3Interface Properties
The following table contains information about the vrrpv3Interface 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 |
vrrpv3VrrsPathway Properties
The following table contains information about the vrrpv3VrrsPathway 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 | vrrpv3:State (scalar:Enum8) | Administrative state for vrrs pathway | SELECTION: 0 - disabled 1 - enabled DEFAULT: enabled |
tag | string:Basic
| Name of vrrs tag which pathway will follow | MAX SIZE: 48 |
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 |
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 Pathway Will Inherit vMAC
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface ethernet 1/2
vrrs pathway TAG_1
mac address inherit
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 |
vrrpv3Entity |
sys/vrrpv3 |
vrrpv3Inst |
sys/vrrpv3/inst |
vrrpv3Interface |
sys/vrrpv3/inst/if-[eth1/2] |
vrrpv3VrrsPathway |
sys/vrrpv3/inst/if-[eth1/2]/vrrs-pw-TAG_1 |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-[eth1/2] |
vrrpv3Interface Properties
The following table contains information about the vrrpv3Interface 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 |
vrrpv3VrrsPathway Properties
The following table contains information about the vrrpv3VrrsPathway 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 |
mac | address:MAC
| Configured virtual MAC address for the Pathway | Value must match MM:MM:MM:SS:SS:SS format |
tag | string:Basic
| Name of vrrs tag which pathway will follow | MAX SIZE: 48 |
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 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html
Configuring the Interval Between vMAC Unsolicited Advertisements
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface ethernet 1/2
vrrs pathway TAG_1
mac advert interval 285
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 |
vrrpv3Entity |
sys/vrrpv3 |
vrrpv3Inst |
sys/vrrpv3/inst |
vrrpv3Interface |
sys/vrrpv3/inst/if-[eth1/2] |
vrrpv3VrrsPathway |
sys/vrrpv3/inst/if-[eth1/2]/vrrs-pw-TAG_1 |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-[eth1/2] |
vrrpv3Interface Properties
The following table contains information about the vrrpv3Interface 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 |
vrrpv3VrrsPathway Properties
The following table contains information about the vrrpv3VrrsPathway 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 |
macAdvIntvl | scalar:Uint16
| Interval in seconds, between virtual MAC unsolicited advertisements | RANGE: [1 , 300] DEFAULT: 10 |
tag | string:Basic
| Name of vrrs tag which pathway will follow | MAX SIZE: 48 |
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 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html
Deleting the Interval Between vMAC Unsolicited Advertisements
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface ethernet 1/2
vrrs pathway TAG_1
no mac advert interval 285
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 |
vrrpv3Entity |
sys/vrrpv3 |
vrrpv3Inst |
sys/vrrpv3/inst |
vrrpv3Interface |
sys/vrrpv3/inst/if-[eth1/2] |
vrrpv3VrrsPathway |
sys/vrrpv3/inst/if-[eth1/2]/vrrs-pw-TAG_1 |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-[eth1/2] |
vrrpv3Interface Properties
The following table contains information about the vrrpv3Interface 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 |
vrrpv3VrrsPathway Properties
The following table contains information about the vrrpv3VrrsPathway 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 |
macAdvIntvl | scalar:Uint16
| Interval in seconds, between virtual MAC unsolicited advertisements | RANGE: [1 , 300] DEFAULT: 10 |
tag | string:Basic
| Name of vrrs tag which pathway will follow | MAX SIZE: 48 |
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 |
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