Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Macros | |
#define | OPEN_LAG_MEMBER_BUFFER_SIZE (sizeof(uint32_t) * OPEN_MAX_MEMBERS_PER_LAG) |
#define | OPEN_MAX_MEMBERS_PER_LAG 32 |
Enumerations | |
enum | OPEN_DOT3AD_STATE_TYPE_t { OPEN_DOT3AD_STATE_AGGREGATION = 0, OPEN_DOT3AD_STATE_LACP_TIMEOUT = 1, OPEN_DOT3AD_STATE_LACP_ACTIVITY = 2 } |
OpEN uses these enumerations to indicate DOT3AD state types. More... | |
enum | OPEN_LAG_HASH_MODE_t { OPEN_LAG_HASHING_MODE_SA_VLAN = 0, OPEN_LAG_HASHING_MODE_DA_VLAN = 1, OPEN_LAG_HASHING_MODE_SDA_VLAN = 2, OPEN_LAG_HASHING_MODE_SIP_SPORT = 3, OPEN_LAG_HASHING_MODE_DIP_DPORT = 4, OPEN_LAG_HASHING_MODE_SDIP_DPORT = 5, OPEN_LAG_HASHING_MODE_ENHANCED = 6 } |
Hash Mode names. More... | |
Functions | |
open_error_t | openapiDot3adAggPortActorAdminStateGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DOT3AD_STATE_TYPE_t type, OPEN_CONTROL_t *state) |
Gets the LACP actor admin state. More... | |
open_error_t | openapiDot3adAggPortActorAdminStateSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DOT3AD_STATE_TYPE_t type, OPEN_CONTROL_t mode) |
Sets the LACP actor admin state. More... | |
open_error_t | openapiDot3adAggPortLacpModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *lacpMode) |
Gets the LACP mode of the physical interface. More... | |
open_error_t | openapiDot3adAggPortLacpModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t lacpMode) |
Sets the LACP mode of the physical interface. More... | |
open_error_t | openapiLagActiveMembersGet (openapiClientHandle_t *client_handle, uint32_t lagIfNum, uint32_t *count, open_buffdesc *bufd) |
Gets the list of active member ports for the LAG interface. More... | |
open_error_t | openapiLagActiveMembersListGet (openapiClientHandle_t *client_handle, uint32_t lagIfNum, uint32_t *count, open_buffdesc *bufd) |
Gets a comma-delimited list of active member ports for the LAG interface. More... | |
open_error_t | openapiLagAdminModeGet (openapiClientHandle_t *client_handle, uint32_t lagIfNum, OPEN_CONTROL_t *adminMode) |
Get the administrative mode of a LAG interface. More... | |
open_error_t | openapiLagAdminModeSet (openapiClientHandle_t *client_handle, uint32_t lagIfNum, OPEN_CONTROL_t adminMode) |
Set the administrative mode of a LAG interface. More... | |
open_error_t | openapiLagLoadBalanceModeGet (openapiClientHandle_t *client_handle, uint32_t lagIfNum, OPEN_LAG_HASH_MODE_t *lbMode) |
Gets load balancing mode of the LAG interface. More... | |
open_error_t | openapiLagLoadBalanceModeSet (openapiClientHandle_t *client_handle, uint32_t lagIfNum, OPEN_LAG_HASH_MODE_t lbMode) |
Sets load balancing mode of the LAG interface. More... | |
open_error_t | openapiLagMaxMemberCountGet (openapiClientHandle_t *client_handle, uint32_t *memberMax) |
Get the maximum number of members allowed for a LAG. More... | |
open_error_t | openapiLagMembersGet (openapiClientHandle_t *client_handle, uint32_t lagIfNum, uint32_t *count, open_buffdesc *bufd) |
Gets the list of member ports for the LAG interface. More... | |
open_error_t | openapiLagMembersListGet (openapiClientHandle_t *client_handle, uint32_t lagIfNum, uint32_t *count, open_buffdesc *bufd) |
Gets a comma-delimited list of member ports for the LAG interface. More... | |
open_error_t | openapiLagMinUplinksGet (openapiClientHandle_t *client_handle, uint32_t lagIfNum, uint32_t *minUpLinks) |
Gets minimum uplinks for the LAG interface. More... | |
open_error_t | openapiLagMinUplinksSet (openapiClientHandle_t *client_handle, uint32_t lagIfNum, uint32_t minUpLinks) |
Sets minimum uplinks for the LAG interface. More... | |
open_error_t | openapiLagNameGet (openapiClientHandle_t *client_handle, uint32_t lagIfNum, open_buffdesc *name) |
Gets name of the LAG interface. More... | |
open_error_t | openapiLagNameMaxLengthGet (openapiClientHandle_t *client_handle, uint32_t *maxLen) |
Get the maximum LAG name length. More... | |
open_error_t | openapiLagNameSet (openapiClientHandle_t *client_handle, uint32_t lagIfNum, open_buffdesc *name) |
Sets name of the LAG interface. More... | |
open_error_t | openapiLagPortAdd (openapiClientHandle_t *client_handle, uint32_t lagIfNum, uint32_t phyIfNum) |
Adds a physical interface to a LAG interface. More... | |
open_error_t | openapiLagPortDelete (openapiClientHandle_t *client_handle, uint32_t lagIfNum, uint32_t phyIfNum) |
Delete a physical interface from a LAG interface. More... | |
open_error_t | openapiLagStaticModeGet (openapiClientHandle_t *client_handle, uint32_t lagIfNum, OPEN_CONTROL_t *staticMode) |
Gets static mode of the LAG interface. More... | |
open_error_t | openapiLagStaticModeSet (openapiClientHandle_t *client_handle, uint32_t lagIfNum, OPEN_CONTROL_t staticMode) |
Sets static mode of the LAG interface. More... | |
open_error_t | openapiLagThresholdMinMaxGet (openapiClientHandle_t *client_handle, uint32_t *minThreshold, uint32_t *maxThreshold) |
Get the LAG Threshold minimum and maximum values. More... | |
OpEN uses these enumerations to indicate DOT3AD state types.
Enumerator | |
---|---|
OPEN_DOT3AD_STATE_AGGREGATION |
aggregation. |
OPEN_DOT3AD_STATE_LACP_TIMEOUT |
short timeout. |
OPEN_DOT3AD_STATE_LACP_ACTIVITY |
active. |
Definition at line 60 of file openapi_lag.h.
enum OPEN_LAG_HASH_MODE_t |
Hash Mode names.
Definition at line 48 of file openapi_lag.h.
open_error_t openapiDot3adAggPortActorAdminStateGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_DOT3AD_STATE_TYPE_t | type, | ||
OPEN_CONTROL_t * | state | ||
) |
Gets the LACP actor admin state.
[in] | client_handle | client handle from registration API |
[in] | ifNum | physical interface number. |
[in] | type | type of the LACP actor admin state. |
[out] | state | LACP actor admin state. |
OPEN_E_NONE | LACP actor admin state get successfully. |
OPEN_E_FAIL | Failed to get LACP actor admin state. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiDot3adAggPortActorAdminStateSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_DOT3AD_STATE_TYPE_t | type, | ||
OPEN_CONTROL_t | mode | ||
) |
Sets the LACP actor admin state.
[in] | client_handle | client handle from registration API |
[in] | ifNum | physical interface number. |
[in] | type | type of the LACP actor admin state. |
[in] | mode | LACP actor admin state. |
OPEN_E_NONE | LACP actor admin state set successfully. |
OPEN_E_FAIL | Failed to set LACP actor admin state. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiDot3adAggPortLacpModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_CONTROL_t * | lacpMode | ||
) |
Gets the LACP mode of the physical interface.
[in] | client_handle | client handle from registration API |
[in] | ifNum | physical interface number. |
[out] | lacpMode | LACP mode of the physical interface. |
OPEN_E_NONE | LACP mode of the physical interface returned. |
OPEN_E_FAIL | Failed to get LACP mode of the physical interface. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiDot3adAggPortLacpModeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_CONTROL_t | lacpMode | ||
) |
Sets the LACP mode of the physical interface.
[in] | client_handle | client handle from registration API |
[in] | ifNum | physical interface number. |
[in] | lacpMode | LACP mode of the physical interface. |
OPEN_E_NONE | LACP mode of the physical interface set successfully. |
OPEN_E_FAIL | Failed to set LACP mode of the physical interface. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiLagActiveMembersGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | lagIfNum, | ||
uint32_t * | count, | ||
open_buffdesc * | bufd | ||
) |
Gets the list of active member ports for the LAG interface.
[in] | client_handle | client handle from registration API |
[in] | lagIfNum | LAG interface number. |
[in,out] | count | size of LAG member list Input: maximum number of LAG members to output Output: actual number of LAG member ports in list |
[out] | bufd | buffer for outputting list of LAG members. returns array of Physical interfaces that are part of LAG |
OPEN_E_NONE | members list returned successfully. |
OPEN_E_FAIL | Failed to set the minimum uplinks for a LAG. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiLagActiveMembersListGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | lagIfNum, | ||
uint32_t * | count, | ||
open_buffdesc * | bufd | ||
) |
Gets a comma-delimited list of active member ports for the LAG interface.
[in] | client_handle | client handle from registration API |
[in] | lagIfNum | LAG interface number. |
[in,out] | count | size of LAG member list Input: maximum number of LAG members to output Output: actual number of LAG member ports in list |
[out] | bufd | buffer for outputting comma separated list of LAG members. Comma separated list of LAG member internal interface numbers |
OPEN_E_NONE | active members list returned successfully. |
OPEN_E_FAIL | Failed to get members list for the given LAG. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiLagAdminModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | lagIfNum, | ||
OPEN_CONTROL_t * | adminMode | ||
) |
Get the administrative mode of a LAG interface.
[in] | client_handle | client handle from registration API |
[in] | lagIfNum | internal interface number of a configured LAG |
[out] | adminMode | LACP administrative mode value |
OPEN_E_NONE | LACP admin state get successfully. |
OPEN_E_FAIL | Failed to get LACP admin state. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.19
open_error_t openapiLagAdminModeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | lagIfNum, | ||
OPEN_CONTROL_t | adminMode | ||
) |
Set the administrative mode of a LAG interface.
[in] | client_handle | client handle from registration API |
[in] | lagIfNum | internal interface number of a configured LAG |
[in] | adminMode | LACP administrative mode value |
OPEN_E_NONE | LACP admin state set successfully. |
OPEN_E_FAIL | Failed to set LACP admin state. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.19
open_error_t openapiLagLoadBalanceModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | lagIfNum, | ||
OPEN_LAG_HASH_MODE_t * | lbMode | ||
) |
Gets load balancing mode of the LAG interface.
[in] | client_handle | client handle from registration API |
[in] | lagIfNum | LAG interface number. |
[out] | lbMode | load balance mode of the LAG interface. |
OPEN_E_NONE | load balancing mode returned. |
OPEN_E_FAIL | Failed to get the load balance mode of the LAG. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiLagLoadBalanceModeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | lagIfNum, | ||
OPEN_LAG_HASH_MODE_t | lbMode | ||
) |
Sets load balancing mode of the LAG interface.
[in] | client_handle | client handle from registration API |
[in] | lagIfNum | LAG interface number. |
[in] | lbMode | load balance mode of the LAG interface. |
OPEN_E_NONE | load balance mode set. |
OPEN_E_FAIL | Failed to set the load balance mode of the LAG. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiLagMaxMemberCountGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | memberMax | ||
) |
Get the maximum number of members allowed for a LAG.
[in] | client_handle | Client handle from registration API |
[out] | memberMax | Maximum members |
OPEN_E_NONE | if member maximum is returned successfully. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiLagMembersGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | lagIfNum, | ||
uint32_t * | count, | ||
open_buffdesc * | bufd | ||
) |
Gets the list of member ports for the LAG interface.
[in] | client_handle | client handle from registration API |
[in] | lagIfNum | LAG interface number. |
[in,out] | count | size of LAG member list Input: maximum number of LAG members to output Output: actual number of LAG member ports in list |
[out] | bufd | buffer for outputting list of LAG members. returns array of Physical interfaces that are part of LAG |
OPEN_E_NONE | members list returned successfully. |
OPEN_E_FAIL | Failed to set the minimum uplinks for a LAG. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiLagMembersListGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | lagIfNum, | ||
uint32_t * | count, | ||
open_buffdesc * | bufd | ||
) |
Gets a comma-delimited list of member ports for the LAG interface.
[in] | client_handle | client handle from registration API |
[in] | lagIfNum | LAG interface number. |
[in,out] | count | size of LAG member list Input: maximum number of LAG members to output Output: actual number of LAG member ports in list |
[out] | bufd | buffer for outputting comma separated list of LAG members. Comma separated list of LAG member internal interface numbers |
OPEN_E_NONE | members list returned successfully. |
OPEN_E_FAIL | Failed to get members list for the given LAG. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiLagMinUplinksGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | lagIfNum, | ||
uint32_t * | minUpLinks | ||
) |
Gets minimum uplinks for the LAG interface.
These are the minimum number of physical interfaces that needs to to be UP for the LAG interface to UP
[in] | client_handle | client handle from registration API |
[in] | lagIfNum | LAG interface number. |
[out] | minUpLinks | minimum uplinks of the LAG interface. |
OPEN_E_NONE | minimum uplinks returned. |
OPEN_E_FAIL | Failed to get the minimum uplinks for a LAG. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiLagMinUplinksSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | lagIfNum, | ||
uint32_t | minUpLinks | ||
) |
Sets minimum uplinks for the LAG interface.
These are the minimum number of physical interfaces that needs to to be UP for the LAG interface to UP
[in] | client_handle | client handle from registration API |
[in] | lagIfNum | LAG interface number. |
[in] | minUpLinks | minimum uplinks of the LAG interface.
|
OPEN_E_NONE | minimum uplinks successfully set. |
OPEN_E_FAIL | Failed to set the minimum uplinks for a LAG. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiLagNameGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | lagIfNum, | ||
open_buffdesc * | name | ||
) |
Gets name of the LAG interface.
[in] | client_handle | client handle from registration API |
[in] | lagIfNum | LAG interface number. |
[out] | name | Name of the LAG interface. dmx |
OPEN_E_NONE | LAG name returned. |
OPEN_E_FAIL | Failed to get the name of the LAG. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiLagNameMaxLengthGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | maxLen | ||
) |
Get the maximum LAG name length.
[in] | client_handle | Client handle from registration API |
[out] | maxLen | Maximum length for a LAG name. |
OPEN_E_NONE | if LAD name maximum length is returned. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiLagNameSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | lagIfNum, | ||
open_buffdesc * | name | ||
) |
Sets name of the LAG interface.
[in] | client_handle | client handle from registration API |
[in] | lagIfNum | LAG interface number. |
[in] | name | Name of the LAG interface. |
OPEN_E_NONE | LAG name successfully set. |
OPEN_E_FAIL | Failed to set the name of the LAG. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiLagPortAdd | ( | openapiClientHandle_t * | client_handle, |
uint32_t | lagIfNum, | ||
uint32_t | phyIfNum | ||
) |
Adds a physical interface to a LAG interface.
[in] | client_handle | client handle from registration API |
[in] | lagIfNum | LAG interface number. |
[in] | phyIfNum | physical interface. |
OPEN_E_NONE | physical interface added to LAG. |
OPEN_E_FAIL | Failed to add physical interface to LAG. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiLagPortDelete | ( | openapiClientHandle_t * | client_handle, |
uint32_t | lagIfNum, | ||
uint32_t | phyIfNum | ||
) |
Delete a physical interface from a LAG interface.
[in] | client_handle | client handle from registration API |
[in] | lagIfNum | LAG interface number. |
[in] | phyIfNum | physical interface. |
OPEN_E_NONE | physical interface deleted from LAG. |
OPEN_E_FAIL | Failed to delete physical interface to LAG. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiLagStaticModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | lagIfNum, | ||
OPEN_CONTROL_t * | staticMode | ||
) |
Gets static mode of the LAG interface.
[in] | client_handle | client handle from registration API |
[in] | lagIfNum | LAG interface number. |
[out] | staticMode | OPEN_ENABLE if static OPEN_DISABLE if dynamic. |
OPEN_E_NONE | LAG static mode returned. |
OPEN_E_FAIL | Failed to get the static mode of the LAG. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiLagStaticModeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | lagIfNum, | ||
OPEN_CONTROL_t | staticMode | ||
) |
Sets static mode of the LAG interface.
[in] | client_handle | client handle from registration API |
[in] | lagIfNum | LAG interface number. |
[in] | staticMode | OPEN_ENABLE if static OPEN_DISABLE if dynamic. |
OPEN_E_NONE | LAG static mode successfully set. |
OPEN_E_FAIL | Failed to set the static mode of the LAG. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_FULL | Table is full. This may occur when a LAG's mode is set to dynamic and maximum number of dynamic lags are already present in the system |
OpEN API Version: 1.1
open_error_t openapiLagThresholdMinMaxGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | minThreshold, | ||
uint32_t * | maxThreshold | ||
) |
Get the LAG Threshold minimum and maximum values.
[in] | client_handle | Client handle from registration API |
[out] | minThreshold | Minimum threshold |
[out] | maxThreshold | Maximum threshold |
OPEN_E_NONE | if min and max values are returned. |
OPEN_E_FAIL | if failed to get the range values. |
OPEN_E_PARAM | error in parameter passed. |
OpEN API Version: 1.1