ethtool

Source: Wikipedia, the free encyclopedia.
ethtool
Original author(s)David S. Miller
Developer(s)Ben Hutchings
Initial release1998; 26 years ago (1998)
Repository
Written in
Networking
LicenseGPLv2
Websitewww.kernel.org/pub/software/network/ethtool/

ethtool is the primary means in

userspace
.

ethtool consists of two components, an

userspace API based on the Linux SIOCETHTOOL ioctl
mechanism through which application programs can communicate with the kernel to send and receive NIC and NIC driver parameters.

Most

community, the term ethtool is usually used to refer to this utility program.

The ethtool

C++ standard library
respectively.

Several scripting languages such as Perl and Python provide ethtool API bindings that allow programmers using these languages to write scripts that can control NIC's.

The macOS and FreeBSD operating systems provide utility programs that have a user interface similar to the Linux ethtool utility, but that use fundamentally different APIs to communicate with their operating system kernels and NIC's.

Usage

The command is useful for:

  • Identification and diagnosis of Ethernet devices
  • Extended Ethernet devices statistics
  • Control speed, duplex, autonegotiation and flow control for Ethernet devices
  • Control
    large send offload
  • Control DMA ring sizes and interrupt moderation
  • Control receive queue selection for
    multiqueue devices
  • Upgrade firmware in flash memory

Examples

To display the current parameters of the first network port (eth0):

$ ethtool eth0
Settings for eth0:
       Supported ports: [ TP MII ]
       Supported link modes: 10baseT/Half 10baseT/Full
                               100baseT/Half 100baseT/Full
       Supports auto-negotiation: Yes
       Advertised link modes: 10baseT/Half 10baseT/Full
                               100baseT/Half 100baseT/Full
       Advertised auto-negotiation: No
       Speed: 100Mb/s
       Duplex: Full
       Port: MII
       PHYAD: 1
       Transceiver: internal
       Auto-negotiation: off
       Supports Wake-on: g
       Wake-on: g
       Current message level: 0x00000007 (7)
       Link detected: yes

[1]

To configure it with the 1000 Mb/s speed and

1000BASE-T
:

$ ethtool -s eth0 speed 1000 duplex full autoneg off

To let the link light of the device eth0 flash for two minutes:

$ ethtool -p eth0 120

To print the driver info of the interface eth0:

$ ethtool -i eth0
driver: mlx5_core
version: 4.9-2.2.4
firmware-version: 14.28.2006 (MT_2420110034)
expansion-rom-version: 
bus-info: 0000:65:00.1
supports-statistics: yes
supports-test: yes
supports-eeprom-access: no
supports-register-dump: no
supports-priv-flags: yes

mii-tool

mii-tool is an older program performing a similar function to ethtool. Since 2003,[2] it's considered obsolete and replaced by ethtool.

Example

To display the current parameters:

$ mii-tool
eth0: no autonegotiation, 100baseTx-HD, link ok

To force the network speed to 1 Gbit/s, and the duplex in full on the port 1 (eth0):

$ mii-tool -F 1000baseTx-FD eth0
$ mii-tool
eth0: 1 000 Mbit, full duplex, link ok

See also

References

  1. ^ "9 Linux ethtool Examples to Manipulate Ethernet Card (NIC Card)". www.thegeekstuff.com. 2010-10-28. Retrieved 2020-11-14.
  2. ^ "Ethernet Auto-negotiation and Duplexing on Linux". lists.olug.org. September 2003.

External links