Auto-VoIP Configuration [OPENAPI_VOIP]

Macros
#define	OUI_DESC_STRINGLEN   33
#define	OUI_STR_LEN   9

Enumerations
enum	OPEN_QOS_VOIP_TYPE_t { OPEN_QOS_VOIP_TYPE_PROTOCOL =1, OPEN_QOS_VOIP_TYPE_OUI, OPEN_QOS_VOIP_TYPE_TOTAL }
	< Voip types More...
enum	OPEN_VOIP_PRI_SCHEME_t { OPEN_VOIP_PRI_REMARK = 1, OPEN_VOIP_PRI_TRAFFIC_CLASS }

Functions
open_error_t	openapiVoipGlobalVlanIdGet (openapiClientHandle_t *client_handle, uint32_t *vlanId)
	Gets the VLAN ID for voip traffic on switch. More...
open_error_t	openapiVoipGlobalVlanIdReset (openapiClientHandle_t *client_handle)
	Resets the VLAN ID for voip traffic on switch. More...
open_error_t	openapiVoipGlobalVlanIdSet (openapiClientHandle_t *client_handle, uint32_t vlanId)
	Sets the VLAN ID for voip traffic on switch. More...
open_error_t	openapiVoipIndexOuiAdd (openapiClientHandle_t *client_handle, uint32_t ouiIndex, open_buffdesc *voipOui, open_buffdesc *ouiDesc)
	Adds a voip OUI entry in the given index. More...
open_error_t	openapiVoipIndexOuiRemove (openapiClientHandle_t *client_handle, uint32_t ouiIndex)
	Removes a voip OUI entry in the given index. More...
open_error_t	openapiVoipIntfModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_QOS_VOIP_TYPE_t type, OPEN_CONTROL_t *mode)
	Gets the VOIP profile mode on interface. More...
open_error_t	openapiVoipIntfModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_QOS_VOIP_TYPE_t type, OPEN_CONTROL_t mode)
	Sets the VOIP profile mode on interface. More...
open_error_t	openapiVoipIntfOUIStatusGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_LINK_STATE_t *val)
	Gets VoIP OUI mode operational port status. More...
open_error_t	openapiVoipIntfProtocolStatusGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_LINK_STATE_t *val)
	Gets VoIP Protocol mode operational port status. More...
open_error_t	openapiVoipMaxCallsGet (openapiClientHandle_t *client_handle, uint32_t *maxCalls)
	Get the maximum number of Auto-VoIP calls supported. More...
open_error_t	openapiVoipNumActiveProtocolSessionsGet (openapiClientHandle_t *client_handle, uint32_t *sessions)
	Gets VoIP Protocol Mode Active Sessions. More...
open_error_t	openapiVoipOuiAdd (openapiClientHandle_t *client_handle, open_buffdesc *voipOui, open_buffdesc *ouiDesc)
	Adds a voip OUI entry. More...
open_error_t	openapiVoipOuiCountGet (openapiClientHandle_t *client_handle, uint32_t *voipOuiCount)
	Gets the count of OUIs present in voip database. More...
open_error_t	openapiVoipOuiDescGet (openapiClientHandle_t *client_handle, open_buffdesc *voipOui, open_buffdesc *ouiDesc)
	Gets the voip OUI description for a given OUI. More...
open_error_t	openapiVoipOuiEntryGet (openapiClientHandle_t *client_handle, uint32_t ouiIndex, open_buffdesc *voipOui, open_buffdesc *ouiDesc)
	Gets the voip OUI entry for the index. More...
open_error_t	openapiVoipOuiEntryNextGet (openapiClientHandle_t *client_handle, uint32_t ouiIndex, open_buffdesc *voipOui, open_buffdesc *ouiDesc, uint32_t *nextOuiIndex)
	Gets the voip OUI entry for the given index and also returns next OUI Index. More...
open_error_t	openapiVoipOuiFirstEntryGet (openapiClientHandle_t *client_handle, open_buffdesc *voipOui, open_buffdesc *ouiDesc)
	Gets the first voip OUI entry. More...
open_error_t	openapiVoipOuiNextEntryGet (openapiClientHandle_t *client_handle, open_buffdesc *voipOui, open_buffdesc *nextVoipOui, open_buffdesc *nextOuiDesc)
	Gets the next voip OUI entry for a given OUI. More...
open_error_t	openapiVoipOUIPriorityGet (openapiClientHandle_t *client_handle, uint32_t *priority)
	Gets the priority for voip traffic on switch. More...
open_error_t	openapiVoipOUIPrioritySet (openapiClientHandle_t *client_handle, uint32_t priority)
	Sets the priority for voip traffic on switch. More...
