Configuring an IPv4 Unicast Address Family

This section uses IPv4 unicast examples to demonstrate many of the BGP configuration options and to show how the REST APIs correspond to the CLI commands.

Enabling IPv4 Unicast Address Family

Configuring an IPv4 Unicast Address Family

POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json

{
 "bgpInst": {
   "attributes": {
     "asn": "100"
   },
   "children": [
     {
       "bgpDom": {
         "attributes": {
           "name": "default"
         },
         "children": [
           {
             "bgpDomAf": {
               "attributes": {
                 "type": "ipv4-ucast"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <af-items>
            <DomAf-list>
              <type>ipv4-ucast</type>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Places the router in address family configuration mode and specifies unicast address prefixes for the IPv4 address family.


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

router bgp 100
 address-family ipv4 unicast

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

Enabling an IPv4 Unicast and Multicast Address Families under the Default VRF

Enabling an IPv4 Address Family under the Default VRF

POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json


{
 "bgpInst": {
   "attributes": {
     "asn": "100"
   },
   "children": [
     {
       "bgpDom": {
         "attributes": {
           "name": "default"
         },
         "children": [
           {
             "bgpDomAf": {
               "attributes": {
                 "type": "ipv4-mcast"
               }
             }
           },
           {
             "bgpDomAf": {
               "attributes": {
                 "type": "ipv4-ucast"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <af-items>
            <DomAf-list>
              <type>ipv4-mcast</type>
            </DomAf-list>
            <DomAf-list>
              <type>ipv4-ucast</type>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

This section demonstrates how to enable an IPv4 address family unicast and multicast together.


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

router bgp 100
 address-family ipv4 unicast
 address-family ipv4 multicast

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 Forward Packets over Multipath Paths

Configuring Forward Packets over Multipath Paths

POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json

{
 "bgpInst": {
   "attributes": {
     "asn": "100"
   },
   "children": [
     {
       "bgpDom": {
         "attributes": {
           "name": "default"
         },
         "children": [
           {
             "bgpDomAf": {
               "attributes": {
                 "maxExtEcmp": "9",
                 "type": "ipv4-ucast"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <af-items>
            <DomAf-list>
              <type>ipv4-ucast</type>
              <maxExtEcmp>9</maxExtEcmp>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Forwards packets over multipath paths.

Note: This example was added in Release 7.0(3)I6(1).


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

router bgp 100
 address-family ipv4 unicast
  maximum-paths 9

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference: http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload: https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring Multipath for IBGP Paths

Configuring Multipath for IBGP Paths

POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json

{
 "bgpInst": {
   "attributes": {
     "asn": "100"
   },
   "children": [
     {
       "bgpDom": {
         "attributes": {
           "name": "default"
         },
         "children": [
           {
             "bgpDomAf": {
               "attributes": {
                 "maxEcmp": "10",
                 "type": "ipv4-ucast"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <af-items>
            <DomAf-list>
              <type>ipv4-ucast</type>
              <maxEcmp>10</maxEcmp>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Controls the maximum number of parallel iBGP routes that can be installed in a routing table.

Note: This example was added in Release 7.0(3)I6(1).


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

router bgp 100
 address-family ipv4 unicast
  maximum-paths ibgp 10

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

Configuring the Administrative Distance

POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json

{
 "bgpInst": {
   "attributes": {
     "asn": "100"
   },
   "children": [
     {
       "bgpDom": {
         "attributes": {
           "name": "default"
         },
         "children": [
           {
             "bgpDomAf": {
               "attributes": {
                 "type": "ipv4-ucast"
               },
               "children": [
                 {
                   "bgpAdminDist": {
                     "attributes": {
                       "eDist": "5",
                       "iDist": "8",
                       "localDist": "220"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <af-items>
            <DomAf-list>
              <type>ipv4-ucast</type>
              <adminDist-items>
                <eDist>5</eDist>
                <iDist>8</iDist>
                <localDist>220</localDist>
              </adminDist-items>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Configures administrative distance.

Note: This example was added in Release 7.0(3)I6(1).


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

router bgp 100
 address-family ipv4 unicast
  distance 5 8 220

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 Advertisement to only Active Routes to Peers

Configuring Advertisement to only Active Routes to Peers

POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json

{
 "bgpInst": {
   "attributes": {
     "asn": "100"
   },
   "children": [
     {
       "bgpDom": {
         "attributes": {
           "name": "default"
         },
         "children": [
           {
             "bgpDomAf": {
               "attributes": {
                 "supprInactive": "enabled",
                 "type": "ipv4-ucast"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <af-items>
            <DomAf-list>
              <type>ipv4-ucast</type>
              <supprInactive>enabled</supprInactive>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Suppresses the advertisement of routes that are not installed in the routing information base (RIB).

Note: This example was added in Release 7.0(3)I6(1).


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

router bgp 100
 address-family ipv4 unicast
  suppress-inactive

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

Enabling MPLS Encapsulation

Enabling MPLS Encapsulation

POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json

{
 "bgpInst": {
   "attributes": {
     "asn": "100"
   },
   "children": [
     {
       "bgpDom": {
         "attributes": {
           "name": "default"
         },
         "children": [
           {
             "bgpPeer": {
               "attributes": {
                 "addr": "1.2.3.4",
                 "inheritContPeerCtrl": ""
               },
               "children": [
                 {
                   "bgpPeerAf": {
                     "attributes": {
                       "encapMpls": "enabled",
                       "inheritContPeerPolicyCtrl": "",
                       "type": "l2vpn-evpn"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>l2vpn-evpn</type>
                  <encapMpls>enabled</encapMpls>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Sets the label allocation mode to per-VRF.


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

router bgp 100
 address-family ipv4 unicast
  label-allocation-mode per-vrf

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

Disabling Label-Allocation Mode

Disabling Label-Allocation Mode

POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json

{
 "bgpInst": {
   "attributes": {
     "asn": "100"
   },
   "children": [
     {
       "bgpDom": {
         "attributes": {
           "name": "default"
         },
         "children": [
           {
             "bgpDomAf": {
               "attributes": {
                 "lblAllocMod": "disabled",
                 "type": "ipv4-ucast"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <af-items>
            <DomAf-list>
              <type>ipv4-ucast</type>
              <lblAllocMod>disabled</lblAllocMod>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Configures the per-prefix label mode.


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

router bgp 100
 address-family ipv4 unicast
  no label-allocation-mode per-vrf

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 IPv4 Aggregate Addresses

Configuring IPv4 Aggregate Addresses

POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json

{
 "bgpInst": {
   "attributes": {
     "asn": "100"
   },
   "children": [
     {
       "bgpDom": {
         "attributes": {
           "name": "default"
         },
         "children": [
           {
             "bgpDomAf": {
               "attributes": {
                 "type": "ipv4-ucast"
               },
               "children": [
                 {
                   "bgpAggAddr": {
                     "attributes": {
                       "addr": "192.0.0.0/8",
                       "adverMap": "sample2",
                       "asSet": "enabled",
                       "attrMap": "sample1",
                       "summaryOnly": "disabled",
                       "supprMap": "sample3"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <af-items>
            <DomAf-list>
              <type>ipv4-ucast</type>
              <aggaddr-items>
                <AggAddr-list>
                  <addr>192.0.0.0/8</addr>
                  <adverMap></adverMap>
                  <asSet>enabled</asSet>
                  <attrMap></attrMap>
                  <summaryOnly>disabled</summaryOnly>
                  <supprMap></supprMap>
                </AggAddr-list>
              </aggaddr-items>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Creates an aggregate address. The path advertised for this route is an autonomous system set that consists of all elements contained in all paths that are being summarized:

  • The as-set keyword generates autonomous system set path information and community information from contributing paths.
  • The advertise-map keyword and argument specify the route map used to select attribute information from selected routes.
  • The attribute-map keyword and argument specify the route map used to select attribute information from the aggregate.
  • The suppress-map keyword and argument conditionally filter more specific routes.

CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

router bgp 100
 address-family ipv4 unicast
  aggregate-address 192.0.0.0/8 as-set advertise-map sample2 suppress-map sample3 attribute-map sample1

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 Redistribution of AM Routes

 Configuring the Redistribution of AM Routes

POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpDomAf": {
                "attributes": {
                  "type": "ipv4-ucast"
                },
                "children": [
                  {
                    "bgpInterLeakP": {
                      "attributes": {
                        "inst": "none",
                        "proto": "am",
                        "rtMap": "rtmap1"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <af-items>
            <DomAf-list>
              <type>ipv4-ucast</type>
              <interleak-items>
                <InterLeakP-list>
                  <proto>am</proto>
                  <inst>none</inst>
                  <rtMap>rtmap1</rtMap>
                </InterLeakP-list>
              </interleak-items>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Configures the redistribution of AM routes.

For configuring a route-map, Configuring a Route Map

Note: This example was added in Release 7.0(3)I7(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
 address-family ipv4 unicast
  redistribute am route-map rtmap1

Configuring a Route Map to Redistributed Routes

Configuring a Route Map to Redistributed Routes

POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpDomAf": {
                "attributes": {
                  "type": "ipv4-ucast"
                },
                "children": [
                  {
                    "bgpInterLeakP": {
                      "attributes": {
                        "inst": "none",
                        "proto": "direct",
                        "rtMap": "map1"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <af-items>
            <DomAf-list>
              <type>ipv4-ucast</type>
              <interleak-items>
                <InterLeakP-list>
                  <proto>direct</proto>
                  <inst>none</inst>
                  <rtMap>map1</rtMap>
                </InterLeakP-list>
              </interleak-items>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Configuring a route map to redistributed routes.

For configuring a route-map, Configuring a Route Map

Note: This example was added in Release 7.0(3)I7(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
 address-family ipv4 unicast
  redistribute direct route-map map1

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 Redistribution of EIGRP Routes with Attributes Applied from a Route Map

Configuring the Redistribution of EIGRP Routes with Attributes Applied from a Route Map

POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpDomAf": {
                "attributes": {
                  "type": "ipv4-ucast"
                },
                "children": [
                  {
                    "bgpInterLeakP": {
                      "attributes": {
                        "inst": "ProtTag1",
                        "proto": "eigrp",
                        "rtMap": "map1"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <af-items>
            <DomAf-list>
              <type>ipv4-ucast</type>
              <interleak-items>
                <InterLeakP-list>
                  <proto>eigrp</proto>
                  <inst>ProtTag1</inst>
                  <rtMap>map1</rtMap>
                </InterLeakP-list>
              </interleak-items>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Configuring the redistribution of EIGRP routes with attributes applied from a route map.

For configuring a route-map, Configuring a Route Map

Note: This example was added in Release 7.0(3)I7(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
 address-family ipv4 unicast
  redistribute eigrp ProtTag1 route-map map1

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 Redistribution of HMM Routes with Attributes Applied from a Route Map

Configuring the Redistribution of HMM Routes with Attributes Applied from a Route Map

POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpDomAf": {
                "attributes": {
                  "type": "ipv4-ucast"
                },
                "children": [
                  {
                    "bgpInterLeakP": {
                      "attributes": {
                        "inst": "none",
                        "proto": "hmm",
                        "rtMap": "map1"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <af-items>
            <DomAf-list>
              <type>ipv4-ucast</type>
              <interleak-items>
                <InterLeakP-list>
                  <proto>hmm</proto>
                  <inst>none</inst>
                  <rtMap>map1</rtMap>
                </InterLeakP-list>
              </interleak-items>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Configures the redistribution of HMM routes with attributes applied from a route map.

For configuring a route-map, Configuring a Route Map

Note: This example was added in Release 7.0(3)I7(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
 address-family ipv4 unicast
  redistribute hmm route-map map1

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 Redistribution of ISIS Routes with Attributes Applied from a Route Map

Configuring the Redistribution of ISIS Routes with Attributes Applied from a Route Map

POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpDomAf": {
                "attributes": {
                  "type": "ipv4-ucast"
                },
                "children": [
                  {
                    "bgpInterLeakP": {
                      "attributes": {
                        "inst": "ProtTag1",
                        "proto": "isis",
                        "rtMap": "map1"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <af-items>
            <DomAf-list>
              <type>ipv4-ucast</type>
              <interleak-items>
                <InterLeakP-list>
                  <proto>isis</proto>
                  <inst>ProtTag1</inst>
                  <rtMap>map1</rtMap>
                </InterLeakP-list>
              </interleak-items>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Configures the redistribution of ISIS routes with attributes applied from a route map.

For configuring a route-map, Configuring a Route Map

Note: This example was added in Release 7.0(3)I7(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
 address-family ipv4 unicast
  redistribute isis ProtTag1 route-map map1

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 Redistribution of LISP Routes with Attributes Applied from a Route Map

Configuring the Redistribution of LISP Routes with Attributes Applied from a Route Map

POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpDomAf": {
                "attributes": {
                  "type": "ipv4-ucast"
                },
                "children": [
                  {
                    "bgpInterLeakP": {
                      "attributes": {
                        "inst": "none",
                        "proto": "lisp",
                        "rtMap": "map1"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <af-items>
            <DomAf-list>
              <type>ipv4-ucast</type>
              <interleak-items>
                <InterLeakP-list>
                  <proto>lisp</proto>
                  <inst>none</inst>
                  <rtMap>map1</rtMap>
                </InterLeakP-list>
              </interleak-items>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Configures the redistribution of LISP routes with attributes applied from a route map.

For configuring a route-map, Configuring a Route Map

Note: This example was added in Release 7.0(3)I7(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
 address-family ipv4 unicast
  redistribute lisp route-map map1

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 Redistribution of OSPF Routes with Attributes Applied from a Route Map

Configuring the Redistribution of OSPF Routes with Attributes Applied from a Route Map

POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpDomAf": {
                "attributes": {
                  "type": "ipv4-ucast"
                },
                "children": [
                  {
                    "bgpInterLeakP": {
                      "attributes": {
                        "inst": "ProtTag1",
                        "proto": "ospf",
                        "rtMap": "map1"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <af-items>
            <DomAf-list>
              <type>ipv4-ucast</type>
              <interleak-items>
                <InterLeakP-list>
                  <proto>ospf</proto>
                  <inst>ProtTag1</inst>
                  <rtMap>map1</rtMap>
                </InterLeakP-list>
              </interleak-items>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Configures the redistribution of OSPF routes with attributes applied from a route map.

For configuring a route-map, Configuring a Route Map

Note: This example was added in Release 7.0(3)I7(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
 address-family ipv4 unicast
  redistribute ospf ProtTag1 route-map map1

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 Redistribution of RIP Routes with Attributes Applied from a Route Map

Configuring the Redistribution of RIP Routes with Attributes Applied from a Route Map

POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpDomAf": {
                "attributes": {
                  "type": "ipv4-ucast"
                },
                "children": [
                  {
                    "bgpInterLeakP": {
                      "attributes": {
                        "inst": "ProtTag1",
                        "proto": "rip",
                        "rtMap": "map1"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <af-items>
            <DomAf-list>
              <type>ipv4-ucast</type>
              <interleak-items>
                <InterLeakP-list>
                  <proto>rip</proto>
                  <inst>ProtTag1</inst>
                  <rtMap>map1</rtMap>
                </InterLeakP-list>
              </interleak-items>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Configures the redistribution of RIP routes with attributes applied from a route map.

For configuring a route-map, Configuring a Route Map

Note: This example was added in Release 7.0(3)I7(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
 address-family ipv4 unicast
  redistribute rip ProtTag1 route-map map1

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 Redistribution of Static Routes with Attributes Applied from a Route Map

Configuring the Redistribution of Static Routes with Attributes Applied from a Route Map

POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpDomAf": {
                "attributes": {
                  "type": "ipv4-ucast"
                },
                "children": [
                  {
                    "bgpInterLeakP": {
                      "attributes": {
                        "inst": "none",
                        "proto": "static",
                        "rtMap": "map1"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <af-items>
            <DomAf-list>
              <type>ipv4-ucast</type>
              <interleak-items>
                <InterLeakP-list>
                  <proto>static</proto>
                  <inst>none</inst>
                  <rtMap>map1</rtMap>
                </InterLeakP-list>
              </interleak-items>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Configures the redistribution of Static routes with attributes applied from a route map. For configuring a route-map, Configuring a Route Map

Note: This example was added in Release 7.0(3)I7(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
 address-family ipv4 unicast
  redistribute static route-map map1

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

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 with Install Backup Path

Configuring Additional Paths with Install Backup Path

POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpDomAf": {
                "attributes": {
                  "type": "ipv4-ucast"
                },
                "children": [
                  {
                    "bgpAddlPath": {
                      "attributes": {
                        "capability": "install-bkup"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <af-items>
            <DomAf-list>
              <type>ipv4-ucast</type>
              <addlpath-items>
                <capability>install-bkup</capability>
              </addlpath-items>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Note: This example was added in Release 7.0(3)I7(2).


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
  address-family ipv4 unicast
    additional-paths install backup

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 Additional Paths Configured with Install Backup Path

Deleting Additional Paths Configured with Install Backup Path

POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpDomAf": {
                "attributes": {
                  "type": "ipv4-ucast"
                },
                "children": [
                  {
                    "bgpAddlPath": {
                      "attributes": {
                        "capability": ""
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <af-items>
            <DomAf-list>
              <type>ipv4-ucast</type>
              <addlpath-items>
                <capability></capability>
              </addlpath-items>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Note: This example was added in Release 7.0(3)I7(2).


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
  address-family ipv4 unicast
    no additional-paths install backup

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

Applying a Route Map to a Network Prefix

Applying a Route Map to a Network Prefix

POST http://<mgmt0_IP>/api/mo/sys/bgp.json

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "123"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpDomAf": {
                      "attributes": {
                        "type": "ipv4-ucast"
                      },
                      "children": [
                        {
                          "bgpAdvPrefix": {
                            "attributes": {
                              "addr": "0.0.0.0/2",
                              "rtMap": "Map_1"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <af-items>
            <DomAf-list>
              <type>ipv4-ucast</type>
              <prefix-items>
                <AdvPrefix-list>
                  <addr>0.0.0.0/2</addr>
                  <rtMap>Map_1</rtMap>
                </AdvPrefix-list>
              </prefix-items>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

For configuring a route-map, Configuring a Route Map

Note: This example was added in Release 7.0(3)I7(2).


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
 address-family ipv4 unicast
  network 1.2.3.4/2 route-map Map_1

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/media/dme/index.html

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

Applying an AS-PATH Filter List to Incoming Routes

Applying an AS-PATH Filter List to Incoming Routes

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "rpmEntity": {
          "children": [
            {
              "rtlistRule": {
                "attributes": {
                  "name": "List_A"
                },
                "children": [
                  {
                    "rtlistEntry": {
                      "attributes": {
                        "action": "permit",
                        "order": "10",
                        "regex": "1"
}}}]}}]}},{
"bgpEntity": {
  "children": [
    {
      "bgpInst": {
        "attributes": {
          "asn": "123"
        },
        "children": [
          {
            "bgpDom": {
              "attributes": {
                "name": "default"
              },
              "children": [
                {
                  "bgpPeer": {
                    "attributes": {
                      "addr": "1.2.3.4",
                      "inheritContPeerCtrl": ""
                    },
                    "children": [
                      {
                        "bgpPeerAf": {
                          "attributes": {
                            "inheritContPeerPolicyCtrl": "",
                            "type": "ipv4-ucast"
                          },
                          "children": [
                            {
                              "bgpFltrCtrlP": {
                                "attributes": {
                                  "direction": "in",
                                  "list": "List_A"
}}}]}}]}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <rpm-items>
    <accesslist-items>
      <Rule-list>
        <name>List_A</name>
        <ent-items>
          <Entry-list>
            <order>10</order>
            <action>permit</action>
            <regex>1</regex>
          </Entry-list>
        </ent-items>
      </Rule-list>
    </accesslist-items>
  </rpm-items>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv4-ucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <fltrctrl-items>
                    <FltrCtrlP-list>
                      <direction>in</direction>
                      <list>List_A</list>
                    </FltrCtrlP-list>
                  </fltrctrl-items>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Note: This example was added in Release 7.0(3)I7(2).


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.

ip as-path access-list List_A seq 10 permit 1
router bgp 123
 neighbor 1.2.3.4
  address-family ipv4 unicast
   filter-list List_A in

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/media/dme/index.html

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

Applying an AS-PATH Filter List to Outgoing Routes

Applying an AS-PATH Filter List to Outgoing Routes

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "rpmEntity": {
          "children": [
            {
              "rtlistRule": {
                "attributes": {
                  "name": "List_A"
                },
                "children": [
                  {
                    "rtlistEntry": {
                      "attributes": {
                        "action": "permit",
                        "order": "10",
                        "regex": "1"
}}}]}}]}},{
"bgpEntity": {
  "children": [
    {
      "bgpInst": {
        "attributes": {
          "asn": "123"
        },
        "children": [
          {
            "bgpDom": {
              "attributes": {
                "name": "default"
              },
              "children": [
                {
                  "bgpPeer": {
                    "attributes": {
                      "addr": "1.2.3.4",
                      "inheritContPeerCtrl": ""
                    },
                    "children": [
                      {
                        "bgpPeerAf": {
                          "attributes": {
                            "inheritContPeerPolicyCtrl": "",
                            "type": "ipv4-ucast"
                          },
                          "children": [
                            {
                              "bgpFltrCtrlP": {
                                "attributes": {
                                  "direction": "out",
                                    "list": "List_A"
}}}]}}]}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <rpm-items>
    <accesslist-items>
      <Rule-list>
        <name>List_A</name>
        <ent-items>
          <Entry-list>
            <order>10</order>
            <action>permit</action>
            <regex>1</regex>
          </Entry-list>
        </ent-items>
      </Rule-list>
    </accesslist-items>
  </rpm-items>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv4-ucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <fltrctrl-items>
                    <FltrCtrlP-list>
                      <direction>out</direction>
                      <list>List_A</list>
                    </FltrCtrlP-list>
                  </fltrctrl-items>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Note: This example was added in Release 7.0(3)I7(2).


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.

ip as-path access-list List_A seq 10 permit 1
router bgp 123
 neighbor 1.2.3.4
  address-family ipv4 unicast
   filter-list List_A out

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/media/dme/index.html

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

Applying a Prefix List to Incoming Routes

Applying a Prefix List to Incoming Routes

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "rpmEntity": {
          "children": [
            {
              "rtpfxRuleV4": {
                "attributes": {
                  "name": "List_1"
                },
                "children": [
                  {
                    "rtpfxEntry": {
                      "attributes": {
                        "action": "permit",
                        "criteria": "exact",
                        "fromPfxLen": "0",
                        "order": "10",
                        "pfx": "4.3.2.1/3",
                        "toPfxLen": "0"
}}}]}}]}},{
"bgpEntity": {
  "children": [
    {
      "bgpInst": {
        "attributes": {
          "asn": "123"
        },
        "children": [
          {
            "bgpDom": {
              "attributes": {
                "name": "default"
              },
              "children": [
                {
                  "bgpPeer": {
                    "attributes": {
                      "addr": "1.2.3.4",
                      "inheritContPeerCtrl": ""
                    },
                    "children": [
                      {
                        "bgpPeerAf": {
                          "attributes": {
                            "inheritContPeerPolicyCtrl": "",
                            "type": "ipv4-ucast"
                          },
                          "children": [
                            {
                              "bgpPfxCtrlP": {
                                "attributes": {
                                  "direction": "in",
                                  "list": "List_1"
}}}]}}]}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <rpm-items>
    <pfxlistv4-items>
      <RuleV4-list>
        <name>List_1</name>
        <ent-items>
          <Entry-list>
            <order>10</order>
            <action>permit</action>
            <criteria>exact</criteria>
            <fromPfxLen>0</fromPfxLen>
            <pfx>4.3.2.1/3</pfx>
            <toPfxLen>0</toPfxLen>
          </Entry-list>
        </ent-items>
      </RuleV4-list>
    </pfxlistv4-items>
  </rpm-items>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv4-ucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <pfxctrl-items>
                    <PfxCtrlP-list>
                      <direction>in</direction>
                      <list>List_1</list>
                    </PfxCtrlP-list>
                  </pfxctrl-items>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Note: This example was added in Release 7.0(3)I7(2).


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.

ip prefix-list List_1 seq 10 permit 4.3.2.1/3
router bgp 123
 neighbor 1.2.3.4
  address-family ipv4 unicast
   prefix-list List_1 in

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/media/dme/index.html

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

Applying a Prefix List to Outgoing Routes

Applying a Prefix List to Outgoing Routes

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "rpmEntity": {
          "children": [
            {
              "rtpfxRuleV4": {
                "attributes": {
                  "name": "List_1"
                },
                "children": [
                  {
                    "rtpfxEntry": {
                      "attributes": {
                        "action": "permit",
                        "criteria": "exact",
                        "fromPfxLen": "0",
                        "order": "10",
                        "pfx": "4.3.2.1/3",
                        "toPfxLen": "0"
}}}]}}]}},{
"bgpEntity": {
  "children": [
    {
      "bgpInst": {
        "attributes": {
          "asn": "123"
        },
        "children": [
          {
            "bgpDom": {
              "attributes": {
                "name": "default"
              },
              "children": [
                {
                  "bgpPeer": {
                    "attributes": {
                      "addr": "1.2.3.4",
                      "inheritContPeerCtrl": ""
                    },
                    "children": [
                      {
                        "bgpPeerAf": {
                          "attributes": {
                            "inheritContPeerPolicyCtrl": "",
                            "type": "ipv4-ucast"
                          },
                          "children": [
                            {
                              "bgpPfxCtrlP": {
                                "attributes": {
                                  "direction": "out",
                                  "list": "List_1"
}}}]}}]}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <rpm-items>
    <pfxlistv4-items>
      <RuleV4-list>
        <name>List_1</name>
        <ent-items>
          <Entry-list>
            <order>10</order>
            <action>permit</action>
            <criteria>exact</criteria>
            <fromPfxLen>0</fromPfxLen>
            <pfx>4.3.2.1/3</pfx>
            <toPfxLen>0</toPfxLen>
          </Entry-list>
        </ent-items>
      </RuleV4-list>
    </pfxlistv4-items>
  </rpm-items>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv4-ucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <pfxctrl-items>
                    <PfxCtrlP-list>
                      <direction>out</direction>
                      <list>List_1</list>
                    </PfxCtrlP-list>
                  </pfxctrl-items>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Note: This example was added in Release 7.0(3)I7(2).


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.

ip prefix-list List_1 seq 10 permit 4.3.2.1/3
router bgp 123
 neighbor 1.2.3.4
  address-family ipv4 unicast
   prefix-list List_1 out

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/media/dme/index.html

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

Querying an IPv4 Aggregate Address Family

Querying an IPv4 Aggregate Address Family

GET http://<IP_address>/api/mo/sys/bgp/inst/dom-default/af-ipv4-ucast/aggaddr-[10.0.0.0/28].json

{
  "totalCount": "1",
  "imdata": [
    {
      "bgpAggAddr": {
        "attributes": {
          "addr": "192.0.0.0/8",
          "adverMap": "sample2",
          "asSet": "enabled",
          "attrMap": "sample1",
          "childAction": "",
          "dn": "sys/bgp/inst/dom-default/af-ipv4-ucast/aggaddr-[10.0.0.0/28]",
          "lcOwn": "local",
          "modTs": "2015-07-14T01:42:16.238+00:00",
          "status": "",
          "summaryOnly": "disabled",
          "supprMap": "sample3"
}}}]}

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 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": "ipv4-ucast"
}}}]}}]}}]}}

{
    imdata:[]
}

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

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


CLI Commands

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

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

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/media/dme/index.html

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": "ipv4-ucast"
}}}]}}]}}]}}

{
    imdata:[]
}

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

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


CLI Commands

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

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

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/media/dme/index.html

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": "ipv4-ucast"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>VRF_1</name>
          <af-items>
            <DomAf-list>
              <type>ipv4-ucast</type>
              <allocLblAll>disabled</allocLblAll>
              <allocLblRtMap>MAP1</allocLblRtMap>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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


CLI Commands

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

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

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/media/dme/index.html

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": "ipv4-ucast"
}}}]}}]}}]}}

{
    imdata:[]
}

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

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


CLI Commands

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

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

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/media/dme/index.html

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