Provide L2 Multicast Snooping API's [OPENAPI_SNOOPING]

Macros
#define	OPEN_INTF_LEN   4

Enumerations
enum	OPEN_SNOOP_QUERIER_STATE_t { OPEN_SNOOP_QUERIER_DISABLED = 0, OPEN_SNOOP_QUERIER_QUERIER = 1, OPEN_SNOOP_QUERIER_NON_QUERIER = 2 }
enum	OPEN_SNOOP_SSM_FILTER_MODE_t { OPEN_SNOOP_SSM_FILTER_MODE_NONE = 0, OPEN_SNOOP_SSM_FILTER_MODE_INCLUDE = 1, OPEN_SNOOP_SSM_FILTER_MODE_EXCLUDE = 2 }

Functions
open_error_t	openapiSnoopAdminModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *adminMode, uint8_t family)
	Returns the IGMP/MLD Snooping Admin mode. More...
open_error_t	openapiSnoopAdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t adminMode, uint8_t family)
	Sets the IGMP/MLD Snooping Admin mode. More...
open_error_t	openapiSnoopAutoVideoModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode)
	Gets the Auto-Video mode. More...
open_error_t	openapiSnoopAutoVideoModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets the Auto-Video mode. More...
open_error_t	openapiSnoopAutoVideoVlanGet (openapiClientHandle_t *client_handle, uint32_t *vlanId)
	Gets the Auto-Video VLAN. More...
open_error_t	openapiSnoopControlFramesProcessedGet (openapiClientHandle_t *client_handle, uint32_t *processedFrames, uint8_t family)
	Returns the number of multicast control frames processed by the CPU. More...
open_error_t	openapiSnoopDataFramesForwardedGet (openapiClientHandle_t *client_handle, uint32_t *forwardedFrames, uint8_t family)
	Returns the number of multicast data frames forwarded by the CPU. More...
open_error_t	openapiSnoopEntriesFlush (openapiClientHandle_t *client_handle, uint8_t family)
	Flushes all Snooping entries and multicast router entries. More...
open_error_t	openapiSnoopFastLeaveAutoAssignmentModeGet (openapiClientHandle_t *client_handle, uint8_t family, OPEN_CONTROL_t *mode)
	Get the snooping fast leave auto-assignment global mode. More...
open_error_t	openapiSnoopFastLeaveAutoAssignmentModeSet (openapiClientHandle_t *client_handle, uint8_t family, OPEN_CONTROL_t mode)
	Set the global mode for the Fast Leave Auto Assignment. More...
open_error_t	openapiSnoopFloodUnknownAllPortsGet (openapiClientHandle_t *client_handle, OPEN_BOOL_t *floodAll)
	Returns the configured mode for flooding unknown multicast traffic to all ports. More...
open_error_t	openapiSnoopFloodUnknownAllPortsSet (openapiClientHandle_t *client_handle, OPEN_BOOL_t floodAll)
	Sets the configured mode for flooding unknown multicast traffic to all ports. More...
open_error_t	openapiSnoopIgmpPlusModeGet (openapiClientHandle_t *client_handle, uint8_t family, OPEN_CONTROL_t *mode)
	Get the IGMP plus mode. More...
open_error_t	openapiSnoopIgmpPlusModeSet (openapiClientHandle_t *client_handle, uint8_t family, OPEN_CONTROL_t mode)
	Set the IGMP plus mode. More...
open_error_t	openapiSnoopIntfApiVlanStaticMcastRtrGet (openapiClientHandle_t *client_handle, uint8_t family, uint32_t vlan, uint32_t ifNum, OPEN_CONTROL_t *status)
	Get the IGMP static mcast router attached status for the specified interface/VLAN. More...
open_error_t	openapiSnoopIntfEnabledMaskGet (openapiClientHandle_t *client_handle, open_buffdesc *mask, uint8_t family)
	Returns the interface mask of interfaces enabled for IGMP/MLD Snooping. More...
open_error_t	openapiSnoopIntfEnabledMaskSet (openapiClientHandle_t *client_handle, open_buffdesc *mask, uint8_t family)
	Sets IGMP/MLD Snooping interface mode via a comma separated string. More...
open_error_t	openapiSnoopIntfFastLeaveAdminModeGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_CONTROL_t *mode, uint8_t family)
	Returns the Fast-Leave Admin mode for the specified interface. More...
open_error_t	openapiSnoopIntfFastLeaveAdminModeSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_CONTROL_t mode, uint8_t family)
	Sets the Fast-Leave Admin mode for the specified interface. More...
open_error_t	openapiSnoopIntfFastLeaveOperModeGet (openapiClientHandle_t *client_handle, uint8_t family, uint32_t ifNum, OPEN_CONTROL_t *mode)
	Get the interface based fast leave auto-assignment mode. More...
open_error_t	openapiSnoopIntfFastLeaveOperModeSet (openapiClientHandle_t *client_handle, uint8_t family, uint32_t ifNum, OPEN_CONTROL_t mode)
	Set the fast leave auto-assignment mode on an interface. More...
open_error_t	openapiSnoopIntfGroupMembershipIntervalGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *queryTime, uint8_t family)
	Returns the IGMP/MLD group membership interval for the specified interface. More...
open_error_t	openapiSnoopIntfGroupMembershipIntervalSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t queryTime, uint8_t family)
	Sets the IGMP/MLD group membership interval for the specified interface. More...
open_error_t	openapiSnoopIntfMcastRtrExpiryTimeGet (openapiClientHandle_t *client_handle, uint8_t family, uint32_t ifNum, uint32_t *expiryTime)
	Get the multicast router expiry time value on an interface. More...
open_error_t	openapiSnoopIntfMcastRtrExpiryTimeSet (openapiClientHandle_t *client_handle, uint8_t family, uint32_t ifNum, uint32_t expiryTime)
	Set the multicast router expiry time value on an interface. More...
open_error_t	openapiSnoopIntfModeGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_CONTROL_t *mode, uint8_t family)
	Returns the IGMP/MLD Snooping mode for the specified interface. More...
open_error_t	openapiSnoopIntfModeSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_CONTROL_t mode, uint8_t family)
	Sets the IGMP/MLD Snooping mode for the specified interface. More...
open_error_t	openapiSnoopIntfMrouterGet (openapiClientHandle_t *client_handle, uint8_t family, uint32_t ifNum, uint32_t vlanId, OPEN_CONTROL_t *mode)
	Get the Multicast Router Detected mode on a specified vlan, interface. More...
open_error_t	openapiSnoopIntfMrouterSet (openapiClientHandle_t *client_handle, uint8_t family, uint32_t ifNum, OPEN_CONTROL_t mode)
	Set the specified interface as a multicast router interface. More...
open_error_t	openapiSnoopIntfMrouterStatusGet (openapiClientHandle_t *client_handle, uint8_t family, uint32_t ifNum, OPEN_CONTROL_t *status)
	Get the Multicast Router Detected status for the specified interface. More...
open_error_t	openapiSnoopIntfProxyQuerierModeGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_CONTROL_t *mode, uint8_t family)
	Returns the Proxy Querier Admin mode for the specified interface. More...
open_error_t	openapiSnoopIntfProxyQuerierModeSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_CONTROL_t mode, uint8_t family)
	Sets the Proxy Querier Admin mode for the specified interface. More...
open_error_t	openapiSnoopIntfResponseTimeGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *responseTime, uint8_t family)
	Returns the IGMP/MLD query response time for the specified interface. More...
open_error_t	openapiSnoopIntfResponseTimeSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t responseTime, uint8_t family)
	Sets the IGMP/MLD query response time for the specified interface. More...
open_error_t	openapiSnoopIntfStaticMcastRtrVlanMaskGet (openapiClientHandle_t *client_handle, uint8_t family, uint32_t ifNum, OPEN_VLAN_LIST_t *vlanStaticMcastRtr)
	Get the VLAN list on which static mrouter is enabled. More...
open_error_t	openapiSnoopIntfStaticMcastRtrVlanMaskSet (openapiClientHandle_t *client_handle, uint8_t family, uint32_t ifNum, OPEN_VLAN_LIST_t *vlanStaticMcastRtr, OPEN_CONTROL_t status)
	Set the VLAN list on which static mrouter is enabled. More...
open_error_t	openapiSnoopIsAutoVideoVlanEnabled (openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_BOOL_t *status)
	To check if Auto-Video feature is supported and enabled. More...
