Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Macros | Enumerations | Functions
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 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 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 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 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 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 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 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 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 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, OPEN_CONTROL_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, OPEN_CONTROL_t vlanMode, uint8_t family)
 Set the configured snooping querier mode for the specified vlanId of a snoop instance. 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 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 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 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 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

Enumerator
OPEN_SNOOP_QUERIER_QUERIER 

Querier Disabled.

OPEN_SNOOP_QUERIER_NON_QUERIER 

Querier State.

Definition at line 52 of file openapi_snooping.h.

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 45 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_handleclient handle from registration API.
[out]adminModeadmin mode.
[in]familyaddress family. OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping
Return values
OPEN_E_NONEIGMP/MLD Snooping Admin mode returned.
OPEN_E_FAILFailed to get IGMP/MLD Snooping Admin mode.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]adminModeadmin mode.
[in]familyaddress family. OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping
Return values
OPEN_E_NONEIGMP/MLD static mcast router attached status set successful.
OPEN_E_FAILFailed to set IGMP/MLD Snooping Admin mode.
OPEN_E_PARAMError 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_handleclient handle from registration API
[out]modeAuto Video mode
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther 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_handleclient handle from registration API
[in]modeAuto Video mode
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther 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_handleclient handle from registration API
[out]vlanIdAuto Video vlanId
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther 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_handleclient handle from registration API.
[out]processedFramesnumber of control frames processed.
[in]familyaddress family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping
Return values
OPEN_E_NONENumber of multicast control (i.e. IGMP/MLD) frames processed by the CPU returned.
OPEN_E_FAILFailed to get number of multicast control (i.e. IGMP/MLD) frames processed by the CPU.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[out]forwardedFramesnumber of data frames forwarded.
[in]familyaddress family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping
Return values
OPEN_E_NONENumber of multicast data frames forwarded by the CPU returned.
OPEN_E_FAILFailed to get Inumber of multicast data frames forwarded by the CPU.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]familyaddress family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping
Return values
OPEN_E_NONEAll entries flushed successful.
OPEN_E_FAILFailed to flush all entries.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
snooping_example.c.
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_handleclient handle from registration API.
[out]floodAllOPEN_TRUE if flooding to all ports.
Return values
OPEN_E_NONEConfigured mode for flooding unknown multicast traffic to all ports returned.
OPEN_E_FAILFailed to get configured mode for flooding unknown multicast traffic to all ports.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]floodAllOPEN_TRUE if flooding to all ports.
Return values
OPEN_E_NONEConfigured mode for flooding unknown multicast traffic to all ports set successful.
OPEN_E_FAILFailed to set configured mode for flooding unknown multicast traffic to all ports.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
snooping_example.c.
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_handleclient handle from registration API.
[out]maskcomma separated string of the interfaces.
  • Buffer allocated size must be at least
  • L7_IGMP_SNOOPING_MAX_INTF
[in]familyaddress family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping
Return values
OPEN_E_NONEInterface mask of interfaces enabled for IGMP/MLD Snooping returned.
OPEN_E_FAILFailed to get interface mask of interfaces enabled for IGMP/MLD Snooping.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]maskcomma separated string of the interfaces.
  • Buffer allocated size must be at least
  • L7_IGMP_SNOOPING_MAX_INTF
