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\-s\fR[\fItatistics\fR] |
20 \fB\-r\fR[\fIesolve\fR] |
21 \fB\-f\fR[\fIamily\fR] {
22 .BR inet " | " inet6 " | " ipx " | " dnet " | " link " } | "
23 \fB\-o\fR[\fIneline\fR] }
76 .BI "ip link delete " DEVICE
84 .RB "} { " up " | " down " | " arp " { " on " | " off " } |"
86 .BR promisc " { " on " | " off " } |"
88 .BR allmulticast " { " on " | " off " } |"
90 .BR dynamic " { " on " | " off " } |"
92 .BR multicast " { " on " | " off " } |"
124 .IR VLAN-QOS " ] ] ["
131 .B spoofchk { on | off } ] [
132 .B state { auto | enable | disable}
144 .RI "[ " DEVICE " | "
149 .SS ip link add - add virtual link
153 specifies the physical device to act operate on.
156 specifies the name of the new virtual device.
159 specifies the type of the new device.
165 - Ethernet Bridge device
171 - Dummy network interface
174 - Intermediate Functional Block device
177 - IP over Infiniband device
180 - Virtual interface base on link layer address (MAC)
183 - Virtual Controller Area Network interface
186 - Virtual ethernet interface
189 - 802.1q tagged virtual LAN interface
192 - Virtual eXtended LAN
195 - Virtual tunnel interface IPv4|IPv6 over IPv6
198 - Virtual tunnel interface IPv4 over IPv4
201 - Virtual tunnel interface IPv6 over IPv4
204 - Virtual tunnel interface GRE over IPv4
207 - Virtual L2 tuunel interface GRE over IPv4
210 - Virtual tuunel interface GRE over IPv6
213 - Virtual L2 tuunel interface GRE over IPv6
217 .BI numtxqueues " QUEUE_COUNT "
218 specifies the number of transmit queues for new device.
221 .BI numrxqueues " QUEUE_COUNT "
222 specifies the number of receive queues for new device.
226 specifies the desired index of the new virtual device. The link creation fails, if the index is busy.
232 the following additional arguments are supported:
234 .BI "ip link add " DEVICE
235 .BI type " vxlan " id " ID
238 .RB " ] [ { " group " | " remote " } "
263 - specifies the VXLAN Network Identifer (or VXLAN Segment
267 - specifies the physical device to use for tunnel endpoint communication.
271 - specifies the multicast IP address to join.
272 This parameter cannot be specified with the
278 - specifies the unicast destination IP address to use in outgoing packets
279 when the destination link layer address is not known in the VXLAN device
280 forwarding database. This parameter cannot be specified with the
286 - specifies the source IP address to use in outgoing packets.
290 - specifies the TTL value to use in outgoing packets.
294 - specifies the TOS value to use in outgoing packets.
298 - specifies the range of port numbers to use as UDP
299 source ports to communicate to the remote VXLAN tunnel endpoint.
303 - specifies if unknown source link layer addresses and IP addresses
304 are entered into the VXLAN device forwarding database.
308 - specifies if route short circuit is turned on.
312 - specifies ARP proxy is turned on.
316 - specifies if netlink LLADDR miss notifications are generated.
320 - specifies if netlink IP ADDR miss notifications are generated.
325 IP6GRE/IP6GRETAP Type Support
328 the following additional arguments are supported:
330 .BI "ip link add " DEVICE
331 .BI type " { ip6gre | ip6gretap } " remote " ADDR " local " ADDR
341 .BI encaplimit " ELIM "
343 .BI tclass " TCLASS "
345 .BI flowlabel " FLOWLABEL "
355 - specifies the remote IPv6 address of the tunnel.
359 - specifies the fixed local IPv6 address for tunneled packets.
360 It must be and address on another interface on this host.
367 flag enables sequencing of outgoing packets.
370 flag requires that all input packets are serialized.
374 - use keyed GRE with key
376 is either a number or an IPv4 address-like dotted quad.
379 parameter specifies the same key to use in both directions.
381 .BR ikey " and " okey
382 parameters specify different keys for input and output.
386 - generate/require checksums for tunneled packets.
389 flag calculates checksums for outgoing packets.
392 flag requires that all input packets have the correct
395 flag is equivalent to the combination
400 - specifies Hop Limit value to use in outgoing packets.
403 .BI encaplimit " ELIM"
404 - specifies a fixed encapsulation limit. Default is 4.
407 .BI flowlabel " FLOWLABEL"
408 - specifies a fixed flowlabel.
412 - specifies the traffic class field on
413 tunneled packets, which can be specified as either a two-digit
414 hex value (e.g. c0) or a predefined string (e.g. internet).
417 causes the field to be copied from the original IP header. The
419 .BI "inherit/" STRING
421 .BI "inherit/" 00 ".." ff
422 will set the field to
426 when tunneling non-IP packets. The default value is 00.
430 .SS ip link delete - delete virtual link
432 specifies the virtual device to act operate on.
434 specifies the type of the device.
439 specifies the physical device to act operate on.
441 .SS ip link set - change device attributes
446 specifies network device to operate on. When configuring SR-IOV Virtual Function
447 (VF) devices, this keyword should specify the associated Physical Function (PF)
453 has a dual role: If both group and dev are present, then move the device to the
454 specified group. If only a group is specified, then the command operates on
455 all devices in that group.
459 change the state of the device to
465 .BR "arp on " or " arp off"
471 .BR "multicast on " or " multicast off"
477 .BR "dynamic on " or " dynamic off"
484 change the name of the device. This operation is not
485 recommended if the device is running or has some addresses
489 .BI txqueuelen " NUMBER"
492 change the transmit queue length of the device.
501 .BI address " LLADDRESS"
502 change the station address of the interface.
505 .BI broadcast " LLADDRESS"
509 .BI peer " LLADDRESS"
510 change the link layer broadcast address or the peer address when
516 move the device to the network namespace associated with the process
520 .BI netns " NETNSNAME"
521 move the device to the network namespace associated with name
526 give the device a symbolic name for easy reference.
530 specify the group the device belongs to.
531 The available groups are listed in file
532 .BR "@SYSCONFDIR@/group" .
536 specify a Virtual Function device to be configured. The associated PF device
537 must be specified using the
543 - change the station address for the specified VF. The
545 parameter must be specified.
549 - change the assigned VLAN for the specified VF. When specified, all traffic
550 sent from the VF will be tagged with the specified VLAN ID. Incoming traffic
551 will be filtered for the specified VLAN ID, and will have all VLAN tags
552 stripped before being passed to the VF. Setting this parameter to 0 disables
553 VLAN tagging and filtering. The
555 parameter must be specified.
559 - assign VLAN QOS (priority) bits for the VLAN tag. When specified, all VLAN
560 tags transmitted by the VF will include the specified priority bits in the
561 VLAN tag. If not specified, the value is assumed to be 0. Both the
565 parameters must be specified. Setting both
569 as 0 disables VLAN tagging and filtering for the VF.
573 -- change the allowed transmit bandwidth, in Mbps, for the specified VF.
574 Setting this parameter to 0 disables rate limiting.
576 parameter must be specified.
582 .BI max_tx_rate " TXRATE"
583 - change the allowed maximum transmit bandwidth, in Mbps, for the specified VF.
585 parameter must be specified.
588 .BI min_tx_rate " TXRATE"
589 - change the allowed minimum transmit bandwidth, in Mbps, for the specified VF.
590 Minimum TXRATE should be always <= Maximum TXRATE.
592 parameter must be specified.
595 .BI spoofchk " on|off"
596 - turn packet spoof checking on or off for the specified VF.
598 .BI state " auto|enable|disable"
599 - set the virtual link state as seen by the specified VF. Setting to auto means a
600 reflection of the PF link state, enable lets the VF to communicate with other VFs on
601 this host even if the PF link state is down, disable causes the HW to drop any packets
607 set master device of the device (enslave device).
611 unset master device of the device (release device).
615 If multiple parameter changes are requested,
617 aborts immediately after any of the changes have failed.
618 This is the only case when
620 can move the system to an unpredictable state. The solution
621 is to avoid changing several parameters with one
625 .SS ip link show - display device attributes
628 .BI dev " NAME " (default)
630 specifies the network device to show.
631 If this argument is omitted all devices in the default group are listed.
636 specifies what group of devices to show.
640 only display running interfaces.
646 Shows the state of all network interfaces on the system.
649 ip link set dev ppp0 mtu 1400
651 Change the MTU the ppp0 device.
654 ip link add link eth0 name eth0.10 type vlan id 10
656 Creates a new vlan device eth0.10 on device eth0.
659 ip link delete dev eth0.10
669 Original Manpage by Michail Litvak <mci@owl.openwall.com>