.ti -8
.IR OPTIONS " := { "
\fB\-V\fR[\fIersion\fR] |
+\fB\-h\fR[\fIuman-readable\fR] |
\fB\-s\fR[\fItatistics\fR] |
\fB\-r\fR[\fIesolve\fR] |
\fB\-f\fR[\fIamily\fR] {
.br
.RB "[ " mtu
.IR MTU " ]"
+.RB "[ " index
+.IR IDX " ]"
.br
.RB "[ " numtxqueues
.IR QUEUE_COUNT " ]"
.ti -8
.IR TYPE " := [ "
.BR bridge " | "
+.BR bond " | "
.BR can " | "
.BR dummy " | "
+.BR hsr " | "
.BR ifb " | "
.BR ipoib " |"
.BR macvlan " | "
+.BR macvtap " | "
.BR vcan " | "
.BR veth " | "
.BR vlan " | "
.IR VLAN-QOS " ] ] ["
.B rate
.IR TXRATE " ] ["
-.B spoofchk { on | off }
+.B max_tx_rate
+.IR TXRATE " ] ["
+.B min_tx_rate
+.IR TXRATE " ] ["
+.B spoofchk { on | off } ] [
+.B state { auto | enable | disable}
] |
.br
.B master
.B ip link show
.RI "[ " DEVICE " | "
.B group
-.IR GROUP " ]"
+.IR GROUP " | "
+.BR up " | "
+.B master
+.IR DEVICE " | "
+.B type
+.IR TYPE " ]"
+
+.ti -8
+.B ip link help
+.RI "[ " TYPE " ]"
.SH "DESCRIPTION"
.SS ip link add - add virtual link
.B bridge
- Ethernet Bridge device
.sp
-.B can
-- Controller Area Network interface
+.B bond
+- Bonding device
.sp
.B dummy
- Dummy network interface
.sp
+.B hsr
+- High-availability Seamless Redundancy device
+.sp
.B ifb
- Intermediate Functional Block device
.sp
.B macvlan
- Virtual interface base on link layer address (MAC)
.sp
+.B macvtap
+- Virtual interface based on link layer address (MAC) and TAP.
+.sp
.B vcan
-- Virtual Local CAN interface
+- Virtual Controller Area Network interface
.sp
.B veth
- Virtual ethernet interface
- Virtual tunnel interface GRE over IPv4
.sp
.BR gretap
-- Virtual L2 tuunel interface GRE over IPv4
+- Virtual L2 tunnel interface GRE over IPv4
.sp
.BR ip6gre
-- Virtual tuunel interface GRE over IPv6
+- Virtual tunnel interface GRE over IPv6
.sp
.BR ip6gretap
-- Virtual L2 tuunel interface GRE over IPv6
+- Virtual L2 tunnel interface GRE over IPv6
.in -8
.TP
.BI numrxqueues " QUEUE_COUNT "
specifies the number of receive queues for new device.
+.TP
+.BI index " IDX "
+specifies the desired index of the new virtual device. The link creation fails, if the index is busy.
+
.TP
VXLAN Type Support
-For a link of type
+For a link of type
.I VXLAN
the following additional arguments are supported:
.BI "ip link add " DEVICE
-.BI type " vxlan " id " ID
+.BI type " vxlan " id " ID"
.R " [ "
.BI dev " PHYS_DEV "
.RB " ] [ { " group " | " remote " } "
.I "[no]l2miss "
.R " ] [ "
.I "[no]l3miss "
+.R " ] [ "
+.BI ageing " SECONDS "
+.R " ] [ "
+.BI maxaddress " NUMBER "
.R " ]"
.in +8
.I [no]l3miss
- specifies if netlink IP ADDR miss notifications are generated.
+.sp
+.BI ageing " SECONDS"
+- specifies the lifetime in seconds of FDB entries learnt by the kernel.
+
+.sp
+.BI maxaddress " NUMBER"
+- specifies the maximum number of FDB entries.
+
.in -8
.TP
IP6GRE/IP6GRETAP Type Support
-For a link of type
+For a link of type
.I IP6GRE/IP6GRETAP
the following additional arguments are supported:
.sp
.BI flowlabel " FLOWLABEL"
-- specifies a fixed flowlabel.
+- specifies a fixed flowlabel.
.sp
.BI tclass " TCLASS"
.in -8
+.TP
+IPoIB Type Support
+For a link of type
+.I IPoIB
+the following additional arguments are supported:
+
+.BI "ip link add " DEVICE " name " NAME
+.BI type " ipoib [ " pkey " PKEY ] [" mode " MODE " ]
+
+.in +8
+.sp
+.BI pkey " PKEY "
+- specifies the IB P-Key to use.
+
+.BI mode " MODE "
+- specifies the mode (datagram or connected) to use.
+
.SS ip link delete - delete virtual link
.I DEVICE
specifies the virtual device to act operate on.
.sp
.BI rate " TXRATE"
-- change the allowed transmit bandwidth, in Mbps, for the specified VF.
-Setting this parameter to 0 disables rate limiting. The
+-- change the allowed transmit bandwidth, in Mbps, for the specified VF.
+Setting this parameter to 0 disables rate limiting.
+.B vf
+parameter must be specified.
+Please use new API
+.B "max_tx_rate"
+option instead.
+
+.sp
+.BI max_tx_rate " TXRATE"
+- change the allowed maximum transmit bandwidth, in Mbps, for the specified VF.
+.B vf
+parameter must be specified.
+
+.sp
+.BI min_tx_rate " TXRATE"
+- change the allowed minimum transmit bandwidth, in Mbps, for the specified VF.
+Minimum TXRATE should be always <= Maximum TXRATE.
.B vf
parameter must be specified.
.sp
.BI spoofchk " on|off"
- turn packet spoof checking on or off for the specified VF.
+.sp
+.BI state " auto|enable|disable"
+- set the virtual link state as seen by the specified VF. Setting to auto means a
+reflection of the PF link state, enable lets the VF to communicate with other VFs on
+this host even if the PF link state is down, disable causes the HW to drop any packets
+sent by the VF.
.in -8
.TP
.B up
only display running interfaces.
+.TP
+.BI master " DEVICE "
+.I DEVICE
+specifies the master device which enslaves devices to show.
+
+.TP
+.BI type " TYPE "
+.I TYPE
+specifies the type of devices to show.
+
+.TP
+The show command has additional formatting options:
+
+.RS
+.TP
+.BR "\-s" , " \-stats", " \-statistics"
+output more statistics about packet usage.
+
+.TP
+.BR "\-d", " \-details"
+output more detailed information.
+
+.TP
+.BR "\-h", " \-human", " \-human-readble"
+output statistics with human readable values number followed by suffix
+
+.TP
+.BR "\-iec"
+print human readable rates in IEC units (ie. 1K = 1024).
+.RE
+
+.SS ip link help - display help
+
+.PP
+.I "TYPE"
+specifies which help of link type to dislpay.
+
.SH "EXAMPLES"
.PP
ip link show
Shows the state of all network interfaces on the system.
.RE
.PP
+ip link show type bridge
+.RS 4
+Shows the bridge devices.
+.RE
+.PP
+ip link show type vlan
+.RS 4
+Shows the vlan devices.
+.RE
+.PP
+ip link show master br0
+.RS 4
+Shows devices enslaved by br0
+.RE
+.PP
ip link set dev ppp0 mtu 1400
.RS 4
Change the MTU the ppp0 device.
Removes vlan device.
.RE
+ip link help gre
+.RS 4
+Display help for the gre link type.
+.RE
+
.SH SEE ALSO
.br
.BR ip (8)
projects / mirror_iproute2.git / blobdiff