Configuring an IPv6 Unicast Subaddress Family Under a VRF

Configuring the Label Allocation to All Routes

Configuring the Label Allocation to All Routes
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"
}}}]}}]}}]}}
{
    imdata:[]
}
<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>


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.

MODN
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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
allocLblAllbgp:AdminSt
(scalar:Enum8)
Allocate labels for all routesSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
allocLblRtMapstring:Basic
Allocate labels for selective routesA sequence of characters
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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

Deleting the Configuration of the Label Allocation Set to All Routes
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": "disabled",
                        "allocLblRtMap": "",
                        "type": "ipv6-ucast"
}}}]}}]}}]}}
{
    imdata:[]
}
<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>disabled</allocLblAll>
              <allocLblRtMap></allocLblRtMap>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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

MODN
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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
allocLblAllbgp:AdminSt
(scalar:Enum8)
Allocate labels for all routesSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
allocLblRtMapstring:Basic
Allocate labels for selective routesA sequence of characters
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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

Configuring the Label Allocation to a Route Map
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": "disabled",
                        "allocLblRtMap": "MAP1",
                        "type": "ipv6-ucast"
}}}]}}]}}]}}
{
    imdata:[]
}
<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>disabled</allocLblAll>
              <allocLblRtMap>MAP1</allocLblRtMap>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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 route-map MAP1

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


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

MODN
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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
allocLblAllbgp:AdminSt
(scalar:Enum8)
Allocate labels for all routesSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
allocLblRtMapstring:Basic
Allocate labels for selective routesA sequence of characters
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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

Deleting the Configuration of the Label Allocation Set to a Route Map
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": "disabled",
                        "allocLblRtMap": "",
                        "type": "ipv6-ucast"
}}}]}}]}}]}}
{
    imdata:[]
}
<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>disabled</allocLblAll>
              <allocLblRtMap></allocLblRtMap>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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
  no allocate-label route-map MAP1

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


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

MODN
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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
allocLblAllbgp:AdminSt
(scalar:Enum8)
Allocate labels for all routesSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
allocLblRtMapstring:Basic
Allocate labels for selective routesA sequence of characters
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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

