Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)

Latest

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring BGP as the Ingress Replication Protocol

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/eps.json
{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1",
            "ingressReplProtoBGP": "yes"
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <ingressReplProtoBGP>true</ingressReplProtoBGP>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

Configuring NVE Interfaces

Configuring BGP as the Ingress Replication Protocol

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.

interface nve 1-1
global ingress-replication protocol bgp

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
nvoEps	sys/eps
nvoEp	sys/eps/epId-{epId}

nvoEp Properties

The following table contains information about the nvoEp 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
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]
ingressReplProtoBGP	scalar:Bool	VxLAN Ingress Replication Protocol BGP.	SELECTION: true or false

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 BGP as the Ingress Replication Protocol

CLI Commands

interface nve 1-1
no global ingress-replication protocol bgp

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

MO	DN
nvoEps	sys/eps
nvoEp	sys/eps/epId-{epId}

nvoEp Properties

Property Name	Data Type	Description	Values
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]
ingressReplProtoBGP	scalar:Bool	VxLAN Ingress Replication Protocol BGP.	SELECTION: true or false

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 ARP Suppression for NVE

CLI Commands

interface nve 1-1
global suppress-arp

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

MO	DN
nvoEps	sys/eps
nvoEp	sys/eps/epId-{epId}

nvoEp Properties

Property Name	Data Type	Description	Values
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]
suppressARP	scalar:Bool	Suppress ARP.	SELECTION: true or false

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 ARP Suppression for NVE

CLI Commands

interface nve 1-1
no global suppress-arp

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

MO	DN
nvoEps	sys/eps
nvoEp	sys/eps/epId-{epId}

nvoEp Properties

Property Name	Data Type	Description	Values
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]
suppressARP	scalar:Bool	Suppress ARP.	SELECTION: true or false

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 Global Multicast Group for L2 VNIs

CLI Commands

interface nve 1-1
global mcast-group 234.255.255.250 L2

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

MO	DN
nvoEps	sys/eps
nvoEp	sys/eps/epId-{epId}

nvoEp Properties

Property Name	Data Type	Description	Values
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]
mcastGroupL2	mcast:GrpIp (address:Ip)	Base multicast group address for L2.	Value must match ipv4 or ipv6 known format

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 Global Multicast Group for L2 VNIs

CLI Commands

interface nve 1-1
no global mcast-group L2

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

MO	DN
nvoEps	sys/eps
nvoEp	sys/eps/epId-{epId}

nvoEp Properties

Property Name	Data Type	Description	Values
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]
mcastGroupL2	mcast:GrpIp (address:Ip)	Base multicast group address for L2.	Value must match ipv4 or ipv6 known format

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 Global Multicast Group for L3 VNIs

CLI Commands

interface nve 1-1
global mcast-group 234.255.255.250 L3

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

MO	DN
nvoEps	sys/eps
nvoEp	sys/eps/epId-{epId}

nvoEp Properties

Property Name	Data Type	Description	Values
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]
mcastGroupL3	mcast:GrpIp (address:Ip)	Base multicast group address for L3.	Value must match ipv4 or ipv6 known format

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 Global Multicast Group for L3 VNIs

CLI Commands

interface nve 1-1
no global mcast-group L3

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

MO	DN
nvoEps	sys/eps
nvoEp	sys/eps/epId-{epId}

nvoEp Properties

Property Name	Data Type	Description	Values
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]
mcastGroupL3	mcast:GrpIp (address:Ip)	Base multicast group address for L3.	Value must match ipv4 or ipv6 known format

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 Description

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

CLI Commands

interface nve 1-1
description SampleString_123

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

MO	DN
nvoEps	sys/eps
nvoEp	sys/eps/epId-{epId}

nvoEp Properties

Property Name	Data Type	Description	Values
descr	string:Basic	Description for the NVE	A sequence of characters
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]

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 Description

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

CLI Commands

interface nve 1-1
no description SampleString_123

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

MO	DN
nvoEps	sys/eps
nvoEp	sys/eps/epId-{epId}

nvoEp Properties

Property Name	Data Type	Description	Values
descr	string:Basic	Description for the NVE	A sequence of characters
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]

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 NVE Multicast Group

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

CLI Commands

interface nve 1-1
member vni 123 mcast-group 231.1.1.1

