Cisco Nexus 3000 and 9000 Series NX-API REST SDK API, Release 9.3(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring the Gateway IP for Type 5 EVPN Routes

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
  "rpmEntity": {
    "children": [
      {
        "rtmapRule": {
          "attributes": {
            "name": "Map_1"
          },
          "children": [
            {
              "rtmapEntry": {
                "attributes": {
                  "action": "permit",
                  "order": "10"
                },
                "children": [
                  {
                    "rtmapSetEvpn": {
                      "attributes": {
                        "ip": "1.2.3.4"
}}}]}}]}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <rpm-items>
    <rtmap-items>
      <Rule-list>
        <name>Map_1</name>
        <ent-items>
          <Entry-list>
            <order>10</order>
            <action>permit</action>
            <sevpn-items>
              <ip>1.2.3.4</ip>
            </sevpn-items>
          </Entry-list>
        </ent-items>
      </Rule-list>
    </rtmap-items>
  </rpm-items>
</System>

VNF Multipath Enhancements (Proportional VNF) Some parts are CIA-OUT)

For more information, see the Cisco Nexus 9000 Series NX-OS VXLAN Configuration Guide:

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

Configuring the Gateway IP for Type 5 EVPN Routes

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

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.

route-map Map_1
set evpn gateway-ip 1.2.3.4

Verifying a DME Configuration

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

MO	DN
rpmEntity	sys/rpm
rtmapRule	sys/rpm/rtmap-[Map_1]
rtmapEntry	sys/rpm/rtmap-[Map_1]/ent-10
rtmapSetEvpn	sys/rpm/rtmap-[Map_1]/ent-10/sevpn

rtmapRule Properties

The following table contains information about the rtmapRule 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	pol:ObjName (naming:Name256)	Object name	RANGE: [0 , 63]

rtmapEntry Properties

The following table contains information about the rtmapEntry 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	rtflt:Action (scalar:Enum8)	Action	SELECTION: 0 - deny 1 - permit DEFAULT: permit
order	rtflt:Order (scalar:Uint32)	Order	RANGE: [0 , 65535]

rtmapSetEvpn Properties

The following table contains information about the rtmapSetEvpn 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
ip	address:Ip	EVPN Gateway IP Address	Value 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

Deleting the Gateway IP for Type 5 EVPN Routes

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

CLI Commands

route-map Map_1
no set evpn gateway-ip 1.2.3.4

Verifying a DME Configuration

MO	DN
rpmEntity	sys/rpm
rtmapRule	sys/rpm/rtmap-[Map_1]
rtmapEntry	sys/rpm/rtmap-[Map_1]/ent-10
rtmapSetEvpn	sys/rpm/rtmap-[Map_1]/ent-10/sevpn

rtmapRule Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	RANGE: [0 , 63]

rtmapEntry Properties

Property Name	Data Type	Description	Values
action	rtflt:Action (scalar:Enum8)	Action	SELECTION: 0 - deny 1 - permit DEFAULT: permit
order	rtflt:Order (scalar:Uint32)	Order	RANGE: [0 , 65535]

rtmapSetEvpn 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

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 Nexthop Address as the Gateway IP

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

CLI Commands

route-map Map_1
set evpn gateway-ip use-nexthop

Verifying a DME Configuration

MO	DN
rpmEntity	sys/rpm
rtmapRule	sys/rpm/rtmap-[Map_1]
rtmapEntry	sys/rpm/rtmap-[Map_1]/ent-10
rtmapSetEvpn	sys/rpm/rtmap-[Map_1]/ent-10/sevpn

rtmapRule Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	RANGE: [0 , 63]

rtmapEntry Properties

Property Name	Data Type	Description	Values
action	rtflt:Action (scalar:Enum8)	Action	SELECTION: 0 - deny 1 - permit DEFAULT: permit
order	rtflt:Order (scalar:Uint32)	Order	RANGE: [0 , 65535]

rtmapSetEvpn Properties

Property Name	Data Type	Description	Values
gwType	rtmap:GatewayT (scalar:Enum8)	EVPN Gateway Address Type	SELECTION: 0 - ip-address 1 - nexthop DEFAULT: ip-address

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 Nexthop Address as the Gateway IP

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

CLI Commands

route-map Map_1
no set evpn gateway-ip use-nexthop

Verifying a DME Configuration

MO	DN
rpmEntity	sys/rpm
rtmapRule	sys/rpm/rtmap-[Map_1]
rtmapEntry	sys/rpm/rtmap-[Map_1]/ent-10
rtmapSetEvpn	sys/rpm/rtmap-[Map_1]/ent-10/sevpn

rtmapRule Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	RANGE: [0 , 63]

rtmapEntry Properties

Property Name	Data Type	Description	Values
action	rtflt:Action (scalar:Enum8)	Action	SELECTION: 0 - deny 1 - permit DEFAULT: permit
order	rtflt:Order (scalar:Uint32)	Order	RANGE: [0 , 65535]

rtmapSetEvpn 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

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 Multipath for Local Paths

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

CLI Commands

router bgp 100
  vrf VRF_1
   address-family ipv4 unicast
    maximum-paths local 53

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-VRF_1
bgpDomAf	sys/bgp/inst/dom-VRF_1/af-[ipv4-ucast]

bgpInst Properties

The following table contains information about the bgpInst 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
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

The following table contains information about the bgpDom 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.	MAX SIZE: 63

bgpDomAf Properties

The following table contains information about the bgpDomAf 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
maxLclEcmp	bgp:MaxEcmp (scalar:UByte)	Maximum number of equal-cost multipath for local paths	RANGE: [1 , 64] DEFAULT: 1
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 Multipath for Local Paths

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

CLI Commands

router bgp 100
  vrf VRF_1
   address-family ipv4 unicast
    no maximum-paths local 53

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-VRF_1
bgpDomAf	sys/bgp/inst/dom-VRF_1/af-[ipv4-ucast]

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpDomAf Properties

Property Name	Data Type	Description	Values
maxLclEcmp	bgp:MaxEcmp (scalar:UByte)	Maximum number of equal-cost multipath for local paths	RANGE: [1 , 64] DEFAULT: 1
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

Configuring Multipath for Local Paths

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

CLI Commands

router bgp 100
  vrf VRF_1
   address-family ipv6 unicast
    maximum-paths local 21

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-VRF_1
bgpDomAf	sys/bgp/inst/dom-VRF_1/af-[ipv6-ucast]

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpDomAf Properties

Property Name	Data Type	Description	Values
maxLclEcmp	bgp:MaxEcmp (scalar:UByte)	Maximum number of equal-cost multipath for local paths	RANGE: [1 , 64] DEFAULT: 1
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 Multipath for Local Paths

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

CLI Commands

router bgp 100
  vrf VRF_1
   address-family ipv6 unicast
    no maximum-paths local 21

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-VRF_1
bgpDomAf	sys/bgp/inst/dom-VRF_1/af-[ipv6-ucast]

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpDomAf Properties

Property Name	Data Type	Description	Values
maxLclEcmp	bgp:MaxEcmp (scalar:UByte)	Maximum number of equal-cost multipath for local paths	RANGE: [1 , 64] DEFAULT: 1
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

Configuring Multipath for Local Paths

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

CLI Commands

router bgp 100
  router bgp 100
   address-family l2vpn evpn
    maximum-paths local 30

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpDomAf	sys/bgp/inst/dom-default/af-[l2vpn-evpn]

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpDomAf Properties

Property Name	Data Type	Description	Values
maxLclEcmp	bgp:MaxEcmp (scalar:UByte)	Maximum number of equal-cost multipath for local paths	RANGE: [1 , 64] DEFAULT: 1
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 Multipath for Local Paths

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

CLI Commands

router bgp 100
  router bgp 100
   address-family l2vpn evpn
    no maximum-paths local 30

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpDomAf	sys/bgp/inst/dom-default/af-[l2vpn-evpn]

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpDomAf Properties

Property Name	Data Type	Description	Values
maxLclEcmp	bgp:MaxEcmp (scalar:UByte)	Maximum number of equal-cost multipath for local paths	RANGE: [1 , 64] DEFAULT: 1
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