X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=docs%2Fcli-reference%2Finterface%2Fhardware.rst;fp=docs%2Freference%2Fcmdreference%2Finterface%2Fhardware.rst;h=0d124385fac7262b555dd13afdb3c1a144808d85;hb=9ad39c026c8a3c945a7003c4aa4f5cb1d4c80160;hp=2c28d655c4ac3a43c1bfdad8c364bf5a1c6407cb;hpb=f47122e07e1ecd0151902a3cabe46c60a99bee8e;p=vpp.git diff --git a/docs/reference/cmdreference/interface/hardware.rst b/docs/cli-reference/interface/hardware.rst similarity index 95% rename from docs/reference/cmdreference/interface/hardware.rst rename to docs/cli-reference/interface/hardware.rst index 2c28d655c4a..0d124385fac 100644 --- a/docs/reference/cmdreference/interface/hardware.rst +++ b/docs/cli-reference/interface/hardware.rst @@ -4,7 +4,7 @@ Hardware-Interfaces Commands ============================ -This section contains those interface commands that are related to hardware-interfaces: +This section contains those interface commands that are related to hardware-interfaces: * `Show Bridge-Domain`_ @@ -16,16 +16,14 @@ This section contains those interface commands that are related to hardware-inte Show Bridge-Domain +++++++++++++++++++ -Summary/Usage -------------- +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. -show bridge-domain [*bridge-domain-id* [detail|int|arp| *bd-tag* ]] -Description ------------ +.. code-block:: console + + show bridge-domain [*bridge-domain-id* [detail|int|arp| *bd-tag* ]] -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 ------------- @@ -70,17 +68,16 @@ following optional parameters: - **detail**: Also display all remaining attributes and extended statistics. -.. note:: +.. 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] [ [ [..]]] [ [ [..]]]. + Examples -------- Example of how to display default data for all interfaces: @@ -139,13 +136,10 @@ Clear the extended statistics for all or a list of given interfaces (statistics associated with the **show hardware-interfaces** command). -Summary/Usage -------------- - .. code-block:: shell clear hardware-interfaces [ [ [..]]] [ [ [..]]]. - + Examples -------- @@ -158,7 +152,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): +(where 2 is the software index): .. code-block:: console