MO	DN
nvoEp	sys/eps/epId-1
nvoEps	sys/eps
nvoNw	sys/eps/epId-1/nws/vni-123
nvoNws	sys/eps/epId-1/nws

nvoEp Properties

Property Name	Data Type	Description	Values
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]

nvoNw Properties

The following table contains information about the nvoNw 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
cfgSrc	nvo:CfgSrcT (scalar:Enum16)	Internal system property. Not intended for external use.	SELECTION: 0 - unknown 1 - cli 2 - controller DEFAULT: 0
isLegacyMode	scalar:Bool	Indicates whether Multicast group configuration for the VNI(s) is configured in legacy mode or not.	SELECTION: true or false
mcastGroup	mcast:GrpIp (address:Ip)	Configures multicast group address for VNI(s).	Supported range is valid multicast group addresses. Value must match ipv4 or ipv6 known format
vni	nvo:VniT (scalar:Uint32)	Configure Virtual Network ID	Supported VNI values 1 to 16777214. RANGE: [1 , 16777215]

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 NVE Multicast Group

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

CLI Commands

interface nve 1-1
no member vni 123 mcast-group 231.1.1.1

MO	DN
nvoEp	sys/eps/epId-1
nvoEps	sys/eps
nvoNw	sys/eps/epId-1/nws/vni-123
nvoNws	sys/eps/epId-1/nws

nvoEp Properties

Property Name	Data Type	Description	Values
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]

nvoNw Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
vni	nvo:VniT (scalar:Uint32)	Configure Virtual Network ID	Supported VNI values 1 to 16777214. RANGE: [1 , 16777215]

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 Static Virtual RMAC

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

CLI Commands

interface nve 1-1
virtual-rmac d8b1.9071.e903

MO	DN
nvoEp	sys/eps/epId-1
nvoEps	sys/eps

nvoEp Properties

Property Name	Data Type	Description	Values
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]
virtualMac	address:MAC	Custom Virtual Router MAC address configuration for VPC VxLAN.	Value must match MM:MM:MM:SS:SS:SS format

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 Static Virtual RMAC

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

CLI Commands

interface nve 1-1
no virtual-rmac d8b1.9071.e903

MO	DN
nvoEp	sys/eps/epId-1
nvoEps	sys/eps

nvoEp Properties

Property Name	Data Type	Description	Values
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]
virtualMac	address:MAC	Custom Virtual Router MAC address configuration for VPC VxLAN.	Value must match MM:MM:MM:SS:SS:SS format

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 Global Multicast Group for L2 VNIs

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

CLI Commands

interface nve 1-1
global mcast-group 231.1.1.1 L2

MO	DN
nvoEp	sys/eps/epId-1
nvoEps	sys/eps

nvoEp Properties

Property Name	Data Type	Description	Values
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]
mcastGroupL2	mcast:GrpIp (address:Ip)	Base multicast group address for L2.	Value must match ipv4 or ipv6 known format

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 Global Multicast Group for L2 VNIs

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

CLI Commands

interface nve 1-1
no global mcast-group L2

MO	DN
nvoEp	sys/eps/epId-1
nvoEps	sys/eps

nvoEp Properties

Property Name	Data Type	Description	Values
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]
mcastGroupL2	mcast:GrpIp (address:Ip)	Base multicast group address for L2.	Value must match ipv4 or ipv6 known format

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 Global Multicast Group for L3 VNIs

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

CLI Commands

interface nve 1-1
global mcast-group 231.1.1.1 L3

MO	DN
nvoEp	sys/eps/epId-1
nvoEps	sys/eps

nvoEp Properties

Property Name	Data Type	Description	Values
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]
mcastGroupL3	mcast:GrpIp (address:Ip)	Base multicast group address for L3.	Value must match ipv4 or ipv6 known format

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 Multicast Group for L3 VNIs

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

CLI Commands

interface nve 1-1
no global mcast-group L3

MO	DN
nvoEp	sys/eps/epId-1
nvoEps	sys/eps

nvoEp Properties

Property Name	Data Type	Description	Values
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]
mcastGroupL3	mcast:GrpIp (address:Ip)	Base multicast group address for L3.	Value must match ipv4 or ipv6 known format

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 Anycast Loopback Interface

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

CLI Commands

interface nve 1-1
source-interface loopback 123 anycast loopback 123

