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 " | "
160 .SS ip link add - add virtual link
164 specifies the physical device to act operate on.
167 specifies the name of the new virtual device.
170 specifies the type of the new device.
176 - Ethernet Bridge device
182 - Dummy network interface
185 - High-availability Seamless Redundancy device
188 - Intermediate Functional Block device
191 - IP over Infiniband device
194 - Virtual interface base on link layer address (MAC)
197 - Virtual interface based on link layer address (MAC) and TAP.
200 - Virtual Controller Area Network interface
203 - Virtual ethernet interface
206 - 802.1q tagged virtual LAN interface
209 - Virtual eXtended LAN
212 - Virtual tunnel interface IPv4|IPv6 over IPv6
215 - Virtual tunnel interface IPv4 over IPv4
218 - Virtual tunnel interface IPv6 over IPv4
221 - Virtual tunnel interface GRE over IPv4
224 - Virtual L2 tuunel interface GRE over IPv4
227 - Virtual tuunel interface GRE over IPv6
230 - Virtual L2 tuunel interface GRE over IPv6
234 .BI numtxqueues " QUEUE_COUNT "
235 specifies the number of transmit queues for new device.
238 .BI numrxqueues " QUEUE_COUNT "
239 specifies the number of receive queues for new device.
243 specifies the desired index of the new virtual device. The link creation fails, if the index is busy.
249 the following additional arguments are supported:
251 .BI "ip link add " DEVICE
252 .BI type " vxlan " id " ID"
255 .RB " ] [ { " group " | " remote " } "
276 .BI ageing " SECONDS "
278 .BI maxaddress " NUMBER "
284 - specifies the VXLAN Network Identifer (or VXLAN Segment
288 - specifies the physical device to use for tunnel endpoint communication.
292 - specifies the multicast IP address to join.
293 This parameter cannot be specified with the
299 - specifies the unicast destination IP address to use in outgoing packets
300 when the destination link layer address is not known in the VXLAN device
301 forwarding database. This parameter cannot be specified with the
307 - specifies the source IP address to use in outgoing packets.
311 - specifies the TTL value to use in outgoing packets.
315 - specifies the TOS value to use in outgoing packets.
319 - specifies the range of port numbers to use as UDP
320 source ports to communicate to the remote VXLAN tunnel endpoint.
324 - specifies if unknown source link layer addresses and IP addresses
325 are entered into the VXLAN device forwarding database.
329 - specifies if route short circuit is turned on.
333 - specifies ARP proxy is turned on.
337 - specifies if netlink LLADDR miss notifications are generated.
341 - specifies if netlink IP ADDR miss notifications are generated.
344 .BI ageing " SECONDS"
345 - specifies the lifetime in seconds of FDB entries learnt by the kernel.
348 .BI maxaddress " NUMBER"
349 - specifies the maximum number of FDB entries.
354 IP6GRE/IP6GRETAP Type Support
357 the following additional arguments are supported:
359 .BI "ip link add " DEVICE
360 .BI type " { ip6gre | ip6gretap } " remote " ADDR " local " ADDR
370 .BI encaplimit " ELIM "
372 .BI tclass " TCLASS "
374 .BI flowlabel " FLOWLABEL "
384 - specifies the remote IPv6 address of the tunnel.
388 - specifies the fixed local IPv6 address for tunneled packets.
389 It must be and address on another interface on this host.
396 flag enables sequencing of outgoing packets.
399 flag requires that all input packets are serialized.
403 - use keyed GRE with key
405 is either a number or an IPv4 address-like dotted quad.
408 parameter specifies the same key to use in both directions.
410 .BR ikey " and " okey
411 parameters specify different keys for input and output.
415 - generate/require checksums for tunneled packets.
418 flag calculates checksums for outgoing packets.
421 flag requires that all input packets have the correct
424 flag is equivalent to the combination
429 - specifies Hop Limit value to use in outgoing packets.
432 .BI encaplimit " ELIM"
433 - specifies a fixed encapsulation limit. Default is 4.
436 .BI flowlabel " FLOWLABEL"
437 - specifies a fixed flowlabel.
441 - specifies the traffic class field on
442 tunneled packets, which can be specified as either a two-digit
443 hex value (e.g. c0) or a predefined string (e.g. internet).
446 causes the field to be copied from the original IP header. The
448 .BI "inherit/" STRING
450 .BI "inherit/" 00 ".." ff
451 will set the field to
455 when tunneling non-IP packets. The default value is 00.
463 the following additional arguments are supported:
465 .BI "ip link add " DEVICE " name " NAME
466 .BI type " ipoib [ " pkey " PKEY ] [" mode " MODE " ]
471 - specifies the IB P-Key to use.
474 - specifies the mode (datagram or connected) to use.
476 .SS ip link delete - delete virtual link
478 specifies the virtual device to act operate on.
480 specifies the type of the device.
485 specifies the physical device to act operate on.
487 .SS ip link set - change device attributes
492 specifies network device to operate on. When configuring SR-IOV Virtual Function
493 (VF) devices, this keyword should specify the associated Physical Function (PF)
499 has a dual role: If both group and dev are present, then move the device to the
500 specified group. If only a group is specified, then the command operates on
501 all devices in that group.
505 change the state of the device to
511 .BR "arp on " or " arp off"
517 .BR "multicast on " or " multicast off"
523 .BR "dynamic on " or " dynamic off"
530 change the name of the device. This operation is not
531 recommended if the device is running or has some addresses
535 .BI txqueuelen " NUMBER"
538 change the transmit queue length of the device.
547 .BI address " LLADDRESS"
548 change the station address of the interface.
551 .BI broadcast " LLADDRESS"
555 .BI peer " LLADDRESS"
556 change the link layer broadcast address or the peer address when
562 move the device to the network namespace associated with the process
566 .BI netns " NETNSNAME"
567 move the device to the network namespace associated with name
572 give the device a symbolic name for easy reference.
576 specify the group the device belongs to.
577 The available groups are listed in file
578 .BR "@SYSCONFDIR@/group" .
582 specify a Virtual Function device to be configured. The associated PF device
583 must be specified using the
589 - change the station address for the specified VF. The
591 parameter must be specified.
595 - change the assigned VLAN for the specified VF. When specified, all traffic
596 sent from the VF will be tagged with the specified VLAN ID. Incoming traffic
597 will be filtered for the specified VLAN ID, and will have all VLAN tags
598 stripped before being passed to the VF. Setting this parameter to 0 disables
599 VLAN tagging and filtering. The
601 parameter must be specified.
605 - assign VLAN QOS (priority) bits for the VLAN tag. When specified, all VLAN
606 tags transmitted by the VF will include the specified priority bits in the
607 VLAN tag. If not specified, the value is assumed to be 0. Both the
611 parameters must be specified. Setting both
615 as 0 disables VLAN tagging and filtering for the VF.
619 -- change the allowed transmit bandwidth, in Mbps, for the specified VF.
620 Setting this parameter to 0 disables rate limiting.
622 parameter must be specified.
628 .BI max_tx_rate " TXRATE"
629 - change the allowed maximum transmit bandwidth, in Mbps, for the specified VF.
631 parameter must be specified.
634 .BI min_tx_rate " TXRATE"
635 - change the allowed minimum transmit bandwidth, in Mbps, for the specified VF.
636 Minimum TXRATE should be always <= Maximum TXRATE.
638 parameter must be specified.
641 .BI spoofchk " on|off"
642 - turn packet spoof checking on or off for the specified VF.
644 .BI state " auto|enable|disable"
645 - set the virtual link state as seen by the specified VF. Setting to auto means a
646 reflection of the PF link state, enable lets the VF to communicate with other VFs on
647 this host even if the PF link state is down, disable causes the HW to drop any packets
653 set master device of the device (enslave device).
657 unset master device of the device (release device).
661 If multiple parameter changes are requested,
663 aborts immediately after any of the changes have failed.
664 This is the only case when
666 can move the system to an unpredictable state. The solution
667 is to avoid changing several parameters with one
671 .SS ip link show - display device attributes
674 .BI dev " NAME " (default)
676 specifies the network device to show.
677 If this argument is omitted all devices in the default group are listed.
682 specifies what group of devices to show.
686 only display running interfaces.
689 .BI master " DEVICE "
691 specifies the master device which enslaves devices to show.
696 specifies the type of devices to show.
699 The show command has additional formatting options:
703 .BR "\-s" , " \-stats", " \-statistics"
704 output more statistics about packet usage.
707 .BR "\-d", " \-details"
708 output more detailed information.
711 .BR "\-h", " \-human", " \-human-readble"
712 output statistics with human readable values number followed by suffix
716 print human readable rates in IEC units (ie. 1K = 1024).
719 .SS ip link help - display help
723 specifies which help of link type to dislpay.
729 Shows the state of all network interfaces on the system.
732 ip link show type bridge
734 Shows the bridge devices.
737 ip link show type vlan
739 Shows the vlan devices.
742 ip link show master br0
744 Shows devices enslaved by br0
747 ip link set dev ppp0 mtu 1400
749 Change the MTU the ppp0 device.
752 ip link add link eth0 name eth0.10 type vlan id 10
754 Creates a new vlan device eth0.10 on device eth0.
757 ip link delete dev eth0.10
764 Display help for the gre link type.
772 Original Manpage by Michail Litvak <mci@owl.openwall.com>