Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)

Latest

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Translating IGMPv1/v2 Reports to (S,G) Route Entries Under a VRF Interface

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "igmpEntity": {
          "children": [
            {
              "igmpInst": {
                "children": [
                  {
                    "igmpDom": {
                      "attributes": {
                        "name": "VRF_1"
                      },
                      "children": [
                        {
                          "igmpSSMXlate": {
                            "attributes": {
                              "grpPfx": "232.0.0.0/8",
                              "srcAddr": "10.1.1.1/32"
}}}]}}]}}]}},{
        "l3Inst": {
          "attributes": {
            "name": "VRF_1"
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>VRF_1</name>
          <ssmxlate-items>
            <SSMXlate-list>
              <srcAddr>10.1.1.1/32</srcAddr>
              <grpPfx>232.0.0.0/8</grpPfx>
            </SSMXlate-list>
          </ssmxlate-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
  <inst-items>
    <Inst-list>
      <name>VRF_1</name>
    </Inst-list>
  </inst-items>
</System>

Configuring IGMP Under a VRF Interface

This section contains payload examples and CLIs to demonstrate how to use the NX-API REST API to perform configurations 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.

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

Translating IGMPv1/v2 Reports to (S,G) Route Entries Under 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 igmp ssm-translate 232.0.0.0/8 10.1.1.1

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
igmpEntity	sys/igmp
igmpInst	sys/igmp/inst
igmpDom	sys/igmp/inst/dom-{name}
igmpSSMXlate	sys/igmp/inst/dom-{name}/ssmxlate-src-{[srcAddr]}-grp-{[grpPfx]}
l3Inst	sys/inst-{name}

igmpDom Properties

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

igmpSSMXlate Properties

The following table contains information about the igmpSSMXlate 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
grpPfx	mcast:GrpIp (address:Ip)	Address	Value must match ipv4 or ipv6 known format
srcAddr	address:Ip	Address	Value must match ipv4 or ipv6 known format

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

Disabling the Translation of IGMPv1/v2 Reports to (S,G) Route Entries Under a VRF Interface