MO	DN
nvoEp	sys/eps/epId-1
nvoEps	sys/eps

nvoEp Properties

Property Name	Data Type	Description	Values
anycastIntf	nw:IfId (base:IfIndex)	Anycast Source Interface associated with the NVE.	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]
sourceInterface	nw:IfId (base:IfIndex)	Source Interface associated with the NVE.	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

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 Anycast Loopback Interface

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

CLI Commands

interface nve 1-1
no source-interface loopback 123 anycast loopback 123

MO	DN
nvoEp	sys/eps/epId-1
nvoEps	sys/eps

nvoEp Properties

Property Name	Data Type	Description	Values
anycastIntf	nw:IfId (base:IfIndex)	Anycast Source Interface associated with the NVE.	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]
sourceInterface	nw:IfId (base:IfIndex)	Source Interface associated with the NVE.	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

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 Hold Source Loopback Down Time

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

CLI Commands

interface nve 1-1
source-interface hold-down-time 123

MO	DN
nvoEp	sys/eps/epId-1
nvoEps	sys/eps

nvoEp Properties

Property Name	Data Type	Description	Values
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]
holdDownTime	scalar:Uint16	Hold Down Time.	Supported values are 1 to 1500 (in seconds). RANGE: [1 , 1500] DEFAULT: 180

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 Hold Source Loopback Down Time

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

CLI Commands

interface nve 1-1
no source-interface hold-down-time 123

MO	DN
nvoEp	sys/eps/epId-1
nvoEps	sys/eps

nvoEp Properties

Property Name	Data Type	Description	Values
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]
holdDownTime	scalar:Uint16	Hold Down Time.	Supported values are 1 to 1500 (in seconds). RANGE: [1 , 1500] DEFAULT: 180

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 the Override Source Address of Routed MCAST Packets

Note:

This example was added in Release 9.3(5).
This is only supported on the following platforms:
- N9K-C92160YC-X
- N9K-C92304QC
- N9K-C9272Q
- N9K-C9236C
- N9K-C92300YC
- N9K-C93108TC-EX
- N9K-C93180LC-EX
- N9K-C93180YC-EX

CLI Commands

interface nve 1-1
mcast-routing override source-interface loopback 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.

MO	DN
nvoEps	sys/eps
nvoEp	sys/eps/epId-1

nvoEp Properties

Property Name	Data Type	Description	Values
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]
mcastRtSrcIntf	nw:IfId (base:IfIndex)	mcast-routing source interface	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

nvoEp Properties

Property Name	Data Type	Description	Values
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]
mcastRtSrcIntf	nw:IfId (base:IfIndex)	mcast-routing source interface	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

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 Override Source Address of Routed MCAST Packets

Note:

This example was added in Release 9.3(5).
This is only supported on the following platforms:
- N9K-C92160YC-X
- N9K-C92304QC
- N9K-C9272Q
- N9K-C9236C
- N9K-C92300YC
- N9K-C93108TC-EX
- N9K-C93180LC-EX
- N9K-C93180YC-E

CLI Commands

interface nve 1-1
no mcast-routing override source-interface loopback 123

Verifying a DME Configuration

MO	DN
nvoEps	sys/eps
nvoEp	sys/eps/epId-1

nvoEp Properties

Property Name	Data Type	Description	Values
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]
mcastRtSrcIntf	nw:IfId (base:IfIndex)	mcast-routing source interface	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

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 Suppress MAC-Only Route Advertiement

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

CLI Commands

interface nve 1-1
suppress mac-route

Verifying a DME Configuration

MO	DN
nvoEps	sys/eps
nvoEp	sys/eps/epId-1

nvoEp Properties

Property Name	Data Type	Description	Values
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]
suppressMacRoute	scalar:Bool	NO COMMENTS	SELECTION: false - no true - yes DEFAULT: no(false)

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 Suppress MAC-Only Route Advertiement

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

CLI Commands

interface nve 1-1
no suppress mac-route

Verifying a DME Configuration

MO	DN
nvoEps	sys/eps
nvoEp	sys/eps/epId-1

nvoEp Properties

Property Name	Data Type	Description	Values
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]
suppressMacRoute	scalar:Bool	NO COMMENTS	SELECTION: false - no true - yes DEFAULT: no(false)

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 Tunnel Endpoint

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

