Enumerations
enum	OPEN_POLICY_PORT_ACTION_t { OPEN_POLICY_PORT_ACTION_NONE = 0, OPEN_POLICY_PORT_ACTION_SHUTDOWN = 1, OPEN_POLICY_PORT_ACTION_RATELIMIT = 2, OPEN_POLICY_PORT_ACTION_TRAP = 3 }
	OpEN uses this enumeration to define Storm Control actions. More...

enum	OPEN_STORM_CTRL_MODE_t { OPEN_STORM_CTRL_MODE_NONE = 0, OPEN_STORM_CTRL_MODE_UNICAST = 1, OPEN_STORM_CTRL_MODE_BROADCAST = 2, OPEN_STORM_CTRL_MODE_MULTICAST = 3 }
	OpEN uses this enumeration to define Storm Control modes. More...

Functions
open_error_t	openapiStormControlActionGet (openapiClientHandle_t client_handle, OPEN_STORM_CTRL_MODE_t stormCtrlMode, OPEN_POLICY_PORT_ACTION_t action)
	Get the global storm control action.

open_error_t	openapiStormControlActionSet (openapiClientHandle_t *client_handle, OPEN_STORM_CTRL_MODE_t stormCtrlMode, OPEN_POLICY_PORT_ACTION_t action)
	Set the storm control action globally and on all the interfaces.

open_error_t	openapiStormControlIntfModeGet (openapiClientHandle_t client_handle, OPEN_STORM_CTRL_MODE_t stormCtrlMode, uint32_t interface, OPEN_CONTROL_t state)
	Get the state of storm control mode on an interface.

open_error_t	openapiStormControlIntfModeSet (openapiClientHandle_t *client_handle, OPEN_STORM_CTRL_MODE_t stormCtrlMode, uint32_t interface, OPEN_CONTROL_t state)
	Set the state of storm control mode on an interface.

open_error_t	openapiStormControlIntfThresholdDefaultSet (openapiClientHandle_t *client_handle, OPEN_STORM_CTRL_MODE_t stormCtrlMode, uint32_t interface)
	Set the storm control threshold value and rate unit to default on an interface.

open_error_t	openapiStormControlIntfThresholdGet (openapiClientHandle_t client_handle, OPEN_STORM_CTRL_MODE_t stormCtrlMode, uint32_t interface, OPEN_RATE_UNIT_t rateUnit, uint32_t *threshold)
	Get the storm control threshold on an interface.

open_error_t	openapiStormControlIntfThresholdSet (openapiClientHandle_t *client_handle, OPEN_STORM_CTRL_MODE_t stormCtrlMode, uint32_t interface, OPEN_RATE_UNIT_t rateUnit, uint32_t threshold)
	Set the storm control mode and threshold on an interface.

open_error_t	openapiStormControlModeGet (openapiClientHandle_t client_handle, OPEN_STORM_CTRL_MODE_t stormCtrlMode, OPEN_CONTROL_t state)
	Get the state of global storm control mode.

open_error_t	openapiStormControlModeSet (openapiClientHandle_t *client_handle, OPEN_STORM_CTRL_MODE_t stormCtrlMode, OPEN_CONTROL_t state)
	Set the state of storm control mode globally and on all the interfaces.

open_error_t	openapiStormControlThresholdDefaultSet (openapiClientHandle_t *client_handle, OPEN_STORM_CTRL_MODE_t stormCtrlMode)
	Set the storm control threshold and rate unit on all the interfaces to default values.

open_error_t	openapiStormControlThresholdGet (openapiClientHandle_t client_handle, OPEN_STORM_CTRL_MODE_t stormCtrlMode, OPEN_RATE_UNIT_t rateUnit, uint32_t *threshold)
	Get the global storm control threshold value and rate unit.

open_error_t	openapiStormControlThresholdMinMaxGet (openapiClientHandle_t client_handle, OPEN_RATE_UNIT_t rateUnit, uint32_t minThreshold, uint32_t *maxThreshold)
	Get the storm control minimum and maximum threshold values based on the rate.

