This Code Implements The OpEN Static Filter API [OPENAPI_STATIC_FILTER]

Enumerations
enum	OPEN_FILTER_VLAN_FILTER_MODE_t { OPEN_FILTER_FORWARD_ALL, OPEN_FILTER_FORWARD_UNREGISTERED, OPEN_FILTER_FILTER_UNREGISTERED }

Functions
open_error_t	openapiFilterAdminModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *adminMode)
	Gets the static MAC filter admin mode. More...
open_error_t	openapiFilterAdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t adminMode)
	Sets the static MAC filter admin mode. More...
open_error_t	openapiFilterCheckMacAddrTypeMulticast (openapiClientHandle_t *client_handle, open_buffdesc *macAddr, OPEN_BOOL_t *status)
	Checks to see the mac address type, unicast or multicast. More...
open_error_t	openapiFilterCountersGet (openapiClientHandle_t *client_handle, uint32_t *totalCount, uint32_t *multicastFiltCount, uint32_t *unicastFiltCount)
	Gets the number of total, multicast and unicast MAC static filters configured. More...
open_error_t	openapiFilterCountGet (openapiClientHandle_t *client_handle, uint32_t *count)
	Gets the number of MAC static filters configured. More...
open_error_t	openapiFilterCreate (openapiClientHandle_t *client_handle, open_buffdesc *macAddr, uint32_t vlanID)
	Create a MAC Static Filter. More...
open_error_t	openapiFilterDstFiltIntfListGet (openapiClientHandle_t *client_handle, open_buffdesc *macAddr, uint32_t vlanId, uint32_t *numOfDstIntf, open_buffdesc *dstFiltIntfList)
	Gets list of destination filter interfaces for a MAC static filter. More...
open_error_t	openapiFilterDstIntfAdd (openapiClientHandle_t *client_handle, open_buffdesc *macAddr, uint32_t vlanId, uint32_t ifNum)
	Adds a destination interface to the static MAC filter. More...
open_error_t	openapiFilterDstIntfDelete (openapiClientHandle_t *client_handle, open_buffdesc *macAddr, uint32_t vlanId, uint32_t ifNum)
	Deletes a destination interface from the destination interface list of the static MAC filter. More...
open_error_t	openapiFilterDstIntfListAdd (openapiClientHandle_t *client_handle, open_buffdesc *macAddr, uint32_t vlanId, uint32_t ifNum, open_buffdesc *fwdIntfList, open_buffdesc *filterIntfList)
	Adds destination interfaces to the static MAC filter. More...
open_error_t	openapiFilterDstIntfListDelete (openapiClientHandle_t *client_handle, open_buffdesc *macAddr, uint32_t vlanId, uint32_t ifNum, open_buffdesc *fwdIntfList, open_buffdesc *filterIntfList)
	Deletes destination interfaces from the static MAC filter. More...
open_error_t	openapiFilterDstIntfListGet (openapiClientHandle_t *client_handle, open_buffdesc *macAddr, uint32_t vlanId, uint32_t *numOfDstIntf, open_buffdesc *dstIntfList)
	Gets list of destination interfaces for a MAC static filter. More...
open_error_t	openapiFilterFilteringModeSet (openapiClientHandle_t *client_handle, OPEN_FILTER_VLAN_FILTER_MODE_t mode)
	Set multicast address filtering configuration for all vlans. More...
open_error_t	openapiFilterFirstGet (openapiClientHandle_t *client_handle, open_buffdesc *macAddr, uint32_t *vlanId)
	Gets the first configured MAC static filter. More...
open_error_t	openapiFilterIsConfigured (openapiClientHandle_t *client_handle, open_buffdesc *macAddr, uint32_t vlanId, OPEN_BOOL_t *status)
	Checks to see if a MAC filter is configured or not. More...
open_error_t	openapiFilterIsIntfInAnyFilter (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *status)
	Checks if a particular interface is present in any MAC filter. More...
