Code Review
/
vpp.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
review
|
tree
raw
|
inline
| side by side
docs: better docs, mv doxygen to sphinx
[vpp.git]
/
docs
/
cli-reference
/
interface
/
hardware.rst
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
2c28d65
..
0d12438
100644
(file)
--- a/
docs/reference/cmdreference/interface/hardware.rst
+++ b/
docs/cli-reference/interface/hardware.rst
@@
-4,7
+4,7
@@
Hardware-Interfaces Commands
============================
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`_
* `Show Bridge-Domain`_
@@
-16,16
+16,14
@@
This section contains those interface commands that are related to hardware-inte
Show Bridge-Domain
+++++++++++++++++++
Show Bridge-Domain
+++++++++++++++++++
-S
ummary/Usage
--------------
+S
how 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
-------------
Example Usage
-------------
@@
-70,17
+68,16
@@
following optional parameters:
- **detail**: Also display all remaining attributes and extended
statistics.
- **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.
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> [..]]].
.. 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:
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).
(statistics associated with the **show hardware-interfaces** command).
-Summary/Usage
--------------
-
.. code-block:: shell
clear hardware-interfaces [<interface> [<interface> [..]]] [<sw_idx> [<sw_idx> [..]]].
.. code-block:: shell
clear hardware-interfaces [<interface> [<interface> [..]]] [<sw_idx> [<sw_idx> [..]]].
-
+
Examples
--------
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
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
.. code-block:: console