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