Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Macros | Enumerations | Functions
QinQ Configuration And Status [OPENAPI_DOT1AD]

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...
 

Detailed Description

Enumeration Type Documentation

This enumerator is appointed to indicate interface type for a given configuration or status parameter.

Enumerator
OPEN_DOT1AD_INTERFACE_TYPE_UNI_P 

UNI port.

OPEN_DOT1AD_INTERFACE_TYPE_UNI_S 

Port based UNI port.

OPEN_DOT1AD_INTERFACE_TYPE_NNI 

Service based UNI port.

OPEN_DOT1AD_INTERFACE_TYPE_SWITCHPORT 

NNI port.

OPEN_DOT1AD_INTERFACE_TYPE_TOTAL 

Ordinary Switch Port.

Definition at line 85 of file openapi_dot1ad.h.

This enumerator is appointed to indicate packet type for a given configuration or status parameter.

Enumerator
OPEN_DOT1AD_PKTTYPE_UNTAGGED 

Match criteria is not defined.

OPEN_DOT1AD_PKTTYPE_PRIOTAGGED 

To match untagged packets.

OPEN_DOT1AD_PKTTYPE_TAGGED 

To match priority-tagged packets.

OPEN_DOT1AD_PKTTYPE_NO_STAG 

To match tagged packets.

OPEN_DOT1AD_PKTTYPE_NO_CTAG 

To match packets without service tag.

OPEN_DOT1AD_PKTTYPE_TOTAL 

To match packets without customer tag.

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.

Function Documentation

open_error_t openapiDot1adInterfacePreserveCvlanDot1pGet ( openapiClientHandle_t client_handle,
uint32_t  intIfNum,
OPEN_BOOL_t enable 
)

Get the Dot1ad interface's preserve CVLAN-dot1p property.

Parameters
[in]client_handleClient handle from registration API
[in]intIfNumInternal interface number
[out]enableOPEN_TRUE/OPEN_FALSE
Return values
OPEN_E_NONEIf success.
OPEN_E_FAILIf other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal 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.

Parameters
[in]client_handleClient handle from registration API
[in]intIfNumInternal interface number
[in]enableOPEN_TRUE/OPEN_FALSE
Return values
OPEN_E_NONEIf success.
OPEN_E_FAILIf other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal 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.

Parameters
[in]client_handleClient handle from registration API
[in]BasePortInternal interface number
[out]intfTypeDot1ad interface type
Return values
OPEN_E_NONEIf Dot1ad interface type is get successfully.
OPEN_E_FAILDot1ad interface type is not retrieved, or other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal error.

OpEN API Version: 1.7

Examples:
dot1ad_example.c.
open_error_t openapiDot1adInterfaceTypeSet ( openapiClientHandle_t client_handle,
uint32_t  basePort,
OPEN_DOT1AD_INTERFACE_TYPE_t  intfType 
)

Set the Dot1ad interface type.

Parameters
[in]client_handleClient handle from registration API
[in]basePortInternal interface number
[in]intfTypeDot1ad interface type
Return values
OPEN_E_NONEIf Dot1ad interface type is set successfully.
OPEN_E_FAILDot1ad interface type is not set, or other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal error.

OpEN API Version: 1.7

Examples:
dot1ad_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]intIfNumInternal interface number
[out]nextIntIfNumPointer to the next valid internal interface number
Return values
OPEN_E_NONEIf success.
OPEN_E_EXISTIf interface does not exist.
OPEN_E_FAILIf other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal 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.

Parameters
[in]client_handleClient handle from registration API
[in]svidservice index
-Minimum value OPEN_DOT1AD_SVID_MIN
-Maximum value OPEN_DOT1AD_SVID_MAX
[in]isolateVidisolated VLAN ID
-Minimum value OPEN_DOT1AD_MIN_VLAN_ID
-Maximum value OPEN_DOT1AD_MAX_VLAN_ID
Return values
OPEN_E_NONEIsolate VLAN ID is set.
OPEN_E_ERRORService does not exist.
OPEN_E_FAILService Type is not E-TREE, invalid vlanID, or other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal 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.

