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