X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fplugins%2Facl%2Facl.api;h=b58ed76673a834859af9437a2e2dc105cfae751a;hb=27fe75a;hp=3b334113f1d93db3d18d3a88886ad4c514698b67;hpb=11b8dbf78af49d270a0e72abe7dea73eec30d85f;p=vpp.git

diff --git a/src/plugins/acl/acl.api b/src/plugins/acl/acl.api
index 3b334113f1d..b58ed76673a 100644
--- a/src/plugins/acl/acl.api
+++ b/src/plugins/acl/acl.api
@@ -19,6 +19,7 @@
     used to control the ACL plugin
 */
 
+option version = "1.0.0";
 
 /** \brief Get the plugin version
     @param client_index - opaque cookie to identify the sender
@@ -44,6 +45,30 @@ define acl_plugin_get_version_reply
   u32 minor;
 };
 
+/** \brief Control ping from client to api server request
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+*/
+define acl_plugin_control_ping
+{
+  u32 client_index;
+  u32 context;
+};
+
+/** \brief Control ping from the client to the server response
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param retval - return code for the request
+    @param vpe_pid - the pid of the vpe, returned by the server
+*/
+define acl_plugin_control_ping_reply
+{
+  u32 context;
+  i32 retval;
+  u32 client_index;
+  u32 vpe_pid;
+};
+
 /** \brief Access List Rule entry
     @param is_permit - deny (0), permit (1), or permit+reflect(2) action on this rule.
     @param is_ipv6   - IP addresses in this rule are IPv6 (1) or IPv4 (0)
@@ -281,7 +306,7 @@ define acl_interface_list_details
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
     @param tag - descriptive value for this MACIP ACL
-    @param count - number of rules in this ACL
+    @param count - number of rules in this MACIP ACL
     @param r - vector of MACIP ACL rules
 */
 
@@ -296,7 +321,7 @@ manual_endian manual_print define macip_acl_add
 
 /** \brief Reply to add MACIP ACL
     @param context - returned sender context, to match reply w/ request
-    @param acl_index - index of the newly created ACL
+    @param acl_index - index of the newly created MACIP ACL
     @param retval 0 - no error
 */
 
@@ -307,6 +332,38 @@ define macip_acl_add_reply
   i32 retval;
 };
 
+/** \brief Add/Replace a MACIP ACL
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param acl_index - an existing MACIP ACL entry (0..0xfffffffe) to replace, or 0xffffffff to make new MACIP ACL
+    @param tag - descriptive value for this MACIP ACL
+    @param count - number of rules in this MACIP ACL
+    @param r - vector of MACIP ACL rules
+*/
+
+manual_endian manual_print define macip_acl_add_replace
+{
+  u32 client_index;
+  u32 context;
+  u32 acl_index; /* ~0 to add, existing MACIP ACL# to replace */
+  u8 tag[64];
+  u32 count;
+  vl_api_macip_acl_rule_t r[count];
+};
+
+/** \brief Reply to add/replace MACIP ACL
+    @param context - returned sender context, to match reply w/ request
+    @param acl_index - index of the newly created MACIP ACL
+    @param retval 0 - no error
+*/
+
+define macip_acl_add_replace_reply
+{
+  u32 context;
+  u32 acl_index;
+  i32 retval;
+};
+
 /** \brief Delete a MACIP ACL
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -323,7 +380,7 @@ autoreply manual_print define macip_acl_del
 /** \brief Add or delete a MACIP ACL to/from interface
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
-    @param is_add - add (1) or delete (0) ACL from being used on an interface
+    @param is_add - add (1) or delete (0) MACIP ACL from being used on an interface
     @param sw_if_index - interface to apply the action to
     @param acl_index - MACIP ACL index
 */
@@ -333,7 +390,7 @@ autoreply manual_print define macip_acl_interface_add_del
   u32 client_index;
   u32 context;
   u8 is_add;
