X-Git-Url: https://gerrit.fd.io/r/gitweb?p=vpp.git;a=blobdiff_plain;f=src%2Fplugins%2Facl%2Facl.api;h=eb0594650d0bcd0e5f9c5fded0328b6305f866f0;hp=b35267d28ed0a4b50908f1872231690888b7d6b0;hb=709dad304;hpb=18cd91c61116f49468ac4596cddb4f1f8fc04bbc

diff --git a/src/plugins/acl/acl.api b/src/plugins/acl/acl.api
index b35267d28ed..eb0594650d0 100644
--- a/src/plugins/acl/acl.api
+++ b/src/plugins/acl/acl.api
@@ -109,6 +109,7 @@ manual_print manual_endian define acl_add_replace
   u8 tag[64]; /* What gets in here gets out in the corresponding tag field when dumping the ACLs. */
   u32 count;
   vl_api_acl_rule_t r[count];
+  option vat_help = "<acl-idx> [<ipv4|ipv6> <permit|permit+reflect|deny|action N> [src IP/plen] [dst IP/plen] [sport X-Y] [dport X-Y] [proto P] [tcpflags FL MASK], ... , ...";
 };
 
 /** \brief Reply to add/replace ACL
@@ -135,6 +136,7 @@ autoreply manual_print define acl_del
   u32 client_index;
   u32 context;
   u32 acl_index;
+  option vat_help = "<acl-idx>";
 };
 
 /* acl_interface_add_del(_reply) to be deprecated in lieu of acl_interface_set_acl_list */
@@ -160,6 +162,7 @@ autoreply manual_print define acl_interface_add_del
   u8 is_input;
   u32 sw_if_index;
   u32 acl_index;
+  option vat_help = "<intfc> | sw_if_index <if-idx> [add|del] [input|output] acl <acl-idx>";
 };
 
 /** \brief Set the vector of input/output ACLs checked for an interface
@@ -179,6 +182,7 @@ autoreply manual_print define acl_interface_set_acl_list
   u8 count;
   u8 n_input; /* First n_input ACLs are set as a list of input ACLs, the rest are applied as output */
   u32 acls[count];
+  option vat_help = "<intfc> | sw_if_index <if-idx> input [acl-idx list] output [acl-idx list]";
 };
 
 /** \brief Reply to set the ACL list on an interface
@@ -197,6 +201,7 @@ define acl_dump
   u32 client_index;
   u32 context;
   u32 acl_index; /* ~0 for all ACLs */
+  option vat_help = "[<acl-idx>]";
 };
 
 /** \brief Details about a single ACL contents
@@ -227,6 +232,7 @@ define acl_interface_list_dump
   u32 client_index;
   u32 context;
   u32 sw_if_index; /* ~0 for all interfaces */
+  option vat_help = "[<intfc> | sw_if_index <if-idx>]";
 };
 
 /** \brief Details about a single ACL contents
@@ -261,6 +267,7 @@ manual_endian manual_print define macip_acl_add
   u8 tag[64];
   u32 count;
   vl_api_macip_acl_rule_t r[count];
+  option vat_help = "...";
 };
 
 /** \brief Reply to add MACIP ACL
@@ -293,6 +300,7 @@ manual_endian manual_print define macip_acl_add_replace
   u8 tag[64];
   u32 count;
   vl_api_macip_acl_rule_t r[count];
+  option vat_help = "<acl-idx> [<ipv4|ipv6> <permit|deny|action N> [count <count>] [src] ip <ipaddress/[plen]> mac <mac> mask <mac_mask>, ... , ...";
 };
 
 /** \brief Reply to add/replace MACIP ACL
@@ -319,6 +327,7 @@ autoreply manual_print define macip_acl_del
   u32 client_index;
   u32 context;
   u32 acl_index;
+  option vat_help = "<acl-idx>";
 };
 
 /** \brief Add or delete a MACIP ACL to/from interface
@@ -337,6 +346,7 @@ autoreply manual_print define macip_acl_interface_add_del
   /* MACIP ACLs are always input */
   u32 sw_if_index;
   u32 acl_index;
+  option vat_help = "<intfc> | sw_if_index <if-idx> [add|del] acl <acl-idx>";
 };
 
 /** \brief Dump one or all defined MACIP ACLs
@@ -350,6 +360,7 @@ define macip_acl_dump
   u32 client_index;
   u32 context;
   u32 acl_index; /* ~0 for all ACLs */
+  option vat_help = "[<acl-idx>]";
 };
 
 /** \brief Details about one MACIP ACL
@@ -438,6 +449,7 @@ autoreply manual_print define acl_interface_set_etype_whitelist
   u8 count; /* Total number of ethertypes in the whitelist */
   u8 n_input; /* first n_input ethertypes are input, the rest - output */
   u16 whitelist[count];
+  option vat_help = "<intfc> | sw_if_index <if-idx> input [ethertype list] output [ethertype list]";
 };
 
 /** \brief Dump the list(s) of Ethertype whitelists applied to specific or all interfaces
@@ -451,6 +463,7 @@ define acl_interface_etype_whitelist_dump
   u32 client_index;
   u32 context;
   u32 sw_if_index; /* ~0 for all interfaces */
+  option vat_help = "[<intfc> | sw_if_index <if-idx>]";
 };
 
 /** \brief Details about ethertype whitelist on a single interface
@@ -481,4 +494,5 @@ autoreply define acl_stats_intf_counters_enable
   u32 client_index;
   u32 context;
   bool enable;
+  option vat_help = "[disable]";
 };