Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
#include <stdio.h>
#include <stddef.h>
#include <stdbool.h>
#include <sys/un.h>
#include "openapi_common.h"
Go to the source code of this file.
Macros | |
#define | OPEN_DOT1AD_CVID_MAX 4092 |
Maximum numbers of customer VLAN ID. | |
#define | OPEN_DOT1AD_CVID_MIN 1 |
Maximum numbers of customer VLAN ID. | |
#define | OPEN_DOT1AD_MAX_VLAN_ID 4095 |
Maximum numbers of VLAN ID. | |
#define | OPEN_DOT1AD_MIN_VLAN_ID 1 |
Minimum numbers of VLAN ID. | |
#define | OPEN_DOT1AD_SERVICE_NAME_LEN_MAX 31 |
Maximum length of service name (does not include trailing '\0') | |
#define | OPEN_DOT1AD_SERVICE_NAME_LEN_MIN 1 |
Minimum length of service name (does not include trailing '\0') | |
#define | OPEN_DOT1AD_SERVICES_MAX 4096 |
Maximum numbers of services VLAN ID. | |
#define | OPEN_DOT1AD_SUBSCRIPTIONS_MAX 4096 |
Maximum numbers of subscriptions. | |
#define | OPEN_DOT1AD_SVID_MAX 4092 |
Maximum numbers of services VLAN ID. | |
#define | OPEN_DOT1AD_SVID_MIN 1 |
Minimum numbers of services VLAN ID. | |
Enumerations | |
enum | OPEN_DOT1AD_INTERFACE_TYPE_t { OPEN_DOT1AD_INTERFACE_TYPE_UNI = 0, OPEN_DOT1AD_INTERFACE_TYPE_UNI_P = 1, OPEN_DOT1AD_INTERFACE_TYPE_UNI_S = 2, OPEN_DOT1AD_INTERFACE_TYPE_NNI = 3, OPEN_DOT1AD_INTERFACE_TYPE_SWITCHPORT = 4, OPEN_DOT1AD_INTERFACE_TYPE_TOTAL } |
This enumerator is appointed to indicate interface type for a given configuration or status parameter. More... | |
enum | OPEN_DOT1AD_PKTTYPE_t { OPEN_DOT1AD_PKTTYPE_NONE = 0, OPEN_DOT1AD_PKTTYPE_UNTAGGED = 1, OPEN_DOT1AD_PKTTYPE_PRIOTAGGED = 2, OPEN_DOT1AD_PKTTYPE_TAGGED = 3, OPEN_DOT1AD_PKTTYPE_NO_STAG = 4, OPEN_DOT1AD_PKTTYPE_NO_CTAG = 5, OPEN_DOT1AD_PKTTYPE_TOTAL } |
This enumerator is appointed to indicate packet type for a given configuration or status parameter. More... | |
enum | OPEN_DOT1AD_SVCTYPE_t { OPEN_DOT1AD_SVCTYPE_ELINE = 1, OPEN_DOT1AD_SVCTYPE_ELAN = 2, OPEN_DOT1AD_SVCTYPE_ETREE = 3, OPEN_DOT1AD_SVCTYPE_TLS = 4, OPEN_DOT1AD_SVCTYPE_TOTAL } |
This enumerator is appointed to indicate type of DOT1AD service for a given configuration or status parameter. More... | |
Functions | |
open_error_t | openapiDot1adInterfacePreserveCvlanDot1pGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *enable) |
Get the Dot1ad interface's preserve CVLAN-dot1p property. More... | |
open_error_t | openapiDot1adInterfacePreserveCvlanDot1pSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t enable) |
Set the Dot1ad interface's preserve CVLAN-dot1p property. More... | |
open_error_t | openapiDot1adInterfaceTypeGet (openapiClientHandle_t *client_handle, uint32_t BasePort, OPEN_DOT1AD_INTERFACE_TYPE_t *intfType) |
Get the Dot1ad interface type. More... | |
open_error_t | openapiDot1adInterfaceTypeSet (openapiClientHandle_t *client_handle, uint32_t basePort, OPEN_DOT1AD_INTERFACE_TYPE_t intfType) |
Set the Dot1ad interface type. More... | |
open_error_t | openapiDot1adIntfNextGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *nextIntIfNum) |
Get the Internal Interface Number of the next valid DOT1AD port. More... | |
open_error_t | openapiDot1adIsolateVidSet (openapiClientHandle_t *client_handle, uint32_t svid, uint32_t isolateVid) |
To set the isolated VLAN ID for E-TREE service. More... | |
open_error_t | openapiDot1adNniIntfListGet (openapiClientHandle_t *client_handle, uint32_t svid, open_buffdesc *nniIntfList) |
To get the NNI InterfaceList for a given DOT1AD service. More... | |
open_error_t | openapiDot1adNniIntfListSet (openapiClientHandle_t *client_handle, uint32_t svid, open_buffdesc *nniIntfList) |
To set the NNI Intf List for a given DOT1AD service. More... | |
open_error_t | openapiDot1adReleaseCurrentSubscription (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t svid) |
Remove current subscription structure from given internal interface number and DOT1AD service VLAN ID. More... | |
open_error_t | openapiDot1adReserveCurrentSubscription (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t svid) |
Reserve current subscription structure for given internal interface number and DOT1AD service VLAN ID. More... | |
open_error_t | openapiDot1adServiceCreate (openapiClientHandle_t *client_handle, uint32_t svid) |
To create a new DOT1AD service. More... | |
open_error_t | openapiDot1adServiceDelete (openapiClientHandle_t *client_handle, uint32_t svid) |
To delete an existing DOT1AD service. More... | |
open_error_t | openapiDot1adServiceIndexGetFirst (openapiClientHandle_t *client_handle, uint32_t *serviceIndex) |
Get the First service index created in the system. More... | |
open_error_t | openapiDot1adServiceIndexGetNext (openapiClientHandle_t *client_handle, uint32_t serviceIndex, uint32_t *next) |
Given serviceIndex, get the next service index. More... | |
open_error_t | openapiDot1adServiceIntfMatchCvidGet (openapiClientHandle_t *client_handle, uint32_t subscrIndex, uint32_t intIfNum, uint32_t *matchCvid) |
To get the matching customer VLAN ID for a DOT1AD subscription. More... | |
open_error_t | openapiDot1adServiceIntfMatchPriorityGet (openapiClientHandle_t *client_handle, uint32_t subscrIndex, uint32_t intIfNum, uint32_t *priority) |
To get the matching dot1p priority for a DOT1AD subscription. More... | |
open_error_t | openapiDot1adServiceIntfMatchSvidGet (openapiClientHandle_t *client_handle, uint32_t subscrIndex, uint32_t intIfNum, uint32_t *matchSvid) |
To get the matching service VLAN ID for a DOT1AD subscription. More... | |
open_error_t | openapiDot1adServiceIsolateVidIsConfigured (openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_BOOL_t *flag) |
To get the information if specified VLAN ID is configured as isolate Vlan Id. More... | |
open_error_t | openapiDot1adServiceNameAdd (openapiClientHandle_t *client_handle, uint32_t svid, open_buffdesc *name) |
To add the name to this service. More... | |
open_error_t | openapiDot1adServiceNameGet (openapiClientHandle_t *client_handle, uint32_t svid, open_buffdesc *name) |
To get the name of the service for a given service VLAN ID. More... | |
open_error_t | openapiDot1adServiceNameStringCheck (openapiClientHandle_t *client_handle, open_buffdesc *name) |
Checks if the service name is a valid string. More... | |
open_error_t | openapiDot1adServiceNameToSvid (openapiClientHandle_t *client_handle, open_buffdesc *name, uint32_t *svid) |
To get the VLAN ID of a service, given its name. More... | |
open_error_t | openapiDot1adServiceRemoveCtagGet (openapiClientHandle_t *client_handle, uint32_t subscrIndex, uint32_t intIfNum, OPEN_BOOL_t *removeCtag) |
To get the remove CTAG action for a DOT1AD subscription. More... | |
open_error_t | openapiDot1adServiceTypeGet (openapiClientHandle_t *client_handle, uint32_t svid, OPEN_DOT1AD_SVCTYPE_t *serviceType) |
To get the service type for a given DOT1AD service. More... | |
open_error_t | openapiDot1adServiceTypeSet (openapiClientHandle_t *client_handle, uint32_t svid, OPEN_DOT1AD_SVCTYPE_t serviceType) |
To set the service type for a given DOT1AD service. More... | |
open_error_t | openapiDot1adServiceVidIsConfigured (openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_BOOL_t *flag) |
To get the information if specified VLAN ID is configured as a DOT1AD service Vlan. More... | |
open_error_t | openapiDot1adSpecificSubscriptionNextIntfEntryGet (openapiClientHandle_t *client_handle, uint32_t intfIn, uint32_t svidIn, uint32_t cvidIn, uint32_t *intfOut, uint32_t *svidOut, uint32_t *cvidOut) |
Given interface number, service VLAN ID and Customer VLAN ID get the next subscribers entry. More... | |
open_error_t | openapiDot1adSubscriptionAdd (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t svid) |
To add a subscription to a given DOT1AD service on a given interface. More... | |
open_error_t | openapiDot1adSubscriptionCvidSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t svid, uint32_t cvid) |
To set the resulting customer VLAN ID for a DOT1AD subscription. More... | |
open_error_t | openapiDot1adSubscriptionDelete (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t svid, open_buffdesc *subscrName) |
To delete a DOT1AD service subscription on an given interface. More... | |
open_error_t | openapiDot1adSubscriptionFirstIntfEntryGet (openapiClientHandle_t *client_handle, uint32_t intfIn, uint32_t *intfOut, uint32_t *svid, uint32_t *cvid) |
Get the first subscribers entry based on interface number. More... | |
open_error_t | openapiDot1adSubscriptionMatchCvidSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t svid, uint32_t matchCvid) |
To set the matching customer VLAN ID for a DOT1AD subscription. More... | |
open_error_t | openapiDot1adSubscriptionMatchPrioritySet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t svid, uint32_t priority) |
To set the matching dot1p priority for a DOT1AD subscription. More... | |
open_error_t | openapiDot1adSubscriptionMatchSvidSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t svid, uint32_t matchSvid) |
To set the matching Service VLAN ID for a DOT1AD subscription. More... | |
open_error_t | openapiDot1adSubscriptionNameGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t svid, uint32_t cvid, open_buffdesc *name) |
To get the name of a DOT1AD service subscription. More... | |
open_error_t | openapiDot1adSubscriptionNameSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t svid, open_buffdesc *name) |
To set the name for a DOT1AD service subscription. More... | |
open_error_t | openapiDot1adSubscriptionNextIntfEntryGet (openapiClientHandle_t *client_handle, uint32_t intfIn, uint32_t svidIn, uint32_t cvidIn, uint32_t *intfOut, uint32_t *svidOut, uint32_t *cvidOut) |
Given subscribers entry, get the next subscribers entry. More... | |
open_error_t | openapiDot1adSubscriptionNNIIntfListGet (openapiClientHandle_t *client_handle, uint32_t subscrIndex, uint32_t intIfNum, open_buffdesc *nniIntfList) |
To get the NNI InterfaceList for a given DOT1AD service subscription. More... | |
open_error_t | openapiDot1adSubscriptionNNIIntfListSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t svid, open_buffdesc *nniIntfList) |
To set the NNI Interface List for a given DOT1AD service subscription. More... | |
open_error_t | openapiDot1adSubscriptionPktTypeGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t svid, uint32_t cvid, OPEN_DOT1AD_PKTTYPE_t *pktType) |
To get the matching Packet type for a DOT1AD subscription. More... | |
open_error_t | openapiDot1adSubscriptionPktTypeSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t svid, OPEN_DOT1AD_PKTTYPE_t pktType) |
To set the matching Packet type for a DOT1AD subscription. More... | |
open_error_t | openapiDot1adSubscriptionRemoveCtagSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t svid, OPEN_BOOL_t removeCtag) |
To set the action remove CTAG for a DOT1AD subscription. More... | |
open_error_t | openapiDot1adSubscriptionSvidSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t svid) |
To set the Service VLAN ID for a DOT1AD subscription. More... | |