FD.io VPP  v17.01.1-3-gc6833f8
Vector Packet Processing
lb.api
Go to the documentation of this file.
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 {
16  u8 ip6_src_address[16];
19 };
20 
21 define lb_conf_reply {
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 {
39  u8 ip_prefix[16];
44 };
45 
46 define lb_add_del_vip_reply {
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 {
62  u8 vip_ip_prefix[16];
64  u8 as_address[16];
66 };
67 
68 define lb_add_del_as_reply {
71 };
u32 flow_timeout
Definition: lb.api:18
int lb_conf(ip4_address_t *ip4_address, ip6_address_t *ip6_address, u32 per_cpu_sticky_buckets, u32 flow_timeout)
Fix global load-balancer parameters.
Definition: lb.c:362
u32 client_index
Definition: lb.api:13
int i32
Definition: types.h:81
u32 context
Definition: lb.api:14
u32 new_flows_table_length
Definition: lb.api:42
u32 sticky_buckets_per_core
Definition: lb.api:17
unsigned int u32
Definition: types.h:88
unsigned char u8
Definition: types.h:56
u32 ip4_src_address
Definition: lb.api:15