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

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

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring the Max Route Limit

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "l3Inst": {
          "attributes": {
            "name": "VRF_1"
          },
          "children": [
            {
              "rtctrlDom": {
                "attributes": {
                  "name": "VRF_1"
                },
                "children": [
                  {
                    "rtctrlDomAf": {
                      "attributes": {
                        "type": "ipv4-ucast"
                      },
                      "children": [
                        {
                          "l3MaxRoutes": {
                            "attributes": {
                              "action": "shut",
                              "maxRt": "100",
                              "reinstall": "100",
                              "thresh": "100"
}}}]}}]}}]}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <inst-items>
    <Inst-list>
      <name>VRF_1</name>
      <dom-items>
        <Dom-list>
          <name>VRF_1</name>
          <af-items>
            <DomAf-list>
              <type>ipv4-ucast</type>
              <maxrts-items>
                <action>shut</action>
                <maxRt>100</maxRt>
                <reinstall>100</reinstall>
                <thresh>100</thresh>
              </maxrts-items>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </Inst-list>
  </inst-items>
</System>

Configuring the Max Route Limit

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.

vrf context VRF_1
address-family ipv4 unicast
maximum routes 100

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
l3Inst	sys/inst-VRF_1
rtctrlDom	sys/inst-VRF_1/dom-VRF_1
rtctrlDomAf	sys/inst-VRF_1/dom-VRF_1/af-ipv4-ucast
l3MaxRoutes	sys/inst-VRF_1/dom-VRF_1/af-ipv4-ucast/maxrts

l3MaxRoutes Properties

The following table contains information about the l3MaxRoutes 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
action	l3:MaxRtAct (scalar:Enum8)	Action to do when warning message limit is exceeded	SELECTION: 1 - log 2 - shut 3 - reinstall DEFAULT: shut
maxRt	l3:MaxLmt (scalar:Uint32)	Maximum number of routes allowed	RANGE: [0 , 4294967295] Default: 0
reinstall	l3:MaxRtThresh (scalar:UByte)	Reinstall previous rejected route due to over maximum route limit	RANGE: [1 , 100] DEFAULT: 100
thresh	l3:MaxRtThresh (scalar:UByte)	Threshold percentage at which to generate a warning	RANGE: [1 , 100] DEFAULT: 100

l3Inst Properties

The following table contains information about the l3Inst 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
name	naming:Name256 string:Basic	The Layer 3 instance name.	RANGE: Min: "1" Max: "128"

rtctrlDom Properties

The following table contains information about the rtctrlDom 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
name	naming:Name256 string:Basic	The name of the object.

rtctrlDomAf Properties

The following table contains information about the rtctrlDomAf 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
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 1 - ipv4-ucast 2 - ipv4-mcast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 11 - ipv6-lucast 12 - lnkstate 13 - ipv4-mvpn 14 - ipv6-mvpn 15 - l2vpn-vpls 16 - ipv4-mdt DEFAULT: ipv4-ucast

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 Max Route Limit Configuration

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

CLI Commands

vrf context VRF_1
address-family ipv4 unicast
no maximum routes 100

Verifying a DME Configuration

MO	DN
topSystem	sys
l3Inst	sys/inst-VRF_1
rtctrlDom	sys/inst-VRF_1/dom-VRF_1
rtctrlDomAf	sys/inst-VRF_1/dom-VRF_1/af-ipv4-ucast
l3MaxRoutes	sys/inst-VRF_1/dom-VRF_1/af-ipv4-ucast/maxrts

l3Inst Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The Layer 3 instance name.	RANGE: Min: "1" Max: "128"

rtctrlDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The name of the object.

rtctrlDomAf Properties

Property Name	Data Type	Description	Values
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 1 - ipv4-ucast 2 - ipv4-mcast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 11 - ipv6-lucast 12 - lnkstate 13 - ipv4-mvpn 14 - ipv6-mvpn 15 - l2vpn-vpls 16 - ipv4-mdt DEFAULT: ipv4-ucast

l3MaxRoutes Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

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

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 Max Route Limit Threshold

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

CLI Commands

vrf context VRF_1
address-family ipv4 unicast
maximum routes 100 80

Verifying a DME Configuration

