Configuring IGMP under an Ethernet Interface

This section contains payload examples and CLIs to demonstrate how to use the NX-API REST API to configure IGMP on Cisco Nexus 3000 and 9000 Series switches and to show how the REST APIs correspond to the CLI commands.

For more information about configuring IGMP, 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/

Accepting IGMPv3 Reports for Non-SSM Groups

Accepting IGMPv3 Reports for Non-SSM Groups
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
      {
        "igmpEntity": {
          "children": [
            {
              "igmpInst": {
                "children": [
                  {
                    "igmpDom": {
                      "attributes": {
                        "name": "default"
                      },
                      "children": [
                        {
                          "igmpIf": {
                            "attributes": {
                              "allowv3Asm": "yes",
                              "id": "eth1/1"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <bootupDelay>123</bootupDelay>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 ip igmp allow-v3-asm

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

Configuring Bootup Delay
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
      {
        "igmpEntity": {
          "children": [
            {
              "igmpInst": {
                "attributes": {
                  "bootupDelay": "123"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <bootupDelay>123</bootupDelay>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 ip igmp bootup-delay 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/

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

Deleting Bootup Delay
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
"igmpEntity": {
  "children": [
    {
      "igmpInst": {
        "attributes": {
          "bootupDelay": "0"
}}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <bootupDelay>0</bootupDelay>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 no ip igmp bootup-delay 123

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
igmpEntity sys/igmp
igmpInst sys/igmp/inst


igmpInst Properties

The following table contains information about the igmpInst 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
bootupDelayipmc:BootupDelay
(scalar:Uint16)
Bootup Route Add Delay
RANGE: [0 , 65535]
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 Immediate Leave

Configuring Immediate Leave
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1",
                  "immediateLeave": "yes"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <immediateLeave>true</immediateLeave>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 ip igmp immediate-leave

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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

Disabling Immediate Leave

Disabling Immediate Leave
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1",
                  "immediateLeave": "no"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <immediateLeave>false</immediateLeave>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 no ip igmp immediate-leave

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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

Configuring Local Group Membership for a Router

Configuring Local Group Membership for a Router
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpStRepP": {
                      "attributes": {
                        "joinType": "1",
                        "rtMap": "rtMap1"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <streppol-items>
                <StRepP-list>
                  <joinType>1</joinType>
                  <rtMap>rtMap1</rtMap>
                </StRepP-list>
              </streppol-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 ip igmp join-group network rtMap1

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpStRepP sys/igmp/inst/dom-{name}/if-{[id]}/streppol-{joinType}


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpStRepP Properties

The following table contains information about the igmpStRepP 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
joinTypeipmc:JoinType
(scalar:Enum8)
Join Type of GroupsSELECTION:
0 - 0
1 - 1
rtMapstring:Basic
Route MapA sequence of characters


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 Local Group Membership for a Router

Disabling Local Group Membership for a Router
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpStRepP": {
                      "attributes": {
                        "joinType": "1",
                        "status": "deleted"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <streppol-items>
                <StRepP-list xc:operation="delete">
                  <joinType>1</joinType>
                </StRepP-list>
              </streppol-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 no ip igmp join-group network rtMap1

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpStRepP sys/igmp/inst/dom-{name}/if-{[id]}/streppol-{joinType}


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpStRepP Properties

The following table contains information about the igmpStRepP 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
joinTypeipmc:JoinType
(scalar:Enum8)
Join Type of GroupsSELECTION:
0 - 0
1 - 1
statusmo: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

Configuring Send Reports for Groups

Configuring Send Reports for Groups
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1",
                  "reportLl": "yes"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <reportLl>true</reportLl>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 ip igmp report-link-local-groups

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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

Disabling Send Reports for Groups

Disabling Send Reports for Groups
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1",
                  "reportLl": "no"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <reportLl>false</reportLl>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 no ip igmp report-link-local-groups

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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

Configuring Static OIF for a Multicast Forwarding Entry

Configuring Static OIF for a Multicast Forwarding Entry (Release 9.2(1))
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpJoinType": {
                      "attributes": {
                        "type": "0"
                      },
                      "children": [
                        {
                          "igmpVersion": {
                            "attributes": {
                              "version": "2"
                            },
                            "children": [
                              {
                                "igmpGroup": {
                                  "attributes": {
                                    "grp": "239.255.255.255",
                                    "useStaticOif": "yes"
}}}]}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <jointype-items>
                <JoinType-list>
                  <type>0</type>
                  <ver-items>
                    <Version-list>
                      <version>2</version>
                      <group-items>
                        <Group-list>
                          <grp>239.255.255.255</grp>
                          <useStaticOif>true</useStaticOif>
                        </Group-list>
                      </group-items>
                    </Version-list>
                  </ver-items>
                </JoinType-list>
              </jointype-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

Note: This example was added in Release Cisco NX-OS Release 9.2(1).


CLI Commands

interface ethernet 1/1
 ip igmp static-oif 239.255.255.255

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpJoinType sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}
igmpVersion sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}/ver-{version}
igmpGroup sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}/ver-{version}/group-{[grp]}


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpJoinType Properties

The following table contains information about the igmpJoinType 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
typeipmc:JoinType
(scalar:Enum8)
Join Type of the Groups. Supported Types Include Static or Join.SELECTION:
0 - 0
1 - 1


igmpVersion Properties

The following table contains information about the igmpVersion 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
versionipmc:Ver
(scalar:Enum8)
IGMP Group VersionSELECTION:
0 - unspecified
2 - 2
3 - 3


igmpGroup Properties

The following table contains information about the igmpGroup 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
grpaddress:Ip
Route IP Address for Choosing GroupsValue must match ipv4 or ipv6 known format
useStaticOifscalar:Bool
Indicates if Static Outgoing Interace is Being UsedSELECTION: 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 Static OIF for a Multicast Forwarding Entry

Disabling Static OIF for a Multicast Forwarding Entry (Release 9.2(1))
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpJoinType": {
                      "attributes": {
                        "type": "0"
                      },
                      "children": [
                        {
                          "igmpVersion": {
                            "attributes": {
                              "version": "2"
                            },
                            "children": [
                              {
                                "igmpGroup": {
                                  "attributes": {
                                    "grp": "239.255.255.255",
                                    "status": "deleted"
}}}]}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <jointype-items>
                <JoinType-list>
                  <type>0</type>
                  <ver-items>
                    <Version-list>
                      <version>2</version>
                      <group-items>
                        <Group-list xc:operation="delete">
                          <grp>239.255.255.255</grp>
                        </Group-list>
                      </group-items>
                    </Version-list>
                  </ver-items>
                </JoinType-list>
              </jointype-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

Note: This example was added in Release Cisco NX-OS Release 9.2(1).


CLI Commands

interface ethernet 1/1
 no ip igmp static-oif 239.255.255.255

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpJoinType sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}
igmpVersion sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}/ver-{version}
igmpGroup sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}/ver-{version}/group-{[grp]}


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpJoinType Properties

The following table contains information about the igmpJoinType 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
typeipmc:JoinType
(scalar:Enum8)
Join Type of the Groups. Supported Types Include Static or Join.SELECTION:
0 - 0
1 - 1


igmpVersion Properties

The following table contains information about the igmpVersion 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
versionipmc:Ver
(scalar:Enum8)
IGMP Group VersionSELECTION:
0 - unspecified
2 - 2
3 - 3


igmpGroup Properties

The following table contains information about the igmpGroup 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
grpaddress:Ip
Route IP Address for Choosing GroupsValue must match ipv4 or ipv6 known format
statusmo: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

Configuring a Static Group

Configuring a Static Group (Release 9.2(1))
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpJoinType": {
                      "attributes": {
                        "type": "0"
                      },
                      "children": [
                        {
                          "igmpVersion": {
                            "attributes": {
                              "version": "2"
                            },
                            "children": [
                              {
                                "igmpGroup": {
                                  "attributes": {
                                    "grp": "239.255.255.255",
                                    "useStaticOif": "no"
}}}]}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <jointype-items>
                <JoinType-list>
                  <type>0</type>
                  <ver-items>
                    <Version-list>
                      <version>2</version>
                      <group-items>
                        <Group-list>
                          <grp>239.255.255.255</grp>
                          <useStaticOif>false</useStaticOif>
                        </Group-list>
                      </group-items>
                    </Version-list>
                  </ver-items>
                </JoinType-list>
              </jointype-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

Note: This example was added in Release Cisco NX-OS Release 9.2(1).


CLI Commands

interface ethernet 1/1
 ip igmp static-group 239.255.255.255

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpJoinType sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}
igmpVersion sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}/ver-{version}
igmpGroup sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}/ver-{version}/group-{[grp]}


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpJoinType Properties

The following table contains information about the igmpJoinType 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
typeipmc:JoinType
(scalar:Enum8)
Join Type of the Groups. Supported Types Include Static or Join.SELECTION:
0 - 0
1 - 1


igmpVersion Properties

The following table contains information about the igmpVersion 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
versionipmc:Ver
(scalar:Enum8)
IGMP Group VersionSELECTION:
0 - unspecified
2 - 2
3 - 3


igmpGroup Properties

The following table contains information about the igmpGroup 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
grpaddress:Ip
Route IP Address for Choosing GroupsValue must match ipv4 or ipv6 known format
useStaticOifscalar:Bool
Indicates if Static Outgoing Interace is Being UsedSELECTION: 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 a Static Group

Disabling a Static Group (Release 9.2(1))
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpJoinType": {
                      "attributes": {
                        "type": "0"
                      },
                      "children": [
                        {
                          "igmpVersion": {
                            "attributes": {
                              "version": "2"
                            },
                            "children": [
                              {
                                "igmpGroup": {
                                  "attributes": {
                                    "grp": "239.255.255.255",
                                    "status": "deleted"

}}}]}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <jointype-items>
                <JoinType-list>
                  <type>0</type>
                  <ver-items>
                    <Version-list>
                      <version>2</version>
                      <group-items>
                        <Group-list xc:operation="delete">
                          <grp>239.255.255.255</grp>
                        </Group-list>
                      </group-items>
                    </Version-list>
                  </ver-items>
                </JoinType-list>
              </jointype-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

Note: This example was added in Release Cisco NX-OS Release 9.2(1).


CLI Commands

interface ethernet 1/1
 no ip igmp static-group 239.255.255.255

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpJoinType sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}
igmpVersion sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}/ver-{version}
igmpGroup sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}/ver-{version}/group-{[grp]}


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpJoinType Properties

The following table contains information about the igmpJoinType 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
typeipmc:JoinType
(scalar:Enum8)
Join Type of the Groups. Supported Types Include Static or Join.SELECTION:
0 - 0
1 - 1


igmpVersion Properties

The following table contains information about the igmpVersion 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
versionipmc:Ver
(scalar:Enum8)
IGMP Group VersionSELECTION:
0 - unspecified
2 - 2
3 - 3


igmpGroup Properties

The following table contains information about the igmpGroup 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
grpaddress:Ip
Route IP Address for Choosing GroupsValue must match ipv4 or ipv6 known format
statusmo: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

Configuring a State Limit

Configuring a State Limit
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpResP": {
                      "attributes": {
                        "max": "123",
                        "rsvd": "123",
                        "rtMap": "map1"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <limit-items>
                <max>123</max>
                <rsvd>123</rsvd>
                <rtMap>map1</rtMap>
              </limit-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 ip igmp state-limit 123 reserved map1 123

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpResP sys/igmp/inst/dom-{name}/if-{[id]}/limit


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpResP Properties

The following table contains information about the igmpResP 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
maxmcast:NumEntries
(scalar:Uint32)
Maximum Multicast Entries
RANGE: [0 , 4294967295]
DEFAULT: 0
rsvdmcast:NumEntries
(scalar:Uint32)
Reserved Multicast Entries
RANGE: [0 , 4294967295]
DEFAULT: 0
rtMapstring:Basic
Reserved Entries Route MapA sequence of characters


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 a State Limit

Disabling a State Limit
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpResP": {
                      "attributes": {
                        "status": "deleted"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <limit-items xc:operation="delete">
              </limit-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 no ip igmp state-limit 123 reserved map1 123

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpResP sys/igmp/inst/dom-{name}/if-{[id]}/limit


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpResP Properties

The following table contains information about the igmpResP 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
statusmo: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

Configuring an IGMP Report Policy with a Route Map

Configuring an IGMP Report Policy with a Route Map
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpRepP": {
                      "attributes": {
                        "pfxList": "",
                        "rtMap": "map1",
                        "useAccessGrpCommand": "no"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <reppol-items>
                <pfxList></pfxList>
                <rtMap>map1</rtMap>
                <useAccessGrpCommand>false</useAccessGrpCommand>
              </reppol-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 ip igmp report-policy map1

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpRepP sys/igmp/inst/dom-{name}/if-{[id]}/reppol


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpRepP Properties

The following table contains information about the igmpRepP 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
pfxListstring:Basic
Prefix ListA sequence of characters
rtMapstring:Basic
Route MapA sequence of characters
useAccessGrpCommandscalar:Bool
Flag to use access-groupSELECTION: 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

Configuring an IGMP Access Group with a Prefix List

Configuring an IGMP Access Group with a Prefix List
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpRepP": {
                      "attributes": {
                        "pfxList": "List1",
                        "rtMap": "",
                        "useAccessGrpCommand": "yes"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <reppol-items>
                <pfxList>List1</pfxList>
                <rtMap></rtMap>
                <useAccessGrpCommand>true</useAccessGrpCommand>
              </reppol-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 ip igmp access-group prefix-list List1

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpRepP sys/igmp/inst/dom-{name}/if-{[id]}/reppol


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpRepP Properties

The following table contains information about the igmpRepP 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
pfxListstring:Basic
Prefix ListA sequence of characters
rtMapstring:Basic
Route MapA sequence of characters
useAccessGrpCommandscalar:Bool
Flag to use access-groupSELECTION: 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

Disabling an IGMP Report Policy with a Route Map

Disabling an IGMP Report Policy with a Route Map
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpRepP": {
                      "attributes": {
                        "pfxList": "",
                        "rtMap": "",
                        "useAccessGrpCommand": "no"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <reppol-items>
                <pfxList></pfxList>
                <rtMap></rtMap>
                <useAccessGrpCommand>false</useAccessGrpCommand>
              </reppol-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 no ip igmp report-policy map1

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpRepP sys/igmp/inst/dom-{name}/if-{[id]}/reppol


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpRepP Properties

The following table contains information about the igmpRepP 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
pfxListstring:Basic
Prefix ListA sequence of characters
rtMapstring:Basic
Route MapA sequence of characters
useAccessGrpCommandscalar:Bool
Flag to use access-groupSELECTION: 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

Disabling an IGMP Access Group with a Prefix List

Disabling an IGMP Access Group with a Prefix List
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpRepP": {
                      "attributes": {
                        "pfxList": "",
                        "rtMap": "",
                        "useAccessGrpCommand": "no"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <reppol-items>
                <pfxList></pfxList>
                <rtMap></rtMap>
                <useAccessGrpCommand>false</useAccessGrpCommand>
              </reppol-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 no ip igmp access-group prefix-list List1

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpRepP sys/igmp/inst/dom-{name}/if-{[id]}/reppol


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpRepP Properties

The following table contains information about the igmpRepP 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
pfxListstring:Basic
Prefix ListA sequence of characters
rtMapstring:Basic
Route MapA sequence of characters
useAccessGrpCommandscalar:Bool
Flag to use access-groupSELECTION: 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

Configuring an IGMP Report Policy with a Prefix List

Configuring an IGMP Report Policy with a Prefix List
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpRepP": {
                      "attributes": {
                        "pfxList": "List1",
                        "rtMap": "",
                        "useAccessGrpCommand": "no"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <reppol-items>
                <pfxList>List1</pfxList>
                <rtMap></rtMap>
                <useAccessGrpCommand>false</useAccessGrpCommand>
              </reppol-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 ip igmp report-policy prefix-list List1

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpRepP sys/igmp/inst/dom-{name}/if-{[id]}/reppol


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpRepP Properties

The following table contains information about the igmpRepP 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
pfxListstring:Basic
Prefix ListA sequence of characters
rtMapstring:Basic
Route MapA sequence of characters
useAccessGrpCommandscalar:Bool
Flag to use access-groupSELECTION: 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

Configuring an IGMP Access Group with a Route Map

Configuring an IGMP Access Group with a Route Map
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpRepP": {
                      "attributes": {
                        "pfxList": "",
                        "rtMap": "map1",
                        "useAccessGrpCommand": "yes"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <reppol-items>
                <pfxList></pfxList>
                <rtMap>map1</rtMap>
                <useAccessGrpCommand>true</useAccessGrpCommand>
              </reppol-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 ip igmp access-group map1

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpRepP sys/igmp/inst/dom-{name}/if-{[id]}/reppol


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpRepP Properties

The following table contains information about the igmpRepP 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
pfxListstring:Basic
Prefix ListA sequence of characters
rtMapstring:Basic
Route MapA sequence of characters
useAccessGrpCommandscalar:Bool
Flag to use access-groupSELECTION: 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

Disabling an IGMP Report Policy with a Prefix List

Disabling an IGMP Report Policy with a Prefix List
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpRepP": {
                      "attributes": {
                        "pfxList": "",
                        "rtMap": "",
                        "useAccessGrpCommand": "no"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <reppol-items>
                <pfxList></pfxList>
                <rtMap></rtMap>
                <useAccessGrpCommand>false</useAccessGrpCommand>
              </reppol-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 no ip igmp report-policy prefix-list List1

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpRepP sys/igmp/inst/dom-{name}/if-{[id]}/reppol


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpRepP Properties

The following table contains information about the igmpRepP 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
pfxListstring:Basic
Prefix ListA sequence of characters
rtMapstring:Basic
Route MapA sequence of characters
useAccessGrpCommandscalar:Bool
Flag to use access-groupSELECTION: 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

Disabling an IGMP Access Group with a Route Map

Disabling an IGMP Access Group with a Route Map
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpRepP": {
                      "attributes": {
                        "pfxList": "",
                        "rtMap": "",
                        "useAccessGrpCommand": "no"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <reppol-items>
                <pfxList></pfxList>
                <rtMap></rtMap>
                <useAccessGrpCommand>false</useAccessGrpCommand>
              </reppol-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 no ip igmp access-group map1

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpRepP sys/igmp/inst/dom-{name}/if-{[id]}/reppol


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpRepP Properties

The following table contains information about the igmpRepP 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
pfxListstring:Basic
Prefix ListA sequence of characters
rtMapstring:Basic
Route MapA sequence of characters
useAccessGrpCommandscalar:Bool
Flag to use access-groupSELECTION: 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

Configuring Group Membership Timeout for IGMPv2

Configuring Group Membership Timeout for IGMPv2
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "grpTimeout": "123",
                  "id": "eth1/1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <grpTimeout>123</grpTimeout>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 ip igmp group-timeout 123

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

The following table contains information about the igmpIf 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
grpTimeoutipmc:GrpTimeout
(scalar:Uint16)
Group Membership Timeout
RANGE: [3 , 65535]
DEFAULT: 260
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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 Group Membership Timeout for IGMPv2

Disabling Group Membership Timeout for IGMPv2
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "grpTimeout": "260",
                  "id": "eth1/1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <grpTimeout>260</grpTimeout>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 no ip igmp group-timeout 123

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

The following table contains information about the igmpIf 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
grpTimeoutipmc:GrpTimeout
(scalar:Uint16)
Group Membership Timeout
RANGE: [3 , 65535]
DEFAULT: 260
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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 Number of Group-Specific Queries

Configuring the Number of Group-Specific Queries
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpQuerierP": {
                      "attributes": {
                        "lastMbrCnt": "2"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <querierp-items>
                <lastMbrCnt>2</lastMbrCnt>
              </querierp-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 ip igmp last-member-query-count 2

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpQuerierP sys/igmp/inst/dom-{name}/if-{[id]}/querierp


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpQuerierP Properties

The following table contains information about the igmpQuerierP 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
lastMbrCntmcast:LastMbrQueryCnt
(scalar:Uint16)
Last Member Query Count
RANGE: [1 , 5]
DEFAULT: 2


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 Number of Group-Specific Queries

Disabling the Number of Group-Specific Queries
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpQuerierP": {
                      "attributes": {
                        "lastMbrCnt": "2"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <querierp-items>
                <lastMbrCnt>2</lastMbrCnt>
              </querierp-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 no ip igmp last-member-query-count 2

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpQuerierP sys/igmp/inst/dom-{name}/if-{[id]}/querierp


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpQuerierP Properties

The following table contains information about the igmpQuerierP 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
lastMbrCntmcast:LastMbrQueryCnt
(scalar:Uint16)
Last Member Query Count
RANGE: [1 , 5]
DEFAULT: 2


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 Last Member Query Response Time

Configuring the Last Member Query Response Time
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpQuerierP": {
                      "attributes": {
                        "lastMbrRespTime": "2"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <querierp-items>
                <lastMbrRespTime>2</lastMbrRespTime>
              </querierp-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 ip igmp last-member-query-response-time 2

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpQuerierP sys/igmp/inst/dom-{name}/if-{[id]}/querierp


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpQuerierP Properties

The following table contains information about the igmpQuerierP 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
lastMbrRespTimemcast:LastMbrRespTime
(scalar:Uint16)
Last Member Response Time
RANGE: [1 , 25]
DEFAULT: 1


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 Last Member Query Response Time

Disabling the Last Member Query Response Time
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpQuerierP": {
                      "attributes": {
                        "lastMbrRespTime": "1"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <querierp-items>
                <lastMbrRespTime>1</lastMbrRespTime>
              </querierp-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 no ip igmp last-member-query-response-time 2

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpQuerierP sys/igmp/inst/dom-{name}/if-{[id]}/querierp


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpQuerierP Properties

The following table contains information about the igmpQuerierP 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
lastMbrRespTimemcast:LastMbrRespTime
(scalar:Uint16)
Last Member Response Time
RANGE: [1 , 25]
DEFAULT: 1


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 Interval Between Query Transmission

Configuring the Interval Between Query Transmission
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpQuerierP": {
                      "attributes": {
                        "queryIntvl": "123"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <querierp-items>
                <queryIntvl>123</queryIntvl>
              </querierp-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 ip igmp query-interval 123

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpQuerierP sys/igmp/inst/dom-{name}/if-{[id]}/querierp


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpQuerierP Properties

The following table contains information about the igmpQuerierP 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
queryIntvlmcast:QueryIntvl
(scalar:Uint16)
Query Interval
RANGE: [1 , 18000]
DEFAULT: 125


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 Interval Between Query Transmission

Disabling the Interval Between Query Transmission
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpQuerierP": {
                      "attributes": {
                        "queryIntvl": "125"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <querierp-items>
                <queryIntvl>125</queryIntvl>
              </querierp-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 no ip igmp query-interval 123

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpQuerierP sys/igmp/inst/dom-{name}/if-{[id]}/querierp


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpQuerierP Properties

The following table contains information about the igmpQuerierP 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
queryIntvlmcast:QueryIntvl
(scalar:Uint16)
Query Interval
RANGE: [1 , 18000]
DEFAULT: 125


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 Maximum Response Time for Query Messages

Configuring the Maximum Response Time for Query Messages
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpQuerierP": {
                      "attributes": {
                        "rspIntvl": "12"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <querierp-items>
                <rspIntvl>12</rspIntvl>
              </querierp-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 ip igmp query-max-response-time 12

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpQuerierP sys/igmp/inst/dom-{name}/if-{[id]}/querierp


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpQuerierP Properties

The following table contains information about the igmpQuerierP 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
rspIntvlmcast:QueryRspIntvl
(scalar:Uint16)
Response Interval of Querier
RANGE: [1 , 8387]
DEFAULT: 10


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 Maximum Response Time for Query Messages

Disabling the Maximum Response Time for Query Messages
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpQuerierP": {
                      "attributes": {
                        "rspIntvl": "10"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <querierp-items>
                <rspIntvl>10</rspIntvl>
              </querierp-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 no ip igmp query-max-response-time 12

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpQuerierP sys/igmp/inst/dom-{name}/if-{[id]}/querierp


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpQuerierP Properties

The following table contains information about the igmpQuerierP 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
rspIntvlmcast:QueryRspIntvl
(scalar:Uint16)
Response Interval of Querier
RANGE: [1 , 8387]
DEFAULT: 10


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 RFC-Defined Robustness Variable

Configuring the RFC-Defined Robustness Variable
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpQuerierP": {
                      "attributes": {
                        "robustFac": "1"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <querierp-items>
                <robustFac>1</robustFac>
              </querierp-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 ip igmp robustness-variable 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.

MODN
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpQuerierP sys/igmp/inst/dom-{name}/if-{[id]}/querierp


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpQuerierP Properties

The following table contains information about the igmpQuerierP 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
robustFacmcast:RobustFactor
(scalar:UByte)
Robustness Factor
RANGE: [1 , 7]
DEFAULT: 2


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 RFC-Defined Robustness Variable

Disabling the RFC-Defined Robustness Variable
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpQuerierP": {
                      "attributes": {
                        "robustFac": "2"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <querierp-items>
                <robustFac>2</robustFac>
              </querierp-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 no ip igmp robustness-variable 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.

MODN
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpQuerierP sys/igmp/inst/dom-{name}/if-{[id]}/querierp


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpQuerierP Properties

The following table contains information about the igmpQuerierP 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
robustFacmcast:RobustFactor
(scalar:UByte)
Robustness Factor
RANGE: [1 , 7]
DEFAULT: 2


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 Number of Queries Sent at Startup

Configuring the Number of Queries Sent at Startup
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpQuerierP": {
                      "attributes": {
                        "startQueryCnt": "1"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <querierp-items>
                <startQueryCnt>1</startQueryCnt>
              </querierp-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 ip igmp startup-query-count 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.

MODN
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpQuerierP sys/igmp/inst/dom-{name}/if-{[id]}/querierp


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpQuerierP Properties

The following table contains information about the igmpQuerierP 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
startQueryCntmcast:QueryCnt
(scalar:UByte)
Startup Query Count
RANGE: [0 , 10]


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 Number of Queries Sent at Startup

Disabling the Number of Queries Sent at Startup
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpQuerierP": {
                      "attributes": {
                        "startQueryCnt": "2"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <querierp-items>
                <startQueryCnt>2</startQueryCnt>
              </querierp-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 no ip igmp startup-query-count 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.

MODN
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpQuerierP sys/igmp/inst/dom-{name}/if-{[id]}/querierp


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpQuerierP Properties

The following table contains information about the igmpQuerierP 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
startQueryCntmcast:QueryCnt
(scalar:UByte)
Startup Query Count
RANGE: [0 , 10]


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 Query Interval at Startup

Configuring the Query Interval at Startup
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpQuerierP": {
                      "attributes": {
                        "startQueryIntvl": "123"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <querierp-items>
                <startQueryIntvl>123</startQueryIntvl>
              </querierp-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 ip igmp startup-query-interval 123

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpQuerierP sys/igmp/inst/dom-{name}/if-{[id]}/querierp


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpQuerierP Properties

The following table contains information about the igmpQuerierP 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
startQueryIntvlmcast:StartQueryIntvl
(scalar:Uint16)
Startup Query Interval
RANGE: [0 , 18000]
DEFAULT: 31


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 Query Interval at Startup

Disabling the Query Interval at Startup
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpQuerierP": {
                      "attributes": {
                        "startQueryIntvl": "31"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <querierp-items>
                <startQueryIntvl>31</startQueryIntvl>
              </querierp-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 no ip igmp startup-query-interval 123

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpQuerierP sys/igmp/inst/dom-{name}/if-{[id]}/querierp


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpQuerierP Properties

The following table contains information about the igmpQuerierP 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
startQueryIntvlmcast:StartQueryIntvl
(scalar:Uint16)
Startup Query Interval
RANGE: [0 , 18000]
DEFAULT: 31


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 Querier Timeout for IGMPv2

Configuring the Querier Timeout for IGMPv2
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpQuerierP": {
                      "attributes": {
                        "querierTimeout": "123"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <querierp-items>
                <querierTimeout>123</querierTimeout>
              </querierp-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 ip igmp querier-timeout 123

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpQuerierP sys/igmp/inst/dom-{name}/if-{[id]}/querierp


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpQuerierP Properties

The following table contains information about the igmpQuerierP 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
querierTimeoutmcast:QuerierTimeout
(scalar:Uint16)
Querier Timeout
RANGE: [1 , 0xffff]
DEFAULT: 255


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 Querier Timeout for IGMPv2

Disabling the Querier Timeout for IGMPv2
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpQuerierP": {
                      "attributes": {
                        "querierTimeout": "255"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <querierp-items>
                <querierTimeout>255</querierTimeout>
              </querierp-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 no ip igmp querier-timeout 123

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpQuerierP sys/igmp/inst/dom-{name}/if-{[id]}/querierp


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpQuerierP Properties

The following table contains information about the igmpQuerierP 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
querierTimeoutmcast:QuerierTimeout
(scalar:Uint16)
Querier Timeout
RANGE: [1 , 0xffff]
DEFAULT: 255


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 Querier Timeout for IGMPv2

Configuring the Querier Timeout for IGMPv2
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpQuerierP": {
                      "attributes": {
                        "querierTimeout": "123"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <querierp-items>
                <querierTimeout>123</querierTimeout>
              </querierp-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 ip igmp query-timeout 123

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpQuerierP sys/igmp/inst/dom-{name}/if-{[id]}/querierp


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpQuerierP Properties

The following table contains information about the igmpQuerierP 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
querierTimeoutmcast:QuerierTimeout
(scalar:Uint16)
Querier Timeout
RANGE: [1 , 0xffff]
DEFAULT: 255


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 Querier Timeout for IGMPv2

Disabling the Querier Timeout for IGMPv2
POST http://<mgmt0_IP>/api/mo/sys/igmp.json
{
  "igmpInst": {
    "children": [
      {
        "igmpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "igmpIf": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "igmpQuerierP": {
                      "attributes": {
                        "querierTimeout": "255"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <querierp-items>
                <querierTimeout>255</querierTimeout>
              </querierp-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
</System>

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


CLI Commands

interface ethernet 1/1
 no ip igmp query-timeout 123

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
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpQuerierP sys/igmp/inst/dom-{name}/if-{[id]}/querierp


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpQuerierP Properties

The following table contains information about the igmpQuerierP 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
querierTimeoutmcast:QuerierTimeout
(scalar:Uint16)
Querier Timeout
RANGE: [1 , 0xffff]
DEFAULT: 255


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 Source Address for IGMPv3 (S,G) Channel

Configuring the Source Address for IGMPv3 (S,G) Channel
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "igmpEntity": {
          "children": [
            {
              "igmpInst": {
                "children": [
                  {
                    "igmpDom": {
                      "attributes": {
                        "name": "default"
                      },
                      "children": [
                        {
                          "igmpIf": {
                            "attributes": {
                              "id": "eth1/2"
                            },
                            "children": [
                              {
                                "igmpJoinType": {
                                  "attributes": {
                                    "type": "0"
                                  },
                                  "children": [
                                    {
                                      "igmpVersion": {
                                        "attributes": {
                                          "version": "3"
                                        },
                                        "children": [
                                          {
                                            "igmpGroup": {
                                              "attributes": {
                                                "grp": "239.255.255.255"
                                              },
                                              "children": [
                                                {
                                                  "igmpSource": {
                                                    "attributes": {
                                                      "src": "1.2.3.4",
                                                      "useStaticOif": "no"
                                                    }
                                                  }
                                                }
                                              ]
                                            }
                                          }
                                        ]
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/2</id>
              <jointype-items>
                <JoinType-list>
                  <type>0</type>
                  <ver-items>
                    <Version-list>
                      <version>3</version>
                      <group-items>
                        <Group-list>
                          <grp>239.255.255.255</grp>
                          <source-items>
                            <Source-list>
                              <src>1.2.3.4</src>
                              <useStaticOif>false</useStaticOif>
                            </Source-list>
                          </source-items>
                        </Group-list>
                      </group-items>
                    </Version-list>
                  </ver-items>
                </JoinType-list>
              </jointype-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

Note: This example was added in Release 9.2(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
 ip igmp static-group 239.255.255.255 source 1.2.3.4

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
topSystem sys
igmpEntity sys/igmp
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpJoinType sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}
igmpVersion sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}/ver-{version}
igmpGroup sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}/ver-{version}/group-{[grp]}
igmpSource sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}/ver-{version}/group-{[grp]}/source-{[src]}
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-{[id]}


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpJoinType Properties

The following table contains information about the igmpJoinType 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
typeipmc:JoinType
(scalar:Enum8)
Join Type of the Groups. Supported Types Include Static or Join.SELECTION:
0 - 0
1 - 1


igmpVersion Properties

The following table contains information about the igmpVersion 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
versionipmc:Ver
(scalar:Enum8)
IGMP Group VersionSELECTION:
0 - unspecified
2 - 2
3 - 3


igmpGroup Properties

The following table contains information about the igmpGroup 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
grpaddress:Ip
Route IP Address for Choosing GroupsValue must match ipv4 or ipv6 known format


igmpSource Properties

The following table contains information about the igmpSource 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
srcaddress:Ip
IGMP Source IP AddressValue must match ipv4 or ipv6 known format
useStaticOifscalar:Bool
Indicates if Static Outgoing Interface is being usedSELECTION: true or false
DEFAULT: true


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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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 Source Address for IGMPv3 (S,G) Channel

Deleting the Source Address for IGMPv3 (S,G) Channel
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "igmpEntity": {
          "children": [
            {
              "igmpInst": {
                "children": [
                  {
                    "igmpDom": {
                      "attributes": {
                        "name": "default"
                      },
                      "children": [
                        {
                          "igmpIf": {
                            "attributes": {
                              "id": "eth1/2"
                            },
                            "children": [
                              {
                                "igmpJoinType": {
                                  "attributes": {
                                    "type": "0"
                                  },
                                  "children": [
                                    {
                                      "igmpVersion": {
                                        "attributes": {
                                          "version": "3"
                                        },
                                        "children": [
                                          {
                                            "igmpGroup": {
                                              "attributes": {
                                                "grp": "239.255.255.255"
                                              },
                                              "children": [
                                                {
                                                  "igmpSource": {
                                                    "attributes": {
                                                      "src": "1.2.3.4",
                                                      "status": "deleted"
                                                    }
                                                  }
                                                }
                                              ]
                                            }
                                          }
                                        ]
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/2</id>
              <jointype-items>
                <JoinType-list>
                  <type>0</type>
                  <ver-items>
                    <Version-list>
                      <version>3</version>
                      <group-items>
                        <Group-list>
                          <grp>239.255.255.255</grp>
                          <source-items>
                            <Source-list xc:operation="delete">
                              <src>1.2.3.4</src>
                            </Source-list>
                          </source-items>
                        </Group-list>
                      </group-items>
                    </Version-list>
                  </ver-items>
                </JoinType-list>
              </jointype-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

Note: This example was added in Release 9.2(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
 no ip igmp static-group 239.255.255.255 source 1.2.3.4

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
topSystem sys
igmpEntity sys/igmp
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpJoinType sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}
igmpVersion sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}/ver-{version}
igmpGroup sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}/ver-{version}/group-{[grp]}
igmpSource sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}/ver-{version}/group-{[grp]}/source-{[src]}
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-{[id]}


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpJoinType Properties

The following table contains information about the igmpJoinType 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
typeipmc:JoinType
(scalar:Enum8)
Join Type of the Groups. Supported Types Include Static or Join.SELECTION:
0 - 0
1 - 1


igmpVersion Properties

The following table contains information about the igmpVersion 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
versionipmc:Ver
(scalar:Enum8)
IGMP Group VersionSELECTION:
0 - unspecified
2 - 2
3 - 3


igmpGroup Properties

The following table contains information about the igmpGroup 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
grpaddress:Ip
Route IP Address for Choosing GroupsValue must match ipv4 or ipv6 known format


igmpSource Properties

The following table contains information about the igmpSource 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
srcaddress:Ip
IGMP Source IP AddressValue must match ipv4 or ipv6 known format
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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 Static OIF for a Multicast Forwarding Entry

Configuring Static OIF for a Multicast Forwarding Entry
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "igmpEntity": {
          "children": [
            {
              "igmpInst": {
                "children": [
                  {
                    "igmpDom": {
                      "attributes": {
                        "name": "default"
                      },
                      "children": [
                        {
                          "igmpIf": {
                            "attributes": {
                              "id": "eth1/2"
                            },
                            "children": [
                              {
                                "igmpJoinType": {
                                  "attributes": {
                                    "type": "0"
                                  },
                                  "children": [
                                    {
                                      "igmpVersion": {
                                        "attributes": {
                                          "version": "3"
                                        },
                                        "children": [
                                          {
                                            "igmpGroup": {
                                              "attributes": {
                                                "grp": "237.1.1.0"
                                              },
                                              "children": [
                                                {
                                                  "igmpSource": {
                                                    "attributes": {
                                                      "src": "1.2.3.4",
                                                      "useStaticOif": "yes"
                                                    }
                                                  }
                                                }
                                              ]
                                            }
                                          }
                                        ]
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/2</id>
              <jointype-items>
                <JoinType-list>
                  <type>0</type>
                  <ver-items>
                    <Version-list>
                      <version>3</version>
                      <group-items>
                        <Group-list>
                          <grp>237.1.1.0</grp>
                          <source-items>
                            <Source-list>
                              <src>1.2.3.4</src>
                              <useStaticOif>true</useStaticOif>
                            </Source-list>
                          </source-items>
                        </Group-list>
                      </group-items>
                    </Version-list>
                  </ver-items>
                </JoinType-list>
              </jointype-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

Note: This example was added in Release 9.2(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
 ip igmp static-oif 237.1.1.0 source 1.2.3.4

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
topSystem sys
igmpEntity sys/igmp
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpJoinType sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}
igmpVersion sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}/ver-{version}
igmpGroup sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}/ver-{version}/group-{[grp]}
igmpSource sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}/ver-{version}/group-{[grp]}/source-{[src]}
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-{[id]}


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpJoinType Properties

The following table contains information about the igmpJoinType 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
typeipmc:JoinType
(scalar:Enum8)
Join Type of the Groups. Supported Types Include Static or Join.SELECTION:
0 - 0
1 - 1


igmpVersion Properties

The following table contains information about the igmpVersion 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
versionipmc:Ver
(scalar:Enum8)
IGMP Group VersionSELECTION:
0 - unspecified
2 - 2
3 - 3


igmpGroup Properties

The following table contains information about the igmpGroup 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
grpaddress:Ip
Route IP Address for Choosing GroupsValue must match ipv4 or ipv6 known format


igmpSource Properties

The following table contains information about the igmpSource 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
srcaddress:Ip
IGMP Source IP AddressValue must match ipv4 or ipv6 known format
useStaticOifscalar:Bool
Indicates if Static Outgoing Interface is being usedSELECTION: true or false
DEFAULT: true


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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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 Static OIF for a Multicast Forwarding Entry

Deleting Static OIF for a Multicast Forwarding Entry
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "igmpEntity": {
          "children": [
            {
              "igmpInst": {
                "children": [
                  {
                    "igmpDom": {
                      "attributes": {
                        "name": "default"
                      },
                      "children": [
                        {
                          "igmpIf": {
                            "attributes": {
                              "id": "eth1/2"
                            },
                            "children": [
                              {
                                "igmpJoinType": {
                                  "attributes": {
                                    "type": "0"
                                  },
                                  "children": [
                                    {
                                      "igmpVersion": {
                                        "attributes": {
                                          "version": "3"
                                        },
                                        "children": [
                                          {
                                            "igmpGroup": {
                                              "attributes": {
                                                "grp": "237.1.1.0"
                                              },
                                              "children": [
                                                {
                                                  "igmpSource": {
                                                    "attributes": {
                                                      "src": "1.2.3.4",
                                                      "status": "deleted"
                                                    }
                                                  }
                                                }
                                              ]
                                            }
                                          }
                                        ]
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <igmp-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/2</id>
              <jointype-items>
                <JoinType-list>
                  <type>0</type>
                  <ver-items>
                    <Version-list>
                      <version>3</version>
                      <group-items>
                        <Group-list>
                          <grp>237.1.1.0</grp>
                          <source-items>
                            <Source-list xc:operation="delete">
                              <src>1.2.3.4</src>
                            </Source-list>
                          </source-items>
                        </Group-list>
                      </group-items>
                    </Version-list>
                  </ver-items>
                </JoinType-list>
              </jointype-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </igmp-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

Note: This example was added in Release 9.2(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
 no ip igmp static-oif 237.1.1.0 source 1.2.3.4

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
topSystem sys
igmpEntity sys/igmp
igmpInst sys/igmp/inst
igmpDom sys/igmp/inst/dom-{name}
igmpIf sys/igmp/inst/dom-{name}/if-{[id]}
igmpJoinType sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}
igmpVersion sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}/ver-{version}
igmpGroup sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}/ver-{version}/group-{[grp]}
igmpSource sys/igmp/inst/dom-{name}/if-{[id]}/jointype-{type}/ver-{version}/group-{[grp]}/source-{[src]}
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-{[id]}


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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


igmpIf Properties

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


igmpJoinType Properties

The following table contains information about the igmpJoinType 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
typeipmc:JoinType
(scalar:Enum8)
Join Type of the Groups. Supported Types Include Static or Join.SELECTION:
0 - 0
1 - 1


igmpVersion Properties

The following table contains information about the igmpVersion 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
versionipmc:Ver
(scalar:Enum8)
IGMP Group VersionSELECTION:
0 - unspecified
2 - 2
3 - 3


igmpGroup Properties

The following table contains information about the igmpGroup 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
grpaddress:Ip
Route IP Address for Choosing GroupsValue must match ipv4 or ipv6 known format


igmpSource Properties

The following table contains information about the igmpSource 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
srcaddress:Ip
IGMP Source IP AddressValue must match ipv4 or ipv6 known format
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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