flowperpkt.api

Go to the documentation of this file.

/* Define a simple enable-disable binary API to control the feature */

/** \file
    This file defines the vpp control-plane API messages
    used to control the flowperpkt plugin
*/

/** \brief Enable / disable per-packet IPFIX recording on an interface
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param is_add - add address if non-zero, else delete
    @param is_ipv6 - if non-zero the address is ipv6, else ipv4
    @param sw_if_index - index of the interface
*/
manual_print define flowperpkt_tx_interface_add_del
{
  /* Client identifier, set from api_main.my_client_index */
  u32 client_index;

  /* Arbitrary context, so client can match reply to request */
  u32 context;

  /* Enable / disable the feature */
  u8 is_add;
  u8 which;  /* 0 = ipv4, 1 = l2, 2 = ipv6 */

  /* Interface handle */
  u32 sw_if_index;
};

/** \brief Reply to enable/disable per-packet IPFIX recording messages
    @param context - returned sender context, to match reply w/ request
    @param retval - return code
*/
define flowperpkt_tx_interface_add_del_reply
{
  /* From the request */
  u32 context;

  /* Return value, zero means all OK */
  i32 retval;
};

define flowperpkt_params
{
  u32 client_index;
  u32 context;
  u8 record_l2;
  u8 record_l3;
  u8 record_l4;
  u32 active_timer;  /* ~0 is off, 0 is default */
  u32 passive_timer; /* ~0 is off, 0 is default */
};

define flowperpkt_params_reply
{
  u32 context;
  i32 retval;
};