open_error_t	openapiSnoopIsValidIntf (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *status)
	Checks if interface is a valid IGMP/MLD snooping Interface. More...
open_error_t	openapiSnoopMrtrExcludeModeGet (openapiClientHandle_t *client_handle, uint8_t family, OPEN_CONTROL_t *mode)
	To check if mrouter ports are excluded from the forwarding list. More...
open_error_t	openapiSnoopMrtrExcludeModeSet (openapiClientHandle_t *client_handle, uint8_t family, OPEN_CONTROL_t mode)
	Configure to exclude mrouter ports from the forwarding list. More...
open_error_t	openapiSnoopProtocolGet (openapiClientHandle_t *client_handle, uint8_t family, OPEN_BOOL_t *status)
	Checks if the passed family type snooping is supported or not. More...
open_error_t	openapiSnoopProtocolNextGet (openapiClientHandle_t *client_handle, uint32_t family, uint32_t *nextFamily)
	Get the next supported protocol family given the family. More...
open_error_t	openapiSnoopProxyQuerierAdminModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *adminMode, uint8_t family)
	Returns the IGMP/MLD Proxy Querier Admin mode for the specified snooping instance. More...
open_error_t	openapiSnoopProxyQuerierAdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t adminMode, uint8_t family)
	Sets the IGMP/MLD Proxy Querier Admin mode for the specified snooping instance. More...
open_error_t	openapiSnoopQuerierAddressGet (openapiClientHandle_t *client_handle, open_inet_addr_t *snoopQuerierAddr, uint8_t family)
	Gets the snooping querier configured address of a snoop instance. More...
open_error_t	openapiSnoopQuerierAddressSet (openapiClientHandle_t *client_handle, open_inet_addr_t *snoopQuerierAddr, uint8_t family)
	Sets the snooping querier configured address of a snoop instance. More...
open_error_t	openapiSnoopQuerierAdminModeGet (openapiClientHandle_t *client_handle, uint32_t *adminMode, uint8_t family)
	Gets the snooping querier admin mode of a snoop instance. More...
open_error_t	openapiSnoopQuerierAdminModeSet (openapiClientHandle_t *client_handle, uint32_t adminMode, uint8_t family)
	Gets the Snooping Querier Admin mode of a snoop instance. More...
open_error_t	openapiSnoopQuerierExpiryIntervalGet (openapiClientHandle_t *client_handle, uint32_t *expiryInterval, uint8_t family)
	Gets the other querier expiry interval of a snoop instance. More...
open_error_t	openapiSnoopQuerierExpiryIntervalSet (openapiClientHandle_t *client_handle, uint32_t expiryInterval, uint8_t family)
	Sets the other querier expiry interval of a snoop instance. More...
open_error_t	openapiSnoopQuerierLastQuerierAddressGet (openapiClientHandle_t *client_handle, uint32_t vlanId, open_inet_addr_t *querierAddr, uint8_t family)
	Gets the detected last querier address for specified VLAN ID of a snoop instance. More...
open_error_t	openapiSnoopQuerierLastQuerierVersionGet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t *version, uint8_t family)
	Gets the detected last querier's version for specified VLAN ID of a snoop instance. More...
open_error_t	openapiSnoopQuerierMacAddrGet (openapiClientHandle_t *client_handle, uint8_t family, uint32_t vlan, open_buffdesc *snoopQuerierMac)
	Get the last detected Querier MAC Address on a vlan. More...
open_error_t	openapiSnoopQuerierOperMaxRespTimeGet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t *maxRespTime, uint8_t family)
	Gets the operational value of max response time for specified VLAN ID of a snoop instance. More...
open_error_t	openapiSnoopQuerierOperStateGet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t *state, uint8_t family)
	Gets the operational state of querier for specified VLAN ID of a snoop instance. More...
open_error_t	openapiSnoopQuerierOperVersionGet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t *version, uint8_t family)
	Gets the operational version of querier for specified VLAN ID of a snoop instance. More...
open_error_t	openapiSnoopQuerierQueryIntervalGet (openapiClientHandle_t *client_handle, uint32_t *queryInterval, uint8_t family)
	Gets the snooping querier query interval of a snoop instance. More...
open_error_t	openapiSnoopQuerierQueryIntervalSet (openapiClientHandle_t *client_handle, uint32_t queryInterval, uint8_t family)
	Sets the qnooping querier query interval of a snoop instance. More...
open_error_t	openapiSnoopQuerierVersionGet (openapiClientHandle_t *client_handle, uint32_t *version, uint8_t family)
	Gets the snooping querier configured version of a snoop instance. More...
open_error_t	openapiSnoopQuerierVersionSet (openapiClientHandle_t *client_handle, uint32_t version, uint8_t family)
	Sets the snooping querier configured version of a snoop instance. More...
open_error_t	openapiSnoopQuerierVlanAddressGet (openapiClientHandle_t *client_handle, uint32_t vlanId, open_inet_addr_t *snoopQuerierAddr, uint8_t family)
	Gets the qnooping querier configured address for specified VLAN ID of a snoop instance. More...
open_error_t	openapiSnoopQuerierVlanAddressSet (openapiClientHandle_t *client_handle, uint32_t vlanId, open_inet_addr_t *snoopQuerierAddr, uint8_t family)
	Sets the snooping querier configured address for specified VLAN ID of a snoop instance. More...
open_error_t	openapiSnoopQuerierVlanElectionModeGet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t *vlanMode, uint8_t family)
	Gets the configured snooping querier election mode for the specified vlan ID of a snoop instance. More...
open_error_t	openapiSnoopQuerierVlanElectionModeSet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t vlanMode, uint8_t family)
	Sets the configured snooping querier election mode for the specified VLAN ID of a snoop instance. More...
open_error_t	openapiSnoopQuerierVlanModeGet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t *vlanMode, uint8_t family)
	Gets the configured snooping querier mode for the specified vlanId of a snoop instance. More...
open_error_t	openapiSnoopQuerierVlanModeSet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t vlanMode, uint8_t family)
	Set the configured snooping querier mode for the specified vlanId of a snoop instance. More...
open_error_t	openapiSnoopReportFloodModeGet (openapiClientHandle_t *client_handle, uint8_t family, OPEN_CONTROL_t *mode)
	Get the global mode based on which Reports will be flooded. More...
open_error_t	openapiSnoopReportFloodModeSet (openapiClientHandle_t *client_handle, uint8_t family, OPEN_CONTROL_t mode)
	Set the global mode based on which Reports will be flooded. More...
open_error_t	openapiSnoopRouterAlertMandatoryGet (openapiClientHandle_t *client_handle, uint8_t family, OPEN_BOOL_t *checkRtrAlert)
	Get whether router alert checking in IGMP frames is enabled. More...
open_error_t	openapiSnoopRouterAlertMandatorySet (openapiClientHandle_t *client_handle, uint8_t family, OPEN_BOOL_t checkRtrAlert)
	Set if router alert checking in IGMP frames to be enabled. More...
open_error_t	openapiSnoopSSMGroupFilterModeGet (openapiClientHandle_t *client_handle, uint8_t family, open_inet_addr_t *pGroup, uint32_t *pIntIfNum, uint32_t *pVlanId, OPEN_SNOOP_SSM_FILTER_MODE_t *pfilterMode)
	Gets the source filter mode (Include or Exclude) for the specified group on the specified interface and VLAN. More...
open_error_t	openapiSnoopSSMGroupLastReporterGet (openapiClientHandle_t *client_handle, uint8_t family, open_inet_addr_t *pGroup, uint32_t *pIntIfNum, uint32_t *pVlanId, open_inet_addr_t *pSrcIp)
	Gets the IP address of the source of last membership report received for the specified group address on the specified interface and VLAN. More...
open_error_t	openapiSnoopSSMGroupRecordFirstGet (openapiClientHandle_t *client_handle, uint8_t family, open_inet_addr_t *pGroup, uint32_t *pIntIfNum, uint32_t *pVlanId)
	Gets the first learnt entry from SSM group database. More...
open_error_t	openapiSnoopSSMGroupRecordNextGet (openapiClientHandle_t *client_handle, uint8_t family, open_inet_addr_t *pGroup, uint32_t *pIntIfNum, uint32_t *pVlanId)
	Gets the next learnt entry from SSM group database. More...