Parameters
[in]client_handleClient handle from registration API
[in]svidService VLAN ID of the given DOT1AD service.
-Minimum value OPEN_DOT1AD_SVID_MIN
-Maximum value OPEN_DOT1AD_SVID_MAX
[out]nniInfListNNI Interface List in form of comma separated internal interface numbers
Return values
OPEN_E_NONEIf NNI InterfaceList is retrieved successfully.
OPEN_E_ERRORIf Service with the specified service VLAN ID does not exist.
OPEN_E_FAILIf specified service VLAN ID is out of range or other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal error.
Note
Caller must provide a nniIntfList buffer of at least (255 + 1) characters.

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.

Parameters
[in]client_handleClient handle from registration API
[in]svidService VLAN ID of the given DOT1AD service
-Minimum value OPEN_DOT1AD_SVID_MIN
-Maximum value OPEN_DOT1AD_SVID_MAX
[in]nniInfListNNI Interface List in form of comma separated internal interface numbers
Return values
OPEN_E_NONEIf NNI Intf List is added.
OPEN_E_ERRORIf the service does not exist.
OPEN_E_FULLIf number of NNI interfaces specified is greater than the allowed number.
OPEN_E_FAILIf specified service VLAN ID is out of range or other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal error.

OpEN API Version: 1.7

Examples:
dot1ad_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]intIfNumInternal interface number
[in]svidDOT1AD service VLAN ID
-Minimum value OPEN_DOT1AD_SVID_MIN
-Maximum value OPEN_DOT1AD_SVID_MAX
Return values
OPEN_E_NONEIf current subscription is removed.
OPEN_E_FAILInvalid parms, or other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal 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.

Parameters
[in]client_handleClient handle from registration API
[in]intIfNumInternal interface number
[in]svidDOT1AD service VLAN ID
-Minimum value OPEN_DOT1AD_SVID_MIN
-Maximum value OPEN_DOT1AD_SVID_MAX
Return values
OPEN_E_NONEIf current subscription is reserved.
OPEN_E_FAILInvalid parms, or other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal error.

OpEN API Version: 1.7

open_error_t openapiDot1adServiceCreate ( openapiClientHandle_t client_handle,
uint32_t  svid 
)

To create a new DOT1AD service.

Parameters
[in]client_handleClient handle from registration API
[in]svidService VLAN ID for the service
-Minimum value OPEN_DOT1AD_SVID_MIN
-Maximum value OPEN_DOT1AD_SVID_MAX
Return values
OPEN_E_NONEIf the service created
OPEN_E_ERRORIf the service already exists
OPEN_E_FULLIf maximum number of services already created
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal error.
OPEN_E_FAILAll other failures.
Note
The service name must be set after the service is created.

OpEN API Version: 1.7

Examples:
dot1ad_example.c.
open_error_t openapiDot1adServiceDelete ( openapiClientHandle_t client_handle,
uint32_t  svid 
)

To delete an existing DOT1AD service.

Parameters
[in]client_handleClient handle from registration API
[in]svidService VLAN ID for the service
-Minimum value OPEN_DOT1AD_SVID_MIN
-Maximum value OPEN_DOT1AD_SVID_MAX
Return values
OPEN_E_NONEIf the service is deleted.
OPEN_E_ERRORIf the service not exist.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal error.
OPEN_E_FAILAll other failures.

OpEN API Version: 1.7

Examples:
dot1ad_example.c.
open_error_t openapiDot1adServiceIndexGetFirst ( openapiClientHandle_t client_handle,
uint32_t *  serviceIndex 
)

Get the First service index created in the system.

