Macros
#define	OPEN_GARP_DEF_JOIN_TIME 20 /* centiseconds */

#define	OPEN_GARP_DEF_LEAVE_ALL_TIME 1000 /* centiseconds */

#define	OPEN_GARP_DEF_LEAVE_TIME 60 /* centiseconds */

#define	OPEN_GARP_MAX_JOIN_TIME 100 /* centiseconds */

#define	OPEN_GARP_MAX_LEAVE_ALL_TIME 6000 /* centiseconds */

#define	OPEN_GARP_MAX_LEAVE_TIME 600 /* centiseconds */

#define	OPEN_GARP_MIN_JOIN_TIME 10 /* centiseconds */

#define	OPEN_GARP_MIN_LEAVE_ALL_TIME 200 /* centiseconds */

#define	OPEN_GARP_MIN_LEAVE_TIME 20 /* centiseconds */

Functions
open_error_t	openapiGarpGmrpEnableGet (openapiClientHandle_t client_handle, OPEN_CONTROL_t globalGmrpStatus)
	Get the GMRP global status. More...

open_error_t	openapiGarpGmrpEnableSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t globalGmrpStatus)
	Set the GMRP global status. More...

open_error_t	openapiGarpGmrpFailedRegistrationsGet (openapiClientHandle_t client_handle, uint32_t ifNum, uint32_t gmrpFailedRegistrations)
	Get the number of failed GMRP registrations of the interface. More...

open_error_t	openapiGarpGmrpPortEnableGet (openapiClientHandle_t client_handle, uint32_t ifNum, OPEN_CONTROL_t intfGmrpStatus)
	Get the GMRP interface status. More...

open_error_t	openapiGarpGmrpPortEnableSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t intfGmrpStatus)
	Set the GMRP interface status. More...

open_error_t	openapiGarpGmrpReceivePDUCountGet (openapiClientHandle_t client_handle, uint32_t ifNum, uint32_t gmrpPduRxCount)
	Get the number of GMRP PDUs received on an interface. More...

open_error_t	openapiGarpGmrpTransmitPDUCountGet (openapiClientHandle_t client_handle, uint32_t ifNum, uint32_t gmrpPduTxCount)
	Get the number of GMRP PDUs transmitted from an interface. More...

open_error_t	openapiGarpGvrpEnableGet (openapiClientHandle_t client_handle, OPEN_CONTROL_t globalGvrpStatus)
	Get the GVRP global status. More...

open_error_t	openapiGarpGvrpEnableSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t globalGvrpStatus)
	Set the GVRP global status. More...

open_error_t	openapiGarpGvrpFailedRegistrationsGet (openapiClientHandle_t client_handle, uint32_t ifNum, uint32_t gvrpFailedRegistrations)
	Get the number of failed GVRP registrations of the interface. More...

open_error_t	openapiGarpGvrpPortEnableGet (openapiClientHandle_t client_handle, uint32_t ifNum, OPEN_CONTROL_t intfGvrpStatus)
	Get the GVRP interface status. More...

open_error_t	openapiGarpGvrpPortEnableSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t intfGvrpStatus)
	Set the GVRP interface status. More...

open_error_t	openapiGarpGvrpReceivePDUCountGet (openapiClientHandle_t client_handle, uint32_t ifNum, uint32_t gvrpPduRxCount)
	Get the number of GVRP PDUs received on an interface. More...

open_error_t	openapiGarpGvrpTransmitPDUCountGet (openapiClientHandle_t client_handle, uint32_t ifNum, uint32_t gvrpPduTxCount)
	Get the number of GVRP PDUs transmitted from an interface. More...

open_error_t	openapiGarpJoinTimeGet (openapiClientHandle_t client_handle, uint32_t ifNum, uint32_t joinTime)
	Get the GARP Join Time. More...

open_error_t	openapiGarpJoinTimeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t joinTime)
	Set the GARP Join Time. More...

open_error_t	openapiGarpLeaveAllTimeGet (openapiClientHandle_t client_handle, uint32_t ifNum, uint32_t leaveAllTime)
	Get the GARP Leave All Time. More...

open_error_t	openapiGarpLeaveAllTimeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t leaveAllTime)
	Set the GARP Leave All Time. More...

open_error_t	openapiGarpLeaveTimeGet (openapiClientHandle_t client_handle, uint32_t ifNum, uint32_t leaveTime)
	Get the GARP Leave Time. More...

open_error_t	openapiGarpLeaveTimeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t leaveTime)
	Set the GARP Leave Time. More...

Detailed Description

Function Documentation

open_error_t openapiGarpGmrpEnableGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	globalGmrpStatus
	)

Get the GMRP global status.

Parameters

[in]	client_handle	client handle from registration API
[out]	globalGmrpStatus	GMRP global 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:: garp_example.c.

open_error_t openapiGarpGmrpEnableSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	globalGmrpStatus
	)

Set the GMRP global status.

Parameters

[in]	client_handle	client handle from registration API
[in]	globalGmrpStatus	GMRP global status.

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:: garp_example.c.

open_error_t openapiGarpGmrpFailedRegistrationsGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	gmrpFailedRegistrations
	)

Get the number of failed GMRP registrations of the interface.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	ifNum	Internal interface number.
[out]	gmrpFailedRegistrations	Number of failed GMRP registrations.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_NOT_FOUND	If this Counter is not supported.
OPEN_E_UNAVAIL	Feature not available.