open_error_t	openapiSnoopSSMMfdbCurrEntriesGet (openapiClientHandle_t *client_handle, uint8_t family, uint32_t *currEntries)
	To get the current number of entries in the MFDB table. More...
open_error_t	openapiSnoopSSMMfdbEntryExcPortMaskGet (openapiClientHandle_t *client_handle, uint8_t family, open_inet_addr_t *pGroup, open_inet_addr_t *pSource, uint32_t *pVlanId, open_buffdesc *excPortMaskName)
	Get the exclude port list for a given SSM MFDB entry. More...
open_error_t	openapiSnoopSSMMfdbEntryFirstGet (openapiClientHandle_t *client_handle, uint8_t family, open_inet_addr_t *pGroup, open_inet_addr_t *pSource, uint32_t *pVlanId)
	Gets the first learnt entry from SSM MFDB. More...
open_error_t	openapiSnoopSSMMfdbEntryIncPortMaskGet (openapiClientHandle_t *client_handle, uint8_t family, open_inet_addr_t *pGroup, open_inet_addr_t *pSource, uint32_t *pVlanId, open_buffdesc *incPortMaskName)
	Get the include port list for a given SSM MFDB entry. More...
open_error_t	openapiSnoopSSMMfdbEntryNextGet (openapiClientHandle_t *client_handle, uint8_t family, open_inet_addr_t *pGroup, open_inet_addr_t *pSource, uint32_t *pVlanId)
	Gets next learnt entry from SSM MFDB. More...
open_error_t	openapiSnoopSSMMfdbMaxTableEntriesGet (openapiClientHandle_t *client_handle, uint8_t family, uint32_t *maxEntries)
	To get the maximum number of entries that the SSM MFDB table can hold for a given family. More...
open_error_t	openapiSnoopSSMMfdbMostEntriesGet (openapiClientHandle_t *client_handle, uint8_t family, uint32_t *mostEntries)
	To get the most number of entries ever in the SSM MFDB table for a given family. More...
open_error_t	openapiSnoopSSMSrcListEntryGet (openapiClientHandle_t *client_handle, uint8_t family, open_inet_addr_t *pGroup, uint32_t *pIntIfNum, uint32_t *pVlanId, open_inet_addr_t *pSrcIp)
	To validate if the specified source address exists for the specified group address and interface or not. More...
open_error_t	openapiSnoopSSMSrcListEntryNextGet (openapiClientHandle_t *client_handle, uint8_t family, open_inet_addr_t *pGroup, uint32_t *pIntIfNum, uint32_t *pVlanId, open_inet_addr_t *pSrcIp)
	Get the next source list entry for the specified group address interface and source address. More...
open_error_t	openapiSnoopVlanCheckValid (openapiClientHandle_t *client_handle, uint32_t vlanId)
	Check if VLAN is eligible for snooping configuration. More...
open_error_t	openapiSnoopVlanFastLeaveModeGet (openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_BOOL_t *fastLeaveMode, uint8_t family)
	Gets the configured IGMP/MLD snooping fast leave mode for the specified VLAN. More...
open_error_t	openapiSnoopVlanFastLeaveModeSet (openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_BOOL_t fastLeaveMode, uint8_t family)
	Sets the configured IGMP/MLD snooping fast leave mode for the specified VLAN. More...
open_error_t	openapiSnoopVlanGroupMembershipIntervalGet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint16_t *groupMembershipInterval, uint8_t family)
	Gets the configured IGMP/MLD snooping group membership interval for the specified VLAN. More...
open_error_t	openapiSnoopVlanGroupMembershipIntervalSet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint16_t groupMembershipInterval, uint8_t family)
	Sets the configured IGMP/MLD snooping group membership interval for the specified VLAN. More...
open_error_t	openapiSnoopVlanIgmpPlusModeGet (openapiClientHandle_t *client_handle, uint8_t family, uint32_t vlan, OPEN_CONTROL_t *mode)
	Get the igmp plus vlan mode. More...
open_error_t	openapiSnoopVlanIgmpPlusModeSet (openapiClientHandle_t *client_handle, uint8_t family, uint32_t vlan, OPEN_CONTROL_t mode)
	Set the igmp plus vlan mode. More...
open_error_t	openapiSnoopVlanMaximumResponseTimeGet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint16_t *responseTime, uint8_t family)
	Gets the configured IGMP/MLD snooping maximum response time for the specified VLAN. More...
open_error_t	openapiSnoopVlanMaximumResponseTimeSet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint16_t responseTime, uint8_t family)
	Set response time for the specified VLAN. More...
open_error_t	openapiSnoopVlanMcastRtrExpiryTimeGet (openapiClientHandle_t *client_handle, uint8_t family, uint32_t vlan, uint16_t *expiryTime)
	Get the configured IGMP Snooping Mcast Router Expiry Time for the VLAN. More...
open_error_t	openapiSnoopVlanMcastRtrExpiryTimeSet (openapiClientHandle_t *client_handle, uint8_t family, uint32_t vlan, uint16_t expiryTime)
	Set the configured IGMP Snooping Mcast Router Expiry Time for the VLAN. More...
open_error_t	openapiSnoopVlanModeGet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t *snoopVlanMode, uint8_t family)
	Get the IGMP/MLD snooping mode corresponding to the VLAN ID. More...
open_error_t	openapiSnoopVlanModeSet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t snoopVlanMode, uint8_t family)
	Set the IGMP/MLD snooping mode corresponding to the VLAN ID. More...
open_error_t	openapiSnoopVlanMrouterListGet (openapiClientHandle_t *client_handle, uint8_t family, uint32_t vlan, open_buffdesc *dynamicMask, open_buffdesc *staticMask)
	Get the static and dynamic Mrouter interface list. More...
open_error_t	openapiSnoopVlanMrtrExcludeModeGet (openapiClientHandle_t *client_handle, uint8_t family, uint32_t vlan, OPEN_CONTROL_t *mode)
	Get the VLAN mode for excluding mrouter ports. More...
open_error_t	openapiSnoopVlanMrtrExcludeModeSet (openapiClientHandle_t *client_handle, uint8_t family, uint32_t vlan, OPEN_CONTROL_t mode)
	Set the VLAN mode for excluding mrouter ports. More...
open_error_t	openapiSnoopVlanNextGet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t *nextVlan)
	Gets next VLAN ID for snooping configuration. More...
open_error_t	openapiSnoopVlanProxyQuerierModeGet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t *mode, uint8_t family)
	Gets the configured snooping proxy querier mode for the specified VLAN of a snoop instance. More...
open_error_t	openapiSnoopVlanProxyQuerierModeSet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t mode, uint8_t family)
	Sets the configured snooping proxy querier mode for the specified VLAN of a snoop instance. More...
open_error_t	openapiSnoopVlanReportFloodModeGet (openapiClientHandle_t *client_handle, uint8_t family, uint32_t vlan, OPEN_CONTROL_t *mode)
	Get the report flood mode in the VLAN. More...
open_error_t	openapiSnoopVlanReportFloodModeSet (openapiClientHandle_t *client_handle, uint8_t family, uint32_t vlan, OPEN_CONTROL_t mode)
	Set the report flood mode in the VLAN. More...
open_error_t	openapiSnoopVlanReportSuppModeGet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint8_t family, OPEN_BOOL_t *reportSuppMode)
	Get the configured IGMP/MLD snooping report suppression mode for the specified VLAN. More...
open_error_t	openapiSnoopVlanReportSuppModeSet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint8_t family, OPEN_BOOL_t reportSuppMode)
	Sets the configured IGMP/MLD snooping report suppression mode for the specified VLAN. More...

Detailed Description

Enumeration Type Documentation

enum OPEN_SNOOP_QUERIER_STATE_t

Enumerator
OPEN_SNOOP_QUERIER_QUERIER	Querier Disabled.
OPEN_SNOOP_QUERIER_NON_QUERIER	Querier State.

Definition at line 53 of file openapi_snooping.h.

enum OPEN_SNOOP_SSM_FILTER_MODE_t

Enumerator
OPEN_SNOOP_SSM_FILTER_MODE_INCLUDE	Non-SSM Filter Mode State.
OPEN_SNOOP_SSM_FILTER_MODE_EXCLUDE	SSM Filter Mode Include.

Definition at line 46 of file openapi_snooping.h.

Function Documentation

open_error_t openapiSnoopAdminModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	adminMode,
		uint8_t	family
	)