open_error_t	openapiStormControlThresholdSet (openapiClientHandle_t *client_handle, OPEN_STORM_CTRL_MODE_t stormCtrlMode, OPEN_RATE_UNIT_t rateUnit, uint32_t threshold)
	Set the storm control threshold and rate unit on all the interfaces.

Detailed Description

Enumeration Type Documentation

enum OPEN_POLICY_PORT_ACTION_t

OpEN uses this enumeration to define Storm Control actions.

Enumerator:

OPEN_POLICY_PORT_ACTION_SHUTDOWN	shutdown port if storm
OPEN_POLICY_PORT_ACTION_RATELIMIT	rate limit port if storm
OPEN_POLICY_PORT_ACTION_TRAP	trap if storm

Definition at line 53 of file openapi_storm_control.h.

enum OPEN_STORM_CTRL_MODE_t

OpEN uses this enumeration to define Storm Control modes.

Enumerator:

OPEN_STORM_CTRL_MODE_NONE	Storm Control mode none.
OPEN_STORM_CTRL_MODE_UNICAST	Storm Control unicast mode.
OPEN_STORM_CTRL_MODE_BROADCAST	Storm Control broadcast mode.
OPEN_STORM_CTRL_MODE_MULTICAST	Storm Control multicast mode.

Definition at line 44 of file openapi_storm_control.h.

Function Documentation

open_error_t openapiStormControlActionGet	(	openapiClientHandle_t *	client_handle,
		OPEN_STORM_CTRL_MODE_t	stormCtrlMode,
		OPEN_POLICY_PORT_ACTION_t *	action
	)

Get the global storm control action.

Parameters

[in]	client_handle	Client handle from registration API
[in]	stormCtrlMode	Storm control mode: OPEN_STORM_CTRL_MODE_t
[out]	action	Storm control action: OPEN_POLICY_PORT_ACTION_t

Return values

OPEN_E_NONE	if storm control action is returned successfully.
OPEN_E_UNAVAIL	if the feature is unsupported.
OPEN_E_PARAM	error in parameter passed.

OpEN API Version: 1.11

Examples:: storm_control_example.c.

open_error_t openapiStormControlActionSet	(	openapiClientHandle_t *	client_handle,
		OPEN_STORM_CTRL_MODE_t	stormCtrlMode,
		OPEN_POLICY_PORT_ACTION_t	action
	)

Set the storm control action globally and on all the interfaces.

Parameters

[in]	client_handle	Client handle from registration API
[in]	stormCtrlMode	Storm control mode: OPEN_STORM_CTRL_MODE_t
[in]	action	Storm control action: OPEN_POLICY_PORT_ACTION_t

Return values

OPEN_E_NONE	if storm control action is set.
OPEN_E_FAIL	if failed to set storm control action.
OPEN_E_UNAVAIL	if the feature is unsupported.
OPEN_E_PARAM	error in parameter passed.

Note: Calling this API will change the running configuration of the switch.

OpEN API Version: 1.11

Examples:: storm_control_example.c.

open_error_t openapiStormControlIntfModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_STORM_CTRL_MODE_t	stormCtrlMode,
		uint32_t	interface,
		OPEN_CONTROL_t *	state
	)

Get the state of storm control mode on an interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	stormCtrlMode	Storm control mode: broadcast/multicast/unicast
[in]	interface	Interface ID
[out]	state	Storm-control mode state: enable/disable

Return values

OPEN_E_NONE	if the state of storm control mode is returned on an interface.
OPEN_E_FAIL	if the interface is not a physical interface or if failed to set storm control mode.
OPEN_E_PARAM	error in parameter passed.

OpEN API Version: 1.1

Examples:: storm_control_example.c.

open_error_t openapiStormControlIntfModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_STORM_CTRL_MODE_t	stormCtrlMode,
		uint32_t	interface,
		OPEN_CONTROL_t	state
	)

Set the state of storm control mode on an interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	stormCtrlMode	Storm control mode: broadcast/multicast/unicast
[in]	interface	Interface ID
[in]	state	Storm control mode state: enable/disable

Return values

OPEN_E_NONE	if state of storm control mode is set on an interface.
OPEN_E_FAIL	if failed to set state of storm control mode on an interface.
OPEN_E_UNAVAIL	if the feature is unsupported.
OPEN_E_PARAM	error in parameter passed.