Parameters
[in]client_handleClient handle from registration API
[out]serviceIndexFirst service index valueX
Return values
OPEN_E_NONEIf the first service ID is found.
OPEN_E_ERRORIf no service have been created yet.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal error.
OPEN_E_FAILAll 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.

Parameters
[in]client_handleClient handle from registration API
[in]serviceIndexThe current service index
-Maximum value OPEN_DOT1AD_SERVICES_MAX
[out]nextThe next service index
Return values
OPEN_E_NONEIf the next service index was found.
OPEN_E_ERRORIf serviceIndex does not exist.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal error.
OPEN_E_FAILAll 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.

Parameters
[in]subscrIndexSubscription Index
[in]intIfNuminternal interface number
[out]matchCvidMatching customer VLAN ID
-Minimum value OPEN_DOT1AD_CVID_MIN
-Maximum value OPEN_DOT1AD_CVID_MAX
Return values
OPEN_E_NONEIf Service VLAN ID is get successfully.
OPEN_E_FAILService VLAN ID is not get, or other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal 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.

Parameters
[in]client_handleClient handle from registration API
[in]subscrIndexSubscription Index
-Maximum value OPEN_DOT1AD_SUBSCRIPTIONS_MAX
[in]intIfNumInternal interface number
[out]priorityMatching dot1p priority
Return values
OPEN_E_NONEIf priority is get successfully.
OPEN_E_FAILPriority is not get, or other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal 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.

Parameters
[in]client_handleClient handle from registration API
[in]subscrIndexSubscription Index
[in]intIfNuminternal interface number
[out]matchSvidMatching service VLAN ID
-Minimum value OPEN_DOT1AD_SVID_MIN
-Maximum value OPEN_DOT1AD_SVID_MAX
Return values
OPEN_E_NONEIf Service VLAN ID is get successfully.
OPEN_E_FAILService VLAN ID is not get, or other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal 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.

Parameters
[in]client_handleClient handle from registration API
[in]vlanIdVlan id
-Minimum value OPEN_DOT1AD_MIN_VLAN_ID
-Maximum value OPEN_DOT1AD_MAX_VLAN_ID
[out]flagFlag
Return values
OPEN_E_NONEInformation is retrieved.
OPEN_E_FAILInvalid parms, or other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal error.

OpEN API Version: 1.7

Examples:
dot1ad_example.c.
open_error_t openapiDot1adServiceNameAdd ( openapiClientHandle_t client_handle,
uint32_t  svid,
open_buffdesc name 
)

To add the name to this service.

Parameters
[in]client_handleClient handle from registration API
[in]svidService VLAN ID
-Minimum value OPEN_DOT1AD_SVID_MIN
-Maximum value OPEN_DOT1AD_SVID_MAX
[in]nameName 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
Return values
OPEN_E_NONEIf name is added
OPEN_E_ERRORIf the service does not exist.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal error.
OPEN_E_FAILAll other failures.

OpEN API Version: 1.7

Examples:
dot1ad_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]svidService VLAN ID
-Minimum value OPEN_DOT1AD_SVID_MIN
-Maximum value OPEN_DOT1AD_SVID_MAX
[out]nameName of the service for the specified Service VLAN ID
Return values
OPEN_E_NONEIf service name is retrieved.
OPEN_E_ERRORIf the specified service VLAN ID does not exist.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal error.
OPEN_E_FAILAll other failures.
Note
Caller must provide a name buffer of at least 32 characters.

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.

Parameters
[in]client_handleClient handle from registration API
[in]nameDOT1AD service name
-Minimum length OPEN_DOT1AD_SERVICE_NAME_LEN_MIN
-Maximum length OPEN_DOT1AD_SERVICE_NAME_LEN_MAX
Return values
OPEN_E_NONEIf the service name is valid.
OPEN_E_FAILIf the service name is invalid.
OPEN_E_PARAMIf invalid parms, or other failure.
OPEN_E_INTERNALInternal error.
Note
This function only checks the name string syntax for a service. It does not check if a service currently contains this name.

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.