open_error_t	openapiVoipOuiRemove (openapiClientHandle_t *client_handle, open_buffdesc *voipOui)
	Removes a voip OUI entry. More...
open_error_t	openapiVoipProfileCosQueueGet (openapiClientHandle_t *client_handle, OPEN_VOIP_PRI_SCHEME_t *pType, uint32_t *pTypeVal)
	Gets the VOIP profile Cos Queue. More...
open_error_t	openapiVoipProfileCosQueueSet (openapiClientHandle_t *client_handle, OPEN_VOIP_PRI_SCHEME_t pType, uint32_t pTypeVal)
	Sets the VOIP profile cos queue. More...

Detailed Description

Enumeration Type Documentation

enum OPEN_QOS_VOIP_TYPE_t

< Voip types

Enumerator
OPEN_QOS_VOIP_TYPE_PROTOCOL	Protocol based VOIP.
OPEN_QOS_VOIP_TYPE_OUI	OUI based VOIP.
OPEN_QOS_VOIP_TYPE_TOTAL	Last VOIP type.

Definition at line 46 of file openapi_voip.h.

enum OPEN_VOIP_PRI_SCHEME_t

Enumerator
OPEN_VOIP_PRI_REMARK	Re mark.
OPEN_VOIP_PRI_TRAFFIC_CLASS	Traffic class.

Definition at line 54 of file openapi_voip.h.

Function Documentation

open_error_t openapiVoipGlobalVlanIdGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	vlanId
	)

Gets the VLAN ID for voip traffic on switch.

Parameters

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

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.19

open_error_t openapiVoipGlobalVlanIdReset

(

openapiClientHandle_t *

client_handle

)

Resets the VLAN ID for voip traffic on switch.

Parameters

[in]

client_handle

client handle from registration API

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.19

open_error_t openapiVoipGlobalVlanIdSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId
	)

Sets the VLAN ID for voip traffic on switch.

Parameters

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

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.19

open_error_t openapiVoipIndexOuiAdd	(	openapiClientHandle_t *	client_handle,
		uint32_t	ouiIndex,
		open_buffdesc *	voipOui,
		open_buffdesc *	ouiDesc
	)

Adds a voip OUI entry in the given index.

Parameters

[in]	client_handle	client handle from registration API
[in]	ouiIndex	OUI index
[in]	voipOui	Voip OUI string
[in]	ouiDesc	Voip OUI description

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

OUI contains ascii string as "xx:xx:xx"

OpEN API Version: 1.26

open_error_t openapiVoipIndexOuiRemove	(	openapiClientHandle_t *	client_handle,
		uint32_t	ouiIndex
	)

Removes a voip OUI entry in the given index.

Parameters

[in]	client_handle	client handle from registration API
[in]	ouiIndex	OUI index

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 openapiVoipIntfModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_QOS_VOIP_TYPE_t	type,
		OPEN_CONTROL_t *	mode
	)

Gets the VOIP profile mode on interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface to be configured
[in]	type	Auto VoIP type (protocol/OUI based)
[out]	mode	Mode value

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.19

open_error_t openapiVoipIntfModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_QOS_VOIP_TYPE_t	type,
		OPEN_CONTROL_t	mode
	)

Sets the VOIP profile mode on interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface to be configured
[in]	type	Auto VoIP type (protocol/OUI based)
[in]	mode	Mode value

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.19

open_error_t openapiVoipIntfOUIStatusGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_LINK_STATE_t *	val
	)

Gets VoIP OUI mode operational port status.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface to be configured
[out]	val	Operational status (UP or DOWN)

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.19

open_error_t openapiVoipIntfProtocolStatusGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_LINK_STATE_t *	val
	)

Gets VoIP Protocol mode operational port status.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface to be configured
[out]	val	Operational status (UP or DOWN)

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.19

open_error_t openapiVoipMaxCallsGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	maxCalls
	)

Get the maximum number of Auto-VoIP calls supported.

Parameters

[in]	client_handle	client handle from registration API
[out]	maxCalls	maximum number of Auto-VoIP calls

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.19

open_error_t openapiVoipNumActiveProtocolSessionsGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	sessions
	)

Gets VoIP Protocol Mode Active Sessions.

Parameters

[in]	client_handle	client handle from registration API
[out]	sessions	number of Auto-VoIP sessions

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.19

open_error_t openapiVoipOuiAdd	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	voipOui,
		open_buffdesc *	ouiDesc
	)

Adds a voip OUI entry.

Parameters

