Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Data Structures | |
struct | _open_ifa_5_tuple_key_ |
struct | _open_ifa_capabilities_ |
struct | _open_ifa_cl_config_ |
struct | _open_ifa_cl_key_ |
struct | _open_ifa_feature_ |
struct | _open_ifa_flow_ |
struct | _open_ifa_flow_key_ |
struct | _open_ifa_flow_params_ |
struct | _open_ifa_session_ |
struct | _open_ifa_session_key_ |
struct | _open_ifa_session_stats_ |
Macros | |
#define | OPEN_IFA_ASIC_MAX_COUNT 1 |
Max number of ASICs supported. | |
#define | OPEN_IFA_MAX_FLOWS_PER_SESSION 8 |
#define | OPEN_IFA_MAX_NAME_LENGTH 128 |
Maximum length of name param. | |
Typedefs | |
typedef struct _open_ifa_5_tuple_key_ | OPEN_IFA_5_TUPLE_KEY_t |
typedef struct _open_ifa_capabilities_ | OPEN_IFA_CAPABILITIES_t |
typedef enum _open_ifa_cl_config_param_mask_ | OPEN_IFA_CL_CONFIG_PARAM_MASK_t |
typedef struct _open_ifa_cl_config_ | OPEN_IFA_CL_CONFIG_t |
typedef struct _open_ifa_cl_key_ | OPEN_IFA_CL_KEY_t |
typedef enum _open_ifa_dev_type_ | OPEN_IFA_DEV_TYPE_t |
typedef enum _open_ifa_feat_config_mask_ | OPEN_IFA_FEAT_CONFIG_MASK_t |
typedef struct _open_ifa_feature_ | OPEN_IFA_FEATURE_t |
typedef struct _open_ifa_flow_key_ | OPEN_IFA_FLOW_KEY_t |
typedef enum _open_ifa_flow_param_mask_ | OPEN_IFA_FLOW_PARAM_t |
typedef struct _open_ifa_flow_params_ | OPEN_IFA_FLOW_PARAMS_t |
typedef struct _open_ifa_flow_ | OPEN_IFA_FLOW_t |
typedef enum _open_ifa_flow_type_ | OPEN_IFA_FLOW_TYPE_t |
typedef struct _open_ifa_session_key_ | OPEN_IFA_SESSION_KEY_t |
typedef struct _open_ifa_session_stats_ | OPEN_IFA_SESSION_STATS_t |
typedef struct _open_ifa_session_ | OPEN_IFA_SESSION_t |
typedef enum _open_ifa_tuple_mask_ | OPEN_IFA_TUPLE_MASK_t |
open_error_t openapiIfaCapabilitiesGet | ( | openapiClientHandle_t * | clientHandle, |
int | asic, | ||
OPEN_IFA_CAPABILITIES_t * | cap | ||
) |
Get IFA capabilities.
[in] | clientHandle | OpenAPI connection Handle |
[in] | asic | Asic/Unit number |
[in] | cap | IFA capabilities |
OPEN_E_NONE | |
OPEN_E_ERROR | |
OPEN_E_PARAM | OpEN API Version: 1.18 |
open_error_t openapiIfaClearStats | ( | openapiClientHandle_t * | clientHandle, |
int | asic, | ||
open_buffdesc * | name | ||
) |
Clear IFA stats.
[in] | clientHandle | OpenAPI connection Handle |
[in] | asic | Asic/Unit number |
[in] | name | IFA session name |
OPEN_E_NONE | |
OPEN_E_ERROR | |
OPEN_E_PARAM | OpEN API Version: 1.18 |
open_error_t openapiIfaCollectorCreate | ( | openapiClientHandle_t * | clientHandle, |
int | asic, | ||
OPEN_IFA_CL_CONFIG_t * | clConfig | ||
) |
Create IFA collector.
[in] | clientHandle | OpenAPI connection Handle |
[in] | asic | Asic/Unit number |
[in] | clConfig | IFA collector configuration |
OPEN_E_NONE | |
OPEN_E_ERROR | |
OPEN_E_PARAM | OpEN API Version: 1.18 |
open_error_t openapiIfaCollectorRemove | ( | openapiClientHandle_t * | clientHandle, |
int | asic, | ||
open_buffdesc * | name | ||
) |
Remove IFA collector.
[in] | clientHandle | OpenAPI connection Handle |
[in] | asic | Asic/Unit number |
[in] | name | IFA collector name |
OPEN_E_NONE | |
OPEN_E_ERROR | |
OPEN_E_PARAM | OpEN API Version: 1.18 |
open_error_t openapiIfaConfigGet | ( | openapiClientHandle_t * | clientHandle, |
int | asic, | ||
OPEN_IFA_FEATURE_t * | config | ||
) |
Inband flow analyzer feature configuration get function.
[in] | clientHandle | OpenAPI connection Handle |
[in] | asic | Asic/Unit number |
[in,out] | config | Inband flow analyzer config |
OPEN_E_NONE | |
OPEN_E_ERROR | |
OPEN_E_PARAM | OpEN API Version: 1.18 |
open_error_t openapiIfaConfigSet | ( | openapiClientHandle_t * | clientHandle, |
int | asic, | ||
OPEN_IFA_FEATURE_t * | config | ||
) |
Inband flow analyzer feature configuration set function.
[in] | clientHandle | OpenAPI connection Handle |
[in] | asic | Asic/Unit number |
[in] | config | Inband flow analyzer config |
OPEN_E_NONE | |
OPEN_E_ERROR | |
OPEN_E_PARAM | OpEN API Version: 1.18 |
open_error_t openapiIfaFlowCreate | ( | openapiClientHandle_t * | clientHandle, |
int | asic, | ||
OPEN_IFA_FLOW_t * | appFlow | ||
) |
Create IFA flow.
[in] | clientHandle | OpenAPI connection Handle |
[in] | asic | Asic/Unit number |
[in] | appFlow | IFA flow configuration |
OPEN_E_NONE | |
OPEN_E_ERROR | |
OPEN_E_PARAM | OpEN API Version: 1.18 |
open_error_t openapiIfaFlowRemove | ( | openapiClientHandle_t * | clientHandle, |
int | asic, | ||
open_buffdesc * | name | ||
) |
Remove IFA flow.
[in] | clientHandle | OpenAPI connection Handle |
[in] | asic | Asic/Unit number |
[in] | name | IFA flow name |
OPEN_E_NONE | |
OPEN_E_ERROR | |
OPEN_E_PARAM | OpEN API Version: 1.18 |
open_error_t openapiIfaSessionCreate | ( | openapiClientHandle_t * | clientHandle, |
int | asic, | ||
OPEN_IFA_SESSION_t * | session | ||
) |
Create IFA session.
[in] | clientHandle | OpenAPI connection Handle |
[in] | asic | Asic/Unit number |
[in] | session | IFA session configuration |
OPEN_E_NONE | |
OPEN_E_ERROR | |
OPEN_E_PARAM | OpEN API Version: 1.18 |
open_error_t openapiIfaSessionRemove | ( | openapiClientHandle_t * | clientHandle, |
int | asic, | ||
open_buffdesc * | name | ||
) |
Remove IFA session.
[in] | clientHandle | OpenAPI connection Handle |
[in] | asic | Asic/Unit number |
[in] | name | IFA session name |
OPEN_E_NONE | |
OPEN_E_ERROR | |
OPEN_E_PARAM | OpEN API Version: 1.18 |
open_error_t openapiIfaSessionStart | ( | openapiClientHandle_t * | clientHandle, |
int | asic, | ||
open_buffdesc * | name | ||
) |
Start IFA session.
[in] | clientHandle | OpenAPI connection Handle |
[in] | asic | Asic/Unit number |
[in] | name | IFA session name |
OPEN_E_NONE | |
OPEN_E_ERROR | |
OPEN_E_PARAM | OpEN API Version: 1.18 |
open_error_t openapiIfaSessionStatsGet | ( | openapiClientHandle_t * | clientHandle, |
int | asic, | ||
open_buffdesc * | name, | ||
OPEN_IFA_SESSION_STATS_t * | data | ||
) |
Get IFA stats.
[in] | clientHandle | OpenAPI connection Handle |
[in] | asic | Asic/Unit number |
[in] | name | IFA session name |
data | input/ouput IFA session stats |
OPEN_E_NONE | |
OPEN_E_ERROR | |
OPEN_E_PARAM | OpEN API Version: 1.18 |
open_error_t openapiIfaSessionStop | ( | openapiClientHandle_t * | clientHandle, |
int | asic, | ||
open_buffdesc * | name | ||
) |
Stop IFA session.
[in] | clientHandle | OpenAPI connection Handle |
[in] | asic | Asic/Unit number |
[in] | name | IFA session name |
OPEN_E_NONE | |
OPEN_E_ERROR | |
OPEN_E_PARAM | OpEN API Version: 1.18 |