Configuring NVE Interfaces

Configuring BGP as the Ingress Replication Protocol

Configuring BGP as the Ingress Replication Protocol

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1",
            "ingressReplProtoBGP": "yes"
}}}]}}

{
    imdata:[]
}

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

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

Deleting BGP as the Ingress Replication Protocol

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1",
            "ingressReplProtoBGP": "no"
}}}]}}

{
    imdata:[]
}

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

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

Configuring ARP Suppression for NVE

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1",
            "suppressARP": "yes"
}}}]}}

{
    imdata:[]
}

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

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

Deleting ARP Suppression for NVE

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1",
            "suppressARP": "no"
}}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <suppressARP>false</suppressARP>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

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

Configuring a Global Multicast Group for L2 VNIs

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1",
            "mcastGroupL2": "234.255.255.250"
}}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <mcastGroupL2>234.255.255.250</mcastGroupL2>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

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

Deleting a Global Multicast Group for L2 VNIs

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1",
            "mcastGroupL2": "0.0.0.0"
}}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <mcastGroupL2>0.0.0.0</mcastGroupL2>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

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

Configuring a Global Multicast Group for L3 VNIs

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1",
            "mcastGroupL3": "234.255.255.250"
}}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <mcastGroupL3>234.255.255.250</mcastGroupL3>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

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

Deleting a Global Multicast Group for L3 VNIs

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1",
            "mcastGroupL3": "0.0.0.0"
}}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <mcastGroupL3>0.0.0.0</mcastGroupL3>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

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

Configuring a Description

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "descr": "SampleString_123",
            "epId": "1"
}}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <descr>SampleString_123</descr>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

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

Deleting a Description

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "descr": "",
            "epId": "1"
}}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <descr></descr>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

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

Configuring an NVE Multicast Group

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1"
          },
          "children": [
            {
              "nvoNws": {
                "children": [
                  {
                    "nvoNw": {
                      "attributes": {
                        "cfgSrc": "cli",
                        "isLegacyMode": "yes",
                        "mcastGroup": "231.1.1.1",
                        "vni": "123"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <nws-items>
          <vni-items>
            <Nw-list>
              <vni>123</vni>
              <cfgSrc>cli</cfgSrc>
              <isLegacyMode>true</isLegacyMode>
              <mcastGroup>231.1.1.1</mcastGroup>
            </Nw-list>
          </vni-items>
        </nws-items>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

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

Deleting an NVE Multicast Group

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1"
          },
          "children": [
            {
              "nvoNws": {
                "children": [
                  {
                    "nvoNw": {
                      "attributes": {
                        "status": "deleted",
                        "vni": "123"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <nws-items>
          <vni-items>
            <Nw-list nc:operation="delete">
              <vni>123</vni>
            </Nw-list>
          </vni-items>
        </nws-items>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

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

Configuring a Static Virtual RMAC

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1",
            "virtualMac": "D8:B1:90:71:E9:03"
}}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <virtualMac>D8:B1:90:71:E9:03</virtualMac>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

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

Deleting a Static Virtual RMAC

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1",
            "virtualMac": "00:00:00:00:00:00"
}}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <virtualMac>00:00:00:00:00:00</virtualMac>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

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

Configuring a Global Multicast Group for L2 VNIs

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1",
            "mcastGroupL2": "231.1.1.1"
}}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <mcastGroupL2>231.1.1.1</mcastGroupL2>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

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

Deleting a Global Multicast Group for L2 VNIs

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1",
            "mcastGroupL2": "0.0.0.0"
}}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <mcastGroupL2>0.0.0.0</mcastGroupL2>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

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

Configuring a Global Multicast Group for L3 VNIs

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1",
            "mcastGroupL3": "231.1.1.1"
}}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <mcastGroupL3>231.1.1.1</mcastGroupL3>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

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

Deleting a Multicast Group for L3 VNIs

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1",
            "mcastGroupL3": "0.0.0.0"
}}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <mcastGroupL3>0.0.0.0</mcastGroupL3>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

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

Configuring an Anycast Loopback Interface

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "anycastIntf": "lo123",
            "epId": "1",
            "sourceInterface": "lo123"
}}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <anycastIntf>lo123</anycastIntf>
        <sourceInterface>lo123</sourceInterface>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

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