[in]familyaddress family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping
Return values
OPEN_E_NONEIGMP/MLD Snooping interface mode via a bit mask set successful.
OPEN_E_FAILFailed to set IGMP/MLD Snooping interface mode via a bit mask.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]intIfNuminternal interface number.
[out]modeFast-Leave interface admin mode.
[in]familyaddress family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping
Return values
OPEN_E_NONEFast-Leave Admin mode for the specified interface returned.
OPEN_E_FAILFailed to get Fast-Leave Admin mode for the specified interface.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]intIfNuminternal interface number.
[in]modeFast-Leave interface admin mode.
[in]familyaddress family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping
Return values
OPEN_E_NONEFast-Leave Admin mode for the specified interface set succesful.
OPEN_E_FAILFailed to set Fast-Leave Admin mode for the specified interface.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
snooping_example.c.
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_handleclient handle from registration API.
[in]intIfNuminternal interface number.
[out]queryTimequery time.
[in]familyaddress family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping
Return values
OPEN_E_NONEIGMP/MLD group membership interval for the specified interface returned.
OPEN_E_FAILFailed to get IGMP/MLD group membership interval for the specified interface.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]intIfNuminternal interface number.
[in]queryTimequery time.
[in]familyaddress family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping
Return values
OPEN_E_NONEIGMP/MLD group membership interval for the specified interface set successful.
OPEN_E_FAILFailed to set IGMP/MLD group membership interval for the specified interface.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
snooping_example.c.
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_handleclient handle from registration API.
[in]intIfNuminternal interface number.
[out]modesnooping mode
[in]familyaddress family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping
Return values
OPEN_E_NONEIGMP/MLD Snooping mode for the specified interface returned.
OPEN_E_FAILFailed to get IGMP/MLD Snooping mode for the specified interface.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]intIfNuminternal interface number.
[in]modesnooping mode
[in]familyaddress family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping
Return values
OPEN_E_NONEIGMP/MLD Snooping mode for the specified interface set successful.
OPEN_E_FAILFailed to set IGMP/MLD Snooping mode for the specified interface.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
snooping_example.c.
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_handleclient handle from registration API.
[in]intIfNuminternal interface number.
[out]modeProxy Querier Admin mode.
[in]familyaddress family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping
Return values
OPEN_E_NONEProxy Querier Admin mode for the specified interface returned.
OPEN_E_FAILFailed to get Proxy Querier Admin mode for the specified interface.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]intIfNuminternal interface number.
[in]modeProxy Querier Admin mode.
[in]familyaddress family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping
Return values
OPEN_E_NONEProxy Querier Admin mode for the specified interface set successful.
OPEN_E_FAILFailed 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_handleclient handle from registration API.
[in]intIfNuminternal interface number.
[out]responseTimeresponse time.
[in]familyaddress family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping
Return values
OPEN_E_NONEIGMP/MLD query response time for the specified interface returned.
OPEN_E_FAILFailed to get IGMP/MLD query response time for the specified interface.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]intIfNuminternal interface number.
[in]responseTimeresponse time.
[in]familyaddress family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping
Return values
OPEN_E_NONEIGMP/MLD query response time for the specified interface set successful.
OPEN_E_FAILFailed to set IGMP/MLD query response time for the specified interface.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
snooping_example.c.
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_handleclient handle from registration API.
[in]intIfNuminternal interface number.
[out]validvalidation status.
Return values
OPEN_E_NONEValidity of interface checked.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
snooping_example.c.
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_handleclient handle from registration API.
[in]familyaddress family. OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping
[out]validvalidation status
Return values
OPEN_E_NONEValidity of family checked.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
snooping_example.c.
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_handleclient handle from registration API.
[out]adminModeadmin mode.
[in]familyaddress family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping
Return values
OPEN_E_NONEIGMP/MLD Proxy Querier Admin mode for the specified snooping instance returned.
OPEN_E_FAILFailed to get IGMP/MLD Proxy Querier Admin mode for the specified snooping instance.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]adminModeadmin mode.
[in]familyaddress family OPEN_AF_INET => IGMP Snooping OPEN_AF_INET6 => MLD Snooping
Return values
OPEN_E_NONEIGMP/MLD Proxy Querier Admin mode for the specified snooping instance set successful.
OPEN_E_FAILFailed to set IGMP/MLD Proxy Querier Admin mode for the specified snooping instance.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[out]snoopQuerierAddrpointer to querier address.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEquerier configured address was retrieved successfully.
OPEN_E_FAILquerier configured address retrieval failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]snoopQuerierAddrpointer to querier address.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEquerier configured address was set successfully.
OPEN_E_FAILquerier configured address set failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[out]adminModesnooping querier admin mode.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEquerier admin mode was retrieved successfully.
OPEN_E_FAILquerier admin mode retrieval failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]adminModesnooping querier admin mode.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEquerier admin mode address was set successfully.
OPEN_E_FAILquerier admin mode address set failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[out]expiryIntervalinterval for declaring last querier as expired.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEquerier expiry interval was retrieved successfully.
OPEN_E_FAILquerier expiry interval retrieval failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]expiryIntervalinterval for declaring last querier as expired.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEquerier expiry interval address was set successfully.
OPEN_E_FAILquerier expiry interval address set failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[out]querierAddrlast querier VLAN address.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEquerier address was retrieved successfully.
OPEN_E_FAILquerier address retrieval failed.
OPEN_E_NOT_FOUNDif querier address is not found.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]vlanIdVLAN ID.
[out]versionlast querier protocol version.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONElast querier's version was retrieved successfully.
OPEN_E_FAILlast querier's version retrieval failed.
OPEN_E_NOT_FOUNDif last querier's version is not found.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

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_handleclient handle from registration API.
[in]vlanIdVLAN ID.
[out]maxRespTimeoperational max response time value.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEmax response time was retrieved successfully.
OPEN_E_FAILmax response time retrieval failed.
OPEN_E_NOT_FOUNDif max response time is not found.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]vlanIdVLAN ID.
[out]stateoperational state OPEN_SNOOP_QUERIER_STATE_t.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEstate of querier was retrieved successfully.
OPEN_E_FAILstate of querier retrieval failed.
OPEN_E_NOT_FOUNDif state of querier is not found.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]vlanIdVLAN ID.
[out]versionoperational version.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEoperational version was retrieved successfully.
OPEN_E_FAILoperational version retrieval failed.
OPEN_E_NOT_FOUNDif operational version is not found.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[out]queryIntervalinterval for sending periodic queries.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEsnooping interval was retrieved successfully.
OPEN_E_FAILsnooping interval retrieval failed.
OPEN_E_NOT_FOUNDif snooping interval is not found.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]queryIntervalinterval for sending periodic queries.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEsnooping interval was set successfully.
OPEN_E_FAILsnooping interval set failed.
OPEN_E_NOT_FOUNDif snooping interval is not found.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[out]versionconfigured querier version.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEquerier configured version was retrieved successfully.
OPEN_E_FAILquerier configured version retrieval failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]versionconfigured querier version.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEconfigured querier version was set successfully.
OPEN_E_FAILconfigured querier version set failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]vlanIdVLAN ID.
[out]snoopQuerierAddrquerier VLAN address.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEquerier VLAN address was retrieved successfully.
OPEN_E_FAILquerier VLAN address retrieval failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]vlanIdVLAN ID.
[in]snoopQuerierAddrquerier VLAN address.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEquerier VLAN address was set successfully.
OPEN_E_FAILquerier VLAN address set failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]vlanIdVLAN ID.
[out]vlanModeconfigured snooping querier VLAN election participate mode.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEquerier election mode was retrieved successfully.
OPEN_E_FAILquerier election mode retrieval failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]vlanIdVLAN ID.
[in]vlanModeconfigured snooping querier VLAN election participate mode.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEquerier election mode was set successfully.
OPEN_E_FAILquerier election mode set failed.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

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

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

