api: Add to interface crud - read by sw_if_index.

[vpp.git] / src / vnet / interface.api

diff --git a/src/vnet/interface.api b/src/vnet/interface.api
index 69de722..0cebd00 100644 (file)
--- a/src/vnet/interface.api
+++ b/src/vnet/interface.api
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-option version = "2.2.0";
+option version = "2.2.1";
 
 import "vnet/interface_types.api";
 
@@ -203,11 +203,19 @@ define sw_interface_details
   u32 i_sid;
 };
 
-/* works */
+/** \brief Request all or filtered subset of sw_interface_details
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param sw_if_index - ~0 if ignore, index of the interface to filter on
+    @param name_filter_valid - 1 if requesting a filtered subset of records else 0
+    @param name_filter - interface name substring filter. Eg. loop1 returns [loop1, loop10]
+*/
+
 define sw_interface_dump
 {
   u32 client_index;
   u32 context;
+  vl_api_interface_index_t sw_if_index;
   u8 name_filter_valid;
   u8 name_filter[49];
 };