Configuring MRIB Global Parameters

This section contains payload examples and CLIs to demonstrate how to use the NX-API REST API to configure global parameters 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 Multicast Routing Configuration Guide, Release 7.x.

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

Disabling ECMP Multicast Load Splitting

Disabling ECMP Multicast Load Splitting

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

{
  "mribInst": {
    "children": [
      {
        "mribDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "mribConfig": {
                "attributes": {
                  "Mode": "none",
                  "ModeEnable": "enabled"
}}}]}}]}}

{
    imdata:[]
}

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

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.

ip multicast multipath none

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/

Deleting the ECMP Multicast Load Splitting Configuration

Deleting the ECMP Multicast Load Splitting Configuration

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

{
  "mribInst": {
    "children": [
      {
        "mribDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "mribConfig": {
                "attributes": {
                  "Mode": "none",
                  "ModeEnable": "disabled"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <mrib-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <config-items>
            <Mode>none</Mode>
            <ModeEnable>disabled</ModeEnable>
          </config-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </mrib-items>
</System>

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.

no ip multicast multipath none

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 a Hash Based on the Source and Group

Configuring a Hash Based on the Source and Group

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

{
  "mribInst": {
    "children": [
      {
        "mribDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "mribConfig": {
                "attributes": {
                  "Mode": "legacy",
                  "ModeEnable": "enabled"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <mrib-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <config-items>
            <Mode>legacy</Mode>
            <ModeEnable>enabled</ModeEnable>
          </config-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </mrib-items>
</System>

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.

ip multicast multipath legacy

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/

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

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

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

{
  "mribInst": {
    "children": [
      {
        "mribDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "mribConfig": {
                "attributes": {
                  "Mode": "legacy",
                  "ModeEnable": "disabled"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <mrib-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <config-items>
            <Mode>legacy</Mode>
            <ModeEnable>disabled</ModeEnable>
          </config-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </mrib-items>
</System>

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.

no ip multicast multipath legacy

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 a Hash Based on the Source, Group, and Next-Hop Address

Configuring a Hash Based on the Source, Group, and Next-Hop Address

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

{
  "mribInst": {
    "children": [
      {
        "mribDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "mribConfig": {
                "attributes": {
                  "Mode": "s-g-hash",
                  "ModeEnable": "enabled"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <mrib-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <config-items>
            <Mode>s-g-hash</Mode>
            <ModeEnable>enabled</ModeEnable>
          </config-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </mrib-items>
</System>

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.

ip multicast multipath s-g-hash next-hop-based

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/

Deleting the Configuration for a Hash Based on the Source, Group, and Next-Hop Address

Deleting the Configuration for a Hash Based on the Source, Group, and Next-Hop Address

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

{
  "mribInst": {
    "children": [
      {
        "mribDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "mribConfig": {
                "attributes": {
                  "Mode": "s-g-hash",
                  "ModeEnable": "disabled"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <mrib-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <config-items>
            <Mode>s-g-hash</Mode>
            <ModeEnable>disabled</ModeEnable>
          </config-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </mrib-items>
</System>

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.

no ip multicast multipath s-g-hash next-hop-based

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 a Resilient RPF Interface

Configuring a Resilient RPF Interface

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

{
  "mribInst": {
    "children": [
      {
        "mribDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "mribConfig": {
                "attributes": {
                  "Mode": "resilient",
                  "ModeEnable": "enabled"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <mrib-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <config-items>
            <Mode>resilient</Mode>
            <ModeEnable>enabled</ModeEnable>
          </config-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </mrib-items>
</System>

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.

ip multicast multipath resilient

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/

Deleting a Resilient RPF Interface Configuration

Deleting a Resilient RPF Interface Configuration

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

{
  "mribInst": {
    "children": [
      {
        "mribDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "mribConfig": {
                "attributes": {
                  "Mode": "resilient",
                  "ModeEnable": "disabled"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <mrib-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <config-items>
            <Mode>resilient</Mode>
            <ModeEnable>disabled</ModeEnable>
          </config-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </mrib-items>
</System>

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.

no ip multicast multipath resilient

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 an NBM-controlled RPF Interface

Configuring an NBM-controlled RPF Interface

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

{
  "mribInst": {
    "children": [
      {
        "mribDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "mribConfig": {
                "attributes": {
                  "Mode": "nbm",
                  "ModeEnable": "enabled"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <mrib-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <config-items>
            <Mode>nbm</Mode>
            <ModeEnable>enabled</ModeEnable>
          </config-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </mrib-items>
</System>

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.

ip multicast multipath nbm

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/

Deleting an NBM-controlled RPF Interface Configuration

Deleting an NBM-controlled RPF Interface Configuration

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

{
  "mribInst": {
    "children": [
      {
        "mribDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "mribConfig": {
                "attributes": {
                  "Mode": "nbm",
                  "ModeEnable": "disabled"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <mrib-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <config-items>
            <Mode>nbm</Mode>
            <ModeEnable>disabled</ModeEnable>
          </config-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </mrib-items>
</System>

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.

no ip multicast multipath nbm

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 an IP Multicast Hold-Down Period

Configuring an IP Multicast Hold-Down Period

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

{
  "mribInst": {
    "children": [
      {
        "mribDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "mribConfig": {
                "attributes": {
                  "holdEnable": "enabled",
                  "holddown": "123"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <mrib-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <config-items>
            <holdEnable>enabled</holdEnable>
            <holddown>123</holddown>
          </config-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </mrib-items>
</System>

Note: This example was added in 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.

ip routing multicast holddown 123

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/

Disabling an IP Multicast Hold-Down Period

Disabling an IP Multicast Hold-Down Period

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

{
  "mribInst": {
    "children": [
      {
        "mribDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "mribConfig": {
                "attributes": {
                  "holdEnable": "enabled",
                  "holddown": "210"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <mrib-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <config-items>
            <holdEnable>enabled</holdEnable>
            <holddown>210</holddown>
          </config-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </mrib-items>
</System>

Note: This example was added in 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.

no ip routing multicast holddown 123

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 an IPv4 Multicast Hold-Down Period

Configuring an IPv4 Multicast Hold-Down Period

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

{
  "mribInst": {
    "children": [
      {
        "mribDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "mribConfig": {
                "attributes": {
                  "holdEnable": "enabled",
                  "holddown": "123"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <mrib-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <config-items>
            <holdEnable>enabled</holdEnable>
            <holddown>123</holddown>
          </config-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </mrib-items>
</System>

Note: This example was added in 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.

ipv4 routing multicast holddown 123

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/

Disabling an IPv4 Multicast Hold-Down Period

Disabling an IPv4 Multicast Hold-Down Period

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

{
  "mribInst": {
    "children": [
      {
        "mribDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "mribConfig": {
                "attributes": {
                  "holdEnable": "enabled",
                  "holddown": "210"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <mrib-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <config-items>
            <holdEnable>enabled</holdEnable>
            <holddown>210</holddown>
          </config-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </mrib-items>
</System>

Note: This example was added in 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.

no ipv4 routing multicast holddown 123

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/