-  /* macip ACLs are always input */
+  /* MACIP ACLs are always input */
   u32 sw_if_index;
   u32 acl_index;
 };
@@ -341,7 +398,7 @@ autoreply manual_print define macip_acl_interface_add_del
 /** \brief Dump one or all defined MACIP ACLs
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
-    @param acl_index - MACIP ACL index or ~0 to dump all ACLs
+    @param acl_index - MACIP ACL index or ~0 to dump all MACIP ACLs
 */
 
 define macip_acl_dump
@@ -356,7 +413,7 @@ define macip_acl_dump
     @param acl_index - index of this MACIP ACL
     @param tag - descriptive tag which was supplied during the creation
     @param count - length of the vector of MACIP ACL rules
-    @param r - rules comprising this ACL
+    @param r - rules comprising this MACIP ACL
 */
 
 manual_endian manual_print define macip_acl_details
@@ -382,7 +439,7 @@ define macip_acl_interface_get
 /** \brief Reply with the vector of MACIP ACLs by sw_if_index
     @param context - returned sender context, to match reply w/ request
     @param count - total number of elements in the vector
-    @param acls - the vector of active MACACL indices per sw_if_index
+    @param acls - the vector of active MACIP ACL indices per sw_if_index
 */
 
 define macip_acl_interface_get_reply
@@ -392,3 +449,80 @@ define macip_acl_interface_get_reply
   u32 acls[count];
 };
 
+/** \brief Dump the list(s) of MACIP ACLs applied to specific or all interfaces
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param sw_if_index - interface to dump the MACIP ACL list for
+*/
+
+define macip_acl_interface_list_dump
+{
+  u32 client_index;
+  u32 context;
+  u32 sw_if_index; /* ~0 for all interfaces */
+};
+
+/** \brief Details about a single MACIP ACL contents
+    @param context - returned sender context, to match reply w/ request
+    @param sw_if_index - interface for which the list of MACIP ACLs is applied
+    @param count - total length of acl indices vector
+    @param acls - the vector of MACIP ACL indices
+*/
+
+define macip_acl_interface_list_details
+{
+  u32 context;
+  u32 sw_if_index;
+  u8 count;
+  u32 acls[count];
+};
+
+/** \brief Set the ethertype whitelists on an interface. Takes effect when applying ACLs on the interface, so must be given prior.
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param sw_if_index - the interface to alter the list of ACLs on
+    @param count - total number of whitelisted ethertypes in the vector
+    @param n_input - this many first elements correspond to input whitelisted ethertypes, the rest - output
+    @param whitelist - vector of whitelisted ethertypes
+*/
+
+autoreply manual_print define acl_interface_set_etype_whitelist
+{
+  u32 client_index;
+  u32 context;
+  u32 sw_if_index;
+  u8 count; /* Total number of ethertypes in the whitelist */
+  u8 n_input; /* first n_input ethertypes are input, the rest - output */
+  u16 whitelist[count];
+};
+
+/** \brief Dump the list(s) of Ethertype whitelists applied to specific or all interfaces
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param sw_if_index - interface to dump the ethertype whitelist for
+*/
+
+define acl_interface_etype_whitelist_dump
+{
+  u32 client_index;
+  u32 context;
+  u32 sw_if_index; /* ~0 for all interfaces */
+};
+
+/** \brief Details about ethertype whitelist on a single interface
+    @param context - returned sender context, to match reply w/ request
+    @param sw_if_index - interface for which the list of MACIP ACLs is applied
+    @param count - total number of whitelisted ethertypes in the vector
+    @param n_input - this many first elements correspond to input whitelisted ethertypes, the rest - output
+    @param whitelist - vector of whitelisted ethertypes
+*/
+
+define acl_interface_etype_whitelist_details
+{
+  u32 context;
+  u32 sw_if_index;
+  u8 count;
+  u8 n_input; /* first n_input ethertypes are input, the rest - output */
+  u16 whitelist[count];
+};
+