Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)

Latest

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring Minimum Delay

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vrrpv3Entity": {
          "children": [
            {
              "vrrpv3Inst": {
                "children": [
                  {
                    "vrrpv3Interface": {
                      "attributes": {
                        "delayIntfMin": "25",
                        "id": "eth1/2"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
Response
{
    imdata:[]
}

Copy
<System>
  <vrrpv3-items>
    <inst-items>
      <if-items>
        <Interface-list>
          <id>eth1/2</id>
          <delayIntfMin>25</delayIntfMin>
        </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>

Configuring the Delay Period for FHRP Client Initialization

You can configure the delay period for the initialization of FHRP clients.

Note: In all FHRP protocols, we do not recommend to use aggressive timers as they cause CPU spikes and they result in increased control packet flow. In case of VRRPv3, you should configure sufficient interface delay/reload delay for proper failover of the VRRP nodes.

For more information, see the Cisco Nexus 3000 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 Minimum Delay

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
fhrp delay minimum 25

Verifying a DME Configuration

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

MO	DN
topSystem	sys
vrrpv3Entity	sys/vrrpv3
vrrpv3Inst	sys/vrrpv3/inst
vrrpv3Interface	sys/vrrpv3/inst/if-[eth1/2]
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]

vrrpv3Interface Properties

The following table contains information about the vrrpv3Interface properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
delayIntfMin	scalar:Uint16	Delay in seconds, to start VRRPv3 state machine after receiving interface moving to Up state	RANGE: [0 , 3600] DEFAULT: 0
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

l1PhysIf Properties

The following table contains information about the l1PhysIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

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

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

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

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

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

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

Deleting Minimum Delay

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

CLI Commands

interface ethernet 1/2
no fhrp delay minimum 25

Verifying a DME Configuration

MO	DN
topSystem	sys
vrrpv3Entity	sys/vrrpv3
vrrpv3Inst	sys/vrrpv3/inst
vrrpv3Interface	sys/vrrpv3/inst/if-[eth1/2]
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]

vrrpv3Interface Properties

Property Name	Data Type	Description	Values
delayIntfMin	scalar:Uint16	Delay in seconds, to start VRRPv3 state machine after receiving interface moving to Up state	RANGE: [0 , 3600] DEFAULT: 0
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

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

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

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

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

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

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

Configuring Reload Delay

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

CLI Commands

interface ethernet 1/2
fhrp delay reload 2247

Verifying a DME Configuration

MO	DN
topSystem	sys
vrrpv3Entity	sys/vrrpv3
vrrpv3Inst	sys/vrrpv3/inst
vrrpv3Interface	sys/vrrpv3/inst/if-[eth1/2]
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]

vrrpv3Interface Properties

Property Name	Data Type	Description	Values
delayReload	scalar:Uint16	Delay in seconds, to start VRRPv3 state machine after the system-reload	RANGE: [0 , 3600] DEFAULT: 0
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

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

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

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

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

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

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

Deleting Reload Delay

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

CLI Commands

interface ethernet 1/2
no fhrp delay reload 2247

Verifying a DME Configuration

MO	DN
topSystem	sys
vrrpv3Entity	sys/vrrpv3
vrrpv3Inst	sys/vrrpv3/inst
vrrpv3Interface	sys/vrrpv3/inst/if-[eth1/2]
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]

vrrpv3Interface Properties

Property Name	Data Type	Description	Values
delayReload	scalar:Uint16	Delay in seconds, to start VRRPv3 state machine after the system-reload	RANGE: [0 , 3600] DEFAULT: 0
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

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

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

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

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

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

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

Configuring VRRPv3

Configuring Address Match in Advertisement Packets

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

CLI Commands

interface ethernet 1/2
vrrpv3 10 address-family ipv4
match-address

Verifying a DME Configuration

MO	DN
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

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

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 Name	Data Type	Description	Values
af	vrrpv3:VrAf (scalar:Enum8)	Virtual Router Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4
id	vrrpv3:Id (scalar:Uint32)	VRRPv3 Virtual Router Id	RANGE: [1 , 255]
matchAddr	vrrpv3:State (scalar:Enum8)	Enables matching of secondary addresses in the vrrpv3 advertisement packet against the configured vrrpv3 secondary addresses	SELECTION: 0 - disabled 1 - enabled DEFAULT: enabled

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

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

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

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

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

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

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

Deleting Address Match in Advertisement Packets

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

CLI Commands

interface ethernet 1/2
vrrpv3 10 address-family ipv4
no match-address

Verifying a DME Configuration

MO	DN
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

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

vrrpv3Vr Properties

Property Name	Data Type	Description	Values
af	vrrpv3:VrAf (scalar:Enum8)	Virtual Router Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4
id	vrrpv3:Id (scalar:Uint32)	VRRPv3 Virtual Router Id	RANGE: [1 , 255]
matchAddr	vrrpv3:State (scalar:Enum8)	Enables matching of secondary addresses in the vrrpv3 advertisement packet against the configured vrrpv3 secondary addresses	SELECTION: 0 - disabled 1 - enabled DEFAULT: enabled

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

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

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

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

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

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

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

Configuring VRRPv2 Compatibility Mode

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

CLI Commands

interface ethernet 1/2
vrrpv3 10 address-family ipv4
vrrpv2

Verifying a DME Configuration

MO	DN
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

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

vrrpv3Vr Properties

Property Name	Data Type	Description	Values
af	vrrpv3:VrAf (scalar:Enum8)	Virtual Router Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4
id	vrrpv3:Id (scalar:Uint32)	VRRPv3 Virtual Router Id	RANGE: [1 , 255]
vrrpv2CompatMode	vrrpv3:State (scalar:Enum8)	vrrpv2 compatibility mode	SELECTION: 0 - disabled 1 - enabled DEFAULT: disabled

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

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

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

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

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

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

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

Deleting VRRPv2 Compatibility Mode

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

CLI Commands

interface ethernet 1/2
vrrpv3 10 address-family ipv4
no vrrpv2

Verifying a DME Configuration

MO	DN
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

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

vrrpv3Vr Properties

Property Name	Data Type	Description	Values
af	vrrpv3:VrAf (scalar:Enum8)	Virtual Router Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4
id	vrrpv3:Id (scalar:Uint32)	VRRPv3 Virtual Router Id	RANGE: [1 , 255]
vrrpv2CompatMode	vrrpv3:State (scalar:Enum8)	vrrpv2 compatibility mode	SELECTION: 0 - disabled 1 - enabled DEFAULT: disabled

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

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

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

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

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

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

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

Configuring the Group Leader Name (VRRS Tag)

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

CLI Commands

interface ethernet 1/2
vrrpv3 10 address-family ipv4
vrrs leader SampleString_123

Verifying a DME Configuration

MO	DN
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

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

vrrpv3Vr Properties

Property Name	Data Type	Description	Values
af	vrrpv3:VrAf (scalar:Enum8)	Virtual Router Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4
id	vrrpv3: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 Name	Data Type	Description	Values
tag	string:Basic	VRRS tag for which group is leader	MAX SIZE: 48

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

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

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

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

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

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

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

Deleting the Group Leader Name (VRRS Tag)

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

CLI Commands

interface ethernet 1/2
vrrpv3 10 address-family ipv4
no vrrs leader SampleString_123

Verifying a DME Configuration

MO	DN
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

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

vrrpv3Vr Properties

Property Name	Data Type	Description	Values
af	vrrpv3:VrAf (scalar:Enum8)	Virtual Router Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4
id	vrrpv3:Id (scalar:Uint32)	VRRPv3 Virtual Router Id	RANGE: [1 , 255]

vrrpv3VrrsLeader Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
tag	string:Basic	VRRS tag for which group is leader	MAX SIZE: 48

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

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

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

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

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

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

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