FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
flowprobe.api
Go to the documentation of this file.
1 /* Define a simple enable-disable binary API to control the feature */
2 
3 /** \file
4  This file defines the vpp control-plane API messages
5  used to control the flowprobe plugin
6 */
7 
8 option version = "1.0.0";
9 
10 import "vnet/interface_types.api";
11 
13 {
17 };
18 
20 {
24 };
25 
26 /** \brief Enable / disable per-packet IPFIX recording on an interface
27  @param client_index - opaque cookie to identify the sender
28  @param context - sender context, to match reply w/ request
29  @param is_add - add address if non-zero, else delete
30  @param which - flags indicating forwarding path
31  @param sw_if_index - index of the interface
32 */
33 autoreply define flowprobe_tx_interface_add_del
34 {
35  /* Client identifier, set from api_main.my_client_index */
37 
38  /* Arbitrary context, so client can match reply to request */
40 
41  /* Enable / disable the feature */
42  bool is_add;
43  vl_api_flowprobe_which_flags_t which;
44 
45  /* Interface handle */
46  vl_api_interface_index_t sw_if_index;
47  option vat_help = "<intfc> [disable]";
48 };
49 
50 autoreply define flowprobe_params
51 {
54  vl_api_flowprobe_record_flags_t record_flags;
55  u32 active_timer; /* ~0 is off, 0 is default */
56  u32 passive_timer; /* ~0 is off, 0 is default */
57  option vat_help = "record <[l2] [l3] [l4]> [active <timer> passive <timer>]";
58 };
vl_api_flowprobe_tx_interface_add_del_t::which
vl_api_flowprobe_which_flags_t which
Definition: flowprobe.api:43
vl_api_flowprobe_tx_interface_add_del_t::is_add
bool is_add
Definition: flowprobe.api:42
FLOWPROBE_RECORD_FLAG_L2
@ FLOWPROBE_RECORD_FLAG_L2
Definition: flowprobe.api:21
FLOWPROBE_WHICH_FLAG_L2
@ FLOWPROBE_WHICH_FLAG_L2
Definition: flowprobe.api:15
vl_api_flowprobe_params_t::vat_help
option vat_help
Definition: flowprobe.api:57
flowprobe_record_flags
flowprobe_record_flags
Definition: flowprobe.api:19
vl_api_flowprobe_params_t::client_index
u32 client_index
Definition: flowprobe.api:52
vl_api_flowprobe_params_t::record_flags
vl_api_flowprobe_record_flags_t record_flags
Definition: flowprobe.api:54
flowprobe_which_flags
flowprobe_which_flags
Definition: flowprobe.api:12
flowprobe_params
static int flowprobe_params(flowprobe_main_t *fm, u8 record_l2, u8 record_l3, u8 record_l4, u32 active_timer, u32 passive_timer)
Definition: flowprobe.c:671
vl_api_flowprobe_params_t::context
u32 context
Definition: flowprobe.api:53
vl_api_flowprobe_params_t::passive_timer
u32 passive_timer
Definition: flowprobe.api:56
vl_api_flowprobe_tx_interface_add_del_t::context
u32 context
Definition: flowprobe.api:39
version
option version
Definition: flowprobe.api:8
vl_api_flowprobe_tx_interface_add_del_t::client_index
u32 client_index
Definition: flowprobe.api:36
vl_api_flowprobe_params_t::active_timer
u32 active_timer
Definition: flowprobe.api:55
u32
unsigned int u32
Definition: types.h:88
FLOWPROBE_RECORD_FLAG_L4
@ FLOWPROBE_RECORD_FLAG_L4
Definition: flowprobe.api:23
vl_api_flowprobe_tx_interface_add_del_t::vat_help
option vat_help
Definition: flowprobe.api:47
u8
unsigned char u8
Definition: types.h:56
FLOWPROBE_WHICH_FLAG_IP6
@ FLOWPROBE_WHICH_FLAG_IP6
Definition: flowprobe.api:16
vl_api_flowprobe_tx_interface_add_del_t
Enable / disable per-packet IPFIX recording on an interface.
Definition: flowprobe.api:33
vl_api_flowprobe_params_t
Definition: flowprobe.api:50
FLOWPROBE_RECORD_FLAG_L3
@ FLOWPROBE_RECORD_FLAG_L3
Definition: flowprobe.api:22
FLOWPROBE_WHICH_FLAG_IP4
@ FLOWPROBE_WHICH_FLAG_IP4
Definition: flowprobe.api:14
vl_api_flowprobe_tx_interface_add_del_t::sw_if_index
vl_api_interface_index_t sw_if_index
Definition: flowprobe.api:46