1ETHTOOL(8)                  System Manager's Manual                 ETHTOOL(8)
2
3
4

NAME

6       ethtool - query or control network driver and hardware settings
7

SYNOPSIS

9       ethtool devname
10
11       ethtool -h|--help
12
13       ethtool --version
14
15       ethtool -a|--show-pause devname
16
17       ethtool -A|--pause devname [autoneg on|off] [rx on|off] [tx on|off]
18
19       ethtool -c|--show-coalesce devname
20
21       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
29       ethtool -g|--show-ring devname
30
31       ethtool -G|--set-ring devname [rx N] [rx-mini N] [rx-jumbo N] [tx N]
32
33       ethtool -i|--driver devname
34
35       ethtool -d|--register-dump devname [raw on|off] [hex on|off] [file
36              name]
37
38       ethtool -e|--eeprom-dump devname [raw on|off] [offset N] [length N]
39
40       ethtool -E|--change-eeprom devname [magic N] [offset N] [length N]
41              [value N]
42
43       ethtool -k|--show-features|--show-offload devname
44
45       ethtool -K|--features|--offload devname feature on|off ...
46
47       ethtool -p|--identify devname [N]
48
49       ethtool -P|--show-permaddr devname
50
51       ethtool -r|--negotiate devname
52
53       ethtool -S|--statistics devname
54
55       ethtool --phy-statistics devname
56
57       ethtool -t|--test devname [offline|online|external_lb]
58
59       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
64       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
68       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
84       ethtool -w|--get-dump devname [data filename]
85
86       ethtool -W|--set-dump devname N
87
88       ethtool -T|--show-time-stamping devname
89
90       ethtool -x|--show-rxfh-indir|--show-rxfh devname
91
92       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
96       ethtool -f|--flash devname file [N]
97
98       ethtool -l|--show-channels devname
99
100       ethtool -L|--set-channels devname [rx N] [tx N] [other N] [combined N]
101
102       ethtool -m|--dump-module-eeprom|--module-info devname [raw on|off]
103              [hex on|off] [offset N] [length N]
104
105       ethtool --show-priv-flags devname
106
107       ethtool --set-priv-flags devname flag on|off ...
108
109       ethtool --show-eee devname
110
111       ethtool --set-eee devname [eee on|off] [tx-lpi on|off] [tx-timer N]
112              [advertise N]
113
114       ethtool --set-phy-tunable devname [ downshift on|off [count N] ] [
115              fast-link-down on|off [msecs N] ]
116
117       ethtool --get-phy-tunable devname [downshift] [fast-link-down]
118
119       ethtool --reset devname [flags N] [mgmt] [mgmt-shared] [irq] [irq-
120              shared] [dma] [dma-shared] [filter] [filter-shared] [offload]
121              [offload-shared] [mac] [mac-shared] [phy] [phy-shared] [ram]
122              [ram-shared] [ap] [ap-shared] [dedicated] [all]
123
124       ethtool --show-fec devname
125
126       ethtool --set-fec devname encoding auto|off|rs|baser [...]
127
128       ethtool -Q|--per-queue devname [queue_mask %x] sub_command ...
129               .
130
131

DESCRIPTION

133       ethtool is used to query and control network device driver and hardware
134       settings, particularly for wired Ethernet devices.
135
136       devname is the name of the network device on which ethtool should oper‐
137       ate.
138
139

OPTIONS

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

BUGS

854       Not supported (in part or whole) on all network drivers.
855

AUTHOR

857       ethtool was written by David Miller.
858
859       Modifications by Jeff Garzik, Tim Hockin, Jakub Jelinek, Andre Majorel,
860       Eli  Kupermann,  Scott  Feldman,  Andi  Kleen, Alexander Duyck, Sucheta
861       Chakraborty, Jesse Brandeburg, Ben Hutchings, Scott Branden.
862

AVAILABILITY

864       ethtool                is                available                 from
865http://www.kernel.org/pub/software/network/ethtool/
866
867
868
869Ethtool version 5.3             September 2019                      ETHTOOL(8)
Impressum