Voice VLAN Configuration And Status [OPENAPI_VOICE_VLAN]

Macros
#define	OPEN_VOICE_VLAN_DOT1P_MAX   7
	Maximum value for DOT1P.
#define	OPEN_VOICE_VLAN_DOT1P_MIN   0
	Minimum value for DOT1P.
#define	OPEN_VOICE_VLAN_DSCP_MAX   64
	Maximum value for DSCP.
#define	OPEN_VOICE_VLAN_DSCP_MIN   0
	Minimum value for DSCP.

Enumerations
enum	OPEN_VOICE_VLAN_CONFIG_TYPE_t {   OPEN_VOICE_VLAN_CONFIG_DISABLE = 0, OPEN_VOICE_VLAN_CONFIG_VLAN_ID = 1, OPEN_VOICE_VLAN_CONFIG_DOT1P = 2, OPEN_VOICE_VLAN_CONFIG_NONE = 3,   OPEN_VOICE_VLAN_CONFIG_UNTAGGED = 4 }

Functions
open_error_t	openapiVoiceVlanAdminModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode)
	Gets Voice VLAN global administrative mode. More...
open_error_t	openapiVoiceVlanAdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets Voice VLAN global administrative mode. More...
open_error_t	openapiVoiceVlanPortAdminModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_VOICE_VLAN_CONFIG_TYPE_t *mode)
	Get the Voice VLAN interface mode. More...
open_error_t	openapiVoiceVlanPortAdminModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_VOICE_VLAN_CONFIG_TYPE_t mode, uint32_t dataValue)
	Set the Voice VLAN interface mode. More...
open_error_t	openapiVoiceVlanPortAuthStateGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *state)
	Get voice vlan Auth State. More...
open_error_t	openapiVoiceVlanPortAuthStateSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t state)
	Set voice vlan Auth State. More...
open_error_t	openapiVoiceVlanPortCosOverrideModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode)
	Get the value of the cos override mode. More...
open_error_t	openapiVoiceVlanPortCosOverrideModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t mode)
	Set the value of the cos override mode. More...
open_error_t	openapiVoiceVlanPortDot1pPriorityGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *priority)
	Get the Voice VLAN port DOT1P priority. More...
open_error_t	openapiVoiceVlanPortDot1pPrioritySet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t dot1pPriority)
	Set the value of the dot1p. More...
open_error_t	openapiVoiceVlanPortDscpGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *dscp)
	Get the value of the dscp. More...
open_error_t	openapiVoiceVlanPortDscpSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t dscp)
	Set the value of the dscp. More...
open_error_t	openapiVoiceVlanPortStatusGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode)
	Get the value voice vlan status. More...
open_error_t	openapiVoiceVlanPortVlanIdGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *vlanId)
	Get the Voice VLAN port VLAN ID. More...
open_error_t	openapiVoiceVlanPortVlanIdSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t vlanId)
	Set the value of the vlan ID. More...

Detailed Description

Enumeration Type Documentation

enum OPEN_VOICE_VLAN_CONFIG_TYPE_t

Enumerator
OPEN_VOICE_VLAN_CONFIG_DISABLE	voice VLAN disabled, no data needed to configure
OPEN_VOICE_VLAN_CONFIG_VLAN_ID	tag with specified VLAN ID, VLAN ID specified when configured
OPEN_VOICE_VLAN_CONFIG_DOT1P	use 802.1p priority tagging, priority data specified when configured
OPEN_VOICE_VLAN_CONFIG_NONE	allow device to use its own configuration, no data needed to configure
OPEN_VOICE_VLAN_CONFIG_UNTAGGED	send untagged packets, no data needed to configure

Definition at line 43 of file openapi_voice_vlan.h.

Function Documentation

open_error_t openapiVoiceVlanAdminModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	mode
	)

Gets Voice VLAN global administrative mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	mode	administrative mode

Return values

OPEN_E_NONE	Administrative mode get successful.
OPEN_E_FAIL	Administrative mode get failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.14

open_error_t openapiVoiceVlanAdminModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets Voice VLAN global administrative mode.

Parameters

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

Return values

OPEN_E_NONE	Administrative mode set successful.
OPEN_E_FAIL	Administrative mode set failed.
OPEN_E_PARAM	Error in parameter passed.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.14

open_error_t openapiVoiceVlanPortAdminModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_VOICE_VLAN_CONFIG_TYPE_t *	mode
	)

Get the Voice VLAN interface mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID
[out]	mode	mode

Return values

OPEN_E_NONE	Success
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.14

open_error_t openapiVoiceVlanPortAdminModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_VOICE_VLAN_CONFIG_TYPE_t	mode,
		uint32_t	dataValue
	)

Set the Voice VLAN interface mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID
[in]	mode	mode
[in]	dataValue	Certain modes are configured with data. See comments for OPEN_VOICE_VLAN_CONFIG_TYPE_t for information about which modes require data.

Return values

OPEN_E_NONE	Success
OPEN_E_FAIL	Failure
OPEN_E_PARAM	Error in parameter passed.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.14

open_error_t openapiVoiceVlanPortAuthStateGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t *	state
	)

Get voice vlan Auth State.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[out]	state	Auth state

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

open_error_t openapiVoiceVlanPortAuthStateSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t	state
	)

Set voice vlan Auth State.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	state	Auth state

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.26

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

Get the value of the cos override mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[out]	mode	Cos override mode

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

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

Set the value of the cos override mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	mode	Cos override mode

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.26

open_error_t openapiVoiceVlanPortDot1pPriorityGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	priority
	)

Get the Voice VLAN port DOT1P priority.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID
[out]	priority	priority

Return values

OPEN_E_NONE	Success
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.14

open_error_t openapiVoiceVlanPortDot1pPrioritySet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t	dot1pPriority
	)

Set the value of the dot1p.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	dot1pPriority	Dot1p priority value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.26

open_error_t openapiVoiceVlanPortDscpGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	dscp
	)

Get the value of the dscp.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[out]	dscp	Dscp value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

open_error_t openapiVoiceVlanPortDscpSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t	dscp
	)

Set the value of the dscp.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	dscp	Dscp value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.26

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

Get the value voice vlan status.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[out]	mode	Voice vlan status

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

open_error_t openapiVoiceVlanPortVlanIdGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	vlanId
	)

Get the Voice VLAN port VLAN ID.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID
[out]	vlanId	vlanId

Return values

OPEN_E_NONE	Success
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.14

open_error_t openapiVoiceVlanPortVlanIdSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t	vlanId
	)

Set the value of the vlan ID.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	vlanId	Vlan ID

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.26