MO	DN
topSystem	sys
l3Inst	sys/inst-VRF_1
rtctrlDom	sys/inst-VRF_1/dom-VRF_1
rtctrlDomAf	sys/inst-VRF_1/dom-VRF_1/af-ipv4-ucast
l3MaxRoutes	sys/inst-VRF_1/dom-VRF_1/af-ipv4-ucast/maxrts

l3Inst Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The Layer 3 instance name.	RANGE: Min: "1" Max: "128"

rtctrlDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The name of the object.

rtctrlDomAf Properties

Property Name	Data Type	Description	Values
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 1 - ipv4-ucast 2 - ipv4-mcast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 11 - ipv6-lucast 12 - lnkstate 13 - ipv4-mvpn 14 - ipv6-mvpn 15 - l2vpn-vpls 16 - ipv4-mdt DEFAULT: ipv4-ucast

l3MaxRoutes Properties

Property Name	Data Type	Description	Values
action	l3:MaxRtAct (scalar:Enum8)	Action to do when warning message limit is exceeded	SELECTION: 1 - log 2 - shut 3 - reinstall DEFAULT: shut
maxRt	l3:MaxLmt (scalar:Uint32)	Maximum number of routes allowed	RANGE: [0 , 4294967295] Default: 0
reinstall	l3:MaxRtThresh (scalar:UByte)	Reinstall previous rejected route due to over maximum route limit	RANGE: [1 , 100] DEFAULT: 100
thresh	l3:MaxRtThresh (scalar:UByte)	Threshold percentage at which to generate a warning	RANGE: [1 , 100] DEFAULT: 100

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 Max Route Limit Threshold Configuration

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

CLI Commands

vrf context VRF_1
address-family ipv4 unicast
no maximum routes 100 80

Verifying a DME Configuration

MO	DN
topSystem	sys
l3Inst	sys/inst-VRF_1
rtctrlDom	sys/inst-VRF_1/dom-VRF_1
rtctrlDomAf	sys/inst-VRF_1/dom-VRF_1/af-ipv4-ucast
l3MaxRoutes	sys/inst-VRF_1/dom-VRF_1/af-ipv4-ucast/maxrts

l3Inst Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The Layer 3 instance name.	RANGE: Min: "1" Max: "128"

rtctrlDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The name of the object.

rtctrlDomAf Properties

Property Name	Data Type	Description	Values
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 1 - ipv4-ucast 2 - ipv4-mcast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 11 - ipv6-lucast 12 - lnkstate 13 - ipv4-mvpn 14 - ipv6-mvpn 15 - l2vpn-vpls 16 - ipv4-mdt DEFAULT: ipv4-ucast

l3MaxRoutes Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

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

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 Reinstall of a Previously Rejected Route Due to Over Max Route Limit

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

CLI Commands

vrf context VRF_1
address-family ipv4 unicast
maximum routes 100 75 reinstall 84

Verifying a DME Configuration

MO	DN
topSystem	sys
l3Inst	sys/inst-VRF_1
rtctrlDom	sys/inst-VRF_1/dom-VRF_1
rtctrlDomAf	sys/inst-VRF_1/dom-VRF_1/af-ipv4-ucast
l3MaxRoutes	sys/inst-VRF_1/dom-VRF_1/af-ipv4-ucast/maxrts

l3Inst Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The Layer 3 instance name.	RANGE: Min: "1" Max: "128"

rtctrlDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The name of the object.

rtctrlDomAf Properties

Property Name	Data Type	Description	Values
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 1 - ipv4-ucast 2 - ipv4-mcast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 11 - ipv6-lucast 12 - lnkstate 13 - ipv4-mvpn 14 - ipv6-mvpn 15 - l2vpn-vpls 16 - ipv4-mdt DEFAULT: ipv4-ucast

l3MaxRoutes Properties

Property Name	Data Type	Description	Values
action	l3:MaxRtAct (scalar:Enum8)	Action to do when warning message limit is exceeded	SELECTION: 1 - log 2 - shut 3 - reinstall DEFAULT: shut
maxRt	l3:MaxLmt (scalar:Uint32)	Maximum number of routes allowed	RANGE: [0 , 4294967295] Default: 0
reinstall	l3:MaxRtThresh (scalar:UByte)	Reinstall previous rejected route due to over maximum route limit	RANGE: [1 , 100] DEFAULT: 100
thresh	l3:MaxRtThresh (scalar:UByte)	Threshold percentage at which to generate a warning	RANGE: [1 , 100] DEFAULT: 100