Returns the IGMP/MLD Snooping Admin mode.

Parameters

[in]	client_handle	client handle from registration API.
[out]	adminMode	admin mode.
[in]	family	address family. OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping

Return values

OPEN_E_NONE	IGMP/MLD Snooping Admin mode returned.
OPEN_E_FAIL	Failed to get IGMP/MLD Snooping Admin mode.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopAdminModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	adminMode,
		uint8_t	family
	)

Sets the IGMP/MLD Snooping Admin mode.

Parameters

[in]	client_handle	client handle from registration API.
[in]	adminMode	admin mode.
[in]	family	address family. OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping

Return values

OPEN_E_NONE	IGMP/MLD static mcast router attached status set successful.
OPEN_E_FAIL	Failed to set IGMP/MLD Snooping Admin mode.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopAutoVideoModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	mode
	)

Gets the Auto-Video mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	mode	Auto Video mode

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.19

Examples:

snooping_example.c.

open_error_t openapiSnoopAutoVideoModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets the Auto-Video mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Auto Video mode

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.19

Examples:

snooping_example.c.

open_error_t openapiSnoopAutoVideoVlanGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	vlanId
	)

Gets the Auto-Video VLAN.

Parameters

[in]	client_handle	client handle from registration API
[out]	vlanId	Auto Video vlanId

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.19

Examples:

snooping_example.c.

open_error_t openapiSnoopControlFramesProcessedGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	processedFrames,
		uint8_t	family
	)

Returns the number of multicast control frames processed by the CPU.

Parameters

[in]	client_handle	client handle from registration API.
[out]	processedFrames	number of control frames processed.
[in]	family	address family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping

Return values

OPEN_E_NONE	Number of multicast control (i.e. IGMP/MLD) frames processed by the CPU returned.
OPEN_E_FAIL	Failed to get number of multicast control (i.e. IGMP/MLD) frames processed by the CPU.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopDataFramesForwardedGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	forwardedFrames,
		uint8_t	family
	)

Returns the number of multicast data frames forwarded by the CPU.

Parameters

[in]	client_handle	client handle from registration API.
[out]	forwardedFrames	number of data frames forwarded.
[in]	family	address family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping

Return values

OPEN_E_NONE	Number of multicast data frames forwarded by the CPU returned.
OPEN_E_FAIL	Failed to get Inumber of multicast data frames forwarded by the CPU.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopEntriesFlush	(	openapiClientHandle_t *	client_handle,
		uint8_t	family
	)

Flushes all Snooping entries and multicast router entries.

Parameters

[in]	client_handle	client handle from registration API.
[in]	family	address family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping

Return values

OPEN_E_NONE	All entries flushed successful.
OPEN_E_FAIL	Failed to flush all entries.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopFastLeaveAutoAssignmentModeGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		OPEN_CONTROL_t *	mode
	)

Get the snooping fast leave auto-assignment global mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[out]	mode	Fast Leave Auto Assignment Mode ENABLE/DISABLE

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopFastLeaveAutoAssignmentModeSet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		OPEN_CONTROL_t	mode
	)

Set the global mode for the Fast Leave Auto Assignment.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[in]	mode	Fast Leave Auto Assignment Mode ENABLE/DISABLE

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopFloodUnknownAllPortsGet	(	openapiClientHandle_t *	client_handle,
		OPEN_BOOL_t *	floodAll
	)

Returns the configured mode for flooding unknown multicast traffic to all ports.

Parameters

[in]	client_handle	client handle from registration API.
[out]	floodAll	OPEN_TRUE if flooding to all ports.

Return values

OPEN_E_NONE	Configured mode for flooding unknown multicast traffic to all ports returned.
OPEN_E_FAIL	Failed to get configured mode for flooding unknown multicast traffic to all ports.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopFloodUnknownAllPortsSet	(	openapiClientHandle_t *	client_handle,
		OPEN_BOOL_t	floodAll
	)

Sets the configured mode for flooding unknown multicast traffic to all ports.

Parameters

[in]	client_handle	client handle from registration API.
[in]	floodAll	OPEN_TRUE if flooding to all ports.

Return values

OPEN_E_NONE	Configured mode for flooding unknown multicast traffic to all ports set successful.
OPEN_E_FAIL	Failed to set configured mode for flooding unknown multicast traffic to all ports.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopIgmpPlusModeGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		OPEN_CONTROL_t *	mode
	)

Get the IGMP plus mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[out]	mode	IGMP Plus Mode ENABLE/DISABLE

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopIgmpPlusModeSet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		OPEN_CONTROL_t	mode
	)

Set the IGMP plus mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[in]	mode	IGMP Plus Mode ENABLE/DISABLE

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopIntfApiVlanStaticMcastRtrGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		uint32_t	vlan,
		uint32_t	ifNum,
		OPEN_CONTROL_t *	status
	)

Get the IGMP static mcast router attached status for the specified interface/VLAN.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[in]	vlan	VLAN ID
[in]	ifNum	interface number
[out]	status	status ENABLED/DISABLED

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopIntfEnabledMaskGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	mask,
		uint8_t	family
	)

Returns the interface mask of interfaces enabled for IGMP/MLD Snooping.

Parameters

[in]	client_handle	client handle from registration API.
[out]	mask	comma separated string of the interfaces. Buffer allocated size must be at least L7_IGMP_SNOOPING_MAX_INTF
[in]	family	address family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping

Return values

OPEN_E_NONE	Interface mask of interfaces enabled for IGMP/MLD Snooping returned.
OPEN_E_FAIL	Failed to get interface mask of interfaces enabled for IGMP/MLD Snooping.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopIntfEnabledMaskSet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	mask,
		uint8_t	family
	)

Sets IGMP/MLD Snooping interface mode via a comma separated string.

Parameters

[in]	client_handle	client handle from registration API.
[in]	mask	comma separated string of the interfaces. Buffer allocated size must be at least L7_IGMP_SNOOPING_MAX_INTF
[in]	family	address family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping

Return values

OPEN_E_NONE	IGMP/MLD Snooping interface mode via a bit mask set successful.
OPEN_E_FAIL	Failed to set IGMP/MLD Snooping interface mode via a bit mask.
OPEN_E_PARAM	Error in parameter passed.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopIntfFastLeaveAdminModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_CONTROL_t *	mode,
		uint8_t	family
	)

Returns the Fast-Leave Admin mode for the specified interface.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	internal interface number.
[out]	mode	Fast-Leave interface admin mode.
[in]	family	address family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping

Return values

OPEN_E_NONE	Fast-Leave Admin mode for the specified interface returned.
OPEN_E_FAIL	Failed to get Fast-Leave Admin mode for the specified interface.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopIntfFastLeaveAdminModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_CONTROL_t	mode,
		uint8_t	family
	)

Sets the Fast-Leave Admin mode for the specified interface.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	internal interface number.
[in]	mode	Fast-Leave interface admin mode.
[in]	family	address family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping

Return values

OPEN_E_NONE	Fast-Leave Admin mode for the specified interface set succesful.
OPEN_E_FAIL	Failed to set Fast-Leave Admin mode for the specified interface.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopIntfFastLeaveOperModeGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		uint32_t	ifNum,
		OPEN_CONTROL_t *	mode
	)

Get the interface based fast leave auto-assignment mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[in]	ifNum	interface
[out]	mode	Fast Leave Operational Mode ENABLE/DISABLE

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopIntfFastLeaveOperModeSet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		uint32_t	ifNum,
		OPEN_CONTROL_t	mode
	)

Set the fast leave auto-assignment mode on an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[in]	ifNum	interface
[in]	mode	Fast Leave Operational Mode ENABLE/DISABLE

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopIntfGroupMembershipIntervalGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	queryTime,
		uint8_t	family
	)

Returns the IGMP/MLD group membership interval for the specified interface.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	internal interface number.
[out]	queryTime	query time.
[in]	family	address family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping

Return values

OPEN_E_NONE	IGMP/MLD group membership interval for the specified interface returned.
OPEN_E_FAIL	Failed to get IGMP/MLD group membership interval for the specified interface.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopIntfGroupMembershipIntervalSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	queryTime,
		uint8_t	family
	)

Sets the IGMP/MLD group membership interval for the specified interface.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	internal interface number.
[in]	queryTime	query time.
[in]	family	address family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping

