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 --phy-statistics devname
56 ethtool -t|--test devname [offline|online|external_lb]
58 ethtool -s devname [speed N] [duplex half|full] [port tp|aui|bnc|mii]
60 [mdix auto|on|off] [autoneg on|off] [advertise N] [phyad N]
61 [xcvr internal|external] [wol p|u|m|b|a|g|s|f|d...]
62 [sopass xx:yy:zz:aa:bb:cc] [msglvl N | msglvl type on|off ...]
63 ethtool -n|-u|--show-nfc|--show-ntuple devname
65 [ rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6 |
66 rule N ]
67 ethtool -N|-U|--config-nfc|--config-ntuple devname
69 rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6
70 m|v|t|s|d|f|n|r... |
71 flow-type
72 ether|ip4|tcp4|udp4|sctp4|ah4|esp4|ip6|tcp6|udp6|ah6|esp6|sctp6
73 [src xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]]
74 [dst xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]] [proto N [m N]]
75 [src-ip ip-address [m ip-address]] [dst-ip ip-address [m ip-
76 address]] [tos N [m N]] [tclass N [m N]] [l4proto N [m N]]
77 [src-port N [m N]] [dst-port N [m N]] [spi N [m N]]
78 [l4data N [m N]] [vlan-etype N [m N]] [vlan N [m N]]
79 [user-def N [m N]] [dst-
80 mac xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]] [action N]
81 [context N] [loc N] |
82 delete N
83 ethtool -w|--get-dump devname [data filename]
85 ethtool -W|--set-dump devname N
87 ethtool -T|--show-time-stamping devname
89 ethtool -x|--show-rxfh-indir|--show-rxfh devname
91 ethtool -X|--set-rxfh-indir|--rxfh devname [hkey xx:yy:zz:aa:bb:cc:...]
93 [start N] [ equal N | weight W0 W1 ... | default ] [hfunc FUNC]
94 [context CTX | new] [delete]
95 ethtool -f|--flash devname file [N]
97 ethtool -l|--show-channels devname
99 ethtool -L|--set-channels devname [rx N] [tx N] [other N] [combined N]
101 ethtool -m|--dump-module-eeprom|--module-info devname [raw on|off]
103 [hex on|off] [offset N] [length N]
104 ethtool --show-priv-flags devname
106 ethtool --set-priv-flags devname flag on|off ...
108 ethtool --show-eee devname
110 ethtool --set-eee devname [eee on|off] [tx-lpi on|off] [tx-timer N]
112 [advertise N]
113 ethtool --set-phy-tunable devname [ downshift on|off [count N] ] [
115 fast-link-down on|off [msecs N] ] [ energy-detect-power-down
116 on|off [msecs N] ]
117 ethtool --get-phy-tunable devname [downshift] [fast-link-down] [energy-
119 detect-power-down]
120 ethtool --reset devname [flags N] [mgmt] [mgmt-shared] [irq] [irq-
122 shared] [dma] [dma-shared] [filter] [filter-shared] [offload]
123 [offload-shared] [mac] [mac-shared] [phy] [phy-shared] [ram]
124 [ram-shared] [ap] [ap-shared] [dedicated] [all]
125 ethtool --show-fec devname
127 ethtool --set-fec devname encoding auto|off|rs|baser [...]
129 ethtool -Q|--per-queue devname [queue_mask %x] sub_command ...
131 .
132
135 ethtool is used to query and control network device driver and hardware
136 settings, particularly for wired Ethernet devices.
137 devname is the name of the network device on which ethtool should oper‐
139 ate.
140
143 ethtool with a single argument specifying the device name prints cur‐
144 rent settings of the specified device.
145 -h --help
147 Shows a short help message.
148 --version
150 Shows the ethtool version number.
151 -a --show-pause
153 Queries the specified Ethernet device for pause parameter infor‐
154 mation.
155 -A --pause
157 Changes the pause parameters of the specified Ethernet device.
158 autoneg on|off
160 Specifies whether pause autonegotiation should be enabled.
161 rx on|off
163 Specifies whether RX pause should be enabled.
164 tx on|off
166 Specifies whether TX pause should be enabled.
167 -c --show-coalesce
169 Queries the specified network device for coalescing information.
170 -C --coalesce
172 Changes the coalescing settings of the specified network device.
173 -g --show-ring
175 Queries the specified network device for rx/tx ring parameter
176 information.
177 -G --set-ring
179 Changes the rx/tx ring parameters of the specified network de‐
180 vice.
181 rx N Changes the number of ring entries for the Rx ring.
183 rx-mini N
185 Changes the number of ring entries for the Rx Mini ring.
186 rx-jumbo N
188 Changes the number of ring entries for the Rx Jumbo ring.
189 tx N Changes the number of ring entries for the Tx ring.
191 -i --driver
193 Queries the specified network device for associated driver in‐
194 formation.
195 -d --register-dump
197 Retrieves and prints a register dump for the specified network
198 device. The register format for some devices is known and de‐
199 coded others are printed in hex. When raw is enabled, then eth‐
200 tool dumps the raw register data to stdout. If file is speci‐
201 fied, then use contents of previous raw register dump, rather
202 than reading from the device.
203 -e --eeprom-dump
205 Retrieves and prints an EEPROM dump for the specified network
206 device. When raw is enabled, then it dumps the raw EEPROM data
207 to stdout. The length and offset parameters allow dumping cer‐
208 tain portions of the EEPROM. Default is to dump the entire EEP‐
209 ROM.
210 raw on|off
212 offset N
214 length N
216 -E --change-eeprom
218 If value is specified, changes EEPROM byte for the specified
219 network device. offset and value specify which byte and it's
220 new value. If value is not specified, stdin is read and written
221 to the EEPROM. The length and offset parameters allow writing to
222 certain portions of the EEPROM. Because of the persistent na‐
223 ture of writing to the EEPROM, a device-specific magic key must
224 be specified to prevent the accidental writing to the EEPROM.
225 -k --show-features --show-offload
227 Queries the specified network device for the state of protocol
228 offload and other features.
229 -K --features --offload
231 Changes the offload parameters and other features of the speci‐
232 fied network device. The following feature names are built-in
233 and others may be defined by the kernel.
234 rx on|off
236 Specifies whether RX checksumming should be enabled.
237 tx on|off
239 Specifies whether TX checksumming should be enabled.
240 sg on|off
242 Specifies whether scatter-gather should be enabled.
243 tso on|off
245 Specifies whether TCP segmentation offload should be en‐
246 abled.
247 ufo on|off
249 Specifies whether UDP fragmentation offload should be en‐
250 abled
251 gso on|off
253 Specifies whether generic segmentation offload should be en‐
254 abled
255 gro on|off
257 Specifies whether generic receive offload should be enabled
258 lro on|off
260 Specifies whether large receive offload should be enabled
261 rxvlan on|off
263 Specifies whether RX VLAN acceleration should be enabled
264 txvlan on|off
266 Specifies whether TX VLAN acceleration should be enabled
267 ntuple on|off
269 Specifies whether Rx ntuple filters and actions should be
270 enabled
271 rxhash on|off
273 Specifies whether receive hashing offload should be enabled
274 -p --identify
276 Initiates adapter-specific action intended to enable an operator
277 to easily identify the adapter by sight. Typically this in‐
278 volves blinking one or more LEDs on the specific network port.
279 [ N] Length of time to perform phys-id, in seconds.
281 -P --show-permaddr
283 Queries the specified network device for permanent hardware ad‐
284 dress.
285 -r --negotiate
287 Restarts auto-negotiation on the specified Ethernet device, if
288 auto-negotiation is enabled.
289 -S --statistics
291 Queries the specified network device for NIC- and driver-specif‐
292 ic statistics.
293 --phy-statistics
295 Queries the specified network device for PHY specific statis‐
296 tics.
297 -t --test
299 Executes adapter selftest on the specified network device. Pos‐
300 sible test modes are:
301 offline
303 Perform full set of tests, possibly interrupting normal op‐
304 eration during the tests,
305 online Perform limited set of tests, not interrupting normal opera‐
307 tion,
308 external_lb
310 Perform full set of tests, as for offline, and additionally
311 an external-loopback test.
312 -s --change
314 Allows changing some or all settings of the specified network
315 device. All following options only apply if -s was specified.
316 speed N
318 Set speed in Mb/s. ethtool with just the device name as an
319 argument will show you the supported device speeds.
320 duplex half|full
322 Sets full or half duplex mode.
323 port tp|aui|bnc|mii
325 Selects device port.
326 mdix auto|on|off
328 Selects MDI-X mode for port. May be used to override the au‐
329 tomatic detection feature of most adapters. An argument of
330 auto means automatic detection of MDI status, on forces MDI-
331 X (crossover) mode, while off means MDI (straight through)
332 mode. The driver should guarantee that this command takes
333 effect immediately, and if necessary may reset the link to
334 cause the change to take effect.
335 autoneg on|off
337 Specifies whether autonegotiation should be enabled. Autone‐
338 gotiation is enabled by default, but in some network devices
339 may have trouble with it, so you can disable it if really
340 necessary.
341 advertise N
343 Sets the speed and duplex advertised by autonegotiation.
344 The argument is a hexadecimal value using one or a combina‐
345 tion of the following values:
346 0x001 10baseT Half
348 0x002 10baseT Full
349 0x004 100baseT Half
350 0x008 100baseT Full
351 0x80000000000000000 100baseT1 Full
352 0x010 1000baseT Half (not supported by IEEE standards)
353 0x020 1000baseT Full
354 0x100000000000000000 1000baseT1 Full
355 0x20000 1000baseKX Full
356 0x20000000000 1000baseX Full
357 0x800000000000 2500baseT Full
358 0x8000 2500baseX Full (not supported by IEEE standards)
359 0x1000000000000 5000baseT Full
360 0x1000 10000baseT Full
361 0x40000 10000baseKX4 Full
362 0x80000 10000baseKR Full
363 0x100000 10000baseR_FEC
364 0x40000000000 10000baseCR Full
365 0x80000000000 10000baseSR Full
366 0x100000000000 10000baseLR Full
367 0x200000000000 10000baseLRM Full
368 0x400000000000 10000baseER Full
369 0x200000 20000baseMLD2 Full (not supported by IEEE standards)
370 0x400000 20000baseKR2 Full (not supported by IEEE standards)
371 0x80000000 25000baseCR Full
372 0x100000000 25000baseKR Full
373 0x200000000 25000baseSR Full
374 0x800000 40000baseKR4 Full
375 0x1000000 40000baseCR4 Full
376 0x2000000 40000baseSR4 Full
377 0x4000000 40000baseLR4 Full
378 0x400000000 50000baseCR2 Full
379 0x800000000 50000baseKR2 Full
380 0x10000000000 50000baseSR2 Full
381 0x10000000000000 50000baseKR Full
382 0x20000000000000 50000baseSR Full
383 0x40000000000000 50000baseCR Full
384 0x80000000000000 50000baseLR_ER_FR Full
385 0x100000000000000 50000baseDR Full
386 0x8000000 56000baseKR4 Full
387 0x10000000 56000baseCR4 Full
388 0x20000000 56000baseSR4 Full
389 0x40000000 56000baseLR4 Full
390 0x1000000000 100000baseKR4 Full
391 0x2000000000 100000baseSR4 Full
392 0x4000000000 100000baseCR4 Full
393 0x8000000000 100000baseLR4_ER4 Full
394 0x200000000000000 100000baseKR2 Full
395 0x400000000000000 100000baseSR2 Full
396 0x800000000000000 100000baseCR2 Full
397 0x1000000000000000 100000baseLR2_ER2_FR2 Full
398 0x2000000000000000 100000baseDR2 Full
399 0x4000000000000000 200000baseKR4 Full
400 0x8000000000000000 200000baseSR4 Full
401 0x10000000000000000 200000baseLR4_ER4_FR4 Full
402 0x20000000000000000 200000baseDR4 Full
403 0x40000000000000000 200000baseCR4 Full
404 phyad N
406 PHY address.
407 xcvr internal|external
409 Selects transceiver type. Currently only internal and exter‐
410 nal can be specified, in the future further types might be
411 added.
412 wol p|u|m|b|a|g|s|f|d...
414 Sets Wake-on-LAN options. Not all devices support this.
415 The argument to this option is a string of characters speci‐
416 fying which options to enable.
417 p Wake on PHY activity
419 u Wake on unicast messages
420 m Wake on multicast messages
421 b Wake on broadcast messages
422 a Wake on ARP
423 g Wake on MagicPacket™
424 s Enable SecureOn™ password for MagicPacket™
425 f Wake on filter(s)
426 d Disable (wake on nothing). This option
427 clears all previous options.
428 sopass xx:yy:zz:aa:bb:cc
430 Sets the SecureOn™ password. The argument to this option
431 must be 6 bytes in Ethernet MAC hex format
432 (xx:yy:zz:aa:bb:cc).
433 msglvl N
435 msglvl type on|off ...
436 Sets the driver message type flags by name or number. type
437 names the type of message to enable or disable; N specifies
438 the new flags numerically. The defined type names and num‐
439 bers are:
440 drv 0x0001 General driver status
442 probe 0x0002 Hardware probing
443 link 0x0004 Link state
444 timer 0x0008 Periodic status check
445 ifdown 0x0010 Interface being brought down
446 ifup 0x0020 Interface being brought up
447 rx_err 0x0040 Receive error
448 tx_err 0x0080 Transmit error
449 tx_queued 0x0100 Transmit queueing
450 intr 0x0200 Interrupt handling
451 tx_done 0x0400 Transmit completion
452 rx_status 0x0800 Receive completion
453 pktdata 0x1000 Packet contents
454 hw 0x2000 Hardware status
455 wol 0x4000 Wake-on-LAN status
456 The precise meanings of these type flags differ between
458 drivers.
459 -n -u --show-nfc --show-ntuple
461 Retrieves receive network flow classification options or rules.
462 rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6
464 Retrieves the hash options for the specified flow type.
465 tcp4 TCP over IPv4
467 udp4 UDP over IPv4
468 ah4 IPSEC AH over IPv4
469 esp4 IPSEC ESP over IPv4
470 sctp4 SCTP over IPv4
471 tcp6 TCP over IPv6
472 udp6 UDP over IPv6
473 ah6 IPSEC AH over IPv6
474 esp6 IPSEC ESP over IPv6
475 sctp6 SCTP over IPv6
476 rule N Retrieves the RX classification rule with the given ID.
478 -N -U --config-nfc --config-ntuple
480 Configures receive network flow classification options or rules.
481 rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6
483 m|v|t|s|d|f|n|r...
484 Configures the hash options for the specified flow type.
485 m Hash on the Layer 2 destination address of the rx packet.
487 v Hash on the VLAN tag of the rx packet.
488 t Hash on the Layer 3 protocol field of the rx packet.
489 s Hash on the IP source address of the rx packet.
490 d Hash on the IP destination address of the rx packet.
491 f Hash on bytes 0 and 1 of the Layer 4 header of the rx packet.
492 n Hash on bytes 2 and 3 of the Layer 4 header of the rx packet.
493 r Discard all packets of this flow type. When this option is
494 set, all other options are ignored.
495 flow-type
497 ether|ip4|tcp4|udp4|sctp4|ah4|esp4|ip6|tcp6|udp6|ah6|esp6|sctp6
498 Inserts or updates a classification rule for the specified
499 flow type.
500 ether Ethernet
502 ip4 Raw IPv4
503 tcp4 TCP over IPv4
504 udp4 UDP over IPv4
505 sctp4 SCTP over IPv4
506 ah4 IPSEC AH over IPv4
507 esp4 IPSEC ESP over IPv4
508 ip6 Raw IPv6
509 tcp6 TCP over IPv6
510 udp6 UDP over IPv6
511 sctp6 SCTP over IPv6
512 ah6 IPSEC AH over IPv6
513 esp6 IPSEC ESP over IPv6
514 For all fields that allow both a value and a mask to be specified,
516 the mask may be specified immediately after the value using the m
517 keyword, or separately using the field name keyword with -mask ap‐
518 pended, e.g. src-mask.
519 src xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]
521 Includes the source MAC address, specified as 6 bytes in
522 hexadecimal separated by colons, along with an optional
523 mask. Valid only for flow-type ether.
524 dst xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]
526 Includes the destination MAC address, specified as 6 bytes
527 in hexadecimal separated by colons, along with an optional
528 mask. Valid only for flow-type ether.
529 proto N [m N]
531 Includes the Ethernet protocol number (ethertype) and an op‐
532 tional mask. Valid only for flow-type ether.
533 src-ip ip-address [m ip-address]
535 Specify the source IP address of the incoming packet to
536 match along with an optional mask. Valid for all IP based
537 flow-types.
538 dst-ip ip-address [m ip-address]
540 Specify the destination IP address of the incoming packet to
541 match along with an optional mask. Valid for all IP based
542 flow-types.
543 tos N [m N]
545 Specify the value of the Type of Service field in the incom‐
546 ing packet to match along with an optional mask. Applies to
547 all IPv4 based flow-types.
548 tclass N [m N]
550 Specify the value of the Traffic Class field in the incoming
551 packet to match along with an optional mask. Applies to all
552 IPv6 based flow-types.
553 l4proto N [m N]
555 Includes the layer 4 protocol number and optional mask.
556 Valid only for flow-types ip4 and ip6.
557 src-port N [m N]
559 Specify the value of the source port field (applicable to
560 TCP/UDP packets) in the incoming packet to match along with
561 an optional mask. Valid for flow-types ip4, tcp4, udp4, and
562 sctp4 and their IPv6 equivalents.
563 dst-port N [m N]
565 Specify the value of the destination port field (applicable
566 to TCP/UDP packets)in the incoming packet to match along
567 with an optional mask. Valid for flow-types ip4, tcp4,
568 udp4, and sctp4 and their IPv6 equivalents.
569 spi N [m N]
571 Specify the value of the security parameter index field (ap‐
572 plicable to AH/ESP packets)in the incoming packet to match
573 along with an optional mask. Valid for flow-types ip4, ah4,
574 and esp4 and their IPv6 equivalents.
575 l4data N [m N]
577 Specify the value of the first 4 Bytes of Layer 4 in the in‐
578 coming packet to match along with an optional mask. Valid
579 for ip4 and ip6 flow-types.
580 vlan-etype N [m N]
582 Includes the VLAN tag Ethertype and an optional mask.
583 vlan N [m N]
585 Includes the VLAN tag and an optional mask.
586 user-def N [m N]
588 Includes 64-bits of user-specific data and an optional mask.
589 dst-mac xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]
591 Includes the destination MAC address, specified as 6 bytes
592 in hexadecimal separated by colons, along with an optional
593 mask. Valid for all IP based flow-types.
594 action N
596 Specifies the Rx queue to send packets to, or some other ac‐
597 tion.
598 -1 Drop the matched flow
600 -2 Use the matched flow as a Wake-on-LAN filter
601 0 or higher Rx queue to route the flow
602 context N
604 Specifies the RSS context to spread packets over multiple
605 queues; either 0 for the default RSS context, or a value re‐
606 turned by ethtool -X ... context new.
607 vf N Specifies the Virtual Function the filter applies to. Not
609 compatible with action.
610 queue N
612 Specifies the Rx queue to send packets to. Not compatible
613 with action.
614 loc N Specify the location/ID to insert the rule. This will over‐
616 write any rule present in that location and will not go
617 through any of the rule ordering process.
618 delete N
620 Deletes the RX classification rule with the given ID.
621 -w --get-dump
623 Retrieves and prints firmware dump for the specified network de‐
624 vice. By default, it prints out the dump flag, version and
625 length of the dump data. When data is indicated, then ethtool
626 fetches the dump data and directs it to a file.
627 -W --set-dump
629 Sets the dump flag for the device.
630 -T --show-time-stamping
632 Show the device's time stamping capabilities and associated PTP
633 hardware clock.
634 -x --show-rxfh-indir --show-rxfh
636 Retrieves the receive flow hash indirection table and/or RSS
637 hash key.
638 -X --set-rxfh-indir --rxfh
640 Configures the receive flow hash indirection table and/or RSS
641 hash key.
642 hkey Sets RSS hash key of the specified network device. RSS hash
644 key should be of device supported length. Hash key format
645 must be in xx:yy:zz:aa:bb:cc format meaning both the nibbles
646 of a byte should be mentioned even if a nibble is zero.
647 hfunc Sets RSS hash function of the specified network device.
649 List of RSS hash functions which kernel supports is shown as
650 a part of the --show-rxfh command output.
651 start N
653 For the equal and weight options, sets the starting receive
654 queue for spreading flows to N.
655 equal N
657 Sets the receive flow hash indirection table to spread flows
658 evenly between the first N receive queues.
659 weight W0 W1 ...
661 Sets the receive flow hash indirection table to spread flows
662 between receive queues according to the given weights. The
663 sum of the weights must be non-zero and must not exceed the
664 size of the indirection table.
665 default
667 Sets the receive flow hash indirection table to its default
668 value.
669 context CTX | new
671 Specifies an RSS context to act on; either new to allocate a
672 new RSS context, or CTX, a value returned by a previous
673 ... context new.
674 delete Delete the specified RSS context. May only be used in con‐
676 junction with context and a non-zero CTX value.
677 -f --flash
679 Write a firmware image to flash or other non-volatile memory on
680 the device.
681 file Specifies the filename of the firmware image. The firmware
683 must first be installed in one of the directories where the
684 kernel firmware loader or firmware agent will look, such as
685 /lib/firmware.
686 N If the device stores multiple firmware images in separate
688 regions of non-volatile memory, this parameter may be used
689 to specify which region is to be written. The default is 0,
690 requesting that all regions are written. All other values
691 are driver-dependent.
692 -l --show-channels
694 Queries the specified network device for the numbers of channels
695 it has. A channel is an IRQ and the set of queues that can
696 trigger that IRQ.
697 -L --set-channels
699 Changes the numbers of channels of the specified network device.
700 rx N Changes the number of channels with only receive queues.
702 tx N Changes the number of channels with only transmit queues.
704 other N
706 Changes the number of channels used only for other purposes
707 e.g. link interrupts or SR-IOV co-ordination.
708 combined N
710 Changes the number of multi-purpose channels.
711 -m --dump-module-eeprom --module-info
713 Retrieves and if possible decodes the EEPROM from plugin mod‐
714 ules, e.g SFP+, QSFP. If the driver and module support it, the
715 optical diagnostic information is also read and decoded.
716 --show-priv-flags
718 Queries the specified network device for its private flags. The
719 names and meanings of private flags (if any) are defined by each
720 network device driver.
721 --set-priv-flags
723 Sets the device's private flags as specified.
724 flag on|off Sets the state of the named private flag.
726 --show-eee
728 Queries the specified network device for its support of Energy-
729 Efficient Ethernet (according to the IEEE 802.3az specifica‐
730 tions)
731 --set-eee
733 Sets the device EEE behaviour.
734 eee on|off
736 Enables/disables the device support of EEE.
737 tx-lpi on|off
739 Determines whether the device should assert its Tx LPI.
740 advertise N
742 Sets the speeds for which the device should advertise EEE
743 capabilities. Values are as for --change advertise
744 tx-timer N
746 Sets the amount of time the device should stay in idle mode
747 prior to asserting its Tx LPI (in microseconds). This has
748 meaning only when Tx LPI is enabled.
749 --set-phy-tunable
751 Sets the PHY tunable parameters.
752 downshift on|off
754 Specifies whether downshift should be enabled.
755 count N
757 Sets the PHY downshift re-tries count.
758 fast-link-down on|off
760 Specifies whether Fast Link Down should be enabled and time
761 until link down (if supported).
762 msecs N
764 Sets the period after which the link is reported as down. Note that the PHY may choose
765 the closest supported value. Only on reading back the tunable do you get the actual value.
766 energy-detect-power-down on|off
768 Specifies whether Energy Detect Power Down (EDPD) should be
769 enabled (if supported). This will put the RX and TX circuit
770 blocks into a low power mode, and the PHY will wake up peri‐
771 odically to send link pulses to avoid any lock-up situation
772 with a peer PHY that may also have EDPD enabled. By default,
773 this setting will also enable the periodic transmission of
774 TX pulses.
775 msecs N
777 Some PHYs support configuration of the wake-up interval to send TX pulses.
778 This setting allows the control of this interval, and 0 disables TX pulses
779 if the PHY supports this. Disabling TX pulses can create a lock-up situation
780 where neither of the PHYs wakes the other one. If unspecified the default
781 value (in milliseconds) will be used by the PHY.
782 --get-phy-tunable
785 Gets the PHY tunable parameters.
786 downshift
788 For operation in cabling environments that are
789 incompatible with 1000BASE-T, PHY device provides
790 an automatic link speed downshift operation.
791 Link speed downshift after N failed 1000BASE-T
792 auto-negotiation attempts. Downshift is useful
793 where cable does not have the 4 pairs instance.
794 Gets the PHY downshift count/status.
796 fast-link-down
798 Depending on the mode it may take 0.5s - 1s until
799 a broken link is reported as down. In certain
800 use cases a link-down event needs to be reported
801 as soon as possible. Some PHYs support a Fast
802 Link Down Feature and may allow configuration of
803 the delay before a broken link is reported as be‐
804 ing down.
805 Gets the PHY Fast Link Down status / period.
807 energy-detect-power-down
809 Gets the current configured setting for Energy
810 Detect Power Down (if supported).
811 --reset
814 Reset hardware components specified by flags and com‐
815 ponents listed below
816 flags N
818 Resets the components based on direct flags mask
819 mgmt Management processor
821 irq Interrupt requester
823 dma DMA engine
825 filter Filtering/flow direction
827 offload
829 Protocol offload
830 mac Media access controller
832 phy Transceiver/PHY
834 ram RAM shared between multiple components ap Appli‐
836 cation Processor
837 dedicated
839 All components dedicated to this interface
840 all All components used by this interface, even if
842 shared
843 --show-fec
845 Queries the specified network device for its support
846 of Forward Error Correction.
847 --set-fec
849 Configures Forward Error Correction for the specified
850 network device.
851 Forward Error Correction modes selected by a user are
853 expected to be persisted after any hotplug events. If
854 a module is swapped that does not support the current
855 FEC mode, the driver or firmware must take the link
856 down administratively and report the problem in the
857 system logs for users to correct.
858 encoding auto|off|rs|baser [...]
860 Sets the FEC encoding for the device. Combina‐
862 tions of options are specified as e.g. encoding
863 auto rs ; the semantics of such combinations vary
864 between drivers.
865 auto Use the driver's default encoding
867 off Turn off FEC
868 RS Force RS-FEC encoding
869 BaseR Force BaseR encoding
870 -Q|--per-queue
872 Applies provided sub command to specific queues.
873 queue_mask %x
875 Sets the specific queues which the sub command is
876 applied to. If queue_mask is not set, the sub
877 command will be applied to all queues.
878 sub_command
880 Sub command to apply. The supported sub commands
881 include --show-coalesce and --coalesce.
882
884 Not supported (in part or whole) on all network drivers.
885
887 ethtool was written by David Miller.
888 Modifications by Jeff Garzik, Tim Hockin, Jakub Jelinek, An‐
890 dre Majorel, Eli Kupermann, Scott Feldman, Andi Kleen,
891 Alexander Duyck, Sucheta Chakraborty, Jesse Brandeburg, Ben
892 Hutchings, Scott Branden.
893
895 ethtool is available from
896 ⟨http://www.kernel.org/pub/software/network/ethtool/⟩
897Ethtool version 5.4 January 2020 ETHTOOL(8)