open_error_t	openapiFilterIsValidIntf (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *status)
	Checks if the interface is valid for filtering. More...
open_error_t	openapiFilterNextGet (openapiClientHandle_t *client_handle, open_buffdesc *macAddr, uint32_t vlanId, open_buffdesc *nextMacAddr, uint32_t *nextVlanId)
	Gets the next configured MAC static filter. More...
open_error_t	openapiFilterPortParmCanSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *status)
	Check to see if the port is the appropriate type on which the param can be set. More...
open_error_t	openapiFilterRemove (openapiClientHandle_t *client_handle, open_buffdesc *macAddr, uint32_t vlanID)
	Remove a configured MAC Static Filter. More...
open_error_t	openapiFilterSizeGet (openapiClientHandle_t *client_handle, uint32_t *size)
	Gets the buffer size used by filtering component for the bit mask. More...
open_error_t	openapiFilterSrcIntfAdd (openapiClientHandle_t *client_handle, open_buffdesc *macAddr, uint32_t vlanId, uint32_t ifNum)
	Adds a source interface to the static MAC filter. More...
open_error_t	openapiFilterSrcIntfDelete (openapiClientHandle_t *client_handle, open_buffdesc *macAddr, uint32_t vlanId, uint32_t ifNum)
	Deletes a source interface from the source interface list of the static MAC filter. More...
open_error_t	openapiFilterSrcIntfListGet (openapiClientHandle_t *client_handle, open_buffdesc *macAddr, uint32_t vlanId, uint32_t *numOfSrcIntf, open_buffdesc *srcIntfList)
	Gets list of source interfaces for a MAC static filter. More...
open_error_t	openapiFilterSrcIntfListModify (openapiClientHandle_t *client_handle, open_buffdesc *macAddr, uint32_t vlanId, open_buffdesc *srcIntfList)
	Apply a source interface list to the static MAC filter. More...
open_error_t	openapiFilterStreamGet (openapiClientHandle_t *client_handle, open_buffdesc *macAddr, uint32_t vlanId, uint32_t *streamId)
	Gets the configured stream id. More...
open_error_t	openapiFilterStreamSet (openapiClientHandle_t *client_handle, open_buffdesc *macAddr, uint32_t vlanId, uint32_t streamId)
	Sets the stream id of an existing macfilter with given MAC address and vlan id. More...
open_error_t	openapiFilterVlanFilteringModeGet (openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_FILTER_VLAN_FILTER_MODE_t *mode)
	Gets multicast address filtering configuration for the specified vlan. More...
open_error_t	openapiFilterVlanFilteringModeSet (openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_FILTER_VLAN_FILTER_MODE_t mode)
	Sets multicast address filtering configuration for the specified vlan. More...

Detailed Description

Function Documentation

open_error_t openapiFilterAdminModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	adminMode
	)

Gets the static MAC filter admin mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	adminMode	Static MAC filter admin mode

Return values

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

OpEN API Version: 1.25

Examples:

static_filter_example.c.

open_error_t openapiFilterAdminModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	adminMode
	)

Sets the static MAC filter admin mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	adminMode	Static MAC filter admin mode

Return values

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

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

static_filter_example.c.

open_error_t openapiFilterCheckMacAddrTypeMulticast	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	macAddr,
		OPEN_BOOL_t *	status
	)

Checks to see the mac address type, unicast or multicast.

Parameters

[in]	client_handle	client handle from registration API
[in]	macAddr	MAC address
[out]	status	OPEN_TRUE MAC address is of type multicast OPEN_FALSE MAC address is of type unicast

Return values

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

OpEN API Version: 1.25

Examples:

static_filter_example.c.

open_error_t openapiFilterCountersGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	totalCount,
		uint32_t *	multicastFiltCount,
		uint32_t *	unicastFiltCount
	)

Gets the number of total, multicast and unicast MAC static filters configured.

Parameters

