Cisco Nexus 3000 and 9000 Series NX-API REST SDK and API, Release 7.x

NX-OS 7(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Advertising a Physical IP for a Type-5 Route

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json
{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpDomAf": {
                "attributes": {
                  "advPip": "enabled",
                  "type": "l2vpn-evpn"
}}}]}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <af-items>
            <DomAf-list>
              <type>l2vpn-evpn</type>
              <advPip>enabled</advPip>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Configuring an L2VPN EVPN Address Family

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

Advertising a Physical IP for a Type-5 Route

Advertises route type 5 routes using the primary IP address of the VTEP interface as the next hop address in the VXLAN EVPN fabric.

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 l2vpn evpn
advertise-pip

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

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

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

Deleting a Configured Advertised Physical IP for Type-5 Route

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

CLI Commands

router bgp 100
address-family l2vpn evpn
no advertise-pip

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/

Configuring an Additional Path with Receive Capability

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

CLI Commands

router bgp 100
address-family l2vpn evpn
additional-paths receive

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/

Deleting an Additional Path with Receive Capability

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

CLI Commands

router bgp 100
address-family l2vpn evpn
no additional-paths receive

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/

Configuring Additional Path Selections With Route-map

For configuring a route-map, Configuring a Route Map

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

CLI Commands

router bgp 100
address-family l2vpn evpn
additional-paths selection route-map RTMap1

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/

Deleting Additional Path Selections With Route-map

For configuring a route-map, Configuring a Route Map

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

CLI Commands

router bgp 100
address-family l2vpn evpn
no additional-paths selection route-map RTMap1

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/

Configuring Additional Paths with Send Capability

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

CLI Commands

router bgp 100
address-family l2vpn evpn
additional-paths send

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/

Deleting the Configured Additional Paths with Send Capability

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

CLI Commands

router bgp 100
address-family l2vpn evpn
no additional-paths send

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/

Configuring L2VPN EVPN Under a Neighbor

Configuring an AS-Override While Sending an Update

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

CLI Commands

router bgp 100
neighbor 1.2.3.4
address-family l2vpn evpn
as-override

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

Configuring an AS-Override While Sending an Update (inherited from a Peer Template)

The default option is only valid when inheriting a template.

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

CLI Commands

router bgp 100
template peer P_1 neighbor 1.2.3.4
  inherit peer P_1
   address-family l2vpn evpn
   default as-override

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

Deleting an AS-Override While Sending an Update

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

CLI Commands

router bgp 100
neighbor 1.2.3.4
address-family l2vpn evpn
no as-override

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

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

CLI Commands

ip as-path access-list List_A seq 10 permit 1
router bgp 123
neighbor 1.2.3.4
address-family l2vpn evpn
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

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

CLI Commands

ip as-path access-list List_A seq 10 permit 1
router bgp 123
neighbor 1.2.3.4
address-family l2vpn evpn
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

Applying a Prefix List to Incoming Routes

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

CLI Commands

ip prefix-list List_1 seq 10 permit 4.3.2.1/3
router bgp 123
neighbor 1.2.3.4
address-family l2vpn evpn
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

Applying a Prefix List to Outgoing Routes

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

CLI Commands

ip prefix-list List_1 seq 10 permit 4.3.2.1/3
router bgp 123
neighbor 1.2.3.4
address-family l2vpn evpn
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

Overriding an Route-Target’s ASN Field for eBGP EVPN Sessions

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

CLI Commands

router bgp 100
neighbor 1.2.3.4
address-family l2vpn evpn
rewrite-evpn-rt-asn

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/

Overriding a Route-Target’s ASN Field for eBGP EVPN Sessions (Values inherited from a Peer Template)

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

CLI Command

The CLI command below is the equivalent of the payload example 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
template peer-policy Pol1
neighbor 1.2.3.4
  address-family l2vpn evpn
   inherit peer-policy Pol1 123
   default rewrite-evpn-rt-asn

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/

Configuring a Default Site-of-Origin Extended Community (Values inherited from a Peer Template)

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

CLI Command

router bgp 100
template peer-policy Pol1
neighbor 1.2.3.4
  address-family l2vpn evpn
   inherit peer-policy Pol1 123
   default rewrite-evpn-rt-asn

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/

Response

Configuring an L2VPN EVPN Address Family

Advertising a Physical IP for a Type-5 Route

Deleting a Configured Advertised Physical IP for Type-5 Route

Configuring an Additional Path with Receive Capability

Deleting an Additional Path with Receive Capability

Configuring Additional Path Selections With Route-map

Deleting Additional Path Selections With Route-map

Configuring Additional Paths with Send Capability

Deleting the Configured Additional Paths with Send Capability

Configuring L2VPN EVPN Under a Neighbor

Configuring an AS-Override While Sending an Update

Configuring an AS-Override While Sending an Update (inherited from a Peer Template)

Deleting an AS-Override While Sending an Update

Applying an AS-PATH Filter List to Incoming Routes

Applying an AS-PATH Filter List to Outgoing Routes

Applying a Prefix List to Incoming Routes

Applying a Prefix List to Outgoing Routes

Overriding an Route-Target’s ASN Field for eBGP EVPN Sessions

Overriding a Route-Target’s ASN Field for eBGP EVPN Sessions (Values inherited from a Peer Template)

Configuring a Default Site-of-Origin Extended Community (Values inherited from a Peer Template)