Parameters
[in]client_handleclient handle from registration API.
[in]vlanIdVLAN ID.
[out]vlanModeconfigured snooping querier VLAN mode.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEsnooping querier VLAN mode was retrieved successfully.
OPEN_E_FAILsnooping querier VLAN mode retrieval failed.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
snooping_example.c.
open_error_t openapiSnoopQuerierVlanModeSet ( openapiClientHandle_t client_handle,
uint32_t  vlanId,
OPEN_CONTROL_t  vlanMode,
uint8_t  family 
)

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

Parameters
[in]client_handleclient handle from registration API.
[in]vlanIdVLAN ID.
[in]vlanModeconfigured snooping querier VLAN mode.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEsnooping querier VLAN mode was set successfully.
OPEN_E_FAILsnooping querier VLAN mode set failed.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.11

Examples:
snooping_example.c.
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_handleclient handle from registration API.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[in]pGrouppointer to the group address.
[in]pIntIfNumpointer to the internal interface number.
[in]pVlanIdVLAN ID for the group entry.
[out]pfilterModepointer to the filter mode.
Return values
OPEN_E_NONESSM group filter mode returned.
OPEN_E_FAILSSM group filter mode retrieval failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[in]pGrouppointer to the group address.
[in]pIntIfNumpointer to the internal interface number.
[in]pVlanIdVLAN ID for the group entry.
[out]pSrcIppointer to the last reporter IP address.
Return values
OPEN_E_NONESSM group last reporter returned.
OPEN_E_FAILSSM group last reporter retrieval failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[in]pGrouppointer to the group address.
[in]pIntIfNumpointer to the internal interface number.
[in]pVlanIdVLAN ID for the group entry.
Return values
OPEN_E_NONESSM group record first returned.
OPEN_E_FAILSSM group record first retrieval failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[in,out]pGrouppointer to the group address.
[in,out]pIntIfNumpointer to the internal interface number.
[in,out]pVlanIdVLAN ID for the group entry.
Return values
OPEN_E_NONESSM group record next returned.
OPEN_E_FAILSSM group record next retrieval failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[out]currEntriesnumber of current entries.
Return values
OPEN_E_NONEcurrent number of entries returned.
OPEN_E_FAILcurrent number of entries retrieval failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[in]pGrouppointer to the group address.
[in]pIntIfNumpointer to the internal interface number.
[in]pVlanIdVLAN ID for the group entry.
[out]excPortMaskpointer to interface mask.
  • Buffer allocated size must be at least
  • L7_NIM_IFNAME_SIZE
Return values
OPEN_E_NONEport list returned.
OPEN_E_FAILport list retrieval failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[out]pGrouppointer to the group address.
[out]pSourcepointer to the internal interface number.
[out]pVlanIdVLAN ID for the group entry.
Return values
OPEN_E_NONEfirst learnt entry returned.
OPEN_E_FAILfirst learnt entry retrieval failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[in]pGrouppointer to the group address.
[in]pIntIfNumpointer to the internal interface number.
[in]pVlanIdVLAN ID for the group entry.
[out]incPortMaskpointer to interface mask.
  • Buffer allocated size must be at least
  • L7_NIM_IFNAME_SIZE