Deleting an Anycast Loopback Interface

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "anycastIntf": "unspecified",
            "epId": "1",
            "sourceInterface": "unspecified"
}}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <anycastIntf>unspecified</anycastIntf>
        <sourceInterface>unspecified</sourceInterface>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

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

Configuring a Hold Source Loopback Down Time

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1",
            "holdDownTime": "123"
}}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <holdDownTime>123</holdDownTime>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

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

Deleting a Hold Source Loopback Down Time

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1",
            "holdDownTime": "180"
}}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <holdDownTime>180</holdDownTime>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

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

Configuring the Override Source Address of Routed MCAST Packets

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1",
            "mcastRtSrcIntf": "lo123"
}}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <mcastRtSrcIntf>lo123</mcastRtSrcIntf>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

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

Deleting the Override Source Address of Routed MCAST Packets

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1",
            "mcastRtSrcIntf": "unspecified"
}}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <mcastRtSrcIntf>unspecified</mcastRtSrcIntf>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

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

Configuring Suppress MAC-Only Route Advertiement

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1",
            "suppressMacRoute": "yes"
}}}]}}

{
    imdata:[]
}

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

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

Deleting Suppress MAC-Only Route Advertiement

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1",
            "suppressMacRoute": "no"
}}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <suppressMacRoute>false</suppressMacRoute>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

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

Configuring a Tunnel Endpoint

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1"
          },
          "children": [
            {
              "nvoNws": {
                "children": [
                  {
                    "nvoNw": {
                      "attributes": {
                        "isLegacyMode": "no",
                        "vni": "123"
                      },
                      "children": [
                        {
                          "nvoPeerVtep": {
                            "attributes": {
                              "ip": "1.2.3.4"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <nws-items>
          <vni-items>
            <Nw-list>
              <vni>123</vni>
              <isLegacyMode>false</isLegacyMode>
              <peervtep-items>
                <PeerVtep-list>
                  <ip>1.2.3.4</ip>
                </PeerVtep-list>
              </peervtep-items>
            </Nw-list>
          </vni-items>
        </nws-items>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

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

Deleting a Tunnel Endpoint

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1"
          },
          "children": [
            {
              "nvoNws": {
                "children": [
                  {
                    "nvoNw": {
                      "attributes": {
                        "isLegacyMode": "no",
                        "vni": "123"
                      },
                      "children": [
                        {
                          "nvoPeerVtep": {
                            "attributes": {
                              "ip": "1.2.3.4",
                              "status": "deleted"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <nws-items>
          <vni-items>
            <Nw-list>
              <vni>123</vni>
              <isLegacyMode>false</isLegacyMode>
              <peervtep-items>
                <PeerVtep-list nc:operation="delete">
                  <ip>1.2.3.4</ip>
                </PeerVtep-list>
              </peervtep-items>
            </Nw-list>
          </vni-items>
        </nws-items>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

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

Configuring Spine Anycast Gateway

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1",
            "hostReach": "bgp"
          },
          "children": [
            {
              "nvoNws": {
                "children": [
                  {
                    "nvoNw": {
                      "attributes": {
                        "isLegacyMode": "no",
                        "spineAnyCastGw": "yes",
                        "vni": "123"
}}}]}}]}}]}}

{
    imdata:[]
}

  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <hostReach>bgp</hostReach>
        <nws-items>
          <vni-items>
            <Nw-list>
              <vni>123</vni>
              <isLegacyMode>false</isLegacyMode>
              <spineAnyCastGw>true</spineAnyCastGw>
            </Nw-list>
          </vni-items>
        </nws-items>
      </Ep-list>
    </epId-items>
  </eps-items>

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

Deleting Spine Anycast Gateway

POST http://<mgmt0_IP>/api/mo/sys/eps.json

{
  "nvoEps": {
    "children": [
      {
        "nvoEp": {
          "attributes": {
            "epId": "1"
          },
          "children": [
            {
              "nvoNws": {
                "children": [
                  {
                    "nvoNw": {
                      "attributes": {
                        "isLegacyMode": "no",
                        "spineAnyCastGw": "no",
                        "vni": "123"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <nws-items>
          <vni-items>
            <Nw-list>
              <vni>123</vni>
              <isLegacyMode>false</isLegacyMode>
              <spineAnyCastGw>false</spineAnyCastGw>
            </Nw-list>
          </vni-items>
        </nws-items>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

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