Configuring Additional Paths to Install the Backup Path
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "123"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "VRF_1"
                },
                "children": [
                  {
                    "bgpDomAf": {
                      "attributes": {
                        "type": "ipv6-ucast"
                      },
                      "children": [
                        {
                          "bgpAddlPath": {
                            "attributes": {
                              "capability": "install-bkup"
}}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>VRF_1</name>
          <af-items>
            <DomAf-list>
              <type>ipv6-ucast</type>
              <addlpath-items>
                <capability>install-bkup</capability>
              </addlpath-items>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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
  additional-paths install backup

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


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

MODN
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

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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 NameData TypeDescriptionValues
capabilitybgp:AddlPathCapT
(scalar:Bitmask8)
Additional paths capabilitySELECTION:
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

Deleting the Configuration of Additional Paths Set to Install the Backup Path
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "123"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "VRF_1"
                },
                "children": [
                  {
                    "bgpDomAf": {
                      "attributes": {
                        "type": "ipv6-ucast"
                      },
                      "children": [
                        {
                          "bgpAddlPath": {
                            "attributes": {
                              "capability": ""
}}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>VRF_1</name>
          <af-items>
            <DomAf-list>
              <type>ipv6-ucast</type>
              <addlpath-items>
                <capability></capability>
              </addlpath-items>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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
  no additional-paths install backup

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


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

MODN
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

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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 NameData TypeDescriptionValues
capabilitybgp:AddlPathCapT
(scalar:Bitmask8)
Additional paths capabilitySELECTION:
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

Delaying Initial Bestpath Until Redistribution IGPs Have Converged
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "VRF_1"
                },
                "children": [
                  {
                    "bgpDomAf": {
                      "attributes": {
                        "type": "ipv6-ucast",
                        "waitIgpConv": "enabled"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>VRF_1</name>
          <af-items>
            <DomAf-list>
              <type>ipv6-ucast</type>
              <waitIgpConv>enabled</waitIgpConv>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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


CLI Commands

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

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.

MODN
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

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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
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

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 NameData TypeDescriptionValues
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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
waitIgpConvbgp:AdminSt
(scalar:Enum8)
Delay initial bestpath until redistributed IGPs have convergedSELECTION:
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

Deleting the Configuration for Delaying Initial Bestpath Until Redistribution IGPs Have Converged
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "VRF_1"
                },
                "children": [
                  {
                    "bgpDomAf": {
                      "attributes": {
                        "type": "ipv6-ucast",
                        "waitIgpConv": "disabled"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>VRF_1</name>
          <af-items>
            <DomAf-list>
              <type>ipv6-ucast</type>
              <waitIgpConv>disabled</waitIgpConv>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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


CLI Commands

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

router bgp 100
 vrf VRF_1
  address-family ipv6 unicast
  no 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.

MODN
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

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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
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

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 NameData TypeDescriptionValues
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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
waitIgpConvbgp:AdminSt
(scalar:Enum8)
Delay initial bestpath until redistributed IGPs have convergedSELECTION:
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

Configuring VRF Export to Allow Re-Importation of VPN Imported Routes
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": "ipv6-ucast"
                      },
                      "children": [
                        {
                          "rtctrlAfCtrl": {
                            "attributes": {
                              "type": "ipv6-ucast"
                            },
                            "children": [
                              {
                                "rtctrlRttP": {
                                  "attributes": {
                                    "type": "export"
                                  },
                                  "children": [
                                    {
                                      "rtctrlDomNonDefP": {
                                        "attributes": {
                                          "allowVpn": "yes"
}}}]}}]}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <inst-items>
    <Inst-list>
      <name>VRF_1</name>
      <dom-items>
        <Dom-list>
          <name>VRF_1</name>
          <af-items>
            <DomAf-list>
              <type>ipv6-ucast</type>
              <ctrl-items>
                <AfCtrl-list>
                  <type>ipv6-ucast</type>
                  <rttp-items>
                    <RttP-list>
                      <type>export</type>
                      <rtctrlnondef-items>
                        <allowVpn>true</allowVpn>
                      </rtctrlnondef-items>
                    </RttP-list>
                  </rttp-items>
                </AfCtrl-list>
              </ctrl-items>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </Inst-list>
  </inst-items>
</System>

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


CLI Commands

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

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


Verifying a DME Configuration

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

MODN
topSystem sys
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 NameData TypeDescriptionValues
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 NameData TypeDescriptionValues
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 NameData TypeDescriptionValues
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 NameData TypeDescriptionValues
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 NameData TypeDescriptionValues
typertctrl:RttPType
(scalar:Enum8)
TypeSELECTION:
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 NameData TypeDescriptionValues
allowVpnscalar:Bool
Allow VPN to be considered for route leakingSELECTION: 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

Deleting VRF Export to Allow Re-Importation of VPN Imported Routes
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": "ipv6-ucast"
                      },
                      "children": [
                        {
                          "rtctrlAfCtrl": {
                            "attributes": {
                              "type": "ipv6-ucast"
                            },
                            "children": [
                              {
                                "rtctrlRttP": {
                                  "attributes": {
                                    "type": "export"
                                  },
                                  "children": [
                                    {
                                      "rtctrlDomNonDefP": {
                                        "attributes": {
                                          "allowVpn": "no"
}}}]}}]}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <inst-items>
    <Inst-list>
      <name>VRF_1</name>
      <dom-items>
        <Dom-list>
          <name>VRF_1</name>
          <af-items>
            <DomAf-list>
              <type>ipv6-ucast</type>
              <ctrl-items>
                <AfCtrl-list>
                  <type>ipv6-ucast</type>
                  <rttp-items>
                    <RttP-list>
                      <type>export</type>
                      <rtctrlnondef-items>
                        <allowVpn>false</allowVpn>
                      </rtctrlnondef-items>
                    </RttP-list>
                  </rttp-items>
                </AfCtrl-list>
              </ctrl-items>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </Inst-list>
  </inst-items>
</System>

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


CLI Commands

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

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


Verifying a DME Configuration

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

MODN
topSystem sys
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 NameData TypeDescriptionValues
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 NameData TypeDescriptionValues
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 NameData TypeDescriptionValues
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 NameData TypeDescriptionValues
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 NameData TypeDescriptionValues
typertctrl:RttPType
(scalar:Enum8)
TypeSELECTION:
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 NameData TypeDescriptionValues
allowVpnscalar:Bool
Allow VPN to be considered for route leakingSELECTION: 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

Configuring VRF Import to Allow Leaked Routes to be Advertised to VPN
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": "ipv6-ucast"
                      },
                      "children": [
                        {
                          "rtctrlAfCtrl": {
                            "attributes": {
                              "type": "ipv6-ucast"
                            },
                            "children": [
                              {
                                "rtctrlRttP": {
                                  "attributes": {
                                    "type": "import"
                                  },
                                  "children": [
                                    {
                                      "rtctrlDomNonDefP": {
                                        "attributes": {
                                          "advtVpn": "yes"
}}}]}}]}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <inst-items>
    <Inst-list>
      <name>VRF_1</name>
      <dom-items>
        <Dom-list>
          <name>VRF_1</name>
          <af-items>
            <DomAf-list>
              <type>ipv6-ucast</type>
              <ctrl-items>
                <AfCtrl-list>
                  <type>ipv6-ucast</type>
                  <rttp-items>
                    <RttP-list>
                      <type>import</type>
                      <rtctrlnondef-items>
                        <advtVpn>true</advtVpn>
                      </rtctrlnondef-items>
                    </RttP-list>
                  </rttp-items>
                </AfCtrl-list>
              </ctrl-items>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </Inst-list>
  </inst-items>
</System>

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


CLI Commands

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

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


Verifying a DME Configuration

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

MODN
topSystem sys
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

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 NameData TypeDescriptionValues
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 NameData TypeDescriptionValues
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 NameData TypeDescriptionValues
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 NameData TypeDescriptionValues
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 NameData TypeDescriptionValues
typertctrl:RttPType
(scalar:Enum8)
TypeSELECTION:
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 NameData TypeDescriptionValues
advtVpnscalar:Bool
Allow leaked routes to be advertised to VPNSELECTION: 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

Deleting VRF Import to Allow Leaked Routes to be Advertised to VPN
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": "ipv6-ucast"
                      },
                      "children": [
                        {
                          "rtctrlAfCtrl": {
                            "attributes": {
                              "type": "ipv6-ucast"
                            },
                            "children": [
                              {
                                "rtctrlRttP": {
                                  "attributes": {
                                    "type": "import"
                                  },
                                  "children": [
                                    {
                                      "rtctrlDomNonDefP": {
                                        "attributes": {
                                          "advtVpn": "no"
}}}]}}]}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <inst-items>
    <Inst-list>
      <name>VRF_1</name>
      <dom-items>
        <Dom-list>
          <name>VRF_1</name>
          <af-items>
            <DomAf-list>
              <type>ipv6-ucast</type>
              <ctrl-items>
                <AfCtrl-list>
                  <type>ipv6-ucast</type>
                  <rttp-items>
                    <RttP-list>
                      <type>import</type>
                      <rtctrlnondef-items>
                        <advtVpn>false</advtVpn>
                      </rtctrlnondef-items>
                    </RttP-list>
                  </rttp-items>
                </AfCtrl-list>
              </ctrl-items>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </Inst-list>
  </inst-items>
</System>

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


CLI Commands

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

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


Verifying a DME Configuration

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

MODN
topSystem sys
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

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 NameData TypeDescriptionValues
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 NameData TypeDescriptionValues
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 NameData TypeDescriptionValues
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 NameData TypeDescriptionValues
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 NameData TypeDescriptionValues
typertctrl:RttPType
(scalar:Enum8)
TypeSELECTION:
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 NameData TypeDescriptionValues
advtVpnscalar:Bool
Allow leaked routes to be advertised to VPNSELECTION: 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

Configuring VRF Import to Allow Leaked Routes to be Advertised to VPN
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": "ipv6-ucast"
                      },
                      "children": [
                        {
                          "rtctrlAfCtrl": {
                            "attributes": {
                              "type": "ipv6-ucast"
                            },
                            "children": [
                              {
                                "rtctrlRttP": {
                                  "attributes": {
                                    "type": "import"
                                  },
                                  "children": [
                                    {
                                      "rtctrlDomDefMapP": {
                                        "attributes": {
                                          "advtVpn": "yes",
                                          "pfxLimit": "1717449998",
                                          "rtMap": "SampleString_123"
}}}]}}]}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <inst-items>
    <Inst-list>
      <name>VRF_1</name>
      <dom-items>
        <Dom-list>
          <name>VRF_1</name>
          <af-items>
            <DomAf-list>
              <type>ipv6-ucast</type>
              <ctrl-items>
                <AfCtrl-list>
                  <type>ipv6-ucast</type>
                  <rttp-items>
                    <RttP-list>
                      <type>import</type>
                      <rtctrldefmap-items>
                        <advtVpn>true</advtVpn>
                        <pfxLimit>1717449998</pfxLimit>
                        <rtMap>SampleString_123</rtMap>
                      </rtctrldefmap-items>
                    </RttP-list>
                  </rttp-items>
                </AfCtrl-list>
              </ctrl-items>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </Inst-list>
  </inst-items>
</System>

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


CLI Commands

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

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


Verifying a DME Configuration

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

MODN
topSystem sys
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

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 NameData TypeDescriptionValues
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 NameData TypeDescriptionValues
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 NameData TypeDescriptionValues
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 NameData TypeDescriptionValues
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 NameData TypeDescriptionValues
typertctrl:RttPType
(scalar:Enum8)
TypeSELECTION:
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 NameData TypeDescriptionValues
advtVpnscalar:Bool
Allow leaked routes to be advertised to VPNSELECTION: true or false
pfxLimitscalar:Uint32
Default Vrf Prefix Limit
RANGE: [0 , 2147483647]
DEFAULT: 0
rtMapstring:Basic
Route MapA 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

Deleting VRF Import to Allow Leaked Routes to be Advertised to VPN
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": "ipv6-ucast"
                      },
                      "children": [
                        {
                          "rtctrlAfCtrl": {
                            "attributes": {
                              "type": "ipv6-ucast"
                            },
                            "children": [
                              {
                                "rtctrlRttP": {
                                  "attributes": {
                                    "type": "import"
                                  },
                                  "children": [
                                    {
                                      "rtctrlDomDefMapP": {
                                        "attributes": {
                                          "status": "deleted"
}}}]}}]}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <inst-items>
    <Inst-list>
      <name>VRF_1</name>
      <dom-items>
        <Dom-list>
          <name>VRF_1</name>
          <af-items>
            <DomAf-list>
              <type>ipv6-ucast</type>
              <ctrl-items>
                <AfCtrl-list>
                  <type>ipv6-ucast</type>
                  <rttp-items>
                    <RttP-list>
                      <type>import</type>
                      <rtctrldefmap-items nc:operation="delete">
                      </rtctrldefmap-items>
                    </RttP-list>
                  </rttp-items>
                </AfCtrl-list>
              </ctrl-items>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </Inst-list>
  </inst-items>
</System>

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


CLI Commands

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

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


Verifying a DME Configuration

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

MODN
topSystem sys
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

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 NameData TypeDescriptionValues
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 NameData TypeDescriptionValues
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 NameData TypeDescriptionValues
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 NameData TypeDescriptionValues
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 NameData TypeDescriptionValues
typertctrl:RttPType
(scalar:Enum8)
TypeSELECTION:
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 NameData TypeDescriptionValues
statusmo:ModificationStatus
(scalar:Bitmask32)
Modification statusSELECTION:
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