1ETHTOOL(8) System Manager's Manual ETHTOOL(8)
2
6 ethtool - Display or change ethernet card settings
7
9 ethtool ethX
10 ethtool -h|--help
12 ethtool -a|--show-pause ethX
14 ethtool -A|--pause ethX [autoneg on|off] [rx on|off] [tx on|off]
16 ethtool -c|--show-coalesce ethX
18 ethtool -C|--coalesce ethX [adaptive-rx on|off] [adaptive-tx on|off]
20 [rx-usecs N] [rx-frames N] [rx-usecs-irq N] [rx-frames-irq N] [tx-usecs
21 N] [tx-frames N] [tx-usecs-irq N] [tx-frames-irq N] [stats-block-usecs
22 N] [pkt-rate-low N] [rx-usecs-low N] [rx-frames-low N] [tx-usecs-low N]
23 [tx-frames-low N] [pkt-rate-high N] [rx-usecs-high N] [rx-frames-high
24 N] [tx-usecs-high N] [tx-frames-high N] [sample-interval N]
25 ethtool -g|--show-ring ethX
27 ethtool -G|--set-ring ethX [rx N] [rx-mini N] [rx-jumbo N] [tx N]
29 ethtool -i|--driver ethX
31 ethtool -d|--register-dump ethX [raw on|off]
33 ethtool -e|--eeprom-dump ethX [raw on|off] [offset N] [length N]
35 ethtool -E|--change-eeprom ethX [magic N] [offset N] [value N]
37 ethtool -k|--show-offload ethX
39 ethtool -K--offload ethX [rx on|off] [tx on|off] [sg on|off]
41 [tso on|off] [ufo on|off] [gso on|off]
42 ethtool -p|--blink ethX [N]
44 ethtool -r|--negotiate ethX
46 ethtool -S|--statistics ethX
48 ethtool -t|--test ethX [offline|online]
50 ethtool -s ethX [speed 10|100|1000] [duplex half|full]
52 [port tp|aui|bnc|mii] [autoneg on|off] [phyad N] [xcvr internal|exter‐
53 nal] [wol p|u|m|b|a|g|s|d...] [sopass xx:yy:zz:aa:bb:cc] [msglvl N]
54
56 ethtool is used for querying settings of an ethernet device and chang‐
57 ing them.
58 ethX is the name of the ethernet device to work on.
60
63 ethtool with a single argument specifying the device name prints cur‐
64 rent setting of the specified device.
65 -h --help
67 shows a short help message.
68 -a --show-pause
70 queries the specified ethernet device for pause parameter infor‐
71 mation.
72 -A --pause
74 change the pause parameters of the specified ethernet device.
75 autoneg on|off
77 Specify if pause autonegotiation is enabled.
78 rx on|off
80 Specify if RX pause is enabled.
81 tx on|off
83 Specify if TX pause is enabled.
84 -c --show-coalesce
86 queries the specified ethernet device for coalescing informa‐
87 tion.
88 -C --coalesce
90 change the coalescing settings of the specified ethernet device.
91 -g --show-ring
93 queries the specified ethernet device for rx/tx ring parameter
94 information.
95 -G --set-ring
97 change the rx/tx ring parameters of the specified ethernet
98 device.
99 rx N Change number of ring entries for the Rx ring.
101 rx-mini N
103 Change number of ring entries for the Rx Mini ring.
104 rx-jumbo N
106 Change number of ring entries for the Rx Jumbo ring.
107 tx N Change number of ring entries for the Tx ring.
109 -i --driver
111 queries the specified ethernet device for associated driver
112 information.
113 -d --register-dump
115 retrieves and prints a register dump for the specified ethernet
116 device. When raw is enabled, then it dumps the raw register
117 data to stdout.
118 -e --eeprom-dump
120 retrieves and prints an EEPROM dump for the specified ethernet
121 device. When raw is enabled, then it dumps the raw EEPROM data
122 to stdout. The length and offset parameters allow dumping cer‐
123 tain portions of the EEPROM. Default is to dump the entire EEP‐
124 ROM.
125 -E --change-eeprom
127 Changes EEPROM byte for the specified ethernet device. offset
128 and value specify which byte and it's new value. Because of the
129 persistent nature of writing to the EEPROM, a device-specific
130 magic key must be specified to prevent the accidental writing to
131 the EEPROM.
132 -k --show-offload
134 queries the specified ethernet device for offload information.
135 -K --offload
137 change the offload parameters of the specified ethernet device.
138 rx on|off
140 Specify if RX checksumming is enabled.
141 tx on|off
143 Specify if TX checksumming is enabled.
144 sg on|off
146 Specify if scatter-gather is enabled.
147 tso on|off
149 Specify if tcp segmentation offload is enabled.
150 ufo on|off
152 Specify if UDP fragmentation offload is enabled
153 gso on|off
155 Specify if generic segmentation offload is enabled
156 -p --identify
158 initiates adapter-specific action intended to enable an operator
159 to easily identify the adapter by sight. Typically this
160 involves blinking one or more LEDs on the specific ethernet
161 port.
162 N Length of time to perform phys-id, in seconds.
164 -r --negotiate
166 restarts auto-negotiation on the specified ethernet device, if
167 auto-negotiation is enabled.
168 -S --statistics
170 queries the specified ethernet device for NIC- and driver-spe‐
171 cific statistics.
172 -t --test
174 executes adapter selftest on the specified ethernet device. Pos‐
175 sible test modes are:
176 offline|online
178 defines test type: offline (default) means to perform full set
179 of tests possibly causing normal operation interruption during
180 the tests, online means to perform limited set of tests do not
181 interrupting normal adapter operation.
182 -s --change
184 option allows changing some or all settings of the specified
185 ethernet device. All following options only apply if -s was
186 specified.
187 speed 10|100|1000
189 Set speed in Mb/s. ethtool with single argument will show you
190 the supported device speeds.
191 duplex half|full
193 Set full or half duplex mode.
194 port tp|aui|bnc|mii
196 Select device port.
197 autoneg on|off
199 Specify if autonegotiation is enabled. In the usual case it is,
200 but might cause some problems with some network devices, so you
201 can turn it off.
202 phyad N
204 PHY address.
205 xcvr internal|external
207 Select transceiver type. Currently only internal and external
208 can be specified, in the future further types might be added.
209 wol p|u|m|b|a|g|s|d...
211 Set Wake-on-LAN options. Not all devices support this. The
212 argument to this option is a string of characters specifying
213 which options to enable.
214 p Wake on phy activity
215 u Wake on unicast messages
216 m Wake on multicast messages
217 b Wake on broadcast messages
218 a Wake on ARP
219 g Wake on MagicPacket(tm)
220 s Enable SecureOn(tm) password for MagicPacket(tm)
221 d Disable (wake on nothing). This option clears all previous
222 options.
223 sopass xx:yy:zz:aa:bb:cc
225 Set the SecureOn(tm) password. The argument to this option must
226 be 6 bytes in ethernet MAC hex format (xx:yy:zz:aa:bb:cc).
227 msglvl N
229 Set the driver message level. Meanings differ per driver.
230
232 Not supported (in part or whole) on all ethernet drivers.
233
235 ethtool was written by David Miller.
236 Modifications by Jeff Garzik, Tim Hockin, Jakub Jelinek, Andre Majorel,
238 Eli Kupermann, Scott Feldman, Andi Kleen.
239
241 ethtool is available over the Web on the SourceForge site at
242 http://sourceforge.net/projects/gkernel/
243Ethtool version 5 September 2006 ETHTOOL(8)