Note: Calling this API will change the running configuration of the switch.

OpEN API Version: 1.1

Examples:: storm_control_example.c.

open_error_t openapiStormControlIntfThresholdDefaultSet	(	openapiClientHandle_t *	client_handle,
		OPEN_STORM_CTRL_MODE_t	stormCtrlMode,
		uint32_t	interface
	)

Set the storm control threshold value and rate unit to default on an interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	stormCtrlMode	Storm control mode: broadcast/multicast/unicast
[in]	interface	Interface ID.

Return values

OPEN_E_NONE	if threshold value and rate unit are set on an interface.
OPEN_E_FAIL	if the interface is not a physical interface or if failed to set the threshold value and rate unit.
OPEN_E_PARAM	error in parameter passed.

Note: Calling this API will change the running configuration of the switch.; This API also sets storm control mode to default on an interface.; For storm control to be operational, it must also enabled globally.

OpEN API Version: 1.1

Examples:: storm_control_example.c.

open_error_t openapiStormControlIntfThresholdGet	(	openapiClientHandle_t *	client_handle,
		OPEN_STORM_CTRL_MODE_t	stormCtrlMode,
		uint32_t	interface,
		OPEN_RATE_UNIT_t *	rateUnit,
		uint32_t *	threshold
	)

Get the storm control threshold on an interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	stormCtrlMode	Storm control mode: broadcast/multicast/unicast
[in]	interface	Interface ID
[out]	rateUnit	Threshold unit - pps/percent
[out]	threshold	Threshold value

Return values

OPEN_E_NONE	if storm control threshold and rate unit of an interface is returned.
OPEN_E_FAIL	if the interface is not a physical interface or if failed to get storm control threshold and rate unit.
OPEN_E_PARAM	error in parameter passed.

OpEN API Version: 1.1

Examples:: storm_control_example.c.

open_error_t openapiStormControlIntfThresholdSet	(	openapiClientHandle_t *	client_handle,
		OPEN_STORM_CTRL_MODE_t	stormCtrlMode,
		uint32_t	interface,
		OPEN_RATE_UNIT_t	rateUnit,
		uint32_t	threshold
	)

Set the storm control mode and threshold on an interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	stormCtrlMode	Storm control mode: OPEN_STORM_CTRL_MODE_t
[in]	interface	Interface ID.
[in]	rateUnit	Threshold unit: OPEN_RATE_UNIT_t
[in]	threshold	Threshold value: openapiStormControlThresholdMinMaxGet()

Return values

OPEN_E_NONE	if threshold value and rate unit are applied.
OPEN_E_FAIL	if the interface is not a physical interface or if failed to set storm control mode or if failed to set the threshold value and rate unit.
OPEN_E_UNAVAIL	if the feature is unsupported.
OPEN_E_PARAM	error in parameter passed.

Note: Calling this API will change the running configuration of the switch.; This API also sets storm control mode to non-default state on the interface.; For storm control to be operational it must also enabled globally.; The minimum and maximum threshold ranges can be determined via openapiStormControlThresholdMinMaxGet().

OpEN API Version: 1.1

Examples:: storm_control_example.c.

open_error_t openapiStormControlModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_STORM_CTRL_MODE_t	stormCtrlMode,
		OPEN_CONTROL_t *	state
	)

Get the state of global storm control mode.

Parameters

[in]	client_handle	Client handle from registration API
[in]	stormCtrlMode	Storm control mode: OPEN_STORM_CTRL_MODE_t
[out]	state	Storm control mode state

Return values

OPEN_E_NONE	if storm control mode state is returned successfully.
OPEN_E_UNAVAIL	if the feature is unsupported.
OPEN_E_PARAM	error in parameter passed.

OpEN API Version: 1.1

Examples:: storm_control_example.c.

open_error_t openapiStormControlModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_STORM_CTRL_MODE_t	stormCtrlMode,
		OPEN_CONTROL_t	state
	)

Set the state of storm control mode globally and on all the interfaces.

Parameters