Parameters
[in]client_handleClient handle from registration API
[in]nameDot1ad service name
-Minimum length OPEN_DOT1AD_SERVICE_NAME_LEN_MIN
-Maximum length OPEN_DOT1AD_SERVICE_NAME_LEN_MAX
[out]svidDevice VLAN ID
Return values
OPEN_E_NONEIf service instance index is retrieved.
OPEN_E_ERRORIf service instance name does not exist.
OPEN_E_PARAMIf invalid parms, or other failure.
OPEN_E_INTERNALInternal error.
OPEN_E_FAILAll other failures.

OpEN API Version: 1.7

Examples:
dot1ad_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]intIfNumInternal interface number
[out]removeCtagRemove CTAG action. (OPEN_TRUE or OPEN_FALSE)
Return values
OPEN_E_NONEIf action remove CTAG is get successfully.
OPEN_E_FAILAction remove CTAG is not get, or other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal 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.

Parameters
[in]client_handleClient handle from registration API
[in]svidService VLAN ID.
-Minimum value OPEN_DOT1AD_SVID_MIN
-Maximum value OPEN_DOT1AD_SVID_MAX
[out]serviceTypeType of the DOT1AD Service.
Return values
OPEN_E_NONEService Type is retrieved successfully.
OPEN_E_ERRORService with specified service VLAN ID does not exist.
OPEN_E_FAILInvalid service VLAN ID, or other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal 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.

Parameters
[in]client_handleClient handle from registration API
[in]svidService VLAN ID
-Minimum value OPEN_DOT1AD_SVID_MIN
-Maximum value OPEN_DOT1AD_SVID_MAX
[in]serviceTypeType of the DOT1AD Service
-Maximum value OPEN_DOT1AD_SERVICES_MAX
Return values
OPEN_E_NONEService Type is set successfully.
OPEN_E_ERRORService with specified service VLAN ID does not exist.
OPEN_E_INTERNALInternal error.
OPEN_E_PARAMError in parameter passed.
OPEN_E_FAILAll other failures.

OpEN API Version: 1.7

Examples:
dot1ad_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]vlanIdVlan id
-Minimum value OPEN_DOT1AD_MIN_VLAN_ID
-Maximum value OPEN_DOT1AD_MAX_VLAN_ID
[out]flagFlag
Return values
OPEN_E_NONEInformation is retrieved
OPEN_E_FAILInvalid parms, or other failure
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal error.

OpEN API Version: 1.7

Examples:
dot1ad_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]intfInInternal interface number
[in]svidInDOT1AD service VLAN ID
[in]cvidInCustomer VLAN ID
[out]intfOutNext internal interface number
[out]svidOutNext DOT1AD service VLAN ID
[out]cvidOutNext customer VLAN ID
Return values
OPEN_E_NONEIf the next subscribers entry was found
OPEN_E_NOT_FOUNDIf subscrEntry does not exist
OPEN_E_FAILAll 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.

Parameters
[in]client_handleClient handle from registration API
[in]intIfNumInternal Interface number
[in]svidService VLAN ID of the given DOT1AD service
-Minimum value OPEN_DOT1AD_SVID_MIN
-Maximum value OPEN_DOT1AD_SVID_MAX
Return values
OPEN_E_NONEIf adding a subscription is successful.
OPEN_E_UNAVAILIf NNI interface list is specified at subscription level for service subscriptions whose service type is not E-LINE.
OPEN_E_ERRORIf service with the specified service VLAN ID does not exist.
OPEN_E_DISABLEDIf hardware update failed.
OPEN_E_FULLIf number of specified NNI interfaces is greater than the allowed number.
OPEN_E_FAILFor all other failures.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal 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.

