docs/cli-reference/interface/hardware.rst

   1 .. _interface:
   2
   3 .. toctree::
   4
   5 Hardware-Interfaces Commands
   6 ============================
   7 This section contains those interface commands that are related to hardware-interfaces:
   8
   9
  10 * `Show Bridge-Domain`_
  11 * `Show Hardware-Interfaces`_
  12 * `Clear Hardware-Interfaces`_
  13
  14 .. 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>`_ .
  15
  16 Show Bridge-Domain
  17 +++++++++++++++++++
  18
  19 Show a summary of all the bridge-domain instances or detailed view of a single bridge-domain.
  20 Bridge-domains are created by adding an interface to a bridge using the **set interface l2 bridge** command.
  21
  22
  23 .. code-block:: console
  24
  25     show bridge-domain [*bridge-domain-id* [detail|int|arp| *bd-tag* ]]
  26
  27
  28 Example Usage
  29 -------------
  30 .. code-block:: console
  31
  32     Example of displaying all bridge-domains:
  33
  34     vpp# show bridge-domain
  35
  36      ID   Index   Learning   U-Forwrd   UU-Flood   Flooding   ARP-Term     BVI-Intf
  37      0      0        off        off        off        off        off        local0
  38     200     1        on         on         on         on         off          N/A
  39
  40     Example of displaying details of a single bridge-domains:
  41
  42     vpp# show bridge-domain 200 detail
  43
  44      ID   Index   Learning   U-Forwrd   UU-Flood   Flooding   ARP-Term     BVI-Intf
  45     200     1        on         on         on         on         off          N/A
  46
  47              Interface           Index  SHG  BVI        VLAN-Tag-Rewrite
  48      GigabitEthernet0/8/0.200      3     0    -               none
  49      GigabitEthernet0/9/0.200      4     0    -               none
  50
  51 Declaration and Implementation
  52 ------------------------------
  53
  54 **Declaration:** bd_show_cli (src/vnet/l2/l2_bd.c line 1151)
  55
  56 **Implementation:** bd_show
  57
  58 Show Hardware-Interfaces
  59 +++++++++++++++++++++++++
  60 Display more detailed information about all or a list of given
  61 interfaces. The verboseness of the output can be controlled by the
  62 following optional parameters:
  63
  64 -  **brief**: Only show name, index and state (default for bonded
  65    interfaces).
  66 -  **verbose**: Also display additional attributes (default for all other
  67    interfaces).
  68 -  **detail**: Also display all remaining attributes and extended
  69    statistics.
  70
  71 .. note::
  72         To limit the output of the command to bonded interfaces and their
  73         slave interfaces, use the '*bond*' optional parameter.
  74
  75
  76 .. code-block:: shell
  77
  78     show hardware-interfaces [brief|verbose|detail] [bond] [<interface> [<interface> [..]]] [<sw_idx> [<sw_idx> [..]]].
  79
  80
  81 Examples
  82 --------
  83 Example of how to display default data for all interfaces:
  84
  85 .. code-block:: console
  86
  87     vpp# show hardware-interfaces
  88                   Name                Idx   Link  Hardware
  89     GigabitEthernet7/0/0               1     up   GigabitEthernet7/0/0
  90       Ethernet address ec:f4:bb:c0:bc:fc
  91       Intel e1000
  92         carrier up full duplex speed 1000 mtu 9216
  93         rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
  94         cpu socket 0
  95     GigabitEthernet7/0/1               2     up   GigabitEthernet7/0/1
  96       Ethernet address ec:f4:bb:c0:bc:fd
  97       Intel e1000
  98         carrier up full duplex speed 1000 mtu 9216
  99         rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
 100         cpu socket 0
 101     VirtualEthernet0/0/0               3     up   VirtualEthernet0/0/0
 102       Ethernet address 02:fe:a5:a9:8b:8e
 103     VirtualEthernet0/0/1               4     up   VirtualEthernet0/0/1
 104       Ethernet address 02:fe:c0:4e:3b:b0
 105     VirtualEthernet0/0/2               5     up   VirtualEthernet0/0/2
 106       Ethernet address 02:fe:1f:73:92:81
 107     VirtualEthernet0/0/3               6     up   VirtualEthernet0/0/3
 108       Ethernet address 02:fe:f2:25:c4:68
 109     local0                             0    down  local0
 110       local
 111
 112 Example of how to display *verbose* data for an interface by name and software index
 113 (where 2 is the software index):
 114
 115 .. code-block:: console
 116
 117     vpp# show hardware-interfaces GigabitEthernet7/0/0 2 verbose
 118                    Name                Idx   Link  Hardware
 119     GigabitEthernet7/0/0               1     up   GigabitEthernet7/0/0
 120       Ethernet address ec:f4:bb:c0:bc:fc
 121       Intel e1000
 122         carrier up full duplex speed 1000 mtu 9216
 123         rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
 124         cpu socket 0
 125     GigabitEthernet7/0/1               2    down  GigabitEthernet7/0/1
 126       Ethernet address ec:f4:bb:c0:bc:fd
 127       Intel e1000
 128         carrier up full duplex speed 1000 mtu 9216
 129         rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
 130         cpu socket 0
 131
 132 Clear Hardware-Interfaces
 133 +++++++++++++++++++++++++
 134
 135 Clear the extended statistics for all or a list of given interfaces
 136 (statistics associated with the **show hardware-interfaces** command).
 137
 138
 139 .. code-block:: shell
 140
 141     clear hardware-interfaces [<interface> [<interface> [..]]] [<sw_idx> [<sw_idx> [..]]].
 142
 143
 144 Examples
 145 --------
 146
 147 Example of how to clear the extended statistics for all interfaces:
 148
 149
 150 .. code-block:: console
 151
 152         vpp# clear hardware-interfaces
 153
 154 Example of how to clear the extended statistics for an interface by name and software index
 155 (where 2 is the software index):
 156
 157 .. code-block:: console
 158
 159         vpp# clear hardware-interfaces GigabitEthernet7/0/0 2
 160
 161