[in]	client_handle	client handle from registration API
[in]	voipOui	Voip OUI string
[in]	ouiDesc	Voip OUI description

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

OUI should contain ascii string as "xx:xx:xx"

OpEN API Version: 1.26

open_error_t openapiVoipOuiCountGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	voipOuiCount
	)

Gets the count of OUIs present in voip database.

Parameters

[in]	client_handle	client handle from registration API
[out]	voipOuiCount	Number of OUIs present in database

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 openapiVoipOuiDescGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	voipOui,
		open_buffdesc *	ouiDesc
	)

Gets the voip OUI description for a given OUI.

Parameters

[in]	client_handle	client handle from registration API
[in]	voipOui	Voip OUI string
[out]	ouiDesc	Voip OUI description

Return values

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

Note

OUI contains ascii string as "xx:xx:xx"

OpEN API Version: 1.26

open_error_t openapiVoipOuiEntryGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ouiIndex,
		open_buffdesc *	voipOui,
		open_buffdesc *	ouiDesc
	)

Gets the voip OUI entry for the index.

Parameters

[in]	client_handle	client handle from registration API
[in]	ouiIndex	OUI index
[out]	voipOui	Voip OUI string
[out]	ouiDesc	Voip OUI description

Return values

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

Note

OUI contains ascii string as "xx:xx:xx"

OpEN API Version: 1.26

open_error_t openapiVoipOuiEntryNextGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ouiIndex,
		open_buffdesc *	voipOui,
		open_buffdesc *	ouiDesc,
		uint32_t *	nextOuiIndex
	)

Gets the voip OUI entry for the given index and also returns next OUI Index.

Parameters

[in]	client_handle	client handle from registration API
[in]	ouiIndex	OUI index
[out]	voipOui	Voip OUI string
[out]	ouiDesc	Voip OUI description
[out]	nextOuiIndex	Next OUI index

Return values

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

Note

OUI contains ascii string as "xx:xx:xx"

This API returns the next OUI index. It may not be valid. User of this API needs to enusre the validity by invoking openapiVoipOuiEntryGet()

OpEN API Version: 1.26

open_error_t openapiVoipOuiFirstEntryGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	voipOui,
		open_buffdesc *	ouiDesc
	)

Gets the first voip OUI entry.

Parameters

[in]	client_handle	client handle from registration API
[out]	voipOui	Voip OUI string
[out]	ouiDesc	Voip OUI description

Return values

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

Note

OUI contains ascii string as "xx:xx:xx"

OpEN API Version: 1.26

open_error_t openapiVoipOuiNextEntryGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	voipOui,
		open_buffdesc *	nextVoipOui,
		open_buffdesc *	nextOuiDesc
	)

Gets the next voip OUI entry for a given OUI.

Parameters

[in]	client_handle	client handle from registration API
[in]	voipOui	Voip OUI string
[out]	nextVoipOui	Next voip OUI string
[out]	nextOuiDesc	Next voip OUI description

Return values

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

Note

OUI contains ascii string as "xx:xx:xx"

OpEN API Version: 1.26

open_error_t openapiVoipOUIPriorityGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	priority
	)

Gets the priority for voip traffic on switch.

Parameters

[in]	client_handle	client handle from registration API
[out]	priority	priority value

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.19

open_error_t openapiVoipOUIPrioritySet	(	openapiClientHandle_t *	client_handle,
		uint32_t	priority
	)

Sets the priority for voip traffic on switch.

Parameters

[in]	client_handle	client handle from registration API
[in]	priority	priority value

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.19

open_error_t openapiVoipOuiRemove	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	voipOui
	)

Removes a voip OUI entry.

Parameters

[in]	client_handle	client handle from registration API
[in]	voipOui	Voip OUI string

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

OUI should contain ascii string as "xx:xx:xx"

OpEN API Version: 1.26

open_error_t openapiVoipProfileCosQueueGet	(	openapiClientHandle_t *	client_handle,
		OPEN_VOIP_PRI_SCHEME_t *	pType,
		uint32_t *	pTypeVal
	)

Gets the VOIP profile Cos Queue.

Parameters

[in]	client_handle	client handle from registration API
[out]	pType	priScheme (remark or traffic-class)
[out]	pTypeVal	value

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.19

open_error_t openapiVoipProfileCosQueueSet	(	openapiClientHandle_t *	client_handle,
		OPEN_VOIP_PRI_SCHEME_t	pType,
		uint32_t	pTypeVal
	)

Sets the VOIP profile cos queue.

Parameters

[in]	client_handle	client handle from registration API
[in]	pType	priScheme (remark or traffic-class)
[in]	pTypeVal	value

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.19