1wicked-ethtool(8)            Network configuration           wicked-ethtool(8)
2
3
4

NAME

6       wicked ethtool command permits to query/configure parameters of NIC and
7       it's device driver.
8
9

SYNOPSIS

11       wicked ethtool <interface> < --action [ arguments ] >
12
13

NOTATION

15       We use the terms NIC, interface, device and tx/rx queue in a  dedicated
16       way.  A device or NIC is always a piece of hardware representing a net‐
17       work interface, a PCI or PCMCIA card or a USB device. An interface then
18       is  the name of the network interface it gets from the kernel, when the
19       device has been registered. A  queue  is  typically  implemented  as  a
20       first-in,  first-out (FIFO) ring buffer. Network device use transmit or
21       receive queue (tx/rx queue) for storing/buffring network packet data
22
23

DESCRIPTION

25       wicked ethtool can be used to configure a NIC as well as to  query  NIC
26       related  parameters  like  speed,  link  status, driver info and varius
27       other.  wicked ethtool doesn't require any file or a dbus  server  run‐
28       ning which is suitable for dracut environment.
29
30       Note,  that  the behavior depends on the effective kernel driver imple‐
31       menting an ethtool option.   Some  drivers  may  ignore  the  requested
32       option, e.g. specified advertise modes for autonegotiation.
33
34

ACTION