OpEN API Version: 1.26

Examples:: garp_example.c.

open_error_t openapiGarpGmrpPortEnableGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t *	intfGmrpStatus
	)

Get the GMRP interface status.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[out]	intfGmrpStatus	GMRP interface 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:: garp_example.c.

open_error_t openapiGarpGmrpPortEnableSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t	intfGmrpStatus
	)

Set the GMRP interface status.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	intfGmrpStatus	GVRP interface status.

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:: garp_example.c.

open_error_t openapiGarpGmrpReceivePDUCountGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	gmrpPduRxCount
	)

Get the number of GMRP PDUs received on an interface.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	ifNum	Internal interface number.
[out]	gmrpPduRxCount	Number GMRP PDUs received.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_NOT_FOUND	If this Counter is not supported.
OPEN_E_UNAVAIL	Feature not available.

OpEN API Version: 1.26

Examples:: garp_example.c.

open_error_t openapiGarpGmrpTransmitPDUCountGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	gmrpPduTxCount
	)

Get the number of GMRP PDUs transmitted from an interface.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	ifNum	Internal interface number.
[out]	gmrpPduTxCount	Number GMRP PDUs transmitted.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_NOT_FOUND	If this Counter is not supported.
OPEN_E_UNAVAIL	Feature not available.

OpEN API Version: 1.26

Examples:: garp_example.c.

open_error_t openapiGarpGvrpEnableGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	globalGvrpStatus
	)

Get the GVRP global status.

Parameters

[in]	client_handle	client handle from registration API
[out]	globalGvrpStatus	GVRP global 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:: garp_example.c.

open_error_t openapiGarpGvrpEnableSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	globalGvrpStatus
	)

Set the GVRP global status.

Parameters

[in]	client_handle	client handle from registration API
[in]	globalGvrpStatus	GVRP global status.

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:: garp_example.c.

open_error_t openapiGarpGvrpFailedRegistrationsGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	gvrpFailedRegistrations
	)

Get the number of failed GVRP registrations of the interface.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	ifNum	Internal interface number.
[out]	gvrpFailedRegistrations	Number of failed GVRP registrations.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_NOT_FOUND	If this Counter is not supported.
OPEN_E_UNAVAIL	Feature not available.

OpEN API Version: 1.26

Examples:: garp_example.c.

open_error_t openapiGarpGvrpPortEnableGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t *	intfGvrpStatus
	)

Get the GVRP interface status.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[out]	intfGvrpStatus	GVRP interface 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:: garp_example.c.

open_error_t openapiGarpGvrpPortEnableSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t	intfGvrpStatus
	)

Set the GVRP interface status.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	intfGvrpStatus	GVRP interface status.

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:: garp_example.c.

open_error_t openapiGarpGvrpReceivePDUCountGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	gvrpPduRxCount
	)

Get the number of GVRP PDUs received on an interface.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	ifNum	Internal interface number.
[out]	gvrpPduRxCount	Number GVRP PDUs received.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_NOT_FOUND	If this Counter is not supported.
OPEN_E_UNAVAIL	Feature not available.

OpEN API Version: 1.26

Examples:: garp_example.c.

open_error_t openapiGarpGvrpTransmitPDUCountGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	gvrpPduTxCount
	)

Get the number of GVRP PDUs transmitted from an interface.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	ifNum	Internal interface number.
[out]	gvrpPduTxCount	Number GVRP PDUs transmitted.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_NOT_FOUND	If this Counter is not supported.
OPEN_E_UNAVAIL	Feature not available.

OpEN API Version: 1.26

Examples:: garp_example.c.

open_error_t openapiGarpJoinTimeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	joinTime
	)

Get the GARP Join Time.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[out]	joinTime	GARP join time in centiseconds.

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:: garp_example.c.

open_error_t openapiGarpJoinTimeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t	joinTime
	)

Set the GARP Join Time.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	joinTime	GARP join time in centiseconds.

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; Refer OPEN_GARP_MIN_JOIN_TIME and OPEN_GARP_MAX_JOIN_TIME for minimum and maximum values.

OpEN API Version: 1.25

Examples:: garp_example.c.

open_error_t openapiGarpLeaveAllTimeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	leaveAllTime
	)

Get the GARP Leave All Time.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[out]	leaveAllTime	GARP leave All time in centiseconds.

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:: garp_example.c.

open_error_t openapiGarpLeaveAllTimeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t	leaveAllTime
	)

Set the GARP Leave All Time.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	leaveAllTime	GARP leave All time in centiseconds.

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; Refer OPEN_GARP_MIN_LEAVE_ALL_TIME and OPEN_GARP_MAX_LEAVE_ALL_TIME for minimum and maximum values.

OpEN API Version: 1.25

Examples:: garp_example.c.

open_error_t openapiGarpLeaveTimeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	leaveTime
	)

Get the GARP Leave Time.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[out]	leaveTime	GARP leave time in centiseconds.

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:: garp_example.c.

open_error_t openapiGarpLeaveTimeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t	leaveTime
	)

Set the GARP Leave Time.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	leaveTime	GARP leave time in centiseconds.

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; Refer OPEN_GARP_MIN_LEAVE_TIME and OPEN_GARP_MAX_LEAVE_TIME for minimum and maximum values.

OpEN API Version: 1.25

Examples:: garp_example.c.

Macros

Functions

Detailed Description

Function Documentation