Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Enumerations | Functions
Auto-VoIP Configuration [OPENAPI_VOIP]

Enumerations

enum  OPEN_QOS_VOIP_TYPE_t { OPEN_QOS_VOIP_TYPE_PROTOCOL =1, OPEN_QOS_VOIP_TYPE_OUI, OPEN_QOS_VOIP_TYPE_TOTAL }
 
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 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 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 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

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_handleclient handle from registration API
[out]vlanIdVLAN ID
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther 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_handleclient handle from registration API
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther 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_handleclient handle from registration API
[in]vlanIdVLAN ID
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

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_handleclient handle from registration API
[in]ifNuminterface to be configured
[in]typeAuto VoIP type (protocol/OUI based)
[out]modeMode value
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther 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_handleclient handle from registration API
[in]ifNuminterface to be configured
[in]typeAuto VoIP type (protocol/OUI based)
[in]modeMode value
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther 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_handleclient handle from registration API
[in]ifNumInterface to be configured
[out]valOperational status (UP or DOWN)
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther 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_handleclient handle from registration API
[in]ifNumInterface to be configured
[out]valOperational status (UP or DOWN)
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther 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_handleclient handle from registration API
[out]maxCallsmaximum number of Auto-VoIP calls
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther 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_handleclient handle from registration API
[out]sessionsnumber of Auto-VoIP sessions
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

open_error_t openapiVoipOUIPriorityGet ( openapiClientHandle_t client_handle,
uint32_t *  priority 
)

Gets the priority for voip traffic on switch.

Parameters
[in]client_handleclient handle from registration API
[out]prioritypriority value
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther 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_handleclient handle from registration API
[in]prioritypriority value
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

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_handleclient handle from registration API
[out]pTypepriScheme (remark or traffic-class)
[out]pTypeValvalue
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther 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_handleclient handle from registration API
[in]pTypepriScheme (remark or traffic-class)
[in]pTypeValvalue
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19