Parameters
[in]client_handleClient handle from registration API
[in]intIfNumInternal interface number
[in]svidDOT1AD service VLAN ID
-Minimum value OPEN_DOT1AD_SVID_MIN
-Maximum value OPEN_DOT1AD_SVID_MAX
[in]cvidResulting 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
Return values
OPEN_E_NONEIf resulting customer VLAN ID is set successfully.
OPEN_E_FAILResulting customer VLAN ID is not set, or other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal 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.

Parameters
[in]client_handleClient handle from registration API
[in]intIfNumInternal interface number
[in]svidService VLAN ID of the given DOT1AD service
-Minimum value OPEN_DOT1AD_SVID_MIN
-Maximum value OPEN_DOT1AD_SVID_MAX
[in]subscrNameName of the DOT1AD service subscription
-Minimum length OPEN_DOT1AD_SERVICE_NAME_LEN_MIN
-Maximum length OPEN_DOT1AD_SERVICE_NAME_LEN_MAX
Return values
OPEN_E_NONEIf the DOT1AD service subscription is deleted.
OPEN_E_FAILInvalid service identifier, all other failures.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal 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.

Parameters
[in]client_handleClient handle from registration API
[in]intfInInternal interface number
[out]intfOutNext internal interface number
[out]svidNext DOT1AD service VLAN ID
[out]cvidNext customer VLAN ID
Return values
OPEN_E_NONEIf the next subscribers entry was found
OPEN_E_NOT_FOUNDIf subscrEntry does not exist
OPEN_E_FAILAll 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.

Parameters
[in]client_handleClient handle from registration API
[in]intIfNumInternal interface number
[in]svidDOT1AD service VLAN ID
-Minimum value OPEN_DOT1AD_SVID_MIN
-Maximum value OPEN_DOT1AD_SVID_MAX
[in]matchCvidMatching customer VLAN ID
-Minimum value OPEN_DOT1AD_CVID_MIN
-Maximum value OPEN_DOT1AD_CVID_MAX
Return values
OPEN_E_NONEIf customer VLAN ID is set successfully.
OPEN_E_FAILcustomer VLAN ID is not set, or other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal 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.

Parameters
[in]client_handleClient handle from registration API
[in]intIfNumInternal interface number
[in]svidDOT1AD service VLAN ID
-Minimum value OPEN_DOT1AD_SVID_MIN
-Maximum value OPEN_DOT1AD_SVID_MAX
[in]priorityMatching dot1p priority
Return values
OPEN_E_NONEIf priority is set successfully.
OPEN_E_FAILPriority is not set, or other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal 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.

Parameters
[in]client_handleClient handle from registration API
[in]intIfNumInternal interface number
[in]svidDOT1AD service VLAN ID
-Minimum value OPEN_DOT1AD_SVID_MIN
-Maximum value OPEN_DOT1AD_SVID_MAX
[in]matchSvidMatching service VLAN ID
Return values
OPEN_E_NONEIf Service VLAN ID is set successfully.
OPEN_E_FAILService VLAN ID is not set, or other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal 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.

Parameters
[in]client_handleClient handle from registration API
[in]intIfNumInternal interface number
[in]svidDot1ad service VLAN ID
-Minimum value OPEN_DOT1AD_SVID_MIN
-Maximum value OPEN_DOT1AD_SVID_MAX
[in]cvidCustomer VLAN ID
-Minimum value OPEN_DOT1AD_CVID_MIN
-Maximum value OPEN_DOT1AD_CVID_MAX
[out]nameSubscription name
Return values
OPEN_E_NONEIf subscription name is get successfully.
OPEN_E_FAILSubscription name not get, or other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal 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.

Parameters
[in]client_handleClient handle from registration API
[in]intIfNumInternal interface number
[in]svidDOT1AD service VLAN ID
-Minimum value OPEN_DOT1AD_SVID_MIN
-Maximum value OPEN_DOT1AD_SVID_MAX
[in]nameSubscription name
-Minimum length OPEN_DOT1AD_SERVICE_NAME_LEN_MIN
-Maximum length OPEN_DOT1AD_SERVICE_NAME_LEN_MAX
Return values
OPEN_E_NONEIf subscription name is set successfully
OPEN_E_FAILSubscription name already exists, or other failure
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal 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.

