VXLAN Configuration Command Examples

This section contains payload examples and CLIs to demonstrate how to use NX-API REST to configure VXLAN on Cisco Nexus 3000 and 9000 Series switches and to show how the REST APIs correspond to the CLI commands. For more information, see the Cisco Nexus 9000 Series NX-OS VXLAN Configuration Guide.

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

Configuring VLAN and VXLAN VNI

Configuring VLAN and VXLAN VNI

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

{
 "bdEntity": {
   "children": [
     {
       "l2BD": {
         "attributes": {
           "accEncap": "vxlan-90001",
           "fabEncap": "vlan-123",
           "pcTag": "1"
}}}]}}

{
    imdata:[]
}

<System>
  <bd-items>
    <bd-items>
      <BD-list>
        <fabEncap>vlan-123</fabEncap>
        <accEncap>vxlan-90001</accEncap>
        <pcTag>1</pcTag>
      </BD-list>
    </bd-items>
  </bd-items>
</System>

This operation specifies a VLAN and maps the VLAN to a VXLAN VNI to configure Layer 2 VNI under VXLAN VLAN. This creates a VRF overlay VLAN for VXLAN routing.

CLI Commands

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

vlan 123
vn-segment 90001

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
bdEntity	sys/bd
l2BD	sys/bd/bd-{[fabEncap]}

l2BD Properties

The following table contains information about the l2BD 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
accEncap	base:Encap	The Layer 2 access encapsulation (VLAN or VNID).	SELECTION: unknown, vlan-%d or vxlan-%d
fabEncap	base:Encap	The Layer 2 bridge-domain Fabric encapsulation (VNID).	SELECTION: unknown, vlan-%d or vxlan-%d
pcTag	actrl:PcTag scalar:Uint32	The default classId for the unknown Unicast traffic terminating on the L2 bridge-domain.	SELECTION: 0u - any DEFAULT: 0

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 SVI for Hosts for VXLAN Routing

Configuring SVI for Hosts for VXLAN Routing

