Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
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... | |
This enumerator is appointed to indicate interface type for a given configuration or status parameter.
Definition at line 85 of file openapi_dot1ad.h.
This enumerator is appointed to indicate packet type for a given configuration or status parameter.
Definition at line 72 of file openapi_dot1ad.h.
This enumerator is appointed to indicate type of DOT1AD service for a given configuration or status parameter.
Enumerator | |
---|---|
OPEN_DOT1AD_SVCTYPE_ELAN |
E-line servicetype. |
OPEN_DOT1AD_SVCTYPE_ETREE |
E-lan servicetype. |
OPEN_DOT1AD_SVCTYPE_TLS |
E-tree servicetype. |
OPEN_DOT1AD_SVCTYPE_TOTAL |
tls servicetype |
Definition at line 61 of file openapi_dot1ad.h.
open_error_t openapiDot1adInterfacePreserveCvlanDot1pGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intIfNum, | ||
OPEN_BOOL_t * | enable | ||
) |
Get the Dot1ad interface's preserve CVLAN-dot1p property.
[in] | client_handle | Client handle from registration API |
[in] | intIfNum | Internal interface number |
[out] | enable | OPEN_TRUE/OPEN_FALSE |
OPEN_E_NONE | If success. |
OPEN_E_FAIL | If other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
open_error_t openapiDot1adInterfacePreserveCvlanDot1pSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intIfNum, | ||
OPEN_BOOL_t | enable | ||
) |
Set the Dot1ad interface's preserve CVLAN-dot1p property.
[in] | client_handle | Client handle from registration API |
[in] | intIfNum | Internal interface number |
[in] | enable | OPEN_TRUE/OPEN_FALSE |
OPEN_E_NONE | If success. |
OPEN_E_FAIL | If other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
open_error_t openapiDot1adInterfaceTypeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | BasePort, | ||
OPEN_DOT1AD_INTERFACE_TYPE_t * | intfType | ||
) |
Get the Dot1ad interface type.
[in] | client_handle | Client handle from registration API |
[in] | BasePort | Internal interface number |
[out] | intfType | Dot1ad interface type |
OPEN_E_NONE | If Dot1ad interface type is get successfully. |
OPEN_E_FAIL | Dot1ad interface type is not retrieved, or other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
open_error_t openapiDot1adInterfaceTypeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | basePort, | ||
OPEN_DOT1AD_INTERFACE_TYPE_t | intfType | ||
) |
Set the Dot1ad interface type.
[in] | client_handle | Client handle from registration API |
[in] | basePort | Internal interface number |
[in] | intfType | Dot1ad interface type |
OPEN_E_NONE | If Dot1ad interface type is set successfully. |
OPEN_E_FAIL | Dot1ad interface type is not set, or other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | intIfNum | Internal interface number |
[out] | nextIntIfNum | Pointer to the next valid internal interface number |
OPEN_E_NONE | If success. |
OPEN_E_EXIST | If interface does not exist. |
OPEN_E_FAIL | If other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
open_error_t openapiDot1adIsolateVidSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | svid, | ||
uint32_t | isolateVid | ||
) |
To set the isolated VLAN ID for E-TREE service.
[in] | client_handle | Client handle from registration API |
[in] | svid | service index |
- | Minimum value OPEN_DOT1AD_SVID_MIN | |
- | Maximum value OPEN_DOT1AD_SVID_MAX | |
[in] | isolateVid | isolated VLAN ID |
- | Minimum value OPEN_DOT1AD_MIN_VLAN_ID | |
- | Maximum value OPEN_DOT1AD_MAX_VLAN_ID |
OPEN_E_NONE | Isolate VLAN ID is set. |
OPEN_E_ERROR | Service does not exist. |
OPEN_E_FAIL | Service Type is not E-TREE, invalid vlanID, or other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
open_error_t openapiDot1adNniIntfListGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | svid, | ||
open_buffdesc * | nniIntfList | ||
) |
To get the NNI InterfaceList for a given DOT1AD service.
[in] | client_handle | Client handle from registration API |
[in] | svid | Service VLAN ID of the given DOT1AD service. |
- | Minimum value OPEN_DOT1AD_SVID_MIN | |
- | Maximum value OPEN_DOT1AD_SVID_MAX | |
[out] | nniInfList | NNI Interface List in form of comma separated internal interface numbers |
OPEN_E_NONE | If NNI InterfaceList is retrieved successfully. |
OPEN_E_ERROR | If Service with the specified service VLAN ID does not exist. |
OPEN_E_FAIL | If specified service VLAN ID is out of range or other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | svid | Service VLAN ID of the given DOT1AD service |
- | Minimum value OPEN_DOT1AD_SVID_MIN | |
- | Maximum value OPEN_DOT1AD_SVID_MAX | |
[in] | nniInfList | NNI Interface List in form of comma separated internal interface numbers |
OPEN_E_NONE | If NNI Intf List is added. |
OPEN_E_ERROR | If the service does not exist. |
OPEN_E_FULL | If number of NNI interfaces specified is greater than the allowed number. |
OPEN_E_FAIL | If specified service VLAN ID is out of range or other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | intIfNum | Internal interface number |
[in] | svid | DOT1AD service VLAN ID |
- | Minimum value OPEN_DOT1AD_SVID_MIN | |
- | Maximum value OPEN_DOT1AD_SVID_MAX |
OPEN_E_NONE | If current subscription is removed. |
OPEN_E_FAIL | Invalid parms, or other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | intIfNum | Internal interface number |
[in] | svid | DOT1AD service VLAN ID |
- | Minimum value OPEN_DOT1AD_SVID_MIN | |
- | Maximum value OPEN_DOT1AD_SVID_MAX |
OPEN_E_NONE | If current subscription is reserved. |
OPEN_E_FAIL | Invalid parms, or other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
open_error_t openapiDot1adServiceCreate | ( | openapiClientHandle_t * | client_handle, |
uint32_t | svid | ||
) |
To create a new DOT1AD service.
[in] | client_handle | Client handle from registration API |
[in] | svid | Service VLAN ID for the service |
- | Minimum value OPEN_DOT1AD_SVID_MIN | |
- | Maximum value OPEN_DOT1AD_SVID_MAX |
OPEN_E_NONE | If the service created |
OPEN_E_ERROR | If the service already exists |
OPEN_E_FULL | If maximum number of services already created |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OPEN_E_FAIL | All other failures. |
OpEN API Version: 1.7
open_error_t openapiDot1adServiceDelete | ( | openapiClientHandle_t * | client_handle, |
uint32_t | svid | ||
) |
To delete an existing DOT1AD service.
[in] | client_handle | Client handle from registration API |
[in] | svid | Service VLAN ID for the service |
- | Minimum value OPEN_DOT1AD_SVID_MIN | |
- | Maximum value OPEN_DOT1AD_SVID_MAX |
OPEN_E_NONE | If the service is deleted. |
OPEN_E_ERROR | If the service not exist. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OPEN_E_FAIL | All other failures. |
OpEN API Version: 1.7
open_error_t openapiDot1adServiceIndexGetFirst | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | serviceIndex | ||
) |
Get the First service index created in the system.
[in] | client_handle | Client handle from registration API |
[out] | serviceIndex | First service index valueX |
OPEN_E_NONE | If the first service ID is found. |
OPEN_E_ERROR | If no service have been created yet. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OPEN_E_FAIL | All other failures. |
OpEN API Version: 1.7
open_error_t openapiDot1adServiceIndexGetNext | ( | openapiClientHandle_t * | client_handle, |
uint32_t | serviceIndex, | ||
uint32_t * | next | ||
) |
Given serviceIndex, get the next service index.
[in] | client_handle | Client handle from registration API |
[in] | serviceIndex | The current service index |
- | Maximum value OPEN_DOT1AD_SERVICES_MAX | |
[out] | next | The next service index |
OPEN_E_NONE | If the next service index was found. |
OPEN_E_ERROR | If serviceIndex does not exist. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OPEN_E_FAIL | All other failures. |
OpEN API Version: 1.7
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.
[in] | subscrIndex | Subscription Index |
[in] | intIfNum | internal interface number |
[out] | matchCvid | Matching customer VLAN ID |
- | Minimum value OPEN_DOT1AD_CVID_MIN | |
- | Maximum value OPEN_DOT1AD_CVID_MAX |
OPEN_E_NONE | If Service VLAN ID is get successfully. |
OPEN_E_FAIL | Service VLAN ID is not get, or other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | subscrIndex | Subscription Index |
- | Maximum value OPEN_DOT1AD_SUBSCRIPTIONS_MAX | |
[in] | intIfNum | Internal interface number |
[out] | priority | Matching dot1p priority |
OPEN_E_NONE | If priority is get successfully. |
OPEN_E_FAIL | Priority is not get, or other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | subscrIndex | Subscription Index |
[in] | intIfNum | internal interface number |
[out] | matchSvid | Matching service VLAN ID |
- | Minimum value OPEN_DOT1AD_SVID_MIN | |
- | Maximum value OPEN_DOT1AD_SVID_MAX |
OPEN_E_NONE | If Service VLAN ID is get successfully. |
OPEN_E_FAIL | Service VLAN ID is not get, or other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | vlanId | Vlan id |
- | Minimum value OPEN_DOT1AD_MIN_VLAN_ID | |
- | Maximum value OPEN_DOT1AD_MAX_VLAN_ID | |
[out] | flag | Flag |
OPEN_E_NONE | Information is retrieved. |
OPEN_E_FAIL | Invalid parms, or other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
open_error_t openapiDot1adServiceNameAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | svid, | ||
open_buffdesc * | name | ||
) |
To add the name to this service.
[in] | client_handle | Client handle from registration API |
[in] | svid | Service VLAN ID |
- | Minimum value OPEN_DOT1AD_SVID_MIN | |
- | Maximum value OPEN_DOT1AD_SVID_MAX | |
[in] | name | Name of the service for the specified Service VLAN ID |
- | Minimum length OPEN_DOT1AD_SERVICE_NAME_LEN_MIN | |
- | Maximum length OPEN_DOT1AD_SERVICE_NAME_LEN_MAX |
OPEN_E_NONE | If name is added |
OPEN_E_ERROR | If the service does not exist. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OPEN_E_FAIL | All other failures. |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | svid | Service VLAN ID |
- | Minimum value OPEN_DOT1AD_SVID_MIN | |
- | Maximum value OPEN_DOT1AD_SVID_MAX | |
[out] | name | Name of the service for the specified Service VLAN ID |
OPEN_E_NONE | If service name is retrieved. |
OPEN_E_ERROR | If the specified service VLAN ID does not exist. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OPEN_E_FAIL | All other failures. |
OpEN API Version: 1.7
open_error_t openapiDot1adServiceNameStringCheck | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | name | ||
) |
Checks if the service name is a valid string.
[in] | client_handle | Client handle from registration API |
[in] | name | DOT1AD service name |
- | Minimum length OPEN_DOT1AD_SERVICE_NAME_LEN_MIN | |
- | Maximum length OPEN_DOT1AD_SERVICE_NAME_LEN_MAX |
OPEN_E_NONE | If the service name is valid. |
OPEN_E_FAIL | If the service name is invalid. |
OPEN_E_PARAM | If invalid parms, or other failure. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | name | Dot1ad service name |
- | Minimum length OPEN_DOT1AD_SERVICE_NAME_LEN_MIN | |
- | Maximum length OPEN_DOT1AD_SERVICE_NAME_LEN_MAX | |
[out] | svid | Device VLAN ID |
OPEN_E_NONE | If service instance index is retrieved. |
OPEN_E_ERROR | If service instance name does not exist. |
OPEN_E_PARAM | If invalid parms, or other failure. |
OPEN_E_INTERNAL | Internal error. |
OPEN_E_FAIL | All other failures. |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | intIfNum | Internal interface number |
[out] | removeCtag | Remove CTAG action. (OPEN_TRUE or OPEN_FALSE) |
OPEN_E_NONE | If action remove CTAG is get successfully. |
OPEN_E_FAIL | Action remove CTAG is not get, or other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | svid | Service VLAN ID. |
- | Minimum value OPEN_DOT1AD_SVID_MIN | |
- | Maximum value OPEN_DOT1AD_SVID_MAX | |
[out] | serviceType | Type of the DOT1AD Service. |
OPEN_E_NONE | Service Type is retrieved successfully. |
OPEN_E_ERROR | Service with specified service VLAN ID does not exist. |
OPEN_E_FAIL | Invalid service VLAN ID, or other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | svid | Service VLAN ID |
- | Minimum value OPEN_DOT1AD_SVID_MIN | |
- | Maximum value OPEN_DOT1AD_SVID_MAX | |
[in] | serviceType | Type of the DOT1AD Service |
- | Maximum value OPEN_DOT1AD_SERVICES_MAX |
OPEN_E_NONE | Service Type is set successfully. |
OPEN_E_ERROR | Service with specified service VLAN ID does not exist. |
OPEN_E_INTERNAL | Internal error. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_FAIL | All other failures. |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | vlanId | Vlan id |
- | Minimum value OPEN_DOT1AD_MIN_VLAN_ID | |
- | Maximum value OPEN_DOT1AD_MAX_VLAN_ID | |
[out] | flag | Flag |
OPEN_E_NONE | Information is retrieved |
OPEN_E_FAIL | Invalid parms, or other failure |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | intfIn | Internal interface number |
[in] | svidIn | DOT1AD service VLAN ID |
[in] | cvidIn | Customer VLAN ID |
[out] | intfOut | Next internal interface number |
[out] | svidOut | Next DOT1AD service VLAN ID |
[out] | cvidOut | Next customer VLAN ID |
OPEN_E_NONE | If the next subscribers entry was found |
OPEN_E_NOT_FOUND | If subscrEntry does not exist |
OPEN_E_FAIL | All other failures |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | intIfNum | Internal Interface number |
[in] | svid | Service VLAN ID of the given DOT1AD service |
- | Minimum value OPEN_DOT1AD_SVID_MIN | |
- | Maximum value OPEN_DOT1AD_SVID_MAX |
OPEN_E_NONE | If adding a subscription is successful. |
OPEN_E_UNAVAIL | If NNI interface list is specified at subscription level for service subscriptions whose service type is not E-LINE. |
OPEN_E_ERROR | If service with the specified service VLAN ID does not exist. |
OPEN_E_DISABLED | If hardware update failed. |
OPEN_E_FULL | If number of specified NNI interfaces is greater than the allowed number. |
OPEN_E_FAIL | For all other failures. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | intIfNum | Internal interface number |
[in] | svid | DOT1AD service VLAN ID |
- | Minimum value OPEN_DOT1AD_SVID_MIN | |
- | Maximum value OPEN_DOT1AD_SVID_MAX | |
[in] | cvid | Resulting customer VLAN ID. This is specified as part of assign-cvid or remark-cvid actions. |
- | Minimum value OPEN_DOT1AD_CVID_MIN | |
- | Maximum value OPEN_DOT1AD_CVID_MAX |
OPEN_E_NONE | If resulting customer VLAN ID is set successfully. |
OPEN_E_FAIL | Resulting customer VLAN ID is not set, or other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | intIfNum | Internal interface number |
[in] | svid | Service VLAN ID of the given DOT1AD service |
- | Minimum value OPEN_DOT1AD_SVID_MIN | |
- | Maximum value OPEN_DOT1AD_SVID_MAX | |
[in] | subscrName | Name of the DOT1AD service subscription |
- | Minimum length OPEN_DOT1AD_SERVICE_NAME_LEN_MIN | |
- | Maximum length OPEN_DOT1AD_SERVICE_NAME_LEN_MAX |
OPEN_E_NONE | If the DOT1AD service subscription is deleted. |
OPEN_E_FAIL | Invalid service identifier, all other failures. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | intfIn | Internal interface number |
[out] | intfOut | Next internal interface number |
[out] | svid | Next DOT1AD service VLAN ID |
[out] | cvid | Next customer VLAN ID |
OPEN_E_NONE | If the next subscribers entry was found |
OPEN_E_NOT_FOUND | If subscrEntry does not exist |
OPEN_E_FAIL | All other failures |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | intIfNum | Internal interface number |
[in] | svid | DOT1AD service VLAN ID |
- | Minimum value OPEN_DOT1AD_SVID_MIN | |
- | Maximum value OPEN_DOT1AD_SVID_MAX | |
[in] | matchCvid | Matching customer VLAN ID |
- | Minimum value OPEN_DOT1AD_CVID_MIN | |
- | Maximum value OPEN_DOT1AD_CVID_MAX |
OPEN_E_NONE | If customer VLAN ID is set successfully. |
OPEN_E_FAIL | customer VLAN ID is not set, or other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | intIfNum | Internal interface number |
[in] | svid | DOT1AD service VLAN ID |
- | Minimum value OPEN_DOT1AD_SVID_MIN | |
- | Maximum value OPEN_DOT1AD_SVID_MAX | |
[in] | priority | Matching dot1p priority |
OPEN_E_NONE | If priority is set successfully. |
OPEN_E_FAIL | Priority is not set, or other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | intIfNum | Internal interface number |
[in] | svid | DOT1AD service VLAN ID |
- | Minimum value OPEN_DOT1AD_SVID_MIN | |
- | Maximum value OPEN_DOT1AD_SVID_MAX | |
[in] | matchSvid | Matching service VLAN ID |
OPEN_E_NONE | If Service VLAN ID is set successfully. |
OPEN_E_FAIL | Service VLAN ID is not set, or other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | intIfNum | Internal interface number |
[in] | svid | Dot1ad service VLAN ID |
- | Minimum value OPEN_DOT1AD_SVID_MIN | |
- | Maximum value OPEN_DOT1AD_SVID_MAX | |
[in] | cvid | Customer VLAN ID |
- | Minimum value OPEN_DOT1AD_CVID_MIN | |
- | Maximum value OPEN_DOT1AD_CVID_MAX | |
[out] | name | Subscription name |
OPEN_E_NONE | If subscription name is get successfully. |
OPEN_E_FAIL | Subscription name not get, or other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | intIfNum | Internal interface number |
[in] | svid | DOT1AD service VLAN ID |
- | Minimum value OPEN_DOT1AD_SVID_MIN | |
- | Maximum value OPEN_DOT1AD_SVID_MAX | |
[in] | name | Subscription name |
- | Minimum length OPEN_DOT1AD_SERVICE_NAME_LEN_MIN | |
- | Maximum length OPEN_DOT1AD_SERVICE_NAME_LEN_MAX |
OPEN_E_NONE | If subscription name is set successfully |
OPEN_E_FAIL | Subscription name already exists, or other failure |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | intfIn | Internal interface number |
[out] | svidIn | DOT1AD service VLAN ID |
[out] | cvidIn | Customer VLAN ID |
[out] | intfOut | Next internal interface number |
[out] | svidOut | Next DOT1AD service VLAN ID |
[out] | cvidOut | Next customer VLAN ID |
OPEN_E_NONE | If the next subscribers entry was found |
OPEN_E_NOT_FOUND | If subscrEntry does not exist |
OPEN_E_FAIL | All other failures |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | subscrIndex | Subscription Index |
- | Maximum value OPEN_DOT1AD_SUBSCRIPTIONS_MAX | |
[in] | intIfNum | Internal interface number |
[out] | nniInfList | NNI Interface List |
[out] | nniIntfCnt | Count of NNI Interfaces |
OPEN_E_NONE | If NNI InterfaceList is retrieved successfully. |
OPEN_E_FAIL | NNI InterfaceList is not retrieved, or other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | intIfNum | Internal interface number |
[in] | svid | DOT1AD service VLAN ID |
- | Minimum value OPEN_DOT1AD_SVID_MIN | |
- | Maximum value OPEN_DOT1AD_SVID_MAX | |
[in] | nniIntfList | NNI Interface List. |
[in] | nniIntfCnt | Number of NNI interfaces specified in the nniIntfList. |
- | Maximum value is max physical port per unit / 6 |
OPEN_E_NONE | If NNI Interface List is added. |
OPEN_E_FAIL | If any one of the Interface in the specified nniIntfList is not NNI other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | intIfNum | Internal interface number |
[in] | svid | DOT1AD service VLAN ID |
- | Minimum value OPEN_DOT1AD_SVID_MIN | |
- | Maximum value OPEN_DOT1AD_SVID_MAX | |
[in] | cvid | Customer VLAN ID |
- | Minimum value OPEN_DOT1AD_CVID_MIN | |
- | Maximum value OPEN_DOT1AD_CVID_MAX | |
[out] | pktType | Matching Packet type |
OPEN_E_NONE | If Packet type is get successfully. |
OPEN_E_FAIL | Packet type is not get, or other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | intIfNum | Internal interface number |
[in] | svid | DOT1AD service VLAN ID |
- | Minimum value OPEN_DOT1AD_SVID_MIN | |
- | Maximum value OPEN_DOT1AD_SVID_MAX | |
[in] | pktType | Matching Packet type |
OPEN_E_NONE | If Packet type is set successfully. |
OPEN_E_FAIL | Packet type is not set, or other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
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.
[in] | client_handle | Client handle from registration API |
[in] | intIfNum | Internal interface number |
[in] | svid | DOT1AD service VLAN ID |
- | Minimum value OPEN_DOT1AD_SVID_MIN | |
- | Maximum value OPEN_DOT1AD_SVID_MAX | |
[in] | removeCtag | Remove CTAG flag (OPEN_TRUE or OPEN_FALSE) |
OPEN_E_NONE | If action remove CTAG is set successfully. |
OPEN_E_FAIL | Action remove CTAG is not set, or other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7
open_error_t openapiDot1adSubscriptionSvidSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intIfNum, | ||
uint32_t | svid | ||
) |
To set the Service VLAN ID for a DOT1AD subscription.
[in] | client_handle | Client handle from registration API |
[in] | intIfNum | Internal interface number |
[in] | svid | DOT1AD service VLAN ID |
- | Minimum value OPEN_DOT1AD_SVID_MIN | |
- | Maximum value OPEN_DOT1AD_SVID_MAX |
OPEN_E_NONE | If service VLAN ID is set successfully. |
OPEN_E_FAIL | service VLAN ID is not set, or other failure. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.7