Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Macros | Enumerations | Functions
openapi_pbvlan.h File Reference

Go to the source code of this file.

Macros

#define OPENAPI_PBVLAN_MAX_CONFIGURABLE_PROTOCOLS   16
 Maximum number of protocols which could be added to the PBVLAN group. More...
 
#define OPENAPI_PBVLAN_MAX_GROUP_NAME   16
 Maximum length of the PBVLAN group name. More...
 
#define OPENAPI_PBVLAN_MAX_NUM_GROUPS   128
 Maximum ID of the PBVLAN group. More...
 
#define OPENAPI_PBVLAN_MIN_GROUP_NAME   1
 Minumum length of the PBVLAN group name. More...
 
#define OPENAPI_PBVLAN_MIN_NUM_GROUPS   1
 Minumum ID of the PBVLAN group. More...
 

Enumerations

enum  OPENAPI_PBVLAN_PROT_TYPE_t { OPENAPI_PBVLAN_STR_PROT_TYPE = 0, OPENAPI_PBVLAN_NUM_PROT_TYPE = 1 }
 Protocol type indicates type of the protocol format. More...
 

Functions

open_error_t openapiPbVlanGroupCreate (openapiClientHandle_t *client_handle, uint32_t groupId)
 Create a Protocol-Based VLAN group. More...
 
open_error_t openapiPbVlanGroupDelete (openapiClientHandle_t *client_handle, uint32_t groupId)
 Delete a Protocol-Based VLAN group. More...
 
open_error_t openapiPbVlanGroupGetFirst (openapiClientHandle_t *client_handle, uint32_t *groupId)
 Get the ID of the first created Protocol-Based VLAN group. More...
 
open_error_t openapiPbVlanGroupGetNext (openapiClientHandle_t *client_handle, uint32_t groupId, uint32_t *nextGroupId)
 Get the ID of the next created Protocol-Based VLAN group. More...
 
open_error_t openapiPbVlanGroupIdGet (openapiClientHandle_t *client_handle, open_buffdesc *groupName, uint32_t *groupId)
 Get the group ID of the Protocol-Based VLAN group with specified name. More...
 
open_error_t openapiPbVlanGroupNameGet (openapiClientHandle_t *client_handle, uint32_t groupId, open_buffdesc *groupName)
 Get the group name of the specified Protocol-Based VLAN group. More...
 
open_error_t openapiPbVlanGroupNameSet (openapiClientHandle_t *client_handle, uint32_t groupId, open_buffdesc *groupName)
 Set the group name of the specified Protocol-Based VLAN group. More...
 
open_error_t openapiPbVlanGroupPortAdd (openapiClientHandle_t *client_handle, uint32_t groupId, uint32_t ifNum)
 Add an interface to the specified Protocol-Based VLAN group. More...
 
open_error_t openapiPbVlanGroupPortDelete (openapiClientHandle_t *client_handle, uint32_t groupId, uint32_t ifNum)
 Delete an interfcae from the specified Protocol-Based VLAN group. More...
 
open_error_t openapiPbVlanGroupPortGetNext (openapiClientHandle_t *client_handle, uint32_t groupId, uint32_t ifNum, uint32_t *nextIfNum)
 Get the next configured interface of the Protocol-Based VLAN group. More...
 
open_error_t openapiPbVlanGroupProtocolAdd (openapiClientHandle_t *client_handle, uint32_t groupId, uint32_t prot, OPENAPI_PBVLAN_PROT_TYPE_t protType)
 Add a protocol to the specified Protocol-Based VLAN group. More...
 
open_error_t openapiPbVlanGroupProtocolDelete (openapiClientHandle_t *client_handle, uint32_t groupId, uint32_t prot)
 Delete a protocol from the specified Protocol-Based VLAN group. More...
 
open_error_t openapiPbVlanGroupProtocolGet (openapiClientHandle_t *client_handle, uint32_t groupId, open_buffdesc *protList)
 Get the comma separated list with all configured protocols of the Protocol-Based VLAN group. More...
 
open_error_t openapiPbVlanGroupProtocolGetNext (openapiClientHandle_t *client_handle, uint32_t groupId, uint32_t prot, uint32_t *nextProt)
 Get the next configured protocol of the Protocol-Based VLAN group. More...
 
open_error_t openapiPbVlanGroupVlanIDAdd (openapiClientHandle_t *client_handle, uint32_t groupId, uint32_t vlanId)
 Add a VLAN to the specified Protocol-Based VLAN group. More...
 
open_error_t openapiPbVlanGroupVlanIDDelete (openapiClientHandle_t *client_handle, uint32_t groupId, uint32_t vlanId)
 Delete a VLAN from the specified Protocol-Based VLAN group. More...
 
open_error_t openapiPbVlanGroupVlanIDGet (openapiClientHandle_t *client_handle, uint32_t groupId, uint32_t *vlanId)
 Get the VLAN ID of the Protocol-Based VLAN group. More...
 
open_error_t openapiPbVlanIntfValidate (openapiClientHandle_t *client_handle, uint32_t ifNum)
 Check whether specified interface is valid for the Protocol-Based VLAN configuration. More...