src/plugins/lb/lb.api

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