1ETHTOOL(8) System Manager's Manual ETHTOOL(8)
2
6 ethtool - query or control network driver and hardware settings
7
9 ethtool devname
10 ethtool -h|--help
12 ethtool --version
14 ethtool -a|--show-pause devname
16 ethtool -A|--pause devname [autoneg on|off] [rx on|off] [tx on|off]
18 ethtool -c|--show-coalesce devname
20 ethtool -C|--coalesce devname [adaptive-rx on|off] [adaptive-tx on|off]
22 [rx-usecs N] [rx-frames N] [rx-usecs-irq N] [rx-frames-irq N]
23 [tx-usecs N] [tx-frames N] [tx-usecs-irq N] [tx-frames-irq N]
24 [stats-block-usecs N] [pkt-rate-low N] [rx-usecs-low N]
25 [rx-frames-low N] [tx-usecs-low N] [tx-frames-low N]
26 [pkt-rate-high N] [rx-usecs-high N] [rx-frames-high N]
27 [tx-usecs-high N] [tx-frames-high N] [sample-interval N]
28 ethtool -g|--show-ring devname
30 ethtool -G|--set-ring devname [rx N] [rx-mini N] [rx-jumbo N] [tx N]
32 ethtool -i|--driver devname
34 ethtool -d|--register-dump devname [raw on|off] [hex on|off] [file
36 name]
37 ethtool -e|--eeprom-dump devname [raw on|off] [offset N] [length N]
39 ethtool -E|--change-eeprom devname [magic N] [offset N] [length N]
41 [value N]
42 ethtool -k|--show-features|--show-offload devname
44 ethtool -K|--features|--offload devname feature on|off ...
46 ethtool -p|--identify devname [N]
48 ethtool -P|--show-permaddr devname
50 ethtool -r|--negotiate devname
52 ethtool -S|--statistics devname
54 ethtool -t|--test devname [offline|online|external_lb]
56 ethtool -s devname speed N [duplex half|full] [port tp|aui|bnc|mii]
58 [mdix auto|on|off] [autoneg on|off] [advertise N] [phyad N]
59 [xcvr internal|external] [wol p|u|m|b|a|g|s|d...]
60 [sopass xx:yy:zz:aa:bb:cc] [msglvl N | msglvl type on|off ...]
61 ethtool -n|-u|--show-nfc|--show-ntuple devname
63 [ rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6 |
64 rule N ]
65 ethtool -N|-U|--config-nfc|--config-ntuple devname
67 rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6
68 m|v|t|s|d|f|n|r... |
69 flow-type ether|ip4|tcp4|udp4|sctp4|ah4|esp4
70 [src xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]]
71 [dst xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]] [proto N [m N]]
72 [src-ip x.x.x.x [m x.x.x.x]] [dst-ip x.x.x.x [m x.x.x.x]]
73 [tos N [m N]] [l4proto N [m N]] [src-port N [m N]]
74 [dst-port N [m N]] [spi N [m N]] [l4data N [m N]]
75 [vlan-etype N [m N]] [vlan N [m N]] [user-def N [m N]]
76 [action N] [loc N] |
77 delete N
78 ethtool -w|--get-dump devname [data filename]
80 ethtool -W|--set-dump devname N
82 ethtool -T|--show-time-stamping devname
84 ethtool -x|--show-rxfh-indir|--show-rxfh devname
86 ethtool -X|--set-rxfh-indir|--rxfh devname [hkey xx:yy:zz:aa:bb:cc:...]
88 [ equal N | weight W0 W1 ... ]
89 ethtool -f|--flash devname FILE [N]
91 ethtool -l|--show-channels devname
93 ethtool -L|--set-channels devname [rx N] [tx N] [other N] [combined N]
95 ethtool -m|--dump-module-eeprom devname [raw on|off] [hex on|off]
97 [offset N] [length N]
98 ethtool --show-priv-flags devname
100 ethtool --set-priv-flags devname flag on|off ...
102 ethtool --show-eee devname
104 ethtool --set-eee devname [eee on|off] [tx-lpi on|off] [tx-timer N]
106 [advertise N]
107
110 ethtool is used to query and control network device driver and hardware
111 settings, particularly for wired Ethernet devices.
112 devname is the name of the network device on which ethtool should oper‐
114 ate.
115
118 ethtool with a single argument specifying the device name prints cur‐
119 rent settings of the specified device.
120 -h --help
122 Shows a short help message.
123 --version
125 Shows the ethtool version number.
126 -a --show-pause
128 Queries the specified Ethernet device for pause parameter infor‐
129 mation.
130 -A --pause
132 Changes the pause parameters of the specified Ethernet device.
133 autoneg on|off
135 Specifies whether pause autonegotiation should be enabled.
136 rx on|off
138 Specifies whether RX pause should be enabled.
139 tx on|off
141 Specifies whether TX pause should be enabled.
142 -c --show-coalesce
144 Queries the specified network device for coalescing information.
145 -C --coalesce
147 Changes the coalescing settings of the specified network device.
148 -g --show-ring
150 Queries the specified network device for rx/tx ring parameter
151 information.
152 -G --set-ring
154 Changes the rx/tx ring parameters of the specified network de‐
155 vice.
156 rx N Changes the number of ring entries for the Rx ring.
158 rx-mini N
160 Changes the number of ring entries for the Rx Mini ring.
161 rx-jumbo N
163 Changes the number of ring entries for the Rx Jumbo ring.
164 tx N Changes the number of ring entries for the Tx ring.
166 -i --driver
168 Queries the specified network device for associated driver in‐
169 formation.
170 -d --register-dump
172 Retrieves and prints a register dump for the specified network
173 device. The register format for some devices is known and de‐
174 coded others are printed in hex. When raw is enabled, then eth‐
175 tool dumps the raw register data to stdout. If file is speci‐
176 fied, then use contents of previous raw register dump, rather
177 than reading from the device.
178 -e --eeprom-dump
181 Retrieves and prints an EEPROM dump for the specified network
182 device. When raw is enabled, then it dumps the raw EEPROM data
183 to stdout. The length and offset parameters allow dumping cer‐
184 tain portions of the EEPROM. Default is to dump the entire EEP‐
185 ROM.
186 -E --change-eeprom
188 If value is specified, changes EEPROM byte for the specified
189 network device. offset and value specify which byte and it's
190 new value. If value is not specified, stdin is read and written
191 to the EEPROM. The length and offset parameters allow writing to
192 certain portions of the EEPROM. Because of the persistent na‐
193 ture of writing to the EEPROM, a device-specific magic key must
194 be specified to prevent the accidental writing to the EEPROM.
195 -k --show-features --show-offload
197 Queries the specified network device for the state of protocol
198 offload and other features.
199 -K --features --offload
201 Changes the offload parameters and other features of the speci‐
202 fied network device. The following feature names are built-in
203 and others may be defined by the kernel.
204 rx on|off
206 Specifies whether RX checksumming should be enabled.
207 tx on|off
209 Specifies whether TX checksumming should be enabled.
210 sg on|off
212 Specifies whether scatter-gather should be enabled.
213 tso on|off
215 Specifies whether TCP segmentation offload should be enabled.
216 ufo on|off
218 Specifies whether UDP fragmentation offload should be enabled
219 gso on|off
221 Specifies whether generic segmentation offload should be enabled
222 gro on|off
224 Specifies whether generic receive offload should be enabled
225 lro on|off
227 Specifies whether large receive offload should be enabled
228 rxvlan on|off
230 Specifies whether RX VLAN acceleration should be enabled
231 txvlan on|off
233 Specifies whether TX VLAN acceleration should be enabled
234 ntuple on|off
236 Specifies whether Rx ntuple filters and actions should be en‐
237 abled
238 rxhash on|off
240 Specifies whether receive hashing offload should be enabled
241 -p --identify
243 Initiates adapter-specific action intended to enable an operator
244 to easily identify the adapter by sight. Typically this in‐
245 volves blinking one or more LEDs on the specific network port.
246 N Length of time to perform phys-id, in seconds.
248 -P --show-permaddr
250 Queries the specified network device for permanent hardware ad‐
251 dress.
252 -r --negotiate
254 Restarts auto-negotiation on the specified Ethernet device, if
255 auto-negotiation is enabled.
256 -S --statistics
258 Queries the specified network device for NIC- and driver-specif‐
259 ic statistics.
260 -t --test
262 Executes adapter selftest on the specified network device. Pos‐
263 sible test modes are:
264 offline|online|external_lb
266 defines test type: offline (default) means to perform full set
267 of tests possibly causing normal operation interruption during
268 the tests, online means to perform limited set of tests do not
269 interrupting normal adapter operation, external_lb means to per‐
270 form external-loopback test in addition to other offline tests.
271 -s --change
273 Allows changing some or all settings of the specified network
274 device. All following options only apply if -s was specified.
275 speed N
277 Set speed in Mb/s. ethtool with just the device name as an ar‐
278 gument will show you the supported device speeds.
279 duplex half|full
281 Sets full or half duplex mode.
282 port tp|aui|bnc|mii
284 Selects device port.
285 mdix auto|on|off
287 Selects MDI-X mode for port. May be used to override the auto‐
288 matic detection feature of most adapters. An argument of auto
289 means automatic detection of MDI status, on forces MDI-X (cross‐
290 over) mode, while off means MDI (straight through) mode. The
291 driver should guarantee that this command takes effect immedi‐
292 ately, and if necessary may reset the link to cause the change
293 to take effect.
294 autoneg on|off
296 Specifies whether autonegotiation should be enabled. Autonegoti‐
297 ation is enabled by default, but in some network devices may
298 have trouble with it, so you can disable it if really necessary.
299 advertise N
301 Sets the speed and duplex advertised by autonegotiation. The
302 argument is a hexadecimal value using one or a combination of
303 the following values:
304 0x001 10 Half
306 0x002 10 Full
307 0x004 100 Half
308 0x008 100 Full
309 0x010 1000 Half (not supported by IEEE standards)
310 0x020 1000 Full
311 0x8000 2500 Full (not supported by IEEE standards)
312 0x1000 10000 Full
313 0x20000 20000MLD2 Full (not supported by IEEE standards)
314 0x40000 20000KR2 Full (not supported by IEEE standards)
315 phyad N
317 PHY address.
318 xcvr internal|external
320 Selects transceiver type. Currently only internal and external
321 can be specified, in the future further types might be added.
322 wol p|u|m|b|a|g|s|d...
324 Sets Wake-on-LAN options. Not all devices support this. The
325 argument to this option is a string of characters specifying
326 which options to enable.
327 p Wake on PHY activity
329 u Wake on unicast messages
330 m Wake on multicast messages
331 b Wake on broadcast messages
332 a Wake on ARP
333 g Wake on MagicPacket™
334 s Enable SecureOn™ password for MagicPacket™
335 d Disable (wake on nothing). This option
336 clears all previous options.
337 sopass xx:yy:zz:aa:bb:cc
339 Sets the SecureOn™ password. The argument to this option must
340 be 6 bytes in Ethernet MAC hex format (xx:yy:zz:aa:bb:cc).
341 msglvl N
343 msglvl type on|off ...
344 Sets the driver message type flags by name or number. type names
345 the type of message to enable or disable; N specifies the new
346 flags numerically. The defined type names and numbers are:
347 drv 0x0001 General driver status
349 probe 0x0002 Hardware probing
350 link 0x0004 Link state
351 timer 0x0008 Periodic status check
352 ifdown 0x0010 Interface being brought down
353 ifup 0x0020 Interface being brought up
354 rx_err 0x0040 Receive error
355 tx_err 0x0080 Transmit error
356 tx_queued 0x0100 Transmit queueing
357 intr 0x0200 Interrupt handling
358 tx_done 0x0400 Transmit completion
359 rx_status 0x0800 Receive completion
360 pktdata 0x1000 Packet contents
361 hw 0x2000 Hardware status
362 wol 0x4000 Wake-on-LAN status
363 The precise meanings of these type flags differ between drivers.
365 -n -u --show-nfc --show-ntuple
367 Retrieves receive network flow classification options or rules.
368 rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6
370 Retrieves the hash options for the specified flow type.
371 tcp4 TCP over IPv4
373 udp4 UDP over IPv4
374 ah4 IPSEC AH over IPv4
375 esp4 IPSEC ESP over IPv4
376 sctp4 SCTP over IPv4
377 tcp6 TCP over IPv6
378 udp6 UDP over IPv6
379 ah6 IPSEC AH over IPv6
380 esp6 IPSEC ESP over IPv6
381 sctp6 SCTP over IPv6
382 rule N Retrieves the RX classification rule with the given ID.
384 -N -U --config-nfc --config-ntuple
386 Configures receive network flow classification options or rules.
387 rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6
389 m|v|t|s|d|f|n|r...
390 Configures the hash options for the specified flow type.
391 m Hash on the Layer 2 destination address of the rx packet.
393 v Hash on the VLAN tag of the rx packet.
394 t Hash on the Layer 3 protocol field of the rx packet.
395 s Hash on the IP source address of the rx packet.
396 d Hash on the IP destination address of the rx packet.
397 f Hash on bytes 0 and 1 of the Layer 4 header of the rx packet.
398 n Hash on bytes 2 and 3 of the Layer 4 header of the rx packet.
399 r Discard all packets of this flow type. When this option is
400 set, all other options are ignored.
401 flow-type ether|ip4|tcp4|udp4|sctp4|ah4|esp4
403 Inserts or updates a classification rule for the specified flow
404 type.
405 ether Ethernet
407 ip4 Raw IPv4
408 tcp4 TCP over IPv4
409 udp4 UDP over IPv4
410 sctp4 SCTP over IPv4
411 ah4 IPSEC AH over IPv4
412 esp4 IPSEC ESP over IPv4
413 All fields below that include a mask option may either use "m" to indi‐
415 cate a mask, or may use the full name of the field with a "-mask" ap‐
416 pended to indicate that this is the mask for a given field.
417 src xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]
419 Includes the source MAC address, specified as 6 bytes in hexa‐
420 decimal separated by colons, along with an optional mask. Valid
421 only for flow-type ether.
422 dst xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]
424 Includes the destination MAC address, specified as 6 bytes in
425 hexadecimal separated by colons, along with an optional mask.
426 Valid only for flow-type ether.
427 proto N [m N]
429 Includes the Ethernet protocol number (ethertype) and an option‐
430 al mask. Valid only for flow-type ether.
431 src-ip x.x.x.x [m x.x.x.x]
433 Specify the source IP address of the incoming packet to match
434 along with an optional mask. Valid for all IPv4 based flow-
435 types.
436 dst-ip x.x.x.x [m x.x.x.x]
438 Specify the destination IP address of the incoming packet to
439 match along with an optional mask. Valid for all IPv4 based
440 flow-types.
441 tos N [m N]
443 Specify the value of the Type of Service field in the incoming
444 packet to match along with an optional mask. Applies to all
445 IPv4 based flow-types.
446 l4proto N [l4m N]
448 Includes the layer 4 protocol number and optional mask. Valid
449 only for flow-type ip4.
450 src-port N [m N]
452 Specify the value of the source port field (applicable to
453 TCP/UDP packets) in the incoming packet to match along with an
454 optional mask. Valid for flow-types ip4, tcp4, udp4, and sctp4.
455 dst-port N [m N]
457 Specify the value of the destination port field (applicable to
458 TCP/UDP packets)in the incoming packet to match along with an
459 optional mask. Valid for flow-types ip4, tcp4, udp4, and sctp4.
460 spi N [m N]
462 Specify the value of the security parameter index field (appli‐
463 cable to AH/ESP packets)in the incoming packet to match along
464 with an optional mask. Valid for flow-types ip4, ah4, and esp4.
465 l4data N [m N]
467 Specify the value of the first 4 Bytes of Layer 4 in the incom‐
468 ing packet to match along with an optional mask. Valid for ip4
469 flow-type.
470 vlan-etype N [m N]
472 Includes the VLAN tag Ethertype and an optional mask.
473 vlan N [m N]
475 Includes the VLAN tag and an optional mask.
476 user-def N [m N]
478 Includes 64-bits of user-specific data and an optional mask.
479 action N
481 Specifies the Rx queue to send packets to, or some other action.
482 -1 Drop the matched flow
484 0 or higher Rx queue to route the flow
485 loc N Specify the location/ID to insert the rule. This will overwrite
487 any rule present in that location and will not go through any of
488 the rule ordering process.
489 delete N
491 Deletes the RX classification rule with the given ID.
492 -w --get-dump
494 Retrieves and prints firmware dump for the specified network de‐
495 vice. By default, it prints out the dump flag, version and
496 length of the dump data. When data is indicated, then ethtool
497 fetches the dump data and directs it to a file.
498 -W --set-dump
500 Sets the dump flag for the device.
501 -T --show-time-stamping
503 Show the device's time stamping capabilities and associated PTP
504 hardware clock.
505 -x --show-rxfh-indir --show-rxfh
507 Retrieves the receive flow hash indirection table and/or RSS
508 hash key.
509 -X --set-rxfh-indir --rxfh
511 Configures the receive flow hash indirection table and/or RSS
512 hash key.
513 hkey Sets RSS hash key of the specified network device. RSS hash key
515 should be of device supported length. Hash key format must be
516 in xx:yy:zz:aa:bb:cc format meaning both the nibbles of a byte
517 should be mentioned even if a nibble is zero.
518 equal N
520 Sets the receive flow hash indirection table to spread flows
521 evenly between the first N receive queues.
522 weight W0 W1 ...
524 Sets the receive flow hash indirection table to spread flows be‐
525 tween receive queues according to the given weights. The sum of
526 the weights must be non-zero and must not exceed the size of the
527 indirection table.
528 -f --flash FILE
530 Flash firmware image from the specified file to a region on the
531 adapter. By default this will flash all the regions on the
532 adapter.
533 N A number to identify flash region where the image should be
535 flashed. Default region is 0 which denotes all regions in the
536 flash.
537 -l --show-channels
539 Queries the specified network device for the numbers of channels
540 it has. A channel is an IRQ and the set of queues that can
541 trigger that IRQ.
542 -L --set-channels
544 Changes the numbers of channels of the specified network device.
545 rx N Changes the number of channels with only receive queues.
547 tx N Changes the number of channels with only transmit queues.
549 other N
551 Changes the number of channels used only for other purposes e.g.
552 link interrupts or SR-IOV co-ordination.
553 combined N
555 Changes the number of multi-purpose channels.
556 -m --dump-module-eeprom
558 Retrieves and if possible decodes the EEPROM from plugin mod‐
559 ules, e.g SFP+, QSFP
560 --show-priv-flags
562 Queries the specified network device for its private flags. The
563 names and meanings of private flags (if any) are defined by each
564 network device driver.
565 --set-priv-flags
567 Sets the device's private flags as specified.
568 flag on|off Sets the state of the named private flag.
570 --show-eee
572 Queries the specified network device for its support of Energy-
573 Efficient Ethernet (according to the IEEE 802.3az specifica‐
574 tions)
575 --set-eee
577 Sets the device EEE behaviour.
578 eee on|off
580 Enables/disables the device support of EEE.
581 tx-lpi on|off
583 Determines whether the device should assert its Tx LPI.
584 advertise N
586 Sets the speeds for which the device should advertise EEE capa‐
587 biliities. Values are as for --change advertise
588 tx-timer N
590 Sets the amount of time the device should stay in idle mode pri‐
591 or to asserting its Tx LPI (in microseconds). This has meaning
592 only when Tx LPI is enabled.
593
595 Not supported (in part or whole) on all network drivers.
596
598 ethtool was written by David Miller.
599 Modifications by Jeff Garzik, Tim Hockin, Jakub Jelinek, Andre Majorel,
601 Eli Kupermann, Scott Feldman, Andi Kleen, Alexander Duyck, Sucheta
602 Chakraborty.
603
605 ethtool is available from
606 ⟨http://www.kernel.org/pub/software/network/ethtool/⟩
607Ethtool version 3.5 June 2012 ETHTOOL(8)