[in]	client_handle	client handle from registration API
[out]	totalCount	Total number of MAC static filters configured
[out]	multicastFiltCount	Number of multicast MAC static filters configured
[out]	unicastFiltCount	Number of unicast MAC static filters configured

Return values

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

OpEN API Version: 1.25

Examples:

static_filter_example.c.

open_error_t openapiFilterCountGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	count
	)

Gets the number of MAC static filters configured.

Parameters

[in]	client_handle	client handle from registration API
[out]	count	Number of MAC static filters configured

Return values

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

OpEN API Version: 1.25

Examples:

static_filter_example.c.

open_error_t openapiFilterCreate	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	macAddr,
		uint32_t	vlanID
	)

Create a MAC Static Filter.

Parameters

[in]	client_handle	client handle from registration API
[in]	macAddr	static MAC address for the filter
[in]	vlanID	VLAN ID for the filter

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.
OPEN_E_EXISTS	Already exists.
OPEN_E_FULL	Maximum count reached or table full.

Note

Refer OPENAPI_DOT1Q_MIN_VLAN_ID, OPENAPI_DOT1Q_MAX_VLAN_ID for minimum and maximum values of VLAN ID

MAC address string should be in one of the below formats: "xx:xx:xx:xx:xx:xx", "xx-xx-xx-xx-xx-xx", "xxxx.xxxx.xxxx"

macAddr buffer should have 18 bytes memory.

OpEN API Version: 1.20

Examples:

static_filter_example.c.

open_error_t openapiFilterDstFiltIntfListGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	macAddr,
		uint32_t	vlanId,
		uint32_t *	numOfDstIntf,
		open_buffdesc *	dstFiltIntfList
	)

Gets list of destination filter interfaces for a MAC static filter.

Parameters

[in]	client_handle	Client handle from registration API
[in]	macAddr	MAC address
[in]	vlanId	VLAN ID
[out]	numOfDstIntf	Number of destination filter interfaces
[out]	dstFiltIntfList	List of destination filter interfaces

Return values

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

Note

dstFiltIntfList buffer should have ((4 * 1024)+1) bytes memory.

OpEN API Version: 1.25

Examples:

static_filter_example.c.

open_error_t openapiFilterDstIntfAdd	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	macAddr,
		uint32_t	vlanId,
		uint32_t	ifNum
	)

Adds a destination interface to the static MAC filter.

Parameters

[in]	client_handle	client handle from registration API
[in]	macAddr	MAC address
[in]	vlanId	VLAN ID
[in]	ifNum	Interface number

Return values

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

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

static_filter_example.c.

open_error_t openapiFilterDstIntfDelete	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	macAddr,
		uint32_t	vlanId,
		uint32_t	ifNum
	)

Deletes a destination interface from the destination interface list of the static MAC filter.

Parameters

[in]	client_handle	client handle from registration API
[in]	macAddr	MAC address
[in]	vlanId	VLAN ID
[in]	ifNum	Interface number

Return values

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

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

static_filter_example.c.

open_error_t openapiFilterDstIntfListAdd	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	macAddr,
		uint32_t	vlanId,
		uint32_t	ifNum,
		open_buffdesc *	fwdIntfList,
		open_buffdesc *	filterIntfList
	)

Adds destination interfaces to the static MAC filter.

Parameters

[in]	client_handle	client handle from registration API
[in]	macAddr	MAC address
[in]	vlanId	VLAN ID
[in]	ifNum	Interface number
[in]	fwdIntfList	List of ports to forward
[in]	filterIntfList	List of ports to forbid

Return values

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

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

static_filter_example.c.

open_error_t openapiFilterDstIntfListDelete	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	macAddr,
		uint32_t	vlanId,
		uint32_t	ifNum,
		open_buffdesc *	fwdIntfList,
		open_buffdesc *	filterIntfList
	)

Deletes destination interfaces from the static MAC filter.

Parameters