Related Documentation

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

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

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

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

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

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

Deleting a Reinstall of a Previously Rejected Route Due to Over Max Route Limit

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

CLI Commands

vrf context VRF_1
address-family ipv4 unicast
no maximum routes 100 75 reinstall 84

Verifying a DME Configuration

MO	DN
topSystem	sys
l3Inst	sys/inst-VRF_1
rtctrlDom	sys/inst-VRF_1/dom-VRF_1
rtctrlDomAf	sys/inst-VRF_1/dom-VRF_1/af-ipv4-ucast
l3MaxRoutes	sys/inst-VRF_1/dom-VRF_1/af-ipv4-ucast/maxrts

l3Inst Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The Layer 3 instance name.	RANGE: Min: "1" Max: "128"

rtctrlDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The name of the object.

rtctrlDomAf Properties

Property Name	Data Type	Description	Values
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 1 - ipv4-ucast 2 - ipv4-mcast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 11 - ipv6-lucast 12 - lnkstate 13 - ipv4-mvpn 14 - ipv6-mvpn 15 - l2vpn-vpls 16 - ipv4-mdt DEFAULT: ipv4-ucast

l3MaxRoutes Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

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

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 Warning Message if Limit is Exceeded

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

CLI Commands

vrf context VRF_1
address-family ipv4 unicast
maximum routes 100 warning-only

Verifying a DME Configuration

MO	DN
topSystem	sys
l3Inst	sys/inst-VRF_1
rtctrlDom	sys/inst-VRF_1/dom-VRF_1
rtctrlDomAf	sys/inst-VRF_1/dom-VRF_1/af-ipv4-ucast
l3MaxRoutes	sys/inst-VRF_1/dom-VRF_1/af-ipv4-ucast/maxrts

l3Inst Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The Layer 3 instance name.	RANGE: Min: "1" Max: "128"

rtctrlDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The name of the object.

rtctrlDomAf Properties

Property Name	Data Type	Description	Values
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 1 - ipv4-ucast 2 - ipv4-mcast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 11 - ipv6-lucast 12 - lnkstate 13 - ipv4-mvpn 14 - ipv6-mvpn 15 - l2vpn-vpls 16 - ipv4-mdt DEFAULT: ipv4-ucast

l3MaxRoutes Properties

Property Name	Data Type	Description	Values
action	l3:MaxRtAct (scalar:Enum8)	Action to do when warning message limit is exceeded	SELECTION: 1 - log 2 - shut 3 - reinstall DEFAULT: shut
maxRt	l3:MaxLmt (scalar:Uint32)	Maximum number of routes allowed	RANGE: [0 , 4294967295] Default: 0
reinstall	l3:MaxRtThresh (scalar:UByte)	Reinstall previous rejected route due to over maximum route limit	RANGE: [1 , 100] DEFAULT: 100
thresh	l3:MaxRtThresh (scalar:UByte)	Threshold percentage at which to generate a warning	RANGE: [1 , 100] DEFAULT: 100

Related Documentation

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

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

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

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

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

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

Deleting a Warning Message if Limit is Exceeded

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

CLI Commands

vrf context VRF_1
address-family ipv4 unicast
no maximum routes 100 warning-only

Verifying a DME Configuration

MO	DN
topSystem	sys
l3Inst	sys/inst-VRF_1
rtctrlDom	sys/inst-VRF_1/dom-VRF_1
rtctrlDomAf	sys/inst-VRF_1/dom-VRF_1/af-ipv4-ucast
l3MaxRoutes	sys/inst-VRF_1/dom-VRF_1/af-ipv4-ucast/maxrts

l3Inst Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The Layer 3 instance name.	RANGE: Min: "1" Max: "128"

rtctrlDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The name of the object.

rtctrlDomAf Properties

Property Name	Data Type	Description	Values
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 1 - ipv4-ucast 2 - ipv4-mcast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 11 - ipv6-lucast 12 - lnkstate 13 - ipv4-mvpn 14 - ipv6-mvpn 15 - l2vpn-vpls 16 - ipv4-mdt DEFAULT: ipv4-ucast

l3MaxRoutes Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

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

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