Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Enumerations | Functions
Voice VLAN Configuration And Status [OPENAPI_VOICE_VLAN]

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 openapiVoiceVlanPortDot1pPriorityGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *priority)
 Get the Voice VLAN port DOT1P priority. More...
 
open_error_t openapiVoiceVlanPortVlanIdGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *vlanId)
 Get the Voice VLAN port VLAN ID. More...
 

Detailed Description

Enumeration Type Documentation

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_handleclient handle from registration API
[out]modeadministrative mode
Return values
OPEN_E_NONEAdministrative mode get successful.
OPEN_E_FAILAdministrative mode get failed.
OPEN_E_PARAMError 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_handleclient handle from registration API
[in]modeadministrative mode
Return values
OPEN_E_NONEAdministrative mode set successful.
OPEN_E_FAILAdministrative mode set failed.
OPEN_E_PARAMError 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_handleclient handle from registration API
[in]ifNumInterface ID
[out]modemode
Return values
OPEN_E_NONESuccess
OPEN_E_FAILGet failed.
OPEN_E_PARAMError 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_handleclient handle from registration API
[in]ifNumInterface ID
[in]modemode
[in]dataValueCertain 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_NONESuccess
OPEN_E_FAILFailure
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.14

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

Get the Voice VLAN port DOT1P priority.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumInterface ID
[out]prioritypriority
Return values
OPEN_E_NONESuccess
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.14

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

Get the Voice VLAN port VLAN ID.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumInterface ID
[out]vlanIdvlanId
Return values
OPEN_E_NONESuccess
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.14