[in]	client_handle	client handle from registration API
[in]	macAddr	MAC address
[in]	vlanId	VLAN ID
[in]	ifNum	Interface number
[in]	fwdIntfList	List of ports to forward
[in]	filterIntfList	List of ports to forbid

Return values

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

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

static_filter_example.c.

open_error_t openapiFilterDstIntfListGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	macAddr,
		uint32_t	vlanId,
		uint32_t *	numOfDstIntf,
		open_buffdesc *	dstIntfList
	)

Gets list of destination interfaces for a MAC static filter.

Parameters

[in]	client_handle	client handle from registration API
[in]	macAddr	MAC address
[in]	vlanId	VLAN ID
[out]	numOfDstIntf	Number of destination interfaces
[out]	dstIntfList	List of destination interfaces

Return values

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

Note

dstIntfList buffer should have ((4 * 1024)+1) bytes memory.

OpEN API Version: 1.25

Examples:

static_filter_example.c.

open_error_t openapiFilterFilteringModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_FILTER_VLAN_FILTER_MODE_t	mode
	)

Set multicast address filtering configuration for all vlans.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Filtering mode

Return values

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

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

static_filter_example.c.

open_error_t openapiFilterFirstGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	macAddr,
		uint32_t *	vlanId
	)

Gets the first configured MAC static filter.

Parameters

[in]	client_handle	client handle from registration API
[out]	macAddr	MAC address
[out]	vlanId	VLAN ID

Return values

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

OpEN API Version: 1.25

Examples:

static_filter_example.c.

open_error_t openapiFilterIsConfigured	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	macAddr,
		uint32_t	vlanId,
		OPEN_BOOL_t *	status
	)

Checks to see if a MAC filter is configured or not.

Parameters

[in]	client_handle	client handle from registration API
[in]	macAddr	MAC address
[in]	vlanId	VLAN ID
[out]	status	Status of MAC filter

Return values

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

OpEN API Version: 1.25

Examples:

static_filter_example.c.

open_error_t openapiFilterIsIntfInAnyFilter	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t *	status
	)

Checks if a particular interface is present in any MAC filter.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface number
[out]	status	Presence of MAC filter in the specified interface

Return values

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

OpEN API Version: 1.25

Examples:

static_filter_example.c.

open_error_t openapiFilterIsValidIntf	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t *	status
	)

Checks if the interface is valid for filtering.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface number
[out]	status	Validity of interface for MAC filtering

Return values

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

OpEN API Version: 1.25

Examples:

static_filter_example.c.

open_error_t openapiFilterNextGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	macAddr,
		uint32_t	vlanId,
		open_buffdesc *	nextMacAddr,
		uint32_t *	nextVlanId
	)

Gets the next configured MAC static filter.

Parameters

[in]	client_handle	client handle from registration API
[in]	macAddr	MAC address
[in]	vlanId	VLAN ID
[out]	nextMacAddr	MAC address of the next filter
[out]	nextVlanId	VLAN ID of the next filter

Return values

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

OpEN API Version: 1.25

Examples:

static_filter_example.c.

open_error_t openapiFilterPortParmCanSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t *	status
	)

Check to see if the port is the appropriate type on which the param can be set.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface number
[out]	status	Status of the param can be set on this port type

Return values

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

OpEN API Version: 1.25

Examples:

static_filter_example.c.

open_error_t openapiFilterRemove	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	macAddr,
		uint32_t	vlanID
	)

Remove a configured MAC Static Filter.

Parameters

[in]	client_handle	client handle from registration API
[in]	macAddr	static MAC address for the filter
[in]	vlanID	VLAN ID for the filter

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

Note

Refer OPENAPI_DOT1Q_MIN_VLAN_ID, OPENAPI_DOT1Q_MAX_VLAN_ID for minimum and maximum values of VLAN ID

MAC address string should be in one of the below formats: "xx:xx:xx:xx:xx:xx", "xx-xx-xx-xx-xx-xx", "xxxx.xxxx.xxxx"

