src/plugins/flowprobe/flowprobe.api

   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 /** \brief Enable / disable per-packet IPFIX recording on an interface
  11     @param client_index - opaque cookie to identify the sender
  12     @param context - sender context, to match reply w/ request
  13     @param is_add - add address if non-zero, else delete
  14     @param is_ipv6 - if non-zero the address is ipv6, else ipv4
  15     @param sw_if_index - index of the interface
  16 */
  17 autoreply manual_print define flowprobe_tx_interface_add_del
  18 {
  19   /* Client identifier, set from api_main.my_client_index */
  20   u32 client_index;
  21
  22   /* Arbitrary context, so client can match reply to request */
  23   u32 context;
  24
  25   /* Enable / disable the feature */
  26   u8 is_add;
  27   u8 which;  /* 0 = ipv4, 1 = l2, 2 = ipv6 */
  28
  29   /* Interface handle */
  30   u32 sw_if_index;
  31   option vat_help = "<intfc> [disable]";
  32 };
  33
  34 autoreply define flowprobe_params
  35 {
  36   u32 client_index;
  37   u32 context;
  38   u8 record_l2;
  39   u8 record_l3;
  40   u8 record_l4;
  41   u32 active_timer;  /* ~0 is off, 0 is default */
  42   u32 passive_timer; /* ~0 is off, 0 is default */
  43   option vat_help = "record <[l2] [l3] [l4]> [active <timer> passive <timer>]";
  44 };