summaryrefslogtreecommitdiffstats
path: root/src/plugins/lb/lb.api
diff options
context:
space:
mode:
Diffstat (limited to 'src/plugins/lb/lb.api')
-rw-r--r--src/plugins/lb/lb.api9
1 files changed, 5 insertions, 4 deletions
diff --git a/src/plugins/lb/lb.api b/src/plugins/lb/lb.api
index d36f857f5de..190e32011b3 100644
--- a/src/plugins/lb/lb.api
+++ b/src/plugins/lb/lb.api
@@ -1,6 +1,7 @@
option version = "1.0.0";
+import "vnet/ip/ip_types.api";
-/** \brief Configure Load-Balancer global parameters
+/** \brief Configure Load-Balancer global parameters (unlike the CLI, both ip4_src_address and ip6_src_address need to be specified.
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param ip4_src_address - IPv4 address to be used as source for IPv4 traffic(applicable in GRE4/GRE6/NAT4/NAT6 mode only).
@@ -14,8 +15,8 @@ autoreply define lb_conf
{
u32 client_index;
u32 context;
- u32 ip4_src_address;
- u8 ip6_src_address[16];
+ vl_api_ip4_address_t ip4_src_address;
+ vl_api_ip6_address_t ip6_src_address;
u32 sticky_buckets_per_core;
u32 flow_timeout;
};
@@ -26,7 +27,7 @@ autoreply define lb_conf
@param ip_prefix - IP address (IPv4 in lower order 32 bits).
@param prefix_length - IP prefix length (96 + 'IPv4 prefix length' for IPv4).
@param protocol - tcp or udp.
- @param port - destination port.
+ @param port - destination port. (0) means 'all-port VIP'
@param encap - Encap is ip4 GRE(0) or ip6 GRE(1) or L3DSR(2) or NAT4(3) or NAT6(4).
@param dscp - DSCP bit corresponding to VIP(applicable in L3DSR mode only).
@param type - service type(applicable in NAT4/NAT6 mode only).