/* Void Main's man pages */
{ phpMan } else { main(); }
ETHTOOL(8) ETHTOOL(8)
NAME
ethtool - query or control network driver and hardware settings
SYNOPSIS
ethtool ethX
ethtool -h|--help
ethtool --version
ethtool -a|--show-pause ethX
ethtool -A|--pause ethX [autoneg on|off] [rx on|off] [tx on|off]
ethtool -c|--show-coalesce ethX
ethtool -C|--coalesce ethX [adaptive-rx on|off] [adaptive-tx on|off] [rx-usecs N] [rx-frames N] [rx-usecs-irq N]
[rx-frames-irq N] [tx-usecs N] [tx-frames N] [tx-usecs-irq N] [tx-frames-irq N] [stats-block-usecs N]
[pkt-rate-low N] [rx-usecs-low N] [rx-frames-low N] [tx-usecs-low N] [tx-frames-low N] [pkt-rate-high N]
[rx-usecs-high N] [rx-frames-high N] [tx-usecs-high N] [tx-frames-high N] [sample-interval N]
ethtool -g|--show-ring ethX
ethtool -G|--set-ring ethX [rx N] [rx-mini N] [rx-jumbo N] [tx N]
ethtool -i|--driver ethX
ethtool -d|--register-dump ethX [raw on|off] [hex on|off] [file name]
ethtool -e|--eeprom-dump ethX [raw on|off] [offset N] [length N]
ethtool -E|--change-eeprom ethX [magic N] [offset N] [length N] [value N]
ethtool -k|--show-offload ethX
ethtool -K|--offload ethX [rx on|off] [tx on|off] [sg on|off] [tso on|off] [ufo on|off] [gso on|off] [gro on|off]
[lro on|off] [rxvlan on|off] [txvlan on|off] [rxhash on|off]
ethtool -p|--identify ethX [N]
ethtool -P|--show-permaddr ethX
ethtool -r|--negotiate ethX
ethtool -S|--statistics ethX
ethtool -t|--test ethX [offline|online]
ethtool -s ethX speed N [duplex half|full] [port tp|aui|bnc|mii] [autoneg on|off] [advertise N] [phyad N]
[xcvr internal|external] [wol p|u|m|b|a|g|s|d...] [sopass xx:yy:zz:aa:bb:cc] [msglvl N | msglvl type on|off ...]
ethtool -n ethX [rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6]
ethtool -N ethX [rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6 m|v|t|s|d|f|n|r...]
ethtool -x|--show-rxfh-indir ethX
ethtool -X|--set-rxfh-indir ethX [ equal N | weight W0 W1 ... ]
ethtool -f|--flash ethX FILE [N]
ethtool -u|--show-ntuple ethX [rule N]
ethtool -U|--config-ntuple ethX [delete N] [ flow-type ether|ip4|tcp4|udp4|sctp4|ah4|esp4
[src xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]] [dst xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]] [proto N [m N]]
[src-ip x.x.x.x [m x.x.x.x]] [dst-ip x.x.x.x [m x.x.x.x]] [tos N [m N]] [l4proto N [m N]] [src-port N [m N]]
[dst-port N [m N]] [spi N [m N]] [vlan-etype N [m N]] [vlan N [m N]] [user-def N [m N]] [action N] [loc N] ]
DESCRIPTION
ethtool is used to query and control network device driver and hardware settings, particularly for wired Ethernet de-
vices.
ethX is the name of the network device on which ethtool should operate.
OPTIONS
ethtool with a single argument specifying the device name prints current settings of the specified device.
-h --help
Shows a short help message.
--version
Shows the ethtool version number.
-a --show-pause
Queries the specified Ethernet device for pause parameter information.
-A --pause
Changes the pause parameters of the specified Ethernet device.
autoneg on|off
Specifies whether pause autonegotiation should be enabled.
rx on|off
Specifies whether RX pause should be enabled.
tx on|off
Specifies whether TX pause should be enabled.
-c --show-coalesce
Queries the specified network device for coalescing information.
-C --coalesce
Changes the coalescing settings of the specified network device.
-g --show-ring
Queries the specified network device for rx/tx ring parameter information.
-G --set-ring
Changes the rx/tx ring parameters of the specified network device.
rx N Changes the number of ring entries for the Rx ring.
rx-mini N
Changes the number of ring entries for the Rx Mini ring.
rx-jumbo N
Changes the number of ring entries for the Rx Jumbo ring.
tx N Changes the number of ring entries for the Tx ring.
-i --driver
Queries the specified network device for associated driver information.
-d --register-dump
Retrieves and prints a register dump for the specified network device. The register format for some devices is
known and decoded others are printed in hex. When raw is enabled, then ethtool dumps the raw register data to
stdout. If file is specified, then use contents of previous raw register dump, rather than reading from the de-
vice.
-e --eeprom-dump
Retrieves and prints an EEPROM dump for the specified network 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
If value is specified, changes EEPROM byte for the specified network device. offset and value specify which byte
and it's new value. If value is not specified, stdin is read and written to the EEPROM. The length and offset pa-
rameters allow writing to certain portions of the EEPROM. Because of the persistent nature of writing to the EEP-
ROM, a device-specific magic key must be specified to prevent the accidental writing to the EEPROM.
-k --show-offload
Queries the specified network device for offload information.
-K --offload
Changes the offload parameters of the specified network device.
rx on|off
Specifies whether RX checksumming should be enabled.
tx on|off
Specifies whether TX checksumming should be enabled.
sg on|off
Specifies whether scatter-gather should be enabled.
tso on|off
Specifies whether TCP segmentation offload should be enabled.
ufo on|off
Specifies whether UDP fragmentation offload should be enabled
gso on|off
Specifies whether generic segmentation offload should be enabled
gro on|off
Specifies whether generic receive offload should be enabled
lro on|off
Specifies whether large receive offload should be enabled
rxvlan on|off
Specifies whether RX VLAN acceleration should be enabled
txvlan on|off
Specifies whether TX VLAN acceleration should be enabled
rxhash on|off
Specifies whether receive hashing offload should be enabled
-p --identify
Initiates adapter-specific action intended to enable an operator to easily identify the adapter by sight. Typi-
cally this involves blinking one or more LEDs on the specific network port.
N Length of time to perform phys-id, in seconds.
-P --show-permaddr
Queries the specified network device for permanent hardware address.
-r --negotiate
Restarts auto-negotiation on the specified Ethernet device, if auto-negotiation is enabled.
-S --statistics
Queries the specified network device for NIC- and driver-specific statistics.
-t --test
Executes adapter selftest on the specified network device. Possible test modes are:
offline|online
defines test type: offline (default) means to perform full set of tests possibly causing normal operation inter-
ruption during the tests, online means to perform limited set of tests do not interrupting normal adapter opera-
tion.
-s --change
Allows changing some or all settings of the specified network device. All following options only apply if -s was
specified.
speed N
Set speed in Mb/s. ethtool with just the device name as an argument will show you the supported device speeds.
duplex half|full
Sets full or half duplex mode.
port tp|aui|bnc|mii
Selects device port.
autoneg on|off
Specifies whether autonegotiation should be enabled. Autonegotiation is enabled by default, but in some network
devices may have trouble with it, so you can disable it if really necessary.
advertise N
Sets the speed and duplex advertised by autonegotiation. The argument is a hexadecimal value using one or a com-
bination of the following values:
0x001 10 Half
0x002 10 Full
0x004 100 Half
0x008 100 Full
0x010 1000 Half (not supported by IEEE standards)
0x020 1000 Full
0x8000 2500 Full (not supported by IEEE standards)
0x1000 10000 Full
phyad N
PHY address.
xcvr internal|external
Selects transceiver type. Currently only internal and external can be specified, in the future further types might
be added.
wol p|u|m|b|a|g|s|d...
Sets Wake-on-LAN options. Not all devices support this. The argument to this option is a string of characters
specifying which options to enable.
p Wake on PHY activity
u Wake on unicast messages
m Wake on multicast messages
b Wake on broadcast messages
a Wake on ARP
g Wake on MagicPackettm
s Enable SecureOntm password for MagicPackettm
d Disable (wake on nothing). This option
clears all previous options.
sopass xx:yy:zz:aa:bb:cc
Sets the SecureOntm password. The argument to this option must be 6 bytes in Ethernet MAC hex format
(xx:yy:zz:aa:bb:cc).
msglvl N
msglvl type on|off ...
Sets the driver message type flags by name or number. type names the type of message to enable or disable; N spec-
ifies the new flags numerically. The defined type names and numbers are:
drv 0x0001 General driver status
probe 0x0002 Hardware probing
link 0x0004 Link state
timer 0x0008 Periodic status check
ifdown 0x0010 Interface being brought down
ifup 0x0020 Interface being brought up
rx_err 0x0040 Receive error
tx_err 0x0080 Transmit error
tx_queued 0x0100 Transmit queueing
intr 0x0200 Interrupt handling
tx_done 0x0400 Transmit completion
rx_status 0x0800 Receive completion
pktdata 0x1000 Packet contents
hw 0x2000 Hardware status
wol 0x4000 Wake-on-LAN status
The precise meanings of these type flags differ between drivers.
-n --show-nfc
Retrieves the receive network flow classification configurations.
rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6
Retrieves the hash options for the specified network traffic type.
tcp4 TCP over IPv4
udp4 UDP over IPv4
ah4 IPSEC AH over IPv4
esp4 IPSEC ESP over IPv4
sctp4 SCTP over IPv4
tcp6 TCP over IPv6
udp6 UDP over IPv6
ah6 IPSEC AH over IPv6
esp6 IPSEC ESP over IPv6
sctp6 SCTP over IPv6
-N --config-nfc
Configures the receive network flow classification.
rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6 m|v|t|s|d|f|n|r...
Configures the hash options for the specified network traffic type.
m Hash on the Layer 2 destination address of the rx packet.
v Hash on the VLAN tag of the rx packet.
t Hash on the Layer 3 protocol field of the rx packet.
s Hash on the IP source address of the rx packet.
d Hash on the IP destination address of the rx packet.
f Hash on bytes 0 and 1 of the Layer 4 header of the rx packet.
n Hash on bytes 2 and 3 of the Layer 4 header of the rx packet.
r Discard all packets of this flow type. When this option is
set, all other options are ignored.
-x --show-rxfh-indir
Retrieves the receive flow hash indirection table.
-X --set-rxfh-indir
Configures the receive flow hash indirection table.
equal N
Sets the receive flow hash indirection table to spread flows evenly between the first N receive queues.
weight W0 W1 ...
Sets the receive flow hash indirection table to spread flows between receive queues according to the given
weights. The sum of the weights must be non-zero and must not exceed the size of the indirection table.
-f --flash FILE
Flash firmware image from the specified file to a region on the adapter. By default this will flash all the re-
gions on the adapter.
N A number to identify flash region where the image should be flashed. Default region is 0 which denotes all re-
gions in the flash.
-u --show-ntuple
Get Rx ntuple filters and actions, then display them to the user.
rule N Retrieves the RX classification rule with the given ID.
-U --config-ntuple
Configure Rx ntuple filters and actions
delete N
Deletes the RX classification rule with the given ID.
flow-type ether|ip4|tcp4|udp4|sctp4|ah4|esp4
ether Ethernet
ip4 Raw IPv4
tcp4 TCP over IPv4
udp4 UDP over IPv4
sctp4 SCTP over IPv4
ah4 IPSEC AH over IPv4
esp4 IPSEC ESP over IPv4
All fields below that include a mask option may either use "m" to indicate a mask, or may use the full name of the field
with a "-mask" appended to indicate that this is the mask for a given field.
src xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]
Includes the source MAC address, specified as 6 bytes in hexadecimal separated by colons, along with an optional
mask. Valid only for flow-type ether.
dst xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]
Includes the destination MAC address, specified as 6 bytes in hexadecimal separated by colons, along with an op-
tional mask. Valid only for flow-type ether.
proto N [m N]
Includes the Ethernet protocol number (ethertype) and an optional mask. Valid only for flow-type ether.
src-ip x.x.x.x [m x.x.x.x]
Specify the source IP address of the incoming packet to match along with an optional mask. Valid for all IPv4
based flow-types.
dst-ip x.x.x.x [m x.x.x.x]
Specify the destination IP address of the incoming packet to match along with an optional mask. Valid for all
IPv4 based flow-types.
tos N [m N]
Specify the value of the Type of Service field in the incoming packet to match along with an optional mask. Ap-
plies to all IPv4 based flow-types.
l4proto N [l4m N]
Includes the layer 4 protocol number and optional mask. Valid only for flow-type ip4.
src-port N [m N]
Specify the value of the source port field (applicable to TCP/UDP packets) in the incoming packet to match along
with an optional mask. Valid for flow-types ip4, tcp4, udp4, and sctp4.
dst-port N [m N]
Specify the value of the destination port field (applicable to TCP/UDP packets)in the incoming packet to match
along with an optional mask. Valid for flow-types ip4, tcp4, udp4, and sctp4.
spi N [m N]
Specify the value of the security parameter index field (applicable to AH/ESP packets)in the incoming packet to
match along with an optional mask. Valid for flow-types ip4, ah4, and esp4.
vlan-etype N [m N]
Includes the VLAN tag Ethertype and an optional mask.
vlan N [m N]
Includes the VLAN tag and an optional mask.
user-def N [m N]
Includes 64-bits of user-specific data and an optional mask.
action N
Specifies the Rx queue to send packets to, or some other action.
-2 Clear the filter
-1 Drop the matched flow
0 or higher Rx queue to route the flow
loc N Specify the location/ID to insert the rule. This will overwrite any rule present in that location and will not go
through any of the rule ordering process.
BUGS
Not supported (in part or whole) on all network drivers.
AUTHOR
ethtool was written by David Miller.
Modifications by Jeff Garzik, Tim Hockin, Jakub Jelinek, Andre Majorel, Eli Kupermann, Scott Feldman, Andi Kleen, Alexan-
der Duyck.
AVAILABILITY
ethtool is available from <http://www.kernel.org/pub/software/network/ethtool/>;
Ethtool version 2.6.39 January 2011 ETHTOOL(8)
