Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Data Structures | Macros | Enumerations | Functions
openapi_vlan.h File Reference
#include <stdio.h>
#include <stddef.h>
#include <sys/un.h>
#include "openapi_common.h"

Go to the source code of this file.

Data Structures

struct  OPEN_VLAN_LIST_t
 

Macros

#define OPEN_VLAN_LIST_MAX_ENTRIES   4096
 VLAN list.
 

Enumerations

enum  OPEN_DOT1Q_PVLAN_PORT_TYPE_t { OPEN_PRIVATE_VLAN_UNCONFIGURED_PORT, OPEN_PRIVATE_VLAN_HOST_PORT, OPEN_PRIVATE_VLAN_COMMUNITY_PORT, OPEN_PRIVATE_VLAN_PROMISCOUS_PORT }
 
enum  OPEN_DOT1Q_PVLAN_TYPE_t { OPEN_PRIVATE_VLAN_UNCONFIGURED = 0, OPEN_PRIVATE_VLAN_PRIMARY, OPEN_PRIVATE_VLAN_SECONDARY_ISOLATED, OPEN_PRIVATE_VLAN_SECONDARY_COMMUNITY }
 
enum  OPEN_DOT1Q_SWPORT_MODE_t {
  OPEN_DOT1Q_SWPORT_MODE_NONE = 0, OPEN_DOT1Q_SWPORT_MODE_GENERAL = 1, OPEN_DOT1Q_SWPORT_MODE_ACCESS = 2, OPEN_DOT1Q_SWPORT_MODE_TRUNK = 3,
  OPEN_DOT1Q_SWPORT_MODE_PRIVATE_HOST = 4, OPEN_DOT1Q_SWPORT_MODE_PRIVATE_PROMISC = 5, OPEN_DOT1Q_SWPORT_MODE_PRIVATE_PROMISC_TRUNK = 6, OPEN_DOT1Q_SWPORT_MODE_PRIVATE_ISOLATED_TRUNK = 7
}
 

Functions

open_error_t openapiDot1qApiPrivateVlanAssocAdd (openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_VLAN_LIST_t vidList)
 Setup a VLAN bindings for private VLAN domain. More...
 
open_error_t openapiDot1qApiPrivateVlanAssocRemove (openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_VLAN_LIST_t vidList)
 Remove VLAN bindings for private VLAN domain. More...
 
open_error_t openapiDot1qIntfPVlanHostAssocSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t primary_vlan, uint32_t sec_vlan)
 Set VLAN bindings for private VLAN interface. More...
 
open_error_t openapiDot1qIntfPVlanPromiscAssocSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t primary_vlan, OPEN_VLAN_LIST_t vidList)
 Set VLAN bindings for private VLAN interface. More...
 
open_error_t openapiDot1qPrivateVlanAssociationGet (openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_VLAN_LIST_t *vidList)
 Get VLAN bindings for private VLAN domain. More...
 
open_error_t openapiDot1qPrivateVlanEnable (openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_DOT1Q_PVLAN_TYPE_t pvlanType)
 Setup a VLAN as private VLAN. More...
 
open_error_t openapiDot1qPrivateVlanGet (openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_DOT1Q_PVLAN_TYPE_t *pvlanType)
 Get the configured private VLAN type. More...
 
open_error_t openapiDot1qPVlanIntfHostAssocRemove (openapiClientHandle_t *client_handle, uint32_t ifNum)
 Clear VLAN bindings for private VLAN interface. More...
 
open_error_t openapiDot1qPVlanIntfPromiscAssocRemove (openapiClientHandle_t *client_handle, uint32_t ifNum)
 Clear VLAN bindings for private VLAN interface. More...
 
open_error_t openapiDot1qSwPortAccessVlanGet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t *vlanId)
 Get the Access VLAN ID for a port. More...
 
open_error_t openapiDot1qSwPortAccessVlanSet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t vlanId)
 Set the Access VLAN ID for a port. More...
 
open_error_t openapiDot1qSwPortDynamicallyAddedVlanListGet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_VLAN_LIST_t *vidList)
 Get the dynamically added VLAN list for the interface when the interface is in general mode. More...
 
open_error_t openapiDot1qSwPortForbiddenVlanListGet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_VLAN_LIST_t *vidList)
 Get the forbidden VLAN list for the interface when the interface is in general mode. More...
 
open_error_t openapiDot1qSwPortModeGet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_DOT1Q_SWPORT_MODE_t *mode)
 Get the Switchport Configuration Mode for a port. More...
 
open_error_t openapiDot1qSwPortModeSet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_DOT1Q_SWPORT_MODE_t mode)
 Set the Switchport Configuration Mode for a port. More...
 
open_error_t openapiDot1qSwPortTaggedVlanListGet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_VLAN_LIST_t *vidList)
 Get the tagged VLAN list for the interface when the interface is in general mode. More...
 
open_error_t openapiDot1qSwPortTrunkAllowedVlanListGet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_VLAN_LIST_t *vidList)
 Get the list of VLANs allowed on an interface when the interface is in trunking mode. More...
 
open_error_t openapiDot1qSwPortTrunkAllowedVlanListSet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_VLAN_LIST_t *vidList)
 Set the list of VLANs allowed on an interface when the interface is in trunking mode. More...
 
open_error_t openapiDot1qSwPortTrunkNativeVlanGet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t *vlanId)
 Get the Native VLAN ID for a port when in trunking mode. More...
 
open_error_t openapiDot1qSwPortTrunkNativeVlanSet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t vlanId)
 Set the native VLAN ID for a port when in trunking mode. More...
 
open_error_t openapiDot1qSwPortUntaggedVlanListGet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_VLAN_LIST_t *vidList)
 Get the untagged VLAN list for the interface when the interface is in general mode. More...
 
