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 the Label Allocation to All Routes

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "123"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "VRF_1"
                },
                "children": [
                  {
                    "bgpDomAf": {
                      "attributes": {
                        "allocLblAll": "enabled",
                        "allocLblRtMap": "",
                        "type": "ipv6-ucast"
}}}]}}]}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>VRF_1</name>
          <af-items>
            <DomAf-list>
              <type>ipv6-ucast</type>
              <allocLblAll>enabled</allocLblAll>
              <allocLblRtMap></allocLblRtMap>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Configuring an IPv6 Unicast Subaddress Family Under a VRF

Configuring the Label Allocation to All Routes

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.

router bgp 123
vrf VRF_1
address-family ipv6 unicast
allocate-label all

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.

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpDomAf	sys/bgp/inst/dom-{name}/af-{[type]}

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
allocLblAll	bgp:AdminSt (scalar:Enum8)	Allocate labels for all routes	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
allocLblRtMap	string:Basic	Allocate labels for selective routes	A sequence of characters
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 Configuration of the Label Allocation Set to All Routes

CLI Commands

router bgp 123
vrf VRF_1
address-family ipv6 unicast
no allocate-label all

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

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpDomAf	sys/bgp/inst/dom-{name}/af-{[type]}

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
allocLblAll	bgp:AdminSt (scalar:Enum8)	Allocate labels for all routes	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
allocLblRtMap	string:Basic	Allocate labels for selective routes	A sequence of characters
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 the Label Allocation to a Route Map

CLI Commands

router bgp 123
vrf VRF_1
address-family ipv6 unicast
allocate-label route-map MAP1

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

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpDomAf	sys/bgp/inst/dom-{name}/af-{[type]}

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
allocLblAll	bgp:AdminSt (scalar:Enum8)	Allocate labels for all routes	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
allocLblRtMap	string:Basic	Allocate labels for selective routes	A sequence of characters
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 Configuration of the Label Allocation Set to a Route Map

CLI Commands

router bgp 123
vrf VRF_1
address-family ipv6 unicast
no allocate-label route-map MAP1

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

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpDomAf	sys/bgp/inst/dom-{name}/af-{[type]}

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
allocLblAll	bgp:AdminSt (scalar:Enum8)	Allocate labels for all routes	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
allocLblRtMap	string:Basic	Allocate labels for selective routes	A sequence of characters
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 Additional Paths to Install the Backup Path

CLI Commands

router bgp 123
vrf VRF_1
address-family ipv6 unicast
additional-paths install backup

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

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpDomAf	sys/bgp/inst/dom-{name}/af-{[type]}
bgpAddlPath	sys/bgp/inst/dom-{name}/af-{[type]}/addlpath

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

bgpAddlPath Properties

The following table contains information about the bgpAddlPath 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
capability	bgp:AddlPathCapT (scalar:Bitmask8)	Additional paths capability	SELECTION: 1 - send 2 - receive 4 - install-bkup

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 Configuration of Additional Paths Set to Install the Backup Path

CLI Commands

router bgp 123
vrf VRF_1
address-family ipv6 unicast
no additional-paths install backup

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

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpDomAf	sys/bgp/inst/dom-{name}/af-{[type]}
bgpAddlPath	sys/bgp/inst/dom-{name}/af-{[type]}/addlpath

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

bgpAddlPath Properties

Property Name	Data Type	Description	Values
capability	bgp:AddlPathCapT (scalar:Bitmask8)	Additional paths capability	SELECTION: 1 - send 2 - receive 4 - install-bkup

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

Delaying Initial Bestpath Until Redistribution IGPs Have Converged

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

CLI Commands

router bgp 100
vrf VRF_1
address-family ipv6 unicast
wait-igp-convergence

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
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 BGP Domain name. This name can be up to 64 alphanumeric characters. Note that you cannot change this name after the object has been saved.

bgpDomAf 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
waitIgpConv	bgp:AdminSt (scalar:Enum8)	Delay initial bestpath until redistributed IGPs have converged	SELECTION: 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

Deleting the Configuration for Delaying Initial Bestpath Until Redistribution IGPs Have Converged

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

CLI Commands

router bgp 100
vrf VRF_1
address-family ipv6 unicast
no wait-igp-convergence

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 BGP Domain name. This name can be up to 64 alphanumeric characters. Note that you cannot change this name after the object has been saved.

bgpDomAf 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
waitIgpConv	bgp:AdminSt (scalar:Enum8)	Delay initial bestpath until redistributed IGPs have converged	SELECTION: 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

Configuring VRF Export to Allow Re-Importation of VPN Imported Routes

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

CLI Commands

vrf context VRF_1
address-family ipv6 unicast
export vrf allow-vpn

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-ipv6-ucast
rtctrlAfCtrl	sys/inst-VRF_1/dom-VRF_1/af-ipv6-ucast/ctrl-ipv6-ucast
rtctrlRttP	sys/inst-VRF_1/dom-VRF_1/af-ipv6-ucast/ctrl-ipv6-ucast/rttp-export
rtctrlDomNonDefP	sys/inst-VRF_1/dom-VRF_1/af-ipv6-ucast/ctrl-ipv6-ucast/rttp-export/rtctrlnondef

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

rtctrlAfCtrl Properties

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

rtctrlRttP Properties

The following table contains information about the rtctrlRttP 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	rtctrl:RttPType (scalar:Enum8)	Type	SELECTION: 1 - import 2 - export DEFAULT: import

rtctrlDomNonDefP Properties

The following table contains information about the rtctrlDomNonDefP 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
allowVpn	scalar:Bool	Allow VPN to be considered for route leaking	SELECTION: true or false

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 VRF Export to Allow Re-Importation of VPN Imported Routes

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

