Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Data Structures | |
struct | OPEN_VLAN_LIST_t |
Macros | |
#define | OPEN_VLAN_LIST_MAX_ENTRIES 4096 |
VLAN list. | |
Enumerations | |
enum | OPEN_DOT1Q_PVLAN_PORT_TYPE_t { OPEN_PRIVATE_VLAN_UNCONFIGURED_PORT, OPEN_PRIVATE_VLAN_HOST_PORT, OPEN_PRIVATE_VLAN_COMMUNITY_PORT, OPEN_PRIVATE_VLAN_PROMISCOUS_PORT } |
enum | OPEN_DOT1Q_PVLAN_TYPE_t { OPEN_PRIVATE_VLAN_UNCONFIGURED = 0, OPEN_PRIVATE_VLAN_PRIMARY, OPEN_PRIVATE_VLAN_SECONDARY_ISOLATED, OPEN_PRIVATE_VLAN_SECONDARY_COMMUNITY } |
enum | OPEN_DOT1Q_SWPORT_MODE_t { OPEN_DOT1Q_SWPORT_MODE_NONE = 0, OPEN_DOT1Q_SWPORT_MODE_GENERAL = 1, OPEN_DOT1Q_SWPORT_MODE_ACCESS = 2, OPEN_DOT1Q_SWPORT_MODE_TRUNK = 3, OPEN_DOT1Q_SWPORT_MODE_PRIVATE_HOST = 4, OPEN_DOT1Q_SWPORT_MODE_PRIVATE_PROMISC = 5, OPEN_DOT1Q_SWPORT_MODE_PRIVATE_PROMISC_TRUNK = 6, OPEN_DOT1Q_SWPORT_MODE_PRIVATE_ISOLATED_TRUNK = 7 } |
Functions | |
open_error_t | openapiDot1qApiPrivateVlanAssocAdd (openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_VLAN_LIST_t vidList) |
Setup a VLAN bindings for private VLAN domain. More... | |
open_error_t | openapiDot1qApiPrivateVlanAssocRemove (openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_VLAN_LIST_t vidList) |
Remove VLAN bindings for private VLAN domain. More... | |
open_error_t | openapiDot1qIntfPVlanHostAssocSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t primary_vlan, uint32_t sec_vlan) |
Set VLAN bindings for private VLAN interface. More... | |
open_error_t | openapiDot1qIntfPVlanPromiscAssocSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t primary_vlan, OPEN_VLAN_LIST_t vidList) |
Set VLAN bindings for private VLAN interface. More... | |
open_error_t | openapiDot1qPrivateVlanAssociationGet (openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_VLAN_LIST_t *vidList) |
Get VLAN bindings for private VLAN domain. More... | |
open_error_t | openapiDot1qPrivateVlanEnable (openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_DOT1Q_PVLAN_TYPE_t pvlanType) |
Setup a VLAN as private VLAN. More... | |
open_error_t | openapiDot1qPrivateVlanGet (openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_DOT1Q_PVLAN_TYPE_t *pvlanType) |
Get the configured private VLAN type. More... | |
open_error_t | openapiDot1qPVlanIntfHostAssocRemove (openapiClientHandle_t *client_handle, uint32_t ifNum) |
Clear VLAN bindings for private VLAN interface. More... | |
open_error_t | openapiDot1qPVlanIntfPromiscAssocRemove (openapiClientHandle_t *client_handle, uint32_t ifNum) |
Clear VLAN bindings for private VLAN interface. More... | |
open_error_t | openapiDot1qSwPortAccessVlanGet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t *vlanId) |
Get the Access VLAN ID for a port. More... | |
open_error_t | openapiDot1qSwPortAccessVlanSet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t vlanId) |
Set the Access VLAN ID for a port. More... | |
open_error_t | openapiDot1qSwPortDynamicallyAddedVlanListGet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_VLAN_LIST_t *vidList) |
Get the dynamically added VLAN list for the interface when the interface is in general mode. More... | |
open_error_t | openapiDot1qSwPortForbiddenVlanListGet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_VLAN_LIST_t *vidList) |
Get the forbidden VLAN list for the interface when the interface is in general mode. More... | |
open_error_t | openapiDot1qSwPortModeGet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_DOT1Q_SWPORT_MODE_t *mode) |
Get the Switchport Configuration Mode for a port. More... | |
open_error_t | openapiDot1qSwPortModeSet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_DOT1Q_SWPORT_MODE_t mode) |
Set the Switchport Configuration Mode for a port. More... | |
open_error_t | openapiDot1qSwPortTaggedVlanListGet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_VLAN_LIST_t *vidList) |
Get the tagged VLAN list for the interface when the interface is in general mode. More... | |
open_error_t | openapiDot1qSwPortTrunkAllowedVlanListGet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_VLAN_LIST_t *vidList) |
Get the list of VLANs allowed on an interface when the interface is in trunking mode. More... | |
open_error_t | openapiDot1qSwPortTrunkAllowedVlanListSet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_VLAN_LIST_t *vidList) |
Set the list of VLANs allowed on an interface when the interface is in trunking mode. More... | |
open_error_t | openapiDot1qSwPortTrunkNativeVlanGet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t *vlanId) |
Get the Native VLAN ID for a port when in trunking mode. More... | |
open_error_t | openapiDot1qSwPortTrunkNativeVlanSet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t vlanId) |
Set the native VLAN ID for a port when in trunking mode. More... | |
open_error_t | openapiDot1qSwPortUntaggedVlanListGet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_VLAN_LIST_t *vidList) |
Get the untagged VLAN list for the interface when the interface is in general mode. More... | |
open_error_t | openapiPvlanIntfHostAssocGet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t *primaryVid, uint32_t *secondaryVid) |
Get the private VLAN association for a host mode interface. More... | |
open_error_t | openapiPvlanIntfIsolatedTrunkAssocNextGet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t primaryVid, uint32_t *nextPrimaryVid, uint32_t *secondaryVid) |
Get the next primary VLAN and any associated secondary VLAN for an isolated trunk interface in a private VLAN. More... | |
open_error_t | openapiPvlanIntfModeGet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_DOT1Q_SWPORT_MODE_t *mode) |
Get the private VLAN mode for an interface. More... | |
open_error_t | openapiPvlanIntfOperAssocGet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_VLAN_LIST_t *operationalVidList) |
Get the list of operational VLAN(s) for a private VLAN interface. More... | |
open_error_t | openapiPvlanIntfPromiscAssocGet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t *primaryVid, OPEN_VLAN_LIST_t *secondaryVidList) |
Get the private VLAN association for a promiscuous mode interface. More... | |
open_error_t | openapiPvlanIntfPromiscTrunkAssocNextGet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t primaryVid, uint32_t *nextPrimaryVid, OPEN_VLAN_LIST_t *secondaryVidList) |
Get the next primary VLAN and any associated secondary VLAN(s) for a promiscuous trunk interface in a private VLAN. More... | |
open_error_t | openapiPvlanIntfTrunkAllowedVlanListGet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_VLAN_LIST_t *normalVidList) |
Get the list of normal VLAN(s) carried by a promiscuous or isolated trunk interface in a private VLAN. More... | |
open_error_t | openapiPvlanIntfTrunkNativeVlanGet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t *nativeVid) |
Get the native VLAN for a promiscuous or isolated trunk interface in a private VLAN. More... | |
open_error_t | openapiVlanCreate (openapiClientHandle_t *client_handle, uint32_t vlanNum) |
Creates the VLAN with the ID specified on the switch. More... | |
open_error_t | openapiVlanCreatedCheck (openapiClientHandle_t *client_handle, uint32_t vlanNum) |
Test if the given VLAN has been configured on the switch. More... | |
open_error_t | openapiVlanDelete (openapiClientHandle_t *client_handle, uint32_t vlanNum) |
Deletes the VLAN with the ID specified on the switch. More... | |
open_error_t | openapiVlanIfAcceptFrameTypeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DOT1Q_ACCEPT_FRAME_TYPE_t *type) |
Get the Acceptable Frame Type configuration for a port. More... | |
open_error_t | openapiVlanIfAcceptFrameTypeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DOT1Q_ACCEPT_FRAME_TYPE_t type) |
Set the Acceptable Frame Type configuration for a port. More... | |
open_error_t | openapiVlanIfDefaultUserPriorityGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *priority) |
Gets an interface's default user priority. More... | |
open_error_t | openapiVlanIfDefaultUserPrioritySet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t priority) |
Sets an interface's default user priority. More... | |
open_error_t | openapiVlanIfNumTrafficClassesGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *numTrafficClasses) |
Gets an interface's number of traffic classes supported. More... | |
open_error_t | openapiVlanIfParticipationGet (openapiClientHandle_t *client_handle, uint32_t vlanNum, uint32_t ifNum, OPEN_VLAN_PARTICIPATION_MODE_t *participationMode) |
Gets an interface's configured participation mode for the specified VLAN. More... | |
open_error_t | openapiVlanIfParticipationSet (openapiClientHandle_t *client_handle, uint32_t vlanNum, uint32_t ifNum, OPEN_VLAN_PARTICIPATION_MODE_t participationMode) |
Sets an interface's participation mode configuration for the specified VLAN. More... | |
open_error_t | openapiVlanIfParticipationStatusGet (openapiClientHandle_t *client_handle, uint32_t vlanNum, uint32_t ifNum, uint32_t *participating) |
Gets an interface's participation status for the specified VLAN. More... | |
open_error_t | openapiVlanIfPvidGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *vlanNum) |
Gets an interface's PVID. More... | |
open_error_t | openapiVlanIfPvidSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t vlanNum) |
Sets an interface's VLAN ID (PVID). More... | |
open_error_t | openapiVlanIfTaggingGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t vlanNum, OPEN_CONTROL_t *tagging) |
Gets an interface's tagging setting for the specified VLAN. More... | |
open_error_t | openapiVlanIfTaggingSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t vlanNum, OPEN_CONTROL_t tagging) |
Sets an interface's tagging mode for the given VLAN. More... | |
int | openapiVlanIsStatic (openapiClientHandle_t *client_handle, uint32_t vlanNum) |
Returns whether the VLAN is static. More... | |
open_error_t | openapiVlanNameGet (openapiClientHandle_t *client_handle, uint32_t vlanNum, open_buffdesc *vlanName) |
Gets the VLAN Name. More... | |
open_error_t | openapiVlanNameLenGet (openapiClientHandle_t *client_handle, uint32_t *strLen) |
Gets the VLAN Name string length. More... | |
open_error_t | openapiVlanNameSet (openapiClientHandle_t *client_handle, uint32_t vlanNum, open_buffdesc *vlanName) |
Configures a VLAN Name. More... | |
open_error_t | openapiVlanNextChangedGet (openapiClientHandle_t *client_handle, uint32_t vlanNum, uint32_t *nextVlanNum, uint32_t *delete_pending) |
Gets the next VLAN which has a pending change or a pending deletion. More... | |
open_error_t | openapiVlanNextGet (openapiClientHandle_t *client_handle, uint32_t vlanNum, uint32_t *nextVlanNum) |
Gets the next VLAN number that has been configured on the switch. More... | |
Definition at line 47 of file openapi_vlan.h.
open_error_t openapiDot1qApiPrivateVlanAssocAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | vlanId, | ||
OPEN_VLAN_LIST_t | vidList | ||
) |
Setup a VLAN bindings for private VLAN domain.
[in] | client_handle | client handle from registration API |
[in] | vlanId | VLAN ID |
[in] | vidList | Secondary VLAN list |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiDot1qApiPrivateVlanAssocRemove | ( | openapiClientHandle_t * | client_handle, |
uint32_t | vlanId, | ||
OPEN_VLAN_LIST_t | vidList | ||
) |
Remove VLAN bindings for private VLAN domain.
[in] | client_handle | client handle from registration API |
[in] | vlanId | VLAN ID |
[in] | vidList | Secondary VLAN list |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiDot1qIntfPVlanHostAssocSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t | primary_vlan, | ||
uint32_t | sec_vlan | ||
) |
Set VLAN bindings for private VLAN interface.
[in] | client_handle | client handle from registration API |
[in] | ifNum | internal interface number |
[in] | primary_vlan | primary VLAN ID |
[in] | sec_vlan | Secondary VLAN ID |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiDot1qIntfPVlanPromiscAssocSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t | primary_vlan, | ||
OPEN_VLAN_LIST_t | vidList | ||
) |
Set VLAN bindings for private VLAN interface.
[in] | client_handle | client handle from registration API |
[in] | ifNum | internal interface number |
[in] | primary_vlan | primary VLAN ID |
[in] | vidList | Secondary VLAN ID List |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiDot1qPrivateVlanAssociationGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | vlanId, | ||
OPEN_VLAN_LIST_t * | vidList | ||
) |
Get VLAN bindings for private VLAN domain.
[in] | client_handle | client handle from registration API |
[in] | vlanId | VLAN ID |
[out] | vidList | Secondary VLAN list |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiDot1qPrivateVlanEnable | ( | openapiClientHandle_t * | client_handle, |
uint32_t | vlanId, | ||
OPEN_DOT1Q_PVLAN_TYPE_t | pvlanType | ||
) |
Setup a VLAN as private VLAN.
[in] | client_handle | client handle from registration API |
[in] | vlanId | VLAN ID |
[in] | pvlanType | private VLAN type |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiDot1qPrivateVlanGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | vlanId, | ||
OPEN_DOT1Q_PVLAN_TYPE_t * | pvlanType | ||
) |
Get the configured private VLAN type.
[in] | client_handle | client handle from registration API |
[in] | vlanId | VLAN ID |
[out] | pvlanType | private VLAN type |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiDot1qPVlanIntfHostAssocRemove | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum | ||
) |
Clear VLAN bindings for private VLAN interface.
[in] | client_handle | client handle from registration API |
[in] | ifNum | internal interface number |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiDot1qPVlanIntfPromiscAssocRemove | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum | ||
) |
Clear VLAN bindings for private VLAN interface.
[in] | client_handle | client handle from registration API |
[in] | ifNum | internal interface number |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiDot1qSwPortAccessVlanGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
uint32_t * | vlanId | ||
) |
Get the Access VLAN ID for a port.
[in] | client_handle | Client handle from registration API |
[in] | intf | Interface Number |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[out] | vlanId | Storage for VLAN ID |
OPEN_E_NONE | if Access VLAN get is successful. |
OPEN_E_FAIL | if Access VLAN get failed. |
OPEN_E_PARAM | invalid parameter(s) |
OpEN API Version: 1.11
open_error_t openapiDot1qSwPortAccessVlanSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
uint32_t | vlanId | ||
) |
Set the Access VLAN ID for a port.
[in] | client_handle | Client handle from registration API |
[in] | intf | Interface Number |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[in] | vlanId | VLAN ID to be set |
OPEN_E_NONE | if Access VLAN set is successful. |
OPEN_E_FAIL | if Access VLAN set failed. |
OPEN_E_PARAM | invalid parameter(s) |
OpEN API Version: 1.11
open_error_t openapiDot1qSwPortDynamicallyAddedVlanListGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
OPEN_VLAN_LIST_t * | vidList | ||
) |
Get the dynamically added VLAN list for the interface when the interface is in general mode.
[in] | client_handle | Client handle from registration API |
[in] | intf | Interface Number |
[out] | vidList | VLAN ID List |
OPEN_E_NONE | if Dynamically Added VLAN list get is successful. |
OPEN_E_FAIL | if Dynamically Added VLAN list get failed. |
OPEN_E_PARAM | invalid parameter(s) |
OpEN API Version: 1.11
open_error_t openapiDot1qSwPortForbiddenVlanListGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
OPEN_VLAN_LIST_t * | vidList | ||
) |
Get the forbidden VLAN list for the interface when the interface is in general mode.
[in] | client_handle | Client handle from registration API |
[in] | intf | Interface Number |
[out] | vidList | VLAN ID List |
OPEN_E_NONE | if Forbidden VLAN list get is successful. |
OPEN_E_FAIL | if Forbidden VLAN list get failed. |
OPEN_E_PARAM | invalid parameter(s) |
OpEN API Version: 1.11
open_error_t openapiDot1qSwPortModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
OPEN_DOT1Q_SWPORT_MODE_t * | mode | ||
) |
Get the Switchport Configuration Mode for a port.
[in] | client_handle | Client handle from registration API |
[in] | intf | Interface Number |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[out] | mode | Switchport Mode |
OPEN_E_NONE | if Switchport Mode get is successful. |
OPEN_E_FAIL | if Switchport Mode get failed. |
OPEN_E_PARAM | invalid parameter(s) |
OpEN API Version: 1.11
open_error_t openapiDot1qSwPortModeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
OPEN_DOT1Q_SWPORT_MODE_t | mode | ||
) |
Set the Switchport Configuration Mode for a port.
[in] | client_handle | Client handle from registration API |
[in] | intf | Interface Number |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[in] | mode | New Switchport Mode to be set |
OPEN_E_NONE | if Switchport Mode set is successful. |
OPEN_E_FAIL | if Switchport Mode set failed. |
OPEN_E_PARAM | invalid parameter(s) |
OpEN API Version: 1.11
open_error_t openapiDot1qSwPortTaggedVlanListGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
OPEN_VLAN_LIST_t * | vidList | ||
) |
Get the tagged VLAN list for the interface when the interface is in general mode.
[in] | client_handle | Client handle from registration API |
[in] | intf | Interface Number |
[out] | vidList | VLAN ID List |
OPEN_E_NONE | if Tagged VLAN list get is successful. |
OPEN_E_FAIL | if Tagged VLAN list get failed. |
OPEN_E_PARAM | invalid parameter(s) |
OpEN API Version: 1.11
open_error_t openapiDot1qSwPortTrunkAllowedVlanListGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
OPEN_VLAN_LIST_t * | vidList | ||
) |
Get the list of VLANs allowed on an interface when the interface is in trunking mode.
[in] | client_handle | Client handle from registration API |
[in] | intf | Interface Number |
[out] | vidList | VLAN ID List |
OPEN_E_NONE | if Allowed VLAN list get is successful. |
OPEN_E_FAIL | if Allowed VLAN list get failed. |
OPEN_E_PARAM | invalid parameter(s) |
OpEN API Version: 1.11
open_error_t openapiDot1qSwPortTrunkAllowedVlanListSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
OPEN_VLAN_LIST_t * | vidList | ||
) |
Set the list of VLANs allowed on an interface when the interface is in trunking mode.
[in] | client_handle | Client handle from registration API |
[in] | intf | Interface Number |
[in] | vidList | VLAN ID List |
OPEN_E_NONE | if Allowed VLAN list set is successful. |
OPEN_E_FAIL | if Allowed VLAN list set failed. |
OPEN_E_PARAM | invalid parameter(s) |
OpEN API Version: 1.11
open_error_t openapiDot1qSwPortTrunkNativeVlanGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
uint32_t * | vlanId | ||
) |
Get the Native VLAN ID for a port when in trunking mode.
[in] | client_handle | Client handle from registration API |
[in] | intf | Interface Number |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[out] | vlanId | Storage space for the VLAN ID |
OPEN_E_NONE | if Native VLAN get is successful. |
OPEN_E_FAIL | if Native VLAN get failed. |
OPEN_E_PARAM | invalid parameter(s) |
OpEN API Version: 1.11
open_error_t openapiDot1qSwPortTrunkNativeVlanSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
uint32_t | vlanId | ||
) |
Set the native VLAN ID for a port when in trunking mode.
[in] | client_handle | Client handle from registration API |
[in] | intf | Interface Number |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[in] | vlanId | VLAN ID to be set |
OPEN_E_NONE | if native VLAN set is successful. |
OPEN_E_FAIL | if native VLAN set failed. |
OPEN_E_PARAM | invalid parameter(s) |
OPEN_E_DISABLED | when specified VLAN is not in allowed VLAN list |
OpEN API Version: 1.11
open_error_t openapiDot1qSwPortUntaggedVlanListGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
OPEN_VLAN_LIST_t * | vidList | ||
) |
Get the untagged VLAN list for the interface when the interface is in general mode.
[in] | client_handle | Client handle from registration API |
[in] | intf | Interface Number |
[out] | vidList | VLAN ID List |
OPEN_E_NONE | if Untagged VLAN list get is successful. |
OPEN_E_FAIL | if Untagged VLAN list get failed. |
OPEN_E_PARAM | invalid parameter(s) |
OpEN API Version: 1.11
open_error_t openapiPvlanIntfHostAssocGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
uint32_t * | primaryVid, | ||
uint32_t * | secondaryVid | ||
) |
Get the private VLAN association for a host mode interface.
[in] | client_handle | Client handle from registration API |
[in] | intf | Interface Number |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[out] | primaryVid | Primary VLAN ID of the Private VLAN |
[out] | secondaryVid | Secondary VLAN ID of the Private VLAN |
OPEN_E_NONE | Host mode PVLAN bindings get successful. |
OPEN_E_FAIL | Host mode PVLAN bindings get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.18
open_error_t openapiPvlanIntfIsolatedTrunkAssocNextGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
uint32_t | primaryVid, | ||
uint32_t * | nextPrimaryVid, | ||
uint32_t * | secondaryVid | ||
) |
Get the next primary VLAN and any associated secondary VLAN for an isolated trunk interface in a private VLAN.
[in] | client_handle | Client handle from registration API |
[in] | intf | Interface Number |
[in] | primaryVid | Primary VLAN ID to begin search |
[out] | nextPrimaryVid | Next Primary VLAN ID associated with this trunk |
[out] | secondaryVid | Secondary VLAN ID that is mapped to the next primary VLAN ID |
OPEN_E_NONE | Isolated trunk association next get successful. |
OPEN_E_FAIL | Isolated trunk association next get failed. |
OPEN_E_NOT_FOUND | No more instances available. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.18
open_error_t openapiPvlanIntfModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
OPEN_DOT1Q_SWPORT_MODE_t * | mode | ||
) |
Get the private VLAN mode for an interface.
[in] | client_handle | Client handle from registration API |
[in] | intf | Interface Number |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[out] | mode | Private VLAN Mode |
OPEN_E_NONE | PVLAN mode get successful. |
OPEN_E_FAIL | PVLAN mode get failed. |
OPEN_E_NOT_FOUND | Interface not configured as a PVLAN. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.18
open_error_t openapiPvlanIntfOperAssocGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
OPEN_VLAN_LIST_t * | operationalVidList | ||
) |
Get the list of operational VLAN(s) for a private VLAN interface.
[in] | client_handle | Client handle from registration API |
[in] | intf | Interface Number |
[out] | operationalVidList | Operational VLAN ID List carried by PVLAN trunk |
OPEN_E_NONE | Operational VLAN list get successful. |
OPEN_E_FAIL | Operational VLAN list get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.18
open_error_t openapiPvlanIntfPromiscAssocGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
uint32_t * | primaryVid, | ||
OPEN_VLAN_LIST_t * | secondaryVidList | ||
) |
Get the private VLAN association for a promiscuous mode interface.
[in] | client_handle | Client handle from registration API |
[in] | intf | Interface Number |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[out] | primaryVid | Primary VLAN ID of the Private VLAN |
[out] | secondaryVidList | Secondary VLAN ID List that is mapped to primary VLAN ID |
OPEN_E_NONE | Promiscuous mode PVLAN bindings get successful. |
OPEN_E_FAIL | Promiscuous mode PVLAN bindings get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.18
open_error_t openapiPvlanIntfPromiscTrunkAssocNextGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
uint32_t | primaryVid, | ||
uint32_t * | nextPrimaryVid, | ||
OPEN_VLAN_LIST_t * | secondaryVidList | ||
) |
Get the next primary VLAN and any associated secondary VLAN(s) for a promiscuous trunk interface in a private VLAN.
[in] | client_handle | Client handle from registration API |
[in] | intf | Interface Number |
[in] | primaryVid | Primary VLAN ID to begin search |
[out] | nextPrimaryVid | Next Primary VLAN ID associated with this trunk |
[out] | secondaryVidList | Secondary VLAN ID List that is mapped to next primary VLAN ID |
OPEN_E_NONE | Promiscuous trunk association next get successful. |
OPEN_E_FAIL | Promiscuous trunk association next get failed. |
OPEN_E_NOT_FOUND | No more instances available. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.18
open_error_t openapiPvlanIntfTrunkAllowedVlanListGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
OPEN_VLAN_LIST_t * | normalVidList | ||
) |
Get the list of normal VLAN(s) carried by a promiscuous or isolated trunk interface in a private VLAN.
[in] | client_handle | Client handle from registration API |
[in] | intf | Interface Number |
[out] | normalVidList | Normal VLAN ID List carried by PVLAN trunk |
OPEN_E_NONE | PVLAN trunk normal VLAN list get successful. |
OPEN_E_FAIL | PVLAN trunk normal VLAN list get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.18
open_error_t openapiPvlanIntfTrunkNativeVlanGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
uint32_t * | nativeVid | ||
) |
Get the native VLAN for a promiscuous or isolated trunk interface in a private VLAN.
[in] | client_handle | Client handle from registration API |
[in] | intf | Interface Number |
[out] | nativeVid | Native VLAN ID |
OPEN_E_NONE | PVLAN trunk native VLAN get successful. |
OPEN_E_FAIL | PVLAN trunk native VLAN get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.18
open_error_t openapiVlanCreate | ( | openapiClientHandle_t * | client_handle, |
uint32_t | vlanNum | ||
) |
Creates the VLAN with the ID specified on the switch.
[in] | client_handle | client handle from registration API |
[in] | vlanNum | VLAN ID. |
OPEN_E_NONE | The VLAN was successfully created. |
OPEN_E_FAIL | The VLAN was not successfully created. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiVlanCreatedCheck | ( | openapiClientHandle_t * | client_handle, |
uint32_t | vlanNum | ||
) |
Test if the given VLAN has been configured on the switch.
[in] | client_handle | client handle from registration API |
[in] | vlanNum | VLAN ID. |
OPEN_E_NONE | The VLAN is configured. |
OPEN_E_FAIL | The VLAN is not configured. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiVlanDelete | ( | openapiClientHandle_t * | client_handle, |
uint32_t | vlanNum | ||
) |
Deletes the VLAN with the ID specified on the switch.
[in] | client_handle | client handle from registration API |
[in] | vlanNum | VLAN ID. |
OPEN_E_NONE | The VLAN was successfully deleted. |
OPEN_E_FAIL | The VLAN was not successfully deleted. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiVlanIfAcceptFrameTypeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_DOT1Q_ACCEPT_FRAME_TYPE_t * | type | ||
) |
Get the Acceptable Frame Type configuration for a port.
[in] | client_handle | client handle from registration API |
[in] | ifNum | physical or logical interface to be configured |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[out] | type | Frame type |
OPEN_E_NONE | Frame type was successfully retrieved. |
OPEN_E_FAIL | Frame type was not successfully retrieved. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiVlanIfAcceptFrameTypeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_DOT1Q_ACCEPT_FRAME_TYPE_t | type | ||
) |
Set the Acceptable Frame Type configuration for a port.
[in] | client_handle | client handle from registration API |
[in] | ifNum | physical or logical interface to be configured |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[in] | type | Frame Type |
OPEN_E_NONE | Success |
OPEN_E_FAIL | Frame type not set |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiVlanIfDefaultUserPriorityGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | priority | ||
) |
Gets an interface's default user priority.
This is the priority assigned to packets received untagged.
[in] | client_handle | client handle from registration API |
[in] | ifNum | Interface ID |
[out] | priority | Priority assigned to packets. |
OPEN_E_NONE | Port default priority was successfully retrieved. |
OPEN_E_FAIL | Port default priority was not successfully retrieved. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.14
open_error_t openapiVlanIfDefaultUserPrioritySet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t | priority | ||
) |
Sets an interface's default user priority.
This is the priority assigned to packets received untagged.
[in] | client_handle | client handle from registration API |
[in] | ifNum | Interface ID |
[in] | priority | Priority assigned to packets. Acceptable |
- | Minimum value 0 | |
- | Maximum value openapiVlanIfNumTrafficClassesGet() - 1 |
OPEN_E_NONE | Port default priority was successfully set. |
OPEN_E_FAIL | Port default priority was not successfully set. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.14
open_error_t openapiVlanIfNumTrafficClassesGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | numTrafficClasses | ||
) |
Gets an interface's number of traffic classes supported.
[in] | client_handle | client handle from registration API |
[in] | ifNum | Interface ID |
[out] | numTrafficClasses | number of traffic classes |
OPEN_E_NONE | Number of traffic classes was successfully retrieved. |
OPEN_E_FAIL | Number of traffic classes was not successfully retrieved. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.14
open_error_t openapiVlanIfParticipationGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | vlanNum, | ||
uint32_t | ifNum, | ||
OPEN_VLAN_PARTICIPATION_MODE_t * | participationMode | ||
) |
Gets an interface's configured participation mode for the specified VLAN.
[in] | client_handle | client handle from registration API |
[in] | vlanNum | VLAN ID |
[in] | ifNum | Interface ID |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[out] | participationMode | Mode of participation |
OPEN_E_NONE | Participation mode was successfully deleted. |
OPEN_E_FAIL | Participation mode was not successfully deleted. |
OPEN_E_NOT_FOUND | The VLAN specified is not created. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiVlanIfParticipationSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | vlanNum, | ||
uint32_t | ifNum, | ||
OPEN_VLAN_PARTICIPATION_MODE_t | participationMode | ||
) |
Sets an interface's participation mode configuration for the specified VLAN.
[in] | client_handle | client handle from registration API |
[in] | vlanNum | VLAN ID |
[in] | ifNum | Interface ID |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[in] | participationMode | Mode of participation |
OPEN_E_NONE | Participation mode was successfully set. |
OPEN_E_FAIL | Participation mode was not successfully set. |
OPEN_E_UNAVAIL | Setting participation mode not valid for the specified interface. |
OPEN_E_NOT_FOUND | The VLAN specified is not created. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiVlanIfParticipationStatusGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | vlanNum, | ||
uint32_t | ifNum, | ||
uint32_t * | participating | ||
) |
Gets an interface's participation status for the specified VLAN.
[in] | client_handle | client handle from registration API |
[in] | vlanNum | VLAN ID |
[in] | ifNum | Interface ID |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[out] | participating | 1 if participating, 0 if not |
OPEN_E_NONE | Participation status was successfully retrieved. |
OPEN_E_FAIL | Participation status was not successfully retrieved. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiVlanIfPvidGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | vlanNum | ||
) |
Gets an interface's PVID.
[in] | client_handle | client handle from registration API |
[in] | ifNum | Interface ID |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[out] | vlanNum | VLAN ID |
OPEN_E_NONE | PVID was successfully retrieved. |
OPEN_E_FAIL | PVID was not successfully retrieved. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiVlanIfPvidSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t | vlanNum | ||
) |
Sets an interface's VLAN ID (PVID).
[in] | client_handle | client handle from registration API |
[in] | ifNum | Interface ID |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[in] | vlanNum | VLAN ID |
OPEN_E_NONE | PVID was successfully set. |
OPEN_E_FAIL | PVID was not successfully set. |
OPEN_E_UNAVAIL | Setting PVID not valid for the specified interface. |
OPEN_E_NOT_FOUND | The VLAN specified is not created. |
OpEN API Version: 1.1
open_error_t openapiVlanIfTaggingGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t | vlanNum, | ||
OPEN_CONTROL_t * | tagging | ||
) |
Gets an interface's tagging setting for the specified VLAN.
[in] | client_handle | client handle from registration API |
[in] | ifNum | Interface ID |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[in] | vlanNum | VLAN ID |
[out] | tagging | OPEN_ENABLE if port is sending tagged packets on the VLAN |
OPEN_E_NONE | PVID was successfully retrieved. |
OPEN_E_FAIL | PVID was not successfully retrieved. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiVlanIfTaggingSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t | vlanNum, | ||
OPEN_CONTROL_t | tagging | ||
) |
Sets an interface's tagging mode for the given VLAN.
[in] | client_handle | client handle from registration API |
[in] | ifNum | Interface ID |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[in] | vlanNum | VLAN ID |
[in] | tagging | VLAN tagging |
OPEN_E_NONE | Tagging mode was successfully set. |
OPEN_E_FAIL | Tagging mode was not successfully set. |
OPEN_E_UNAVAIL | Setting tagging mode not valid for the specified interface. |
OPEN_E_NOT_FOUND | The VLAN specified is not created. |
OpEN API Version: 1.1
int openapiVlanIsStatic | ( | openapiClientHandle_t * | client_handle, |
uint32_t | vlanNum | ||
) |
Returns whether the VLAN is static.
[in] | client_handle | client handle from registration API |
[in] | vlanNum | VLAN ID. |
OpEN API Version: 1.1
open_error_t openapiVlanNameGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | vlanNum, | ||
open_buffdesc * | vlanName | ||
) |
Gets the VLAN Name.
[in] | client_handle | client handle from registration API |
[in] | vlanNum | VLAN ID |
[out] | vlanName | VLAN name |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiVlanNameLenGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | strLen | ||
) |
Gets the VLAN Name string length.
This length is used to allocate and initialize the open_buffdesc type argument buffers used by various VLAN OpEN APIs.
[in] | client_handle | client handle from registration API |
[out] | strLen | string length |
OPEN_E_NONE | String length Get successful. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiVlanNameSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | vlanNum, | ||
open_buffdesc * | vlanName | ||
) |
Configures a VLAN Name.
[in] | client_handle | client handle from registration API |
[in] | vlanNum | VLAN ID |
[in] | vlanName | VLAN name Populate vlanName:pstart and size with a char buffer containing the VLAN name |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.1
open_error_t openapiVlanNextChangedGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | vlanNum, | ||
uint32_t * | nextVlanNum, | ||
uint32_t * | delete_pending | ||
) |
Gets the next VLAN which has a pending change or a pending deletion.
[in] | client_handle | client handle from registration API |
[in] | vlanNum | ID of the current VLAN ID |
[out] | nextVlanNum | Storage for the returned VLAN ID |
[out] | delete_pending | Flag Indicating that the VLAN is pending for deletion. |
OPEN_E_NONE | The next VLAN of the specified type returned. |
OPEN_E_FAIL | No next VLAN of the specified type was found. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiVlanNextGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | vlanNum, | ||
uint32_t * | nextVlanNum | ||
) |
Gets the next VLAN number that has been configured on the switch.
Call with vlanNum set to 0 to get the first VLAN.
[in] | client_handle | client handle from registration API |
[in] | vlanNum | Current VLAN ID. |
[out] | nextVlanNum | Next VLAN ID, if one exists. |
OPEN_E_NONE | The next VLAN ID returned. |
OPEN_E_FAIL | No next VLAN ID was found. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1