Return values

OPEN_E_NONE	IGMP/MLD group membership interval for the specified interface set successful.
OPEN_E_FAIL	Failed to set IGMP/MLD group membership interval for the specified interface.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopIntfMcastRtrExpiryTimeGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		uint32_t	ifNum,
		uint32_t *	expiryTime
	)

Get the multicast router expiry time value on an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[in]	ifNum	interface
[out]	expiryTime	multicast router expiry time value

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopIntfMcastRtrExpiryTimeSet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		uint32_t	ifNum,
		uint32_t	expiryTime
	)

Set the multicast router expiry time value on an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[in]	ifNum	interface
[in]	expiryTime	multicast router expiry time value

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopIntfModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_CONTROL_t *	mode,
		uint8_t	family
	)

Returns the IGMP/MLD Snooping mode for the specified interface.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	internal interface number.
[out]	mode	snooping mode
[in]	family	address family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping

Return values

OPEN_E_NONE	IGMP/MLD Snooping mode for the specified interface returned.
OPEN_E_FAIL	Failed to get IGMP/MLD Snooping mode for the specified interface.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopIntfModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_CONTROL_t	mode,
		uint8_t	family
	)

Sets the IGMP/MLD Snooping mode for the specified interface.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	internal interface number.
[in]	mode	snooping mode
[in]	family	address family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping

Return values

OPEN_E_NONE	IGMP/MLD Snooping mode for the specified interface set successful.
OPEN_E_FAIL	Failed to set IGMP/MLD Snooping mode for the specified interface.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopIntfMrouterGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		uint32_t	ifNum,
		uint32_t	vlanId,
		OPEN_CONTROL_t *	mode
	)

Get the Multicast Router Detected mode on a specified vlan, interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[in]	ifNum	interface
[in]	vlanId	VLAN ID
[out]	mode	multicast router detected mode

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopIntfMrouterSet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		uint32_t	ifNum,
		OPEN_CONTROL_t	mode
	)

Set the specified interface as a multicast router interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[in]	ifNum	interface
[in]	mode	multicast router interface admin mode

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopIntfMrouterStatusGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		uint32_t	ifNum,
		OPEN_CONTROL_t *	status
	)

Get the Multicast Router Detected status for the specified interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[in]	ifNum	interface
[out]	status	multicast router detected status

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopIntfProxyQuerierModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_CONTROL_t *	mode,
		uint8_t	family
	)

Returns the Proxy Querier Admin mode for the specified interface.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	internal interface number.
[out]	mode	Proxy Querier Admin mode.
[in]	family	address family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping

Return values

OPEN_E_NONE	Proxy Querier Admin mode for the specified interface returned.
OPEN_E_FAIL	Failed to get Proxy Querier Admin mode for the specified interface.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopIntfProxyQuerierModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_CONTROL_t	mode,
		uint8_t	family
	)

Sets the Proxy Querier Admin mode for the specified interface.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	internal interface number.
[in]	mode	Proxy Querier Admin mode.
[in]	family	address family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping

Return values

OPEN_E_NONE	Proxy Querier Admin mode for the specified interface set successful.
OPEN_E_FAIL	Failed to set Proxy Querier Admin mode for the specified interface.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopIntfResponseTimeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	responseTime,
		uint8_t	family
	)

Returns the IGMP/MLD query response time for the specified interface.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	internal interface number.
[out]	responseTime	response time.
[in]	family	address family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping

Return values

OPEN_E_NONE	IGMP/MLD query response time for the specified interface returned.
OPEN_E_FAIL	Failed to get IGMP/MLD query response time for the specified interface.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopIntfResponseTimeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	responseTime,
		uint8_t	family
	)

Sets the IGMP/MLD query response time for the specified interface.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	internal interface number.
[in]	responseTime	response time.
[in]	family	address family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping

Return values

OPEN_E_NONE	IGMP/MLD query response time for the specified interface set successful.
OPEN_E_FAIL	Failed to set IGMP/MLD query response time for the specified interface.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopIntfStaticMcastRtrVlanMaskGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		uint32_t	ifNum,
		OPEN_VLAN_LIST_t *	vlanStaticMcastRtr
	)

Get the VLAN list on which static mrouter is enabled.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[in]	ifNum	interface
[out]	vlanStaticMcastRtr	VLAN list on which static mrouter is enabled.

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopIntfStaticMcastRtrVlanMaskSet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		uint32_t	ifNum,
		OPEN_VLAN_LIST_t *	vlanStaticMcastRtr,
		OPEN_CONTROL_t	status
	)

Set the VLAN list on which static mrouter is enabled.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[in]	ifNum	interface
[in]	vlanStaticMcastRtr	VLAN list on which static mrouter to be set.
[in]	status	status as enable/disable

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopIsAutoVideoVlanEnabled	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		OPEN_BOOL_t *	status
	)

To check if Auto-Video feature is supported and enabled.

Parameters

[in]	client_handle	client handle from registration API
[in]	vlanId	VLAN ID
[out]	status	enabled or not

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopIsValidIntf	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_BOOL_t *	status
	)

Checks if interface is a valid IGMP/MLD snooping Interface.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	internal interface number.
[out]	status	validation status.

Return values

OPEN_E_NONE	Validity of interface checked.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopMrtrExcludeModeGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		OPEN_CONTROL_t *	mode
	)

To check if mrouter ports are excluded from the forwarding list.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[out]	mode	mode

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopMrtrExcludeModeSet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		OPEN_CONTROL_t	mode
	)

Configure to exclude mrouter ports from the forwarding list.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[in]	mode	mode

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopProtocolGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		OPEN_BOOL_t *	status
	)

Checks if the passed family type snooping is supported or not.

Parameters

[in]	client_handle	client handle from registration API.
[in]	family	address family. OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping
[out]	valid	validation status

Return values

OPEN_E_NONE	Validity of family checked.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopProtocolNextGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	family,
		uint32_t *	nextFamily
	)

Get the next supported protocol family given the family.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[out]	nextFamily	address family L7_AF_INET/L7_AF_INET6

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopProxyQuerierAdminModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	adminMode,
		uint8_t	family
	)

Returns the IGMP/MLD Proxy Querier Admin mode for the specified snooping instance.

Parameters

[in]	client_handle	client handle from registration API.
[out]	adminMode	admin mode.
[in]	family	address family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping

Return values

OPEN_E_NONE	IGMP/MLD Proxy Querier Admin mode for the specified snooping instance returned.
OPEN_E_FAIL	Failed to get IGMP/MLD Proxy Querier Admin mode for the specified snooping instance.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopProxyQuerierAdminModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	adminMode,
		uint8_t	family
	)

Sets the IGMP/MLD Proxy Querier Admin mode for the specified snooping instance.

Parameters

[in]	client_handle	client handle from registration API.
[in]	adminMode	admin mode.
[in]	family	address family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping

Return values

OPEN_E_NONE	IGMP/MLD Proxy Querier Admin mode for the specified snooping instance set successful.
OPEN_E_FAIL	Failed to set IGMP/MLD Proxy Querier Admin mode for the specified snooping instance.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopQuerierAddressGet	(	openapiClientHandle_t *	client_handle,
		open_inet_addr_t *	snoopQuerierAddr,
		uint8_t	family
	)

Gets the snooping querier configured address of a snoop instance.

Parameters

[in]	client_handle	client handle from registration API.
[out]	snoopQuerierAddr	pointer to querier address.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	querier configured address was retrieved successfully.
OPEN_E_FAIL	querier configured address retrieval failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopQuerierAddressSet	(	openapiClientHandle_t *	client_handle,
		open_inet_addr_t *	snoopQuerierAddr,
		uint8_t	family
	)

Sets the snooping querier configured address of a snoop instance.

Parameters

[in]	client_handle	client handle from registration API.
[in]	snoopQuerierAddr	pointer to querier address.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	querier configured address was set successfully.
OPEN_E_FAIL	querier configured address set failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopQuerierAdminModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	adminMode,
		uint8_t	family
	)

Gets the snooping querier admin mode of a snoop instance.

Parameters

[in]	client_handle	client handle from registration API.
[out]	adminMode	snooping querier admin mode.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	querier admin mode was retrieved successfully.
OPEN_E_FAIL	querier admin mode retrieval failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopQuerierAdminModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	adminMode,
		uint8_t	family
	)

