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 [--debug N] args
16 ethtool [--json] args
18 ethtool [-I | --include-statistics] args
20 ethtool --monitor [ command ] [ devname ]
22 ethtool -a|--show-pause devname
24 ethtool -A|--pause devname [autoneg on|off] [rx on|off] [tx on|off]
26 ethtool -c|--show-coalesce devname
28 ethtool -C|--coalesce devname [adaptive-rx on|off] [adaptive-tx on|off]
30 [rx-usecs N] [rx-frames N] [rx-usecs-irq N] [rx-frames-irq N]
31 [tx-usecs N] [tx-frames N] [tx-usecs-irq N] [tx-frames-irq N]
32 [stats-block-usecs N] [pkt-rate-low N] [rx-usecs-low N]
33 [rx-frames-low N] [tx-usecs-low N] [tx-frames-low N]
34 [pkt-rate-high N] [rx-usecs-high N] [rx-frames-high N]
35 [tx-usecs-high N] [tx-frames-high N] [sample-interval N]
36 [cqe-mode-rx on|off] [cqe-mode-tx on|off]
37 ethtool -g|--show-ring devname
39 ethtool -G|--set-ring devname [rx N] [rx-mini N] [rx-jumbo N] [tx N]
41 [rx-buf-len N] [cqe-size N]
42 ethtool -i|--driver devname
44 ethtool -d|--register-dump devname [raw on|off] [hex on|off] [file
46 name]
47 ethtool -e|--eeprom-dump devname [raw on|off] [offset N] [length N]
49 ethtool -E|--change-eeprom devname [magic N] [offset N] [length N]
51 [value N]
52 ethtool -k|--show-features|--show-offload devname
54 ethtool -K|--features|--offload devname feature on|off ...
56 ethtool -p|--identify devname [N]
58 ethtool -P|--show-permaddr devname
60 ethtool -r|--negotiate devname
62 ethtool -S|--statistics devname [--all-groups|--groups [eth-phy]
64 [eth-mac] [eth-ctrl] ]
65 ethtool --phy-statistics devname
67 ethtool -t|--test devname [offline|online|external_lb]
69 ethtool -s devname [speed N] [lanes N] [duplex half|full]
71 [port tp|aui|bnc|mii] [mdix auto|on|off] [autoneg on|off]
72 [advertise N[/M] | advertise mode on|off ...] [phyad N]
73 [xcvr internal|external] [wol N[/M] | wol p|u|m|b|a|g|s|f|d...]
74 [sopass xx:yy:zz:aa:bb:cc] [master-slave preferred-
75 master|preferred-slave|forced-master|forced-slave] [msglvl
76 N[/M] | msglvl type on|off ...]
77 ethtool -n|-u|--show-nfc|--show-ntuple devname
79 [ rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6 |
80 rule N ]
81 ethtool -N|-U|--config-nfc|--config-ntuple devname
83 rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6
84 m|v|t|s|d|f|n|r... |
85 flow-type
86 ether|ip4|tcp4|udp4|sctp4|ah4|esp4|ip6|tcp6|udp6|ah6|esp6|sctp6
87 [src xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]]
88 [dst xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]] [proto N [m N]]
89 [src-ip ip-address [m ip-address]] [dst-ip ip-address [m ip-
90 address]] [tos N [m N]] [tclass N [m N]] [l4proto N [m N]]
91 [src-port N [m N]] [dst-port N [m N]] [spi N [m N]]
92 [l4data N [m N]] [vlan-etype N [m N]] [vlan N [m N]]
93 [user-def N [m N]] [dst-
94 mac xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]] [action N]
95 [context N] [loc N] |
96 delete N
97 ethtool -w|--get-dump devname [data filename]
99 ethtool -W|--set-dump devname N
101 ethtool -T|--show-time-stamping devname
103 ethtool -x|--show-rxfh-indir|--show-rxfh devname
105 ethtool -X|--set-rxfh-indir|--rxfh devname [hkey xx:yy:zz:aa:bb:cc:...]
107 [start N] [ equal N | weight W0 W1 ... | default ] [hfunc FUNC]
108 [context CTX | new] [delete]
109 ethtool -f|--flash devname file [N]
111 ethtool -l|--show-channels devname
113 ethtool -L|--set-channels devname [rx N] [tx N] [other N] [combined N]
115 ethtool -m|--dump-module-eeprom|--module-info devname [raw on|off]
117 [hex on|off] [offset N] [length N] [page N] [bank N] [i2c N]
118 ethtool --show-priv-flags devname
120 ethtool --set-priv-flags devname flag on|off ...
122 ethtool --show-eee devname
124 ethtool --set-eee devname [eee on|off] [tx-lpi on|off] [tx-timer N]
126 [advertise N]
127 ethtool --set-phy-tunable devname [ downshift on|off [count N] ] [
129 fast-link-down on|off [msecs N] ] [ energy-detect-power-down
130 on|off [msecs N] ]
131 ethtool --get-phy-tunable devname [downshift] [fast-link-down] [energy-
133 detect-power-down]
134 ethtool --get-tunable devname [rx-copybreak] [tx-copybreak] [tx-buf-
136 size] [pfc-prevention-tout]
137 ethtool --set-tunable devname [rx-copybreak N] [tx-copybreak N]
139 [tx-buf-size N] [pfc-prevention-tout N]
140 ethtool --reset devname [flags N] [mgmt] [mgmt-shared] [irq] [irq-
142 shared] [dma] [dma-shared] [filter] [filter-shared] [offload]
143 [offload-shared] [mac] [mac-shared] [phy] [phy-shared] [ram]
144 [ram-shared] [ap] [ap-shared] [dedicated] [all]
145 ethtool --show-fec devname
147 ethtool --set-fec devname encoding auto|off|rs|baser|llrs [...]
149 ethtool -Q|--per-queue devname [queue_mask %x] sub_command ...
151 .
152 ethtool --cable-test devname
154 ethtool --cable-test-tdr devname [first N] [last N] [step N] [pair N]
156 ethtool --show-tunnels devname
158 ethtool --show-module devname
160 ethtool --set-module devname [power-mode-policy high|auto]
162
165 ethtool is used to query and control network device driver and hardware
166 settings, particularly for wired Ethernet devices.
167 devname is the name of the network device on which ethtool should oper‐
169 ate.
170
173 ethtool with a single argument specifying the device name prints cur‐
174 rent settings of the specified device.
175 -h --help
177 Shows a short help message.
178 --version
180 Shows the ethtool version number.
181 --debug N
183 Turns on debugging messages. Argument is interpreted as a mask:
184 0x01 Parser information
186 --json Output results in JavaScript Object Notation (JSON). Only a sub‐
188 set of options support this. Those which do not will continue to
189 output plain text in the presence of this option.
190 -I --include-statistics
192 Include command-related statistics in the output. This option
193 allows displaying relevant device statistics for selected get
194 commands.
195 -a --show-pause
197 Queries the specified Ethernet device for pause parameter infor‐
198 mation.
199 -A --pause
201 Changes the pause parameters of the specified Ethernet device.
202 autoneg on|off
204 Specifies whether pause autonegotiation should be enabled.
205 rx on|off
207 Specifies whether RX pause should be enabled.
208 tx on|off
210 Specifies whether TX pause should be enabled.
211 -c --show-coalesce
213 Queries the specified network device for coalescing information.
214 -C --coalesce
216 Changes the coalescing settings of the specified network device.
217 -g --show-ring
219 Queries the specified network device for rx/tx ring parameter
220 information.
221 -G --set-ring
223 Changes the rx/tx ring parameters of the specified network de‐
224 vice.
225 rx N Changes the number of ring entries for the Rx ring.
227 rx-mini N
229 Changes the number of ring entries for the Rx Mini ring.
230 rx-jumbo N
232 Changes the number of ring entries for the Rx Jumbo ring.
233 tx N Changes the number of ring entries for the Tx ring.
235 rx-buf-len N
237 Changes the size of a buffer in the Rx ring.
238 cqe-size N
240 Changes the size of completion queue event.
241 -i --driver
243 Queries the specified network device for associated driver in‐
244 formation.
245 -d --register-dump
247 Retrieves and prints a register dump for the specified network
248 device. The register format for some devices is known and de‐
249 coded others are printed in hex. When raw is enabled, then eth‐
250 tool dumps the raw register data to stdout. If file is speci‐
251 fied, then use contents of previous raw register dump, rather
252 than reading from the device.
253 -e --eeprom-dump
255 Retrieves and prints an EEPROM dump for the specified network
256 device. When raw is enabled, then it dumps the raw EEPROM data
257 to stdout. The length and offset parameters allow dumping cer‐
258 tain portions of the EEPROM. Default is to dump the entire EEP‐
259 ROM.
260 raw on|off
262 offset N
264 length N
266 -E --change-eeprom
268 If value is specified, changes EEPROM byte for the specified
269 network device. offset and value specify which byte and it's
270 new value. If value is not specified, stdin is read and written
271 to the EEPROM. The length and offset parameters allow writing to
272 certain portions of the EEPROM. Because of the persistent na‐
273 ture of writing to the EEPROM, a device-specific magic key must
274 be specified to prevent the accidental writing to the EEPROM.
275 -k --show-features --show-offload
277 Queries the specified network device for the state of protocol
278 offload and other features.
279 -K --features --offload
281 Changes the offload parameters and other features of the speci‐
282 fied network device. The following feature names are built-in
283 and others may be defined by the kernel.
284 rx on|off
286 Specifies whether RX checksumming should be enabled.
287 tx on|off
289 Specifies whether TX checksumming should be enabled.
290 sg on|off
292 Specifies whether scatter-gather should be enabled.
293 tso on|off
295 Specifies whether TCP segmentation offload should be en‐
296 abled.
297 ufo on|off
299 Specifies whether UDP fragmentation offload should be en‐
300 abled
301 gso on|off
303 Specifies whether generic segmentation offload should be en‐
304 abled
305 gro on|off
307 Specifies whether generic receive offload should be enabled
308 lro on|off
310 Specifies whether large receive offload should be enabled
311 rxvlan on|off
313 Specifies whether RX VLAN acceleration should be enabled
314 txvlan on|off
316 Specifies whether TX VLAN acceleration should be enabled
317 ntuple on|off
319 Specifies whether Rx ntuple filters and actions should be
320 enabled
321 rxhash on|off
323 Specifies whether receive hashing offload should be enabled
324 -p --identify
326 Initiates adapter-specific action intended to enable an operator
327 to easily identify the adapter by sight. Typically this in‐
328 volves blinking one or more LEDs on the specific network port.
329 [ N] Length of time to perform phys-id, in seconds.
331 -P --show-permaddr
333 Queries the specified network device for permanent hardware ad‐
334 dress.
335 -r --negotiate
337 Restarts auto-negotiation on the specified Ethernet device, if
338 auto-negotiation is enabled.
339 -S --statistics
341 Queries the specified network device for standard (IEEE, IETF,
342 etc.), or NIC- and driver-specific statistics. NIC- and driver-
343 specific statistics are requested when no group of statistics is
344 specified.
345 NIC- and driver-specific statistics and standard statistics are
347 independent, devices may implement either, both or none. There
348 is little commonality between naming of NIC- and driver-specific
349 statistics across vendors.
350 --all-groups
352 --groups [eth-phy] [eth-mac] [eth-ctrl] [rmon]
354 Request groups of standard device statistics.
355 --phy-statistics
357 Queries the specified network device for PHY specific statis‐
358 tics.
359 -t --test
361 Executes adapter selftest on the specified network device. Pos‐
362 sible test modes are:
363 offline
365 Perform full set of tests, possibly interrupting normal op‐
366 eration during the tests,
367 online Perform limited set of tests, not interrupting normal opera‐
369 tion,
370 external_lb
372 Perform full set of tests, as for offline, and additionally
373 an external-loopback test.
374 -s --change
376 Allows changing some or all settings of the specified network
377 device. All following options only apply if -s was specified.
378 speed N
380 Set speed in Mb/s. ethtool with just the device name as an
381 argument will show you the supported device speeds.
382 lanes N
384 Set number of lanes.
385 duplex half|full
387 Sets full or half duplex mode.
388 port tp|aui|bnc|mii
390 Selects device port.
391 master-slave preferred-master|preferred-slave|forced-master|forced-
393 slave
394 Configure MASTER/SLAVE role of the PHY. When the PHY is con‐
395 figured as MASTER, the PMA Transmit function shall source
396 TX_TCLK from a local clock source. When configured as SLAVE,
397 the PMA Transmit function shall source TX_TCLK from the
398 clock recovered from data stream provided by MASTER. Not all
399 devices support this.
400 preferred-master Prefer MASTER role on autonegotiation
402 preferred-slave Prefer SLAVE role on autonegotiation
403 forced-master Force the PHY in MASTER role. Can be used without autonegotiation
404 forced-slave Force the PHY in SLAVE role. Can be used without autonegotiation
405 mdix auto|on|off
407 Selects MDI-X mode for port. May be used to override the au‐
408 tomatic detection feature of most adapters. An argument of
409 auto means automatic detection of MDI status, on forces MDI-
410 X (crossover) mode, while off means MDI (straight through)
411 mode. The driver should guarantee that this command takes
412 effect immediately, and if necessary may reset the link to
413 cause the change to take effect.
414 autoneg on|off
416 Specifies whether autonegotiation should be enabled. Autone‐
417 gotiation is enabled by default, but in some network devices
418 may have trouble with it, so you can disable it if really
419 necessary.
420 advertise N
422 Sets the speed and duplex advertised by autonegotiation.
423 The argument is a hexadecimal value using one or a combina‐
424 tion of the following values:
425 0x001 10baseT Half
427 0x002 10baseT Full
428 0x004 100baseT Half
429 0x008 100baseT Full
430 0x80000000000000000 100baseT1 Full
431 0x40000000000000000000000 100baseFX Half
432 0x80000000000000000000000 100baseFX Full
433 0x010 1000baseT Half (not supported by IEEE standards)
434 0x020 1000baseT Full
435 0x20000 1000baseKX Full
436 0x20000000000 1000baseX Full
437 0x100000000000000000 1000baseT1 Full
438 0x8000 2500baseX Full (not supported by IEEE standards)
439 0x800000000000 2500baseT Full
440 0x1000000000000 5000baseT Full
441 0x1000 10000baseT Full
442 0x40000 10000baseKX4 Full
443 0x80000 10000baseKR Full
444 0x100000 10000baseR_FEC
445 0x40000000000 10000baseCR Full
446 0x80000000000 10000baseSR Full
447 0x100000000000 10000baseLR Full
448 0x200000000000 10000baseLRM Full
449 0x400000000000 10000baseER Full
450 0x200000 20000baseMLD2 Full (not supported by IEEE standards)
451 0x400000 20000baseKR2 Full (not supported by IEEE standards)
452 0x80000000 25000baseCR Full
453 0x100000000 25000baseKR Full
454 0x200000000 25000baseSR Full
455 0x800000 40000baseKR4 Full
456 0x1000000 40000baseCR4 Full
457 0x2000000 40000baseSR4 Full
458 0x4000000 40000baseLR4 Full
459 0x400000000 50000baseCR2 Full
460 0x800000000 50000baseKR2 Full
461 0x10000000000 50000baseSR2 Full
462 0x10000000000000 50000baseKR Full
463 0x20000000000000 50000baseSR Full
464 0x40000000000000 50000baseCR Full
465 0x80000000000000 50000baseLR_ER_FR Full
466 0x100000000000000 50000baseDR Full
467 0x8000000 56000baseKR4 Full
468 0x10000000 56000baseCR4 Full
469 0x20000000 56000baseSR4 Full
470 0x40000000 56000baseLR4 Full
471 0x1000000000 100000baseKR4 Full
472 0x2000000000 100000baseSR4 Full
473 0x4000000000 100000baseCR4 Full
474 0x8000000000 100000baseLR4_ER4 Full
475 0x200000000000000 100000baseKR2 Full
476 0x400000000000000 100000baseSR2 Full
477 0x800000000000000 100000baseCR2 Full
478 0x1000000000000000 100000baseLR2_ER2_FR2 Full
479 0x2000000000000000 100000baseDR2 Full
480 0x8000000000000000000 100000baseKR Full
481 0x10000000000000000000 100000baseSR Full
482 0x20000000000000000000 100000baseLR_ER_FR Full
483 0x40000000000000000000 100000baseCR Full
484 0x80000000000000000000 100000baseDR Full
485 0x4000000000000000 200000baseKR4 Full
486 0x8000000000000000 200000baseSR4 Full
487 0x10000000000000000 200000baseLR4_ER4_FR4 Full
488 0x20000000000000000 200000baseDR4 Full
489 0x40000000000000000 200000baseCR4 Full
490 0x100000000000000000000 200000baseKR2 Full
491 0x200000000000000000000 200000baseSR2 Full
492 0x400000000000000000000 200000baseLR2_ER2_FR2 Full
493 0x800000000000000000000 200000baseDR2 Full
494 0x1000000000000000000000 200000baseCR2 Full
495 0x200000000000000000 400000baseKR8 Full
496 0x400000000000000000 400000baseSR8 Full
497 0x800000000000000000 400000baseLR8_ER8_FR8 Full
498 0x1000000000000000000 400000baseDR8 Full
499 0x2000000000000000000 400000baseCR8 Full
500 0x2000000000000000000000 400000baseKR4 Full
501 0x4000000000000000000000 400000baseSR4 Full
502 0x8000000000000000000000 400000baseLR4_ER4_FR4 Full
503 0x10000000000000000000000 400000baseDR4 Full
504 0x20000000000000000000000 400000baseCR4 Full
505 phyad N
507 PHY address.
508 xcvr internal|external
510 Selects transceiver type. Currently only internal and exter‐
511 nal can be specified, in the future further types might be
512 added.
513 wol p|u|m|b|a|g|s|f|d...
515 Sets Wake-on-LAN options. Not all devices support this.
516 The argument to this option is a string of characters speci‐
517 fying which options to enable.
518 p Wake on PHY activity
520 u Wake on unicast messages
521 m Wake on multicast messages
522 b Wake on broadcast messages
523 a Wake on ARP
524 g Wake on MagicPacket™
525 s Enable SecureOn™ password for MagicPacket™
526 f Wake on filter(s)
527 d Disable (wake on nothing). This option
528 clears all previous options.
529 sopass xx:yy:zz:aa:bb:cc
531 Sets the SecureOn™ password. The argument to this option
532 must be 6 bytes in Ethernet MAC hex format
533 (xx:yy:zz:aa:bb:cc).
534 msglvl N
536 msglvl type on|off ...
537 Sets the driver message type flags by name or number. type
538 names the type of message to enable or disable; N specifies
539 the new flags numerically. The defined type names and num‐
540 bers are:
541 drv 0x0001 General driver status
543 probe 0x0002 Hardware probing
544 link 0x0004 Link state
545 timer 0x0008 Periodic status check
546 ifdown 0x0010 Interface being brought down
547 ifup 0x0020 Interface being brought up
548 rx_err 0x0040 Receive error
549 tx_err 0x0080 Transmit error
550 tx_queued 0x0100 Transmit queueing
551 intr 0x0200 Interrupt handling
552 tx_done 0x0400 Transmit completion
553 rx_status 0x0800 Receive completion
554 pktdata 0x1000 Packet contents
555 hw 0x2000 Hardware status
556 wol 0x4000 Wake-on-LAN status
557 The precise meanings of these type flags differ between
559 drivers.
560 -n -u --show-nfc --show-ntuple
562 Retrieves receive network flow classification options or rules.
563 rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6
565 Retrieves the hash options for the specified flow type.
566 tcp4 TCP over IPv4
568 udp4 UDP over IPv4
569 ah4 IPSEC AH over IPv4
570 esp4 IPSEC ESP over IPv4
571 sctp4 SCTP over IPv4
572 tcp6 TCP over IPv6
573 udp6 UDP over IPv6
574 ah6 IPSEC AH over IPv6
575 esp6 IPSEC ESP over IPv6
576 sctp6 SCTP over IPv6
577 rule N Retrieves the RX classification rule with the given ID.
579 -N -U --config-nfc --config-ntuple
581 Configures receive network flow classification options or rules.
582 rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6
584 m|v|t|s|d|f|n|r...
585 Configures the hash options for the specified flow type.
586 m Hash on the Layer 2 destination address of the rx packet.
588 v Hash on the VLAN tag of the rx packet.
589 t Hash on the Layer 3 protocol field of the rx packet.
590 s Hash on the IP source address of the rx packet.
591 d Hash on the IP destination address of the rx packet.
592 f Hash on bytes 0 and 1 of the Layer 4 header of the rx packet.
593 n Hash on bytes 2 and 3 of the Layer 4 header of the rx packet.
594 r Discard all packets of this flow type. When this option is
595 set, all other options are ignored.
596 flow-type
598 ether|ip4|tcp4|udp4|sctp4|ah4|esp4|ip6|tcp6|udp6|ah6|esp6|sctp6
599 Inserts or updates a classification rule for the specified
600 flow type.
601 ether Ethernet
603 ip4 Raw IPv4
604 tcp4 TCP over IPv4
605 udp4 UDP over IPv4
606 sctp4 SCTP over IPv4
607 ah4 IPSEC AH over IPv4
608 esp4 IPSEC ESP over IPv4
609 ip6 Raw IPv6
610 tcp6 TCP over IPv6
611 udp6 UDP over IPv6
612 sctp6 SCTP over IPv6
613 ah6 IPSEC AH over IPv6
614 esp6 IPSEC ESP over IPv6
615 For all fields that allow both a value and a mask to be specified,
617 the mask may be specified immediately after the value using the m
618 keyword, or separately using the field name keyword with -mask ap‐
619 pended, e.g. src-mask.
620 src xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]
622 Includes the source MAC address, specified as 6 bytes in
623 hexadecimal separated by colons, along with an optional
624 mask. Valid only for flow-type ether.
625 dst xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]
627 Includes the destination MAC address, specified as 6 bytes
628 in hexadecimal separated by colons, along with an optional
629 mask. Valid only for flow-type ether.
630 proto N [m N]
632 Includes the Ethernet protocol number (ethertype) and an op‐
633 tional mask. Valid only for flow-type ether.
634 src-ip ip-address [m ip-address]
636 Specify the source IP address of the incoming packet to
637 match along with an optional mask. Valid for all IP based
638 flow-types.
639 dst-ip ip-address [m ip-address]
641 Specify the destination IP address of the incoming packet to
642 match along with an optional mask. Valid for all IP based
643 flow-types.
644 tos N [m N]
646 Specify the value of the Type of Service field in the incom‐
647 ing packet to match along with an optional mask. Applies to
648 all IPv4 based flow-types.
649 tclass N [m N]
651 Specify the value of the Traffic Class field in the incoming
652 packet to match along with an optional mask. Applies to all
653 IPv6 based flow-types.
654 l4proto N [m N]
656 Includes the layer 4 protocol number and optional mask.
657 Valid only for flow-types ip4 and ip6.
658 src-port N [m N]
660 Specify the value of the source port field (applicable to
661 TCP/UDP packets) in the incoming packet to match along with
662 an optional mask. Valid for flow-types ip4, tcp4, udp4, and
663 sctp4 and their IPv6 equivalents.
664 dst-port N [m N]
666 Specify the value of the destination port field (applicable
667 to TCP/UDP packets)in the incoming packet to match along
668 with an optional mask. Valid for flow-types ip4, tcp4,
669 udp4, and sctp4 and their IPv6 equivalents.
670 spi N [m N]
672 Specify the value of the security parameter index field (ap‐
673 plicable to AH/ESP packets)in the incoming packet to match
674 along with an optional mask. Valid for flow-types ip4, ah4,
675 and esp4 and their IPv6 equivalents.
676 l4data N [m N]
678 Specify the value of the first 4 Bytes of Layer 4 in the in‐
679 coming packet to match along with an optional mask. Valid
680 for ip4 and ip6 flow-types.
681 vlan-etype N [m N]
683 Includes the VLAN tag Ethertype and an optional mask.
684 vlan N [m N]
686 Includes the VLAN tag and an optional mask.
687 user-def N [m N]
689 Includes 64-bits of user-specific data and an optional mask.
690 dst-mac xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]
692 Includes the destination MAC address, specified as 6 bytes
693 in hexadecimal separated by colons, along with an optional
694 mask. Valid for all IP based flow-types.
695 action N
697 Specifies the Rx queue to send packets to, or some other ac‐
698 tion.
699 -1 Drop the matched flow
701 -2 Use the matched flow as a Wake-on-LAN filter
702 0 or higher Rx queue to route the flow
703 context N
705 Specifies the RSS context to spread packets over multiple
706 queues; either 0 for the default RSS context, or a value re‐
707 turned by ethtool -X ... context new.
708 vf N Specifies the Virtual Function the filter applies to. Not
710 compatible with action.
711 queue N
713 Specifies the Rx queue to send packets to. Not compatible
714 with action.
715 loc N Specify the location/ID to insert the rule. This will over‐
717 write any rule present in that location and will not go
718 through any of the rule ordering process.
719 delete N
721 Deletes the RX classification rule with the given ID.
722 -w --get-dump
724 Retrieves and prints firmware dump for the specified network de‐
725 vice. By default, it prints out the dump flag, version and
726 length of the dump data. When data is indicated, then ethtool
727 fetches the dump data and directs it to a file.
728 -W --set-dump
730 Sets the dump flag for the device.
731 -T --show-time-stamping
733 Show the device's time stamping capabilities and associated PTP
734 hardware clock.
735 -x --show-rxfh-indir --show-rxfh
737 Retrieves the receive flow hash indirection table and/or RSS
738 hash key.
739 -X --set-rxfh-indir --rxfh
741 Configures the receive flow hash indirection table and/or RSS
742 hash key.
743 hkey Sets RSS hash key of the specified network device. RSS hash
745 key should be of device supported length. Hash key format
746 must be in xx:yy:zz:aa:bb:cc format meaning both the nibbles
747 of a byte should be mentioned even if a nibble is zero.
748 hfunc Sets RSS hash function of the specified network device.
750 List of RSS hash functions which kernel supports is shown as
751 a part of the --show-rxfh command output.
752 start N
754 For the equal and weight options, sets the starting receive
755 queue for spreading flows to N.
756 equal N
758 Sets the receive flow hash indirection table to spread flows
759 evenly between the first N receive queues.
760 weight W0 W1 ...
762 Sets the receive flow hash indirection table to spread flows
763 between receive queues according to the given weights. The
764 sum of the weights must be non-zero and must not exceed the
765 size of the indirection table.
766 default
768 Sets the receive flow hash indirection table to its default
769 value.
770 context CTX | new
772 Specifies an RSS context to act on; either new to allocate a
773 new RSS context, or CTX, a value returned by a previous
774 ... context new.
775 delete Delete the specified RSS context. May only be used in con‐
777 junction with context and a non-zero CTX value.
778 -f --flash
780 Write a firmware image to flash or other non-volatile memory on
781 the device.
782 file Specifies the filename of the firmware image. The firmware
784 must first be installed in one of the directories where the
785 kernel firmware loader or firmware agent will look, such as
786 /lib/firmware.
787 N If the device stores multiple firmware images in separate
789 regions of non-volatile memory, this parameter may be used
790 to specify which region is to be written. The default is 0,
791 requesting that all regions are written. All other values
792 are driver-dependent.
793 -l --show-channels
795 Queries the specified network device for the numbers of channels
796 it has. A channel is an IRQ and the set of queues that can
797 trigger that IRQ.
798 -L --set-channels
800 Changes the numbers of channels of the specified network device.
801 rx N Changes the number of channels with only receive queues.
803 tx N Changes the number of channels with only transmit queues.
805 other N
807 Changes the number of channels used only for other purposes
808 e.g. link interrupts or SR-IOV co-ordination.
809 combined N
811 Changes the number of multi-purpose channels.
812 -m --dump-module-eeprom --module-info
814 Retrieves and if possible decodes the EEPROM from plugin mod‐
815 ules, e.g SFP+, QSFP. If the driver and module support it, the
816 optical diagnostic information is also read and decoded. When
817 either one of page, bank or i2c parameters is specified, dumps
818 only of a single page or its portion is allowed. In such a case
819 offset and length parameters are treated relatively to EEPROM
820 page boundaries.
821 --show-priv-flags
823 Queries the specified network device for its private flags. The
824 names and meanings of private flags (if any) are defined by each
825 network device driver.
826 --set-priv-flags
828 Sets the device's private flags as specified.
829 flag on|off Sets the state of the named private flag.
831 --show-eee
833 Queries the specified network device for its support of Energy-
834 Efficient Ethernet (according to the IEEE 802.3az specifica‐
835 tions)
836 --set-eee
838 Sets the device EEE behaviour.
839 eee on|off
841 Enables/disables the device support of EEE.
842 tx-lpi on|off
844 Determines whether the device should assert its Tx LPI.
845 advertise N
847 Sets the speeds for which the device should advertise EEE
848 capabilities. Values are as for --change advertise
849 tx-timer N
851 Sets the amount of time the device should stay in idle mode
852 prior to asserting its Tx LPI (in microseconds). This has
853 meaning only when Tx LPI is enabled.
854 --set-phy-tunable
856 Sets the PHY tunable parameters.
857 downshift on|off
859 Specifies whether downshift should be enabled.
860 count N
862 Sets the PHY downshift re-tries count.
863 fast-link-down on|off
865 Specifies whether Fast Link Down should be enabled and time
866 until link down (if supported).
867 msecs N
869 Sets the period after which the link is reported as down. Note that the PHY may choose
870 the closest supported value. Only on reading back the tunable do you get the actual value.
871 energy-detect-power-down on|off
873 Specifies whether Energy Detect Power Down (EDPD) should be
874 enabled (if supported). This will put the RX and TX circuit
875 blocks into a low power mode, and the PHY will wake up peri‐
876 odically to send link pulses to avoid any lock-up situation
877 with a peer PHY that may also have EDPD enabled. By default,
878 this setting will also enable the periodic transmission of
879 TX pulses.
880 msecs N
882 Some PHYs support configuration of the wake-up interval to send TX pulses.
883 This setting allows the control of this interval, and 0 disables TX pulses
884 if the PHY supports this. Disabling TX pulses can create a lock-up situation
885 where neither of the PHYs wakes the other one. If unspecified the default
886 value (in milliseconds) will be used by the PHY.
887 --get-phy-tunable
890 Gets the PHY tunable parameters.
891 downshift
893 For operation in cabling environments that are incompatible
894 with 1000BASE-T, PHY device provides an automatic link speed
895 downshift operation. Link speed downshift after N failed
896 1000BASE-T auto-negotiation attempts. Downshift is useful
897 where cable does not have the 4 pairs instance.
898 Gets the PHY downshift count/status.
900 fast-link-down
902 Depending on the mode it may take 0.5s - 1s until a broken
903 link is reported as down. In certain use cases a link-down
904 event needs to be reported as soon as possible. Some PHYs
905 support a Fast Link Down Feature and may allow configuration
906 of the delay before a broken link is reported as being down.
907 Gets the PHY Fast Link Down status / period.
909 energy-detect-power-down
911 Gets the current configured setting for Energy Detect Power
912 Down (if supported).
913 --get-tunable
916 Get the tunable parameters.
917 rx-copybreak
919 Get the current rx copybreak value in bytes.
920 tx-copybreak
922 Get the current tx copybreak value in bytes.
923 tx-buf-size
925 Get the current tx copybreak buffer size in bytes.
926 pfc-prevention-tout
928 Get the current pfc prevention timeout value in msecs.
929 --set-tunable
931 Set driver's tunable parameters.
932 rx-copybreak N
934 Set the rx copybreak value in bytes.
935 tx-copybreak N
937 Set the tx copybreak value in bytes.
938 tx-buf-size N
940 Set the tx copybreak buffer size in bytes.
941 pfc-prevention-tout N
943 Set pfc prevention timeout in msecs. Value of 0 means dis‐
944 able and 65535 means auto.
945 --reset
947 Reset hardware components specified by flags and components
948 listed below
949 flags N
951 Resets the components based on direct flags mask
952 mgmt Management processor
954 irq Interrupt requester
956 dma DMA engine
958 filter Filtering/flow direction
960 offload
962 Protocol offload
963 mac Media access controller
965 phy Transceiver/PHY
967 ram RAM shared between multiple components ap Application Pro‐
969 cessor
970 dedicated
972 All components dedicated to this interface
973 all All components used by this interface, even if shared
975 --show-fec
977 Queries the specified network device for its support of Forward
978 Error Correction.
979 --set-fec
981 Configures Forward Error Correction for the specified network
982 device.
983 Forward Error Correction modes selected by a user are expected
985 to be persisted after any hotplug events. If a module is swapped
986 that does not support the current FEC mode, the driver or
987 firmware must take the link down administratively and report the
988 problem in the system logs for users to correct.
989 encoding auto|off|rs|baser|llrs [...]
991 Sets the FEC encoding for the device. Combinations of op‐
993 tions are specified as e.g. encoding auto rs ; the seman‐
994 tics of such combinations vary between drivers.
995 auto Use the driver's default encoding
997 off Turn off FEC
998 RS Force RS-FEC encoding
999 BaseR Force BaseR encoding
1000 LLRS Force LLRS-FEC encoding
1001 -Q|--per-queue
1003 Applies provided sub command to specific queues.
1004 queue_mask %x
1006 Sets the specific queues which the sub command is applied
1007 to. If queue_mask is not set, the sub command will be ap‐
1008 plied to all queues.
1009 sub_command
1011 Sub command to apply. The supported sub commands include
1012 --show-coalesce and --coalesce.
1013 --cable-test
1015 Perform a cable test and report the results. What results are
1016 returned depends on the capabilities of the network interface.
1017 Typically open pairs and shorted pairs can be reported, along
1018 with pairs being O.K. When a fault is detected the approximate
1019 distance to the fault may be reported.
1020 --cable-test-tdr
1022 Perform a cable test and report the raw Time Domain Reflectome‐
1023 ter data. A pulse is sent down a cable pair and the amplitude
1024 of the reflection, for a given distance, is reported. A break in
1025 the cable returns a big reflection. Minor damage to the cable
1026 returns a small reflection. If the cable is shorted, the ampli‐
1027 tude of the reflection can be negative. By default, data is re‐
1028 turned for lengths between 0 and 150m at 1m steps, for all
1029 pairs. However parameters can be passed to restrict the collec‐
1030 tion of data. It should be noted, that the interface will round
1031 the distances to whatever granularity is actually implemented.
1032 This is often 0.8 of a meter. The results should include the ac‐
1033 tual rounded first and last distance and step size.
1034 first N
1036 Distance along the cable, in meters, where the first mea‐
1037 surement should be made.
1038 last N
1040 Distance along the cable, in meters, where the last measure‐
1041 ment should be made.
1042 step N
1044 Distance, in meters, between each measurement.
1045 pair N
1047 Which pair should be measured. Typically a cable has 4
1048 pairs. 0 = Pair A, 1 = Pair B, ...
1049 --monitor
1051 Listens to netlink notification and displays them.
1052 command
1054 If argument matching a command is used, ethtool only shows
1055 notifications of this type. Without such argument or with
1056 --all, all notification types are shown.
1057 devname
1059 If a device name is used as argument, only notification for
1060 this device are shown. Default is to show notifications for
1061 all devices.
1062 --show-tunnels
1064 Show tunnel-related device capabilities and state. List UDP
1065 ports kernel has programmed the device to parse as VxLAN, or
1066 GENEVE tunnels.
1067 --show-module
1069 Show the transceiver module's parameters.
1070 --set-module
1072 Set the transceiver module's parameters.
1073 power-mode-policy high|auto
1075 Set the power mode policy for the module. When set to high,
1076 the module always operates at high power mode. When set to
1077 auto, the module is transitioned by the host to high power
1078 mode when the first port using it is put administratively up
1079 and to low power mode when the last port using it is put ad‐
1080 ministratively down. The power mode policy can be set before
1081 a module is plugged-in.
1082
1084 Not supported (in part or whole) on all network drivers.
1085
1087 ethtool was written by David Miller.
1088 Modifications by Jeff Garzik, Tim Hockin, Jakub Jelinek, Andre Majorel,
1090 Eli Kupermann, Scott Feldman, Andi Kleen, Alexander Duyck, Sucheta
1091 Chakraborty, Jesse Brandeburg, Ben Hutchings, Scott Branden.
1092
1094 ethtool is available from
1095 ⟨http://www.kernel.org/pub/software/network/ethtool/⟩
1096Ethtool version 5.18 June 2022 ETHTOOL(8)