This Code Implements The OpEN LoopProtect API [OPENAPI_LOOP_PROTECT]

Enumerations
enum	OPEN_LOOP_PROTECT_PORT_ACTION_t { OPEN_LOOP_PROTECT_ACTION_LOGMSG = 0, OPEN_LOOP_PROTECT_ACTION_SHUTDOWN, OPEN_LOOP_PROTECT_ACTION_LOGMSG_SHUTDOWN }

Functions
open_error_t	openapiLoopProtectAdminModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *adminMode)
	Gets the LoopProtection global mode. More...
open_error_t	openapiLoopProtectAdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t adminMode)
	Sets the LoopProtection global mode. More...
open_error_t	openapiLoopProtectAllStatsClear (openapiClientHandle_t *client_handle)
	Clears the statistics for all interfaces. More...
open_error_t	openapiLoopProtectDisableTimerGet (openapiClientHandle_t *client_handle, uint32_t *val)
	Gets the disable duration for the port. More...
open_error_t	openapiLoopProtectDisableTimerSet (openapiClientHandle_t *client_handle, uint32_t val)
	Sets the disable duration for the port. More...
open_error_t	openapiLoopProtectIsLoopDetected (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *status)
	Gets the status of loop on the specified interface. More...
open_error_t	openapiLoopProtectIsPortDisabled (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *status)
	Gets the port status. More...
open_error_t	openapiLoopProtectIsValidIntf (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *status)
	Gets the status of an interface whether port is valid for configuration for loop protection. More...
open_error_t	openapiLoopProtectMaxPduReceiveGet (openapiClientHandle_t *client_handle, uint32_t *val)
	Gets the maximum number of PDU's to be received on a port before action is taken. More...
open_error_t	openapiLoopProtectMaxPduReceiveSet (openapiClientHandle_t *client_handle, uint32_t val)
	Sets the maximum number of PDU's to be received on a port before action is taken. More...
open_error_t	openapiLoopProtectPortActionGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_LOOP_PROTECT_PORT_ACTION_t *mode)
	Gets the port action for the the specified interface. More...
open_error_t	openapiLoopProtectPortActionSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_LOOP_PROTECT_PORT_ACTION_t mode)
	Sets the port action for the the specified interface. More...
open_error_t	openapiLoopProtectPortAdminModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode)
	Gets the loop protection admin mode for the interface. More...
open_error_t	openapiLoopProtectPortAdminModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t mode)
	Sets the loop protection admin mode for the interface. More...
open_error_t	openapiLoopProtectPortloopDetectCountGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *loopCount)
	Gets the loop Count for the specified interface. More...
open_error_t	openapiLoopProtectPortPacketRxCountGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *count)
	Gets the receive loop count for the specified interface. More...
open_error_t	openapiLoopProtectPortPacketTxCountGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *count)
	Gets the transmit loop count for the specified interface. More...
open_error_t	openapiLoopProtectPortStatsClear (openapiClientHandle_t *client_handle, uint32_t ifNum)
	Clears statistics of the specified interface. More...
open_error_t	openapiLoopProtectPortTimeSinceLastLoopGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *timeVal, OPEN_BOOL_t needUtc)
	Gets the time since last loop occured for the specified interface. More...
open_error_t	openapiLoopProtectPortTxModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode)
	Gets the transmission timer Mode for the LoopProtection PDU's. More...
open_error_t	openapiLoopProtectPortTxModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t mode)
	Sets the transmission mode for the LoopProtection PDU's. More...
open_error_t	openapiLoopProtectPortVlanPropertiesGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *tpid, uint32_t *vlanId)
	Gets the VLAN ID and the TPID used for detecting a loop on the specified interface. More...
open_error_t	openapiLoopProtectPortVlanPropertiesSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t tpid, uint32_t vlanId)
	Sets the VLAN ID and the TPID to be used for detecting a loop on the specified interface. More...
open_error_t	openapiLoopProtectTxTimerGet (openapiClientHandle_t *client_handle, uint32_t *timerVal)
	Gets the transmission timer for the LoopProtection PDU's. More...
open_error_t	openapiLoopProtectTxTimerSet (openapiClientHandle_t *client_handle, uint32_t timerVal)
	Sets the transmission timer for the LoopProtection PDU's. More...
open_error_t	openapiLoopProtectValidIntfFirstGet (openapiClientHandle_t *client_handle, uint32_t *ifNum)
	Gets the first interface that is valid for loop protection. More...
open_error_t	openapiLoopProtectValidIntfNextGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *nextIfNum)
	Gets the next interface that is valid for loop protection. More...

Detailed Description

Function Documentation

open_error_t openapiLoopProtectAdminModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	adminMode
	)

Gets the LoopProtection global mode.

Parameters

[in]	client_handle	Client handle from registration API
[out]	adminMode	LoopProtection global 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:

loop_protect_example.c.

open_error_t openapiLoopProtectAdminModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	adminMode
	)

Sets the LoopProtection global mode.

Parameters

[in]	client_handle	Client handle from registration API
[in]	adminMode	LoopProtection global 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:

loop_protect_example.c.

open_error_t openapiLoopProtectAllStatsClear

(

openapiClientHandle_t *

client_handle

)

Clears the statistics for all interfaces.

Parameters

[in]

client_handle

Client handle from registration API

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:

loop_protect_example.c.

open_error_t openapiLoopProtectDisableTimerGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	val
	)

Gets the disable duration for the port.

Parameters

