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

Configuring an IP Address
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "vrrpv3VrrsPathway": {
                            "attributes": {
                              "tag": "TAG_1"
                            },
                            "children": [
                              {
                                "vrrpv3PwAddr": {
                                  "attributes": {
                                    "addr": "1:2::3:4"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/2</id>
          <vrrs-items>
            <VrrsPathway-list>
              <tag>TAG_1</tag>
              <addr-items>
                <PwAddr-list>
                  <addr>1:2::3:4</addr>
                </PwAddr-list>
              </addr-items>
            </VrrsPathway-list>
          </vrrs-items>
        </Interface-list>
      </if-items>
    </inst-items>
  </vrrpv3-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

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.

MODN
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 NameData TypeDescriptionValues
idnw: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 NameData TypeDescriptionValues
tagstring: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 NameData TypeDescriptionValues
addraddress:Ip
IPvX address for vrrs pathwayValue 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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


Related Documentation

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

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

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Deleting an IP Address

Deleting an IP Address
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "vrrpv3VrrsPathway": {
                            "attributes": {
                              "tag": "TAG_1"
                            },
                            "children": [
                              {
                                "vrrpv3PwAddr": {
                                  "attributes": {
                                    "addr": "1:2::3:4",
                                    "status": "deleted"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/2</id>
          <vrrs-items>
            <VrrsPathway-list>
              <tag>TAG_1</tag>
              <addr-items>
                <PwAddr-list nc:operation="delete">
                  <addr>1:2::3:4</addr>
                </PwAddr-list>
              </addr-items>
            </VrrsPathway-list>
          </vrrs-items>
        </Interface-list>
      </if-items>
    </inst-items>
  </vrrpv3-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

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.

MODN
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 NameData TypeDescriptionValues
idnw: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 NameData TypeDescriptionValues
tagstring: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 NameData TypeDescriptionValues
addraddress:Ip
IPvX address for vrrs pathwayValue must match ipv4 or ipv6 known format
statusmo: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


Related Documentation

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

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

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Configuring an IP Address

Configuring an IP Address
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "vrrpv3VrrsPathway": {
                            "attributes": {
                              "tag": "TAG_1"
                            },
                            "children": [
                              {
                                "vrrpv3PwAddr": {
                                  "attributes": {
                                    "addr": "1:2::3:4"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/2</id>
          <vrrs-items>
            <VrrsPathway-list>
              <tag>TAG_1</tag>
              <addr-items>
                <PwAddr-list>
                  <addr>1:2::3:4</addr>
                </PwAddr-list>
              </addr-items>
            </VrrsPathway-list>
          </vrrs-items>
        </Interface-list>
      </if-items>
    </inst-items>
  </vrrpv3-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

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.

MODN
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 NameData TypeDescriptionValues
idnw: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 NameData TypeDescriptionValues
tagstring: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 NameData TypeDescriptionValues
addraddress:Ip
IPvX address for vrrs pathwayValue 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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


Related Documentation

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

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

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Deleting an IP Address

Deleting an IP Address
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "vrrpv3VrrsPathway": {
                            "attributes": {
                              "tag": "TAG_1"
                            },
                            "children": [
                              {
                                "vrrpv3PwAddr": {
                                  "attributes": {
                                    "addr": "1:2::3:4",
                                    "status": "deleted"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/2</id>
          <vrrs-items>
            <VrrsPathway-list>
              <tag>TAG_1</tag>
              <addr-items>
                <PwAddr-list nc:operation="delete">
                  <addr>1:2::3:4</addr>
                </PwAddr-list>
              </addr-items>
            </VrrsPathway-list>
          </vrrs-items>
        </Interface-list>
      </if-items>
    </inst-items>
  </vrrpv3-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

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.

MODN
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 NameData TypeDescriptionValues
idnw: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 NameData TypeDescriptionValues
tagstring: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 NameData TypeDescriptionValues
addraddress:Ip
IPvX address for vrrs pathwayValue must match ipv4 or ipv6 known format
statusmo: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


Related Documentation

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

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

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Configuring a Group Description

Configuring a Group Description
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "vrrpv3VrrsPathway": {
                            "attributes": {
                              "description": "SampleString_123",
                              "tag": "TAG_1"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/2</id>
          <vrrs-items>
            <VrrsPathway-list>
              <tag>TAG_1</tag>
              Deleting a Group DescriptionSampleString_123</description>
            </VrrsPathway-list>
          </vrrs-items>
        </Interface-list>
      </if-items>
    </inst-items>
  </vrrpv3-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

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.

MODN
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 NameData TypeDescriptionValues
idnw: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 NameData TypeDescriptionValues
descriptionvrrpv3:Desc
(string:Basic)
Description string for vrrs pathway
MAX SIZE: 80
tagstring: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


Related Documentation

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

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

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Configuring a Mac Address

Deleting a Group Description
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "vrrpv3VrrsPathway": {
                            "attributes": {
                              "tag": "TAG_1"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "descr": "",
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/2</id>
          <vrrs-items>
            <VrrsPathway-list>
              <tag>TAG_1</tag>
            </VrrsPathway-list>
          </vrrs-items>
        </Interface-list>
      </if-items>
    </inst-items>
  </vrrpv3-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
        <descr></descr>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

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.

MODN
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 NameData TypeDescriptionValues
idnw: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 NameData TypeDescriptionValues
tagstring: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 NameData TypeDescriptionValues
descrnaming:Descr1024
(string:Basic)
descr
MAX SIZE: 254
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


Related Documentation

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

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

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Deleting a Mac Address

Configuring a Mac Address
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "vrrpv3VrrsPathway": {
                            "attributes": {
                              "mac": "D8:B1:90:71:E9:03",
                              "tag": "TAG_1"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/2</id>
          <vrrs-items>
            <VrrsPathway-list>
              <tag>TAG_1</tag>
              <mac>D8:B1:90:71:E9:03</mac>
            </VrrsPathway-list>
          </vrrs-items>
        </Interface-list>
      </if-items>
    </inst-items>
  </vrrpv3-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

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.

MODN
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 NameData TypeDescriptionValues
idnw: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 NameData TypeDescriptionValues
macaddress:MAC
Configured virtual MAC address for the PathwayValue must match MM:MM:MM:SS:SS:SS format
tagstring: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


Related Documentation

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

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

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Configuring Pathway Shutdown

Deleting a Mac Address
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "vrrpv3VrrsPathway": {
                            "attributes": {
                              "mac": "00:00:00:00:00:00",
                              "tag": "TAG_1"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/2</id>
          <vrrs-items>
            <VrrsPathway-list>
              <tag>TAG_1</tag>
              <mac>00:00:00:00:00:00</mac>
            </VrrsPathway-list>
          </vrrs-items>
        </Interface-list>
      </if-items>
    </inst-items>
  </vrrpv3-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

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.

MODN
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 NameData TypeDescriptionValues
idnw: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 NameData TypeDescriptionValues
macaddress:MAC
Configured virtual MAC address for the PathwayValue must match MM:MM:MM:SS:SS:SS format
tagstring: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


Related Documentation

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

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

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Configuring Pathway Shutdown

Configuring Pathway Shutdown
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "vrrpv3VrrsPathway": {
                            "attributes": {
                              "adminSt": "disabled",
                              "tag": "TAG_1"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/2</id>
          <vrrs-items>
            <VrrsPathway-list>
              <tag>TAG_1</tag>
              <adminSt>disabled</adminSt>
            </VrrsPathway-list>
          </vrrs-items>
        </Interface-list>
      </if-items>
    </inst-items>
  </vrrpv3-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

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.

MODN
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 NameData TypeDescriptionValues
idnw: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 NameData TypeDescriptionValues
adminStvrrpv3:State
(scalar:Enum8)
Administrative state for vrrs pathwaySELECTION:
0 - disabled
1 - enabled
DEFAULT: enabled
tagstring: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


Related Documentation

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

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

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Deleting Pathway Shutdown

Deleting Pathway Shutdown
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "vrrpv3VrrsPathway": {
                            "attributes": {
                              "adminSt": "enabled",
                              "tag": "TAG_1"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/2</id>
          <vrrs-items>
            <VrrsPathway-list>
              <tag>TAG_1</tag>
              <adminSt>enabled</adminSt>
            </VrrsPathway-list>
          </vrrs-items>
        </Interface-list>
      </if-items>
    </inst-items>
  </vrrpv3-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

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.

MODN
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 NameData TypeDescriptionValues
idnw: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 NameData TypeDescriptionValues
adminStvrrpv3:State
(scalar:Enum8)
Administrative state for vrrs pathwaySELECTION:
0 - disabled
1 - enabled
DEFAULT: enabled
tagstring: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


Related Documentation

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

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

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Configuring Pathway Will Inherit vMAC

Configuring Pathway Will Inherit vMAC
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "vrrpv3VrrsPathway": {
                            "attributes": {
                              "mac": "00:00:00:00:00:00",
                              "tag": "TAG_1"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/2</id>
          <vrrs-items>
            <VrrsPathway-list>
              <tag>TAG_1</tag>
              <mac>00:00:00:00:00:00</mac>
            </VrrsPathway-list>
          </vrrs-items>
        </Interface-list>
      </if-items>
    </inst-items>
  </vrrpv3-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

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.

MODN
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 NameData TypeDescriptionValues
idnw: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 NameData TypeDescriptionValues
macaddress:MAC
Configured virtual MAC address for the PathwayValue must match MM:MM:MM:SS:SS:SS format
tagstring: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


Related Documentation

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

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

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Configuring the Interval Between vMAC Unsolicited Advertisements

Configuring the Interval Between vMAC Unsolicited Advertisements 
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "vrrpv3VrrsPathway": {
                            "attributes": {
                              "macAdvIntvl": "285",
                              "tag": "TAG_1"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/2</id>
          <vrrs-items>
            <VrrsPathway-list>
              <tag>TAG_1</tag>
              <macAdvIntvl>285</macAdvIntvl>
            </VrrsPathway-list>
          </vrrs-items>
        </Interface-list>
      </if-items>
    </inst-items>
  </vrrpv3-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

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.

MODN
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 NameData TypeDescriptionValues
idnw: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 NameData TypeDescriptionValues
macAdvIntvlscalar:Uint16
Interval in seconds, between virtual MAC unsolicited advertisements
RANGE: [1 , 300]
DEFAULT: 10
tagstring: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


Related Documentation

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

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

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Deleting the Interval Between vMAC Unsolicited Advertisements

Deleting the Interval Between vMAC Unsolicited Advertisements 
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "vrrpv3VrrsPathway": {
                            "attributes": {
                              "macAdvIntvl": "10",
                              "tag": "TAG_1"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/2</id>
          <vrrs-items>
            <VrrsPathway-list>
              <tag>TAG_1</tag>
              <macAdvIntvl>10</macAdvIntvl>
            </VrrsPathway-list>
          </vrrs-items>
        </Interface-list>
      </if-items>
    </inst-items>
  </vrrpv3-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

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.

MODN
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 NameData TypeDescriptionValues
idnw: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 NameData TypeDescriptionValues
macAdvIntvlscalar:Uint16
Interval in seconds, between virtual MAC unsolicited advertisements
RANGE: [1 , 300]
DEFAULT: 10
tagstring: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


Related Documentation

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

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

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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