1ETHTOOL(8) System Manager's Manual ETHTOOL(8)
3
7 ethtool - query or control network driver and hardware settings
8
10 ethtool ethX
11 ethtool -h|--help
13 ethtool --version
15 ethtool -a|--show-pause ethX
17 ethtool -A|--pause ethX [autoneg on|off] [rx on|off] [tx on|off]
19 ethtool -c|--show-coalesce ethX
21 ethtool -C|--coalesce ethX [adaptive-rx on|off] [adaptive-tx on|off]
23 [rx-usecs N] [rx-frames N] [rx-usecs-irq N] [rx-frames-irq N]
24 [tx-usecs N] [tx-frames N] [tx-usecs-irq N] [tx-frames-irq N]
25 [stats-block-usecs N] [pkt-rate-low N] [rx-usecs-low N]
26 [rx-frames-low N] [tx-usecs-low N] [tx-frames-low N]
27 [pkt-rate-high N] [rx-usecs-high N] [rx-frames-high N]
28 [tx-usecs-high N] [tx-frames-high N] [sample-interval N]
29 ethtool -g|--show-ring ethX
31 ethtool -G|--set-ring ethX [rx N] [rx-mini N] [rx-jumbo N] [tx N]
33 ethtool -i|--driver ethX
35 ethtool -d|--register-dump ethX [raw on|off] [hex on|off] [file name]
37 ethtool -e|--eeprom-dump ethX [raw on|off] [offset N] [length N]
39 ethtool -E|--change-eeprom ethX [magic N] [offset N] [length N]
41 [value N]
42 ethtool -k|--show-offload ethX
44 ethtool -K|--offload ethX [rx on|off] [tx on|off] [sg on|off]
46 [tso on|off] [ufo on|off] [gso on|off] [gro on|off] [lro on|off]
47 [rxvlan on|off] [txvlan on|off] [rxhash on|off]
48 ethtool -p|--identify ethX [N]
50 ethtool -P|--show-permaddr ethX
52 ethtool -r|--negotiate ethX
54 ethtool -S|--statistics ethX
56 ethtool -t|--test ethX [offline|online]
58 ethtool -s ethX speed N [duplex half|full] [port tp|aui|bnc|mii]
60 [autoneg on|off] [advertise N] [phyad N]
61 [xcvr internal|external] [wol p|u|m|b|a|g|s|d...]
62 [sopass xx:yy:zz:aa:bb:cc] [msglvl N | msglvl type on|off ...]
63 ethtool -n ethX
65 [rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6]
66 ethtool -N ethX
68 [rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6 m|v|t|s|d|f|n|r...]
69 ethtool -x|--show-rxfh-indir ethX
71 ethtool -X|--set-rxfh-indir ethX [ equal N | weight W0 W1 ... ]
73 ethtool -f|--flash ethX FILE [N]
75 ethtool -u|--show-ntuple ethX [rule N]
77 ethtool -U|--config-ntuple ethX [delete N]
79 [ flow-type ether|ip4|tcp4|udp4|sctp4|ah4|esp4
80 [src xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]]
81 [dst xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]] [proto N [m N]]
82 [src-ip x.x.x.x [m x.x.x.x]] [dst-ip x.x.x.x [m x.x.x.x]]
83 [tos N [m N]] [l4proto N [m N]] [src-port N [m N]]
84 [dst-port N [m N]] [spi N [m N]] [vlan-etype N [m N]]
85 [vlan N [m N]] [user-def N [m N]] [action N] [loc N] ]
86
89 ethtool is used to query and control network device driver and hardware
90 settings, particularly for wired Ethernet devices.
91 ethX is the name of the network device on which ethtool should operate.
93
96 ethtool with a single argument specifying the device name prints cur‐
97 rent settings of the specified device.
98 -h --help
100 Shows a short help message.
101 --version
103 Shows the ethtool version number.
104 -a --show-pause
106 Queries the specified Ethernet device for pause parameter infor‐
107 mation.
108 -A --pause
110 Changes the pause parameters of the specified Ethernet device.
111 autoneg on|off
113 Specifies whether pause autonegotiation should be enabled.
114 rx on|off
116 Specifies whether RX pause should be enabled.
117 tx on|off
119 Specifies whether TX pause should be enabled.
120 -c --show-coalesce
122 Queries the specified network device for coalescing information.
123 -C --coalesce
125 Changes the coalescing settings of the specified network device.
126 -g --show-ring
128 Queries the specified network device for rx/tx ring parameter
129 information.
130 -G --set-ring
132 Changes the rx/tx ring parameters of the specified network de‐
133 vice.
134 rx N Changes the number of ring entries for the Rx ring.
136 rx-mini N
138 Changes the number of ring entries for the Rx Mini ring.
139 rx-jumbo N
141 Changes the number of ring entries for the Rx Jumbo ring.
142 tx N Changes the number of ring entries for the Tx ring.
144 -i --driver
146 Queries the specified network device for associated driver in‐
147 formation.
148 -d --register-dump
150 Retrieves and prints a register dump for the specified network
151 device. The register format for some devices is known and de‐
152 coded others are printed in hex. When raw is enabled, then eth‐
153 tool dumps the raw register data to stdout. If file is speci‐
154 fied, then use contents of previous raw register dump, rather
155 than reading from the device.
156 -e --eeprom-dump
159 Retrieves and prints an EEPROM dump for the specified network
160 device. When raw is enabled, then it dumps the raw EEPROM data
161 to stdout. The length and offset parameters allow dumping cer‐
162 tain portions of the EEPROM. Default is to dump the entire EEP‐
163 ROM.
164 -E --change-eeprom
166 If value is specified, changes EEPROM byte for the specified
167 network device. offset and value specify which byte and it's
168 new value. If value is not specified, stdin is read and written
169 to the EEPROM. The length and offset parameters allow writing to
170 certain portions of the EEPROM. Because of the persistent na‐
171 ture of writing to the EEPROM, a device-specific magic key must
172 be specified to prevent the accidental writing to the EEPROM.
173 -k --show-offload
175 Queries the specified network device for offload information.
176 -K --offload
178 Changes the offload parameters of the specified network device.
179 rx on|off
181 Specifies whether RX checksumming should be enabled.
182 tx on|off
184 Specifies whether TX checksumming should be enabled.
185 sg on|off
187 Specifies whether scatter-gather should be enabled.
188 tso on|off
190 Specifies whether TCP segmentation offload should be enabled.
191 ufo on|off
193 Specifies whether UDP fragmentation offload should be enabled
194 gso on|off
196 Specifies whether generic segmentation offload should be enabled
197 gro on|off
199 Specifies whether generic receive offload should be enabled
200 lro on|off
202 Specifies whether large receive offload should be enabled
203 rxvlan on|off
205 Specifies whether RX VLAN acceleration should be enabled
206 txvlan on|off
208 Specifies whether TX VLAN acceleration should be enabled
209 rxhash on|off
211 Specifies whether receive hashing offload should be enabled
212 -p --identify
214 Initiates adapter-specific action intended to enable an operator
215 to easily identify the adapter by sight. Typically this in‐
216 volves blinking one or more LEDs on the specific network port.
217 N Length of time to perform phys-id, in seconds.
219 -P --show-permaddr
221 Queries the specified network device for permanent hardware ad‐
222 dress.
223 -r --negotiate
225 Restarts auto-negotiation on the specified Ethernet device, if
226 auto-negotiation is enabled.
227 -S --statistics
229 Queries the specified network device for NIC- and driver-specif‐
230 ic statistics.
231 -t --test
233 Executes adapter selftest on the specified network device. Pos‐
234 sible test modes are:
235 offline|online
237 defines test type: offline (default) means to perform full set
238 of tests possibly causing normal operation interruption during
239 the tests, online means to perform limited set of tests do not
240 interrupting normal adapter operation.
241 -s --change
243 Allows changing some or all settings of the specified network
244 device. All following options only apply if -s was specified.
245 speed N
247 Set speed in Mb/s. ethtool with just the device name as an ar‐
248 gument will show you the supported device speeds.
249 duplex half|full
251 Sets full or half duplex mode.
252 port tp|aui|bnc|mii
254 Selects device port.
255 autoneg on|off
257 Specifies whether autonegotiation should be enabled. Autonegoti‐
258 ation is enabled by default, but in some network devices may
259 have trouble with it, so you can disable it if really necessary.
260 advertise N
262 Sets the speed and duplex advertised by autonegotiation. The
263 argument is a hexadecimal value using one or a combination of
264 the following values:
265 0x001 10 Half
267 0x002 10 Full
268 0x004 100 Half
269 0x008 100 Full
270 0x010 1000 Half (not supported by IEEE standards)
271 0x020 1000 Full
272 0x8000 2500 Full (not supported by IEEE standards)
273 0x1000 10000 Full
274 phyad N
276 PHY address.
277 xcvr internal|external
279 Selects transceiver type. Currently only internal and external
280 can be specified, in the future further types might be added.
281 wol p|u|m|b|a|g|s|d...
283 Sets Wake-on-LAN options. Not all devices support this. The
284 argument to this option is a string of characters specifying
285 which options to enable.
286 p Wake on PHY activity
288 u Wake on unicast messages
289 m Wake on multicast messages
290 b Wake on broadcast messages
291 a Wake on ARP
292 g Wake on MagicPacket™
293 s Enable SecureOn™ password for MagicPacket™
294 d Disable (wake on nothing). This option
295 clears all previous options.
296 sopass xx:yy:zz:aa:bb:cc
298 Sets the SecureOn™ password. The argument to this option must
299 be 6 bytes in Ethernet MAC hex format (xx:yy:zz:aa:bb:cc).
300 msglvl N
302 msglvl type on|off ...
303 Sets the driver message type flags by name or number. type names
304 the type of message to enable or disable; N specifies the new
305 flags numerically. The defined type names and numbers are:
306 drv 0x0001 General driver status
308 probe 0x0002 Hardware probing
309 link 0x0004 Link state
310 timer 0x0008 Periodic status check
311 ifdown 0x0010 Interface being brought down
312 ifup 0x0020 Interface being brought up
313 rx_err 0x0040 Receive error
314 tx_err 0x0080 Transmit error
315 tx_queued 0x0100 Transmit queueing
316 intr 0x0200 Interrupt handling
317 tx_done 0x0400 Transmit completion
318 rx_status 0x0800 Receive completion
319 pktdata 0x1000 Packet contents
320 hw 0x2000 Hardware status
321 wol 0x4000 Wake-on-LAN status
322 The precise meanings of these type flags differ between drivers.
324 -n --show-nfc
326 Retrieves the receive network flow classification configura‐
327 tions.
328 rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6
330 Retrieves the hash options for the specified network traffic
331 type.
332 tcp4 TCP over IPv4
334 udp4 UDP over IPv4
335 ah4 IPSEC AH over IPv4
336 esp4 IPSEC ESP over IPv4
337 sctp4 SCTP over IPv4
338 tcp6 TCP over IPv6
339 udp6 UDP over IPv6
340 ah6 IPSEC AH over IPv6
341 esp6 IPSEC ESP over IPv6
342 sctp6 SCTP over IPv6
343 -N --config-nfc
345 Configures the receive network flow classification.
346 rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6 m|v|t|s|d|f|n|r...
348 Configures the hash options for the specified network traffic
349 type.
350 m Hash on the Layer 2 destination address of the rx packet.
352 v Hash on the VLAN tag of the rx packet.
353 t Hash on the Layer 3 protocol field of the rx packet.
354 s Hash on the IP source address of the rx packet.
355 d Hash on the IP destination address of the rx packet.
356 f Hash on bytes 0 and 1 of the Layer 4 header of the rx packet.
357 n Hash on bytes 2 and 3 of the Layer 4 header of the rx packet.
358 r Discard all packets of this flow type. When this option is
359 set, all other options are ignored.
360 -x --show-rxfh-indir
362 Retrieves the receive flow hash indirection table.
363 -X --set-rxfh-indir
365 Configures the receive flow hash indirection table.
366 equal N
368 Sets the receive flow hash indirection table to spread flows
369 evenly between the first N receive queues.
370 weight W0 W1 ...
372 Sets the receive flow hash indirection table to spread flows be‐
373 tween receive queues according to the given weights. The sum of
374 the weights must be non-zero and must not exceed the size of the
375 indirection table.
376 -f --flash FILE
378 Flash firmware image from the specified file to a region on the
379 adapter. By default this will flash all the regions on the
380 adapter.
381 N A number to identify flash region where the image should be
383 flashed. Default region is 0 which denotes all regions in the
384 flash.
385 -u --show-ntuple
387 Get Rx ntuple filters and actions, then display them to the us‐
388 er.
389 rule N Retrieves the RX classification rule with the given ID.
391 -U --config-ntuple
393 Configure Rx ntuple filters and actions
394 delete N
396 Deletes the RX classification rule with the given ID.
397 flow-type ether|ip4|tcp4|udp4|sctp4|ah4|esp4
399 ether Ethernet
401 ip4 Raw IPv4
402 tcp4 TCP over IPv4
403 udp4 UDP over IPv4
404 sctp4 SCTP over IPv4
405 ah4 IPSEC AH over IPv4
406 esp4 IPSEC ESP over IPv4
407 All fields below that include a mask option may either use "m" to indi‐
409 cate a mask, or may use the full name of the field with a "-mask" ap‐
410 pended to indicate that this is the mask for a given field.
411 src xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]
413 Includes the source MAC address, specified as 6 bytes in hexa‐
414 decimal separated by colons, along with an optional mask. Valid
415 only for flow-type ether.
416 dst xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]
418 Includes the destination MAC address, specified as 6 bytes in
419 hexadecimal separated by colons, along with an optional mask.
420 Valid only for flow-type ether.
421 proto N [m N]
423 Includes the Ethernet protocol number (ethertype) and an option‐
424 al mask. Valid only for flow-type ether.
425 src-ip x.x.x.x [m x.x.x.x]
427 Specify the source IP address of the incoming packet to match
428 along with an optional mask. Valid for all IPv4 based flow-
429 types.
430 dst-ip x.x.x.x [m x.x.x.x]
432 Specify the destination IP address of the incoming packet to
433 match along with an optional mask. Valid for all IPv4 based
434 flow-types.
435 tos N [m N]
437 Specify the value of the Type of Service field in the incoming
438 packet to match along with an optional mask. Applies to all
439 IPv4 based flow-types.
440 l4proto N [l4m N]
442 Includes the layer 4 protocol number and optional mask. Valid
443 only for flow-type ip4.
444 src-port N [m N]
446 Specify the value of the source port field (applicable to
447 TCP/UDP packets) in the incoming packet to match along with an
448 optional mask. Valid for flow-types ip4, tcp4, udp4, and sctp4.
449 dst-port N [m N]
451 Specify the value of the destination port field (applicable to
452 TCP/UDP packets)in the incoming packet to match along with an
453 optional mask. Valid for flow-types ip4, tcp4, udp4, and sctp4.
454 spi N [m N]
456 Specify the value of the security parameter index field (appli‐
457 cable to AH/ESP packets)in the incoming packet to match along
458 with an optional mask. Valid for flow-types ip4, ah4, and esp4.
459 vlan-etype N [m N]
461 Includes the VLAN tag Ethertype and an optional mask.
462 vlan N [m N]
464 Includes the VLAN tag and an optional mask.
465 user-def N [m N]
467 Includes 64-bits of user-specific data and an optional mask.
468 action N
470 Specifies the Rx queue to send packets to, or some other action.
471 -2 Clear the filter
473 -1 Drop the matched flow
474 0 or higher Rx queue to route the flow
475 loc N Specify the location/ID to insert the rule. This will overwrite
477 any rule present in that location and will not go through any of
478 the rule ordering process.
479
481 Not supported (in part or whole) on all network drivers.
482
484 ethtool was written by David Miller.
485 Modifications by Jeff Garzik, Tim Hockin, Jakub Jelinek, Andre Majorel,
487 Eli Kupermann, Scott Feldman, Andi Kleen, Alexander Duyck.
488
490 ethtool is available from
491 ⟨http://www.kernel.org/pub/software/network/ethtool/⟩
492Ethtool version 2.6.39 January 2011 ETHTOOL(8)