{ "mode": "man", "parameter": "ethtool", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/ethtool/8/json", "generated": "2026-06-13T20:00:35Z", "synopsis": "ethtool devname", "sections": { "NAME": { "content": "ethtool - query or control network driver and hardware settings\n", "subsections": [] }, "SYNOPSIS": { "content": "ethtool devname\n", "subsections": [ { "name": "ethtool -h|--help", "content": "" }, { "name": "ethtool --version", "content": "ethtool [--debug N] args\n\nethtool [--json] args\n\nethtool [-I | --include-statistics] args\n\nethtool --monitor [ command ] [ devname ]\n\nethtool -a|--show-pause devname\n\nethtool -A|--pause devname [autoneg on|off] [rx on|off] [tx on|off]\n\nethtool -c|--show-coalesce devname\n\nethtool -C|--coalesce devname [adaptive-rx on|off] [adaptive-tx on|off] [rx-usecs N]\n[rx-frames N] [rx-usecs-irq N] [rx-frames-irq N] [tx-usecs N] [tx-frames N]\n[tx-usecs-irq N] [tx-frames-irq N] [stats-block-usecs N] [pkt-rate-low N]\n[rx-usecs-low N] [rx-frames-low N] [tx-usecs-low N] [tx-frames-low N]\n[pkt-rate-high N] [rx-usecs-high N] [rx-frames-high N] [tx-usecs-high N]\n[tx-frames-high N] [sample-interval N] [cqe-mode-rx on|off] [cqe-mode-tx on|off]\n\nethtool -g|--show-ring devname\n\nethtool -G|--set-ring devname [rx N] [rx-mini N] [rx-jumbo N] [tx N]\n\nethtool -i|--driver devname\n\nethtool -d|--register-dump devname [raw on|off] [hex on|off] [file name]\n\nethtool -e|--eeprom-dump devname [raw on|off] [offset N] [length N]\n\nethtool -E|--change-eeprom devname [magic N] [offset N] [length N] [value N]\n\nethtool -k|--show-features|--show-offload devname\n\nethtool -K|--features|--offload devname feature on|off ...\n\nethtool -p|--identify devname [N]\n\nethtool -P|--show-permaddr devname\n\nethtool -r|--negotiate devname\n\nethtool -S|--statistics devname [--all-groups|--groups [eth-phy] [eth-mac] [eth-ctrl] ]\n\nethtool --phy-statistics devname\n\nethtool -t|--test devname [offline|online|externallb]\n\nethtool -s devname [speed N] [lanes N] [duplex half|full] [port tp|aui|bnc|mii]\n[mdix auto|on|off] [autoneg on|off] [advertise N[/M] | advertise mode on|off ...]\n[phyad N] [xcvr internal|external] [wol N[/M] | wol p|u|m|b|a|g|s|f|d...]\n[sopass xx:yy:zz:aa:bb:cc] [master-slave preferred-master|preferred-slave|forced-\nmaster|forced-slave] [msglvl N[/M] | msglvl type on|off ...]\n\nethtool -n|-u|--show-nfc|--show-ntuple devname\n[ rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6 |\nrule N ]\n\nethtool -N|-U|--config-nfc|--config-ntuple devname\nrx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6 m|v|t|s|d|f|n|r... |\nflow-type ether|ip4|tcp4|udp4|sctp4|ah4|esp4|ip6|tcp6|udp6|ah6|esp6|sctp6\n[src xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]]\n[dst xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]] [proto N [m N]] [src-ip ip-\naddress [m ip-address]] [dst-ip ip-address [m ip-address]] [tos N [m N]]\n[tclass N [m N]] [l4proto N [m N]] [src-port N [m N]] [dst-port N [m N]] [spi N [m N]]\n[l4data N [m N]] [vlan-etype N [m N]] [vlan N [m N]] [user-def N [m N]] [dst-\nmac xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]] [action N] [context N] [loc N] |\ndelete N\n\nethtool -w|--get-dump devname [data filename]\n\nethtool -W|--set-dump devname N\n\nethtool -T|--show-time-stamping devname\n\nethtool -x|--show-rxfh-indir|--show-rxfh devname\n\nethtool -X|--set-rxfh-indir|--rxfh devname [hkey xx:yy:zz:aa:bb:cc:...] [start N] [ equal\nN | weight W0 W1 ... | default ] [hfunc FUNC] [context CTX | new] [delete]\n\nethtool -f|--flash devname file [N]\n\nethtool -l|--show-channels devname\n\nethtool -L|--set-channels devname [rx N] [tx N] [other N] [combined N]\n\nethtool -m|--dump-module-eeprom|--module-info devname [raw on|off] [hex on|off] [offset N]\n[length N] [page N] [bank N] [i2c N]\n\nethtool --show-priv-flags devname\n\nethtool --set-priv-flags devname flag on|off ...\n\nethtool --show-eee devname\n\nethtool --set-eee devname [eee on|off] [tx-lpi on|off] [tx-timer N] [advertise N]\n\nethtool --set-phy-tunable devname [ downshift on|off [count N] ] [ fast-link-down on|off\n[msecs N] ] [ energy-detect-power-down on|off [msecs N] ]\n\nethtool --get-phy-tunable devname [downshift] [fast-link-down] [energy-detect-power-down]\n\nethtool --get-tunable devname [rx-copybreak] [tx-copybreak] [pfc-prevention-tout]\n\nethtool --set-tunable devname [rx-copybreak N] [tx-copybreak N] [pfc-prevention-tout N]\n\nethtool --reset devname [flags N] [mgmt] [mgmt-shared] [irq] [irq-shared] [dma] [dma-shared]\n[filter] [filter-shared] [offload] [offload-shared] [mac] [mac-shared] [phy] [phy-\nshared] [ram] [ram-shared] [ap] [ap-shared] [dedicated] [all]\n\nethtool --show-fec devname\n\nethtool --set-fec devname encoding auto|off|rs|baser|llrs [...]\n\nethtool -Q|--per-queue devname [queuemask %x] subcommand ...\n.\n\nethtool --cable-test devname\n\nethtool --cable-test-tdr devname [first N] [last N] [step N] [pair N]\n\nethtool --show-tunnels devname\n\n" } ] }, "DESCRIPTION": { "content": "ethtool is used to query and control network device driver and hardware settings, particular‐\nly for wired Ethernet devices.\n\ndevname is the name of the network device on which ethtool should operate.\n\n", "subsections": [] }, "OPTIONS": { "content": "ethtool with a single argument specifying the device name prints current settings of the\nspecified device.\n", "subsections": [ { "name": "-h --help", "content": "Shows a short help message.\n", "flag": "-h", "long": "--help" }, { "name": "--version", "content": "Shows the ethtool version number.\n\n--debug N\nTurns on debugging messages. Argument is interpreted as a mask:\n\n0x01 Parser information\n\n--json Output results in JavaScript Object Notation (JSON). Only a subset of options support\nthis. Those which do not will continue to output plain text in the presence of this\noption.\n", "long": "--version" }, { "name": "-I --include-statistics", "content": "Include command-related statistics in the output. This option allows displaying rele‐\nvant device statistics for selected get commands.\n", "flag": "-I", "long": "--include-statistics" }, { "name": "-a --show-pause", "content": "Queries the specified Ethernet device for pause parameter information.\n", "flag": "-a", "long": "--show-pause" }, { "name": "-A --pause", "content": "Changes the pause parameters of the specified Ethernet device.\n\nautoneg on|off\nSpecifies whether pause autonegotiation should be enabled.\n\nrx on|off\nSpecifies whether RX pause should be enabled.\n\ntx on|off\nSpecifies whether TX pause should be enabled.\n", "flag": "-A", "long": "--pause" }, { "name": "-c --show-coalesce", "content": "Queries the specified network device for coalescing information.\n", "flag": "-c", "long": "--show-coalesce" }, { "name": "-C --coalesce", "content": "Changes the coalescing settings of the specified network device.\n", "flag": "-C", "long": "--coalesce" }, { "name": "-g --show-ring", "content": "Queries the specified network device for rx/tx ring parameter information.\n", "flag": "-g", "long": "--show-ring" }, { "name": "-G --set-ring", "content": "Changes the rx/tx ring parameters of the specified network device.\n\nrx N Changes the number of ring entries for the Rx ring.\n\nrx-mini N\nChanges the number of ring entries for the Rx Mini ring.\n\nrx-jumbo N\nChanges the number of ring entries for the Rx Jumbo ring.\n\ntx N Changes the number of ring entries for the Tx ring.\n", "flag": "-G", "long": "--set-ring" }, { "name": "-i --driver", "content": "Queries the specified network device for associated driver information.\n", "flag": "-i", "long": "--driver" }, { "name": "-d --register-dump", "content": "Retrieves and prints a register dump for the specified network device. The register\nformat for some devices is known and decoded others are printed in hex. When raw is\nenabled, then ethtool dumps the raw register data to stdout. If file is specified,\nthen use contents of previous raw register dump, rather than reading from the device.\n", "flag": "-d", "long": "--register-dump" }, { "name": "-e --eeprom-dump", "content": "Retrieves and prints an EEPROM dump for the specified network device. When raw is en‐\nabled, then it dumps the raw EEPROM data to stdout. The length and offset parameters\nallow dumping certain portions of the EEPROM. Default is to dump the entire EEPROM.\n\nraw on|off\n\noffset N\n\nlength N\n", "flag": "-e", "long": "--eeprom-dump" }, { "name": "-E --change-eeprom", "content": "If value is specified, changes EEPROM byte for the specified network device. offset\nand value specify which byte and it's new value. If value is not specified, stdin is\nread and written to the EEPROM. The length and offset parameters allow writing to cer‐\ntain portions of the EEPROM. Because of the persistent nature of writing to the EEP‐\nROM, a device-specific magic key must be specified to prevent the accidental writing\nto the EEPROM.\n", "flag": "-E", "long": "--change-eeprom" }, { "name": "-k --show-features --show-offload", "content": "Queries the specified network device for the state of protocol offload and other fea‐\ntures.\n", "flag": "-k", "long": "--show-offload" }, { "name": "-K --features --offload", "content": "Changes the offload parameters and other features of the specified network device.\nThe following feature names are built-in and others may be defined by the kernel.\n\nrx on|off\nSpecifies whether RX checksumming should be enabled.\n\ntx on|off\nSpecifies whether TX checksumming should be enabled.\n\nsg on|off\nSpecifies whether scatter-gather should be enabled.\n\ntso on|off\nSpecifies whether TCP segmentation offload should be enabled.\n\nufo on|off\nSpecifies whether UDP fragmentation offload should be enabled\n\ngso on|off\nSpecifies whether generic segmentation offload should be enabled\n\ngro on|off\nSpecifies whether generic receive offload should be enabled\n\nlro on|off\nSpecifies whether large receive offload should be enabled\n\nrxvlan on|off\nSpecifies whether RX VLAN acceleration should be enabled\n\ntxvlan on|off\nSpecifies whether TX VLAN acceleration should be enabled\n\nntuple on|off\nSpecifies whether Rx ntuple filters and actions should be enabled\n\nrxhash on|off\nSpecifies whether receive hashing offload should be enabled\n", "flag": "-K", "long": "--offload" }, { "name": "-p --identify", "content": "Initiates adapter-specific action intended to enable an operator to easily identify\nthe adapter by sight. Typically this involves blinking one or more LEDs on the spe‐\ncific network port.\n\n[ N] Length of time to perform phys-id, in seconds.\n", "flag": "-p", "long": "--identify" }, { "name": "-P --show-permaddr", "content": "Queries the specified network device for permanent hardware address.\n", "flag": "-P", "long": "--show-permaddr" }, { "name": "-r --negotiate", "content": "Restarts auto-negotiation on the specified Ethernet device, if auto-negotiation is en‐\nabled.\n", "flag": "-r", "long": "--negotiate" }, { "name": "-S --statistics", "content": "Queries the specified network device for standard (IEEE, IETF, etc.), or NIC- and\ndriver-specific statistics. NIC- and driver-specific statistics are requested when no\ngroup of statistics is specified.\n\nNIC- and driver-specific statistics and standard statistics are independent, devices\nmay implement either, both or none. There is little commonality between naming of NIC-\nand driver-specific statistics across vendors.\n\n--all-groups\n\n--groups [eth-phy] [eth-mac] [eth-ctrl] [rmon]\nRequest groups of standard device statistics.\n", "flag": "-S", "long": "--statistics" }, { "name": "--phy-statistics", "content": "Queries the specified network device for PHY specific statistics.\n", "long": "--phy-statistics" }, { "name": "-t --test", "content": "Executes adapter selftest on the specified network device. Possible test modes are:\n\noffline\nPerform full set of tests, possibly interrupting normal operation during the\ntests,\n\nonline Perform limited set of tests, not interrupting normal operation,\n\nexternallb\nPerform full set of tests, as for offline, and additionally an external-loopback\ntest.\n", "flag": "-t", "long": "--test" }, { "name": "-s --change", "content": "Allows changing some or all settings of the specified network device. All following\noptions only apply if -s was specified.\n\nspeed N\nSet speed in Mb/s. ethtool with just the device name as an argument will show you\nthe supported device speeds.\n\nlanes N\nSet number of lanes.\n\nduplex half|full\nSets full or half duplex mode.\n\nport tp|aui|bnc|mii\nSelects device port.\n\nmaster-slave preferred-master|preferred-slave|forced-master|forced-slave\nConfigure MASTER/SLAVE role of the PHY. When the PHY is configured as MASTER, the\nPMA Transmit function shall source TXTCLK from a local clock source. When config‐\nured as SLAVE, the PMA Transmit function shall source TXTCLK from the clock re‐\ncovered from data stream provided by MASTER. Not all devices support this.\n\npreferred-master Prefer MASTER role on autonegotiation\npreferred-slave Prefer SLAVE role on autonegotiation\nforced-master Force the PHY in MASTER role. Can be used without autonegotiation\nforced-slave Force the PHY in SLAVE role. Can be used without autonegotiation\n\nmdix auto|on|off\nSelects MDI-X mode for port. May be used to override the automatic detection fea‐\nture of most adapters. An argument of auto means automatic detection of MDI sta‐\ntus, on forces MDI-X (crossover) mode, while off means MDI (straight through)\nmode. The driver should guarantee that this command takes effect immediately, and\nif necessary may reset the link to cause the change to take effect.\n\nautoneg on|off\nSpecifies whether autonegotiation should be enabled. Autonegotiation is enabled by\ndefault, but in some network devices may have trouble with it, so you can disable\nit if really necessary.\n\nadvertise N\nSets the speed and duplex advertised by autonegotiation. The argument is a hexa‐\ndecimal value using one or a combination of the following values:\n\n0x001 10baseT Half\n0x002 10baseT Full\n0x004 100baseT Half\n0x008 100baseT Full\n0x80000000000000000 100baseT1 Full\n0x40000000000000000000000 100baseFX Half\n0x80000000000000000000000 100baseFX Full\n0x010 1000baseT Half (not supported by IEEE standards)\n0x020 1000baseT Full\n0x20000 1000baseKX Full\n0x20000000000 1000baseX Full\n0x100000000000000000 1000baseT1 Full\n0x8000 2500baseX Full (not supported by IEEE standards)\n0x800000000000 2500baseT Full\n0x1000000000000 5000baseT Full\n0x1000 10000baseT Full\n0x40000 10000baseKX4 Full\n0x80000 10000baseKR Full\n0x100000 10000baseRFEC\n0x40000000000 10000baseCR Full\n0x80000000000 10000baseSR Full\n0x100000000000 10000baseLR Full\n0x200000000000 10000baseLRM Full\n0x400000000000 10000baseER Full\n0x200000 20000baseMLD2 Full (not supported by IEEE standards)\n0x400000 20000baseKR2 Full (not supported by IEEE standards)\n0x80000000 25000baseCR Full\n0x100000000 25000baseKR Full\n0x200000000 25000baseSR Full\n0x800000 40000baseKR4 Full\n0x1000000 40000baseCR4 Full\n0x2000000 40000baseSR4 Full\n0x4000000 40000baseLR4 Full\n0x400000000 50000baseCR2 Full\n0x800000000 50000baseKR2 Full\n0x10000000000 50000baseSR2 Full\n0x10000000000000 50000baseKR Full\n0x20000000000000 50000baseSR Full\n0x40000000000000 50000baseCR Full\n0x80000000000000 50000baseLRERFR Full\n0x100000000000000 50000baseDR Full\n0x8000000 56000baseKR4 Full\n0x10000000 56000baseCR4 Full\n0x20000000 56000baseSR4 Full\n0x40000000 56000baseLR4 Full\n0x1000000000 100000baseKR4 Full\n0x2000000000 100000baseSR4 Full\n0x4000000000 100000baseCR4 Full\n0x8000000000 100000baseLR4ER4 Full\n0x200000000000000 100000baseKR2 Full\n0x400000000000000 100000baseSR2 Full\n0x800000000000000 100000baseCR2 Full\n0x1000000000000000 100000baseLR2ER2FR2 Full\n0x2000000000000000 100000baseDR2 Full\n0x8000000000000000000 100000baseKR Full\n0x10000000000000000000 100000baseSR Full\n0x20000000000000000000 100000baseLRERFR Full\n0x40000000000000000000 100000baseCR Full\n0x80000000000000000000 100000baseDR Full\n0x4000000000000000 200000baseKR4 Full\n0x8000000000000000 200000baseSR4 Full\n0x10000000000000000 200000baseLR4ER4FR4 Full\n0x20000000000000000 200000baseDR4 Full\n0x40000000000000000 200000baseCR4 Full\n0x100000000000000000000 200000baseKR2 Full\n0x200000000000000000000 200000baseSR2 Full\n0x400000000000000000000 200000baseLR2ER2FR2 Full\n0x800000000000000000000 200000baseDR2 Full\n0x1000000000000000000000 200000baseCR2 Full\n0x200000000000000000 400000baseKR8 Full\n0x400000000000000000 400000baseSR8 Full\n0x800000000000000000 400000baseLR8ER8FR8 Full\n0x1000000000000000000 400000baseDR8 Full\n0x2000000000000000000 400000baseCR8 Full\n0x2000000000000000000000 400000baseKR4 Full\n0x4000000000000000000000 400000baseSR4 Full\n0x8000000000000000000000 400000baseLR4ER4FR4 Full\n0x10000000000000000000000 400000baseDR4 Full\n0x20000000000000000000000 400000baseCR4 Full\n\nphyad N\nPHY address.\n\nxcvr internal|external\nSelects transceiver type. Currently only internal and external can be specified,\nin the future further types might be added.\n\nwol p|u|m|b|a|g|s|f|d...\nSets Wake-on-LAN options. Not all devices support this. The argument to this op‐\ntion is a string of characters specifying which options to enable.\n\np Wake on PHY activity\nu Wake on unicast messages\nm Wake on multicast messages\nb Wake on broadcast messages\na Wake on ARP\ng Wake on MagicPacket™\ns Enable SecureOn™ password for MagicPacket™\nf Wake on filter(s)\nd Disable (wake on nothing). This option\nclears all previous options.\n\nsopass xx:yy:zz:aa:bb:cc\nSets the SecureOn™ password. The argument to this option must be 6 bytes in Eth‐\nernet MAC hex format (xx:yy:zz:aa:bb:cc).\n\nmsglvl N\nmsglvl type on|off ...\nSets the driver message type flags by name or number. type names the type of mes‐\nsage to enable or disable; N specifies the new flags numerically. The defined type\nnames and numbers are:\n\ndrv 0x0001 General driver status\nprobe 0x0002 Hardware probing\nlink 0x0004 Link state\ntimer 0x0008 Periodic status check\nifdown 0x0010 Interface being brought down\nifup 0x0020 Interface being brought up\nrxerr 0x0040 Receive error\ntxerr 0x0080 Transmit error\ntxqueued 0x0100 Transmit queueing\nintr 0x0200 Interrupt handling\ntxdone 0x0400 Transmit completion\nrxstatus 0x0800 Receive completion\npktdata 0x1000 Packet contents\nhw 0x2000 Hardware status\nwol 0x4000 Wake-on-LAN status\n\nThe precise meanings of these type flags differ between drivers.\n", "flag": "-s", "long": "--change" }, { "name": "-n -u --show-nfc --show-ntuple", "content": "Retrieves receive network flow classification options or rules.\n\nrx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6\nRetrieves the hash options for the specified flow type.\n\ntcp4 TCP over IPv4\nudp4 UDP over IPv4\nah4 IPSEC AH over IPv4\nesp4 IPSEC ESP over IPv4\nsctp4 SCTP over IPv4\ntcp6 TCP over IPv6\nudp6 UDP over IPv6\nah6 IPSEC AH over IPv6\nesp6 IPSEC ESP over IPv6\nsctp6 SCTP over IPv6\n\nrule N Retrieves the RX classification rule with the given ID.\n", "flag": "-u", "long": "--show-ntuple" }, { "name": "-N -U --config-nfc --config-ntuple", "content": "Configures receive network flow classification options or rules.\n\nrx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6m|v|t|s|d|f|n|r...\nConfigures the hash options for the specified flow type.\n\nm Hash on the Layer 2 destination address of the rx packet.\nv Hash on the VLAN tag of the rx packet.\nt Hash on the Layer 3 protocol field of the rx packet.\ns Hash on the IP source address of the rx packet.\nd Hash on the IP destination address of the rx packet.\nf Hash on bytes 0 and 1 of the Layer 4 header of the rx packet.\nn Hash on bytes 2 and 3 of the Layer 4 header of the rx packet.\nr Discard all packets of this flow type. When this option is\nset, all other options are ignored.\n\nflow-type ether|ip4|tcp4|udp4|sctp4|ah4|esp4|ip6|tcp6|udp6|ah6|esp6|sctp6\nInserts or updates a classification rule for the specified flow type.\n\nether Ethernet\nip4 Raw IPv4\ntcp4 TCP over IPv4\nudp4 UDP over IPv4\nsctp4 SCTP over IPv4\nah4 IPSEC AH over IPv4\nesp4 IPSEC ESP over IPv4\nip6 Raw IPv6\ntcp6 TCP over IPv6\nudp6 UDP over IPv6\nsctp6 SCTP over IPv6\nah6 IPSEC AH over IPv6\nesp6 IPSEC ESP over IPv6\n\nFor all fields that allow both a value and a mask to be specified, the mask may be speci‐\nfied immediately after the value using the m keyword, or separately using the field name\nkeyword with -mask appended, e.g. src-mask.\n\nsrc xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]\nIncludes the source MAC address, specified as 6 bytes in hexadecimal separated by\ncolons, along with an optional mask. Valid only for flow-type ether.\n\ndst xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]\nIncludes the destination MAC address, specified as 6 bytes in hexadecimal separat‐\ned by colons, along with an optional mask. Valid only for flow-type ether.\n\nproto N [m N]\nIncludes the Ethernet protocol number (ethertype) and an optional mask. Valid on‐\nly for flow-type ether.\n\nsrc-ip ip-address [m ip-address]\nSpecify the source IP address of the incoming packet to match along with an op‐\ntional mask. Valid for all IP based flow-types.\n\ndst-ip ip-address [m ip-address]\nSpecify the destination IP address of the incoming packet to match along with an\noptional mask. Valid for all IP based flow-types.\n\ntos N [m N]\nSpecify the value of the Type of Service field in the incoming packet to match\nalong with an optional mask. Applies to all IPv4 based flow-types.\n\ntclass N [m N]\nSpecify the value of the Traffic Class field in the incoming packet to match along\nwith an optional mask. Applies to all IPv6 based flow-types.\n\nl4proto N [m N]\nIncludes the layer 4 protocol number and optional mask. Valid only for flow-types\nip4 and ip6.\n\nsrc-port N [m N]\nSpecify the value of the source port field (applicable to TCP/UDP packets) in the\nincoming packet to match along with an optional mask. Valid for flow-types ip4,\ntcp4, udp4, and sctp4 and their IPv6 equivalents.\n\ndst-port N [m N]\nSpecify the value of the destination port field (applicable to TCP/UDP packets)in\nthe incoming packet to match along with an optional mask. Valid for flow-types\nip4, tcp4, udp4, and sctp4 and their IPv6 equivalents.\n\nspi N [m N]\nSpecify the value of the security parameter index field (applicable to AH/ESP\npackets)in the incoming packet to match along with an optional mask. Valid for\nflow-types ip4, ah4, and esp4 and their IPv6 equivalents.\n\nl4data N [m N]\nSpecify the value of the first 4 Bytes of Layer 4 in the incoming packet to match\nalong with an optional mask. Valid for ip4 and ip6 flow-types.\n\nvlan-etype N [m N]\nIncludes the VLAN tag Ethertype and an optional mask.\n\nvlan N [m N]\nIncludes the VLAN tag and an optional mask.\n\nuser-def N [m N]\nIncludes 64-bits of user-specific data and an optional mask.\n\ndst-mac xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc]\nIncludes the destination MAC address, specified as 6 bytes in hexadecimal separat‐\ned by colons, along with an optional mask. Valid for all IP based flow-types.\n\naction N\nSpecifies the Rx queue to send packets to, or some other action.\n\n-1 Drop the matched flow\n-2 Use the matched flow as a Wake-on-LAN filter\n0 or higher Rx queue to route the flow\n\ncontext N\nSpecifies the RSS context to spread packets over multiple queues; either 0 for the\ndefault RSS context, or a value returned by ethtool -X ... context new.\n\nvf N Specifies the Virtual Function the filter applies to. Not compatible with action.\n\nqueue N\nSpecifies the Rx queue to send packets to. Not compatible with action.\n\nloc N Specify the location/ID to insert the rule. This will overwrite any rule present\nin that location and will not go through any of the rule ordering process.\n\ndelete N\nDeletes the RX classification rule with the given ID.\n", "flag": "-U", "long": "--config-ntuple" }, { "name": "-w --get-dump", "content": "Retrieves and prints firmware dump for the specified network device. By default, it\nprints out the dump flag, version and length of the dump data. When data is indicat‐\ned, then ethtool fetches the dump data and directs it to a file.\n", "flag": "-w", "long": "--get-dump" }, { "name": "-W --set-dump", "content": "Sets the dump flag for the device.\n", "flag": "-W", "long": "--set-dump" }, { "name": "-T --show-time-stamping", "content": "Show the device's time stamping capabilities and associated PTP hardware clock.\n", "flag": "-T", "long": "--show-time-stamping" }, { "name": "-x --show-rxfh-indir --show-rxfh", "content": "Retrieves the receive flow hash indirection table and/or RSS hash key.\n", "flag": "-x", "long": "--show-rxfh" }, { "name": "-X --set-rxfh-indir --rxfh", "content": "Configures the receive flow hash indirection table and/or RSS hash key.\n\nhkey Sets RSS hash key of the specified network device. RSS hash key should be of de‐\nvice supported length. Hash key format must be in xx:yy:zz:aa:bb:cc format mean‐\ning both the nibbles of a byte should be mentioned even if a nibble is zero.\n\nhfunc Sets RSS hash function of the specified network device. List of RSS hash func‐\ntions which kernel supports is shown as a part of the --show-rxfh command output.\n\nstart N\nFor the equal and weight options, sets the starting receive queue for spreading\nflows to N.\n\nequal N\nSets the receive flow hash indirection table to spread flows evenly between the\nfirst N receive queues.\n\nweight W0 W1 ...\nSets the receive flow hash indirection table to spread flows between receive\nqueues according to the given weights. The sum of the weights must be non-zero\nand must not exceed the size of the indirection table.\n\ndefault\nSets the receive flow hash indirection table to its default value.\n\ncontext CTX | new\nSpecifies an RSS context to act on; either new to allocate a new RSS context, or\nCTX, a value returned by a previous ... context new.\n\ndelete Delete the specified RSS context. May only be used in conjunction with context\nand a non-zero CTX value.\n", "flag": "-X", "long": "--rxfh" }, { "name": "-f --flash", "content": "Write a firmware image to flash or other non-volatile memory on the device.\n\nfile Specifies the filename of the firmware image. The firmware must first be in‐\nstalled in one of the directories where the kernel firmware loader or firmware\nagent will look, such as /lib/firmware.\n\nN If the device stores multiple firmware images in separate regions of non-volatile\nmemory, this parameter may be used to specify which region is to be written. The\ndefault is 0, requesting that all regions are written. All other values are driv‐\ner-dependent.\n", "flag": "-f", "long": "--flash" }, { "name": "-l --show-channels", "content": "Queries the specified network device for the numbers of channels it has. A channel is\nan IRQ and the set of queues that can trigger that IRQ.\n", "flag": "-l", "long": "--show-channels" }, { "name": "-L --set-channels", "content": "Changes the numbers of channels of the specified network device.\n\nrx N Changes the number of channels with only receive queues.\n\ntx N Changes the number of channels with only transmit queues.\n\nother N\nChanges the number of channels used only for other purposes e.g. link interrupts\nor SR-IOV co-ordination.\n\ncombined N\nChanges the number of multi-purpose channels.\n", "flag": "-L", "long": "--set-channels" }, { "name": "-m --dump-module-eeprom --module-info", "content": "Retrieves and if possible decodes the EEPROM from plugin modules, e.g SFP+, QSFP. If\nthe driver and module support it, the optical diagnostic information is also read and\ndecoded. When either one of page, bank or i2c parameters is specified, dumps only of\na single page or its portion is allowed. In such a case offset and length parameters\nare treated relatively to EEPROM page boundaries.\n", "flag": "-m", "long": "--module-info" }, { "name": "--show-priv-flags", "content": "Queries the specified network device for its private flags. The names and meanings of\nprivate flags (if any) are defined by each network device driver.\n", "long": "--show-priv-flags" }, { "name": "--set-priv-flags", "content": "Sets the device's private flags as specified.\n\nflag on|off Sets the state of the named private flag.\n", "long": "--set-priv-flags" }, { "name": "--show-eee", "content": "Queries the specified network device for its support of Energy-Efficient Ethernet (ac‐\ncording to the IEEE 802.3az specifications)\n", "long": "--show-eee" }, { "name": "--set-eee", "content": "Sets the device EEE behaviour.\n\neee on|off\nEnables/disables the device support of EEE.\n\ntx-lpi on|off\nDetermines whether the device should assert its Tx LPI.\n\nadvertise N\nSets the speeds for which the device should advertise EEE capabilities. Values\nare as for --change advertise\n\ntx-timer N\nSets the amount of time the device should stay in idle mode prior to asserting its\nTx LPI (in microseconds). This has meaning only when Tx LPI is enabled.\n", "long": "--set-eee" }, { "name": "--set-phy-tunable", "content": "Sets the PHY tunable parameters.\n\ndownshift on|off\nSpecifies whether downshift should be enabled.\n\ncount N\nSets the PHY downshift re-tries count.\n\nfast-link-down on|off\nSpecifies whether Fast Link Down should be enabled and time until link down (if\nsupported).\n\nmsecs N\nSets the period after which the link is reported as down. Note that the PHY may choose\nthe closest supported value. Only on reading back the tunable do you get the actual value.\n\nenergy-detect-power-down on|off\nSpecifies whether Energy Detect Power Down (EDPD) should be enabled (if support‐\ned). This will put the RX and TX circuit blocks into a low power mode, and the\nPHY will wake up periodically to send link pulses to avoid any lock-up situation\nwith a peer PHY that may also have EDPD enabled. By default, this setting will al‐\nso enable the periodic transmission of TX pulses.\n\nmsecs N\nSome PHYs support configuration of the wake-up interval to send TX pulses.\nThis setting allows the control of this interval, and 0 disables TX pulses\nif the PHY supports this. Disabling TX pulses can create a lock-up situation\nwhere neither of the PHYs wakes the other one. If unspecified the default\nvalue (in milliseconds) will be used by the PHY.\n\n", "long": "--set-phy-tunable" }, { "name": "--get-phy-tunable", "content": "Gets the PHY tunable parameters.\n\ndownshift\nFor operation in cabling environments that are incompatible with 1000BASE-T, PHY\ndevice provides an automatic link speed downshift operation. Link speed downshift\nafter N failed 1000BASE-T auto-negotiation attempts. Downshift is useful where\ncable does not have the 4 pairs instance.\n\nGets the PHY downshift count/status.\n\nfast-link-down\nDepending on the mode it may take 0.5s - 1s until a broken link is reported as\ndown. In certain use cases a link-down event needs to be reported as soon as pos‐\nsible. Some PHYs support a Fast Link Down Feature and may allow configuration of\nthe delay before a broken link is reported as being down.\n\nGets the PHY Fast Link Down status / period.\n\nenergy-detect-power-down\nGets the current configured setting for Energy Detect Power Down (if supported).\n\n", "long": "--get-phy-tunable" }, { "name": "--get-tunable", "content": "Get the tunable parameters.\n\nrx-copybreak\nGet the current rx copybreak value in bytes.\n\ntx-copybreak\nGet the current tx copybreak value in bytes.\n\npfc-prevention-tout\nGet the current pfc prevention timeout value in msecs.\n", "long": "--get-tunable" }, { "name": "--set-tunable", "content": "Set driver's tunable parameters.\n\nrx-copybreak N\nSet the rx copybreak value in bytes.\n\ntx-copybreak N\nSet the tx copybreak value in bytes.\n\npfc-prevention-tout N\nSet pfc prevention timeout in msecs. Value of 0 means disable and 65535 means au‐\nto.\n", "long": "--set-tunable" }, { "name": "--reset", "content": "Reset hardware components specified by flags and components listed below\n\nflags N\nResets the components based on direct flags mask\n\nmgmt Management processor\n\nirq Interrupt requester\n\ndma DMA engine\n\nfilter Filtering/flow direction\n\noffload\nProtocol offload\n\nmac Media access controller\n\nphy Transceiver/PHY\n\nram RAM shared between multiple components ap Application Processor\n\ndedicated\nAll components dedicated to this interface\n\nall All components used by this interface, even if shared\n", "long": "--reset" }, { "name": "--show-fec", "content": "Queries the specified network device for its support of Forward Error Correction.\n", "long": "--show-fec" }, { "name": "--set-fec", "content": "Configures Forward Error Correction for the specified network device.\n\nForward Error Correction modes selected by a user are expected to be persisted after\nany hotplug events. If a module is swapped that does not support the current FEC mode,\nthe driver or firmware must take the link down administratively and report the problem\nin the system logs for users to correct.\n\nencoding auto|off|rs|baser|llrs [...]\n\nSets the FEC encoding for the device. Combinations of options are specified as\ne.g. encoding auto rs ; the semantics of such combinations vary between drivers.\n\nauto Use the driver's default encoding\noff Turn off FEC\nRS Force RS-FEC encoding\nBaseR Force BaseR encoding\nLLRS Force LLRS-FEC encoding\n", "long": "--set-fec" }, { "name": "-Q|--per-queue", "content": "Applies provided sub command to specific queues.\n\nqueuemask %x\nSets the specific queues which the sub command is applied to. If queuemask is\nnot set, the sub command will be applied to all queues.\n\nsubcommand\nSub command to apply. The supported sub commands include --show-coalesce and --co‐\nalesce.\n\nq.B --cable-test\nPerform a cable test and report the results. What results are returned depends on the\ncapabilities of the network interface. Typically open pairs and shorted pairs can be\nreported, along with pairs being O.K. When a fault is detected the approximate dis‐\ntance to the fault may be reported.\n" }, { "name": "--cable-test-tdr", "content": "Perform a cable test and report the raw Time Domain Reflectometer data. A pulse is\nsent down a cable pair and the amplitude of the reflection, for a given distance, is\nreported. A break in the cable returns a big reflection. Minor damage to the cable re‐\nturns a small reflection. If the cable is shorted, the amplitude of the reflection can\nbe negative. By default, data is returned for lengths between 0 and 150m at 1m steps,\nfor all pairs. However parameters can be passed to restrict the collection of data. It\nshould be noted, that the interface will round the distances to whatever granularity\nis actually implemented. This is often 0.8 of a meter. The results should include the\nactual rounded first and last distance and step size.\n\nfirst N\nDistance along the cable, in meters, where the first measurement should be made.\n\nlast N\nDistance along the cable, in meters, where the last measurement should be made.\n\nstep N\nDistance, in meters, between each measurement.\n\npair N\nWhich pair should be measured. Typically a cable has 4 pairs. 0 = Pair A, 1 = Pair\nB, ...\n", "long": "--cable-test-tdr" }, { "name": "--monitor", "content": "Listens to netlink notification and displays them.\n\ncommand\nIf argument matching a command is used, ethtool only shows notifications of this\ntype. Without such argument or with --all, all notification types are shown.\n\ndevname\nIf a device name is used as argument, only notification for this device are shown.\nDefault is to show notifications for all devices.\n", "long": "--monitor" }, { "name": "--show-tunnels", "content": "Show tunnel-related device capabilities and state. List UDP ports kernel has pro‐\ngrammed the device to parse as VxLAN, or GENEVE tunnels.\n", "long": "--show-tunnels" } ] }, "BUGS": { "content": "Not supported (in part or whole) on all network drivers.\n", "subsections": [] }, "AUTHOR": { "content": "ethtool was written by David Miller.\n\nModifications by Jeff Garzik, Tim Hockin, Jakub Jelinek, Andre Majorel, Eli Kupermann, Scott\nFeldman, Andi Kleen, Alexander Duyck, Sucheta Chakraborty, Jesse Brandeburg, Ben Hutchings,\nScott Branden.\n", "subsections": [] }, "AVAILABILITY": { "content": "ethtool is available from ⟨http://www.kernel.org/pub/software/network/ethtool/⟩\n\n\n\nEthtool version 5.16 January 2022 ETHTOOL(8)", "subsections": [] } }, "summary": "ethtool - query or control network driver and hardware settings", "flags": [ { "flag": "-h", "long": "--help", "arg": null, "description": "Shows a short help message." }, { "flag": "", "long": "--version", "arg": null, "description": "Shows the ethtool version number. --debug N Turns on debugging messages. Argument is interpreted as a mask: 0x01 Parser information --json Output results in JavaScript Object Notation (JSON). Only a subset of options support this. Those which do not will continue to output plain text in the presence of this option." }, { "flag": "-I", "long": "--include-statistics", "arg": null, "description": "Include command-related statistics in the output. This option allows displaying rele‐ vant device statistics for selected get commands." }, { "flag": "-a", "long": "--show-pause", "arg": null, "description": "Queries the specified Ethernet device for pause parameter information." }, { "flag": "-A", "long": "--pause", "arg": null, "description": "Changes the pause parameters of the specified Ethernet device. autoneg on|off Specifies whether pause autonegotiation should be enabled. rx on|off Specifies whether RX pause should be enabled. tx on|off Specifies whether TX pause should be enabled." }, { "flag": "-c", "long": "--show-coalesce", "arg": null, "description": "Queries the specified network device for coalescing information." }, { "flag": "-C", "long": "--coalesce", "arg": null, "description": "Changes the coalescing settings of the specified network device." }, { "flag": "-g", "long": "--show-ring", "arg": null, "description": "Queries the specified network device for rx/tx ring parameter information." }, { "flag": "-G", "long": "--set-ring", "arg": null, "description": "Changes the rx/tx ring parameters of the specified network device. rx N Changes the number of ring entries for the Rx ring. rx-mini N Changes the number of ring entries for the Rx Mini ring. rx-jumbo N Changes the number of ring entries for the Rx Jumbo ring. tx N Changes the number of ring entries for the Tx ring." }, { "flag": "-i", "long": "--driver", "arg": null, "description": "Queries the specified network device for associated driver information." }, { "flag": "-d", "long": "--register-dump", "arg": null, "description": "Retrieves and prints a register dump for the specified network device. The register format for some devices is known and decoded others are printed in hex. When raw is enabled, then ethtool dumps the raw register data to stdout. If file is specified, then use contents of previous raw register dump, rather than reading from the device." }, { "flag": "-e", "long": "--eeprom-dump", "arg": null, "description": "Retrieves and prints an EEPROM dump for the specified network device. When raw is en‐ abled, then it dumps the raw EEPROM data to stdout. The length and offset parameters allow dumping certain portions of the EEPROM. Default is to dump the entire EEPROM. raw on|off offset N length N" }, { "flag": "-E", "long": "--change-eeprom", "arg": null, "description": "If value is specified, changes EEPROM byte for the specified network device. offset and value specify which byte and it's new value. If value is not specified, stdin is read and written to the EEPROM. The length and offset parameters allow writing to cer‐ tain portions of the EEPROM. Because of the persistent nature of writing to the EEP‐ ROM, a device-specific magic key must be specified to prevent the accidental writing to the EEPROM." }, { "flag": "-k", "long": "--show-offload", "arg": null, "description": "Queries the specified network device for the state of protocol offload and other fea‐ tures." }, { "flag": "-K", "long": "--offload", "arg": null, "description": "Changes the offload parameters and other features of the specified network device. The following feature names are built-in and others may be defined by the kernel. rx on|off Specifies whether RX checksumming should be enabled. tx on|off Specifies whether TX checksumming should be enabled. sg on|off Specifies whether scatter-gather should be enabled. tso on|off Specifies whether TCP segmentation offload should be enabled. ufo on|off Specifies whether UDP fragmentation offload should be enabled gso on|off Specifies whether generic segmentation offload should be enabled gro on|off Specifies whether generic receive offload should be enabled lro on|off Specifies whether large receive offload should be enabled rxvlan on|off Specifies whether RX VLAN acceleration should be enabled txvlan on|off Specifies whether TX VLAN acceleration should be enabled ntuple on|off Specifies whether Rx ntuple filters and actions should be enabled rxhash on|off Specifies whether receive hashing offload should be enabled" }, { "flag": "-p", "long": "--identify", "arg": null, "description": "Initiates adapter-specific action intended to enable an operator to easily identify the adapter by sight. Typically this involves blinking one or more LEDs on the spe‐ cific network port. [ N] Length of time to perform phys-id, in seconds." }, { "flag": "-P", "long": "--show-permaddr", "arg": null, "description": "Queries the specified network device for permanent hardware address." }, { "flag": "-r", "long": "--negotiate", "arg": null, "description": "Restarts auto-negotiation on the specified Ethernet device, if auto-negotiation is en‐ abled." }, { "flag": "-S", "long": "--statistics", "arg": null, "description": "Queries the specified network device for standard (IEEE, IETF, etc.), or NIC- and driver-specific statistics. NIC- and driver-specific statistics are requested when no group of statistics is specified. NIC- and driver-specific statistics and standard statistics are independent, devices may implement either, both or none. There is little commonality between naming of NIC- and driver-specific statistics across vendors. --all-groups --groups [eth-phy] [eth-mac] [eth-ctrl] [rmon] Request groups of standard device statistics." }, { "flag": "", "long": "--phy-statistics", "arg": null, "description": "Queries the specified network device for PHY specific statistics." }, { "flag": "-t", "long": "--test", "arg": null, "description": "Executes adapter selftest on the specified network device. Possible test modes are: offline Perform full set of tests, possibly interrupting normal operation during the tests, online Perform limited set of tests, not interrupting normal operation, externallb Perform full set of tests, as for offline, and additionally an external-loopback test." }, { "flag": "-s", "long": "--change", "arg": null, "description": "Allows changing some or all settings of the specified network device. All following options only apply if -s was specified. speed N Set speed in Mb/s. ethtool with just the device name as an argument will show you the supported device speeds. lanes N Set number of lanes. duplex half|full Sets full or half duplex mode. port tp|aui|bnc|mii Selects device port. master-slave preferred-master|preferred-slave|forced-master|forced-slave Configure MASTER/SLAVE role of the PHY. When the PHY is configured as MASTER, the PMA Transmit function shall source TXTCLK from a local clock source. When config‐ ured as SLAVE, the PMA Transmit function shall source TXTCLK from the clock re‐ covered from data stream provided by MASTER. Not all devices support this. preferred-master Prefer MASTER role on autonegotiation preferred-slave Prefer SLAVE role on autonegotiation forced-master Force the PHY in MASTER role. Can be used without autonegotiation forced-slave Force the PHY in SLAVE role. Can be used without autonegotiation mdix auto|on|off Selects MDI-X mode for port. May be used to override the automatic detection fea‐ ture of most adapters. An argument of auto means automatic detection of MDI sta‐ tus, on forces MDI-X (crossover) mode, while off means MDI (straight through) mode. The driver should guarantee that this command takes effect immediately, and if necessary may reset the link to cause the change to take effect. autoneg on|off Specifies whether autonegotiation should be enabled. Autonegotiation is enabled by default, but in some network devices may have trouble with it, so you can disable it if really necessary. advertise N Sets the speed and duplex advertised by autonegotiation. The argument is a hexa‐ decimal value using one or a combination of the following values: 0x001 10baseT Half 0x002 10baseT Full 0x004 100baseT Half 0x008 100baseT Full 0x80000000000000000 100baseT1 Full 0x40000000000000000000000 100baseFX Half 0x80000000000000000000000 100baseFX Full 0x010 1000baseT Half (not supported by IEEE standards) 0x020 1000baseT Full 0x20000 1000baseKX Full 0x20000000000 1000baseX Full 0x100000000000000000 1000baseT1 Full 0x8000 2500baseX Full (not supported by IEEE standards) 0x800000000000 2500baseT Full 0x1000000000000 5000baseT Full 0x1000 10000baseT Full 0x40000 10000baseKX4 Full 0x80000 10000baseKR Full 0x100000 10000baseRFEC 0x40000000000 10000baseCR Full 0x80000000000 10000baseSR Full 0x100000000000 10000baseLR Full 0x200000000000 10000baseLRM Full 0x400000000000 10000baseER Full 0x200000 20000baseMLD2 Full (not supported by IEEE standards) 0x400000 20000baseKR2 Full (not supported by IEEE standards) 0x80000000 25000baseCR Full 0x100000000 25000baseKR Full 0x200000000 25000baseSR Full 0x800000 40000baseKR4 Full 0x1000000 40000baseCR4 Full 0x2000000 40000baseSR4 Full 0x4000000 40000baseLR4 Full 0x400000000 50000baseCR2 Full 0x800000000 50000baseKR2 Full 0x10000000000 50000baseSR2 Full 0x10000000000000 50000baseKR Full 0x20000000000000 50000baseSR Full 0x40000000000000 50000baseCR Full 0x80000000000000 50000baseLRERFR Full 0x100000000000000 50000baseDR Full 0x8000000 56000baseKR4 Full 0x10000000 56000baseCR4 Full 0x20000000 56000baseSR4 Full 0x40000000 56000baseLR4 Full 0x1000000000 100000baseKR4 Full 0x2000000000 100000baseSR4 Full 0x4000000000 100000baseCR4 Full 0x8000000000 100000baseLR4ER4 Full 0x200000000000000 100000baseKR2 Full 0x400000000000000 100000baseSR2 Full 0x800000000000000 100000baseCR2 Full 0x1000000000000000 100000baseLR2ER2FR2 Full 0x2000000000000000 100000baseDR2 Full 0x8000000000000000000 100000baseKR Full 0x10000000000000000000 100000baseSR Full 0x20000000000000000000 100000baseLRERFR Full 0x40000000000000000000 100000baseCR Full 0x80000000000000000000 100000baseDR Full 0x4000000000000000 200000baseKR4 Full 0x8000000000000000 200000baseSR4 Full 0x10000000000000000 200000baseLR4ER4FR4 Full 0x20000000000000000 200000baseDR4 Full 0x40000000000000000 200000baseCR4 Full 0x100000000000000000000 200000baseKR2 Full 0x200000000000000000000 200000baseSR2 Full 0x400000000000000000000 200000baseLR2ER2FR2 Full 0x800000000000000000000 200000baseDR2 Full 0x1000000000000000000000 200000baseCR2 Full 0x200000000000000000 400000baseKR8 Full 0x400000000000000000 400000baseSR8 Full 0x800000000000000000 400000baseLR8ER8FR8 Full 0x1000000000000000000 400000baseDR8 Full 0x2000000000000000000 400000baseCR8 Full 0x2000000000000000000000 400000baseKR4 Full 0x4000000000000000000000 400000baseSR4 Full 0x8000000000000000000000 400000baseLR4ER4FR4 Full 0x10000000000000000000000 400000baseDR4 Full 0x20000000000000000000000 400000baseCR4 Full phyad N PHY address. xcvr internal|external Selects transceiver type. Currently only internal and external can be specified, in the future further types might be added. wol p|u|m|b|a|g|s|f|d... Sets Wake-on-LAN options. Not all devices support this. The argument to this op‐ tion is a string of characters specifying which options to enable. p Wake on PHY activity u Wake on unicast messages m Wake on multicast messages b Wake on broadcast messages a Wake on ARP g Wake on MagicPacket™ s Enable SecureOn™ password for MagicPacket™ f Wake on filter(s) d Disable (wake on nothing). This option clears all previous options. sopass xx:yy:zz:aa:bb:cc Sets the SecureOn™ password. The argument to this option must be 6 bytes in Eth‐ ernet MAC hex format (xx:yy:zz:aa:bb:cc). msglvl N msglvl type on|off ... Sets the driver message type flags by name or number. type names the type of mes‐ sage to enable or disable; N specifies the new flags numerically. The defined type names and numbers are: drv 0x0001 General driver status probe 0x0002 Hardware probing link 0x0004 Link state timer 0x0008 Periodic status check ifdown 0x0010 Interface being brought down ifup 0x0020 Interface being brought up rxerr 0x0040 Receive error txerr 0x0080 Transmit error txqueued 0x0100 Transmit queueing intr 0x0200 Interrupt handling txdone 0x0400 Transmit completion rxstatus 0x0800 Receive completion pktdata 0x1000 Packet contents hw 0x2000 Hardware status wol 0x4000 Wake-on-LAN status The precise meanings of these type flags differ between drivers." }, { "flag": "-u", "long": "--show-ntuple", "arg": null, "description": "Retrieves receive network flow classification options or rules. rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6 Retrieves the hash options for the specified flow type. tcp4 TCP over IPv4 udp4 UDP over IPv4 ah4 IPSEC AH over IPv4 esp4 IPSEC ESP over IPv4 sctp4 SCTP over IPv4 tcp6 TCP over IPv6 udp6 UDP over IPv6 ah6 IPSEC AH over IPv6 esp6 IPSEC ESP over IPv6 sctp6 SCTP over IPv6 rule N Retrieves the RX classification rule with the given ID." }, { "flag": "-U", "long": "--config-ntuple", "arg": null, "description": "Configures receive network flow classification options or rules. rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6m|v|t|s|d|f|n|r... Configures the hash options for the specified flow type. m Hash on the Layer 2 destination address of the rx packet. v Hash on the VLAN tag of the rx packet. t Hash on the Layer 3 protocol field of the rx packet. s Hash on the IP source address of the rx packet. d Hash on the IP destination address of the rx packet. f Hash on bytes 0 and 1 of the Layer 4 header of the rx packet. n Hash on bytes 2 and 3 of the Layer 4 header of the rx packet. r Discard all packets of this flow type. When this option is set, all other options are ignored. flow-type ether|ip4|tcp4|udp4|sctp4|ah4|esp4|ip6|tcp6|udp6|ah6|esp6|sctp6 Inserts or updates a classification rule for the specified flow type. ether Ethernet ip4 Raw IPv4 tcp4 TCP over IPv4 udp4 UDP over IPv4 sctp4 SCTP over IPv4 ah4 IPSEC AH over IPv4 esp4 IPSEC ESP over IPv4 ip6 Raw IPv6 tcp6 TCP over IPv6 udp6 UDP over IPv6 sctp6 SCTP over IPv6 ah6 IPSEC AH over IPv6 esp6 IPSEC ESP over IPv6 For all fields that allow both a value and a mask to be specified, the mask may be speci‐ fied immediately after the value using the m keyword, or separately using the field name keyword with -mask appended, e.g. src-mask. src xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc] Includes the source MAC address, specified as 6 bytes in hexadecimal separated by colons, along with an optional mask. Valid only for flow-type ether. dst xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc] Includes the destination MAC address, specified as 6 bytes in hexadecimal separat‐ ed by colons, along with an optional mask. Valid only for flow-type ether. proto N [m N] Includes the Ethernet protocol number (ethertype) and an optional mask. Valid on‐ ly for flow-type ether. src-ip ip-address [m ip-address] Specify the source IP address of the incoming packet to match along with an op‐ tional mask. Valid for all IP based flow-types. dst-ip ip-address [m ip-address] Specify the destination IP address of the incoming packet to match along with an optional mask. Valid for all IP based flow-types. tos N [m N] Specify the value of the Type of Service field in the incoming packet to match along with an optional mask. Applies to all IPv4 based flow-types. tclass N [m N] Specify the value of the Traffic Class field in the incoming packet to match along with an optional mask. Applies to all IPv6 based flow-types. l4proto N [m N] Includes the layer 4 protocol number and optional mask. Valid only for flow-types ip4 and ip6. src-port N [m N] Specify the value of the source port field (applicable to TCP/UDP packets) in the incoming packet to match along with an optional mask. Valid for flow-types ip4, tcp4, udp4, and sctp4 and their IPv6 equivalents. dst-port N [m N] Specify the value of the destination port field (applicable to TCP/UDP packets)in the incoming packet to match along with an optional mask. Valid for flow-types ip4, tcp4, udp4, and sctp4 and their IPv6 equivalents. spi N [m N] Specify the value of the security parameter index field (applicable to AH/ESP packets)in the incoming packet to match along with an optional mask. Valid for flow-types ip4, ah4, and esp4 and their IPv6 equivalents. l4data N [m N] Specify the value of the first 4 Bytes of Layer 4 in the incoming packet to match along with an optional mask. Valid for ip4 and ip6 flow-types. vlan-etype N [m N] Includes the VLAN tag Ethertype and an optional mask. vlan N [m N] Includes the VLAN tag and an optional mask. user-def N [m N] Includes 64-bits of user-specific data and an optional mask. dst-mac xx:yy:zz:aa:bb:cc [m xx:yy:zz:aa:bb:cc] Includes the destination MAC address, specified as 6 bytes in hexadecimal separat‐ ed by colons, along with an optional mask. Valid for all IP based flow-types. action N Specifies the Rx queue to send packets to, or some other action. -1 Drop the matched flow -2 Use the matched flow as a Wake-on-LAN filter 0 or higher Rx queue to route the flow context N Specifies the RSS context to spread packets over multiple queues; either 0 for the default RSS context, or a value returned by ethtool -X ... context new. vf N Specifies the Virtual Function the filter applies to. Not compatible with action. queue N Specifies the Rx queue to send packets to. Not compatible with action. loc N Specify the location/ID to insert the rule. This will overwrite any rule present in that location and will not go through any of the rule ordering process. delete N Deletes the RX classification rule with the given ID." }, { "flag": "-w", "long": "--get-dump", "arg": null, "description": "Retrieves and prints firmware dump for the specified network device. By default, it prints out the dump flag, version and length of the dump data. When data is indicat‐ ed, then ethtool fetches the dump data and directs it to a file." }, { "flag": "-W", "long": "--set-dump", "arg": null, "description": "Sets the dump flag for the device." }, { "flag": "-T", "long": "--show-time-stamping", "arg": null, "description": "Show the device's time stamping capabilities and associated PTP hardware clock." }, { "flag": "-x", "long": "--show-rxfh", "arg": null, "description": "Retrieves the receive flow hash indirection table and/or RSS hash key." }, { "flag": "-X", "long": "--rxfh", "arg": null, "description": "Configures the receive flow hash indirection table and/or RSS hash key. hkey Sets RSS hash key of the specified network device. RSS hash key should be of de‐ vice supported length. Hash key format must be in xx:yy:zz:aa:bb:cc format mean‐ ing both the nibbles of a byte should be mentioned even if a nibble is zero. hfunc Sets RSS hash function of the specified network device. List of RSS hash func‐ tions which kernel supports is shown as a part of the --show-rxfh command output. start N For the equal and weight options, sets the starting receive queue for spreading flows to N. equal N Sets the receive flow hash indirection table to spread flows evenly between the first N receive queues. weight W0 W1 ... Sets the receive flow hash indirection table to spread flows between receive queues according to the given weights. The sum of the weights must be non-zero and must not exceed the size of the indirection table. default Sets the receive flow hash indirection table to its default value. context CTX | new Specifies an RSS context to act on; either new to allocate a new RSS context, or CTX, a value returned by a previous ... context new. delete Delete the specified RSS context. May only be used in conjunction with context and a non-zero CTX value." }, { "flag": "-f", "long": "--flash", "arg": null, "description": "Write a firmware image to flash or other non-volatile memory on the device. file Specifies the filename of the firmware image. The firmware must first be in‐ stalled in one of the directories where the kernel firmware loader or firmware agent will look, such as /lib/firmware. N If the device stores multiple firmware images in separate regions of non-volatile memory, this parameter may be used to specify which region is to be written. The default is 0, requesting that all regions are written. All other values are driv‐ er-dependent." }, { "flag": "-l", "long": "--show-channels", "arg": null, "description": "Queries the specified network device for the numbers of channels it has. A channel is an IRQ and the set of queues that can trigger that IRQ." }, { "flag": "-L", "long": "--set-channels", "arg": null, "description": "Changes the numbers of channels of the specified network device. rx N Changes the number of channels with only receive queues. tx N Changes the number of channels with only transmit queues. other N Changes the number of channels used only for other purposes e.g. link interrupts or SR-IOV co-ordination. combined N Changes the number of multi-purpose channels." }, { "flag": "-m", "long": "--module-info", "arg": null, "description": "Retrieves and if possible decodes the EEPROM from plugin modules, e.g SFP+, QSFP. If the driver and module support it, the optical diagnostic information is also read and decoded. When either one of page, bank or i2c parameters is specified, dumps only of a single page or its portion is allowed. In such a case offset and length parameters are treated relatively to EEPROM page boundaries." }, { "flag": "", "long": "--show-priv-flags", "arg": null, "description": "Queries the specified network device for its private flags. The names and meanings of private flags (if any) are defined by each network device driver." }, { "flag": "", "long": "--set-priv-flags", "arg": null, "description": "Sets the device's private flags as specified. flag on|off Sets the state of the named private flag." }, { "flag": "", "long": "--show-eee", "arg": null, "description": "Queries the specified network device for its support of Energy-Efficient Ethernet (ac‐ cording to the IEEE 802.3az specifications)" }, { "flag": "", "long": "--set-eee", "arg": null, "description": "Sets the device EEE behaviour. eee on|off Enables/disables the device support of EEE. tx-lpi on|off Determines whether the device should assert its Tx LPI. advertise N Sets the speeds for which the device should advertise EEE capabilities. Values are as for --change advertise tx-timer N Sets the amount of time the device should stay in idle mode prior to asserting its Tx LPI (in microseconds). This has meaning only when Tx LPI is enabled." }, { "flag": "", "long": "--set-phy-tunable", "arg": null, "description": "Sets the PHY tunable parameters. downshift on|off Specifies whether downshift should be enabled. count N Sets the PHY downshift re-tries count. fast-link-down on|off Specifies whether Fast Link Down should be enabled and time until link down (if supported). msecs N Sets the period after which the link is reported as down. Note that the PHY may choose the closest supported value. Only on reading back the tunable do you get the actual value. energy-detect-power-down on|off Specifies whether Energy Detect Power Down (EDPD) should be enabled (if support‐ ed). This will put the RX and TX circuit blocks into a low power mode, and the PHY will wake up periodically to send link pulses to avoid any lock-up situation with a peer PHY that may also have EDPD enabled. By default, this setting will al‐ so enable the periodic transmission of TX pulses. msecs N Some PHYs support configuration of the wake-up interval to send TX pulses. This setting allows the control of this interval, and 0 disables TX pulses if the PHY supports this. Disabling TX pulses can create a lock-up situation where neither of the PHYs wakes the other one. If unspecified the default value (in milliseconds) will be used by the PHY." }, { "flag": "", "long": "--get-phy-tunable", "arg": null, "description": "Gets the PHY tunable parameters. downshift For operation in cabling environments that are incompatible with 1000BASE-T, PHY device provides an automatic link speed downshift operation. Link speed downshift after N failed 1000BASE-T auto-negotiation attempts. Downshift is useful where cable does not have the 4 pairs instance. Gets the PHY downshift count/status. fast-link-down Depending on the mode it may take 0.5s - 1s until a broken link is reported as down. In certain use cases a link-down event needs to be reported as soon as pos‐ sible. Some PHYs support a Fast Link Down Feature and may allow configuration of the delay before a broken link is reported as being down. Gets the PHY Fast Link Down status / period. energy-detect-power-down Gets the current configured setting for Energy Detect Power Down (if supported)." }, { "flag": "", "long": "--get-tunable", "arg": null, "description": "Get the tunable parameters. rx-copybreak Get the current rx copybreak value in bytes. tx-copybreak Get the current tx copybreak value in bytes. pfc-prevention-tout Get the current pfc prevention timeout value in msecs." }, { "flag": "", "long": "--set-tunable", "arg": null, "description": "Set driver's tunable parameters. rx-copybreak N Set the rx copybreak value in bytes. tx-copybreak N Set the tx copybreak value in bytes. pfc-prevention-tout N Set pfc prevention timeout in msecs. Value of 0 means disable and 65535 means au‐ to." }, { "flag": "", "long": "--reset", "arg": null, "description": "Reset hardware components specified by flags and components listed below flags N Resets the components based on direct flags mask mgmt Management processor irq Interrupt requester dma DMA engine filter Filtering/flow direction offload Protocol offload mac Media access controller phy Transceiver/PHY ram RAM shared between multiple components ap Application Processor dedicated All components dedicated to this interface all All components used by this interface, even if shared" }, { "flag": "", "long": "--show-fec", "arg": null, "description": "Queries the specified network device for its support of Forward Error Correction." }, { "flag": "", "long": "--set-fec", "arg": null, "description": "Configures Forward Error Correction for the specified network device. Forward Error Correction modes selected by a user are expected to be persisted after any hotplug events. If a module is swapped that does not support the current FEC mode, the driver or firmware must take the link down administratively and report the problem in the system logs for users to correct. encoding auto|off|rs|baser|llrs [...] Sets the FEC encoding for the device. Combinations of options are specified as e.g. encoding auto rs ; the semantics of such combinations vary between drivers. auto Use the driver's default encoding off Turn off FEC RS Force RS-FEC encoding BaseR Force BaseR encoding LLRS Force LLRS-FEC encoding" }, { "flag": "", "long": null, "arg": null, "description": "Applies provided sub command to specific queues. queuemask %x Sets the specific queues which the sub command is applied to. If queuemask is not set, the sub command will be applied to all queues. subcommand Sub command to apply. The supported sub commands include --show-coalesce and --co‐ alesce. q.B --cable-test Perform a cable test and report the results. What results are returned depends on the capabilities of the network interface. Typically open pairs and shorted pairs can be reported, along with pairs being O.K. When a fault is detected the approximate dis‐ tance to the fault may be reported." }, { "flag": "", "long": "--cable-test-tdr", "arg": null, "description": "Perform a cable test and report the raw Time Domain Reflectometer data. A pulse is sent down a cable pair and the amplitude of the reflection, for a given distance, is reported. A break in the cable returns a big reflection. Minor damage to the cable re‐ turns a small reflection. If the cable is shorted, the amplitude of the reflection can be negative. By default, data is returned for lengths between 0 and 150m at 1m steps, for all pairs. However parameters can be passed to restrict the collection of data. It should be noted, that the interface will round the distances to whatever granularity is actually implemented. This is often 0.8 of a meter. The results should include the actual rounded first and last distance and step size. first N Distance along the cable, in meters, where the first measurement should be made. last N Distance along the cable, in meters, where the last measurement should be made. step N Distance, in meters, between each measurement. pair N Which pair should be measured. Typically a cable has 4 pairs. 0 = Pair A, 1 = Pair B, ..." }, { "flag": "", "long": "--monitor", "arg": null, "description": "Listens to netlink notification and displays them. command If argument matching a command is used, ethtool only shows notifications of this type. Without such argument or with --all, all notification types are shown. devname If a device name is used as argument, only notification for this device are shown. Default is to show notifications for all devices." }, { "flag": "", "long": "--show-tunnels", "arg": null, "description": "Show tunnel-related device capabilities and state. List UDP ports kernel has pro‐ grammed the device to parse as VxLAN, or GENEVE tunnels." } ], "examples": [], "see_also": [] }