Parameters
[in]client_handleClient handle from registration API
[in]intfInInternal interface number
[out]svidInDOT1AD service VLAN ID
[out]cvidInCustomer VLAN ID
[out]intfOutNext internal interface number
[out]svidOutNext DOT1AD service VLAN ID
[out]cvidOutNext customer VLAN ID
Return values
OPEN_E_NONEIf the next subscribers entry was found
OPEN_E_NOT_FOUNDIf subscrEntry does not exist
OPEN_E_FAILAll 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.

Parameters
[in]client_handleClient handle from registration API
[in]subscrIndexSubscription Index
-Maximum value OPEN_DOT1AD_SUBSCRIPTIONS_MAX
[in]intIfNumInternal interface number
[out]nniInfListNNI Interface List
[out]nniIntfCntCount of NNI Interfaces
Return values
OPEN_E_NONEIf NNI InterfaceList is retrieved successfully.
OPEN_E_FAILNNI InterfaceList is not retrieved, or other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal 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.

Parameters
[in]client_handleClient handle from registration API
[in]intIfNumInternal interface number
[in]svidDOT1AD service VLAN ID
-Minimum value OPEN_DOT1AD_SVID_MIN
-Maximum value OPEN_DOT1AD_SVID_MAX
[in]nniIntfListNNI Interface List.
[in]nniIntfCntNumber of NNI interfaces specified in the nniIntfList.
-Maximum value is max physical port per unit / 6
Return values
OPEN_E_NONEIf NNI Interface List is added.
OPEN_E_FAILIf any one of the Interface in the specified nniIntfList is not NNI other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal 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.

Parameters
[in]client_handleClient handle from registration API
[in]intIfNumInternal interface number
[in]svidDOT1AD service VLAN ID
-Minimum value OPEN_DOT1AD_SVID_MIN
-Maximum value OPEN_DOT1AD_SVID_MAX
[in]cvidCustomer VLAN ID
-Minimum value OPEN_DOT1AD_CVID_MIN
-Maximum value OPEN_DOT1AD_CVID_MAX
[out]pktTypeMatching Packet type
Return values
OPEN_E_NONEIf Packet type is get successfully.
OPEN_E_FAILPacket type is not get, or other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal 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.

Parameters
[in]client_handleClient handle from registration API
[in]intIfNumInternal interface number
[in]svidDOT1AD service VLAN ID
-Minimum value OPEN_DOT1AD_SVID_MIN
-Maximum value OPEN_DOT1AD_SVID_MAX
[in]pktTypeMatching Packet type
Return values
OPEN_E_NONEIf Packet type is set successfully.
OPEN_E_FAILPacket type is not set, or other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal 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.

Parameters
[in]client_handleClient handle from registration API
[in]intIfNumInternal interface number
[in]svidDOT1AD service VLAN ID
-Minimum value OPEN_DOT1AD_SVID_MIN
-Maximum value OPEN_DOT1AD_SVID_MAX
[in]removeCtagRemove CTAG flag (OPEN_TRUE or OPEN_FALSE)
Return values
OPEN_E_NONEIf action remove CTAG is set successfully.
OPEN_E_FAILAction remove CTAG is not set, or other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal 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.

Parameters
[in]client_handleClient handle from registration API
[in]intIfNumInternal interface number
[in]svidDOT1AD service VLAN ID
-Minimum value OPEN_DOT1AD_SVID_MIN
-Maximum value OPEN_DOT1AD_SVID_MAX
Return values
OPEN_E_NONEIf service VLAN ID is set successfully.
OPEN_E_FAILservice VLAN ID is not set, or other failure.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALInternal error.

OpEN API Version: 1.7