1 .TH IP\-LINK 8 "13 Dec 2012" "iproute2" "Linux"
3 ip-link \- network device configuration
12 .RI " { " COMMAND " | "
18 \fB\-V\fR[\fIersion\fR] |
19 \fB\-h\fR[\fIuman-readable\fR] |
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] }
78 .BI "ip link delete " DEVICE
86 .RB "} { " up " | " down " | " arp " { " on " | " off " } |"
88 .BR promisc " { " on " | " off " } |"
90 .BR allmulticast " { " on " | " off " } |"
92 .BR dynamic " { " on " | " off " } |"
94 .BR multicast " { " on " | " off " } |"
126 .IR VLAN-QOS " ] ] ["
133 .B spoofchk { on | off } ] [
134 .B state { auto | enable | disable}
146 .RI "[ " DEVICE " | "
158 .SS ip link add - add virtual link
162 specifies the physical device to act operate on.
165 specifies the name of the new virtual device.
168 specifies the type of the new device.
174 - Ethernet Bridge device
180 - Dummy network interface
183 - High-availability Seamless Redundancy device
186 - Intermediate Functional Block device
189 - IP over Infiniband device
192 - Virtual interface base on link layer address (MAC)
195 - Virtual interface based on link layer address (MAC) and TAP.
198 - Virtual Controller Area Network interface
201 - Virtual ethernet interface
204 - 802.1q tagged virtual LAN interface
207 - Virtual eXtended LAN
210 - Virtual tunnel interface IPv4|IPv6 over IPv6
213 - Virtual tunnel interface IPv4 over IPv4
216 - Virtual tunnel interface IPv6 over IPv4
219 - Virtual tunnel interface GRE over IPv4
222 - Virtual L2 tuunel interface GRE over IPv4
225 - Virtual tuunel interface GRE over IPv6
228 - Virtual L2 tuunel interface GRE over IPv6
232 .BI numtxqueues " QUEUE_COUNT "
233 specifies the number of transmit queues for new device.
236 .BI numrxqueues " QUEUE_COUNT "
237 specifies the number of receive queues for new device.
241 specifies the desired index of the new virtual device. The link creation fails, if the index is busy.
247 the following additional arguments are supported:
249 .BI "ip link add " DEVICE
250 .BI type " vxlan " id " ID"
253 .RB " ] [ { " group " | " remote " } "
274 .BI ageing " SECONDS "
276 .BI maxaddress " NUMBER "
282 - specifies the VXLAN Network Identifer (or VXLAN Segment
286 - specifies the physical device to use for tunnel endpoint communication.
290 - specifies the multicast IP address to join.
291 This parameter cannot be specified with the
297 - specifies the unicast destination IP address to use in outgoing packets
298 when the destination link layer address is not known in the VXLAN device
299 forwarding database. This parameter cannot be specified with the
305 - specifies the source IP address to use in outgoing packets.
309 - specifies the TTL value to use in outgoing packets.
313 - specifies the TOS value to use in outgoing packets.
317 - specifies the range of port numbers to use as UDP
318 source ports to communicate to the remote VXLAN tunnel endpoint.
322 - specifies if unknown source link layer addresses and IP addresses
323 are entered into the VXLAN device forwarding database.
327 - specifies if route short circuit is turned on.
331 - specifies ARP proxy is turned on.
335 - specifies if netlink LLADDR miss notifications are generated.
339 - specifies if netlink IP ADDR miss notifications are generated.
342 .BI ageing " SECONDS"
343 - specifies the lifetime in seconds of FDB entries learnt by the kernel.
346 .BI maxaddress " NUMBER"
347 - specifies the maximum number of FDB entries.
352 IP6GRE/IP6GRETAP Type Support
355 the following additional arguments are supported:
357 .BI "ip link add " DEVICE
358 .BI type " { ip6gre | ip6gretap } " remote " ADDR " local " ADDR
368 .BI encaplimit " ELIM "
370 .BI tclass " TCLASS "
372 .BI flowlabel " FLOWLABEL "
382 - specifies the remote IPv6 address of the tunnel.
386 - specifies the fixed local IPv6 address for tunneled packets.
387 It must be and address on another interface on this host.
394 flag enables sequencing of outgoing packets.
397 flag requires that all input packets are serialized.
401 - use keyed GRE with key
403 is either a number or an IPv4 address-like dotted quad.
406 parameter specifies the same key to use in both directions.
408 .BR ikey " and " okey
409 parameters specify different keys for input and output.
413 - generate/require checksums for tunneled packets.
416 flag calculates checksums for outgoing packets.
419 flag requires that all input packets have the correct
422 flag is equivalent to the combination
427 - specifies Hop Limit value to use in outgoing packets.
430 .BI encaplimit " ELIM"
431 - specifies a fixed encapsulation limit. Default is 4.
434 .BI flowlabel " FLOWLABEL"
435 - specifies a fixed flowlabel.
439 - specifies the traffic class field on
440 tunneled packets, which can be specified as either a two-digit
441 hex value (e.g. c0) or a predefined string (e.g. internet).
444 causes the field to be copied from the original IP header. The
446 .BI "inherit/" STRING
448 .BI "inherit/" 00 ".." ff
449 will set the field to
453 when tunneling non-IP packets. The default value is 00.
461 the following additional arguments are supported:
463 .BI "ip link add " DEVICE " name " NAME
464 .BI type " ipoib [ " pkey " PKEY ] [" mode " MODE " ]
469 - specifies the IB P-Key to use.
472 - specifies the mode (datagram or connected) to use.
474 .SS ip link delete - delete virtual link
476 specifies the virtual device to act operate on.
478 specifies the type of the device.
483 specifies the physical device to act operate on.
485 .SS ip link set - change device attributes
490 specifies network device to operate on. When configuring SR-IOV Virtual Function
491 (VF) devices, this keyword should specify the associated Physical Function (PF)
497 has a dual role: If both group and dev are present, then move the device to the
498 specified group. If only a group is specified, then the command operates on
499 all devices in that group.
503 change the state of the device to
509 .BR "arp on " or " arp off"
515 .BR "multicast on " or " multicast off"
521 .BR "dynamic on " or " dynamic off"
528 change the name of the device. This operation is not
529 recommended if the device is running or has some addresses
533 .BI txqueuelen " NUMBER"
536 change the transmit queue length of the device.
545 .BI address " LLADDRESS"
546 change the station address of the interface.
549 .BI broadcast " LLADDRESS"
553 .BI peer " LLADDRESS"
554 change the link layer broadcast address or the peer address when
560 move the device to the network namespace associated with the process
564 .BI netns " NETNSNAME"
565 move the device to the network namespace associated with name
570 give the device a symbolic name for easy reference.
574 specify the group the device belongs to.
575 The available groups are listed in file
576 .BR "@SYSCONFDIR@/group" .
580 specify a Virtual Function device to be configured. The associated PF device
581 must be specified using the
587 - change the station address for the specified VF. The
589 parameter must be specified.
593 - change the assigned VLAN for the specified VF. When specified, all traffic
594 sent from the VF will be tagged with the specified VLAN ID. Incoming traffic
595 will be filtered for the specified VLAN ID, and will have all VLAN tags
596 stripped before being passed to the VF. Setting this parameter to 0 disables
597 VLAN tagging and filtering. The
599 parameter must be specified.
603 - assign VLAN QOS (priority) bits for the VLAN tag. When specified, all VLAN
604 tags transmitted by the VF will include the specified priority bits in the
605 VLAN tag. If not specified, the value is assumed to be 0. Both the
609 parameters must be specified. Setting both
613 as 0 disables VLAN tagging and filtering for the VF.
617 -- change the allowed transmit bandwidth, in Mbps, for the specified VF.
618 Setting this parameter to 0 disables rate limiting.
620 parameter must be specified.
626 .BI max_tx_rate " TXRATE"
627 - change the allowed maximum transmit bandwidth, in Mbps, for the specified VF.
629 parameter must be specified.
632 .BI min_tx_rate " TXRATE"
633 - change the allowed minimum transmit bandwidth, in Mbps, for the specified VF.
634 Minimum TXRATE should be always <= Maximum TXRATE.
636 parameter must be specified.
639 .BI spoofchk " on|off"
640 - turn packet spoof checking on or off for the specified VF.
642 .BI state " auto|enable|disable"
643 - set the virtual link state as seen by the specified VF. Setting to auto means a
644 reflection of the PF link state, enable lets the VF to communicate with other VFs on
645 this host even if the PF link state is down, disable causes the HW to drop any packets
651 set master device of the device (enslave device).
655 unset master device of the device (release device).
659 If multiple parameter changes are requested,
661 aborts immediately after any of the changes have failed.
662 This is the only case when
664 can move the system to an unpredictable state. The solution
665 is to avoid changing several parameters with one
669 .SS ip link show - display device attributes
672 .BI dev " NAME " (default)
674 specifies the network device to show.
675 If this argument is omitted all devices in the default group are listed.
680 specifies what group of devices to show.
684 only display running interfaces.
687 .BI master " DEVICE "
689 specifies the master device which enslaves devices to show.
692 The show command has additional formatting options:
696 .BR "\-s" , " \-stats", " \-statistics"
697 output more statistics about packet usage.
700 .BR "\-d", " \-details"
701 output more detailed information.
704 .BR "\-h", " \-human", " \-human-readble"
705 output statistics with human readable values number followed by suffix
709 print human readable rates in IEC units (ie. 1K = 1024).
712 .SS ip link help - display help
716 specifies which help of link type to dislpay.
722 Shows the state of all network interfaces on the system.
725 ip link set dev ppp0 mtu 1400
727 Change the MTU the ppp0 device.
730 ip link add link eth0 name eth0.10 type vlan id 10
732 Creates a new vlan device eth0.10 on device eth0.
735 ip link delete dev eth0.10
742 Display help for the gre link type.
750 Original Manpage by Michail Litvak <mci@owl.openwall.com>