CLI Commands

interface nve 1-1
member vni 123
peer-vtep 1.2.3.4

Verifying a DME Configuration

MO	DN
nvoEps	sys/eps
nvoEp	sys/eps/epId-1
nvoNws	sys/eps/epId-1/nws
nvoNw	sys/eps/epId-1/nws/vni-123
nvoPeerVtep	sys/eps/epId-1/nws/vni-123/peervtep-[1.2.3.4]

nvoEp Properties

Property Name	Data Type	Description	Values
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]

nvoNw Properties

Property Name	Data Type	Description	Values
isLegacyMode	scalar:Bool	Indicates whether Multicast group configuration for the VNI(s) is configured in legacy mode or not.	SELECTION: true or false
vni	nvo:VniT (scalar:Uint32)	Configure Virtual Network ID	Supported VNI values 1 to 16777214. RANGE: [1 , 16777214]

nvoPeerVtep Properties

The following table contains information about the nvoPeerVtep 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
ip	address:Ip	Configures the IP address for Peer-VTEP.	Value must match ipv4 or ipv6 known format

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 Tunnel Endpoint

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

CLI Commands

interface nve 1-1
member vni 123
no peer-vtep 1.2.3.4

Verifying a DME Configuration

MO	DN
nvoEps	sys/eps
nvoEp	sys/eps/epId-1
nvoNws	sys/eps/epId-1/nws
nvoNw	sys/eps/epId-1/nws/vni-123
nvoPeerVtep	sys/eps/epId-1/nws/vni-123/peervtep-[1.2.3.4]

nvoEp Properties

Property Name	Data Type	Description	Values
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]

nvoNw Properties

Property Name	Data Type	Description	Values
isLegacyMode	scalar:Bool	Indicates whether Multicast group configuration for the VNI(s) is configured in legacy mode or not.	SELECTION: true or false
vni	nvo:VniT (scalar:Uint32)	Configure Virtual Network ID	Supported VNI values 1 to 16777214. RANGE: [1 , 16777214]

nvoPeerVtep Properties

Property Name	Data Type	Description	Values
ip	address:Ip	Configures the IP address for Peer-VTEP.	Value must match ipv4 or ipv6 known format
status	mo: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

Configuring Spine Anycast Gateway

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

CLI Commands

interface nve 1-1
member vni 123
spine-anycast-gateway

Verifying a DME Configuration

MO	DN
nvoEps	sys/eps
nvoEp	sys/eps/epId-1
nvoNws	sys/eps/epId-1/nws
nvoNw	sys/eps/epId-1/nws/vni-123

nvoEp Properties

Property Name	Data Type	Description	Values
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]

nvoNw Properties

Property Name	Data Type	Description	Values
isLegacyMode	scalar:Bool	Indicates whether Multicast group configuration for the VNI(s) is configured in legacy mode or not.	SELECTION: true or false
spineAnyCastGw	scalar:Bool	NO COMMENTS	SELECTION: false - no true - yes DEFAULT: no(false)
vni	nvo:VniT (scalar:Uint32)	Configure Virtual Network ID	Supported VNI values 1 to 16777214. RANGE: [1 , 16777214]

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 Spine Anycast Gateway

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

CLI Commands

interface nve 1-1
member vni 123
no spine-anycast-gateway

Verifying a DME Configuration

MO	DN
nvoEps	sys/eps
nvoEp	sys/eps/epId-1
nvoNws	sys/eps/epId-1/nws
nvoNw	sys/eps/epId-1/nws/vni-123

nvoEp Properties

Property Name	Data Type	Description	Values
epId	nvo:EpIdT (scalar:Uint32)	Network Virtualization Overlay Endpoint (NVE) ID	Supported values for N9000 Family is 1. RANGE: [0, 4294967295]

nvoNw Properties

Property Name	Data Type	Description	Values
isLegacyMode	scalar:Bool	Indicates whether Multicast group configuration for the VNI(s) is configured in legacy mode or not.	SELECTION: true or false
spineAnyCastGw	scalar:Bool	NO COMMENTS	SELECTION: false - no true - yes DEFAULT: no(false)
vni	nvo:VniT (scalar:Uint32)	Configure Virtual Network ID	Supported VNI values 1 to 16777214. RANGE: [1 , 16777214]

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