NAME
ethtool - Display or change ethernet card settings
SYNOPSIS
ethtool
ethX
ethtool -h|--help
ethtool -a|--show-pause
ethX
ethtool -A|--pause
ethX
2 autoneg on off
2 rx on off
2 tx on off
ethtool -c|--show-coalesce
ethX
ethtool -C|--coalesce
ethX
2 adaptive-rx on off
2 adaptive-tx on off
[rx-usecs
R N ]
[rx-frames
R N ]
[rx-usecs-irq
R N ]
[rx-frames-irq
R N ]
[tx-usecs
R N ]
[tx-frames
R N ]
[tx-usecs-irq
R N ]
[tx-frames-irq
R N ]
[stats-block-usecs
R N ]
[pkt-rate-low
R N ]
[rx-usecs-low
R N ]
[rx-frames-low
R N ]
[tx-usecs-low
R N ]
[tx-frames-low
R N ]
[pkt-rate-high
R N ]
[rx-usecs-high
R N ]
[rx-frames-high
R N ]
[tx-usecs-high
R N ]
[tx-frames-high
R N ]
[sample-interval
R N ]
ethtool -g|--show-ring
ethX
ethtool -G|--set-ring
ethX
[rx
R N ]
[rx-mini
R N ]
[rx-jumbo
R N ]
[tx
R N ]
ethtool -i|--driver
ethX
ethtool -d|--register-dump
ethX
2 raw on off
ethtool -e|--eeprom-dump
ethX
2 raw on off
[offset
R N ]
[length
R N ]
ethtool -E|--change-eeprom
ethX
[magic
R N ]
[offset
R N ]
[value
R N ]
ethtool -k|--show-offload
ethX
ethtool -K--offload
ethX
2 rx on off
2 tx on off
2 sg on off
2 tso on off
2 ufo on off
2 gso on off
ethtool -p|--blink
ethX
R [ N ]
ethtool -r|--negotiate
ethX
ethtool -S|--statistics
ethX
ethtool -t|--test
ethX
1 offline online
ethtool -s
ethX
3 speed 10 100 1000
2 duplex half full
4 port tp aui bnc mii fibre
2 autoneg on off
[phyad
R N ]
2 xcvr internal external
[wol\]
[sopass\]
[msglvl
R N ]
DESCRIPTION
I ethtool
is used for querying settings of an ethernet device and changing them.
ethX
is the name of the ethernet device to work on.
OPTIONS
ethtool
with a single argument specifying the device name prints current
setting of the specified device.
-h --help
shows a short help message.
-a --show-pause
queries the specified ethernet device for pause parameter information.
-A --pause
change the pause parameters of the specified ethernet device.
Specify if pause autonegotiation is enabled.
Specify if RX pause is enabled.
Specify if TX pause is enabled.
-c --show-coalesce
queries the specified ethernet device for coalescing information.
-C --coalesce
change the coalescing settings of the specified ethernet device.
-g --show-ring
queries the specified ethernet device for rx/tx ring parameter information.
-G --set-ring
change the rx/tx ring parameters of the specified ethernet device.
I rx N
Change number of ring entries for the Rx ring.
I rx-mini N
Change number of ring entries for the Rx Mini ring.
I rx-jumbo N
Change number of ring entries for the Rx Jumbo ring.
I tx N
Change number of ring entries for the Tx ring.
-i --driver
queries the specified ethernet device for associated driver information.
-d --register-dump
retrieves and prints a register dump for the specified ethernet device.
When raw is enabled, then it dumps the raw register data to stdout.
-e --eeprom-dump
retrieves and prints an EEPROM dump for the specified ethernet device.
When raw is enabled, then it dumps the raw EEPROM data to stdout. The
length and offset parameters allow dumping certain portions of the EEPROM.
Default is to dump the entire EEPROM.
-E --change-eeprom
Changes EEPROM byte for the specified ethernet device. offset and value
specify which byte and it's new value. Because of the persistent nature
of writing to the EEPROM, a device-specific magic key must be specified
to prevent the accidental writing to the EEPROM.
-k --show-offload
queries the specified ethernet device for offload information.
-K --offload
change the offload parameters of the specified ethernet device.
Specify if RX checksumming is enabled.
Specify if TX checksumming is enabled.
Specify if scatter-gather is enabled.
Specify if tcp segmentation offload is enabled.
Specify if UDP fragmentation offload is enabled
Specify if generic segmentation offload is enabled
-p --identify
initiates adapter-specific action intended to enable an operator to
easily identify the adapter by sight. Typically this involves
blinking one or more LEDs on the specific ethernet port.
N
Length of time to perform phys-id, in seconds.
-r --negotiate
restarts auto-negotiation on the specified ethernet device, if
auto-negotiation is enabled.
-S --statistics
queries the specified ethernet device for NIC- and driver-specific
statistics.
-t --test
executes adapter selftest on the specified ethernet device. Possible test modes are:
defines test type:
offline
(default) means to perform full set of tests possibly causing normal operation interruption during the tests,
online
means to perform limited set of tests do not interrupting normal adapter operation.
-s --change
option allows changing some or all settings of the specified ethernet device.
All following options only apply if
-s
was specified.
Set speed in Mb/s.
ethtool
with single argument will show you the supported device speeds.
Set full or half duplex mode.
Specify if autonegotiation is enabled. In the usual case it is, but might
cause some problems with some network devices, so you can turn it off.
Select transceiver type. Currently only internal and external can be
specified, in the future further types might be added.
R wol
Set Wake-on-LAN options. Not all devices support this. The argument to
this option is a string of characters specifying which options to enable.
u
Wake on unicast messages
m
Wake on multicast messages
b
Wake on broadcast messages
g
Wake on MagicPacket(tm)
s
Enable SecureOn(tm) password for MagicPacket(tm)
d
Disable (wake on nothing). This option clears all previous options.
sopass \c
Set the SecureOn(tm) password. The argument to this option must be 6
bytes in ethernet MAC hex format ().
I msglvl N
Set the driver message level. Meanings differ per driver.
BUGS
Not supported (in part or whole) on all ethernet drivers (read
/usr/share/doc/ethtool/README.Debian to get an idea about supported features).
COMPATIBILITY
Requires 2.4 or newer kernel to be effective.
Also work on Sparc running 2.2 kernel with Happy Meal ethernet card.
AUTHOR
ethtool
was written by David Miller.
Modifications by
Jeff Garzik,
Tim Hockin,
Jakub Jelinek,
Andre Majorel,
Eli Kupermann,
Scott Feldman,
Andi Kleen.
AVAILABILITY
ethtool
is available over the Web on the SourceForge site at
http://sourceforge.net/projects/gkernel/