36       The following are the ethtool actions
37
38       --get-driver-info
39              Query an interface for driver information
40
41       --get-private-flags
42              Query  private  flags  of  an  interface  defined  by its device
43              driver.
44
45       --get-link-detected
46              Query the link carrier detection status
47
48       --get-link-settings
49              Query ethernet card properties such as  speed,  autoneg,  trans‐
50              ceiver, port, supported and advertising link modes.
51
52       --get-features|--get-offload
53              Query status of NIC protocol offload and other features.
54
55       --get-wake-on-lan|--get-wol
56              Query wake-on-lan settings.
57
58       --get-eee
59              Query  NIC  support  of  Energy-Efficient  Ethernet  as per IEEE
60              802.3az specifications.
61
62       --get-ring
63              Query  NIC driver's rx/tx queue size.
64
65       --get-channels
66              Query NIC's multi-queue settings.
67
68       --get-coalesce
69              Query interrupt rate information for a NIC.
70
71       --set-priv-flags <priv-flags> <on|off>
72              Enable/disable private flags defined by the NIC driver.
73                  #wicked ethtool eth0 --set-priv-flags disable-tpe-recovery on
74                   Note: Private flags are NIC driver specific, The flag in the example above
75                   tested on Emulex OneConnect NIC
76
77       --set-link-settings <setting-name> <value>
78              Configure NIC's link related settings.
79
80
81              autoneg <on|off>
82                     Enable or disable autonegotiation. With disabled autonegotiation,
83                     the speed and duplex can be used to set a fixed link mode.
84
85                     With enabled autonegotiation, the speed and duplex are read-only and
86                     the advertise parameter can be used to specify an explicit set of
87                     supported modes to advertise. Alternatively, wicked can create the
88                     advertise set using speed and duplex to filter known supported modes.
89
90                     To disable autonegotiation and use a fixed link mode:
91                     # wicked ethtool eth0 --set-link-settings autoneg off speed 1000 duplex full
92
93                     To enable autonegotiation and limit/filter advertised modes by speed and duplex:
94                     # wicked ethtool eth0 --set-link-settings autoneg on speed 1000 duplex full
95
96
97              advertise <mode,...>
98                     Set a specific set of comma separated speed modes to advertise in autonegotiation:
99                     # wicked ethtool eth0 --set-link-settings autoneg on advertise 100baseT-Half,100baseT-Full
100
101                     or as hex number list or bitmask, e.g. for modes without a known name:
102                     # wicked ethtool eth0 --set-link-settings autoneg on advertise 0x60000,0x800000
103
104                     To query the list of supported mode names for a specific interface, use:
105                     # wicked ethtool eth0 --get-link-setting
106
107
108              speed <N>
109                     Set a fixed link speed in Mb/s while disabled autonegotiation or limit/filter
110                     supported autonegotiation advertise modes by desired speed and duplex.
111
112
113              duplex <half|full>
114                     Set a fixed duplex mode while disabled autonegotiation or limit/filter
115                     supported autonegotiation advertise modes by desired speed and duplex.
116
117
118              port <TP|AUI|BNC|MII|DA|Fibre|Other>
119                     Set port type of the NIC:
120                     # wicked ethtool eth0 --set-link-settings speed port TP
121
122
123              mdix <mdi|mdi-x|auto-mdi|auto-mdi-x>
124                     Set mdi type for a port:
125                         #wicked ethtool eth1 --set-link-settings mdix auto-mdi-x
126
127
128              phy-address <0-255>
129                     Configure MDIO address of PHY:
130                         #wicked ethtool eth0 --set-link-settings phy-address 0
131
132
133              transceiver <internal|external>
134                     Configure transceiver type:
135                         #wicked ethtool eth0 --set-link-settings transceiver internal
136
137
138       --set-features <feature-name on|off>
139              Enable or disable device specific protocol offload and feature settings:
140                  #wicked ethtool eth0 --set-features rx-gro on
141
142       --set-eee
143              Configure eee related settings:
144
145              eee <on|off>
146                     Enable/disable eee settings:
147                         #wicked ethtool eth0 --set-eee eee on
148
149
150              tx-lpi <on|off>
151                     Configure tx low power idle settings:
152                         #wicked ethtool eth0 --set-eee tx-lpi on
153
154
155              tx-timer <N>
156                     Set interface(in microseconds) delays prior to asserting its tx lpi:
157                         #wicked ethtool eth0 --set-eee tx-timer 100
158
159
160              advertise <mode,...>
161                     Configure speeds for which the device should advertise EEE capabilities:
162                         #wicked ethtool eth0 --set-eee advertise 100baseT-Half,100baseT-Full
163
164       --set-channels <rx|tx|other|combined> <N>
165              Configure rx/tx queue use by the NIC:
166                  #wicked ethtool eth0 --set-channels combined 4
167
168
169       --set-ring <rx|tx|rx-jumbo|rx-mini> <N>
170              Configure rx/tx queue size use by the NIC:
171                  #wicked ethtool eth0 --set-ring rx 2
172
173
174       --set-coalesce <coalesce-name> <on|off|N>
175              Configure interrupts rate settings of NIC:
176                  #wicked ethtool eth0 --set-coalesce rx-usecs 10
177                  #wicked ethtool eth0 --set-coalesce  adaptive-rx on
178
179
180       --set-wol
181              Configure wake-on-lan settings:
182
183              options <list of options with or without comma-separated >
184                         #wicked ethtool eth1 --set-wol options pumba
185                         #wicked ethtool eth1 --set-wol options p,u,m,b,a
186                         #wicked ethtool eth0 --set-wol options phy,unicast,multicast,broadcast,magic
187
188              sopass <a colon-separated bytes in hex>
189                     Set the SecureOn™ password:
190                         #wicked ethtool eth0 --set-wol sopass 02:42:ca:66:ce:a8
191
192
194       Copyright (c) 2018 SUSE LINUX GmbH, Nuernberg, Germany.
195

BUGS

197       Please report bugs at <https://bugzilla.novell.com/index.cgi>
198

AUTHORS

200       Nirmoy Das
201

SEE ALSO

203       ifcfg(5),  routes(5),  wicked(8),  ifcfg-wireless(5),  ifcfg-tunnel(5),
204       ifcfg-vlan(5), ifcfg-bonding(5),
205
206
207
208wicked                             June 2018                 wicked-ethtool(8)
Impressum