Gets the Snooping Querier Admin mode of a snoop instance.

Parameters

[in]	client_handle	client handle from registration API.
[in]	adminMode	snooping querier admin mode.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	querier admin mode address was set successfully.
OPEN_E_FAIL	querier admin mode address set failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopQuerierExpiryIntervalGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	expiryInterval,
		uint8_t	family
	)

Gets the other querier expiry interval of a snoop instance.

Parameters

[in]	client_handle	client handle from registration API.
[out]	expiryInterval	interval for declaring last querier as expired.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	querier expiry interval was retrieved successfully.
OPEN_E_FAIL	querier expiry interval retrieval failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopQuerierExpiryIntervalSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	expiryInterval,
		uint8_t	family
	)

Sets the other querier expiry interval of a snoop instance.

Parameters

[in]	client_handle	client handle from registration API.
[in]	expiryInterval	interval for declaring last querier as expired.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	querier expiry interval address was set successfully.
OPEN_E_FAIL	querier expiry interval address set failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopQuerierLastQuerierAddressGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		open_inet_addr_t *	querierAddr,
		uint8_t	family
	)

Gets the detected last querier address for specified VLAN ID of a snoop instance.

Parameters

[in]	client_handle	client handle from registration API.
[out]	querierAddr	last querier VLAN address.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	querier address was retrieved successfully.
OPEN_E_FAIL	querier address retrieval failed.
OPEN_E_NOT_FOUND	if querier address is not found.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopQuerierLastQuerierVersionGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint32_t *	version,
		uint8_t	family
	)

Gets the detected last querier's version for specified VLAN ID of a snoop instance.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vlanId	VLAN ID.
[out]	version	last querier protocol version.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	last querier's version was retrieved successfully.
OPEN_E_FAIL	last querier's version retrieval failed.
OPEN_E_NOT_FOUND	if last querier's version is not found.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopQuerierMacAddrGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		uint32_t	vlan,
		open_buffdesc *	snoopQuerierMac
	)

Get the last detected Querier MAC Address on a vlan.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[in]	vlan	VLAN ID
[out]	snoopQuerierMac	Querier MAC address

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopQuerierOperMaxRespTimeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint32_t *	maxRespTime,
		uint8_t	family
	)

Gets the operational value of max response time for specified VLAN ID of a snoop instance.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vlanId	VLAN ID.
[out]	maxRespTime	operational max response time value.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	max response time was retrieved successfully.
OPEN_E_FAIL	max response time retrieval failed.
OPEN_E_NOT_FOUND	if max response time is not found.
OPEN_E_PARAM	Error in parameter passed.

Note

When success, if maxRespTime == 0, it means that the max response time is less than 1 sec

OpEN API Version: 1.7

open_error_t openapiSnoopQuerierOperStateGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint32_t *	state,
		uint8_t	family
	)

Gets the operational state of querier for specified VLAN ID of a snoop instance.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vlanId	VLAN ID.
[out]	state	operational state OPEN_SNOOP_QUERIER_STATE_t.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	state of querier was retrieved successfully.
OPEN_E_FAIL	state of querier retrieval failed.
OPEN_E_NOT_FOUND	if state of querier is not found.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopQuerierOperVersionGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint32_t *	version,
		uint8_t	family
	)

Gets the operational version of querier for specified VLAN ID of a snoop instance.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vlanId	VLAN ID.
[out]	version	operational version.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	operational version was retrieved successfully.
OPEN_E_FAIL	operational version retrieval failed.
OPEN_E_NOT_FOUND	if operational version is not found.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopQuerierQueryIntervalGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	queryInterval,
		uint8_t	family
	)

Gets the snooping querier query interval of a snoop instance.

Parameters

[in]	client_handle	client handle from registration API.
[out]	queryInterval	interval for sending periodic queries.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	snooping interval was retrieved successfully.
OPEN_E_FAIL	snooping interval retrieval failed.
OPEN_E_NOT_FOUND	if snooping interval is not found.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopQuerierQueryIntervalSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	queryInterval,
		uint8_t	family
	)

Sets the qnooping querier query interval of a snoop instance.

Parameters

[in]	client_handle	client handle from registration API.
[in]	queryInterval	interval for sending periodic queries.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	snooping interval was set successfully.
OPEN_E_FAIL	snooping interval set failed.
OPEN_E_NOT_FOUND	if snooping interval is not found.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopQuerierVersionGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	version,
		uint8_t	family
	)

Gets the snooping querier configured version of a snoop instance.

Parameters

[in]	client_handle	client handle from registration API.
[out]	version	configured querier version.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	querier configured version was retrieved successfully.
OPEN_E_FAIL	querier configured version retrieval failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopQuerierVersionSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	version,
		uint8_t	family
	)

Sets the snooping querier configured version of a snoop instance.

Parameters

[in]	client_handle	client handle from registration API.
[in]	version	configured querier version.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	configured querier version was set successfully.
OPEN_E_FAIL	configured querier version set failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopQuerierVlanAddressGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		open_inet_addr_t *	snoopQuerierAddr,
		uint8_t	family
	)

Gets the qnooping querier configured address for specified VLAN ID of a snoop instance.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vlanId	VLAN ID.
[out]	snoopQuerierAddr	querier VLAN address.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	querier VLAN address was retrieved successfully.
OPEN_E_FAIL	querier VLAN address retrieval failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopQuerierVlanAddressSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		open_inet_addr_t *	snoopQuerierAddr,
		uint8_t	family
	)

Sets the snooping querier configured address for specified VLAN ID of a snoop instance.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vlanId	VLAN ID.
[in]	snoopQuerierAddr	querier VLAN address.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	querier VLAN address was set successfully.
OPEN_E_FAIL	querier VLAN address set failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopQuerierVlanElectionModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint32_t *	vlanMode,
		uint8_t	family
	)

Gets the configured snooping querier election mode for the specified vlan ID of a snoop instance.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vlanId	VLAN ID.
[out]	vlanMode	configured snooping querier VLAN election participate mode.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	querier election mode was retrieved successfully.
OPEN_E_FAIL	querier election mode retrieval failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopQuerierVlanElectionModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint32_t	vlanMode,
		uint8_t	family
	)

Sets the configured snooping querier election mode for the specified VLAN ID of a snoop instance.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vlanId	VLAN ID.
[in]	vlanMode	configured snooping querier VLAN election participate mode.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	querier election mode was set successfully.
OPEN_E_FAIL	querier election mode set failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopQuerierVlanModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint32_t *	vlanMode,
		uint8_t	family
	)

Gets the configured snooping querier mode for the specified vlanId of a snoop instance.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vlanId	VLAN ID.
[out]	vlanMode	configured snooping querier VLAN mode.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	snooping querier VLAN mode was retrieved successfully.
OPEN_E_FAIL	snooping querier VLAN mode retrieval failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopQuerierVlanModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint32_t	vlanMode,
		uint8_t	family
	)

Set the configured snooping querier mode for the specified vlanId of a snoop instance.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vlanId	VLAN ID.
[in]	vlanMode	configured snooping querier VLAN mode.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	snooping querier VLAN mode was set successfully.
OPEN_E_FAIL	snooping querier VLAN mode set failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.11

Examples:

snooping_example.c.

open_error_t openapiSnoopReportFloodModeGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		OPEN_CONTROL_t *	mode
	)

Get the global mode based on which Reports will be flooded.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[out]	mode	Report Flood Mode ENABLE/DISABLE

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopReportFloodModeSet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		OPEN_CONTROL_t	mode
	)

Set the global mode based on which Reports will be flooded.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[in]	mode	Report Flood Mode ENABLE/DISABLE

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopRouterAlertMandatoryGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		OPEN_BOOL_t *	checkRtrAlert
	)

Get whether router alert checking in IGMP frames is enabled.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[out]	checkRtrAlert	Router Alert Checking enabled TRUE/FALSE

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopRouterAlertMandatorySet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		OPEN_BOOL_t	checkRtrAlert
	)

Set if router alert checking in IGMP frames to be enabled.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[in]	checkRtrAlert	Router Alert Checking enabled TRUE/FALSE

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopSSMGroupFilterModeGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		open_inet_addr_t *	pGroup,
		uint32_t *	pIntIfNum,
		uint32_t *	pVlanId,
		OPEN_SNOOP_SSM_FILTER_MODE_t *	pfilterMode
	)