Return values
OPEN_E_NONEport list returned.
OPEN_E_FAILport list retrieval failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[in,out]pGrouppointer to the group address.
[in,out]pIntIfNumpointer to the internal interface number.
[in,out]pVlanIdVLAN ID for the group entry.
Return values
OPEN_E_NONEnext learnt entry returned.
OPEN_E_FAILnext learnt entry retrieval failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[out]maxEntriestotal number of entries.
Return values
OPEN_E_NONEmaximum number of entries returned.
OPEN_E_FAILmaximum number of entries retrieval failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[out]mostEntriesmost number of entries ever.
Return values
OPEN_E_NONEnumber of entries returned.
OPEN_E_FAILnumber of entries retrieval failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[in]pGrouppointer to the group address.
[in]pIntIfNumpointer to the internal interface number.
[in]pVlanIdVLAN ID for the group entry.
[in]pSrcIppointer to the Source IP address.
Return values
OPEN_E_NONEentry exists.
OPEN_E_FAILif an entry is not exist.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[in,out]pGrouppointer to the group address.
[in,out]pIntIfNumpointer to the internal interface number.
[in,out]pVlanIdVLAN ID for the group entry.
[in,out]pSrcIppointer to the Source IP address.
Return values
OPEN_E_NONEsource list entry exists.
OPEN_E_FAILif an source list entry is not exist.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]vlanIdVLAN ID.
Return values
OPEN_E_NONEvalid VLAN ID.
OPEN_E_FAILinvalid VLAN for configuration.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]vlanIdVLAN ID.
[out]fastLeaveModeconfigured IGMP/MLD snooping fast leave.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEif mode was retrieved successfully.
OPEN_E_FAILif VLAN ID out of range.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]vlanIdVLAN ID.
[in]fastLeaveModeconfigured IGMP/MLD snooping fast leave.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEif mode was sets successfully.
OPEN_E_FAILif VLAN ID out of range or fast leave mode retrieval failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]vlanIdVLAN ID.
[out]groupMembershipIntervalconfigured IGMP/MLD snooping group membership interval.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEgroup membership interval was retrieved successfully.
OPEN_E_FAILgroup membership interval retrieval failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]vlanIdVLAN ID.
[in]groupMembershipIntervalconfigured IGMP/MLD snooping group membership interval.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEgroup membership interval was sets successfully.
OPEN_E_FAILgroup membership interval sets failed.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

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_handleclient handle from registration API.
[in]vlanIdVLAN ID.
[out]responseTimeconfigured IGMP/MLD snooping maximum response time.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEmaximum response time was retrieved successfully.
OPEN_E_FAILmaximum response time retrieval failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]vlanIdVLAN ID.
[in]responseTimeconfigured IGMP/MLD snooping maximum response time.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEresponse time was sets successfully.
OPEN_E_FAILresponse time sets failed.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
snooping_example.c.
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_handleclient handle from registration API.
[in]vlanIdVLAN ID.
[out]snoopVlanModeIGMP/MLD snooping mode for the VLAN ID.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEsnooping VLAN mode was retrieved successfully.
OPEN_E_FAILsnooping VLAN mode retrieval failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]vlanIdVLAN ID.
[in]snoopVlanModeIGMP/MLD snooping mode for the VLAN ID.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEsnooping VLAN mode was sets successfully.
OPEN_E_FAILsnooping VLAN mode sets failed.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

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

Gets next VLAN ID for snooping configuration.

Parameters
[in]client_handleclient handle from registration API.
[in]vlanIdVLAN ID.
[out]vlanIdnext VLAN ID.
Return values
OPEN_E_NONEvalid VLAN ID.
OPEN_E_FAILinvalid VLAN for configuration.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]vlanIdVLAN ID.
[out]modeconfigured snooping proxy querier mode.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEsnooping proxy querier mode was retrieved successfully.
OPEN_E_FAILsnooping proxy querier mode retrieval failed.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]vlanIdVLAN ID.
[in]modeconfigured snooping proxy querier mode.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
Return values
OPEN_E_NONEsnooping proxy querier mode was set successfully.
OPEN_E_FAILsnooping proxy querier mode set failed.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

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_handleclient handle from registration API.
[in]vlanIdVLAN ID.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[out]reportSuppModereference to the IGMP/MLD snooping report suppression mode.
Return values
OPEN_E_NONEif suppression mode was retrieved successfully.
OPEN_E_FAILif VLAN ID out of range.
OPEN_E_PARAMError 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_handleclient handle from registration API.
[in]vlanIdVLAN ID.
[in]familyOPEN_AF_INET => IGMP Snooping. OPEN_AF_INET6 => MLD Snooping.
[in]reportSuppModereference to the IGMP/MLD snooping report suppression mode.
Return values
OPEN_E_NONEsuppression mode was set successfully.
OPEN_E_FAILif VLAN ID out of range.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7