plugins/lb-plugin/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 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 define lb_conf_reply {
  22   u32 context;
  23   i32 retval;
  24 };
  25
  26 /** \brief Add a virtual address (or prefix)
  27     @param client_index - opaque cookie to identify the sender
  28     @param context - sender context, to match reply w/ request
  29     @param ip_prefix - IP address (IPv4 in lower order 32 bits).
  30     @param prefix_length - IP prefix length (96 + 'IPv4 prefix length' for IPv4).
  31     @param is_gre4 - Encap is ip4 GRE (ip6 GRE otherwise).
  32     @param new_flows_table_length - Size of the new connections flow table used
  33            for this VIP (must be power of 2).
  34     @param is_del - The VIP should be removed.
  35 */
  36 define lb_add_del_vip {
  37   u32 client_index;
  38   u32 context;
  39   u8 ip_prefix[16];
  40   u8 prefix_length;
  41   u8 is_gre4;
  42   u32 new_flows_table_length;
  43   u8 is_del;
  44 };
  45
  46 define lb_add_del_vip_reply {
  47   u32 context;
  48   i32 retval;
  49 };
  50
  51 /** \brief Add an application server for a given VIP
  52     @param client_index - opaque cookie to identify the sender
  53     @param context - sender context, to match reply w/ request
  54     @param vip_ip_prefix - VIP IP address (IPv4 in lower order 32 bits).
  55     @param vip_ip_prefix - VIP IP prefix length (96 + 'IPv4 prefix length' for IPv4).
  56     @param as_address - The application server address (IPv4 in lower order 32 bits).
  57     @param is_del - The AS should be removed.
  58 */
  59 define lb_add_del_as {
  60   u32 client_index;
  61   u32 context;
  62   u8 vip_ip_prefix[16];
  63   u8 vip_prefix_length;
  64   u8 as_address[16];
  65   u8 is_del;
  66 };
  67
  68 define lb_add_del_as_reply {
  69   u32 context;
  70   i32 retval;
  71 };