src/plugins/flowperpkt/flowperpkt.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 flowperpkt plugin
   6 */
   7
   8 /** \brief Enable / disable per-packet IPFIX recording on an interface
   9     @param client_index - opaque cookie to identify the sender
  10     @param context - sender context, to match reply w/ request
  11     @param is_add - add address if non-zero, else delete
  12     @param is_ipv6 - if non-zero the address is ipv6, else ipv4
  13     @param sw_if_index - index of the interface
  14 */
  15 manual_print define flowperpkt_tx_interface_add_del
  16 {
  17   /* Client identifier, set from api_main.my_client_index */
  18   u32 client_index;
  19
  20   /* Arbitrary context, so client can match reply to request */
  21   u32 context;
  22
  23   /* Enable / disable the feature */
  24   u8 is_add;
  25   u8 which;  /* 0 = ipv4, 1 = l2, 2 = ipv6 (not yet implemented) */
  26
  27   /* Interface handle */
  28   u32 sw_if_index;
  29 };
  30
  31 /** \brief Reply to enable/disable per-packet IPFIX recording messages
  32     @param context - returned sender context, to match reply w/ request
  33     @param retval - return code
  34 */
  35 define flowperpkt_tx_interface_add_del_reply
  36 {
  37   /* From the request */
  38   u32 context;
  39
  40   /* Return value, zero means all OK */
  41   i32 retval;
  42 };