macAddr buffer should have 18 bytes memory.

OpEN API Version: 1.20

Examples:

static_filter_example.c.

open_error_t openapiFilterSizeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	size
	)

Gets the buffer size used by filtering component for the bit mask.

Parameters

[in]	client_handle	client handle from registration API
[out]	size	Buffer size for the bit mask

Return values

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

OpEN API Version: 1.25

Examples:

static_filter_example.c.

open_error_t openapiFilterSrcIntfAdd	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	macAddr,
		uint32_t	vlanId,
		uint32_t	ifNum
	)

Adds a source interface to the static MAC filter.

Parameters

[in]	client_handle	client handle from registration API
[in]	macAddr	MAC address
[in]	vlanId	VLAN ID
[in]	ifNum	Interface number

Return values

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

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

static_filter_example.c.

open_error_t openapiFilterSrcIntfDelete	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	macAddr,
		uint32_t	vlanId,
		uint32_t	ifNum
	)

Deletes a source interface from the source interface list of the static MAC filter.

Parameters

[in]	client_handle	client handle from registration API
[in]	macAddr	MAC address
[in]	vlanId	VLAN ID
[in]	ifNum	Interface number

Return values

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

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

static_filter_example.c.

open_error_t openapiFilterSrcIntfListGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	macAddr,
		uint32_t	vlanId,
		uint32_t *	numOfSrcIntf,
		open_buffdesc *	srcIntfList
	)

Gets list of source interfaces for a MAC static filter.

Parameters

[in]	client_handle	client handle from registration API
[in]	macAddr	MAC address
[in]	vlanId	VLAN ID
[out]	numOfSrcIntf	Number of source interfaces
[out]	srcIntfList	List of source interfaces

Return values

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

Note

srcIntfList buffer should have ((4 * 1024)+1) bytes memory.

OpEN API Version: 1.25

Examples:

static_filter_example.c.

open_error_t openapiFilterSrcIntfListModify	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	macAddr,
		uint32_t	vlanId,
		open_buffdesc *	srcIntfList
	)

Apply a source interface list to the static MAC filter.

Parameters

[in]	client_handle	client handle from registration API
[in]	macAddr	MAC address
[in]	vlanId	VLAN ID
[in]	srcIntfList	List of interfaces specifying source ports

Return values

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

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

static_filter_example.c.

open_error_t openapiFilterStreamGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	macAddr,
		uint32_t	vlanId,
		uint32_t *	streamId
	)

Gets the configured stream id.

Parameters

[in]	client_handle	client handle from registration API
[in]	macAddr	MAC address
[in]	vlanId	VLAN ID
[out]	streamId	802.1qci stream-id

Return values

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

OpEN API Version: 1.25

Examples:

static_filter_example.c.

open_error_t openapiFilterStreamSet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	macAddr,
		uint32_t	vlanId,
		uint32_t	streamId
	)

Sets the stream id of an existing macfilter with given MAC address and vlan id.

Parameters

[in]	client_handle	client handle from registration API
[in]	macAddr	MAC address
[in]	vlanId	VLAN ID
[in]	streamId	802.1qci stream-id

Return values

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

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

static_filter_example.c.

open_error_t openapiFilterVlanFilteringModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		OPEN_FILTER_VLAN_FILTER_MODE_t *	mode
	)

Gets multicast address filtering configuration for the specified vlan.

Parameters

[in]	client_handle	client handle from registration API
[in]	vlanId	VLAN ID
[out]	mode	Filtering mode

Return values

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

OpEN API Version: 1.25

Examples:

static_filter_example.c.

open_error_t openapiFilterVlanFilteringModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		OPEN_FILTER_VLAN_FILTER_MODE_t	mode
	)

Sets multicast address filtering configuration for the specified vlan.

Parameters

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

Return values

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

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

static_filter_example.c.