aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPaul Vinciguerra <pvinci@vinciconsulting.com>2019-03-14 09:47:29 -0700
committerDave Barach <openvpp@barachs.net>2019-03-14 20:09:20 +0000
commitbb2c7b580ecf56f06ccc871c4a1b0530458e47a8 (patch)
tree4487f6a6e15375e34afb7dc18ec69315daf74aa7
parent6233111b0e36f23d3d269834127aae1b3f77cdf1 (diff)
Update documentation for src/vnet/interface.api sw_interface_dump
Change-Id: Idcb15632ffe45ec269f2482be2ada967f41f19be Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
-rw-r--r--src/vnet/interface.api8
1 files changed, 7 insertions, 1 deletions
diff --git a/src/vnet/interface.api b/src/vnet/interface.api
index 69de722b78b..1af323e0a44 100644
--- a/src/vnet/interface.api
+++ b/src/vnet/interface.api
@@ -203,7 +203,13 @@ 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 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;