Cisco Nexus 3000 and 9000 Series NX-API REST SDK API, Release 9.3(x)

NX-OS 9.3(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Enabling VXLAN BGP EVPN

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "fmEntity": {
          "children": [
            {
              "fmEvpn": {
                "attributes": {
                  "adminSt": "enabled"
 }}},{

              "fmNvo": {
                "attributes": {
                  "adminSt": "enabled"
}}},{

              "fmVnSegment": {
                "attributes": {
                  "adminSt": "enabled"
}}}]}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <fm-items>
    <evpn-items>
      <adminSt>enabled</adminSt>
    </evpn-items>
    <nvo-items>
      <adminSt>enabled</adminSt>
    </nvo-items>
    <vnsegment-items>
      <adminSt>enabled</adminSt>
    </vnsegment-items>
  </fm-items>
</System>

Configuring VXLAN BGP EVPN

Enabling VXLAN BGP EVPN

This operation enables the Network Virtualization (NV) overlay and enables VLAN-based VXLAN and the EVPN control plane for VXLAN.

CLI Commands

The CLI commands and options listed below are the 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.

feature vn-segment
feature nv overlay
nv overlay evpn

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

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

MO	DN
topSystem	sys
fmEntity	sys/fm
fmEvpn	sys/fm/evpn
fmNvo	sys/fm/nvo
fmVnSegment	sys/fm/vnsegment

fmEvpn Properties

The following table contains information about the fmEvpn properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
adminSt	fm:AdminState (scalar:Enum8)	Admin status	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

fmNvo Properties

The following table contains information about the fmNvo properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
adminSt	fm:AdminState (scalar:Enum8)	Admin status	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

fmVnSegment Properties

The following table contains information about the fmVnSegment properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
adminSt	fm:AdminState (scalar:Enum8)	Admin status	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

Related Documentation

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

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

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

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

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

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

Exporting and Importing Target VPN Extended Communities in a Specified Format

Exporting and importing target VPN extended communities in a specified format.

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.

evpn
vni 123 l2
route-target both 1:2

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

MO	DN
rtctrlL2Evpn	sys/evpn
rtctrlBDEvi	sys/evpn/bdevi-{[encap]}
rtctrlRttP	sys/inst-{name}/dom-{name}/af-{[type]}/ctrl-{[type]}/rttp-{type}
rtctrlRttEntry	sys/inst-{name}/dom-{name}/af-{[type]}/ctrl-{[type]}/rttp-{type}/ent-{[rtt]}

rtctrlL2Evpn Properties

The following table contains information about the rtctrlL2Evpn properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt (scalar:Enum8)	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled

rtctrlBDEvi Properties

The following table contains information about the rtctrlBDEvi properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
encap	base:Encap	Encapsulation	SELECTION: unknown, vlan-%d or vxlan-%d

rtctrlRttP Properties

The following table contains information about the rtctrlRttP properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

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

rtctrlRttEntry Properties

The following table contains information about the rtctrlRttEntry properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
rtt	base:Community	Route Target

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

Exporting and Importing Target VPN Extended Communities in Auto-Generated Targets

Exporting and importing target VPN extended communities in auto-generated targets.

CLI Commands

evpn
vni 123 l2
route-target both auto

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

MO	DN
rtctrlL2Evpn	sys/evpn
rtctrlBDEvi	sys/evpn/bdevi-{[encap]}
rtctrlRttP	sys/inst-{name}/dom-{name}/af-{[type]}/ctrl-{[type]}/rttp-{type}
rtctrlRttEntry	sys/inst-{name}/dom-{name}/af-{[type]}/ctrl-{[type]}/rttp-{type}/ent-{[rtt]}

rtctrlL2Evpn Properties

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt (scalar:Enum8)	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled

rtctrlBDEvi Properties

Property Name	Data Type	Description	Values
encap	base:Encap	Encapsulation	SELECTION: unknown, vlan-%d or vxlan-%d

rtctrlRttP Properties

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

rtctrlRttEntry Properties

Property Name	Data Type	Description	Values
rtt	base:Community	Route Target

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 Target VPN Extended Communities in Auto-Generated Targets

Importing target VPN extended communities in auto-generated targets.

CLI Commands

evpn
vni 123 l2
route-target import auto

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

MO	DN
rtctrlL2Evpn	sys/evpn
rtctrlBDEvi	sys/evpn/bdevi-{[encap]}
rtctrlRttP	sys/inst-{name}/dom-{name}/af-{[type]}/ctrl-{[type]}/rttp-{type}
rtctrlRttEntry	sys/inst-{name}/dom-{name}/af-{[type]}/ctrl-{[type]}/rttp-{type}/ent-{[rtt]}

rtctrlL2Evpn Properties

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt (scalar:Enum8)	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled

rtctrlBDEvi Properties

Property Name	Data Type	Description	Values
encap	base:Encap	Encapsulation	SELECTION: unknown, vlan-%d or vxlan-%d

rtctrlRttP Properties

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

rtctrlRttEntry Properties

Property Name	Data Type	Description	Values
rtt	base:Community	Route Target

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 Target VPN Extended Communities in a Specified Format

Importing target VPN extended communities in a specified format.

CLI Commands

evpn
vni 123 l2
route-target import 1:2

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

MO	DN
rtctrlL2Evpn	sys/evpn
rtctrlBDEvi	sys/evpn/bdevi-{[encap]}
rtctrlRttP	sys/inst-{name}/dom-{name}/af-{[type]}/ctrl-{[type]}/rttp-{type}
rtctrlRttEntry	sys/inst-{name}/dom-{name}/af-{[type]}/ctrl-{[type]}/rttp-{type}/ent-{[rtt]}

rtctrlL2Evpn Properties

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt (scalar:Enum8)	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled

rtctrlBDEvi Properties

Property Name	Data Type	Description	Values
encap	base:Encap	Encapsulation	SELECTION: unknown, vlan-%d or vxlan-%d

rtctrlRttP Properties

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

rtctrlRttEntry Properties

Property Name	Data Type	Description	Values
rtt	base:Community	Route Target

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

Exporting Target VPN Extended Communities in Auto-Generated Targets

Exporting target VPN extended communities in auto-generated targets.

CLI Commands

evpn
vni 123 l2
route-target export auto

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

MO	DN
rtctrlL2Evpn	sys/evpn
rtctrlBDEvi	sys/evpn/bdevi-{[encap]}
rtctrlRttP	sys/inst-{name}/dom-{name}/af-{[type]}/ctrl-{[type]}/rttp-{type}
rtctrlRttEntry	sys/inst-{name}/dom-{name}/af-{[type]}/ctrl-{[type]}/rttp-{type}/ent-{[rtt]}

rtctrlL2Evpn Properties

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt (scalar:Enum8)	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled

rtctrlBDEvi Properties

Property Name	Data Type	Description	Values
encap	base:Encap	Encapsulation	SELECTION: unknown, vlan-%d or vxlan-%d

rtctrlRttP Properties

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

rtctrlRttEntry Properties

Property Name	Data Type	Description	Values
rtt	base:Community	Route Target

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

Exporting Target VPN Extended Communities in a Specified Format

Exporting target VPN extended communities in a specified format.

CLI Commands

evpn
vni 123 l2
route-target export 1:2

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

MO	DN
rtctrlL2Evpn	sys/evpn
rtctrlBDEvi	sys/evpn/bdevi-{[encap]}
rtctrlRttP	sys/inst-{name}/dom-{name}/af-{[type]}/ctrl-{[type]}/rttp-{type}
rtctrlRttEntry	sys/inst-{name}/dom-{name}/af-{[type]}/ctrl-{[type]}/rttp-{type}/ent-{[rtt]}

rtctrlL2Evpn Properties

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt (scalar:Enum8)	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled

rtctrlBDEvi Properties

Property Name	Data Type	Description	Values
encap	base:Encap	Encapsulation	SELECTION: unknown, vlan-%d or vxlan-%d

rtctrlRttP Properties

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

rtctrlRttEntry Properties

Property Name	Data Type	Description	Values
rtt	base:Community	Route Target

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

Auto-Generating VPN Route Distinguishers

Auto-generating VPN route distinguishers.

CLI Commands

evpn
vni 123 l2
rd auto

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

MO	DN
rtctrlL2Evpn	sys/evpn
rtctrlBDEvi	sys/evpn/bdevi-{[encap]}

rtctrlL2Evpn Properties

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt (scalar:Enum8)	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled

rtctrlBDEvi Properties

Property Name	Data Type	Description	Values
encap	base:Encap	Encapsulation	SELECTION: unknown, vlan-%d or vxlan-%d
rd	base:Community	Route Distinguisher

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

Generating VPN Route Distinguishers in a Specified Format

Generating VPN route distinguishers in a specified format.

CLI Commands

evpn
vni 123 l2
rd 1:2

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

MO	DN
rtctrlL2Evpn	sys/evpn
rtctrlBDEvi	sys/evpn/bdevi-{[encap]}

rtctrlL2Evpn Properties

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt (scalar:Enum8)	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled

rtctrlBDEvi Properties

Property Name	Data Type	Description	Values
encap	base:Encap	Encapsulation	SELECTION: unknown, vlan-%d or vxlan-%d
rd	base:Community	Route Distinguisher

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

Matching the IP Address of a Route

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

CLI Commands

route-map Map_1
match ip address ipadd

Verifying a DME Configuration

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

MO	DN
rpmEntity	sys/rpm
rtmapRule	sys/rpm/rtmap-[Map_1]
rtmapEntry	sys/rpm/rtmap-[Map_1]/ent-10
rtmapMatchRtDst	sys/rpm/rtmap-[Map_1]/ent-10/mrtdst
rtmapRsRtDstAccAtt	sys/rpm/rtmap-[Map_1]/ent-10/mrtdst/rsrtDstAccAtt-[sys/rpm/accesslist-[ipadd]]

rtmapRule Properties

The following table contains information about the rtmapRule properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
name	pol:ObjName string:Basic	The name of the object.	RANGE: Min: "1" Max: "63"

rtmapEntry Properties

The following table contains information about the rtmapEntry properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
action	rtflt:Action (scalar:Enum8)	Action	SELECTION: 0 - deny 1 - permit DEFAULT: permit
order	rtflt:Order (scalar:Uint32)	Order	RANGE: [0 , 65535]

rtmapRsRtDstAccAtt Properties

The following table contains information about the rtmapRsRtDstAccAtt properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
tDn	reln:Dn reference:BinRef	The distinguished name of the target.

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 Configured IP Address Match of a Route

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

CLI Commands

route-map Map_1
no match ip address ipadd

Verifying a DME Configuration

MO	DN
rpmEntity	sys/rpm
rtmapRule	sys/rpm/rtmap-[Map_1]
rtmapEntry	sys/rpm/rtmap-[Map_1]/ent-10
rtmapMatchRtDst	sys/rpm/rtmap-[Map_1]/ent-10/mrtdst
rtmapRsRtDstAccAtt	sys/rpm/rtmap-[Map_1]/ent-10/mrtdst/rsrtDstAccAtt-[sys/rpm/accesslist-[ipadd]]

rtmapRule Properties

Property Name	Data Type	Description	Values
name	pol:ObjName string:Basic	The name of the object.	RANGE: Min: "1" Max: "63"

rtmapEntry Properties

Property Name	Data Type	Description	Values
action	rtflt:Action (scalar:Enum8)	Action	SELECTION: 0 - deny 1 - permit DEFAULT: permit
order	rtflt:Order (scalar:Uint32)	Order	RANGE: [0 , 65535]

rtmapRsRtDstAccAtt Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
tDn	reln:Dn reference:BinRef	The distinguished name of the target.

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