Configuring Tenant-Routed Multicast Options

When ngMVPN is enabled, options are available for configuring tenant routed multicast.

This section contains payload examples and CLIs to demonstrate how to use the NX-API REST API to configure options that are available when ngMVPN is enabled on Cisco Nexus 3000 and 9000 Series switches and to show how the REST APIs correspond to the CLI commands.

For more information about the options for configurng tenant routed multicast, 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 a Node as Distributed-DR

Configuring a Node as Distributed-DR

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

{
  "ngmvpnEntity": {
    "children": [
      {
        "ngmvpnInst": {
          "attributes": {
            "overlayDistributedDr": "yes"
}}}]}}

{
    "imdata": []
}

<System>
  <ngmvpn-items>
    <inst-items>
      <overlayDistributedDr>true</overlayDistributedDr>
    </inst-items>
  </ngmvpn-items>
</System>


CLI Commands

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

ip multicast overlay-distributed-dr

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.

MODN
ngmvpnEntity sys/ngmvpn
ngmvpnInst sys/ngmvpn/inst


ngmvpnInst Properties

The following table contains information about the ngmvpnInst 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 NameData TypeDescriptionValues
overlayDistributedDrscalar:Bool
Overlay Distributed DR flagSELECTION: true or false


Related Documentation

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

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

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

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

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

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

Deleting a Node Configured as Distributed-DR

Deleting a Node Configured as Distributed-DR

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

{
  "ngmvpnEntity": {
    "children": [
      {
        "ngmvpnInst": {
          "attributes": {
            "overlayDistributedDr": "no"
}}}]}}

{
    "imdata": []
}

<System>
  <ngmvpn-items>
    <inst-items>
      <overlayDistributedDr>false</overlayDistributedDr>
    </inst-items>
  </ngmvpn-items>
</System>


CLI Commands

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

no ip multicast overlay-distributed-dr

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.

MODN
ngmvpnEntity sys/ngmvpn
ngmvpnInst sys/ngmvpn/inst


ngmvpnInst Properties

The following table contains information about the ngmvpnInst 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 NameData TypeDescriptionValues
overlayDistributedDrscalar:Bool
Overlay Distributed DR flagSELECTION: true or false


Related Documentation

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

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

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

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

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

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

Enabling L3-Overlay SPT (Shortest-Path-Tree) Only

Enabling L3-Overlay SPT (Shortest-Path-Tree) Only

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

{
  "ngmvpnEntity": {
    "children": [
      {
        "ngmvpnInst": {
          "attributes": {
            "overlaySptOnly": "yes"
}}}]}}

{
    "imdata": []
}

<System>
  <ngmvpn-items>
    <inst-items>
      <overlaySptOnly>true</overlaySptOnly>
    </inst-items>
  </ngmvpn-items>
</System>


CLI Commands

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

ip multicast overlay-spt-only

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.

MODN
ngmvpnEntity sys/ngmvpn
ngmvpnInst sys/ngmvpn/inst


ngmvpnInst Properties

The following table contains information about the ngmvpnInst 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 NameData TypeDescriptionValues
overlaySptOnlyscalar:Bool
Overlay SPT only flagSELECTION: true or false
DEFAULT: true


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 L3-Overlay SPT (Shortest-Path-Tree) Only

Disabling L3-Overlay SPT (Shortest-Path-Tree) Only

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

{
  "ngmvpnEntity": {
    "children": [
      {
        "ngmvpnInst": {
          "attributes": {
            "overlaySptOnly": "no"
}}}]}}

{
    "imdata": []
}

<System>
  <ngmvpn-items>
    <inst-items>
      <overlaySptOnly>false</overlaySptOnly>
    </inst-items>
  </ngmvpn-items>
</System>


CLI Commands

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

no ip multicast overlay-spt-only

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

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.

MODN
ngmvpnEntity sys/ngmvpn
ngmvpnInst sys/ngmvpn/inst


ngmvpnInst Properties

The following table contains information about the ngmvpnInst 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 NameData TypeDescriptionValues
overlaySptOnlyscalar:Bool
Overlay SPT only flagSELECTION: true or false
DEFAULT: true


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