Configuring VRRPv3

By default, when VRRPv3 is enabled on the device, a MO calls /sys/vrrpv3/inst/ is created. This is a VRRPv3 configuration instance. As you create VRRPv3 IDs, additional objects are created under the /sys/vrrpv3/inst/ object.

For information about VRRPv3, 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/

Enabling VRRPv3

Enabling VRRPv3
POST http://<IP_Address>/api/mo/sys/fm/vrrp.json
{
  "fmEntity": {
    "children": [
      {
        "fmVrrpv3": {
          "attributes": {
            "adminSt": "enabled"
}}}]}}
{
    imdata:[]
}
<System>
  <fm-items>
    <vrrpv3-items>
      <adminSt>enabled</adminSt>
    </vrrpv3-items>
  </fm-items>
</System>


CLI Command

The CLI command below is the equivalent to the payload example 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 or the YANG tab to view the XML payload.

feature vrrpv3

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


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

MODN
fmEntity sys/fm
fmVrrpv3 sys/fm/vrrpv3


fmVrrpv3 Properties

The following table contains information about the fmVrrpv3 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
adminStfm:AdminState
(scalar:Enum8)
Admin statusSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled


Related Documentation

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

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

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

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

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

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

Disabling VRRPv3

Disabling VRRPv3
POST http://<IP_Address>/api/mo/sys/fm/vrrp.json
{
  "fmEntity": {
    "children": [
      {
        "fmVrrpv3": {
          "attributes": {
            "adminSt": "disabled"
}}}]}}
{
    imdata:[]
}
<System>
  <fm-items>
    <vrrpv3-items>
      <adminSt>disabled</adminSt>
    </vrrpv3-items>
  </fm-items>
</System>


CLI Command

The CLI command below is the equivalent to the payload example 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 or the YANG tab to view the XML payload.

no feature vrrpv3

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


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

MODN
fmEntity sys/fm
fmVrrpv3 sys/fm/vrrpv3


fmVrrpv3 Properties

The following table contains information about the fmVrrpv3 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
adminStfm:AdminState
(scalar:Enum8)
Admin statusSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled


Related Documentation

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

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

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

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

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

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

Creating a VRRPv3 Interface

