]>
Commit | Line | Data |
---|---|---|
77987911 | 1 | .TH IP\-LINK 8 "13 Dec 2012" "iproute2" "Linux" |
761a1e60 CT |
2 | .SH "NAME" |
3 | ip-link \- network device configuration | |
4 | .SH "SYNOPSIS" | |
5 | .sp | |
6 | .ad l | |
7 | .in +8 | |
8 | .ti -8 | |
9 | .B ip | |
10 | .RI "[ " OPTIONS " ]" | |
11 | .B link | |
12 | .RI " { " COMMAND " | " | |
13 | .BR help " }" | |
14 | .sp | |
15 | ||
16 | .ti -8 | |
17 | .IR OPTIONS " := { " | |
18 | \fB\-V\fR[\fIersion\fR] | | |
b68d9837 | 19 | \fB\-h\fR[\fIuman-readable\fR] | |
761a1e60 CT |
20 | \fB\-s\fR[\fItatistics\fR] | |
21 | \fB\-r\fR[\fIesolve\fR] | | |
22 | \fB\-f\fR[\fIamily\fR] { | |
23 | .BR inet " | " inet6 " | " ipx " | " dnet " | " link " } | " | |
24 | \fB\-o\fR[\fIneline\fR] } | |
25 | ||
26 | .ti -8 | |
9fc56974 AH |
27 | .BI "ip link add" |
28 | .RB "[ " link | |
29 | .IR DEVICE " ]" | |
761a1e60 CT |
30 | .RB "[ " name " ]" |
31 | .I NAME | |
32 | .br | |
33 | .RB "[ " txqueuelen | |
34 | .IR PACKETS " ]" | |
35 | .br | |
36 | .RB "[ " address | |
37 | .IR LLADDR " ]" | |
38 | .RB "[ " broadcast | |
39 | .IR LLADDR " ]" | |
40 | .br | |
41 | .RB "[ " mtu | |
42 | .IR MTU " ]" | |
4de8d885 PE |
43 | .RB "[ " index |
44 | .IR IDX " ]" | |
761a1e60 | 45 | .br |
d992f3e6 JP |
46 | .RB "[ " numtxqueues |
47 | .IR QUEUE_COUNT " ]" | |
48 | .RB "[ " numrxqueues | |
49 | .IR QUEUE_COUNT " ]" | |
50 | .br | |
761a1e60 CT |
51 | .BR type " TYPE" |
52 | .RI "[ " ARGS " ]" | |
53 | ||
54 | .ti -8 | |
55 | .IR TYPE " := [ " | |
f1a6f4e9 | 56 | .BR bridge " | " |
e37a9c73 | 57 | .BR bond " | " |
f1a6f4e9 SH |
58 | .BR can " | " |
59 | .BR dummy " | " | |
5c0aec93 | 60 | .BR hsr " | " |
f1a6f4e9 SH |
61 | .BR ifb " | " |
62 | .BR ipoib " |" | |
63 | .BR macvlan " | " | |
e4c35682 | 64 | .BR macvtap " | " |
f1a6f4e9 SH |
65 | .BR vcan " | " |
66 | .BR veth " | " | |
67 | .BR vlan " | " | |
77987911 ND |
68 | .BR vxlan " |" |
69 | .BR ip6tnl " |" | |
70 | .BR ipip " |" | |
9abde37c | 71 | .BR sit " |" |
72 | .BR gre " |" | |
73 | .BR gretap " |" | |
74 | .BR ip6gre " |" | |
b6d6b5a1 VK |
75 | .BR ip6gretap " |" |
76 | .BR vti " |" | |
77 | .BR nlmon " |" | |
2c0feda8 LB |
78 | .BR ipvlan " |" |
79 | .BR lowpan " ]" | |
761a1e60 CT |
80 | |
81 | .ti -8 | |
7f74cf6d VK |
82 | .BR "ip link delete " { |
83 | .IR DEVICE " | " | |
84 | .BI "group " GROUP | |
85 | } | |
761a1e60 CT |
86 | .BI type " TYPE" |
87 | .RI "[ " ARGS " ]" | |
88 | ||
89 | .ti -8 | |
90 | .BR "ip link set " { | |
91 | .IR DEVICE " | " | |
92 | .BI "group " GROUP | |
93 | .RB "} { " up " | " down " | " arp " { " on " | " off " } |" | |
94 | .br | |
95 | .BR promisc " { " on " | " off " } |" | |
96 | .br | |
97 | .BR allmulticast " { " on " | " off " } |" | |
98 | .br | |
99 | .BR dynamic " { " on " | " off " } |" | |
100 | .br | |
101 | .BR multicast " { " on " | " off " } |" | |
102 | .br | |
103 | .B txqueuelen | |
104 | .IR PACKETS " |" | |
105 | .br | |
106 | .B name | |
107 | .IR NEWNAME " |" | |
108 | .br | |
109 | .B address | |
110 | .IR LLADDR " |" | |
111 | .B broadcast | |
112 | .IR LLADDR " |" | |
113 | .br | |
114 | .B mtu | |
115 | .IR MTU " |" | |
116 | .br | |
117 | .B netns | |
118 | .IR PID " |" | |
119 | .br | |
120 | .B netns | |
121 | .IR NETNSNAME " |" | |
122 | .br | |
123 | .B alias | |
124 | .IR NAME " |" | |
125 | .br | |
126 | .B vf | |
127 | .IR NUM " [" | |
128 | .B mac | |
129 | .IR LLADDR " ] [" | |
130 | .B vlan | |
131 | .IR VLANID " [ " | |
132 | .B qos | |
133 | .IR VLAN-QOS " ] ] [" | |
134 | .B rate | |
135 | .IR TXRATE " ] [" | |
f89a2a05 SC |
136 | .B max_tx_rate |
137 | .IR TXRATE " ] [" | |
138 | .B min_tx_rate | |
139 | .IR TXRATE " ] [" | |
63f60e3a OG |
140 | .B spoofchk { on | off } ] [ |
141 | .B state { auto | enable | disable} | |
761a1e60 CT |
142 | ] | |
143 | .br | |
144 | .B master | |
145 | .IR DEVICE | |
146 | .br | |
147 | .B nomaster | |
148 | .BR " }" | |
149 | ||
150 | ||
151 | .ti -8 | |
152 | .B ip link show | |
153 | .RI "[ " DEVICE " | " | |
154 | .B group | |
1b944148 VK |
155 | .IR GROUP " | " |
156 | .BR up " | " | |
157 | .B master | |
712249d8 VK |
158 | .IR DEVICE " | " |
159 | .B type | |
160 | .IR TYPE " ]" | |
761a1e60 | 161 | |
1f299e92 | 162 | .ti -8 |
163 | .B ip link help | |
164 | .RI "[ " TYPE " ]" | |
165 | ||
761a1e60 CT |
166 | .SH "DESCRIPTION" |
167 | .SS ip link add - add virtual link | |
168 | ||
169 | .TP | |
170 | .BI link " DEVICE " | |
171 | specifies the physical device to act operate on. | |
172 | ||
173 | .I NAME | |
174 | specifies the name of the new virtual device. | |
175 | ||
176 | .I TYPE | |
177 | specifies the type of the new device. | |
178 | .sp | |
179 | Link types: | |
180 | ||
181 | .in +8 | |
f1a6f4e9 SH |
182 | .B bridge |
183 | - Ethernet Bridge device | |
761a1e60 | 184 | .sp |
cc26a890 JP |
185 | .B bond |
186 | - Bonding device | |
187 | .sp | |
761a1e60 CT |
188 | .B dummy |
189 | - Dummy network interface | |
190 | .sp | |
2f937359 | 191 | .B hsr |
192 | - High-availability Seamless Redundancy device | |
193 | .sp | |
761a1e60 CT |
194 | .B ifb |
195 | - Intermediate Functional Block device | |
196 | .sp | |
f1a6f4e9 SH |
197 | .B ipoib |
198 | - IP over Infiniband device | |
199 | .sp | |
761a1e60 | 200 | .B macvlan |
f1a6f4e9 | 201 | - Virtual interface base on link layer address (MAC) |
761a1e60 | 202 | .sp |
e4c35682 RR |
203 | .B macvtap |
204 | - Virtual interface based on link layer address (MAC) and TAP. | |
205 | .sp | |
f1a6f4e9 | 206 | .B vcan |
2b70fe15 | 207 | - Virtual Controller Area Network interface |
761a1e60 | 208 | .sp |
f1a6f4e9 SH |
209 | .B veth |
210 | - Virtual ethernet interface | |
de038993 | 211 | .sp |
f1a6f4e9 SH |
212 | .BR vlan |
213 | - 802.1q tagged virtual LAN interface | |
214 | .sp | |
215 | .BR vxlan | |
216 | - Virtual eXtended LAN | |
77987911 ND |
217 | .sp |
218 | .BR ip6tnl | |
219 | - Virtual tunnel interface IPv4|IPv6 over IPv6 | |
220 | .sp | |
221 | .BR ipip | |
222 | - Virtual tunnel interface IPv4 over IPv4 | |
223 | .sp | |
224 | .BR sit | |
225 | - Virtual tunnel interface IPv6 over IPv4 | |
9abde37c | 226 | .sp |
227 | .BR gre | |
228 | - Virtual tunnel interface GRE over IPv4 | |
229 | .sp | |
230 | .BR gretap | |
d36d9d41 | 231 | - Virtual L2 tunnel interface GRE over IPv4 |
9abde37c | 232 | .sp |
233 | .BR ip6gre | |
d36d9d41 | 234 | - Virtual tunnel interface GRE over IPv6 |
9abde37c | 235 | .sp |
236 | .BR ip6gretap | |
d36d9d41 | 237 | - Virtual L2 tunnel interface GRE over IPv6 |
b6d6b5a1 VK |
238 | .sp |
239 | .BR vti | |
240 | - Virtual tunnel interface | |
241 | .sp | |
242 | .BR nlmon | |
243 | - Netlink monitoring device | |
244 | .sp | |
245 | .BR ipvlan | |
246 | - Interface for L3 (IPv6/IPv4) based VLANs | |
2c0feda8 LB |
247 | .sp |
248 | .BR lowpan | |
249 | - Interface for 6LoWPAN (IPv6) over IEEE 802.15.4 / Bluetooth | |
761a1e60 CT |
250 | .in -8 |
251 | ||
d992f3e6 JP |
252 | .TP |
253 | .BI numtxqueues " QUEUE_COUNT " | |
254 | specifies the number of transmit queues for new device. | |
255 | ||
256 | .TP | |
257 | .BI numrxqueues " QUEUE_COUNT " | |
258 | specifies the number of receive queues for new device. | |
259 | ||
4de8d885 PE |
260 | .TP |
261 | .BI index " IDX " | |
262 | specifies the desired index of the new virtual device. The link creation fails, if the index is busy. | |
263 | ||
2816a568 TR |
264 | .TP |
265 | VXLAN Type Support | |
63f60e3a | 266 | For a link of type |
2816a568 TR |
267 | .I VXLAN |
268 | the following additional arguments are supported: | |
269 | ||
270 | .BI "ip link add " DEVICE | |
f66611d8 | 271 | .BI type " vxlan " id " ID" |
2816a568 TR |
272 | .R " [ " |
273 | .BI dev " PHYS_DEV " | |
7cfa3802 AW |
274 | .RB " ] [ { " group " | " remote " } " |
275 | .I IPADDR | |
2816a568 TR |
276 | .R " ] [ " |
277 | .BI local " IPADDR " | |
278 | .R " ] [ " | |
279 | .BI ttl " TTL " | |
280 | .R " ] [ " | |
281 | .BI tos " TOS " | |
282 | .R " ] [ " | |
283 | .BI port " MIN MAX " | |
284 | .R " ] [ " | |
285 | .I "[no]learning " | |
286 | .R " ] [ " | |
287 | .I "[no]proxy " | |
288 | .R " ] [ " | |
289 | .I "[no]rsc " | |
290 | .R " ] [ " | |
291 | .I "[no]l2miss " | |
292 | .R " ] [ " | |
293 | .I "[no]l3miss " | |
c2fbc57e ND |
294 | .R " ] [ " |
295 | .BI ageing " SECONDS " | |
296 | .R " ] [ " | |
297 | .BI maxaddress " NUMBER " | |
2eb90dc7 TG |
298 | .R " ] [ " |
299 | .B gbp | |
2816a568 TR |
300 | .R " ]" |
301 | ||
302 | .in +8 | |
303 | .sp | |
304 | .BI id " VNI " | |
305 | - specifies the VXLAN Network Identifer (or VXLAN Segment | |
306 | Identifier) to use. | |
307 | ||
308 | .BI dev " PHYS_DEV" | |
309 | - specifies the physical device to use for tunnel endpoint communication. | |
310 | ||
311 | .sp | |
312 | .BI group " IPADDR" | |
313 | - specifies the multicast IP address to join. | |
7cfa3802 AW |
314 | This parameter cannot be specified with the |
315 | .B remote | |
316 | parameter. | |
317 | ||
318 | .sp | |
319 | .BI remote " IPADDR" | |
320 | - specifies the unicast destination IP address to use in outgoing packets | |
321 | when the destination link layer address is not known in the VXLAN device | |
a89d5329 | 322 | forwarding database. This parameter cannot be specified with the |
7cfa3802 AW |
323 | .B group |
324 | parameter. | |
2816a568 TR |
325 | |
326 | .sp | |
327 | .BI local " IPADDR" | |
328 | - specifies the source IP address to use in outgoing packets. | |
329 | ||
330 | .sp | |
331 | .BI ttl " TTL" | |
332 | - specifies the TTL value to use in outgoing packets. | |
333 | ||
334 | .sp | |
335 | .BI tos " TOS" | |
336 | - specifies the TOS value to use in outgoing packets. | |
337 | ||
338 | .sp | |
339 | .BI port " MIN MAX" | |
340 | - specifies the range of port numbers to use as UDP | |
341 | source ports to communicate to the remote VXLAN tunnel endpoint. | |
342 | ||
343 | .sp | |
344 | .I [no]learning | |
345 | - specifies if unknown source link layer addresses and IP addresses | |
346 | are entered into the VXLAN device forwarding database. | |
347 | ||
348 | .sp | |
349 | .I [no]rsc | |
350 | - specifies if route short circuit is turned on. | |
351 | ||
352 | .sp | |
353 | .I [no]proxy | |
354 | - specifies ARP proxy is turned on. | |
355 | ||
356 | .sp | |
357 | .I [no]l2miss | |
358 | - specifies if netlink LLADDR miss notifications are generated. | |
359 | ||
360 | .sp | |
361 | .I [no]l3miss | |
362 | - specifies if netlink IP ADDR miss notifications are generated. | |
363 | ||
c2fbc57e ND |
364 | .sp |
365 | .BI ageing " SECONDS" | |
366 | - specifies the lifetime in seconds of FDB entries learnt by the kernel. | |
367 | ||
368 | .sp | |
369 | .BI maxaddress " NUMBER" | |
370 | - specifies the maximum number of FDB entries. | |
371 | ||
2eb90dc7 TG |
372 | .sp |
373 | .B gbp | |
374 | - enables the Group Policy extension (VXLAN-GBP). | |
375 | ||
376 | .in +4 | |
377 | Allows to transport group policy context across VXLAN network peers. | |
378 | If enabled, includes the mark of a packet in the VXLAN header for outgoing | |
379 | packets and fills the packet mark based on the information found in the | |
380 | VXLAN header for incomming packets. | |
381 | ||
382 | Format of upper 16 bits of packet mark (flags); | |
383 | ||
384 | .in +2 | |
385 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | |
386 | .br | |
387 | |-|-|-|-|-|-|-|-|-|D|-|-|A|-|-|-| | |
388 | .br | |
389 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | |
390 | ||
391 | .B D := | |
392 | Don't Learn bit. When set, this bit indicates that the egress | |
393 | VTEP MUST NOT learn the source address of the encapsulated frame. | |
394 | ||
395 | .B A := | |
396 | Indicates that the group policy has already been applied to | |
397 | this packet. Policies MUST NOT be applied by devices when the A bit is set. | |
398 | .in -2 | |
399 | ||
400 | Format of lower 16 bits of packet mark (policy ID): | |
401 | ||
402 | .in +2 | |
403 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | |
404 | .br | |
405 | | Group Policy ID | | |
406 | .br | |
407 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | |
408 | .in -2 | |
409 | ||
410 | Example: | |
411 | iptables -A OUTPUT [...] -j MARK --set-mark 0x800FF | |
412 | ||
413 | .in -4 | |
414 | ||
2816a568 TR |
415 | .in -8 |
416 | ||
90f1df71 TH |
417 | .TP |
418 | GRE, IPIP, SIT Type Support | |
419 | For a link of types | |
420 | .I GRE/IPIP/SIT | |
421 | the following additional arguments are supported: | |
422 | ||
423 | .BI "ip link add " DEVICE | |
424 | .BR type " { gre | ipip | sit } " | |
425 | .BI " remote " ADDR " local " ADDR | |
426 | .R " [ " | |
427 | .BR encap " { fou | gue | none } " | |
428 | .R " ] [ " | |
429 | .BI "encap-sport { " PORT " | auto } " | |
430 | .R " ] [ " | |
431 | .BI "encap-dport " PORT | |
432 | .R " ] [ " | |
433 | .I " [no]encap-csum " | |
434 | .R " ] [ " | |
435 | .I " [no]encap-remcsum " | |
436 | .R " ]" | |
437 | ||
438 | .in +8 | |
439 | .sp | |
440 | .BI remote " ADDR " | |
441 | - specifies the remote address of the tunnel. | |
442 | ||
443 | .sp | |
444 | .BI local " ADDR " | |
445 | - specifies the fixed local address for tunneled packets. | |
446 | It must be an address on another interface on this host. | |
447 | ||
448 | .sp | |
449 | .BR encap " { fou | gue | none } " | |
450 | - specifies type of secondary UDP encapsulation. "fou" indicates | |
451 | Foo-Over-UDP, "gue" indicates Generic UDP Encapsulation. | |
452 | ||
453 | .sp | |
454 | .BI "encap-sport { " PORT " | auto } " | |
455 | - specifies the source port in UDP encapsulation. | |
456 | .IR PORT | |
457 | indicates the port by number, "auto" | |
458 | indicates that the port number should be chosen automatically | |
459 | (the kernel picks a flow based on the flow hash of the | |
460 | encapsulated packet). | |
461 | ||
462 | .sp | |
463 | .I [no]encap-csum | |
464 | - specifies if UDP checksums are enabled in the secondary | |
465 | encapsulation. | |
466 | ||
467 | .sp | |
468 | .I [no]encap-remcsum | |
469 | - specifies if Remote Checksum Offload is enabled. This is only | |
470 | applicable for Generic UDP Encapsulation. | |
471 | ||
472 | .in -8 | |
473 | ||
9abde37c | 474 | .TP |
475 | IP6GRE/IP6GRETAP Type Support | |
63f60e3a | 476 | For a link of type |
9abde37c | 477 | .I IP6GRE/IP6GRETAP |
478 | the following additional arguments are supported: | |
479 | ||
480 | .BI "ip link add " DEVICE | |
481 | .BI type " { ip6gre | ip6gretap } " remote " ADDR " local " ADDR | |
482 | .R " [ " | |
483 | .I "[i|o]seq]" | |
484 | .R " ] [ " | |
485 | .I "[i|o]key" KEY | |
486 | .R " ] [ " | |
487 | .I " [i|o]csum " | |
488 | .R " ] [ " | |
489 | .BI hoplimit " TTL " | |
490 | .R " ] [ " | |
491 | .BI encaplimit " ELIM " | |
492 | .R " ] [ " | |
493 | .BI tclass " TCLASS " | |
494 | .R " ] [ " | |
495 | .BI flowlabel " FLOWLABEL " | |
496 | .R " ] [ " | |
497 | .BI "dscp inherit" | |
498 | .R " ] [ " | |
499 | .BI dev " PHYS_DEV " | |
500 | .R " ]" | |
501 | ||
502 | .in +8 | |
503 | .sp | |
504 | .BI remote " ADDR " | |
505 | - specifies the remote IPv6 address of the tunnel. | |
506 | ||
507 | .sp | |
508 | .BI local " ADDR " | |
509 | - specifies the fixed local IPv6 address for tunneled packets. | |
90f1df71 | 510 | It must be an address on another interface on this host. |
9abde37c | 511 | |
512 | .sp | |
513 | .BI [i|o]seq | |
514 | - serialize packets. | |
515 | The | |
516 | .B oseq | |
517 | flag enables sequencing of outgoing packets. | |
518 | The | |
519 | .B iseq | |
520 | flag requires that all input packets are serialized. | |
521 | ||
522 | .sp | |
523 | .BI [i|o]key " KEY" | |
524 | - use keyed GRE with key | |
525 | .IR KEY ". "KEY | |
526 | is either a number or an IPv4 address-like dotted quad. | |
527 | The | |
528 | .B key | |
529 | parameter specifies the same key to use in both directions. | |
530 | The | |
531 | .BR ikey " and " okey | |
532 | parameters specify different keys for input and output. | |
533 | ||
534 | .sp | |
535 | .BI [i|o]csum | |
536 | - generate/require checksums for tunneled packets. | |
537 | The | |
538 | .B ocsum | |
539 | flag calculates checksums for outgoing packets. | |
540 | The | |
541 | .B icsum | |
542 | flag requires that all input packets have the correct | |
a89d5329 | 543 | checksum. The |
9abde37c | 544 | .B csum |
545 | flag is equivalent to the combination | |
546 | .BR "icsum ocsum" . | |
547 | ||
548 | .sp | |
549 | .BI hoplimit " TTL" | |
550 | - specifies Hop Limit value to use in outgoing packets. | |
551 | ||
552 | .sp | |
553 | .BI encaplimit " ELIM" | |
a89d5329 | 554 | - specifies a fixed encapsulation limit. Default is 4. |
9abde37c | 555 | |
556 | .sp | |
557 | .BI flowlabel " FLOWLABEL" | |
63f60e3a | 558 | - specifies a fixed flowlabel. |
9abde37c | 559 | |
560 | .sp | |
561 | .BI tclass " TCLASS" | |
562 | - specifies the traffic class field on | |
563 | tunneled packets, which can be specified as either a two-digit | |
564 | hex value (e.g. c0) or a predefined string (e.g. internet). | |
565 | The value | |
566 | .B inherit | |
567 | causes the field to be copied from the original IP header. The | |
568 | values | |
569 | .BI "inherit/" STRING | |
570 | or | |
571 | .BI "inherit/" 00 ".." ff | |
572 | will set the field to | |
573 | .I STRING | |
574 | or | |
575 | .IR 00 ".." ff | |
576 | when tunneling non-IP packets. The default value is 00. | |
577 | ||
578 | .in -8 | |
579 | ||
8ca8fac7 OG |
580 | .TP |
581 | IPoIB Type Support | |
582 | For a link of type | |
583 | .I IPoIB | |
584 | the following additional arguments are supported: | |
585 | ||
586 | .BI "ip link add " DEVICE " name " NAME | |
587 | .BI type " ipoib [ " pkey " PKEY ] [" mode " MODE " ] | |
588 | ||
589 | .in +8 | |
590 | .sp | |
591 | .BI pkey " PKEY " | |
592 | - specifies the IB P-Key to use. | |
593 | ||
594 | .BI mode " MODE " | |
595 | - specifies the mode (datagram or connected) to use. | |
596 | ||
761a1e60 | 597 | .SS ip link delete - delete virtual link |
761a1e60 CT |
598 | |
599 | .TP | |
600 | .BI dev " DEVICE " | |
7f74cf6d VK |
601 | specifies the virtual device to act operate on. |
602 | ||
603 | .TP | |
604 | .BI group " GROUP " | |
605 | specifies the group of virtual links to delete. Group 0 is not allowed to be | |
606 | deleted since it is the default group. | |
607 | ||
608 | .TP | |
609 | .BI type " TYPE " | |
610 | specifies the type of the device. | |
761a1e60 CT |
611 | |
612 | .SS ip link set - change device attributes | |
613 | ||
614 | .TP | |
615 | .BI dev " DEVICE " | |
616 | .I DEVICE | |
6274b0b7 | 617 | specifies network device to operate on. When configuring SR-IOV Virtual Function |
761a1e60 CT |
618 | (VF) devices, this keyword should specify the associated Physical Function (PF) |
619 | device. | |
620 | ||
621 | .TP | |
622 | .BI group " GROUP " | |
623 | .I GROUP | |
624 | has a dual role: If both group and dev are present, then move the device to the | |
a89d5329 | 625 | specified group. If only a group is specified, then the command operates on |
761a1e60 CT |
626 | all devices in that group. |
627 | ||
628 | .TP | |
629 | .BR up " and " down | |
630 | change the state of the device to | |
631 | .B UP | |
632 | or | |
633 | .BR "DOWN" . | |
634 | ||
635 | .TP | |
636 | .BR "arp on " or " arp off" | |
637 | change the | |
638 | .B NOARP | |
639 | flag on the device. | |
640 | ||
641 | .TP | |
642 | .BR "multicast on " or " multicast off" | |
643 | change the | |
644 | .B MULTICAST | |
645 | flag on the device. | |
646 | ||
647 | .TP | |
648 | .BR "dynamic on " or " dynamic off" | |
649 | change the | |
650 | .B DYNAMIC | |
34c8a95c VK |
651 | flag on the device. Indicates that address can change when interface goes down (currently |
652 | .B NOT | |
653 | used by the Linux). | |
761a1e60 CT |
654 | |
655 | .TP | |
656 | .BI name " NAME" | |
a89d5329 | 657 | change the name of the device. This operation is not |
761a1e60 CT |
658 | recommended if the device is running or has some addresses |
659 | already configured. | |
660 | ||
661 | .TP | |
662 | .BI txqueuelen " NUMBER" | |
663 | .TP | |
664 | .BI txqlen " NUMBER" | |
665 | change the transmit queue length of the device. | |
666 | ||
667 | .TP | |
668 | .BI mtu " NUMBER" | |
669 | change the | |
670 | .I MTU | |
671 | of the device. | |
672 | ||
673 | .TP | |
674 | .BI address " LLADDRESS" | |
675 | change the station address of the interface. | |
676 | ||
677 | .TP | |
678 | .BI broadcast " LLADDRESS" | |
679 | .TP | |
680 | .BI brd " LLADDRESS" | |
681 | .TP | |
682 | .BI peer " LLADDRESS" | |
683 | change the link layer broadcast address or the peer address when | |
684 | the interface is | |
685 | .IR "POINTOPOINT" . | |
686 | ||
687 | .TP | |
36324eba | 688 | .BI netns " NETNSNAME " \fR| " PID" |
761a1e60 | 689 | move the device to the network namespace associated with name |
36324eba VK |
690 | .IR "NETNSNAME " or |
691 | .RI process " PID". | |
692 | ||
693 | Some devices are not allowed to change network namespace: loopback, bridge, | |
694 | ppp, wireless. These are network namespace local devices. In such case | |
695 | .B ip | |
696 | tool will return "Invalid argument" error. It is possible to find out if device is local | |
697 | to a single network namespace by checking | |
698 | .B netns-local | |
699 | flag in the output of the | |
700 | .BR ethtool ":" | |
701 | ||
702 | .in +8 | |
703 | .B ethtool -k | |
704 | .I DEVICE | |
705 | .in -8 | |
706 | ||
707 | To change network namespace for wireless devices the | |
708 | .B iw | |
709 | tool can be used. But it allows to change network namespace only for physical devices and by process | |
710 | .IR PID . | |
761a1e60 CT |
711 | |
712 | .TP | |
713 | .BI alias " NAME" | |
714 | give the device a symbolic name for easy reference. | |
715 | ||
761a1e60 CT |
716 | .TP |
717 | .BI vf " NUM" | |
718 | specify a Virtual Function device to be configured. The associated PF device | |
719 | must be specified using the | |
720 | .B dev | |
721 | parameter. | |
722 | ||
723 | .in +8 | |
724 | .BI mac " LLADDRESS" | |
725 | - change the station address for the specified VF. The | |
726 | .B vf | |
727 | parameter must be specified. | |
728 | ||
729 | .sp | |
730 | .BI vlan " VLANID" | |
731 | - change the assigned VLAN for the specified VF. When specified, all traffic | |
732 | sent from the VF will be tagged with the specified VLAN ID. Incoming traffic | |
733 | will be filtered for the specified VLAN ID, and will have all VLAN tags | |
734 | stripped before being passed to the VF. Setting this parameter to 0 disables | |
735 | VLAN tagging and filtering. The | |
736 | .B vf | |
737 | parameter must be specified. | |
738 | ||
739 | .sp | |
740 | .BI qos " VLAN-QOS" | |
741 | - assign VLAN QOS (priority) bits for the VLAN tag. When specified, all VLAN | |
742 | tags transmitted by the VF will include the specified priority bits in the | |
743 | VLAN tag. If not specified, the value is assumed to be 0. Both the | |
744 | .B vf | |
745 | and | |
746 | .B vlan | |
747 | parameters must be specified. Setting both | |
748 | .B vlan | |
749 | and | |
750 | .B qos | |
751 | as 0 disables VLAN tagging and filtering for the VF. | |
752 | ||
753 | .sp | |
754 | .BI rate " TXRATE" | |
f89a2a05 SC |
755 | -- change the allowed transmit bandwidth, in Mbps, for the specified VF. |
756 | Setting this parameter to 0 disables rate limiting. | |
757 | .B vf | |
758 | parameter must be specified. | |
759 | Please use new API | |
760 | .B "max_tx_rate" | |
761 | option instead. | |
762 | ||
763 | .sp | |
764 | .BI max_tx_rate " TXRATE" | |
765 | - change the allowed maximum transmit bandwidth, in Mbps, for the specified VF. | |
766 | .B vf | |
767 | parameter must be specified. | |
768 | ||
769 | .sp | |
770 | .BI min_tx_rate " TXRATE" | |
771 | - change the allowed minimum transmit bandwidth, in Mbps, for the specified VF. | |
772 | Minimum TXRATE should be always <= Maximum TXRATE. | |
761a1e60 CT |
773 | .B vf |
774 | parameter must be specified. | |
775 | ||
776 | .sp | |
777 | .BI spoofchk " on|off" | |
778 | - turn packet spoof checking on or off for the specified VF. | |
63f60e3a OG |
779 | .sp |
780 | .BI state " auto|enable|disable" | |
781 | - set the virtual link state as seen by the specified VF. Setting to auto means a | |
782 | reflection of the PF link state, enable lets the VF to communicate with other VFs on | |
783 | this host even if the PF link state is down, disable causes the HW to drop any packets | |
784 | sent by the VF. | |
761a1e60 CT |
785 | .in -8 |
786 | ||
787 | .TP | |
788 | .BI master " DEVICE" | |
789 | set master device of the device (enslave device). | |
790 | ||
791 | .TP | |
792 | .BI nomaster | |
793 | unset master device of the device (release device). | |
794 | ||
795 | .PP | |
796 | .B Warning: | |
797 | If multiple parameter changes are requested, | |
798 | .B ip | |
799 | aborts immediately after any of the changes have failed. | |
800 | This is the only case when | |
801 | .B ip | |
a89d5329 | 802 | can move the system to an unpredictable state. The solution |
761a1e60 CT |
803 | is to avoid changing several parameters with one |
804 | .B ip link set | |
805 | call. | |
806 | ||
807 | .SS ip link show - display device attributes | |
808 | ||
809 | .TP | |
810 | .BI dev " NAME " (default) | |
811 | .I NAME | |
812 | specifies the network device to show. | |
813 | If this argument is omitted all devices in the default group are listed. | |
814 | ||
815 | .TP | |
816 | .BI group " GROUP " | |
817 | .I GROUP | |
818 | specifies what group of devices to show. | |
819 | ||
820 | .TP | |
821 | .B up | |
822 | only display running interfaces. | |
823 | ||
1b944148 VK |
824 | .TP |
825 | .BI master " DEVICE " | |
826 | .I DEVICE | |
827 | specifies the master device which enslaves devices to show. | |
828 | ||
712249d8 VK |
829 | .TP |
830 | .BI type " TYPE " | |
831 | .I TYPE | |
832 | specifies the type of devices to show. | |
833 | ||
8322d28d | 834 | .TP |
1e264abc SH |
835 | The show command has additional formatting options: |
836 | ||
8322d28d | 837 | .RS |
1e264abc SH |
838 | .TP |
839 | .BR "\-s" , " \-stats", " \-statistics" | |
840 | output more statistics about packet usage. | |
841 | ||
842 | .TP | |
843 | .BR "\-d", " \-details" | |
844 | output more detailed information. | |
845 | ||
846 | .TP | |
847 | .BR "\-h", " \-human", " \-human-readble" | |
848 | output statistics with human readable values number followed by suffix | |
849 | ||
850 | .TP | |
851 | .BR "\-iec" | |
852 | print human readable rates in IEC units (ie. 1K = 1024). | |
8322d28d | 853 | .RE |
b68d9837 | 854 | |
1f299e92 | 855 | .SS ip link help - display help |
856 | ||
857 | .PP | |
858 | .I "TYPE" | |
859 | specifies which help of link type to dislpay. | |
860 | ||
032b4f4d VK |
861 | .SS |
862 | .I GROUP | |
863 | may be a number or a string from the file | |
699589f6 | 864 | .B @SYSCONFDIR@/group |
032b4f4d VK |
865 | which can be manually filled. |
866 | ||
761a1e60 CT |
867 | .SH "EXAMPLES" |
868 | .PP | |
869 | ip link show | |
870 | .RS 4 | |
871 | Shows the state of all network interfaces on the system. | |
872 | .RE | |
873 | .PP | |
712249d8 VK |
874 | ip link show type bridge |
875 | .RS 4 | |
876 | Shows the bridge devices. | |
877 | .RE | |
878 | .PP | |
879 | ip link show type vlan | |
880 | .RS 4 | |
881 | Shows the vlan devices. | |
882 | .RE | |
883 | .PP | |
417b2180 VK |
884 | ip link show master br0 |
885 | .RS 4 | |
886 | Shows devices enslaved by br0 | |
887 | .RE | |
888 | .PP | |
761a1e60 CT |
889 | ip link set dev ppp0 mtu 1400 |
890 | .RS 4 | |
891 | Change the MTU the ppp0 device. | |
892 | .RE | |
893 | .PP | |
894 | ip link add link eth0 name eth0.10 type vlan id 10 | |
895 | .RS 4 | |
896 | Creates a new vlan device eth0.10 on device eth0. | |
897 | .RE | |
898 | .PP | |
899 | ip link delete dev eth0.10 | |
900 | .RS 4 | |
901 | Removes vlan device. | |
902 | .RE | |
903 | ||
1f299e92 | 904 | ip link help gre |
905 | .RS 4 | |
906 | Display help for the gre link type. | |
90f1df71 TH |
907 | .RE |
908 | .PP | |
909 | ip link add name tun1 type ipip remote 192.168.1.1 | |
910 | local 192.168.1.2 ttl 225 encap gue encap-sport auto | |
911 | encap-dport 5555 encap-csum encap-remcsum | |
912 | .RS 4 | |
913 | Creates an IPIP that is encapsulated with Generic UDP Encapsulation, | |
914 | and the outer UDP checksum and remote checksum offload are enabled. | |
915 | ||
2c0feda8 LB |
916 | .RE |
917 | .PP | |
918 | ip link add link wpan0 lowpan0 type lowpan | |
919 | .RS 4 | |
920 | Creates a 6LoWPAN interface named lowpan0 on the underlying | |
921 | IEEE 802.15.4 device wpan0. | |
1f299e92 | 922 | .RE |
923 | ||
761a1e60 CT |
924 | .SH SEE ALSO |
925 | .br | |
d5910297 VK |
926 | .BR ip (8), |
927 | .BR ip-netns (8) | |
761a1e60 CT |
928 | |
929 | .SH AUTHOR | |
930 | Original Manpage by Michail Litvak <mci@owl.openwall.com> |