Gets the source filter mode (Include or Exclude) for the specified group on the specified interface and VLAN.

Parameters

[in]	client_handle	client handle from registration API.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[in]	pGroup	pointer to the group address.
[in]	pIntIfNum	pointer to the internal interface number.
[in]	pVlanId	VLAN ID for the group entry.
[out]	pfilterMode	pointer to the filter mode.

Return values

OPEN_E_NONE	SSM group filter mode returned.
OPEN_E_FAIL	SSM group filter mode retrieval failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopSSMGroupLastReporterGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		open_inet_addr_t *	pGroup,
		uint32_t *	pIntIfNum,
		uint32_t *	pVlanId,
		open_inet_addr_t *	pSrcIp
	)

Gets the IP address of the source of last membership report received for the specified group address on the specified interface and VLAN.

Parameters

[in]	client_handle	client handle from registration API.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[in]	pGroup	pointer to the group address.
[in]	pIntIfNum	pointer to the internal interface number.
[in]	pVlanId	VLAN ID for the group entry.
[out]	pSrcIp	pointer to the last reporter IP address.

Return values

OPEN_E_NONE	SSM group last reporter returned.
OPEN_E_FAIL	SSM group last reporter retrieval failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopSSMGroupRecordFirstGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		open_inet_addr_t *	pGroup,
		uint32_t *	pIntIfNum,
		uint32_t *	pVlanId
	)

Gets the first learnt entry from SSM group database.

Parameters

[in]	client_handle	client handle from registration API.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[in]	pGroup	pointer to the group address.
[in]	pIntIfNum	pointer to the internal interface number.
[in]	pVlanId	VLAN ID for the group entry.

Return values

OPEN_E_NONE	SSM group record first returned.
OPEN_E_FAIL	SSM group record first retrieval failed.
OPEN_E_PARAM	Error in parameter passed.

Note

pGroup is returned as NULL if there are no entries.

OpEN API Version: 1.7

open_error_t openapiSnoopSSMGroupRecordNextGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		open_inet_addr_t *	pGroup,
		uint32_t *	pIntIfNum,
		uint32_t *	pVlanId
	)

Gets the next learnt entry from SSM group database.

Parameters

[in]	client_handle	client handle from registration API.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[in,out]	pGroup	pointer to the group address.
[in,out]	pIntIfNum	pointer to the internal interface number.
[in,out]	pVlanId	VLAN ID for the group entry.

Return values

OPEN_E_NONE	SSM group record next returned.
OPEN_E_FAIL	SSM group record next retrieval failed.
OPEN_E_PARAM	Error in parameter passed.

Note

pGroup is returned as NULL if there are no entries.

OpEN API Version: 1.7

open_error_t openapiSnoopSSMMfdbCurrEntriesGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		uint32_t *	currEntries
	)

To get the current number of entries in the MFDB table.

Parameters

[in]	client_handle	client handle from registration API.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[out]	currEntries	number of current entries.

Return values

OPEN_E_NONE	current number of entries returned.
OPEN_E_FAIL	current number of entries retrieval failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopSSMMfdbEntryExcPortMaskGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		open_inet_addr_t *	pGroup,
		open_inet_addr_t *	pSource,
		uint32_t *	pVlanId,
		open_buffdesc *	excPortMaskName
	)

Get the exclude port list for a given SSM MFDB entry.

Parameters

[in]	client_handle	client handle from registration API.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[in]	pGroup	pointer to the group address.
[in]	pIntIfNum	pointer to the internal interface number.
[in]	pVlanId	VLAN ID for the group entry.
[out]	excPortMask	pointer to interface mask. Buffer allocated size must be at least L7_NIM_IFNAME_SIZE

Return values

OPEN_E_NONE	port list returned.
OPEN_E_FAIL	port list retrieval failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopSSMMfdbEntryFirstGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		open_inet_addr_t *	pGroup,
		open_inet_addr_t *	pSource,
		uint32_t *	pVlanId
	)

Gets the first learnt entry from SSM MFDB.

Parameters

[in]	client_handle	client handle from registration API.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[out]	pGroup	pointer to the group address.
[out]	pSource	pointer to the internal interface number.
[out]	pVlanId	VLAN ID for the group entry.

Return values

OPEN_E_NONE	first learnt entry returned.
OPEN_E_FAIL	first learnt entry retrieval failed.
OPEN_E_PARAM	Error in parameter passed.

Note

pGroup is returned as NULL if there are no entries.

OpEN API Version: 1.7

open_error_t openapiSnoopSSMMfdbEntryIncPortMaskGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		open_inet_addr_t *	pGroup,
		open_inet_addr_t *	pSource,
		uint32_t *	pVlanId,
		open_buffdesc *	incPortMaskName
	)

Get the include port list for a given SSM MFDB entry.

Parameters

[in]	client_handle	client handle from registration API.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[in]	pGroup	pointer to the group address.
[in]	pIntIfNum	pointer to the internal interface number.
[in]	pVlanId	VLAN ID for the group entry.
[out]	incPortMask	pointer to interface mask. Buffer allocated size must be at least L7_NIM_IFNAME_SIZE

Return values

OPEN_E_NONE	port list returned.
OPEN_E_FAIL	port list retrieval failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopSSMMfdbEntryNextGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		open_inet_addr_t *	pGroup,
		open_inet_addr_t *	pSource,
		uint32_t *	pVlanId
	)

Gets next learnt entry from SSM MFDB.

Parameters

[in]	client_handle	client handle from registration API.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[in,out]	pGroup	pointer to the group address.
[in,out]	pIntIfNum	pointer to the internal interface number.
[in,out]	pVlanId	VLAN ID for the group entry.

Return values

OPEN_E_NONE	next learnt entry returned.
OPEN_E_FAIL	next learnt entry retrieval failed.
OPEN_E_PARAM	Error in parameter passed.

Note

pGroup is returned as NULL if there are no entries.

OpEN API Version: 1.7

open_error_t openapiSnoopSSMMfdbMaxTableEntriesGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		uint32_t *	maxEntries
	)

To get the maximum number of entries that the SSM MFDB table can hold for a given family.

Parameters

[in]	client_handle	client handle from registration API.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[out]	maxEntries	total number of entries.

Return values

OPEN_E_NONE	maximum number of entries returned.
OPEN_E_FAIL	maximum number of entries retrieval failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopSSMMfdbMostEntriesGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		uint32_t *	mostEntries
	)

To get the most number of entries ever in the SSM MFDB table for a given family.

Parameters

[in]	client_handle	client handle from registration API.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[out]	mostEntries	most number of entries ever.

Return values

OPEN_E_NONE	number of entries returned.
OPEN_E_FAIL	number of entries retrieval failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopSSMSrcListEntryGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		open_inet_addr_t *	pGroup,
		uint32_t *	pIntIfNum,
		uint32_t *	pVlanId,
		open_inet_addr_t *	pSrcIp
	)

To validate if the specified source address exists for the specified group address and interface or not.

Parameters

[in]	client_handle	client handle from registration API.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[in]	pGroup	pointer to the group address.
[in]	pIntIfNum	pointer to the internal interface number.
[in]	pVlanId	VLAN ID for the group entry.
[in]	pSrcIp	pointer to the Source IP address.

Return values

OPEN_E_NONE	entry exists.
OPEN_E_FAIL	if an entry is not exist.
OPEN_E_PARAM	Error in parameter passed.

Note

pGroup is returned as NULL if there are no entries.

OpEN API Version: 1.7

open_error_t openapiSnoopSSMSrcListEntryNextGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		open_inet_addr_t *	pGroup,
		uint32_t *	pIntIfNum,
		uint32_t *	pVlanId,
		open_inet_addr_t *	pSrcIp
	)

Get the next source list entry for the specified group address interface and source address.

Parameters

[in]	client_handle	client handle from registration API.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[in,out]	pGroup	pointer to the group address.
[in,out]	pIntIfNum	pointer to the internal interface number.
[in,out]	pVlanId	VLAN ID for the group entry.
[in,out]	pSrcIp	pointer to the Source IP address.

Return values

OPEN_E_NONE	source list entry exists.
OPEN_E_FAIL	if an source list entry is not exist.
OPEN_E_PARAM	Error in parameter passed.

Note

if pIntIfNum = 0, pGroup = 0 & pSrcIp = 0, then return the first valid source list entry.