open_error_t openapiPvlanIntfHostAssocGet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t *primaryVid, uint32_t *secondaryVid)
 Get the private VLAN association for a host mode interface. More...
 
open_error_t openapiPvlanIntfIsolatedTrunkAssocNextGet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t primaryVid, uint32_t *nextPrimaryVid, uint32_t *secondaryVid)
 Get the next primary VLAN and any associated secondary VLAN for an isolated trunk interface in a private VLAN. More...
 
open_error_t openapiPvlanIntfModeGet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_DOT1Q_SWPORT_MODE_t *mode)
 Get the private VLAN mode for an interface. More...
 
open_error_t openapiPvlanIntfOperAssocGet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_VLAN_LIST_t *operationalVidList)
 Get the list of operational VLAN(s) for a private VLAN interface. More...
 
open_error_t openapiPvlanIntfPromiscAssocGet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t *primaryVid, OPEN_VLAN_LIST_t *secondaryVidList)
 Get the private VLAN association for a promiscuous mode interface. More...
 
open_error_t openapiPvlanIntfPromiscTrunkAssocNextGet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t primaryVid, uint32_t *nextPrimaryVid, OPEN_VLAN_LIST_t *secondaryVidList)
 Get the next primary VLAN and any associated secondary VLAN(s) for a promiscuous trunk interface in a private VLAN. More...
 
open_error_t openapiPvlanIntfTrunkAllowedVlanListGet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_VLAN_LIST_t *normalVidList)
 Get the list of normal VLAN(s) carried by a promiscuous or isolated trunk interface in a private VLAN. More...
 
open_error_t openapiPvlanIntfTrunkNativeVlanGet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t *nativeVid)
 Get the native VLAN for a promiscuous or isolated trunk interface in a private VLAN. More...
 
open_error_t openapiVlanCreate (openapiClientHandle_t *client_handle, uint32_t vlanNum)
 Creates the VLAN with the ID specified on the switch. More...
 
open_error_t openapiVlanCreatedCheck (openapiClientHandle_t *client_handle, uint32_t vlanNum)
 Test if the given VLAN has been configured on the switch. More...
 
open_error_t openapiVlanDelete (openapiClientHandle_t *client_handle, uint32_t vlanNum)
 Deletes the VLAN with the ID specified on the switch. More...
 
open_error_t openapiVlanIfAcceptFrameTypeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DOT1Q_ACCEPT_FRAME_TYPE_t *type)
 Get the Acceptable Frame Type configuration for a port. More...
 
open_error_t openapiVlanIfAcceptFrameTypeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DOT1Q_ACCEPT_FRAME_TYPE_t type)
 Set the Acceptable Frame Type configuration for a port. More...
 
open_error_t openapiVlanIfDefaultUserPriorityGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *priority)
 Gets an interface's default user priority. More...
 
open_error_t openapiVlanIfDefaultUserPrioritySet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t priority)
 Sets an interface's default user priority. More...
 
open_error_t openapiVlanIfNumTrafficClassesGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *numTrafficClasses)
 Gets an interface's number of traffic classes supported. More...
 
open_error_t openapiVlanIfParticipationGet (openapiClientHandle_t *client_handle, uint32_t vlanNum, uint32_t ifNum, OPEN_VLAN_PARTICIPATION_MODE_t *participationMode)
 Gets an interface's configured participation mode for the specified VLAN. More...
 
open_error_t openapiVlanIfParticipationSet (openapiClientHandle_t *client_handle, uint32_t vlanNum, uint32_t ifNum, OPEN_VLAN_PARTICIPATION_MODE_t participationMode)
 Sets an interface's participation mode configuration for the specified VLAN. More...
 
open_error_t openapiVlanIfParticipationStatusGet (openapiClientHandle_t *client_handle, uint32_t vlanNum, uint32_t ifNum, uint32_t *participating)
 Gets an interface's participation status for the specified VLAN. More...
 
open_error_t openapiVlanIfPvidGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *vlanNum)
 Gets an interface's PVID. More...
 
open_error_t openapiVlanIfPvidSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t vlanNum)
 Sets an interface's VLAN ID (PVID). More...
 
open_error_t openapiVlanIfTaggingGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t vlanNum, OPEN_CONTROL_t *tagging)
 Gets an interface's tagging setting for the specified VLAN. More...
 
open_error_t openapiVlanIfTaggingSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t vlanNum, OPEN_CONTROL_t tagging)
 Sets an interface's tagging mode for the given VLAN. More...
 
int openapiVlanIsStatic (openapiClientHandle_t *client_handle, uint32_t vlanNum)
 Returns whether the VLAN is static. More...
 
open_error_t openapiVlanNameGet (openapiClientHandle_t *client_handle, uint32_t vlanNum, open_buffdesc *vlanName)
 Gets the VLAN Name. More...
 
open_error_t openapiVlanNameLenGet (openapiClientHandle_t *client_handle, uint32_t *strLen)
 Gets the VLAN Name string length. More...
 
open_error_t openapiVlanNameSet (openapiClientHandle_t *client_handle, uint32_t vlanNum, open_buffdesc *vlanName)
 Configures a VLAN Name. More...
 
open_error_t openapiVlanNextChangedGet (openapiClientHandle_t *client_handle, uint32_t vlanNum, uint32_t *nextVlanNum, uint32_t *delete_pending)
 Gets the next VLAN which has a pending change or a pending deletion. More...
 
open_error_t openapiVlanNextGet (openapiClientHandle_t *client_handle, uint32_t vlanNum, uint32_t *nextVlanNum)
 Gets the next VLAN number that has been configured on the switch. More...