[in]	client_handle	Client handle from registration API
[out]	val	Disable duration in seconds

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:

loop_protect_example.c.

open_error_t openapiLoopProtectDisableTimerSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	val
	)

Sets the disable duration for the port.

Parameters

[in]	client_handle	Client handle from registration API
[in]	val	Disable duration in seconds

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:

loop_protect_example.c.

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

Gets the status of loop on the specified interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Interface number
[out]	status	Loop status

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:

loop_protect_example.c.

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

Gets the port status.

whether port is in D-Disable state due to loop protection.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Interface number
[out]	status	Port status

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:

loop_protect_example.c.

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

Gets the status of an interface whether port is valid for configuration for loop protection.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Interface number
[out]	status	Port status

Return values

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

OpEN API Version: 1.25

Examples:

loop_protect_example.c.

open_error_t openapiLoopProtectMaxPduReceiveGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	val
	)

Gets the maximum number of PDU's to be received on a port before action is taken.

Parameters

[in]	client_handle	Client handle from registration API
[out]	val	Maximum number of PDU's

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:

loop_protect_example.c.

open_error_t openapiLoopProtectMaxPduReceiveSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	val
	)

Sets the maximum number of PDU's to be received on a port before action is taken.

Parameters

[in]	client_handle	Client handle from registration API
[in]	val	Maximum number of PDU's

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:

loop_protect_example.c.

open_error_t openapiLoopProtectPortActionGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_LOOP_PROTECT_PORT_ACTION_t *	mode
	)

Gets the port action for the the specified interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Interface number
[out]	mode	Port action configured on the port

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:

loop_protect_example.c.

open_error_t openapiLoopProtectPortActionSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_LOOP_PROTECT_PORT_ACTION_t	mode
	)

Sets the port action for the the specified interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Interface number
[in]	mode	Port action to be configured on the port

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:

loop_protect_example.c.

open_error_t openapiLoopProtectPortAdminModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t *	mode
	)

Gets the loop protection admin mode for the interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Interface number
[out]	mode	Interface 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:

loop_protect_example.c.

open_error_t openapiLoopProtectPortAdminModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t	mode
	)

Sets the loop protection admin mode for the interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Interface number
[in]	mode	Interface 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:

loop_protect_example.c.

open_error_t openapiLoopProtectPortloopDetectCountGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	loopCount
	)

Gets the loop Count for the specified interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Interface number
[out]	loopCount	Loop count value

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:

loop_protect_example.c.

open_error_t openapiLoopProtectPortPacketRxCountGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	count
	)

Gets the receive loop count for the specified interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Interface number
[out]	count	Receive loop count

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:

loop_protect_example.c.

open_error_t openapiLoopProtectPortPacketTxCountGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	count
	)

Gets the transmit loop count for the specified interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Interface number
[out]	count	Transmit loop count

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:

loop_protect_example.c.

open_error_t openapiLoopProtectPortStatsClear	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum
	)

Clears statistics of the specified interface.

Parameters

[in]	client_handle	Client handle from registration API
[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

OpEN API Version: 1.25

Examples:

loop_protect_example.c.

open_error_t openapiLoopProtectPortTimeSinceLastLoopGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	timeVal,
		OPEN_BOOL_t	needUtc
	)

Gets the time since last loop occured for the specified interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Interface number
[out]	timeVal	Time value
[in]	needUtc	Flag L7_TRUE for UTC time and L7_FALSE for raw time

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:

loop_protect_example.c.

open_error_t openapiLoopProtectPortTxModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t *	mode
	)

Gets the transmission timer Mode for the LoopProtection PDU's.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Interface number
[out]	mode	Transmit 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:

loop_protect_example.c.

open_error_t openapiLoopProtectPortTxModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t	mode
	)

Sets the transmission mode for the LoopProtection PDU's.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Interface number
[in]	mode	Transmit 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:

loop_protect_example.c.

open_error_t openapiLoopProtectPortVlanPropertiesGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	tpid,
		uint32_t *	vlanId
	)

Gets the VLAN ID and the TPID used for detecting a loop on the specified interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Interface number
[out]	tpid	TPID value
[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:

loop_protect_example.c.

open_error_t openapiLoopProtectPortVlanPropertiesSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t	tpid,
		uint32_t	vlanId
	)

Sets the VLAN ID and the TPID to be used for detecting a loop on the specified interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Interface number
[in]	tpid	TPID value
[in]	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

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

loop_protect_example.c.

open_error_t openapiLoopProtectTxTimerGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	timerVal
	)

Gets the transmission timer for the LoopProtection PDU's.

Parameters

[in]	client_handle	Client handle from registration API
[out]	timerVal	Timer value

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:

loop_protect_example.c.

open_error_t openapiLoopProtectTxTimerSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	timerVal
	)

Sets the transmission timer for the LoopProtection PDU's.

Parameters

[in]	client_handle	Client handle from registration API
[in]	timerVal	Timer value

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:

loop_protect_example.c.

open_error_t openapiLoopProtectValidIntfFirstGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	ifNum
	)

Gets the first interface that is valid for loop protection.

Parameters

[in]	client_handle	Client handle from registration API
[out]	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

OpEN API Version: 1.25

Examples:

loop_protect_example.c.

open_error_t openapiLoopProtectValidIntfNextGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	nextIfNum
	)

Gets the next interface that is valid for loop protection.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Interface number
[out]	nextIfNum	Next valid 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

OpEN API Version: 1.25

Examples:

loop_protect_example.c.