src/plugins/lb/lb.api

   1 /** \brief Configure Load-Balancer global parameters
   2     @param client_index - opaque cookie to identify the sender
   3     @param context - sender context, to match reply w/ request
   4     @param ip4_src_address - IPv4 address to be used as source for IPv4 GRE traffic.
   5     @param ip6_src_address - IPv6 address to be used as source for IPv6 GRE traffic.
   6     @param n_sticky_buckets - Number of buckets *per worker thread* in the
   7            established flow table (must be power of 2).
   8     @param flow_timeout - Time in seconds after which, if no packet is received
   9            for a given flow, the flow is removed from the established flow table.
  10 */
  11 autoreply define lb_conf
  12 {
  13   u32 client_index;
  14   u32 context;
  15   u32 ip4_src_address;
  16   u8 ip6_src_address[16];
  17   u32 sticky_buckets_per_core;
  18   u32 flow_timeout;
  19 };
  20
  21 /** \brief Add a virtual address (or prefix)
  22     @param client_index - opaque cookie to identify the sender
  23     @param context - sender context, to match reply w/ request
  24     @param ip_prefix - IP address (IPv4 in lower order 32 bits).
  25     @param prefix_length - IP prefix length (96 + 'IPv4 prefix length' for IPv4).
  26     @param is_gre4 - Encap is ip4 GRE (ip6 GRE otherwise).
  27     @param new_flows_table_length - Size of the new connections flow table used
  28            for this VIP (must be power of 2).
  29     @param is_del - The VIP should be removed.
  30 */
  31 autoreply define lb_add_del_vip {
  32   u32 client_index;
  33   u32 context;
  34   u8 ip_prefix[16];
  35   u8 prefix_length;
  36   u8 is_gre4;
  37   u32 new_flows_table_length;
  38   u8 is_del;
  39 };
  40
  41 /** \brief Add an application server for a given VIP
  42     @param client_index - opaque cookie to identify the sender
  43     @param context - sender context, to match reply w/ request
  44     @param vip_ip_prefix - VIP IP address (IPv4 in lower order 32 bits).
  45     @param vip_ip_prefix - VIP IP prefix length (96 + 'IPv4 prefix length' for IPv4).
  46     @param as_address - The application server address (IPv4 in lower order 32 bits).
  47     @param is_del - The AS should be removed.
  48 */
  49 autoreply define lb_add_del_as {
  50   u32 client_index;
  51   u32 context;
  52   u8 vip_ip_prefix[16];
  53   u8 vip_prefix_length;
  54   u8 as_address[16];
  55   u8 is_del;
  56 };