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

NX-OS 9.3(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Disabling ECMP Multicast Load Splitting on a VRF Interface

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "mribEntity": {
          "children": [
            {
              "mribInst": {
                "children": [
                  {
                    "mribDom": {
                      "attributes": {
                        "name": "VRF_1"
                      },
                      "children": [
                        {
                          "mribConfig": {
                            "attributes": {
                              "Mode": "none",
                              "ModeEnable": "enabled"
}}}]}}]}}]}},{
        "l3Inst": {
          "attributes": {
            "name": "VRF_1"
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <mrib-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>VRF_1</name>
          <config-items>
            <Mode>none</Mode>
            <ModeEnable>enabled</ModeEnable>
          </config-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </mrib-items>
  <inst-items>
    <Inst-list>
      <name>VRF_1</name>
    </Inst-list>
  </inst-items>
</System>

Configuring MRIB Under a VRF Interface

Disabling ECMP Multicast Load Splitting on a VRF Interface

Note: This example was added in Release Cisco NX-OS Release 7.0(3)I7(2).

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 ethernet 1/2-3
vrf context VRF_1
ip multicast multipath none

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
topSystem	sys
mribEntity	sys/mrib
mribInst	sys/mrib/inst
mribDom	sys/mrib/inst/dom-{name}
mribConfig	sys/mrib/inst/dom-{name}/config
l3Inst	sys/inst-{name}

mribDom Properties

The following table contains information about the mribDom 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

mribConfig Properties

The following table contains information about the mribConfig 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
Mode	mrib:MultipathMode (scalar:Enum8)	MRIB Multipath Mode	SELECTION: 1 - none 2 - nbm 3 - null 4 - s-g-hash 5 - legacy 6 - s-g-hash-next-hop DEFAULT: null
ModeEnable	mrib:ModeAdminSt (scalar:Enum8)	Mode Enable	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

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

Deleting the ECMP Multicast Load Splitting Configured on a VRF Interface

Note: This example was added in Release Cisco NX-OS Release 7.0(3)I7(2).

CLI Commands

interface ethernet 1/2-3
vrf context VRF_1
no ip multicast multipath none

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

MO	DN
topSystem	sys
mribEntity	sys/mrib
mribInst	sys/mrib/inst
mribDom	sys/mrib/inst/dom-{name}
mribConfig	sys/mrib/inst/dom-{name}/config
l3Inst	sys/inst-{name}

mribDom Properties

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

mribConfig Properties

Property Name	Data Type	Description	Values
Mode	mrib:MultipathMode (scalar:Enum8)	MRIB Multipath Mode	SELECTION: 1 - none 2 - nbm 3 - null 4 - s-g-hash 5 - legacy 6 - s-g-hash-next-hop DEFAULT: null
ModeEnable	mrib:ModeAdminSt (scalar:Enum8)	Mode Enable	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

l3Inst Properties

Property Name	Data Type	Description	Values
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 a Hash Based on the Source and Group on a VRF Interface

Note: This example was added in Release Cisco NX-OS Release 7.0(3)I7(2).

CLI Commands

interface ethernet 1/2-3
vrf context VRF_1
ip multicast multipath legacy

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

MO	DN
topSystem	sys
mribEntity	sys/mrib
mribInst	sys/mrib/inst
mribDom	sys/mrib/inst/dom-{name}
mribConfig	sys/mrib/inst/dom-{name}/config
l3Inst	sys/inst-{name}

mribDom Properties

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

mribConfig Properties

Property Name	Data Type	Description	Values
Mode	mrib:MultipathMode (scalar:Enum8)	MRIB Multipath Mode	SELECTION: 1 - none 2 - nbm 3 - null 4 - s-g-hash 5 - legacy 6 - s-g-hash-next-hop DEFAULT: null
ModeEnable	mrib:ModeAdminSt (scalar:Enum8)	Mode Enable	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

l3Inst Properties

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

Deleting the Configuration for a Hash Based on the Source and Group on a VRF Interface

Note: This example was added in Release Cisco NX-OS Release 7.0(3)I7(2).

CLI Commands

interface ethernet 1/2-3
vrf context VRF_1
no ip multicast multipath legacy

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

MO	DN
topSystem	sys
mribEntity	sys/mrib
mribInst	sys/mrib/inst
mribDom	sys/mrib/inst/dom-{name}
mribConfig	sys/mrib/inst/dom-{name}/config
l3Inst	sys/inst-{name}

mribDom Properties

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

mribConfig Properties

Property Name	Data Type	Description	Values
Mode	mrib:MultipathMode (scalar:Enum8)	MRIB Multipath Mode	SELECTION: 1 - none 2 - nbm 3 - null 4 - s-g-hash 5 - legacy 6 - s-g-hash-next-hop DEFAULT: null
ModeEnable	mrib:ModeAdminSt (scalar:Enum8)	Mode Enable	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

l3Inst Properties

Property Name	Data Type	Description	Values
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 a Hash Based on the Source, Group, and Next-Hop Address on a VRF Interface

Note: This example was added in Release Cisco NX-OS Release 7.0(3)I7(2).

CLI Commands

interface ethernet 1/2-3
vrf context VRF_1
ip multicast multipath s-g-hash next-hop-based

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

MO	DN
topSystem	sys
mribEntity	sys/mrib
mribInst	sys/mrib/inst
mribDom	sys/mrib/inst/dom-{name}
mribConfig	sys/mrib/inst/dom-{name}/config
l3Inst	sys/inst-{name}

mribDom Properties

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

mribConfig Properties

Property Name	Data Type	Description	Values
Mode	mrib:MultipathMode (scalar:Enum8)	MRIB Multipath Mode	SELECTION: 1 - none 2 - nbm 3 - null 4 - s-g-hash 5 - legacy 6 - s-g-hash-next-hop DEFAULT: null
ModeEnable	mrib:ModeAdminSt (scalar:Enum8)	Mode Enable	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

l3Inst Properties

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

Deleting a Hash Based on the Source, Group, and Next-Hop Address Configured on a VRF Interface

Note: This example was added in Release Cisco NX-OS Release 7.0(3)I7(2).

CLI Commands

interface ethernet 1/2-3
vrf context VRF_1
no ip multicast multipath s-g-hash next-hop-based

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

MO	DN
topSystem	sys
mribEntity	sys/mrib
mribInst	sys/mrib/inst
mribDom	sys/mrib/inst/dom-{name}
mribConfig	sys/mrib/inst/dom-{name}/config
l3Inst	sys/inst-{name}

mribDom Properties

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

mribConfig Properties

Property Name	Data Type	Description	Values
Mode	mrib:MultipathMode (scalar:Enum8)	MRIB Multipath Mode	SELECTION: 1 - none 2 - nbm 3 - null 4 - s-g-hash 5 - legacy 6 - s-g-hash-next-hop DEFAULT: null
ModeEnable	mrib:ModeAdminSt (scalar:Enum8)	Mode Enable	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

l3Inst Properties

Property Name	Data Type	Description	Values
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 a Resilient RPF Interface on a VRF Interface

Note: This example was added in Release Cisco NX-OS Release 7.0(3)I7(2).

CLI Commands

interface ethernet 1/2-3
vrf context VRF_1
ip multicast multipath resilient

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

MO	DN
topSystem	sys
mribEntity	sys/mrib
mribInst	sys/mrib/inst
mribDom	sys/mrib/inst/dom-{name}
mribConfig	sys/mrib/inst/dom-{name}/config
l3Inst	sys/inst-{name}

mribDom Properties

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

mribConfig Properties

Property Name	Data Type	Description	Values
Mode	mrib:MultipathMode (scalar:Enum8)	MRIB Multipath Mode	SELECTION: 1 - none 2 - nbm 3 - null 4 - s-g-hash 5 - legacy 6 - s-g-hash-next-hop DEFAULT: null
ModeEnable	mrib:ModeAdminSt (scalar:Enum8)	Mode Enable	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

l3Inst Properties

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

Deleting a Resilient RPF Interface Configured on a VRF Interface

Note: This example was added in Release Cisco NX-OS Release 7.0(3)I7(2).

CLI Commands

interface ethernet 1/2-3
vrf context VRF_1
no ip multicast multipath resilient

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

MO	DN
topSystem	sys
mribEntity	sys/mrib
mribInst	sys/mrib/inst
mribDom	sys/mrib/inst/dom-{name}
mribConfig	sys/mrib/inst/dom-{name}/config
l3Inst	sys/inst-{name}

mribDom Properties

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

mribConfig Properties

Property Name	Data Type	Description	Values
Mode	mrib:MultipathMode (scalar:Enum8)	MRIB Multipath Mode	SELECTION: 1 - none 2 - nbm 3 - null 4 - s-g-hash 5 - legacy 6 - s-g-hash-next-hop DEFAULT: null
ModeEnable	mrib:ModeAdminSt (scalar:Enum8)	Mode Enable	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

l3Inst Properties

Property Name	Data Type	Description	Values
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 an NBM-controlled RPF Interface on a VRF Interface

Note: This example was added in Release Cisco NX-OS Release 7.0(3)I7(2).

CLI Commands

interface ethernet 1/2-3
vrf context VRF_1
ip multicast multipath nbm

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

MO	DN
topSystem	sys
mribEntity	sys/mrib
mribInst	sys/mrib/inst
mribDom	sys/mrib/inst/dom-{name}
mribConfig	sys/mrib/inst/dom-{name}/config
l3Inst	sys/inst-{name}

mribDom Properties

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

mribConfig Properties

Property Name	Data Type	Description	Values
Mode	mrib:MultipathMode (scalar:Enum8)	MRIB Multipath Mode	SELECTION: 1 - none 2 - nbm 3 - null 4 - s-g-hash 5 - legacy 6 - s-g-hash-next-hop DEFAULT: null
ModeEnable	mrib:ModeAdminSt (scalar:Enum8)	Mode Enable	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

l3Inst Properties

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

Deleting an NBM-controlled RPF Interface Configured on a VRF Interface

Note: This example was added in Release Cisco NX-OS Release 7.0(3)I7(2).

CLI Commands

interface ethernet 1/2-3
vrf context VRF_1
no ip multicast multipath nbm

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

MO	DN
topSystem	sys
mribEntity	sys/mrib
mribInst	sys/mrib/inst
mribDom	sys/mrib/inst/dom-{name}
mribConfig	sys/mrib/inst/dom-{name}/config
l3Inst	sys/inst-{name}

mribDom Properties

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

mribConfig Properties

Property Name	Data Type	Description	Values
Mode	mrib:MultipathMode (scalar:Enum8)	MRIB Multipath Mode	SELECTION: 1 - none 2 - nbm 3 - null 4 - s-g-hash 5 - legacy 6 - s-g-hash-next-hop DEFAULT: null
ModeEnable	mrib:ModeAdminSt (scalar:Enum8)	Mode Enable	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

l3Inst Properties

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

Configuring Resilient RPF Interface

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

CLI Commands

vrf context VRF_1
ip multicast multipath resilient

Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MO	DN
topSystem	sys
mribEntity	sys/mrib
mribInst	sys/mrib/inst
mribDom	sys/mrib/inst/dom-VRF_1
mribConfig	sys/mrib/inst/dom-VRF_1/config
l3Inst	sys/inst-VRF_1

mribDom Properties

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

mribConfig Properties

Property Name	Data Type	Description	Values
modeResilient	mrib:ResilientType (scalar:Bool)	MRIB Multipath Resilient	SELECTION: true or false DEFAULT: false

l3Inst Properties

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

Deleting Resilient RPF Interface

Deleting Configuring Resilient RPF Interface

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

CLI Commands

vrf context VRF_1
no ip multicast multipath resilient

Verifying a DME Configuration

MO	DN
topSystem	sys
mribEntity	sys/mrib
mribInst	sys/mrib/inst
mribDom	sys/mrib/inst/dom-VRF_1
mribConfig	sys/mrib/inst/dom-VRF_1/config
l3Inst	sys/inst-VRF_1

mribDom Properties

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

mribConfig Properties

Property Name	Data Type	Description	Values
modeResilient	mrib:ResilientType (scalar:Bool)	MRIB Multipath Resilient	SELECTION: true or false DEFAULT: false

l3Inst Properties

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

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