Web Services API Guide, Cisco DCNM for LAN, Release 5.x
IgmpSnoopingApp Service
Downloads: This chapterpdf (PDF - 97.0KB) The complete bookPDF (PDF - 11.08MB) | Feedback

IgmpSnoopingApp Service

Table Of Contents

IgmpSnoopingApp Service

Information About IgmpSnoopingApp Service

addIgmpSnoopingMrouterInterfaces

createIgmpSnoopingGroupStaticBinding

deleteIgmpSnoopingGroupStaticBindings

disableIgmpSnoopingOnVdcs

disableIgmpSnoopingOnVlans

enableIgmpSnoopingOnVdcs

enableIgmpSnoopingOnVlans

fetchIgmpSnoopingGroupStatusData

fetchIgmpSnoopingMrouterStatusData

fetchIgmpSnoopingQuerierStatusData

fetchIgmpSnoopingTrackingHostsStatusData

getIgmpSnoopingGlobalSettings

getIgmpSnoopingGroupStaticBindings

getIgmpSnoopingGroupStatusData

getIgmpSnoopingMrouterInterfaces

getIgmpSnoopingMrouterStatusData

getIgmpSnoopingQuerierStatusData

getIgmpSnoopingTrackingHostStatusData

getIgmpSnoopingVlanSettings

modifyIgmpSnoopingGlobalSettings

modifyIgmpSnoopingVlanSettings

removeIgmpSnoopingMrouterInterfaces


IgmpSnoopingApp Service


This chapter describes the DCNM web services' API methods for the IgmpSnoopingApp service. This API is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.0(3) or later.

Information About IgmpSnoopingApp Service

The Cisco NX-OS Internet Group Management Protocol (IGMP) snooping software examines the Layer 2 IP multicast traffic within a VLAN to discover the ports where interested receivers reside. Using the port information, IGMP snooping can reduce bandwidth consumption in a multi-access LAN environment to avoid overloading the entire VLAN. The IGMP snooping feature tracks the ports that are attached to multicast-capable routers to help the routers forward IGMP membership reports. The Cisco NX-OS IGMP snooping software operates on the IGMPv1, IGMPv2, and IGMPv3 control plane packets where Layer 3 control plane packets are intercepted and influence the Layer 2 forwarding behavior. DCNM supports IGMP snooping for IPV4 networks. The Cisco NX-OS IGMP snooping software has the following proprietary features:

Source filtering that allows forwarding of multicast packets based on destination and source IP.

Multicast forwarding based on the IP address rather than the MAC address.

Optimized multicast flooding (OMF) that forwards unknown traffic to routers only and performs no data-driven state creation.

addIgmpSnoopingMrouterInterfaces

Configures Mulitcast router interfaces for the given VLAN

Parameters

opContext - operational Context

networkInterfaceInstanceNameIdCol - List of Instance name ID of Multicast router interfaces

createIgmpSnoopingGroupStaticBinding

Configures static multicast group address / source address for multicast traffic entry on a network interface for the given VLAN

Parameters

opContext - operational Context

vlanInstanceNameId -

staticMulticastGroupAddress - Static multicast group address

sourceAddress - Source address for multicast traffic

networkInterfaceInstanceNameId - Instance name ID of NetworkInterface on which the static multicast group address / source address for multicast traffic entry is to be configured

Returns

Instance name ID of IgmpSnoopingGroupStaticBinding

deleteIgmpSnoopingGroupStaticBindings

Removes static multicast group address / source address for multicast traffic entries for the given VLAN

Parameters

opContext - operational Context

igmpSnoopingGroupStaticBindingInstanceNameIdCol - List of Instance name ID of IgmpSnoopingGroupStaticBinding to be deleted

disableIgmpSnoopingOnVdcs

Disables IGMP Snooping for the given VDCs

Parameters

opContext - operational Context

networkElementInstanceNameIdCol - List of Instance name ID of network element for which to disable IGMP Snooping

disableIgmpSnoopingOnVlans

Disables IGMP Snooping for the given VLANs

Parameters

opContext - operational Context

networkElementInstanceNameIdCol - List of Instance name ID of VLAN for which to disable IGMP Snooping

enableIgmpSnoopingOnVdcs

Enables IGMP Snooping for the given VDCs

Parameters

opContext - operational Context

networkElementInstanceNameIdCol - List of Instance name ID of network element for which to enable IGMP Snooping

enableIgmpSnoopingOnVlans

Enables IGMP Snooping for the given VLANs

Parameters

