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

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring Ethernet EVI Id

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "rtctrlL2Evpn": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "rtctrlBDEvi": {
                "attributes": {
                  "encap": "mpls-9954504"
}}}]}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <evpn-items>
    <adminSt>enabled</adminSt>
    <bdevi-items>
      <BDEvi-list>
        <encap>mpls-9954504</encap>
      </BDEvi-list>
    </bdevi-items>
  </evpn-items>
</System>

Configuring L2 EVI

Configuring Ethernet EVI Id

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

CLI Commands

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

evpn
evi 9954504

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
rtctrlL2Evpn	sys/evpn
rtctrlBDEvi	sys/evpn/bdevi-[mpls-9954504]

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

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 Ethernet EVI Id

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

CLI Commands

evpn
no evi 9954504

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
rtctrlBDEvi	sys/evpn/bdevi-{[encap]}
rtctrlL2Evpn	sys/evpn
topSystem	sys

rtctrlBDEvi Properties

Property Name	Data Type	Description	Values
encap	base:Encap	Encapsulation	SELECTION: unknown, vlan-%d or vxlan-%d
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

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

Related Documentation

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

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

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

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

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

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

Configuring a VPN Route Distinguisher

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

CLI Commands

evpn
evi 123
rd 123:12

Verifying a DME Configuration

MO	DN
topSystem	sys
rtctrlL2Evpn	sys/evpn
rtctrlBDEvi	sys/evpn/bdevi-[mpls-123]

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

Deleting a VPN Route Distinguisher

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

CLI Commands

evpn
evi 123
no rd 123:12

Verifying a DME Configuration

MO	DN
topSystem	sys
rtctrlL2Evpn	sys/evpn
rtctrlBDEvi	sys/evpn/bdevi-[mpls-123]

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

Configuring an Export Target-VPN Community

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

CLI Commands

evpn
evi 123
route-target export 123:12

Verifying a DME Configuration

MO	DN
topSystem	sys
rtctrlL2Evpn	sys/evpn
rtctrlBDEvi	sys/evpn/bdevi-[mpls-123]
rtctrlRttP	sys/evpn/bdevi-[mpls-123]/rttp-export
rtctrlRttEntry	sys/evpn/bdevi-[mpls-123]/rttp-export/ent-route-target:as2-nn2:123:12

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

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

Deleting an Export Target-VPN Community

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

CLI Commands

evpn
evi 123
no route-target export 123:12

Verifying a DME Configuration

MO	DN
topSystem	sys
rtctrlL2Evpn	sys/evpn
rtctrlBDEvi	sys/evpn/bdevi-[mpls-123]
rtctrlRttP	sys/evpn/bdevi-[mpls-123]/rttp-export
rtctrlRttEntry	sys/evpn/bdevi-[mpls-123]/rttp-export/ent-route-target:as2-nn2:123:12

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
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	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

Configuring an Import Target-VPN Community

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

CLI Commands

evpn
evi 123
route-target import 123:12

Verifying a DME Configuration

MO	DN
topSystem	sys
rtctrlL2Evpn	sys/evpn
rtctrlBDEvi	sys/evpn/bdevi-[mpls-123]
rtctrlRttP	sys/evpn/bdevi-[mpls-123]/rttp-import
rtctrlRttEntry	sys/evpn/bdevi-[mpls-123]/rttp-import/ent-route-target:as2-nn2:123:12

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

Deleting an Import Target-VPN Community

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

CLI Commands

evpn
evi 123
no route-target import 123:12

Verifying a DME Configuration

MO	DN
topSystem	sys
rtctrlL2Evpn	sys/evpn
rtctrlBDEvi	sys/evpn/bdevi-[mpls-123]
rtctrlRttP	sys/evpn/bdevi-[mpls-123]/rttp-import
rtctrlRttEntry	sys/evpn/bdevi-[mpls-123]/rttp-import/ent-route-target:as2-nn2:123:12

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
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	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