Configuring an L2VPN EVPN Address Family under a Neighbor

Configuring a Route Map to Specify Import Criteria

Configuring a Route Map to Specify Import Criteria
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "l2vpn-evpn"
                            },
                            "children": [
                              {
                                "bgpImportRt": {
                                  "attributes": {
                                    "importRt": "yes",
                                    "importType": "vpn-unicast",
                                    "reoriginate": "no",
                                    "rtMap": "SampleString_123"
}}}]}}]}}]}}]}}]}}
{
    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>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <import-items>
                    <ImportRt-list>
                      <importType>vpn-unicast</importType>
                      <importRt>true</importRt>
                      <reoriginate>false</reoriginate>
                      <rtMap>SampleString_123</rtMap>
                    </ImportRt-list>
                  </import-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 9.3(5).


CLI Commands

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

router bgp 100
  neighbor 1.2.3.4
   address-family l2vpn evpn
    import vpn unicast route-map SampleString_123


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-default
bgpPeer sys/bgp/inst/dom-default/peer-[1.2.3.4]
bgpPeerAf sys/bgp/inst/dom-default/peer-[1.2.3.4]/af-[l2vpn-evpn]
bgpImportRt sys/bgp/inst/dom-default/peer-[1.2.3.4]/af-[l2vpn-evpn]/import-[vpn-unicast]


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


bgpPeer Properties

The following table contains information about the bgpPeer 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
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt
4398046511104 - mhop-intvl
8796093022208 - mhop-auth


bgpPeerAf Properties

The following table contains information about the bgpPeerAf 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
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
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


bgpImportRt Properties

The following table contains information about the bgpImportRt 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
importRtscalar:Bool
Import routes into another address-family when neither route-map nor reoriginate specifiedSELECTION: true or false
importTypebgp:ImportRtT
(scalar:Enum8)
Type of routes to import from another address-familySELECTION:
0 - vpn-unicast
1 - l2vpn-evpn
reoriginatescalar:Bool
Reoriginate the route with new routeSELECTION: true or false
rtMapstring:Basic
Apply route-map to specify import criteriaA 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 a Route Map to Specify Import Criteria

Deleting a Route Map to Specify Import Criteria
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "l2vpn-evpn"
                            },
                            "children": [
                              {
                                "bgpImportRt": {
                                  "attributes": {
                                    "importType": "vpn-unicast",
                                    "status": "deleted"
}}}]}}]}}]}}]}}]}}
{
    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>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <import-items>
                    <ImportRt-list nc:operation="delete">
                      <importType>vpn-unicast</importType>
                    </ImportRt-list>
                  </import-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 9.3(5).


CLI Commands

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

router bgp 100
  neighbor 1.2.3.4
   address-family l2vpn evpn
    no import vpn unicast route-map SampleString_123


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-default
bgpPeer sys/bgp/inst/dom-default/peer-[1.2.3.4]
bgpPeerAf sys/bgp/inst/dom-default/peer-[1.2.3.4]/af-[l2vpn-evpn]
bgpImportRt sys/bgp/inst/dom-default/peer-[1.2.3.4]/af-[l2vpn-evpn]/import-[vpn-unicast]


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


bgpPeer Properties

The following table contains information about the bgpPeer 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
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt
4398046511104 - mhop-intvl
8796093022208 - mhop-auth


bgpPeerAf Properties

The following table contains information about the bgpPeerAf 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
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
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


bgpImportRt Properties

The following table contains information about the bgpImportRt 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
importTypebgp:ImportRtT
(scalar:Enum8)
Type of routes to import from another address-familySELECTION:
0 - vpn-unicast
1 - l2vpn-evpn
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Reoriginating the Route with a New RT

Reoriginating the Route with a New RT
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "l2vpn-evpn"
                            },
                            "children": [
                              {
                                "bgpImportRt": {
                                  "attributes": {
                                    "importRt": "yes",
                                    "importType": "vpn-unicast",
                                    "reoriginate": "yes",
                                    "rtMap": ""
}}}]}}]}}]}}]}}]}}
{
    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>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <import-items>
                    <ImportRt-list>
                      <importType>vpn-unicast</importType>
                      <importRt>true</importRt>
                      <reoriginate>true</reoriginate>
                      <rtMap></rtMap>
                    </ImportRt-list>
                  </import-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 9.3(5).


CLI Commands

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

router bgp 100
  neighbor 1.2.3.4
   address-family l2vpn evpn
    import vpn unicast reoriginate


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-default
bgpPeer sys/bgp/inst/dom-default/peer-[1.2.3.4]
bgpPeerAf sys/bgp/inst/dom-default/peer-[1.2.3.4]/af-[l2vpn-evpn]
bgpImportRt sys/bgp/inst/dom-default/peer-[1.2.3.4]/af-[l2vpn-evpn]/import-[vpn-unicast]


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


bgpPeer Properties

The following table contains information about the bgpPeer 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
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt
4398046511104 - mhop-intvl
8796093022208 - mhop-auth


bgpPeerAf Properties

The following table contains information about the bgpPeerAf 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
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
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


bgpImportRt Properties

The following table contains information about the bgpImportRt 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
importRtscalar:Bool
Import routes into another address-family when neither route-map nor reoriginate specifiedSELECTION: true or false
importTypebgp:ImportRtT
(scalar:Enum8)
Type of routes to import from another address-familySELECTION:
0 - vpn-unicast
1 - l2vpn-evpn
reoriginatescalar:Bool
Reoriginate the route with new routeSELECTION: true or false
rtMapstring:Basic
Apply route-map to specify import criteriaA 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 the Reoriginating Config

Deleting the Reoriginating Config
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "l2vpn-evpn"
                            },
                            "children": [
                              {
                                "bgpImportRt": {
                                  "attributes": {
                                    "importType": "vpn-unicast",
                                    "status": "deleted"
}}}]}}]}}]}}]}}]}}
{
    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>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <import-items>
                    <ImportRt-list nc:operation="delete">
                      <importType>vpn-unicast</importType>
                    </ImportRt-list>
                  </import-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 9.3(5).


CLI Commands

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

router bgp 100
  neighbor 1.2.3.4
   address-family l2vpn evpn
    no import vpn unicast reoriginate


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-default
bgpPeer sys/bgp/inst/dom-default/peer-[1.2.3.4]
bgpPeerAf sys/bgp/inst/dom-default/peer-[1.2.3.4]/af-[l2vpn-evpn]
bgpImportRt sys/bgp/inst/dom-default/peer-[1.2.3.4]/af-[l2vpn-evpn]/import-[vpn-unicast]


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


bgpPeer Properties

The following table contains information about the bgpPeer 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
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt
4398046511104 - mhop-intvl
8796093022208 - mhop-auth


bgpPeerAf Properties

The following table contains information about the bgpPeerAf 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
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
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


bgpImportRt Properties

The following table contains information about the bgpImportRt 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
importTypebgp:ImportRtT
(scalar:Enum8)
Type of routes to import from another address-familySELECTION:
0 - vpn-unicast
1 - l2vpn-evpn
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Importing the Routes into Another Address Family (VPN EVPN Under a L2VPN EVPN AF)

Importing the Routes into Another Address Family (VPN EVPN Under a L2VPN EVPN AF)
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "l2vpn-evpn"
                            },
                            "children": [
                              {
                                "bgpImportRt": {
                                  "attributes": {
                                    "importRt": "yes",
                                    "importType": "vpn-unicast",
                                    "reoriginate": "no",
                                    "rtMap": "SampleString_123"
}}}]}}]}}]}}]}}]}}
{
    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>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <import-items>
                    <ImportRt-list>
                      <importType>vpn-unicast</importType>
                      <importRt>true</importRt>
                      <reoriginate>false</reoriginate>
                      <rtMap>SampleString_123</rtMap>
                    </ImportRt-list>
                  </import-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 9.3(5).


CLI Commands

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

router bgp 100
  neighbor 1.2.3.4
   address-family l2vpn evpn
    import vpn unicast route-map SampleString_123


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-default
bgpPeer sys/bgp/inst/dom-default/peer-[1.2.3.4]
bgpPeerAf sys/bgp/inst/dom-default/peer-[1.2.3.4]/af-[l2vpn-evpn]
bgpImportRt sys/bgp/inst/dom-default/peer-[1.2.3.4]/af-[l2vpn-evpn]/import-[vpn-unicast]


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


bgpPeer Properties

The following table contains information about the bgpPeer 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
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt
4398046511104 - mhop-intvl
8796093022208 - mhop-auth


bgpPeerAf Properties

The following table contains information about the bgpPeerAf 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
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
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


bgpImportRt Properties

The following table contains information about the bgpImportRt 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
importRtscalar:Bool
Import routes into another address-family when neither route-map nor reoriginate specifiedSELECTION: true or false
importTypebgp:ImportRtT
(scalar:Enum8)
Type of routes to import from another address-familySELECTION:
0 - vpn-unicast
1 - l2vpn-evpn
reoriginatescalar:Bool
Reoriginate the route with new routeSELECTION: true or false
rtMapstring:Basic
Apply route-map to specify import criteriaA 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 the Routes Imported into another Address Family (VPN EVPN Under a L2VPN EVPN AF)

Deleting the Routes Imported into another Address Family (VPN EVPN Under a L2VPN EVPN AF)
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "l2vpn-evpn"
                            },
                            "children": [
                              {
                                "bgpImportRt": {
                                  "attributes": {
                                    "importType": "vpn-unicast",
                                    "status": "deleted"
}}}]}}]}}]}}]}}]}}
{
    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>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <import-items>
                    <ImportRt-list nc:operation="delete">
                      <importType>vpn-unicast</importType>
                    </ImportRt-list>
                  </import-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 9.3(5).


CLI Commands

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

router bgp 100
  neighbor 1.2.3.4
   address-family l2vpn evpn
    no import vpn unicast route-map SampleString_123


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-default
bgpPeer sys/bgp/inst/dom-default/peer-[1.2.3.4]
bgpPeerAf sys/bgp/inst/dom-default/peer-[1.2.3.4]/af-[l2vpn-evpn]
bgpImportRt sys/bgp/inst/dom-default/peer-[1.2.3.4]/af-[l2vpn-evpn]/import-[vpn-unicast]


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


bgpPeer Properties

The following table contains information about the bgpPeer 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
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt
4398046511104 - mhop-intvl
8796093022208 - mhop-auth


bgpPeerAf Properties

The following table contains information about the bgpPeerAf 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
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
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


bgpImportRt Properties

The following table contains information about the bgpImportRt 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
importTypebgp:ImportRtT
(scalar:Enum8)
Type of routes to import from another address-familySELECTION:
0 - vpn-unicast
1 - l2vpn-evpn
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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