VoiceVlan API

This document provides a brief description of the VoiceVlan OpEN APIs. It provides the following services:

• Set Voice VLAN global administrative mode.
• Get Voice VLAN global administrative mode.
• Set Voice VLAN port mode.
• Get Voice VLAN port mode.
• Voice VLAN OpEN APIs Sanity.
• Get the value of the cos override mode.
• Set the value of the cos override mode.
• Get voice VLAN Auth State.
• Set voice VLAN Auth State.
• Get the value of the dscp.
• Set the value of the dscp.
• Set the value of the dot1p.
• Set the value of the VLAN ID.
• Get the value voice VLAN status.

Example C Application voice_vlan_example

Initialization

In the main function, the sample application initializes the OpEN API RPC service by calling openapiClientRegister() and waits for the RPC service in switchdrvr to start. A Client Handle is returned by openapiClientRegister() which is used while invoking the OpEN APIs. The application then exercises the associated OpEN APIs and logs informational and/or error messages on the console. The example application runs to its completion and exits.

voice_vlan_example

voice_vlan_example.c is a sample application that demonstrates the use of OpEN's VoiceVlan APIs. voice_vlan_example is started from the command line and can be used to exercise the various APIs by specifying arguments on the command line.

Sample Output

• Usage: ./voice_vlan_example <test#> <arg1> <arg2> ...
• Test 0: Set Voice VLAN global administrative mode: voice_vlan_example 0
• Test 1: Get Voice VLAN global administrative mode: voice_vlan_example 1
• Test 2: Set Voice VLAN port mode: voice_vlan_example 2 <interface> <mode> <val>
• Test 3: Get Voice VLAN port mode: voice_vlan_example 3
• Test 4: Voice VLAN OpEN APIs Sanity: voice_vlan_example 4
• Test 5: Get the value of the cos override mode: voice_vlan_example 5 <interface>
• Test 6: Set the value of the cos override mode: voice_vlan_example 6 <interface> <mode>
• Test 7: Get voice VLAN Auth State: voice_vlan_example 7 <interface>
• Test 8: Set voice VLAN Auth State: voice_vlan_example 8 <interface> <state>
• Test 9: Get the value of the dscp: voice_vlan_example 9 <interface>
• Test 10: Set the value of the dscp: voice_vlan_example 10 <interface> <dscp>
• Test 11: Set the value of the dot1p: voice_vlan_example 11 <interface> <dot1pPriority>
• Test 12: Set the value of the VLAN ID: voice_vlan_example 12 <interface> <vlanId>
• Test 13: Get the value voice VLAN status: voice_vlan_example 13 <interface>

VoiceVlan CLI/API Cross Reference

CLI Command	OpEN API Reference
(Config)# [no] voice vlan	openapiVoiceVlanAdminModeSet()
(Priv-User Mode)# show voice vlan	openapiVoiceVlanAdminModeGet()
(Interface-Config Mode)# voice vlan {dot1p | <VLAN ID> | none | untagged}	openapiVoiceVlanPortAdminModeSet()
(Priv-User Mode)# show voice vlan interface <slot/port>	openapiVoiceVlanPortAdminModeGet() openapiVoiceVlanPortVlanIdGet() openapiVoiceVlanPortDot1pPriorityGet() openapiVoiceVlanPortCosOverrideModeGet() openapiVoiceVlanPortAuthStateGet() openapiVoiceVlanPortDscpGet() openapiVoiceVlanPortStatusGet()
(Interface-Config Mode)# voice vlan data priority {trust | untrust}	openapiVoiceVlanPortCosOverrideModeSet()
(Interface-Config Mode)# voice vlan auth {enable | disable}	openapiVoiceVlanPortAuthStateSet()
(Interface-Config Mode)# voice vlan dscp	openapiVoiceVlanPortDscpSet()
(Interface-Config Mode)# voice vlan dot1p	openapiVoiceVlanPortDot1pPrioritySet()
(Interface-Config Mode)# voice vlan <id>	openapiVoiceVlanPortVlanIdSet()