diff options
author | Billy McFall <bmcfall@redhat.com> | 2016-09-13 21:47:55 -0400 |
---|---|---|
committer | Chris Luke <chris_luke@comcast.com> | 2016-09-20 14:42:58 +0000 |
commit | 2d085d9c6185caa2a84c5fd8740d279336f2d702 (patch) | |
tree | 0d4991314d58710bb1b2a6f252a167a010f23665 /vnet/vnet/ethernet/interface.c | |
parent | f07fb71b6276429bd81b5ae3669c8f33d38df1fa (diff) |
VPP-282: Document changes for vnet/vnet/ethernet
Change-Id: Ie75f43516fdd76ba3720f65f38d66f14749e3e2d
Signed-off-by: Billy McFall <bmcfall@redhat.com>
Diffstat (limited to 'vnet/vnet/ethernet/interface.c')
-rw-r--r-- | vnet/vnet/ethernet/interface.c | 60 |
1 files changed, 58 insertions, 2 deletions
diff --git a/vnet/vnet/ethernet/interface.c b/vnet/vnet/ethernet/interface.c index 285fd895f01..0b19b51d3be 100644 --- a/vnet/vnet/ethernet/interface.c +++ b/vnet/vnet/ethernet/interface.c @@ -43,6 +43,13 @@ #include <vnet/ethernet/ethernet.h> #include <vnet/l2/l2_input.h> +/** + * @file + * @brief Loopback Interfaces. + * + * This file contains code to manage loopback interfaces. + */ + static uword ethernet_set_rewrite (vnet_main_t * vnm, u32 sw_if_index, @@ -466,14 +473,36 @@ create_simulated_ethernet_interfaces (vlib_main_t * vm, return 0; } +/*? + * Create a loopback interface. Optionally, a MAC Address can be + * provided. If not provided, de:ad:00:00:00:<loopId> will be used. + * + * @cliexpar + * The following two command syntaxes are equivalent: + * @cliexcmd{loopback create-interface [mac <mac-addr>]} + * @cliexcmd{create loopback interface [mac <mac-addr>]} + * Example of how to create a loopback interface: + * @cliexcmd{loopback create-interface} +?*/ /* *INDENT-OFF* */ VLIB_CLI_COMMAND (create_simulated_ethernet_interface_command, static) = { .path = "loopback create-interface", - .short_help = "Create Loopback ethernet interface [mac <mac-addr>]", + .short_help = "loopback create-interface [mac <mac-addr>]", .function = create_simulated_ethernet_interfaces, }; /* *INDENT-ON* */ +/*? + * Create a loopback interface. Optionally, a MAC Address can be + * provided. If not provided, de:ad:00:00:00:<loopId> will be used. + * + * @cliexpar + * The following two command syntaxes are equivalent: + * @cliexcmd{loopback create-interface [mac <mac-addr>]} + * @cliexcmd{create loopback interface [mac <mac-addr>]} + * Example of how to create a loopback interface: + * @cliexcmd{create loopback interface} +?*/ /* *INDENT-OFF* */ VLIB_CLI_COMMAND (create_loopback_interface_command, static) = { .path = "create loopback interface", @@ -593,14 +622,34 @@ delete_sub_interface (vlib_main_t * vm, return 0; } +/*? + * Delete a loopback interface. + * + * @cliexpar + * The following two command syntaxes are equivalent: + * @cliexcmd{loopback delete-interface intfc <interface>} + * @cliexcmd{delete loopback interface intfc <interface>} + * Example of how to delete a loopback interface: + * @cliexcmd{loopback delete-interface intfc loop0} +?*/ /* *INDENT-OFF* */ VLIB_CLI_COMMAND (delete_simulated_ethernet_interface_command, static) = { .path = "loopback delete-interface", - .short_help = "Delete Loopback ethernet interface intfc <interface>", + .short_help = "loopback delete-interface intfc <interface>", .function = delete_simulated_ethernet_interfaces, }; /* *INDENT-ON* */ +/*? + * Delete a loopback interface. + * + * @cliexpar + * The following two command syntaxes are equivalent: + * @cliexcmd{loopback delete-interface intfc <interface>} + * @cliexcmd{delete loopback interface intfc <interface>} + * Example of how to delete a loopback interface: + * @cliexcmd{delete loopback interface intfc loop0} +?*/ /* *INDENT-OFF* */ VLIB_CLI_COMMAND (delete_loopback_interface_command, static) = { .path = "delete loopback interface", @@ -609,6 +658,13 @@ VLIB_CLI_COMMAND (delete_loopback_interface_command, static) = { }; /* *INDENT-ON* */ +/*? + * Delete a sub-interface. + * + * @cliexpar + * Example of how to delete a sub-interface: + * @cliexcmd{delete sub-interface GigabitEthernet0/8/0.200} +?*/ /* *INDENT-OFF* */ VLIB_CLI_COMMAND (delete_sub_interface_command, static) = { .path = "delete sub-interface", |