[in]	client_handle	Client handle from registration API
[in]	stormCtrlMode	Storm control mode: OPEN_STORM_CTRL_MODE_t
[in]	state	Storm control mode state

Return values

OPEN_E_NONE	if storm control mode state is set.
OPEN_E_FAIL	if failed to set storm control mode state.
OPEN_E_UNAVAIL	if the feature is unsupported.
OPEN_E_PARAM	error in parameter passed.

Note: Calling this API will change the running configuration of the switch.; This API enables storm control mode globally and sets the default threshold value and rate unit on all interfaces.

OpEN API Version: 1.1

Examples:: storm_control_example.c.

open_error_t openapiStormControlThresholdDefaultSet	(	openapiClientHandle_t *	client_handle,
		OPEN_STORM_CTRL_MODE_t	stormCtrlMode
	)

Set the storm control threshold and rate unit on all the interfaces to default values.

Parameters

[in]	client_handle	Client handle from registration API
[in]	stormCtrlMode	Storm control mode: broadcast/multicast/unicast

Return values

OPEN_E_NONE	if storm control threshold rate unit and threshold are set to default values.
OPEN_E_FAIL	if failed to set the values to default.
OPEN_E_UNAVAIL	if the feature is unsupported.
OPEN_E_PARAM	error in parameter passed.

Note: Calling this API will change the running configuration of the switch.

OpEN API Version: 1.1

Examples:: storm_control_example.c.

open_error_t openapiStormControlThresholdGet	(	openapiClientHandle_t *	client_handle,
		OPEN_STORM_CTRL_MODE_t	stormCtrlMode,
		OPEN_RATE_UNIT_t *	rateUnit,
		uint32_t *	threshold
	)

Get the global storm control threshold value and rate unit.

Parameters

[in]	client_handle	Client handle from registration API
[in]	stormCtrlMode	Storm control mode: broadcast/multicast/unicast
[out]	rateUnit	Threshold unit - pps/percentage
[out]	threshold	Threshold value

Return values

OPEN_E_NONE	if the storm control threshold is returned.
OPEN_E_UNAVAIL	if the feature is unsupported.
OPEN_E_PARAM	error in parameter passed.

OpEN API Version: 1.1

Examples:: storm_control_example.c.

open_error_t openapiStormControlThresholdMinMaxGet	(	openapiClientHandle_t *	client_handle,
		OPEN_RATE_UNIT_t	rateUnit,
		uint32_t *	minThreshold,
		uint32_t *	maxThreshold
	)

Get the storm control minimum and maximum threshold values based on the rate.

Parameters

[in]	client_handle	Client handle from registration API
[in]	rateUnit	Threshold unit: OPEN_RATE_UNIT_t
[out]	minThreshold	Minimum threshold
[out]	maxThreshold	Maximum threshold

Return values

OPEN_E_NONE	if storm control threshold values are returned.
OPEN_E_FAIL	if failed to get storm control thresholds.
OPEN_E_PARAM	error in parameter passed.

OpEN API Version: 1.1

Examples:: storm_control_example.c.

open_error_t openapiStormControlThresholdSet	(	openapiClientHandle_t *	client_handle,
		OPEN_STORM_CTRL_MODE_t	stormCtrlMode,
		OPEN_RATE_UNIT_t	rateUnit,
		uint32_t	threshold
	)

Set the storm control threshold and rate unit on all the interfaces.

Parameters

[in]	client_handle	Client handle from registration API
[in]	stormCtrlMode	Storm control mode: OPEN_STORM_CTRL_MODE_t
[in]	rateUnit	Threshold unit: OPEN_RATE_UNIT_t
[in]	threshold	Threshold value: openapiStormControlThresholdMinMaxGet()

Return values

OPEN_E_NONE	if storm control mode is applied.
OPEN_E_FAIL	if failed to apply storm control mode.
OPEN_E_UNAVAIL	if the feature is unsupported.
OPEN_E_PARAM	error in parameter passed.

Note: Calling this API will change the running configuration of the switch.; This API also enables storm control mode globally.; The minimum and maximum threshold ranges can be determined via openapiStormControlThresholdMinMaxGet().

OpEN API Version: 1.1

Examples:: storm_control_example.c.

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

Function Documentation