POST http://<IP_Address>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "ipv4Entity": {
          "children": [
            {
              "ipv4Inst": {
                "children": [
                  {
                    "ipv4Dom": {
                      "attributes": {
                        "name": "vxlan-90001"
                      },
                      "children": [
                        {
                          "ipv4If": {
                            "attributes": {
                              "id": "vlan123"
                            },
                            "children": [
                              {
                                "ipv4Addr": {
                                  "attributes": {
                                    "addr": "192.0.20.16/24"
}}}]}}]}}]}}]}},
      {
        "interfaceEntity": {
          "children": [
            {
              "sviIf": {
                "attributes": {
                  "id": "vlan123"
                },
                "children": [
                  {
                    "nwRtVrfMbr": {
                      "attributes": {
                        "tDn": "sys/inst-vxlan-90001"
}}}]}}]}},
      {
        "bdEntity": {
          "children": [
            {
              "l2BD": {
                "attributes": {
                  "fabEncap": "vlan-123",
                  "pcTag": "1"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <ipv4-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>vxlan-90001</name>
          <if-items>
            <If-list>
              <id>vlan123</id>
              <addr-items>
                <Addr-list>
                  <addr>192.0.20.16/24</addr>
                </Addr-list>
              </addr-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </ipv4-items>
  <intf-items>
    <svi-items>
      <If-list>
        <id>vlan123</id>
        <rtvrfMbr-items>
          <tDn>/System/inst-items/Inst-list[name='vxlan-90001']</tDn>
        </rtvrfMbr-items>
      </If-list>
    </svi-items>
  </intf-items>
</System>

This operation configures SVI and an IP address on a VLAN for a host.

CLI Commands

interface vlan123
vrf member vxlan-90001
ip address 192.0.20.16/24

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

MO	DN
topSystem	sys
ipv4Entity	sys/ipv4
ipv4Inst	sys/ipv4/inst
ipv4Dom	sys/ipv4/inst/dom-{name}
ipv4If	sys/ipv4/inst/dom-{name}/if-{[id]}
ipv4Addr	sys/ipv4/inst/dom-{name}/if-{[id]}/addr-{[addr]}
interfaceEntity	sys/intf
sviIf	sys/intf/svi-{[id]}
bdEntity	sys/bd
l2BD	sys/bd/bd-{[fabEncap]}

ipv4Dom Properties

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

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

ipv4If Properties

The following table contains information about the ipv4If 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
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

ipv4Addr Properties

The following table contains information about the ipv4Addr 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
addr	address:Ip	Address	Value must match ipv4 or ipv6 known format

sviIf Properties

The following table contains information about the sviIf 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
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

nwRtVrfMbr Properties

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

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

l2BD Properties

Property Name	Data Type	Description	Values
fabEncap	base:Encap	The Layer 2 bridge-domain Fabric encapsulation (VNID).	SELECTION: unknown, vlan-%d or vxlan-%d
pcTag	actrl:PcTag scalar:Uint32	The default classId for the unknown Unicast traffic terminating on the L2 bridge-domain.	SELECTION: 0u - any DEFAULT: 0

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 VNI Under VRF for VXLAN Routing

This operation configures a Layer 3 VNI under a VRF overlay VLAN. (A VRF overlay VLAN is a VLAN that is not associated with any server facing ports. All VXLAN VNIs that are mapped to a VRF, need to have their own internal VLANs allocated to it.)

Configuring VNI Under VRF for VXLAN Routing

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

{
  "topSystem": {
    "children": [
      {
        "l3Inst": {
          "attributes": {
            "encap": "vxlan-90005",
            "name": "vxlan-90001"
}}}]}}

{
    imdata:[]
}

<System>
  <inst-items>
    <Inst-list>
      <name>vxlan-90001</name>
      <encap>vxlan-90005</encap>
    </Inst-list>
  </inst-items>
</System>

CLI Commands

vrf context vxlan-90001
vni 90005

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

MO	DN
topSystem	sys
l3Inst	sys/inst-{name}

l3Inst Properties

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

Property Name	Data Type	Description	Values
encap	base:Encap	Encap for this Context	SELECTION: unknown, vlan-%d or vxlan-%d
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 128

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

Configuring anycast gateway MAC

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

{
  "hmmEntity": {
    "children": [
      {
        "hmmFwdInst": {
          "attributes": {
            "amac": "CA:BB:D3:69:0C:60"
}}}]}}

{
    imdata:[]
}

<System>
  <hmm-items>
    <fwdinst-items>
      <amac>CA:BB:D3:69:0C:60</amac>
    </fwdinst-items>
  </hmm-items>
</System>

Configures anycast gateway MAC of the switch.

CLI Command

The CLI command below is the equivalent to the payload example displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload or the YANG tab to view the XML payload.

fabric forwarding anycast-gateway-mac cabb.d369.0c60

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

MO	DN
hmmEntity	sys/hmm
hmmFwdInst	sys/hmm/fwdinst

hmmFwdInst Properties

The following table contains information about the hmmFwdInst 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
amac	address:MAC	Anycast Gateway MAC address.	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 an Anycast Gateway for VXLAN Routing

This operation configures a distributed gateway virtual MAC address and associates the SVI with the anycast gateway.

Configuring an Anycast Gateway for VXLAN Routing

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

{
  "topSystem": {
    "children": [
      {
        "hmmEntity": {
          "children": [
            {
              "hmmFwdInst": {
                "attributes": {
                  "amac": "00:01:00:02:00:03"
                },
                "children": [
                  {
                    "hmmFwdIf": {
                      "attributes": {
                        "id": "vlan123",
                        "mode": "anycastGW"
}}}]}}]}},{
        "interfaceEntity": {
          "children": [
            {
              "sviIf": {
                "attributes": {
                  "id": "vlan123"
}}}]}},{
        "fmEntity": {
          "children": [
            {
              "fmInterfaceVlan": {
                "attributes": {
                  "adminSt": "enabled"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <hmm-items>
    <fwdinst-items>
      <amac>00:01:00:02:00:03</amac>
      <if-items>
        <FwdIf-list>
          <id>vlan123</id>
          <mode>anycastGW</mode>
        </FwdIf-list>
      </if-items>
    </fwdinst-items>
  </hmm-items>
  <intf-items>
    <svi-items>
      <If-list>
        <id>vlan123</id>
      </If-list>
    </svi-items>
  </intf-items>
  <fm-items>
    <ifvlan-items>
      <adminSt>enabled</adminSt>
    </ifvlan-items>
  </fm-items>
</System>

CLI Commands

feature interface-vlan
fabric forwarding anycast-gateway-mac 1.2.3
interface vlan123
fabric forwarding mode anycast-gateway

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

MO	DN
topSystem	sys
hmmEntity	sys/hmm
hmmFwdInst	sys/hmm/fwdinst
hmmFwdIf	sys/hmm/fwdinst/if-{[id]}
interfaceEntity	sys/intf
sviIf	sys/intf/svi-{[id]}
fmEntity	sys/fm
fmInterfaceVlan	sys/fm/ifvlan

hmmFwdInst Properties

Property Name	Data Type	Description	Values
amac	address:MAC	Anycast Gateway MAC address.	Value must match MM:MM:MM:SS:SS:SS format

hmmFwdIf Properties

The following table contains information about the hmmFwdIf 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
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
mode	hmm:FwdMode (scalar:Enum8)	HMM Fabric Forwarding mode information for the interface.	SELECTION: 0 - standard 1 - anycastGW 2 - proxyGW DEFAULT: standard

sviIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

fmInterfaceVlan Properties

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

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

Related Documentation

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

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

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

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

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

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

Configuring the NVE Interface and VNIs

Configuring the NVE Interface and VNIs

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

{
  "topSystem": {
    "children": [
      {
        "nvoEps": {
          "children": [
            {
              "nvoEp": {
                "attributes": {
                  "epId": "1",
                  "hostReach": "bgp",
                  "sourceInterface": "lo2"
},
"children": [
  {
    "nvoNws": {
      "children": [
        {
          "nvoNwRange": {
            "attributes": {
              "isLegacyMode": "no",
              "isMcastRange": "no",
              "mcastGroup": "225.4.0.1",
              "suppressARP": "no",
              "vniRangeMax": "5008",
              "vniRangeMin": "5000"
}}},{
  "nvoNw": {
    "attributes": {
      "isLegacyMode": "no",
      "vni": "4001"
    },
"children": [
  {
    "nvoIngRepl": {
      "attributes": {
        "proto": "bgp"
}}}]}},{
 "nvoNw": {
    "attributes": {
       "isLegacyMode": "no",
        "vni": "5000"
},
"children": [
{
"nvoIngRepl": {
   "attributes": {
      "proto": "static"
},
"children": [
  {
     "nvoConfigStIRPeer": {
       "attributes": {
         "ip": "1.1.1.1"
}}}]}}]}},{
  "nvoNw": {
    "attributes": {
      "associateVrfFlag": "yes",
      "isLegacyMode": "no",
      "vni": "90003"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <epId-items>
      <Ep-list>
        <epId>1</epId>
        <hostReach>bgp</hostReach>
        <sourceInterface>lo2</sourceInterface>
        <nws-items>
          <vni-items>
            <Nw-list>
              <vni>4001</vni>
              <isLegacyMode>false</isLegacyMode>
              <IngRepl-items>
                <proto>bgp</proto>
              </IngRepl-items>
            </Nw-list>
            <Nw-list>
              <vni>90003</vni>
              <associateVrfFlag>true</associateVrfFlag>
              <isLegacyMode>false</isLegacyMode>
            </Nw-list>
          </vni-items>
          <vnis-items>
            <NwRange-list>
              <vniRangeMin>5000</vniRangeMin>
              <vniRangeMax>5008</vniRangeMax>
              <isLegacyMode>false</isLegacyMode>
              <isMcastRange>false</isMcastRange>
              <mcastGroup>225.4.0.1</mcastGroup>
             <suppressARP>false</suppressARP> 
            </NwRange-list>
          </vnis-items>
        </nws-items>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

This operation performs the following configuration:

Configures a network virtualization edge (NVE) interface, which is the overlay interface that terminates VXLAN tunnels (only 1 NVE interface is allowed on the switch)
Defines BGP as the mechanism for host reachability advertisement
Adds an Layer 3 VNI to the overlay for a tenant VRF (required for VXLAN routing only)
Adds a Layer 2 VNI to the tunnel interface
Configures the multicast group on a per-VNI basis

CLI Commands

Static VNIs can only be configured without a host-reach BGP config.

interface nve 1
source-interface loopback 2
host-reachability protocol bgp
member vni 5000-5008 mcast-group 225.4.0.1
member vni 90003 associate-vrf
member vni 4001
ingress-replication protocol bgp

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

MO	DN
topSystem	sys
nvoEps	sys/eps
nvoEp	sys/eps/epId-{epId}
nvoNws	sys/eps/epId-{epId}/nws
nvoNwRange	sys/eps/epId-{epId}/nws/vnis-{vniRangeMin}-{vniRangeMax}
nvoNw	sys/eps/epId-{epId}/nws/vni-{vni}
nvoIngRepl	sys/eps/epId-{epId}/nws/vnis-{vniRangeMin}-{vniRangeMax}/IngRepl
nvoConfigStIRPeer	sys/eps/epId-{epId}/nws/vnis-{vniRangeMin}-{vniRangeMax}/IngRepl/config_st_ir_peer-{ip}

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]
hostReach	nvo:HostReachT (scalar:Enum16)	Host Reachability Protocol.	Supported modes are bgp or controller. SELECTION: 0 - Flood-and-learn 1 - bgp 2 - controller 3 - openflow 4 - openflowIR DEFAULT: 0
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

nvoNwRange Properties

The following table contains information about the nvoNwRange 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
isLegacyMode	scalar:Bool	Indicates whether Multicast group configuration for the VNI(s) is configured in legacy mode or not.	SELECTION: true or false
isMcastRange	scalar:Bool	Indicates if the multicast group configuration is a range.	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
suppressARP	nvo:SuppressARPT (scalar:Enum16)	Enable or disable ARP suppression for VNI(s).	SELECTION: 0 - off 1 - enabled 2 - disabled DEFAULT: off
vniRangeMax	nvo:VniT (scalar:Uint32)	Configures the maximum value for the VNI range.	RANGE: [1 , 16777215]
vniRangeMin	nvo:VniT (scalar:Uint32)	Configures the minimum value for the VNI range.	Supported VNI range between 1 to 16777214. RANGE: [1 , 16777215]

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
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 , 16777215]

nvoIngRepl Properties

The following table contains information about the nvoIngRepl 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
proto	nvo:IngReplProtoT (scalar:Enum16)	Configure VxLAN Ingress Replication mode.	Supported IR modes are BGP and static. SELECTION: 0 - unknown 1 - bgp 2 - static DEFAULT: unknown

nvoConfigStIRPeer Properties

The following table contains information about the nvoConfigStIRPeer 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:IPv4	Peer IP configuration for Static IR Peer.	Supports unicast IPv4 addresses. Value must match ipv4 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 the Advertising of Virtual RMAC Capability for the VNI Member of an NVE Interface

Configuring the Advertising of Virtual RMAC Capability for the VNI Member of an NVE Interface

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

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

{
    imdata:[]
}

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

This is supported on the following switches:

N9K-C93180LC-EX
N9K-N9K-93180YC-EX
N9K-N9K-C93108TC-EX

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
member vni 123
advertise virtual-rmac

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

MO	DN
nvoEps	sys/eps
nvoEp	sys/eps/epId-{epId}
nvoNws	sys/eps/epId-{epId}/nws
nvoNw	sys/eps/epId-{epId}/nws/vni-{vni}

nvoEp Properties

Property Name	Data Type	Description	Values
advertiseVmac	scalar:Bool	Enable or disable Virtual MAC Advertisement in VPC mode.	SELECTION: true or false DEFAULT: 0
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 , 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 the Advertising of Virtual RMAC Capability for the VNI Member of an NVE Interface

Deleting the Advertising of Virtual RMAC Capability for the VNI Member of an NVE Interface

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

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

{
    imdata:[]
}

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

This is supported on the following switches:

N9K-C93180LC-EX
N9K-N9K-93180YC-EX
N9K-N9K-C93108TC-EX

CLI Commands

interface nve 1-1
member vni 123
no advertise virtual-rmac

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

MO	DN
nvoEps	sys/eps
nvoEp	sys/eps/epId-{epId}
nvoNws	sys/eps/epId-{epId}/nws
nvoNw	sys/eps/epId-{epId}/nws/vni-{vni}

nvoEp Properties

Property Name	Data Type	Description	Values
advertiseVmac	scalar:Bool	Enable or disable Virtual MAC Advertisement in VPC mode.	SELECTION: true or false DEFAULT: 0
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 , 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 Multisite Border-Gateway Interface for the VNI Member of an NVE Interface

Configuring a Multisite Border-Gateway Interface for the VNI Member of an NVE Interface

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

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

{
    imdata:[]
}

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

This is supported on the following switches:

N9K-C93180LC-EX
N9K-N9K-93180YC-EX
N9K-N9K-C93108TC-EX

CLI Commands

interface nve 1-1
member vni 123
multisite border-gateway interface loopback 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}
nvoNws	sys/eps/epId-{epId}/nws
nvoNw	sys/eps/epId-{epId}/nws/vni-{vni}

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]
multisiteBordergwInterface	nw:IfId (base:IfIndex)	Interface representing the Multisite Border Gateway.	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

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 , 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 a Multisite Border-Gateway Interface for the VNI Member of an NVE Interface

Deleting a Multisite Border-Gateway Interface for the VNI Member of an NVE Interface

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

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

{
    imdata:[]
}

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

This is supported on the following switches:

N9K-C93180LC-EX
N9K-N9K-93180YC-EX
N9K-N9K-C93108TC-EX

CLI Commands

interface nve 1-1
member vni 123
no multisite border-gateway interface loopback 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}
nvoNws	sys/eps/epId-{epId}/nws
nvoNw	sys/eps/epId-{epId}/nws/vni-{vni}

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]
multisiteBordergwInterface	nw:IfId (base:IfIndex)	Interface representing the Multisite Border Gateway.	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

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 , 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 Multisite Ingress Replication for the VNI Member of an NVE Interface

Configuring Multisite Ingress Replication for the VNI Member of an NVE Interface

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

{
  "nvoEps": {
    "children": [
{
"nvoEp": {
  "attributes": {
    "epId": "1"
},
"children": [
{
  "nvoNws": {
    "children": [
      {
        "nvoNw": {
          "attributes": {
            "isLegacyMode": "no",
            "multisiteIngRepl": "enable",
            "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>
              <multisiteIngRepl>enable</multisiteIngRepl>
            </Nw-list>
          </vni-items>
        </nws-items>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

This is supported on the following switches:

N9K-C93180LC-EX
N9K-N9K-93180YC-EX
N9K-N9K-C93108TC-EX

CLI Commands

interface nve 1-1
member vni 123
multisite ingress-replication

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

MO	DN
nvoEps	sys/eps
nvoEp	sys/eps/epId-{epId}
nvoNws	sys/eps/epId-{epId}/nws
nvoNw	sys/eps/epId-{epId}/nws/vni-{vni}

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
multisiteIngRepl	nvo:MultisiteIngReplStateT (scalar:Enum16)	Enable or disable Multisite Ingress Replication for VNI(s).	SELECTION: 1 - disable 2 - enable 3 - enableOptimized DEFAULT: disable
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 Multisite Ingress Replication for the VNI Member of an NVE Interface

Deleting Multisite Ingress Replication for the VNI Member of an NVE Interface

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

{
  "nvoEps": {
    "children": [
{
"nvoEp": {
  "attributes": {
    "epId": "1"
},
"children": [
{
  "nvoNws": {
    "children": [
      {
        "nvoNw": {
          "attributes": {
            "isLegacyMode": "no",
            "multisiteIngRepl": "disable",
            "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>
              <multisiteIngRepl>disable</multisiteIngRepl>
            </Nw-list>
          </vni-items>
        </nws-items>
      </Ep-list>
    </epId-items>
  </eps-items>
</System>

This is supported on the following switches:

N9K-C93180LC-EX
N9K-N9K-93180YC-EX
N9K-N9K-C93108TC-EX

CLI Commands

interface nve 1-1
member vni 123
no multisite ingress-replication

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

MO	DN
nvoEps	sys/eps
nvoEp	sys/eps/epId-{epId}
nvoNws	sys/eps/epId-{epId}/nws
nvoNw	sys/eps/epId-{epId}/nws/vni-{vni}

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
multisiteIngRepl	nvo:MultisiteIngReplStateT (scalar:Enum16)	Enable or disable Multisite Ingress Replication for VNI(s).	SELECTION: 1 - disable 2 - enable 3 - enableOptimized DEFAULT: disable
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

Enabling an EVPN Multisite Border Gateway

Enabling an EVPN Multisite Border Gateway

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

{
"nvoEps": {
  "children": [
    {
      "nvoEvpnMultisiteBordergw": {
        "attributes": {
          "siteId": "123",
          "state": "enabled"
}}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <multisite-items>
      <siteId>123</siteId>
      <state>enabled</state>
    </multisite-items>
  </eps-items>
</System>

This is supported on the following switches:

N9K-C93180LC-EX
N9K-N9K-93180YC-EX
N9K-N9K-C93108TC-EX

CLI Commands

evpn multisite border-gateway 123

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

MO	DN
nvoEps	sys/eps
nvoEvpnMultisiteBordergw	sys/eps/multisite

nvoEvpnMultisiteBordergw Properties

The following table contains information about the nvoEvpnMultisiteBordergw 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
siteId	scalar:Uint64	Configuration of EVPN Multisite Border Gateway.	Supported values are 1 to 281474976710655. RANGE: [0, 18446744073709551615]
state	nvo:MultisiteStateT (scalar:Enum16)	Configures the state of EVPN Multisite Border-gateway.	SELECTION: 1 - enabled DEFAULT: enabled

Related Documentation

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

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

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

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

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

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

Disabling an EVPN Multisite Border Gateway

Disabling an EVPN Multisite Border Gateway

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

{
"nvoEps": {
  "children": [
    {
      "nvoEvpnMultisiteBordergw": {
        "attributes": {
          "status": "deleted"
}}}]}}

{
    imdata:[]
}

<System>
  <eps-items>
    <multisite-items xc:operation="delete">
    </multisite-items>
  </eps-items>
</System>

This is supported on the following switches:

N9K-C93180LC-EX
N9K-N9K-93180YC-EX
N9K-N9K-C93108TC-EX

CLI Commands

no evpn multisite border-gateway

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

MO	DN
nvoEps	sys/eps
nvoEvpnMultisiteBordergw	sys/eps/multisite

nvoEvpnMultisiteBordergw Properties

Property Name	Data Type	Description	Values
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

Enabling EVPN Multisite DCI Tracking on an Ethernet Interface

Enabling EVPN Multisite DCI Tracking on an Ethernet Interface

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

{
"interfaceEntity": {
  "children": [
    {
      "l1PhysIf": {
        "attributes": {
          "id": "eth1/3"
        },
        "children": [
          {
            "nvoMultisiteIfTracking": {
              "attributes": {
                "tracking": "dci"

}}}]}}]}}

{
    imdata:[]
}

<System>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/3</id>
        <multisiteiftracking-items>
          <tracking>dci</tracking>
        </multisiteiftracking-items>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

This is supported on the following switches:

N9K-C93180LC-EX
N9K-N9K-93180YC-EX
N9K-N9K-C93108TC-EX

CLI Commands

interface ethernet 1/3
evpn multisite dci-tracking

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

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-{[id]}
nvoMultisiteIfTracking	sys/intf/svi-{[id]}/multisiteiftracking

l1PhysIf Properties

The following table contains information about the l1PhysIf 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
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

nvoMultisiteIfTracking Properties

The following table contains information about the nvoMultisiteIfTracking 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
tracking	nvo:MultisiteTrackingT (scalar:Enum16)	Configure EVPN multisite tracking for DCI/Fabric interface.	SELECTION: 0 - unknown 1 - dci 2 - fabric DEFAULT: unknown

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

Disabling EVPN Multisite DCI Tracking on an Ethernet Interface

Disabling EVPN Multisite DCI Tracking on an Ethernet Interface

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

{
"interfaceEntity": {
  "children": [
    {
      "l1PhysIf": {
        "attributes": {
          "id": "eth1/3"
        },
        "children": [
          {
            "nvoMultisiteIfTracking": {
              "attributes": {
                "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/3</id>
        <multisiteiftracking-items xc:operation="delete">
        </multisiteiftracking-items>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

This is supported on the following switches:

N9K-C93180LC-EX
N9K-N9K-93180YC-EX
N9K-N9K-C93108TC-EX

CLI Commands

interface ethernet 1/3
no evpn multisite dci-tracking

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

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-{[id]}
nvoMultisiteIfTracking	sys/intf/svi-{[id]}/multisiteiftracking

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

nvoMultisiteIfTracking Properties

Property Name	Data Type	Description	Values
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

Enabling EVPN Multisite Fabric Tracking on an Ethernet Interface

Enabling EVPN Multisite Fabric Tracking on an Ethernet Interface

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

{
"interfaceEntity": {
  "children": [
    {
      "l1PhysIf": {
        "attributes": {
          "id": "eth1/3"
        },
        "children": [
          {
            "nvoMultisiteIfTracking": {
              "attributes": {
                "tracking": "fabric"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/3</id>
        <multisiteiftracking-items>
          <tracking>fabric</tracking>
        </multisiteiftracking-items>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

This is supported on the following switches:

N9K-C93180LC-EX
N9K-N9K-93180YC-EX
N9K-N9K-C93108TC-EX

CLI Commands

interface ethernet 1/3
evpn multisite fabric-tracking

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

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-{[id]}
nvoMultisiteIfTracking	sys/intf/svi-{[id]}/multisiteiftracking

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

nvoMultisiteIfTracking Properties

Property Name	Data Type	Description	Values
tracking	nvo:MultisiteTrackingT (scalar:Enum16)	Configure EVPN multisite tracking for DCI/Fabric interface.	SELECTION: 0 - unknown 1 - dci 2 - fabric DEFAULT: unknown

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

Disabling EVPN Multisite Fabric Tracking on an Ethernet Interface

Disabling EVPN Multisite Fabric Tracking on an Ethernet Interface

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

{
"interfaceEntity": {
  "children": [
    {
      "l1PhysIf": {
        "attributes": {
          "id": "eth1/3"
        },
        "children": [
          {
            "nvoMultisiteIfTracking": {
              "attributes": {
                "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/3</id>
        <multisiteiftracking-items xc:operation="delete">
        </multisiteiftracking-items>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

This is supported on the following switches:

N9K-C93180LC-EX
N9K-N9K-93180YC-EX
N9K-N9K-C93108TC-EX

CLI Commands

interface ethernet 1/3
no evpn multisite fabric-tracking

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

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-{[id]}
nvoMultisiteIfTracking	sys/intf/svi-{[id]}/multisiteiftracking

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

nvoMultisiteIfTracking Properties

Property Name	Data Type	Description	Values
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

Enabling EVPN Multisite DCI Tracking on a Port-Channel Interface

Enabling EVPN Multisite DCI Tracking on a Port-Channel Interface

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

{
"interfaceEntity": {
  "children": [
    {
      "pcAggrIf": {
        "attributes": {
          "id": "po123"
        },
        "children": [
          {
            "nvoMultisiteIfTracking": {
              "attributes": {
                "tracking": "dci"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <intf-items>
    <aggr-items>
      <AggrIf-list>
        <id>po123</id>
        <multisiteiftracking-items>
          <tracking>dci</tracking>
        </multisiteiftracking-items>
      </AggrIf-list>
    </aggr-items>
  </intf-items>
</System>

This is supported on the following switches:

N9K-C93180LC-EX
N9K-N9K-93180YC-EX
N9K-N9K-C93108TC-EX

CLI Commands

interface port-channel 123
evpn multisite dci-tracking

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

MO	DN
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-{[id]}
nvoMultisiteIfTracking	sys/intf/svi-{[id]}/multisiteiftracking

pcAggrIf Properties

The following table contains information about the pcAggrIf 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
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

nvoMultisiteIfTracking Properties

Property Name	Data Type	Description	Values
tracking	nvo:MultisiteTrackingT (scalar:Enum16)	Configure EVPN multisite tracking for DCI/Fabric interface.	SELECTION: 0 - unknown 1 - dci 2 - fabric DEFAULT: unknown

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

Disabling EVPN Multisite DCI Tracking on a Port-Channel Interface

Disabling EVPN Multisite DCI Tracking on a Port-Channel Interface

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

{
"interfaceEntity": {
  "children": [
    {
      "pcAggrIf": {
        "attributes": {
          "id": "po123"
        },
        "children": [
          {
            "nvoMultisiteIfTracking": {
              "attributes": {
                "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <intf-items>
    <aggr-items>
      <AggrIf-list>
        <id>po123</id>
        <multisiteiftracking-items xc:operation="delete">
        </multisiteiftracking-items>
      </AggrIf-list>
    </aggr-items>
  </intf-items>
</System>

This is supported on the following switches:

N9K-C93180LC-EX
N9K-N9K-93180YC-EX
N9K-N9K-C93108TC-EX

CLI Commands

interface port-channel 123
no evpn multisite dci-tracking

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

MO	DN
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-{[id]}
nvoMultisiteIfTracking	sys/intf/svi-{[id]}/multisiteiftracking

pcAggrIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

nvoMultisiteIfTracking Properties

Property Name	Data Type	Description	Values
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

Enabling EVPN Multisite Fabric Tracking on a Port-Channel Interface

Enabling EVPN Multisite Fabric Tracking on a Port-Channel Interface

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

{
"interfaceEntity": {
  "children": [
    {
      "pcAggrIf": {
        "attributes": {
          "id": "po123"
        },
        "children": [
          {
            "nvoMultisiteIfTracking": {
              "attributes": {
                "tracking": "fabric"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <intf-items>
    <aggr-items>
      <AggrIf-list>
        <id>po123</id>
        <multisiteiftracking-items>
          <tracking>fabric</tracking>
        </multisiteiftracking-items>
      </AggrIf-list>
    </aggr-items>
  </intf-items>
</System>

This is supported on the following switches:

N9K-C93180LC-EX

N9K-N9K-93180YC-EX

N9K-N9K-C93108TC-EX

CLI Commands

interface port-channel 123
evpn multisite fabric-tracking

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

MO	DN
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-{[id]}
nvoMultisiteIfTracking	sys/intf/svi-{[id]}/multisiteiftracking

pcAggrIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

nvoMultisiteIfTracking Properties

Property Name	Data Type	Description	Values
tracking	nvo:MultisiteTrackingT (scalar:Enum16)	Configure EVPN multisite tracking for DCI/Fabric interface.	SELECTION: 0 - unknown 1 - dci 2 - fabric DEFAULT: unknown

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

Disabling EVPN Multisite Fabric Tracking on a Port-Channel Interface

Disabling EVPN Multisite Fabric Tracking on a Port-Channel Interface

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

{
"interfaceEntity": {
  "children": [
    {
      "pcAggrIf": {
        "attributes": {
          "id": "po123"
        },
        "children": [
          {
            "nvoMultisiteIfTracking": {
              "attributes": {
                "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <intf-items>
    <aggr-items>
      <AggrIf-list>
        <id>po123</id>
        <multisiteiftracking-items xc:operation="delete">
        </multisiteiftracking-items>
      </AggrIf-list>
    </aggr-items>
  </intf-items>
</System>

This is supported on the following switches:

N9K-C93180LC-EX
N9K-N9K-93180YC-EX
N9K-N9K-C93108TC-EX

CLI Commands

interface port-channel 123
no evpn multisite fabric-tracking

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

MO	DN
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-{[id]}
nvoMultisiteIfTracking	sys/intf/svi-{[id]}/multisiteiftracking

pcAggrIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

nvoMultisiteIfTracking Properties

Property Name	Data Type	Description	Values
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

Enabling EVPN Multisite DCI Tracking on an Ethernet Interface Range

Enabling EVPN Multisite DCI Tracking on an Ethernet Interface Range

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

{
"interfaceEntity": {
  "children": [
    {
      "l1PhysIf": {
        "attributes": {
          "id": "eth1/4"
        },
        "children": [
          {
            "nvoMultisiteIfTracking": {
              "attributes": {
                "tracking": "dci"
}}}]}},{
  "l1PhysIf": {
    "attributes": {
      "id": "eth1/3"
    },
    "children": [
      {
        "nvoMultisiteIfTracking": {
          "attributes": {
            "tracking": "dci"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/4</id>
        <multisiteiftracking-items>
          <tracking>dci</tracking>
        </multisiteiftracking-items>
      </PhysIf-list>
      <PhysIf-list>
        <id>eth1/3</id>
        <multisiteiftracking-items>
          <tracking>dci</tracking>
        </multisiteiftracking-items>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

This is supported on the following switches:

N9K-C93180LC-EX
N9K-N9K-93180YC-EX
N9K-N9K-C93108TC-EX

CLI Commands

interface ethernet 1/3-4
evpn multisite dci-tracking

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

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-{[id]}
nvoMultisiteIfTracking	sys/intf/svi-{[id]}/multisiteiftracking

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

nvoMultisiteIfTracking Properties

Property Name	Data Type	Description	Values
tracking	nvo:MultisiteTrackingT (scalar:Enum16)	Configure EVPN multisite tracking for DCI/Fabric interface.	SELECTION: 0 - unknown 1 - dci 2 - fabric DEFAULT: unknown

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

Disabling EVPN Multisite DCI Tracking on an Ethernet Interface Range

Disabling EVPN Multisite DCI Tracking on an Ethernet Interface Range

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

{
"interfaceEntity": {
  "children": [
    {
      "l1PhysIf": {
        "attributes": {
          "id": "eth1/4"
        },
        "children": [
          {
            "nvoMultisiteIfTracking": {
              "attributes": {
                "status": "deleted"
}}}]}},{
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/3"
                },
                "children": [
                  {
                    "nvoMultisiteIfTracking": {
                      "attributes": {
                        "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/4</id>
        <multisiteiftracking-items xc:operation="delete">
        </multisiteiftracking-items>
      </PhysIf-list>
      <PhysIf-list>
        <id>eth1/3</id>
        <multisiteiftracking-items xc:operation="delete">
        </multisiteiftracking-items>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

This is supported on the following switches:

N9K-C93180LC-EX
N9K-N9K-93180YC-EX
N9K-N9K-C93108TC-EX

CLI Commands

interface ethernet 1/3-4
no evpn multisite dci-tracking

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

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-{[id]}
nvoMultisiteIfTracking	sys/intf/svi-{[id]}/multisiteiftracking

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

nvoMultisiteIfTracking Properties

Property Name	Data Type	Description	Values
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

Enabling EVPN Multisite Fabric Tracking on an Ethernet Interface Range

Enabling EVPN Multisite Fabric Tracking on an Ethernet Interface Range

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

{
"interfaceEntity": {
  "children": [
    {
      "l1PhysIf": {
        "attributes": {
          "id": "eth1/4"
        },
        "children": [
          {
            "nvoMultisiteIfTracking": {
              "attributes": {
                "tracking": "fabric"
}}}]}},{
  "l1PhysIf": {
    "attributes": {
      "id": "eth1/3"
    },
    "children": [
      {
        "nvoMultisiteIfTracking": {
          "attributes": {
            "tracking": "fabric"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/4</id>
        <multisiteiftracking-items>
          <tracking>fabric</tracking>
        </multisiteiftracking-items>
      </PhysIf-list>
      <PhysIf-list>
        <id>eth1/3</id>
        <multisiteiftracking-items>
          <tracking>fabric</tracking>
        </multisiteiftracking-items>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

This is supported on the following switches:

N9K-C93180LC-EX
N9K-N9K-93180YC-EX
N9K-N9K-C93108TC-EX

CLI Commands

interface ethernet 1/3-4
evpn multisite fabric-tracking

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

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-{[id]}
nvoMultisiteIfTracking	sys/intf/svi-{[id]}/multisiteiftracking

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

nvoMultisiteIfTracking Properties

Property Name	Data Type	Description	Values
tracking	nvo:MultisiteTrackingT (scalar:Enum16)	Configure EVPN multisite tracking for DCI/Fabric interface.	SELECTION: 0 - unknown 1 - dci 2 - fabric DEFAULT: unknown

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

Disabling EVPN Multisite Fabric Tracking on an Ethernet Interface Range

Disabling EVPN Multisite Fabric Tracking on an Ethernet Interface Range

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

{
"interfaceEntity": {
  "children": [
    {
      "l1PhysIf": {
        "attributes": {
          "id": "eth1/4"
        },
        "children": [
          {
            "nvoMultisiteIfTracking": {
              "attributes": {
                "status": "deleted"
}}}]}},{
"l1PhysIf": {
"attributes": {
  "id": "eth1/3"
},
"children": [
  {
    "nvoMultisiteIfTracking": {
      "attributes": {
        "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/4</id>
        <multisiteiftracking-items xc:operation="delete">
        </multisiteiftracking-items>
      </PhysIf-list>
      <PhysIf-list>
        <id>eth1/3</id>
        <multisiteiftracking-items xc:operation="delete">
        </multisiteiftracking-items>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

This is supported on the following switches:

N9K-C93180LC-EX
N9K-N9K-93180YC-EX
N9K-N9K-C93108TC-EX

CLI Commands

interface ethernet 1/3-4
no evpn multisite fabric-tracking

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

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-{[id]}
nvoMultisiteIfTracking	sys/intf/svi-{[id]}/multisiteiftracking

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

nvoMultisiteIfTracking Properties

Property Name	Data Type	Description	Values
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

Enabling EVPN Multisite DCI Tracking on a VLAN Interface

Enabling EVPN Multisite DCI Tracking on a VLAN Interface

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

{
"interfaceEntity": {
  "children": [
    {
      "sviIf": {
        "attributes": {
          "id": "vlan123"
        },
        "children": [
          {
            "nvoMultisiteIfTracking": {
              "attributes": {
                "tracking": "dci"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <intf-items>
    <svi-items>
      <If-list>
        <id>vlan123</id>
        <multisiteiftracking-items>
          <tracking>dci</tracking>
        </multisiteiftracking-items>
      </If-list>
    </svi-items>
  </intf-items>
</System>

This is supported on the following switches:

N9K-C93180LC-EX
N9K-N9K-93180YC-EX
N9K-N9K-C93108TC-EX

CLI Commands

interface vlan 123
evpn multisite dci-tracking

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

MO	DN
interfaceEntity	sys/intf
sviIf	sys/intf/svi-{[id]}
nvoMultisiteIfTracking	sys/intf/svi-{[id]}/multisiteiftracking

sviIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

nvoMultisiteIfTracking Properties

Property Name	Data Type	Description	Values
tracking	nvo:MultisiteTrackingT (scalar:Enum16)	Configure EVPN multisite tracking for DCI/Fabric interface.	SELECTION: 0 - unknown 1 - dci 2 - fabric DEFAULT: unknown

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

Disabling EVPN Multisite DCI Tracking on a VLAN Interface

Disabling EVPN Multisite DCI Tracking on a VLAN Interface

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

{
"interfaceEntity": {
  "children": [
    {
      "sviIf": {
        "attributes": {
          "id": "vlan123"
        },
        "children": [
          {
            "nvoMultisiteIfTracking": {
              "attributes": {
                "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <intf-items>
    <svi-items>
      <If-list>
        <id>vlan123</id>
        <multisiteiftracking-items xc:operation="delete">
        </multisiteiftracking-items>
      </If-list>
    </svi-items>
  </intf-items>
</System>

This is supported on the following switches:

N9K-C93180LC-EX
N9K-N9K-93180YC-EX
N9K-N9K-C93108TC-EX

CLI Commands

interface vlan 123
no evpn multisite dci-tracking

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

MO	DN
interfaceEntity	sys/intf
sviIf	sys/intf/svi-{[id]}
nvoMultisiteIfTracking	sys/intf/svi-{[id]}/multisiteiftracking

sviIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

nvoMultisiteIfTracking Properties

Property Name	Data Type	Description	Values
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

Enabling EVPN Multisite Fabric Tracking on a VLAN Interface

Enabling EVPN Multisite Fabric Tracking on a VLAN Interface

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

{
"interfaceEntity": {
  "children": [
    {
      "sviIf": {
        "attributes": {
          "id": "vlan123"
        },
        "children": [
          {
            "nvoMultisiteIfTracking": {
              "attributes": {
                "tracking": "fabric"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <intf-items>
    <svi-items>
      <If-list>
        <id>vlan123</id>
        <multisiteiftracking-items>
          <tracking>fabric</tracking>
        </multisiteiftracking-items>
      </If-list>
    </svi-items>
  </intf-items>
</System>

This is supported on the following switches:

N9K-C93180LC-EX
N9K-N9K-93180YC-EX
N9K-N9K-C93108TC-EX

CLI Commands

interface vlan 123
evpn multisite fabric-tracking

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

MO	DN
interfaceEntity	sys/intf
sviIf	sys/intf/svi-{[id]}
nvoMultisiteIfTracking	sys/intf/svi-{[id]}/multisiteiftracking

sviIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

nvoMultisiteIfTracking Properties

Property Name	Data Type	Description	Values
tracking	nvo:MultisiteTrackingT (scalar:Enum16)	Configure EVPN multisite tracking for DCI/Fabric interface.	SELECTION: 0 - unknown 1 - dci 2 - fabric DEFAULT: unknown

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

Disabling EVPN Multisite Fabric Tracking on a VLAN Interface

Disabling EVPN Multisite Fabric Tracking on a VLAN Interface

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

{
"interfaceEntity": {
  "children": [
    {
      "sviIf": {
        "attributes": {
          "id": "vlan123"
        },
        "children": [
          {
            "nvoMultisiteIfTracking": {
              "attributes": {
                "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <intf-items>
    <svi-items>
      <If-list>
        <id>vlan123</id>
        <multisiteiftracking-items xc:operation="delete">
        </multisiteiftracking-items>
      </If-list>
    </svi-items>
  </intf-items>
</System>

This is supported on the following switches:

N9K-C93180LC-EX
N9K-N9K-93180YC-EX
N9K-N9K-C93108TC-EX

CLI Commands

interface vlan 123
no evpn multisite fabric-tracking

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

MO	DN
interfaceEntity	sys/intf
sviIf	sys/intf/svi-{[id]}
nvoMultisiteIfTracking	sys/intf/svi-{[id]}/multisiteiftracking

sviIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

nvoMultisiteIfTracking Properties

Property Name	Data Type	Description	Values
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

Disabling VXLAN, BGP, and EVPN

Disabling VXLAN, BGP, and EVPN

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

{
  "topSystem": {
    "children": [
      {
        "fmEntity": {
          "children": [
            {
              "fmEvpn": {
                "attributes": {
                  "adminSt": "disabled"
}}},{
  "fmNvo": {
    "attributes": {
      "adminSt": "disabled"
}}},{
  "fmVnSegment": {
    "attributes": {
      "adminSt": "disabled"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <fm-items>
    <evpn-items>
      <adminSt>disabled</adminSt>
    </evpn-items>
    <nvo-items>
      <adminSt>disabled</adminSt>
    </nvo-items>
    <vnsegment-items>
      <adminSt>disabled</adminSt>
    </vnsegment-items>
  </fm-items>
</System>

CLI Commands

no feature vn-segment
no feature nv overlay
no nv overlay evpn

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

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

fmEvpn Properties

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

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

fmNvo Properties

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

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

fmVnSegment Properties

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

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

Related Documentation

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

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

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

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

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

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

Querying Configuration and Operational Data

Querying Configuration and Operational Data

GET http://<IP_Address>/api/node/mo/sys/eps/epId-1.json?rsp-subtree=full

Querying the NVE Interface Configuration and Operational Data

{
"totalCount": "1",
"imdata": [
    {
        "nvoEp": {
            "attributes": {
                "adminSt": "enabled",
                "advertiseVmac": "no",
                "autoRemapReplicationServers": "no",
                "cfgSrc": "0",
                "childAction": "",
                "controllerId": "0",
                "descr": "",
                "dn": "sys/eps/epId-1",
                "encapType": "0",
                "epId": "1",
                "holdDownTime": "180",
                "holdDownTimerExpiryTime": "NA",
                "holdUpTime": "30",
                "holdUpTimerExpiryTime": "NA",
                "hostReach": "bgp",
                "learningMode": "CP",
                "mac": "F4:0F:1B:6F:F5:5B",
                "modTs": "2017-08-15T21:12:59.668+00:00",
                "monPolDn": "",
                "multisiteBordergwInterface": "unspecified",
                "operEncapType": "vxlan",
                "operState": "up",
                "persistentOnReload": "true",
                "propFaultBitmap": "",
                "sourceInterface": "lo2",
                "status": "",
                "uid": "0",
                "vpcVIPNotified": "no"
},
"children": [
{
"nvoPeers": {
    "attributes": {
        "childAction": "",
        "modTs": "2017-08-15T19:20:50.871+00:00",
        "monPolDn": "",
        "persistentOnReload": "true",
        "rn": "peers",
        "status": "",
        "uid": "0"
},
"children": [
{
"nvoDyIRPeer": {
    "attributes": {
        "createTs": "2017-08-15T21:45:15.593+00:00",
        "firstVNI": "0",
        "ip": "1.1.1.1",
        "mac": "00:00:00:00:00:00",
        "rn": "dyn_ir_peer-1.1.1.1",
        "state": "Up",
        "upStateTransitionTs": "2017-08-15T21:45:15.604+00:00"
}}},{
"nvoDyPeer": {
    "attributes": {
        "createTs": "2017-08-15T21:45:15.593+00:00",
        "firstVNI": "4001",
        "ip": "1.1.1.1",
        "mac": "50:87:89:D4:6B:B7",
        "rn": "dy_peer-1.1.1.1",
        "state": "Up",
        "upStateTransitionTs": "2017-08-15T21:45:15.604+00:00"
}}}]}},{
"nvoNws": {
    "attributes": {
        "childAction": "",
        "modTs": "2017-08-15T19:20:50.871+00:00",
        "monPolDn": "",
        "persistentOnReload": "true",
        "rn": "nws",
        "status": "",
        "uid": "0"
},
"children": [
{
"nvoOperNw": {
    "attributes": {
        "epId": "1",
        "mode": "CP",
        "operMcastGroup": "0.0.0.0",
        "rn": "opervni-90003",
        "state": "Up",
        "type": "L3",
        "vlanBD": "vlan-903",
        "vni": "90003"
}}},{
"nvoOperNw": {
    "attributes": {
        "epId": "1",
        "mode": "CP",
        "operMcastGroup": "225.4.0.1",
        "rn": "opervni-5007",
        "state": "Up",
        "type": "L2",
        "vlanBD": "vlan-507",
        "vni": "5007"
}}},{
"nvoOperNw": {
    "attributes": {
        "epId": "1",
        "mode": "CP",
        "operMcastGroup": "225.4.0.1",
        "rn": "opervni-5001",
        "state": "Up",
        "type": "L2",
        "vlanBD": "vlan-501",
        "vni": "5001"
}}},{
"nvoOperNw": {
    "attributes": {
        "epId": "1",
        "mode": "CP",
        "operMcastGroup": "225.4.0.1",
        "rn": "opervni-5003",
        "state": "Up",
        "type": "L2",
        "vlanBD": "vlan-503",
        "vni": "5003"
}}},{
"nvoOperNw": {
    "attributes": {
        "epId": "1",
        "mode": "CP",
        "operMcastGroup": "225.4.0.1",
        "rn": "opervni-5008",
        "state": "Up",
        "type": "L2",
        "vlanBD": "vlan-508",
        "vni": "5008"
}}},{
"nvoOperNw": {
    "attributes": {
        "epId": "1",
        "mode": "CP",
        "operMcastGroup": "225.4.0.1",
        "rn": "opervni-5005",
        "state": "Up",
        "type": "L2",
        "vlanBD": "vlan-505",
        "vni": "5005"
}}},{
"nvoOperNw": {
    "attributes": {
        "epId": "1",
        "mode": "CP",
        "operMcastGroup": "0.0.0.0",
        "rn": "opervni-4001",
        "state": "Up",
        "type": "L2",
        "vlanBD": "vlan-401",
        "vni": "4001"
}}},{
"nvoOperNw": {
    "attributes": {
        "epId": "1",
        "mode": "CP",
        "operMcastGroup": "225.4.0.1",
        "rn": "opervni-5002",
        "state": "Up",
        "type": "L2",
        "vlanBD": "vlan-502",
        "vni": "5002"
}}},{
"nvoOperNw": {
    "attributes": {
        "epId": "1",
        "mode": "CP",
        "operMcastGroup": "225.4.0.1",
        "rn": "opervni-5006",
        "state": "Up",
        "type": "L2",
        "vlanBD": "vlan-506",
        "vni": "5006"
}}},{
"nvoOperNw": {
    "attributes": {
        "epId": "1",
        "mode": "CP",
        "operMcastGroup": "225.4.0.1",
        "rn": "opervni-5004",
        "state": "Up",
        "type": "L2",
        "vlanBD": "vlan-504",
        "vni": "5004"
}}},{
"nvoOperNw": {
    "attributes": {
        "epId": "1",
        "mode": "CP",
        "operMcastGroup": "225.4.0.1",
        "rn": "opervni-5000",
        "state": "Up",
        "type": "L2",
        "vlanBD": "vlan-500",
        "vni": "5000"
}}},{
"nvoNwRange": {
    "attributes": {
        "associateVrfFlag": "no",
        "childAction": "",
        "isLegacyMode": "no",
        "isMcastRange": "no",
        "mcastGroup": "225.4.0.1",
        "modTs": "2017-08-15T19:21:03.043+00:00",
        "monPolDn": "",
        "multisiteIngRepl": "disable",
        "persistentOnReload": "true",
        "propFaultBitmap": "",
        "rn": "vnis-5000-5008",
        "status": "",
        "suppressARP": "no",
        "uid": "0",
        "vniRangeMax": "5008",
        "vniRangeMin": "5000"
}}},{
"nvoNw": {
    "attributes": {
        "associateVrfFlag": "no",
        "childAction": "",
        "isLegacyMode": "no",
        "mcastGroup": "0.0.0.0",
        "modTs": "2017-08-15T21:45:15.542+00:00",
        "monPolDn": "",
        "multisiteIngRepl": "disable",
        "persistentOnReload": "true",
        "propFaultBitmap": "",
        "rn": "vni-4001",
        "status": "",
        "suppressARP": "no",
        "uid": "0",
        "vni": "4001"
},
"children": [
{
"nvoIngRepl": {
    "attributes": {
        "childAction": "",
        "modTs": "2017-08-15T21:45:15.572+00:00",
        "monPolDn": "",
        "persistentOnReload": "true",
        "propFaultBitmap": "",
        "proto": "bgp",
        "rn": "IngRepl",
        "status": "",
        "uid": "0"
}}}]}},{
"nvoNw": {
    "attributes": {
        "associateVrfFlag": "yes",
        "childAction": "",
        "isLegacyMode": "no",
        "mcastGroup": "0.0.0.0",
        "modTs": "2017-08-15T19:20:51.075+00:00",
        "monPolDn": "",
        "multisiteIngRepl": "disable",
        "persistentOnReload": "true",
        "propFaultBitmap": "",
        "rn": "vni-90003",
        "status": "",
        "suppressARP": "no",
        "uid": "0",
        "vni": "90003"
}}}]}}]}}]}

Note: Starting with Cisco NX-OS Release 7.0.3I7(1), the nvoEps MO was added. To view the updated MOs and DNs, and for detailed information about classes and attributes described in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

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

MO	DN
nvoEp	sys/eps/epId-{epId}
nvoPeers	sys/eps/epId-{epId}/peers
nvoDyIRPeer	sys/eps/epId-{epId}/peers/dyn_ir_peer-{[ip]}
nvoDyPeer	sys/eps/epId-{epId}/peers/dy_peer-{[ip]}
nvoNws	sys/eps/epId-{epId}/nws
nvoOperNw	sys/eps/epId-{epId}/nws/opervni-{vni}
nvoNwRange	sys/eps/epId-{epId}/nws/vnis-{vniRangeMin}-{vniRangeMax}
nvoNw	sys/eps/epId-{epId}/nws/vni-{vni}
nvoIngRepl	sys/eps/epId-{epId}/nws/vnis-{vniRangeMin}-{vniRangeMax}/IngRepl

nvoEp Properties

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt (scalar:Enum8)	Administrative Up or Down state of the NVE.	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
advertiseVmac	scalar:Bool	Enable or disable Virtual MAC Advertisement in VPC mode.	SELECTION: true or false DEFAULT: 0
autoRemapReplicationServers	scalar:Bool	Configures auto remapping of VNIs for controller-based replication servers.	SELECTION: true or false
cfgSrc	nvo:CfgSrcT (scalar:Enum16)	Enable or disable VxLAN configuration via controller.	SELECTION: 0 - unknown 1 - cli 2 - controller DEFAULT: 0
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent DEFAULT: 0
controllerId	scalar:Uint32	Controller ID (applicable when host reachability proto is controller).	RANGE: [0, 4294967295] DEFAULT: 0
descr	string:Basic	Description for the NVE	A sequence of characters
dn	reference:BinRef	A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
encapType	nvo:EncapT (scalar:Enum16)	Encapsulation Type.	Supported value is VxLAN. SELECTION: 0 - unknown 1 - vxlan 2 - vxlan-tun-ctrl-frame 3 - vxlan-tun-ctrl-frame-lacp 4 - vxlan-tun-ctrl-frame-stp 5 - dot1q 6 - dot1q-tun-ctrl-frame 7 - dot1q-tun-ctrl-frame-lacp 8 - dot1q-tun-ctrl-frame-stp DEFAULT: 0
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
holdDownTimerExpiryTime	nvo:ETimeStamp (scalar:Date)	Indicates the time after which the hold down timer will expire (in milliseconds).	SELECTION: 0 - NA DEFAULT: NA
holdUpTime	scalar:Uint16	Supported values are 1 to 1000 (in seconds). The time for which the Source Interface will be held operationally Up in VPC mode during bring-down.	RANGE: [0, 65535]
holdUpTimerExpiryTime	nvo:ETimeStamp (scalar:Date)	Indicates the time after which the hold up timer will expire (in milliseconds).	SELECTION: 0 - NA DEFAULT: NA
hostReach	nvo:HostReachT (scalar:Enum16)	Host Reachability Protocol.	Supported modes are bgp or controller. SELECTION: 0 - Flood-and-learn 1 - bgp 2 - controller 3 - openflow 4 - openflowIR DEFAULT: 0
learningMode	nvo:HostLearnModeT (scalar:Enum16)	Indicates the host learning mode (Control plane or data plane).	SELECTION: 1 - DP 2 - CP 3 - Ctrlr DEFAULT: DP
mac	address:MAC	Local Router MAC address	Value must match MM:MM:MM:SS:SS:SS format
modTs	mo:TStamp (scalar:Date)	The time when this object was last modified.	SELECTION: 0 - never DEFAULT: never
monPolDn	reference:BinRef	The monitoring policy attached to this observable object.
multisiteBordergwInterface	nw:IfId (base:IfIndex)	Interface representing the Multisite Border Gateway.	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
operEncapType	nvo:EncapT (scalar:Enum16)	Operational encapsulation type.	SELECTION: 0 - unknown 1 - vxlan 2 - vxlan-tun-ctrl-frame 3 - vxlan-tun-ctrl-frame-lacp 4 - vxlan-tun-ctrl-frame-stp 5 - dot1q 6 - dot1q-tun-ctrl-frame 7 - dot1q-tun-ctrl-frame-lacp 8 - dot1q-tun-ctrl-frame-stp DEFAULT: 0
operState	l2:DomOperSt (scalar:Enum8)	Operational State of the NVE.	SELECTION: 1 - up 2 - down 3 - unknown DEFAULT: down
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
propFaultBitmap	nvo:EpFaultBitmapT scalar:Bitmask64	NO COMMENTS	SELECTION: 1024ull - cfgSrc-uncfg-err 1048576ull - globalCfgInherit-uncfg-err 128ull - controllerId-cfg-err 131072ull - advertiseVmac-cfg-err 16384ull - replnServer-uncfg-err 16ull - holdDownTime-uncfg-err 1ull - epId-cfg-err 2048ull - encapType-cfg-err 2097152ull - suppressMacRoute-cfg-err 256ull - controllerId-uncfg-err 262144ull - advertiseVmac-uncfg-err 2ull - sourceInterface-cfg-err 32768ull - multisiteBordergwInterface-cfg-err 32ull - hostReach-cfg-err 4096ull - encapType-uncfg-err 4194304ull - suppressMacRoute-uncfg-err 4ull - sourceInterface-uncfg-err 512ull - cfgSrc-cfg-err 524288ull - globalCfgInherit-cfg-err 64ull - hostReach-uncfg-err 65536ull - multisiteBordergwInterface-uncfg-err 8192ull - replnServer-cfg-err 8ull - holdDownTime-cfg-err DEFAULT: 0
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
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
uid	scalar:Uint16	A unique identifier for this object.
vpcVIPNotified	scalar:Bool	Flag to indicate that Virtual IP configuration for the NVE source interface has been enabled in VPC mode.	SELECTION: true or false

nvoPeers Properties

The following table contains information about the nvoPeers 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
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent DEFAULT: 0
modTs	mo:TStamp (scalar:Date)	The time when this object was last modified.	SELECTION: 0 - never DEFAULT: never
monPolDn	reference:BinRef	The monitoring policy attached to this observable object.
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
uid	scalar:Uint16	A unique identifier for this object.

nvoDyIRPeer Properties

The following table contains information about the nvoDyIRPeer 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
createTs	scalar:Date	Indicates the time at which the peer was first discovered.	DATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z
firstVNI	nvo:VniT scalar:Uint32	NO COMMENTS	RANGE: Min: (long)1l Max: (long)16777215l
ip	address:Ip	Indicates Peer IP for BGP IR Peer.	Value must match ipv4 or ipv6 known format
mac	address:MAC	The MAC address.
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
state	nvo:PeerStateT (scalar:Enum16)	Indicates the NVE Peer Up or Down state.	SELECTION: 1 - Up 2 - Down DEFAULT: Down
upStateTransitionTs	scalar:Date	Indicates NVE Peer uptime in seconds.	DATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z

nvoDyPeer Properties

The following table contains information about the nvoDyPeer 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
createTs	scalar:Date	Indicates the time at which the peer was first discovered.	DATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z
firstVNI	nvo:VniT (scalar:Uint32)	Indicates the first VNI on which the NVE peer was learnt.	RANGE: [1 , 16777215]
ip	address:Ip	Indicates Peer IP for BGP-RNH or dataplane learnt peer.	Value must match ipv4 or ipv6 known format
mac	address:MAC	Indicates Peer MAC address.	Value must match MM:MM:MM:SS:SS:SS format
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
state	nvo:PeerStateT (scalar:Enum16)	Indicates the NVE Peer Up or Down state.	SELECTION: 1 - Up 2 - Down DEFAULT: Down
upStateTransitionTs	scalar:Date	Indicates NVE Peer uptime in seconds.	DATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z

nvoNws Properties

The following table contains information about the nvoNws 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
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent DEFAULT: 0
modTs	mo:TStamp (scalar:Date)	The time when this object was last modified.	SELECTION: 0 - never DEFAULT: never
monPolDn	reference:BinRef	The monitoring policy attached to this observable object.
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
uid	scalar:Uint16	A unique identifier for this object.

nvoOperNw Properties

The following table contains information about the nvoOperNw 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.	RANGE: [0, 4294967295]
mode	nvo:HostLearnModeT (scalar:Enum16)	Indicates VNI Host reachability mode.	SELECTION: 1 - DP 2 - CP 3 - Ctrlr DEFAULT: DP
operMcastGroup	mcast:GrpIp (address:Ip)	Indicates the multicast group address.	Value must match ipv4 or ipv6 known format
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
state	nvo:VniStateT (scalar:Enum16)	Indicates VNI Up or Down state.	SELECTION: 1 - Up 2 - Down DEFAULT: Down
type	nvo:VniTypeT (scalar:Enum16)	Indicates if VNI is in L2 or L3 type.	SELECTION: 1 - L2 2 - L3 DEFAULT: L2
vlanBD	base:Encap	Indicates the VLAN associated to VNI.	SELECTION: unknown, vlan-%d or vxlan-%d
vni	nvo:VniT (scalar:Uint32)	Virtual Network ID.	RANGE: [1 , 16777215]

nvoNwRange Properties

Property Name	Data Type	Description	Values
associateVrfFlag	scalar:Bool	Configures VNI(s) as L3 VNI.	Supported values are True or False. SELECTION: true or false
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent 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
isMcastRange	scalar:Bool	Indicates if the multicast group configuration is a range.	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
modTs	mo:TStamp (scalar:Date)	The time when this object was last modified.	SELECTION: 0 - never DEFAULT: never
monPolDn	reference:BinRef	The monitoring policy attached to this observable object.
multisiteIngRepl	nvo:MultisiteIngReplStateT (scalar:Enum16)	Enable or disable Multisite Ingress Replication for VNI(s).	SELECTION: 1 - disable 2 - enable 3 - enableOptimized DEFAULT: disable
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
propFaultBitmap	nvo:NwFaultBitmapT scalar:Bitmask64	NO COMMENTS	SELECTION: 1024ull - isLegacyMode-uncfg-err 128ull - associateVrfFlag-cfg-err 16ull - suppressARP-uncfg-err 1ull - epId-cfg-err 256ull - associateVrfFlag-uncfg-err 2ull - vni-cfg-err 32ull - mcastGroup-cfg-err 4ull - vni-uncfg-err 512ull - isLegacyMode-cfg-err 64ull - mcastGroup-uncfg-err 8ull - suppressARP-cfg-err DEFAULT: 0
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
suppressARP	nvo:SuppressARPT (scalar:Enum16)	Enable or disable ARP suppression for VNI(s).	SELECTION: 0 - off 1 - enabled 2 - disabled DEFAULT: off
uid	scalar:Uint16	A unique identifier for this object.
vniRangeMax	nvo:VniT (scalar:Uint32)	Configures the maximum value for the VNI range.	RANGE: [1 , 16777215]
vniRangeMin	nvo:VniT (scalar:Uint32)	Configures the minimum value for the VNI range.	Supported VNI range between 1 to 16777214. RANGE: [1 , 16777215]

nvoNw Properties

Property Name	Data Type	Description	Values
associateVrfFlag	scalar:Bool	Configures VNI(s) as L3 VNI.	Supported values are True or False. SELECTION: true or false
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent 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
modTs	mo:TStamp (scalar:Date)	The time when this object was last modified.	SELECTION: 0 - never DEFAULT: never
monPolDn	reference:BinRef	The monitoring policy attached to this observable object.
multisiteIngRepl	nvo:MultisiteIngReplStateT (scalar:Enum16)	Enable or disable Multisite Ingress Replication for VNI(s).	SELECTION: 1 - disable 2 - enable 3 - enableOptimized DEFAULT: disable
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
propFaultBitmap	nvo:NwFaultBitmapT scalar:Bitmask64	NO COMMENTS	SELECTION: 1024ull - isLegacyMode-uncfg-err 128ull - associateVrfFlag-cfg-err 16ull - suppressARP-uncfg-err 1ull - epId-cfg-err 256ull - associateVrfFlag-uncfg-err 2ull - vni-cfg-err 32ull - mcastGroup-cfg-err 4ull - vni-uncfg-err 512ull - isLegacyMode-cfg-err 64ull - mcastGroup-uncfg-err 8ull - suppressARP-cfg-err DEFAULT: 0
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
suppressARP	nvo:SuppressARPT (scalar:Enum16)	Enable or disable ARP suppression for VNI(s).	SELECTION: 0 - off 1 - enabled 2 - disabled DEFAULT: off
uid	scalar:Uint16	A unique identifier for this object.
vni	nvo:VniT (scalar:Uint32)	Configure Virtual Network ID	Supported VNI values 1 to 16777214. RANGE: [1 , 16777215]

nvoIngRepl Properties

Property Name	Data Type	Description	Values
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent DEFAULT: 0
modTs	mo:TStamp (scalar:Date)	The time when this object was last modified.	SELECTION: 0 - never DEFAULT: never
monPolDn	reference:BinRef	The monitoring policy attached to this observable object.
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
propFaultBitmap	nvo:IrFaultBitmapT scalar:Bitmask64	Operational properties	SELECTION: 1ull - epId-cfg-err 2ull - proto-cfg-err 4ull - proto-uncfg-err DEFAULT: 0
proto	nvo:IngReplProtoT (scalar:Enum16)	Configure VxLAN Ingress Replication mode.	Supported IR modes are BGP and static. SELECTION: 0 - unknown 1 - bgp 2 - static DEFAULT: unknown
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
uid	scalar:Uint16	A unique identifier for this object.

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