lb: remove api boilerplate
[vpp.git] / src / plugins / lb / lb.api
index b9f5c22..e30bab6 100644 (file)
@@ -1,5 +1,6 @@
 option version = "1.0.0";
 import "plugins/lb/lb_types.api";
+import "vnet/interface_types.api";
 
 /** \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
@@ -19,6 +20,7 @@ autoreply manual_print define lb_conf
   vl_api_ip6_address_t ip6_src_address;
   u32 sticky_buckets_per_core;
   u32 flow_timeout;
+  option vat_help = "[ip4-src-address <addr>] [ip6-src-address <addr>] [buckets <n>] [timeout <s>]";
 };
 
 /** \brief Add a virtual address (or prefix)
@@ -49,6 +51,7 @@ autoreply manual_print define lb_add_del_vip {
   u16 node_port;
   u32 new_flows_table_length [default=1024];
   bool is_del;
+  option vat_help = "<prefix> [protocol (tcp|udp) port <n>] [encap (gre6|gre4|l3dsr|nat4|nat6)] [dscp <n>] [type (nodeport|clusterip) target_port <n>] [new_len <n>] [del]";
 };
 
 /** \brief Add an application server for a given VIP
@@ -70,6 +73,7 @@ autoreply manual_print define lb_add_del_as {
   vl_api_address_t as_address;
   bool is_del;
   bool is_flush;
+  option vat_help = "<vip-prefix> [protocol (tcp|udp) port <n>] [<address>] [del] [flush]";
 };
 
 /** \brief Flush a given vip
@@ -129,6 +133,7 @@ define lb_as_dump{
   vl_api_address_with_prefix_t pfx;
   u8 protocol;
   u16 port;
+  option vat_help = "<vip-prefix> [protocol (tcp|udp) port <n>]";
 };
 
 /** \brief lb_as_details
@@ -143,3 +148,28 @@ define lb_as_details {
   u32 in_use_since;
 };
 
+/** \brief Enable/disable NAT4 feature on the interface
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param is_add - true if add, false if delete
+    @param sw_if_index - software index of the interface
+*/
+autoreply define lb_add_del_intf_nat4 {
+  u32 client_index;
+  u32 context;
+  bool is_add;
+  vl_api_interface_index_t sw_if_index;
+};
+
+/** \brief Enable/disable NAT6 feature on the interface
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param is_add - true if add, false if delete
+    @param sw_if_index - software index of the interface
+*/
+autoreply define lb_add_del_intf_nat6 {
+  u32 client_index;
+  u32 context;
+  bool is_add;
+  vl_api_interface_index_t sw_if_index;
+};