Creating a VRRPv3 Interface
POST http://<ip_address>/api/mo/sys/vrrpv3/inst.json
{
 "vrrpv3Inst": {
    "children": [
      {
        "vrrpv3Interface": {
          "attributes": {
            "id": "eth1/7"
          },
          "children": [
            {
              "vrrpv3Vr": {
                "attributes": {
                  "af": "ipv4",
                  "id": "10"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/7</id>
          <id-items>
            <Vr-list>
              <id>10</id>
              <af>ipv4</af>
            </Vr-list>
          </id-items>
        </Interface-list>
      </if-items>
    </inst-items>
  </vrrpv3-items>
</System>

The HTTP request shown in this example creates a VRRPv3 instance with a group ID of 10 and an IPv4 address family.


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

interface ethernet1/7
 vrrpv3 10 address-family ipv4

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


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

MODN
vrrpv3Inst sys/vrrpv3/inst
vrrpv3Interface sys/vrrpv3/inst/if-{[id]}
vrrpv3Vr sys/vrrpv3/inst/if-{[id]}/id-{id}-{af}


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


vrrpv3Vr Properties

The following table contains information about the vrrpv3Vr 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
afvrrpv3:VrAf
(scalar:Enum8)
Virtual Router Address FamilySELECTION:
1 - ipv4
2 - ipv6
DEFAULT: ipv4
idvrrpv3:Id
(scalar:Uint32)
VRRPv3 Virtual Router Id
RANGE: [1 , 255]


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

Generating a VRRPv3 Interface

Generating a VRRPv3 Interface
POST http://<ip_address>/api/mo/sys/vrrpv3/inst.json
{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "id": "eth1/7"
                      },
                      "children": [
                        {
                          "vrrpv3Vr": {
                            "attributes": {
                              "af": "ipv6",
                              "id": "123"	  
}}}]}}]}}]}},{
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/7",
                  "layer": "Layer3",
                  "userCfgdFlags": "admin_layer"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/7</id>
          <id-items>
            <Vr-list>
              <id>123</id>
              <af>ipv6</af>
            </Vr-list>
          </id-items>
        </Interface-list>
      </if-items>
    </inst-items>
  </vrrpv3-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/7</id>
        <layer>Layer3</layer>
        <userCfgdFlags>admin_layer</userCfgdFlags>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

interface ethernet1/7
 no switchport
  vrrpv3 123 address-family ipv6

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


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

MODN
topSystem sys
vrrpv3Entity sys/vrrpv3
vrrpv3Inst sys/vrrpv3/inst
vrrpv3Interface sys/vrrpv3/inst/if-{[id]}
vrrpv3Vr sys/vrrpv3/inst/if-{[id]}/id-{id}-{af}
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-{[id]}


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


vrrpv3Vr Properties

The following table contains information about the vrrpv3Vr 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
afvrrpv3:VrAf
(scalar:Enum8)
Virtual Router Address FamilySELECTION:
1 - ipv4
2 - ipv6
DEFAULT: ipv4
idvrrpv3:Id
(scalar:Uint32)
VRRPv3 Virtual Router Id
RANGE: [1 , 255]


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
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
0 - none
1 - admin_state
2 - admin_layer
4 - admin_router_mac
8 - admin_dce_mode
16 - admin_mtu
DEFAULT: none


Related Documentation

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

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

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

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

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

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

Creating a Primary VRRP ID and Address Family

Creating a Primary VRRP ID and Address Family 
POST http://<IP_address>/api/mo/sys/vrrpv3/inst.json
{
 "vrrpv3Interface": {
    "attributes": {
      "id": "eth1/7"
    },
    "children": [
      {
        "vrrpv3Vr": {
          "attributes": {
            "af": "ipv4",
            "id": "10",
            "ip": "100.0.1.10"
}}}]}}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/7</id>
          <id-items>
            <Vr-list>
              <id>10</id>
              <af>ipv4</af>
              <ip>100.0.1.10</ip>
            </Vr-list>
          </id-items>
        </Interface-list>
      </if-items>
    </inst-items>
  </vrrpv3-items>
</System>

The HTTP request shown in this example creates a Managed Object called "vrrpv3Vr" with an address family attribute (af) of ipv4, an address family ID of "10", and an IP address of 10.10.10.102.


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

interface ethernet1/7
 vrrpv3 10 address-family ipv4
  address 100.0.1.10 primary

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


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

MODN
vrrpv3Interface sys/vrrpv3/inst/if-{[id]}
vrrpv3Vr sys/vrrpv3/inst/if-{[id]}/id-{id}-{af}


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


vrrpv3Vr Properties

The following table contains information about the vrrpv3Vr 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
afvrrpv3:VrAf
(scalar:Enum8)
Virtual Router Address FamilySELECTION:
1 - ipv4
2 - ipv6
DEFAULT: ipv4
idvrrpv3:Id
(scalar:Uint32)
VRRPv3 Virtual Router Id
RANGE: [1 , 255]
ipaddress:Ip
primary IP addressValue must match ipv4 or ipv6 known format


Related Documentation

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

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

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

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

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

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

Configuring VRRPv3 Control Group for IPv6

Configuring VRRPv3 for IPv6 
POST http://<mgmt0_IP>/api/mo/sys/vrrpv3/inst.json
{
"vrrpv3Inst": {
 "children": [
  {
    "vrrpv3Interface": {
      "attributes": {
        "id": "eth1/1"
},
"children": [
{
  "vrrpv3Vr": {
    "attributes": {
      "af": "ipv6",
      "id": "1",
      "ip": "fe80::1",
      "preempt": "disabled",
      "priCfg": "120"
},
"children": [
  {
    "vrrpv3Addr": {
      "attributes": {
        "addr": "1::5"
}}},{
"vrrpv3Addr": {
  "attributes": {
    "addr": "1::2"
}}},{
"vrrpv3Addr": {
  "attributes": {
    "addr": "1::8"
}}},{
"vrrpv3Addr": {
  "attributes": {
    "addr": "1::3"
}}},{
"vrrpv3Addr": {
  "attributes": {
    "addr": "1::7"
}}},{
"vrrpv3Addr": {
  "attributes": {
    "addr": "1::6"
}}},{
"vrrpv3Addr": {
  "attributes": {
    "addr": "1::4"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/1</id>
          <id-items>
            <Vr-list>
              <id>1</id>
              <af>ipv6</af>
              <ip>fe80::1</ip>
              <preempt>disabled</preempt>
              <priCfg>120</priCfg>
              <addr-items>
                <Addr-list>
                  <addr>1::5</addr>
                </Addr-list>
                <Addr-list>
                  <addr>1::2</addr>
                </Addr-list>
                <Addr-list>
                  <addr>1::8</addr>
                </Addr-list>
                <Addr-list>
                  <addr>1::3</addr>
                </Addr-list>
                <Addr-list>
                  <addr>1::7</addr>
                </Addr-list>
                <Addr-list>
                  <addr>1::6</addr>
                </Addr-list>
                <Addr-list>
                  <addr>1::4</addr>
                </Addr-list>
              </addr-items>
            </Vr-list>
          </id-items>
        </Interface-list>
      </if-items>
    </inst-items>
  </vrrpv3-items>
</System>

When configuring a VRRPv3 control group for IPv6, the IP in the payload must be a LINK-Local address. For VRRPv3 IPv6 configurations, link local is the primary address. So global unicast addresses must be the secondary addresses (child MOs).

Note: Secondary IP address support was added from Release 7.0(3)I6(1) where as primary IP and vrrpv3 REST configs are supported from Release 7.0(3)I5(1).


CLI Commands

The CLI commands and options listed below are the 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 or the YANG tab to view the XML payload.

interface ethernet1/1
 vrrpv3 1 address-family ipv6
  priority 120
  no preempt
  address fe80::1 primary
  address 1::2
  address 1::3
  address 1::4
  address 1::5
  address 1::6
  address 1::7
  address 1::8

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


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

MODN
vrrpv3Inst sys/vrrpv3/inst
vrrpv3Interface sys/vrrpv3/inst/if-{[id]}
vrrpv3Vr sys/vrrpv3/inst/if-{[id]}/id-{id}-{af}
vrrpv3Addr sys/vrrpv3/inst/if-{[id]}/id-{id}-{af}/addr-{[addr]}


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


vrrpv3Vr Properties

The following table contains information about the vrrpv3Vr 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
afvrrpv3:VrAf
(scalar:Enum8)
Virtual Router Address FamilySELECTION:
1 - ipv4
2 - ipv6
DEFAULT: ipv4
idvrrpv3:Id
(scalar:Uint32)
VRRPv3 Virtual Router Id
RANGE: [1 , 255]
ipaddress:Ip
primary IP addressValue must match ipv4 or ipv6 known format
preemptvrrpv3:Preempt
(scalar:Enum8)
PreemptSELECTION:
0 - disabled
1 - enabled
DEFAULT: enabled
priCfgvrrpv3:PriVal
(scalar:Uint32)
Configured Priority
RANGE: [1 , 254]
DEFAULT: 100


vrrpv3Addr Properties

The following table contains information about the vrrpv3Addr 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
IP addressValue must match ipv4 or ipv6 known format


Related Documentation

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

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

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

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

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

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

Configuring VRRPv3 Control Group for IPv4

Configuring VRRPv3 for IPv4 
POST http://<mgmt0_IP>/api/mo/sys/vrrpv3/inst.json
{
  "vrrpv3Inst": {
    "children": [
      {
        "vrrpv3Interface": {
          "attributes": {
            "id": "eth1/1"
},
"children": [
{
  "vrrpv3Vr": {
    "attributes": {
      "advIntvl": "1100",
      "af": "ipv4",
      "id": "1",
      "ip": "1.1.1.2",
      "preempt": "enabled",
      "preemptDelayMin": "10",
      "priCfg": "150"
},
"children": [
  {
    "vrrpv3Addr": {
      "attributes": {
        "addr": "1.1.1.8"
}}},{
"vrrpv3Addr": {
  "attributes": {
    "addr": "1.1.1.3"
}}},{
"vrrpv3Addr": {
  "attributes": {
    "addr": "1.1.1.7"
}}},{
"vrrpv3Addr": {
  "attributes": {
    "addr": "1.1.1.9"
}}},{
"vrrpv3Addr": {
  "attributes": {
    "addr": "1.1.1.4"
}}},{
"vrrpv3Addr": {
  "attributes": {
    "addr": "1.1.1.5"
}}},{
"vrrpv3Addr": {
  "attributes": {
    "addr": "1.1.1.6"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/1</id>
          <id-items>
            <Vr-list>
              <id>1</id>
              <af>ipv4</af>
              <advIntvl>1100</advIntvl>
              <ip>1.1.1.2</ip>
              <preempt>enabled</preempt>
              <preemptDelayMin>10</preemptDelayMin>
              <priCfg>150</priCfg>
              <addr-items>
                <Addr-list>
                  <addr>1.1.1.8</addr>
                </Addr-list>
                <Addr-list>
                  <addr>1.1.1.3</addr>
                </Addr-list>
                <Addr-list>
                  <addr>1.1.1.7</addr>
                </Addr-list>
                <Addr-list>
                  <addr>1.1.1.9</addr>
                </Addr-list>
                <Addr-list>
                  <addr>1.1.1.4</addr>
                </Addr-list>
                <Addr-list>
                  <addr>1.1.1.5</addr>
                </Addr-list>
                <Addr-list>
                  <addr>1.1.1.6</addr>
                </Addr-list>
              </addr-items>
            </Vr-list>
          </id-items>
        </Interface-list>
      </if-items>
    </inst-items>
  </vrrpv3-items>
</System>

Configures a VRRPv3 control group for IPv4.


CLI Commands

The CLI commands and options listed below are the 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 or the YANG tab to view the XML payload.

interface ethernet1/1
 vrrpv3 1 address-family ipv4
  timers advertise 1100
  priority 150
   preempt delay minimum 10
   address 1.1.1.2 primary
   address 1.1.1.3 secondary
   address 1.1.1.4 secondary
   address 1.1.1.5 secondary
   address 1.1.1.6 secondary
   address 1.1.1.7 secondary
   address 1.1.1.8 secondary
   address 1.1.1.9 secondary

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


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

MODN
vrrpv3Inst sys/vrrpv3/inst
vrrpv3Interface sys/vrrpv3/inst/if-{[id]}
vrrpv3Vr sys/vrrpv3/inst/if-{[id]}/id-{id}-{af}
vrrpv3Addr sys/vrrpv3/inst/if-{[id]}/id-{id}-{af}/addr-{[addr]}


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


vrrpv3Vr Properties

The following table contains information about the vrrpv3Vr 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
advIntvlvrrpv3:AdvIntvl
(scalar:Uint32)
Advertisement Interval
RANGE: [100 , 40950]
DEFAULT: 1000
afvrrpv3:VrAf
(scalar:Enum8)
Virtual Router Address FamilySELECTION:
1 - ipv4
2 - ipv6
DEFAULT: ipv4
idvrrpv3:Id
(scalar:Uint32)
VRRPv3 Virtual Router Id
RANGE: [1 , 255]
ipaddress:Ip
primary IP addressValue must match ipv4 or ipv6 known format
preemptvrrpv3:Preempt
(scalar:Enum8)
PreemptSELECTION:
0 - disabled
1 - enabled
DEFAULT: enabled
preemptDelayMinvrrpv3:PreemptDelay
(scalar:Uint32)
Miminum delay before preempt
RANGE: [0 , 3600]
DEFAULT: 0
priCfgvrrpv3:PriVal
(scalar:Uint32)
Configured Priority
RANGE: [1 , 254]
DEFAULT: 100


vrrpv3Addr Properties

The following table contains information about the vrrpv3Addr 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
IP addressValue must match ipv4 or ipv6 known format


Related Documentation

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

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

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

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

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

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

Configuring VRRPv3 Object Tracking

Configuring VRRPv3 Object Tracking
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "id": "vlan123"
                      },
                      "children": [
                        {
                          "vrrpv3Vr": {
                            "attributes": {
                              "af": "ipv4",
                              "id": "123"
                            },
                            "children": [
                              {
                                "vrrpv3ObjectTrack": {
                                  "attributes": {
                                    "decrPrio": "10",
                                    "id": "123"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "sviIf": {
                "attributes": {
                  "id": "vlan123"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>vlan123</id>
          <id-items>
            <Vr-list>
              <id>123</id>
              <af>ipv4</af>
              <track-items>
                <ObjectTrack-list>
                  <id>123</id>
                  <decrPrio>10</decrPrio>
                </ObjectTrack-list>
              </track-items>
            </Vr-list>
          </id-items>
        </Interface-list>
      </if-items>
    </inst-items>
  </vrrpv3-items>
  <intf-items>
    <svi-items>
      <If-list>
        <id>vlan123</id>
      </If-list>
    </svi-items>
  </intf-items>
</System>

Note: This example was added in Release 9.2(2)


CLI Commands

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

interface vlan 123
 vrrpv3 address-family ipv4
  track 123

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


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

MODN
topSystem sys
vrrpv3Entity sys/vrrpv3
vrrpv3Inst sys/vrrpv3/inst
vrrpv3Interface sys/vrrpv3/inst/if-{[id]}
vrrpv3Vr sys/vrrpv3/inst/if-{[id]}/id-{id}-{af}
vrrpv3ObjectTrack sys/vrrpv3/inst/if-{[id]}/id-{id}-{af}/track-{id}
interfaceEntity sys/intf
sviIf sys/intf/svi-{[id]}


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


vrrpv3Vr Properties

The following table contains information about the vrrpv3Vr 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
afvrrpv3:VrAf
(scalar:Enum8)
Virtual Router Address FamilySELECTION:
1 - ipv4
2 - ipv6
DEFAULT: ipv4
idvrrpv3:Id
(scalar:Uint32)
VRRPv3 Virtual Router Id
RANGE: [1 , 255]


vrrpv3ObjectTrack Properties

The following table contains information about the vrrpv3ObjectTrack 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
decrPrioscalar:Uint16
Priority to be decremented when tracked object is down. Default value is 10
RANGE: [1 , 254]
DEFAULT: 10
idtrack:TrackId
(scalar:Uint16)
Object Id to be tracked
RANGE: [1 , 512]


sviIf Properties

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

Unconfiguring VRRPv3 Object Tracking

Unconfiguring VRRPv3 Object Tracking
POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "id": "vlan123"
                      },
                      "children": [
                        {
                          "vrrpv3Vr": {
                            "attributes": {
                              "af": "ipv4",
                              "id": "123"
                            },
                            "children": [
                              {
                                "vrrpv3ObjectTrack": {
                                  "attributes": {
                                    "id": "123",
                                    "status": "deleted"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "sviIf": {
                "attributes": {
                  "id": "vlan123"
                }
              }
            }
          ]
        }
      }
    ]
  }
} 
{
    imdata:[]
}

 <System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>vlan123</id>
          <id-items>
            <Vr-list>
              <id>123</id>
              <af>ipv4</af>
              <track-items>
                <ObjectTrack-list xc:operation="delete">
                  <id>123</id>
                </ObjectTrack-list>
              </track-items>
            </Vr-list>
          </id-items>
        </Interface-list>
      </if-items>
    </inst-items>
  </vrrpv3-items>
  <intf-items>
    <svi-items>
      <If-list>
        <id>vlan123</id>
      </If-list>
    </svi-items>
  </intf-items>
</System>

Note: This example was added in Release 9.2(2)


CLI Commands

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

interface vlan 123
 vrrpv3 address-family ipv4
  no track 123

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


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

MODN
topSystem sys
vrrpv3Entity sys/vrrpv3
vrrpv3Inst sys/vrrpv3/inst
vrrpv3Interface sys/vrrpv3/inst/if-{[id]}
vrrpv3Vr sys/vrrpv3/inst/if-{[id]}/id-{id}-{af}
vrrpv3ObjectTrack sys/vrrpv3/inst/if-{[id]}/id-{id}-{af}/track-{id}
interfaceEntity sys/intf
sviIf sys/intf/svi-{[id]}


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


vrrpv3Vr Properties

The following table contains information about the vrrpv3Vr 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
afvrrpv3:VrAf
(scalar:Enum8)
Virtual Router Address FamilySELECTION:
1 - ipv4
2 - ipv6
DEFAULT: ipv4
idvrrpv3:Id
(scalar:Uint32)
VRRPv3 Virtual Router Id
RANGE: [1 , 255]


vrrpv3ObjectTrack Properties

The following table contains information about the vrrpv3ObjectTrack 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
idtrack:TrackId
(scalar:Uint16)
Object Id to be tracked
RANGE: [1 , 512]
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


sviIf Properties

The following table contains information about the sviIf 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 VRRPv3 Protocol Shutdown

Configuring a VRRPv3 Protocol Shutdown 
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "vrrpv3Vr": {
                            "attributes": {
                              "adminSt": "disabled",
                              "af": "ipv4",
                              "id": "10"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/2</id>
          <id-items>
            <Vr-list>
              <id>10</id>
              <af>ipv4</af>
              <adminSt>disabled</adminSt>
            </Vr-list>
          </id-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(1).


CLI Commands

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

interface ethernet 1/2
 vrrpv3 10 address-family ipv4
  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
interfaceEntitysys/intf
l1PhysIfsys/intf/phys-[eth1/2]
vrrpv3Entitysys/vrrpv3
vrrpv3Instsys/vrrpv3/inst
vrrpv3Interfacesys/vrrpv3/inst/if-[eth1/2]
vrrpv3Vrsys/vrrpv3/inst/if-[eth1/2]/id-10-ipv4


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


vrrpv3Vr Properties

The following table contains information about the vrrpv3Vr 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:AdminSt
(scalar:Enum8)
Admin stateSELECTION:
0 - enabled
1 - disabled
afvrrpv3:VrAf
(scalar:Enum8)
Virtual Router Address FamilySELECTION:
1 - ipv4
2 - ipv6
DEFAULT: ipv4
idvrrpv3:Id
(scalar:Uint32)
VRRPv3 Virtual Router Id
RANGE: [1 , 255]


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

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

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 VRRPv3 Protocol Shutdown

Deleting a VRRPv3 Protocol Shutdown 
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "vrrpv3Vr": {
                            "attributes": {
                              "adminSt": "enabled",
                              "af": "ipv4",
                              "id": "10"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/2</id>
          <id-items>
            <Vr-list>
              <id>10</id>
              <af>ipv4</af>
              <adminSt>enabled</adminSt>
            </Vr-list>
          </id-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(1).


CLI Commands

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

interface ethernet 1/2
 vrrpv3 10 address-family ipv4
  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
interfaceEntitysys/intf
l1PhysIfsys/intf/phys-[eth1/2]
vrrpv3Entitysys/vrrpv3
vrrpv3Instsys/vrrpv3/inst
vrrpv3Interfacesys/vrrpv3/inst/if-[eth1/2]
vrrpv3Vrsys/vrrpv3/inst/if-[eth1/2]/id-10-ipv4


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


vrrpv3Vr Properties

The following table contains information about the vrrpv3Vr 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:AdminSt
(scalar:Enum8)
Admin stateSELECTION:
0 - enabled
1 - disabled
afvrrpv3:VrAf
(scalar:Enum8)
Virtual Router Address FamilySELECTION:
1 - ipv4
2 - ipv6
DEFAULT: ipv4
idvrrpv3:Id
(scalar:Uint32)
VRRPv3 Virtual Router Id
RANGE: [1 , 255]


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

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

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

Configuring an IPv6 Address 
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "vrrpv3Vr": {
                            "attributes": {
                              "af": "ipv6",
                              "id": "10"
                            },
                            "children": [
                              {
                                "vrrpv3Addr": {
                                  "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>
          <id-items>
            <Vr-list>
              <id>10</id>
              <af>ipv6</af>
              <addr-items>
                <Addr-list>
                  <addr>1:2::3:4</addr>
                </Addr-list>
              </addr-items>
            </Vr-list>
          </id-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(1).


CLI Commands

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

interface ethernet 1/2
 vrrpv3 10 address-family ipv6
  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
interfaceEntitysys/intf
l1PhysIfsys/intf/phys-[eth1/2]
vrrpv3Addrsys/vrrpv3/inst/if-[eth1/2]/id-10-ipv6/addr-[1:2::3:4]
vrrpv3Entitysys/vrrpv3
vrrpv3Instsys/vrrpv3/inst
vrrpv3Interfacesys/vrrpv3/inst/if-[eth1/2]
vrrpv3Vrsys/vrrpv3/inst/if-[eth1/2]/id-10-ipv6


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


vrrpv3Vr Properties

The following table contains information about the vrrpv3Vr 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
afvrrpv3:VrAf
(scalar:Enum8)
Virtual Router Address FamilySELECTION:
1 - ipv4
2 - ipv6
DEFAULT: ipv4
idvrrpv3:Id
(scalar:Uint32)
VRRPv3 Virtual Router Id
RANGE: [1 , 255]


vrrpv3Addr Properties

The following table contains information about the vrrpv3Addr 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
IP addressValue 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

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

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

Deleting an IPv6 Address 
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "vrrpv3Vr": {
                            "attributes": {
                              "af": "ipv6",
                              "id": "10"
                            },
                            "children": [
                              {
                                "vrrpv3Addr": {
                                  "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>
          <id-items>
            <Vr-list>
              <id>10</id>
              <af>ipv6</af>
              <addr-items>
                <Addr-list xc:operation="delete">
                  <addr>1:2::3:4</addr>
                </Addr-list>
              </addr-items>
            </Vr-list>
          </id-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(1).


CLI Commands

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

interface ethernet 1/2
 vrrpv3 10 address-family ipv6
  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
interfaceEntitysys/intf
l1PhysIfsys/intf/phys-[eth1/2]
vrrpv3Addrsys/vrrpv3/inst/if-[eth1/2]/id-10-ipv6/addr-[1:2::3:4]
vrrpv3Entitysys/vrrpv3
vrrpv3Instsys/vrrpv3/inst
vrrpv3Interfacesys/vrrpv3/inst/if-[eth1/2]
vrrpv3Vrsys/vrrpv3/inst/if-[eth1/2]/id-10-ipv6


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


vrrpv3Vr Properties

The following table contains information about the vrrpv3Vr 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
afvrrpv3:VrAf
(scalar:Enum8)
Virtual Router Address FamilySELECTION:
1 - ipv4
2 - ipv6
DEFAULT: ipv4
idvrrpv3:Id
(scalar:Uint32)
VRRPv3 Virtual Router Id
RANGE: [1 , 255]


vrrpv3Addr Properties

The following table contains information about the vrrpv3Addr 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
IP addressValue must match ipv4 or ipv6 known format
statusmo:ModificationStatus
(scalar:Bitmask32)
Modification statusSELECTION:
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

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

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

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

Configuring Address Match in Advertisement Packets

Configuring Address Match in Advertisement Packets
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "vrrpv3Vr": {
                            "attributes": {
                              "af": "ipv4",
                              "id": "10",
                              "matchAddr": "enabled"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/2</id>
          <id-items>
            <Vr-list>
              <id>10</id>
              <af>ipv4</af>
              <matchAddr>enabled</matchAddr>
            </Vr-list>
          </id-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
  vrrpv3 10 address-family ipv4
   match-address


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]
vrrpv3Vr sys/vrrpv3/inst/if-[eth1/2]/id-10-ipv4
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


vrrpv3Vr Properties

The following table contains information about the vrrpv3Vr 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
afvrrpv3:VrAf
(scalar:Enum8)
Virtual Router Address FamilySELECTION:
1 - ipv4
2 - ipv6
DEFAULT: ipv4
idvrrpv3:Id
(scalar:Uint32)
VRRPv3 Virtual Router Id
RANGE: [1 , 255]
matchAddrvrrpv3:State
(scalar:Enum8)
Enables matching of secondary addresses in the vrrpv3 advertisement packet against the configured vrrpv3 secondary addressesSELECTION:
0 - disabled
1 - enabled
DEFAULT: enabled


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 Address Match in Advertisement Packets

Deleting Address Match in Advertisement Packets
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "vrrpv3Vr": {
                            "attributes": {
                              "af": "ipv4",
                              "id": "10",
                              "matchAddr": "disabled"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/2</id>
          <id-items>
            <Vr-list>
              <id>10</id>
              <af>ipv4</af>
              <matchAddr>disabled</matchAddr>
            </Vr-list>
          </id-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
  vrrpv3 10 address-family ipv4
   no match-address


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]
vrrpv3Vr sys/vrrpv3/inst/if-[eth1/2]/id-10-ipv4
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


vrrpv3Vr Properties

The following table contains information about the vrrpv3Vr 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
afvrrpv3:VrAf
(scalar:Enum8)
Virtual Router Address FamilySELECTION:
1 - ipv4
2 - ipv6
DEFAULT: ipv4
idvrrpv3:Id
(scalar:Uint32)
VRRPv3 Virtual Router Id
RANGE: [1 , 255]
matchAddrvrrpv3:State
(scalar:Enum8)
Enables matching of secondary addresses in the vrrpv3 advertisement packet against the configured vrrpv3 secondary addressesSELECTION:
0 - disabled
1 - enabled
DEFAULT: enabled


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 VRRPv2 Compatibility Mode

Configuring VRRPv2 Compatibility Mode
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "vrrpv3Vr": {
                            "attributes": {
                              "af": "ipv4",
                              "id": "10",
                              "vrrpv2CompatMode": "enabled"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/2</id>
          <id-items>
            <Vr-list>
              <id>10</id>
              <af>ipv4</af>
              <vrrpv2CompatMode>enabled</vrrpv2CompatMode>
            </Vr-list>
          </id-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
  vrrpv3 10 address-family ipv4
   vrrpv2


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]
vrrpv3Vr sys/vrrpv3/inst/if-[eth1/2]/id-10-ipv4
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


vrrpv3Vr Properties

The following table contains information about the vrrpv3Vr 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
afvrrpv3:VrAf
(scalar:Enum8)
Virtual Router Address FamilySELECTION:
1 - ipv4
2 - ipv6
DEFAULT: ipv4
idvrrpv3:Id
(scalar:Uint32)
VRRPv3 Virtual Router Id
RANGE: [1 , 255]
vrrpv2CompatModevrrpv3:State
(scalar:Enum8)
vrrpv2 compatibility modeSELECTION:
0 - disabled
1 - enabled
DEFAULT: disabled


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 VRRPv2 Compatibility Mode

Deleting VRRPv2 Compatibility Mode
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "vrrpv3Vr": {
                            "attributes": {
                              "af": "ipv4",
                              "id": "10",
                              "vrrpv2CompatMode": "disabled"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/2</id>
          <id-items>
            <Vr-list>
              <id>10</id>
              <af>ipv4</af>
              <vrrpv2CompatMode>disabled</vrrpv2CompatMode>
            </Vr-list>
          </id-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
  vrrpv3 10 address-family ipv4
   no vrrpv2


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]
vrrpv3Vr sys/vrrpv3/inst/if-[eth1/2]/id-10-ipv4
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


vrrpv3Vr Properties

The following table contains information about the vrrpv3Vr 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
afvrrpv3:VrAf
(scalar:Enum8)
Virtual Router Address FamilySELECTION:
1 - ipv4
2 - ipv6
DEFAULT: ipv4
idvrrpv3:Id
(scalar:Uint32)
VRRPv3 Virtual Router Id
RANGE: [1 , 255]
vrrpv2CompatModevrrpv3:State
(scalar:Enum8)
vrrpv2 compatibility modeSELECTION:
0 - disabled
1 - enabled
DEFAULT: disabled


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 Group Leader Name (VRRS Tag)

Configuring the Group Leader Name (VRRS Tag)
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "vrrpv3Vr": {
                            "attributes": {
                              "af": "ipv4",
                              "id": "10"
                            },
                            "children": [
                              {
                                "vrrpv3VrrsLeader": {
                                  "attributes": {
                                    "tag": "SampleString_123"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/2</id>
          <id-items>
            <Vr-list>
              <id>10</id>
              <af>ipv4</af>
              <leader-items>
                <VrrsLeader-list>
                  <tag>SampleString_123</tag>
                </VrrsLeader-list>
              </leader-items>
            </Vr-list>
          </id-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
  vrrpv3 10 address-family ipv4
   vrrs leader 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]
vrrpv3Vr sys/vrrpv3/inst/if-[eth1/2]/id-10-ipv4
vrrpv3VrrsLeader sys/vrrpv3/inst/if-[eth1/2]/id-10-ipv4/leader-SampleString_123
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


vrrpv3Vr Properties

The following table contains information about the vrrpv3Vr 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
afvrrpv3:VrAf
(scalar:Enum8)
Virtual Router Address FamilySELECTION:
1 - ipv4
2 - ipv6
DEFAULT: ipv4
idvrrpv3:Id
(scalar:Uint32)
VRRPv3 Virtual Router Id
RANGE: [1 , 255]


vrrpv3VrrsLeader Properties

The following table contains information about the vrrpv3VrrsLeader 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
VRRS tag for which group is leader
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 Group Leader Name (VRRS Tag)

Deleting the Group Leader Name (VRRS Tag)
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "vrrpv3Vr": {
                            "attributes": {
                              "af": "ipv4",
                              "id": "10"
                            },
                            "children": [
                              {
                                "vrrpv3VrrsLeader": {
                                  "attributes": {
                                    "status": "deleted",
                                    "tag": "SampleString_123"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/2</id>
          <id-items>
            <Vr-list>
              <id>10</id>
              <af>ipv4</af>
              <leader-items>
                <VrrsLeader-list nc:operation="delete">
                  <tag>SampleString_123</tag>
                </VrrsLeader-list>
              </leader-items>
            </Vr-list>
          </id-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
  vrrpv3 10 address-family ipv4
   no vrrs leader 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]
vrrpv3Vr sys/vrrpv3/inst/if-[eth1/2]/id-10-ipv4
vrrpv3VrrsLeader sys/vrrpv3/inst/if-[eth1/2]/id-10-ipv4/leader-SampleString_123
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


vrrpv3Vr Properties

The following table contains information about the vrrpv3Vr 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
afvrrpv3:VrAf
(scalar:Enum8)
Virtual Router Address FamilySELECTION:
1 - ipv4
2 - ipv6
DEFAULT: ipv4
idvrrpv3:Id
(scalar:Uint32)
VRRPv3 Virtual Router Id
RANGE: [1 , 255]


vrrpv3VrrsLeader Properties

The following table contains information about the vrrpv3VrrsLeader 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
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced
tagstring:Basic
VRRS tag for which group is leader
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