opContext - operational Context

networkElementInstanceNameIdCol - List of Instance name ID of VLAN for which to enable IGMP Snooping

fetchIgmpSnoopingGroupStatusData

Retrieves the latest IgmpSnoopingGroupStatusData for the given VLAN from the device & updates the DB. Sends a summary event after successful retrieval

Parameters

opContext - operational Context

vlanId - Instance name ID of VLAN for which the status data should be retrieved from the device

fetchIgmpSnoopingMrouterStatusData

Retrieves the latest IgmpSnoopingMrouterStatusData for the given VLAN from the device & updates the DB. Sends a summary event after successful retrieval

Parameters

opContext - operational Context

vlanId - Instance name ID of VLAN for which the status data should be retrieved from the device

fetchIgmpSnoopingQuerierStatusData

Retrieves the latest IgmpSnoopingQuerierStatusData for the given VLAN from the device & updates the DB. Sends a summary event after successful retrieval

Parameters

opContext - operational Context

vlanId - Instance name ID of VLAN for which the status data should be retrieved from the device

fetchIgmpSnoopingTrackingHostsStatusData

Retrieves the latest IgmpSnoopingTrackingHostsStatusData for the given VLAN from the device & updates the DB. Sends a summary event after successful retrieval

Parameters

opContext - operational Context

vlanId - Instance name ID of VLAN for which the status data should be retrieved from the device

getIgmpSnoopingGlobalSettings

Returns IGMP Snooping global settings for the given network devices.

Parameters

opContext - operational Context

networkElementInstanceNameIdCol - List of Instance name ID of network element for which IgmpSnoopingGlobalSetting is queried.

Returns

List of IgmpSnoopingGlobalSetting instances

getIgmpSnoopingGroupStaticBindings

Returns statically configured multicast group address / source address for multicast traffic entries for the given VLAN

Parameters

opContext - operational Context

vlanInstanceNameId - Instance name ID of VLAN for which statically configured multicast group address / source address for multicast traffic are queried

Returns

List of IgmpSnoopingGroupStaticBinding instances

getIgmpSnoopingGroupStatusData

Retrieves the IGMP snooping multicast group status data for the given VLAN from the DB

Parameters

opContext - operational Context

vlanId - Instance name ID of VLAN for which the status data should be retrieved

Returns

List of status data

getIgmpSnoopingMrouterInterfaces

Returns network interfaces that are statically connected to Multicast routers for the given VLAN

Parameters

opContext - operational Context

vlanInstanceNameId - Instance name ID of VLAN for which multicast router interfaces are queried

Returns

List of NetworkInterface instances

getIgmpSnoopingMrouterStatusData

Retrieves the IGMP snooping multicast router status data for the given VLAN from the DB

Parameters

opContext - operational Context

vlanId - Instance name ID of VLAN for which the status data should be retrieved

Returns

List of status data

getIgmpSnoopingQuerierStatusData

Retrieves the IGMP snooping querier router status data for the given VLAN from the DB

Parameters

opContext - operational Context

vlanId - Instance name ID of VLAN for which the status data should be retrieved

Returns

List of status data

getIgmpSnoopingTrackingHostStatusData

Retrieves the IGMP snooping host status data for the given VLAN from the DB

Parameters

opContext - operational Context

vlanId - Instance name ID of VLAN for which the status data should be retrieved

Returns

List of status data

getIgmpSnoopingVlanSettings

Returns IGMP Snooping settings for the given VLANs.

Parameters

opContext - operational Context

vlanInstanceNameIdCol - List of Instance name ID of VLAN for which IgmpSnoopingVlanSetting is queried.

Returns

List of IgmpSnoopingVlanSetting instances

modifyIgmpSnoopingGlobalSettings

Modifies IGMP Snooping global settings for the given network devices.

Parameters

opContext - operational Context

igmpSnoopingGlobalSettingCol - List of IgmpSnoopingGlobalSetting instances with modified values

modifyIgmpSnoopingVlanSettings

Modifies IGMP Snooping settings for the given VLANs.

Parameters

opContext - operational Context

igmpSnoopVlanSettingCol - List of IgmpSnoopingVlanSetting instances with modified values

removeIgmpSnoopingMrouterInterfaces

Removes Mulitcast router interfaces for the given VLAN

Parameters

opContext - operational Context

vlanInstanceNameId - Instance name ID of VLAN for which the multicast router interfaces are removed

networkInterfaceInstanceNameIdCol - List of Instance name ID of Multicast router interfaces