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

Latest

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Querying IP IGMP Groups: Batch 1 of 2

DME

Copy
GET http://<IP_Address>/api/mo/sys/igmp/inst/routedb/vrf-[default]/group-[230.0.0.0].json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-size=14&batch-id=1
Response
{
    "totalCount": "1",
    "imdata": [
        {
            "igmpRouteGroup": {
                "attributes": {
                    "dn": "sys/igmp/inst/routedb/vrf-default/group-[230.0.0.0]",
                    "grpAddr": "230.0.0.0"
                },
                "children": [
                    {
                        "igmpRouteSource": {
                            "attributes": {
                                "oifcount": "0",
                                "rn": "source-[0.0.0.0]",
                                "srcAddr": "0.0.0.0"
                            },
                            "children": [
                                {
                                    "igmpRouteOif": {
                                        "attributes": {
                                            "hostProxy": "no",
                                            "local": "no",
                                            "oif": "eth1/1",
                                            "rn": "oif-[eth1/1]",
                                            "static": "yes",
                                            "uptime": "1969-12-31T17:00:18.739+00:00"
                                        }
                                    }
                                }
                            ]
                        }
                    }
                ]
            }
        },
        {
            "warning": {
                "attributes": {
                    "text": "backend rv=43700005, Dumped entries into ephemeral objstore"
                }
            }
        }
    ]
}

Querying IP IGMP Groups

Querying IP IGMP Groups: Batch 1 of 2

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

igmpRouteGroup Properties

The following table contains information about the igmpRouteGroup properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
dn	reference:BinRef	A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
grpAddr	address:Ip	Group IP Address	Value must match ipv4 or ipv6 known format

igmpRouteSource Properties

The following table contains information about the igmpRouteSource properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
oifcount	scalar:Uint32	Outgoing Interface (OIF) Count	RANGE: [0, 4294967295]
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
srcAddr	address:Ip	IGMP Route Source IP Address	Value must match ipv4 or ipv6 known format

igmpRouteOif Properties

The following table contains information about the igmpRouteOif properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
hostProxy	scalar:Bool	Indicates if Host is Proxy	SELECTION: true or false
local	scalar:Bool	Indicates if the Route is Local	SELECTION: true or false
oif	nw:IfId (base:IfIndex)	Outgoing interface	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
static	scalar:Bool	Indicates if the Route is Static	SELECTION: true or false
uptime	scalar:Date	Route OIF Uptime Timestamp	DATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z

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

Querying IP IGMP Groups: Batch 2 of 2

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

igmpRouteGroup Properties

Property Name	Data Type	Description	Values
dn	reference:BinRef	A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
grpAddr	address:Ip	Group IP Address	Value must match ipv4 or ipv6 known format

igmpRouteSource Properties

Property Name	Data Type	Description	Values
oifcount	scalar:Uint32	Outgoing Interface (OIF) Count	RANGE: [0, 4294967295]
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
srcAddr	address:Ip	IGMP Route Source IP Address	Value must match ipv4 or ipv6 known format

igmpRouteOif Properties

Property Name	Data Type	Description	Values
hostProxy	scalar:Bool	Indicates if Host is Proxy	SELECTION: true or false
local	scalar:Bool	Indicates if the Route is Local	SELECTION: true or false
oif	nw:IfId (base:IfIndex)	Outgoing interface	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
static	scalar:Bool	Indicates if the Route is Static	SELECTION: true or false
uptime	scalar:Date	Route OIF Uptime Timestamp	DATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z

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

Querying IP IGMP Groups: All Groups

The entries are fetched in batches. To fetch all entries together, increase the batch-size.

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

CLI Output
Switch# show ip igmp groups IGMP Connected Group Membership for VRF "default" - 2 total entries Type: S - Static, D - Dynamic, L - Local, T - SSM Translated, H - Host Proxy Group Address Type Interface Uptime Expires Last Reporter 224.10.10.10 S Ethernet1/1 00:00:05 never 10.10.10.2 230.0.0.0 S Ethernet1/1 00:41:34 never 10.10.10.2

CLI Output

Switch# show ip igmp groups 
IGMP Connected Group Membership for VRF "default" - 2 total entries
Type: S - Static, D - Dynamic, L - Local, T - SSM Translated, H - Host Proxy
Group Address      Type Interface              Uptime    Expires   Last Reporter
224.10.10.10       S    Ethernet1/1            00:00:05  never     10.10.10.2
230.0.0.0          S    Ethernet1/1            00:41:34  never     10.10.10.2

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

igmpRouteDb Properties

The following table contains information about the igmpRouteDb properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
dn	reference:BinRef	A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.

igmpVrf Properties

The following table contains information about the igmpVrf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
name	l3:VrfName (string:Basic)	Virtual Routing and Forwarding Name	A sequence of characters
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.

igmpRouteGroup Properties

Property Name	Data Type	Description	Values
grpAddr	address:Ip	Group IP Address	Value must match ipv4 or ipv6 known format
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.

igmpRouteSource Properties

Property Name	Data Type	Description	Values
oifcount	scalar:Uint32	Outgoing Interface (OIF) Count	RANGE: [0, 4294967295]
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
srcAddr	address:Ip	IGMP Route Source IP Address	Value must match ipv4 or ipv6 known format

igmpRouteOif Properties

Property Name	Data Type	Description	Values
hostProxy	scalar:Bool	Indicates if Host is Proxy	SELECTION: true or false
local	scalar:Bool	Indicates if the Route is Local	SELECTION: true or false
oif	nw:IfId (base:IfIndex)	Outgoing interface	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
static	scalar:Bool	Indicates if the Route is Static	SELECTION: true or false
uptime	scalar:Date	Route OIF Uptime Timestamp	DATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z

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