src/plugins/lb/lb.api

   1 option version = "1.0.0";
   2 import "vnet/ip/ip_types.api";
   3
   4 /** \brief Configure Load-Balancer global parameters (unlike the CLI, both ip4_src_address and ip6_src_address need to be specified.
   5     @param client_index - opaque cookie to identify the sender
   6     @param context - sender context, to match reply w/ request
   7     @param ip4_src_address - IPv4 address to be used as source for IPv4 traffic(applicable in GRE4/GRE6/NAT4/NAT6 mode only).
   8     @param ip6_src_address - IPv6 address to be used as source for IPv6 traffic(applicable in GRE4/GRE6/NAT4/NAT6 mode only).
   9     @param sticky_buckets_per_core - Number of buckets *per worker thread* in the
  10            established flow table (must be power of 2).
  11     @param flow_timeout - Time in seconds after which, if no packet is received
  12            for a given flow, the flow is removed from the established flow table.
  13 */
  14 autoreply define lb_conf
  15 {
  16   u32 client_index;
  17   u32 context;
  18   vl_api_ip4_address_t ip4_src_address;
  19   vl_api_ip6_address_t ip6_src_address;
  20   u32 sticky_buckets_per_core;
  21   u32 flow_timeout;
  22 };
  23
  24 /** \brief Add a virtual address (or prefix)
  25     @param client_index - opaque cookie to identify the sender
  26     @param context - sender context, to match reply w/ request
  27     @param ip_prefix - IP address (IPv4 in lower order 32 bits).
  28     @param prefix_length - IP prefix length (96 + 'IPv4 prefix length' for IPv4).
  29     @param protocol - tcp or udp.
  30     @param port - destination port. (0) means 'all-port VIP'
  31     @param encap - Encap is ip4 GRE(0) or ip6 GRE(1) or L3DSR(2) or NAT4(3) or NAT6(4).
  32     @param dscp - DSCP bit corresponding to VIP(applicable in L3DSR mode only).
  33     @param type - service type(applicable in NAT4/NAT6 mode only).
  34     @param target_port - Pod's port corresponding to specific service(applicable in NAT4/NAT6 mode only).
  35     @param node_port - Node's port(applicable in NAT4/NAT6 mode only).
  36     @param new_flows_table_length - Size of the new connections flow table used
  37            for this VIP (must be power of 2).
  38     @param is_del - The VIP should be removed.
  39 */
  40 autoreply define lb_add_del_vip {
  41   u32 client_index;
  42   u32 context;
  43   u8 ip_prefix[16];
  44   u8 prefix_length;
  45   u8 protocol;
  46   u16 port;
  47   u8 encap;
  48   u8 dscp;
  49   u8 type;
  50   u16 target_port;
  51   u16 node_port;
  52   u32 new_flows_table_length;
  53   u8 is_del;
  54 };
  55
  56 /** \brief Add an application server for a given VIP
  57     @param client_index - opaque cookie to identify the sender
  58     @param context - sender context, to match reply w/ request
  59     @param vip_ip_prefix - VIP IP address (IPv4 in lower order 32 bits).
  60     @param vip_prefix_length - VIP IP prefix length (96 + 'IPv4 prefix length' for IPv4).
  61     @param protocol - tcp or udp.
  62     @param port - destination port.
  63     @param as_address - The application server address (IPv4 in lower order 32 bits).
  64     @param is_del - The AS should be removed.
  65     @param is_flush - The sessions related to this AS should be flushed.
  66 */
  67 autoreply define lb_add_del_as {
  68   u32 client_index;
  69   u32 context;
  70   u8 vip_ip_prefix[16];
  71   u8 vip_prefix_length;
  72   u8 protocol;
  73   u16 port;
  74   u8 as_address[16];
  75   u8 is_del;
  76   u8 is_flush;
  77 };
  78
  79 /** \brief Flush a given vip
  80     @param client_index - opaque cookie to identify the sender
  81     @param context - sender context, to match reply w/ request
  82     @param ip_prefix - IP address (IPv4 in lower order 32 bits).
  83     @param prefix_length - IP prefix length (96 + 'IPv4 prefix length' for IPv4).
  84     @param protocol - tcp or udp.
  85     @param port - destination port.
  86 */
  87 autoreply define lb_flush_vip {
  88   u32 client_index;
  89   u32 context;
  90   u8 ip_prefix[16];
  91   u8 prefix_length;
  92   u8 protocol;
  93   u16 port;
  94 };