OpEN API Version: 1.7

open_error_t openapiSnoopVlanCheckValid	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId
	)

Check if VLAN is eligible for snooping configuration.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vlanId	VLAN ID.

Return values

OPEN_E_NONE	valid VLAN ID.
OPEN_E_FAIL	invalid VLAN for configuration.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopVlanFastLeaveModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		OPEN_BOOL_t *	fastLeaveMode,
		uint8_t	family
	)

Gets the configured IGMP/MLD snooping fast leave mode for the specified VLAN.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vlanId	VLAN ID.
[out]	fastLeaveMode	configured IGMP/MLD snooping fast leave.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	if mode was retrieved successfully.
OPEN_E_FAIL	if VLAN ID out of range.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopVlanFastLeaveModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		OPEN_BOOL_t	fastLeaveMode,
		uint8_t	family
	)

Sets the configured IGMP/MLD snooping fast leave mode for the specified VLAN.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vlanId	VLAN ID.
[in]	fastLeaveMode	configured IGMP/MLD snooping fast leave.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	if mode was sets successfully.
OPEN_E_FAIL	if VLAN ID out of range or fast leave mode retrieval failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopVlanGroupMembershipIntervalGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint16_t *	groupMembershipInterval,
		uint8_t	family
	)

Gets the configured IGMP/MLD snooping group membership interval for the specified VLAN.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vlanId	VLAN ID.
[out]	groupMembershipInterval	configured IGMP/MLD snooping group membership interval.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	group membership interval was retrieved successfully.
OPEN_E_FAIL	group membership interval retrieval failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopVlanGroupMembershipIntervalSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint16_t	groupMembershipInterval,
		uint8_t	family
	)

Sets the configured IGMP/MLD snooping group membership interval for the specified VLAN.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vlanId	VLAN ID.
[in]	groupMembershipInterval	configured IGMP/MLD snooping group membership interval.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	group membership interval was sets successfully.
OPEN_E_FAIL	group membership interval sets failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopVlanIgmpPlusModeGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		uint32_t	vlan,
		OPEN_CONTROL_t *	mode
	)

Get the igmp plus vlan mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[in]	vlan	VLAN ID
[out]	mode	igmp plus vlan mode ENABLED/DISABLED

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopVlanIgmpPlusModeSet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		uint32_t	vlan,
		OPEN_CONTROL_t	mode
	)

Set the igmp plus vlan mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[in]	vlan	VLAN ID
[in]	mode	igmp plus vlan mode ENABLED/DISABLED

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopVlanMaximumResponseTimeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint16_t *	responseTime,
		uint8_t	family
	)

Gets the configured IGMP/MLD snooping maximum response time for the specified VLAN.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vlanId	VLAN ID.
[out]	responseTime	configured IGMP/MLD snooping maximum response time.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	maximum response time was retrieved successfully.
OPEN_E_FAIL	maximum response time retrieval failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopVlanMaximumResponseTimeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint16_t	responseTime,
		uint8_t	family
	)

Set response time for the specified VLAN.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vlanId	VLAN ID.
[in]	responseTime	configured IGMP/MLD snooping maximum response time.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	response time was sets successfully.
OPEN_E_FAIL	response time sets failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopVlanMcastRtrExpiryTimeGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		uint32_t	vlan,
		uint16_t *	expiryTime
	)

Get the configured IGMP Snooping Mcast Router Expiry Time for the VLAN.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[in]	vlan	VLAN ID
[out]	expiryTime	Snooping Mcast Router Expiry Time

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopVlanMcastRtrExpiryTimeSet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		uint32_t	vlan,
		uint16_t	expiryTime
	)

Set the configured IGMP Snooping Mcast Router Expiry Time for the VLAN.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[in]	vlan	VLAN ID
[in]	expiryTime	Snooping Mcast Router Expiry Time

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopVlanModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint32_t *	snoopVlanMode,
		uint8_t	family
	)

Get the IGMP/MLD snooping mode corresponding to the VLAN ID.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vlanId	VLAN ID.
[out]	snoopVlanMode	IGMP/MLD snooping mode for the VLAN ID.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	snooping VLAN mode was retrieved successfully.
OPEN_E_FAIL	snooping VLAN mode retrieval failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopVlanModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint32_t	snoopVlanMode,
		uint8_t	family
	)

Set the IGMP/MLD snooping mode corresponding to the VLAN ID.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vlanId	VLAN ID.
[in]	snoopVlanMode	IGMP/MLD snooping mode for the VLAN ID.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	snooping VLAN mode was sets successfully.
OPEN_E_FAIL	snooping VLAN mode sets failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopVlanMrouterListGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		uint32_t	vlan,
		open_buffdesc *	dynamicMask,
		open_buffdesc *	staticMask
	)

Get the static and dynamic Mrouter interface list.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[in]	vlan	VLAN ID
[out]	dynamicMask	Dynamic Mrouter interface list
[out]	staticMask	Static Mrouter interface list

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopVlanMrtrExcludeModeGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		uint32_t	vlan,
		OPEN_CONTROL_t *	mode
	)

Get the VLAN mode for excluding mrouter ports.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[in]	vlan	VLAN ID
[out]	mode	Exclude mode ENABLED/DISABLED

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopVlanMrtrExcludeModeSet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		uint32_t	vlan,
		OPEN_CONTROL_t	mode
	)

Set the VLAN mode for excluding mrouter ports.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[in]	vlan	VLAN ID
[in]	mode	Exclude mode ENABLED/DISABLED

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopVlanNextGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint32_t *	nextVlan
	)

Gets next VLAN ID for snooping configuration.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vlanId	VLAN ID.
[out]	vlanId	next VLAN ID.

Return values

OPEN_E_NONE	valid VLAN ID.
OPEN_E_FAIL	invalid VLAN for configuration.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

Examples:

snooping_example.c.

open_error_t openapiSnoopVlanProxyQuerierModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint32_t *	mode,
		uint8_t	family
	)

Gets the configured snooping proxy querier mode for the specified VLAN of a snoop instance.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vlanId	VLAN ID.
[out]	mode	configured snooping proxy querier mode.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	snooping proxy querier mode was retrieved successfully.
OPEN_E_FAIL	snooping proxy querier mode retrieval failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopVlanProxyQuerierModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint32_t	mode,
		uint8_t	family
	)

Sets the configured snooping proxy querier mode for the specified VLAN of a snoop instance.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vlanId	VLAN ID.
[in]	mode	configured snooping proxy querier mode.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.

Return values

OPEN_E_NONE	snooping proxy querier mode was set successfully.
OPEN_E_FAIL	snooping proxy querier mode set failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopVlanReportFloodModeGet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		uint32_t	vlan,
		OPEN_CONTROL_t *	mode
	)

Get the report flood mode in the VLAN.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[in]	vlan	VLAN ID
[out]	mode	Flood mode ENABLED/DISABLED

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopVlanReportFloodModeSet	(	openapiClientHandle_t *	client_handle,
		uint8_t	family,
		uint32_t	vlan,
		OPEN_CONTROL_t	mode
	)

Set the report flood mode in the VLAN.

Parameters

[in]	client_handle	client handle from registration API
[in]	family	address family L7_AF_INET/L7_AF_INET6
[in]	vlan	VLAN ID
[in]	mode	Flood mode ENABLED/DISABLED

Return values

OPEN_E_UNAVAIL	Feature not available
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

open_error_t openapiSnoopVlanReportSuppModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint8_t	family,
		OPEN_BOOL_t *	reportSuppMode
	)

Get the configured IGMP/MLD snooping report suppression mode for the specified VLAN.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vlanId	VLAN ID.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[out]	reportSuppMode	reference to the IGMP/MLD snooping report suppression mode.

Return values

OPEN_E_NONE	if suppression mode was retrieved successfully.
OPEN_E_FAIL	if VLAN ID out of range.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSnoopVlanReportSuppModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint8_t	family,
		OPEN_BOOL_t	reportSuppMode
	)

Sets the configured IGMP/MLD snooping report suppression mode for the specified VLAN.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vlanId	VLAN ID.
[in]	family	OPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[in]	reportSuppMode	reference to the IGMP/MLD snooping report suppression mode.

Return values

OPEN_E_NONE	suppression mode was set successfully.
OPEN_E_FAIL	if VLAN ID out of range.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7