This document provides a brief description of the L2 Multicast Snooping OpEN APIs. It provides the following services:
- Check if the passed family type snooping is supported or not.
- Get/Set the IGMP/MLD Snooping Admin mode.
- Get the number of multicast control frames processed by the CPU.
- Get the number of multicast data frames forwarded by the CPU.
- Get/Set the IGMP/MLD Proxy Querier Admin mode for the specified snooping instance.
- Get/Set the configured mode for flooding unknown multicast traffic to all ports.
- Flush all Snooping entries and multicast router entries.
- Get the interface mask of interfaces enabled for IGMP/MLD Snooping.
- Set IGMP/MLD Snooping interface mode via a comma separated string.
- Get/Set the IGMP/MLD Snooping mode for the specified interface.
- Get/Set the IGMP/MLD group membership interval for the specified interface.
- Get/Set the IGMP/MLD query response time for the specified interface.
- Get/Set the Fast-Leave Admin mode for the specified interface.
- Get/Set the Proxy Querier Admin mode for the specified interface.
- Check if interface is a valid IGMP/MLD snooping Interface.
- Get the source filter mode (Include or Exclude) for the specified group on the specified interface and VLAN.
- Get the IP address of the source of last membership report received for the specified group address on the specified interface and VLAN.
- Get the first learnt entry from SSM group database.
- Get the next learnt entry from SSM group database.
- Get the current number of entries in the MFDB table.
- Get the exclude port list for a given SSM MFDB entry.
- Get the first learnt entry from SSM MFDB.
- Get the include port list for a given SSM MFDB entry.
- Get next learnt entry from SSM MFDB.
- Get the maximum number of entries that the SSM MFDB table can hold for a given family.
- Get the most number of entries ever in the SSM MFDB table for a given family.
- Validate if the specified source address exists for the specified group address and interface or not.
- Get the next source list entry for the specified group address interface and source address.
- Check if VLAN is eligible for snooping configuration.
- Get next VLAN ID for snooping configuration.
- Get/Set the configured IGMP/MLD snooping fast leave mode for the specified VLAN.
- Get/Set the configured IGMP/MLD snooping group membership interval for the specified VLAN.
- Get/Set the configured IGMP/MLD snooping maximum response time for the specified VLAN.
- Get/Set the IGMP/MLD snooping mode corresponding to the VLAN ID.
- Get/Set the configured snooping proxy querier mode for the specified VLAN of a snoop instance.
- Get/Set the configured IGMP/MLD snooping report suppression mode for the specified VLAN.
- Get/Set the snooping querier configured address of a snoop instance.
- Get/Set the snooping querier admin mode of a snoop instance.
- Get/Set the other querier expiry interval of a snoop instance.
- Get the detected last querier address for specified VLAN ID of a snoop instance.
- Get the detected last querier's version for specified VLAN ID of a snoop instance.
- Get the operational value of max response time for specified VLAN ID of a snoop instance.
- Get the operational state of querier for specified VLAN ID of a snoop instance.
- Get the operational version of querier for specified VLAN ID of a snoop instance.
- Get/Set the snooping querier query interval of a snoop instance.
- Get/Set the snooping querier configured version of a snoop instance.
- Get/Set the snooping querier configured address for specified VLAN ID of a snoop instance.
- Get/Set the configured snooping querier election mode for the specified VLAN ID of a snoop instance.
- Get/Set the configured snooping querier mode for the specified VLAN ID of a snoop instance.
- Get/Set the Auto-Video mode.
- Get the Auto-Video VLAN.
All 'Set' operations would affect the Switch behavior and configuration.
Example C Application snooping_example
Initialization
In the main function, the sample application initializes the OpEN API RPC service by calling openapiClientRegister() and waits for the RPC service in switchdrvr to start. A Client Handle is returned by openapiClientRegister() which is used while invoking the OpEN APIs. The application then exercises the associated OpEN APIs and logs informational and/or error messages on the console. The example application runs to its completion and exits.
snooping_example
snooping_example.c is a sample application that demonstrates the use of the L2 Multicast Snooping OpEN API. snooping_example is started from the command line and exercises all the L2 Multicast Snooping OpEN APIs one by one.
L2 Multicast Snooping CLI/API Cross Reference