CLI Commands

vrf context VRF_1
address-family ipv6 unicast
no export vrf allow-vpn

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-ipv6-ucast
rtctrlAfCtrl	sys/inst-VRF_1/dom-VRF_1/af-ipv6-ucast/ctrl-ipv6-ucast
rtctrlRttP	sys/inst-VRF_1/dom-VRF_1/af-ipv6-ucast/ctrl-ipv6-ucast/rttp-export
rtctrlDomNonDefP	sys/inst-VRF_1/dom-VRF_1/af-ipv6-ucast/ctrl-ipv6-ucast/rttp-export/rtctrlnondef

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

rtctrlAfCtrl 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

rtctrlRttP Properties

Property Name	Data Type	Description	Values
type	rtctrl:RttPType (scalar:Enum8)	Type	SELECTION: 1 - import 2 - export DEFAULT: import

rtctrlDomNonDefP Properties

Property Name	Data Type	Description	Values
allowVpn	scalar:Bool	Allow VPN to be considered for route leaking	SELECTION: true or false

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 VRF Import to Allow Leaked Routes to be Advertised to VPN

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

CLI Commands

vrf context VRF_1
address-family ipv6 unicast
import vrf advertise-vpn

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-ipv6-ucast
rtctrlAfCtrl	sys/inst-VRF_1/dom-VRF_1/af-ipv6-ucast/ctrl-ipv6-ucast
rtctrlRttP	sys/inst-VRF_1/dom-VRF_1/af-ipv6-ucast/ctrl-ipv6-ucast/rttp-import
rtctrlDomNonDefP	sys/inst-VRF_1/dom-VRF_1/af-ipv6-ucast/ctrl-ipv6-ucast/rttp-import/rtctrlnondef

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

rtctrlAfCtrl 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

rtctrlRttP Properties

Property Name	Data Type	Description	Values
type	rtctrl:RttPType (scalar:Enum8)	Type	SELECTION: 1 - import 2 - export DEFAULT: import

rtctrlDomNonDefP Properties

Property Name	Data Type	Description	Values
advtVpn	scalar:Bool	Allow leaked routes to be advertised to VPN	SELECTION: true or false

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 VRF Import to Allow Leaked Routes to be Advertised to VPN

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

CLI Commands

vrf context VRF_1
address-family ipv6 unicast
no import vrf advertise-vpn

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-ipv6-ucast
rtctrlAfCtrl	sys/inst-VRF_1/dom-VRF_1/af-ipv6-ucast/ctrl-ipv6-ucast
rtctrlRttP	sys/inst-VRF_1/dom-VRF_1/af-ipv6-ucast/ctrl-ipv6-ucast/rttp-import
rtctrlDomNonDefP	sys/inst-VRF_1/dom-VRF_1/af-ipv6-ucast/ctrl-ipv6-ucast/rttp-import/rtctrlnondef

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

rtctrlAfCtrl 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

rtctrlRttP Properties

Property Name	Data Type	Description	Values
type	rtctrl:RttPType (scalar:Enum8)	Type	SELECTION: 1 - import 2 - export DEFAULT: import

rtctrlDomNonDefP Properties

Property Name	Data Type	Description	Values
advtVpn	scalar:Bool	Allow leaked routes to be advertised to VPN	SELECTION: true or false

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 VRF Import to Allow Leaked Routes to be Advertised to VPN

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

CLI Commands

vrf context VRF_1
address-family ipv6 unicast
import vrf default 1717449998 map SampleString_123 advertise-vpn

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-ipv6-ucast
rtctrlAfCtrl	sys/inst-VRF_1/dom-VRF_1/af-ipv6-ucast/ctrl-ipv6-ucast
rtctrlRttP	sys/inst-VRF_1/dom-VRF_1/af-ipv6-ucast/ctrl-ipv6-ucast/rttp-import
rtctrlDomDefMapP	sys/inst-VRF_1/dom-VRF_1/af-ipv6-ucast/ctrl-ipv6-ucast/rttp-import/rtctrldefmap

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

rtctrlAfCtrl 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

rtctrlRttP Properties

Property Name	Data Type	Description	Values
type	rtctrl:RttPType (scalar:Enum8)	Type	SELECTION: 1 - import 2 - export DEFAULT: import

rtctrlDomDefMapP Properties

The following table contains information about the rtctrlDomDefMapP 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
advtVpn	scalar:Bool	Allow leaked routes to be advertised to VPN	SELECTION: true or false
pfxLimit	scalar:Uint32	Default Vrf Prefix Limit	RANGE: [0 , 2147483647] DEFAULT: 0
rtMap	string:Basic	Route Map	A sequence of characters

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 VRF Import to Allow Leaked Routes to be Advertised to VPN

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

CLI Commands

vrf context VRF_1
address-family ipv6 unicast
no import vrf default 1717449998 map SampleString_123 advertise-vpn

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-ipv6-ucast
rtctrlAfCtrl	sys/inst-VRF_1/dom-VRF_1/af-ipv6-ucast/ctrl-ipv6-ucast
rtctrlRttP	sys/inst-VRF_1/dom-VRF_1/af-ipv6-ucast/ctrl-ipv6-ucast/rttp-import
rtctrlDomDefMapP	sys/inst-VRF_1/dom-VRF_1/af-ipv6-ucast/ctrl-ipv6-ucast/rttp-import/rtctrldefmap

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

rtctrlAfCtrl 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

rtctrlRttP Properties

Property Name	Data Type	Description	Values
type	rtctrl:RttPType (scalar:Enum8)	Type	SELECTION: 1 - import 2 - export DEFAULT: import

rtctrlDomDefMapP 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