Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Data Structures | Macros | Enumerations | Functions
Instrumentation BHD Specific APIs [OPENAPI_INSTRU_BHD]

Data Structures

struct  OPEN_BHD_PKT_SAMPLING_PARAMS_t::open_agent_sampling_params
 
struct  OPEN_BHD_PKT_SAMPLING_CONFIG_t
 
union  OPEN_BHD_PKT_SAMPLING_PARAMS_t
 
struct  OPEN_BHD_PORT_SFLOW_SAMPLING_STATUS_t
 
struct  OPEN_BLACK_HOLE_CONFIG_t
 
struct  OPEN_BHD_PKT_SAMPLING_PARAMS_t::open_sflow_sampling_params
 

Macros

#define BVIEW_BHD_DEFAULT_PKT_SAMPLING_METHOD   BVIEW_BHD_AGENT_SAMPLING
 
#define BVIEW_BHD_DEST_UDP_PORT_MAX   65535
 
#define BVIEW_BHD_DEST_UDP_PORT_MIN   1
 
#define BVIEW_BHD_MAX_SUPPORTED_PORTS   OPEN_ASIC_MAX_PORTS
 
#define BVIEW_BHD_MAX_UNITS   1
 
#define BVIEW_BHD_SAMP_POOL_SIZE_MAX   100000
 
#define BVIEW_BHD_SAMP_POOL_SIZE_MIN   1024
 
#define BVIEW_BHD_SAMPLE_COUNT_MAX   30
 
#define BVIEW_BHD_SAMPLE_COUNT_MIN   0
 
#define BVIEW_BHD_SAMPLE_PERIODICITY_MAX   (60*60)
 
#define BVIEW_BHD_SAMPLE_PERIODICITY_MIN   1
 
#define BVIEW_BHD_SOURCE_UDP_PORT_MAX   65535
 
#define BVIEW_BHD_SOURCE_UDP_PORT_MIN   1
 
#define BVIEW_BHD_VLAN_MAX   4094
 
#define BVIEW_BHD_VLAN_MIN   1
 
#define BVIEW_BHD_WATERMARK_MAX   10000
 
#define BVIEW_BHD_WATERMARK_MIN   100
 
#define OPEN_BHD_MAX_PACKET_SIZE   OPEN_INSTRU_MAX_PACKET_SIZE
 
#define OPEN_BHD_MAX_PORT_LIST_STR   256
 
#define OPEN_BHD_MAX_PORT_STR   8
 
#define OPEN_BHD_SFLOW_AGENT_NUM   1
 
#define OPEN_BHD_SFLOW_SESSION   1
 

Enumerations

enum  OPEN_BHD_PKT_SAMPLING_METHOD_t { OPEN_BHD_AGENT_SAMPLING = (1 << 0), OPEN_BHD_SFLOW_SAMPLING = (1 << 1), OPEN_BHD_MAX_SAMPLING_METHOD }
 

Functions

open_error_t openapiBhdAsicCapabilitiesGet (openapiClientHandle_t *clientHandle, int32_t asic, int32_t *sampling_capabilities)
 BHD feature, asic sampling capabilities get. More...
 
open_error_t openapiBhdBlackHoleCancel (openapiClientHandle_t *clientHandle, int32_t asic, int32_t sFlow, open_buffdesc *port_list)
 BHD feature, cancel black hole. More...
 
open_error_t openapiBhdBlackHoleConfigure (openapiClientHandle_t *clientHandle, int32_t asic, OPEN_BLACK_HOLE_CONFIG_t *config)
 BHD feature, configure black hole. More...
 
open_error_t openapiBhdPacketCountGet (openapiClientHandle_t *clientHandle, int32_t asic, uint64_t *count)
 BHD feature, Black holed packet count get. More...
 
open_error_t openapiBhdSflowSamplingStatusGet (openapiClientHandle_t *clientHandle, int32_t asic, int32_t port, open_buffdesc *port_list, OPEN_BHD_PORT_SFLOW_SAMPLING_STATUS_t *status)
 BHD feature sflow configuration get function. More...
 

Detailed Description

Function Documentation

open_error_t openapiBhdAsicCapabilitiesGet ( openapiClientHandle_t clientHandle,
int32_t  asic,
int32_t *  sampling_capabilities 
)

BHD feature, asic sampling capabilities get.

Parameters
[in]clientHandleOpenAPI connection Handle
[in]asicAsic/Unit number
[out]sampling_capabilitiesSampling capabilities
Return values
OPEN_E_NONE
OPEN_E_ERROROpEN API Version: 1.12
open_error_t openapiBhdBlackHoleCancel ( openapiClientHandle_t clientHandle,
int32_t  asic,
int32_t  sFlow,
open_buffdesc port_list 
)

BHD feature, cancel black hole.

Parameters
[in]clientHandleOpenAPI connection Handle
[in]asicAsic/Unit number
[in]sFlowFlag to remove BHD sflow config.
[in]port_listSpine port list
Return values
OPEN_E_NONE
OPEN_E_ERROROpEN API Version: 1.12
open_error_t openapiBhdBlackHoleConfigure ( openapiClientHandle_t clientHandle,
int32_t  asic,
OPEN_BLACK_HOLE_CONFIG_t config 
)

BHD feature, configure black hole.

Parameters
[in]clientHandleOpenAPI connection Handle
[in]asicAsic/Unit number
[in]configBlack hole configuration
Return values
OPEN_E_NONE
OPEN_E_ERROROpEN API Version: 1.12
open_error_t openapiBhdPacketCountGet ( openapiClientHandle_t clientHandle,
int32_t  asic,
uint64_t *  count 
)

BHD feature, Black holed packet count get.

Parameters
[in]clientHandleOpenAPI connection Handle
[in]asicAsic/Unit number
[out]countBlack holed packet count
Return values
OPEN_E_NONE
OPEN_E_ERROROpEN API Version: 1.12
open_error_t openapiBhdSflowSamplingStatusGet ( openapiClientHandle_t clientHandle,
int32_t  asic,
int32_t  port,
open_buffdesc port_list,
OPEN_BHD_PORT_SFLOW_SAMPLING_STATUS_t status 
)

BHD feature sflow configuration get function.

Parameters
[in]clientHandleOpenAPI connection Handle
[in]asicAsic/Unit number
[in]portport number
[in]port_listSpine port list
[out]statusSflow sampling status
Return values
OPEN_E_NONE
OPEN_E_ERROROpEN API Version: 1.12