diff options
Diffstat (limited to 'docs/reference/cmdreference/interface/hardware.rst')
| -rw-r--r-- | docs/reference/cmdreference/interface/hardware.rst | 83 |
1 files changed, 69 insertions, 14 deletions
diff --git a/docs/reference/cmdreference/interface/hardware.rst b/docs/reference/cmdreference/interface/hardware.rst index f4d334fd935..4ae8fd59559 100644 --- a/docs/reference/cmdreference/interface/hardware.rst +++ b/docs/reference/cmdreference/interface/hardware.rst @@ -1,32 +1,87 @@ -.. _hardwarecommands: +.. _interface: .. toctree:: +Hardware-Interfaces Commands +============================= +This section contains those interface commands that are related to hardware-interfaces: + + +* `Show Bridge-Domain`_ +* `Show Hardware-Interfaces`_ +* `Clear Hardware-Interfaces`_ + +.. note:: For a complete list of CLI Debug commands refer to the Debug CLI section of the `Source Code Documents <https://docs.fd.io/vpp/18.07/clicmd.html>`_ . + +Show Bridge-Domain ++++++++++++++++++++ + +Summary/Usage +-------------- + +show bridge-domain [*bridge-domain-id* [detail|int|arp| *bd-tag* ]] + +Description +------------ + +Show a summary of all the bridge-domain instances or detailed view of a single bridge-domain. Bridge-domains are created by adding an interface to a bridge using the **set interface l2 bridge** command. + +Example Usage +-------------- +.. code-block:: console + + Example of displaying all bridge-domains: + + vpp# show bridge-domain + + ID Index Learning U-Forwrd UU-Flood Flooding ARP-Term BVI-Intf + 0 0 off off off off off local0 + 200 1 on on on on off N/A + + Example of displaying details of a single bridge-domains: + + vpp# show bridge-domain 200 detail + + ID Index Learning U-Forwrd UU-Flood Flooding ARP-Term BVI-Intf + 200 1 on on on on off N/A + + Interface Index SHG BVI VLAN-Tag-Rewrite + GigabitEthernet0/8/0.200 3 0 - none + GigabitEthernet0/9/0.200 4 0 - none + +Declaration and Implementation +------------------------------- + +**Declaration:** bd_show_cli (src/vnet/l2/l2_bd.c line 1151) + +**Implementation:** bd_show + Show Hardware-Interfaces -======================== ++++++++++++++++++++++++++ Display more detailed information about all or a list of given interfaces. The verboseness of the output can be controlled by the following optional parameters: -- brief: Only show name, index and state (default for bonded +- **brief**: Only show name, index and state (default for bonded interfaces). -- verbose: Also display additional attributes (default for all other +- **verbose**: Also display additional attributes (default for all other interfaces). -- detail: Also display all remaining attributes and extended +- **detail**: Also display all remaining attributes and extended statistics. -**To limit the output of the command to bonded interfaces and their -slave interfaces, use the '*bond*' optional parameter.** +.. note:: + To limit the output of the command to bonded interfaces and their + slave interfaces, use the '*bond*' optional parameter. Summary/Usage -------------- +-------------- .. code-block:: shell show hardware-interfaces [brief|verbose|detail] [bond] [<interface> [<interface> [..]]] [<sw_idx> [<sw_idx> [..]]]. Examples --------- +--------- Example of how to display default data for all interfaces: .. code-block:: console @@ -56,7 +111,7 @@ Example of how to display default data for all interfaces: local0 0 down local0 local -Example of how to display '*verbose*' data for an interface by name and software index (where 2 is the software index): +Example of how to display *verbose* data for an interface by name and software index (where 2 is the software index): .. code-block:: console @@ -76,10 +131,10 @@ Example of how to display '*verbose*' data for an interface by name and software cpu socket 0 Clear Hardware-Interfaces -========================= ++++++++++++++++++++++++++++ Clear the extended statistics for all or a list of given interfaces -(statistics associated with the '*show hardware-interfaces*' command). +(statistics associated with the **show hardware-interfaces** command). Summary/Usage @@ -88,7 +143,7 @@ Summary/Usage .. code-block:: shell clear hardware-interfaces [<interface> [<interface> [..]]] [<sw_idx> [<sw_idx> [..]]]. - + Examples -------- @@ -100,7 +155,7 @@ Example of how to clear the extended statistics for all interfaces: vpp# clear hardware-interfaces -Example of how to clear the extended statistics for an interface by name and software index (where 2 is the software index): +Example of how to clear the extended statistics for an interface by name and software index (where 2 is the software index): .. code-block:: console |