man/man8/ip-link.8.in

   1 .TH IP\-LINK 8 "13 Dec 2012" "iproute2" "Linux"
   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] |
  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] }
  24
  25 .ti -8
  26 .BI "ip link add"
  27 .RB "[ " link
  28 .IR DEVICE " ]"
  29 .RB "[ " name " ]"
  30 .I NAME
  31 .br
  32 .RB "[ " txqueuelen
  33 .IR PACKETS " ]"
  34 .br
  35 .RB "[ " address
  36 .IR LLADDR " ]"
  37 .RB "[ " broadcast
  38 .IR LLADDR " ]"
  39 .br
  40 .RB "[ " mtu
  41 .IR MTU " ]"
  42 .br
  43 .RB "[ " numtxqueues
  44 .IR QUEUE_COUNT " ]"
  45 .RB "[ " numrxqueues
  46 .IR QUEUE_COUNT " ]"
  47 .br
  48 .BR type " TYPE"
  49 .RI "[ " ARGS " ]"
  50
  51 .ti -8
  52 .IR TYPE " := [ "
  53 .BR bridge " | "
  54 .BR can " | "
  55 .BR dummy " | "
  56 .BR ifb " | "
  57 .BR ipoib " |"
  58 .BR macvlan  " | "
  59 .BR vcan " | "
  60 .BR veth " | "
  61 .BR vlan " | "
  62 .BR vxlan " |"
  63 .BR ip6tnl " |"
  64 .BR ipip " |"
  65 .BR sit " ]"
  66
  67 .ti -8
  68 .BI "ip link delete " DEVICE
  69 .BI type " TYPE"
  70 .RI "[ " ARGS " ]"
  71
  72 .ti -8
  73 .BR "ip link set " {
  74 .IR DEVICE " | "
  75 .BI "group " GROUP
  76 .RB "} { " up " | " down " | " arp " { " on " | " off " } |"
  77 .br
  78 .BR promisc " { " on " | " off " } |"
  79 .br
  80 .BR allmulticast " { " on " | " off " } |"
  81 .br
  82 .BR dynamic " { " on " | " off " } |"
  83 .br
  84 .BR multicast " { " on " | " off " } |"
  85 .br
  86 .B  txqueuelen
  87 .IR PACKETS " |"
  88 .br
  89 .B  name
  90 .IR NEWNAME " |"
  91 .br
  92 .B  address
  93 .IR LLADDR " |"
  94 .B  broadcast
  95 .IR LLADDR " |"
  96 .br
  97 .B  mtu
  98 .IR MTU " |"
  99 .br
 100 .B  netns
 101 .IR PID " |"
 102 .br
 103 .B  netns
 104 .IR NETNSNAME " |"
 105 .br
 106 .B alias
 107 .IR NAME  " |"
 108 .br
 109 .B vf
 110 .IR NUM " ["
 111 .B  mac
 112 .IR LLADDR " ] ["
 113 .B vlan
 114 .IR VLANID " [ "
 115 .B qos
 116 .IR VLAN-QOS " ] ] ["
 117 .B rate
 118 .IR TXRATE " ] ["
 119 .B spoofchk { on | off }
 120 ] |
 121 .br
 122 .B master
 123 .IR DEVICE
 124 .br
 125 .B nomaster
 126 .BR " }"
 127
 128
 129 .ti -8
 130 .B ip link show
 131 .RI "[ " DEVICE " | "
 132 .B group
 133 .IR GROUP " ]"
 134
 135 .SH "DESCRIPTION"
 136 .SS ip link add - add virtual link
 137
 138 .TP
 139 .BI link " DEVICE "
 140 specifies the physical device to act operate on.
 141
 142 .I NAME
 143 specifies the name of the new virtual device.
 144
 145 .I TYPE
 146 specifies the type of the new device.
 147 .sp
 148 Link types:
 149
 150 .in +8
 151 .B bridge
 152 - Ethernet Bridge device
 153 .sp
 154 .B can
 155 - Controller Area Network interface
 156 .sp
 157 .B dummy
 158 - Dummy network interface
 159 .sp
 160 .B ifb
 161 - Intermediate Functional Block device
 162 .sp
 163 .B ipoib
 164 - IP over Infiniband device
 165 .sp
 166 .B macvlan
 167 - Virtual interface base on link layer address (MAC)
 168 .sp
 169 .B vcan
 170 - Virtual Local CAN interface
 171 .sp
 172 .B veth
 173 - Virtual ethernet interface
 174 .sp
 175 .BR vlan
 176 - 802.1q tagged virtual LAN interface
 177 .sp
 178 .BR vxlan
 179 - Virtual eXtended LAN
 180 .sp
 181 .BR ip6tnl
 182 - Virtual tunnel interface IPv4|IPv6 over IPv6
 183 .sp
 184 .BR ipip
 185 - Virtual tunnel interface IPv4 over IPv4
 186 .sp
 187 .BR sit
 188 - Virtual tunnel interface IPv6 over IPv4
 189 .in -8
 190
 191 .TP
 192 .BI numtxqueues " QUEUE_COUNT "
 193 specifies the number of transmit queues for new device.
 194
 195 .TP
 196 .BI numrxqueues " QUEUE_COUNT "
 197 specifies the number of receive queues for new device.
 198
 199 .SS ip link delete - delete virtual link
 200 .I DEVICE
 201 specifies the virtual  device to act operate on.
 202 .I TYPE
 203 specifies the type of the device.
 204
 205
 206 .TP
 207 .BI dev " DEVICE "
 208 specifies the physical device to act operate on.
 209
 210 .SS ip link set - change device attributes
 211
 212 .TP
 213 .BI dev " DEVICE "
 214 .I DEVICE
 215 specifies network device to operate on. When configuring SR-IOV Virtual Function
 216 (VF) devices, this keyword should specify the associated Physical Function (PF)
 217 device.
 218
 219 .TP
 220 .BI group " GROUP "
 221 .I GROUP
 222 has a dual role: If both group and dev are present, then move the device to the
 223 specified group.  If only a group is specified, then the command operates on
 224 all devices in that group.
 225
 226 .TP
 227 .BR up " and " down
 228 change the state of the device to
 229 .B UP
 230 or
 231 .BR "DOWN" .
 232
 233 .TP
 234 .BR "arp on " or " arp off"
 235 change the
 236 .B NOARP
 237 flag on the device.
 238
 239 .TP
 240 .BR "multicast on " or " multicast off"
 241 change the
 242 .B MULTICAST
 243 flag on the device.
 244
 245 .TP
 246 .BR "dynamic on " or " dynamic off"
 247 change the
 248 .B DYNAMIC
 249 flag on the device.
 250
 251 .TP
 252 .BI name " NAME"
 253 change the name of the device.  This operation is not
 254 recommended if the device is running or has some addresses
 255 already configured.
 256
 257 .TP
 258 .BI txqueuelen " NUMBER"
 259 .TP
 260 .BI txqlen " NUMBER"
 261 change the transmit queue length of the device.
 262
 263 .TP
 264 .BI mtu " NUMBER"
 265 change the
 266 .I MTU
 267 of the device.
 268
 269 .TP
 270 .BI address " LLADDRESS"
 271 change the station address of the interface.
 272
 273 .TP
 274 .BI broadcast " LLADDRESS"
 275 .TP
 276 .BI brd " LLADDRESS"
 277 .TP
 278 .BI peer " LLADDRESS"
 279 change the link layer broadcast address or the peer address when
 280 the interface is
 281 .IR "POINTOPOINT" .
 282
 283 .TP
 284 .BI netns " PID"
 285 move the device to the network namespace associated with the process
 286 .IR "PID".
 287
 288 .TP
 289 .BI netns " NETNSNAME"
 290 move the device to the network namespace associated with name
 291 .IR "NETNSNAME".
 292
 293 .TP
 294 .BI alias " NAME"
 295 give the device a symbolic name for easy reference.
 296
 297 .TP
 298 .BI group " GROUP"
 299 specify the group the device belongs to.
 300 The available groups are listed in file
 301 .BR "@SYSCONFDIR@/group" .
 302
 303 .TP
 304 .BI vf " NUM"
 305 specify a Virtual Function device to be configured. The associated PF device
 306 must be specified using the
 307 .B dev
 308 parameter.
 309
 310 .in +8
 311 .BI mac " LLADDRESS"
 312 - change the station address for the specified VF. The
 313 .B vf
 314 parameter must be specified.
 315
 316 .sp
 317 .BI vlan " VLANID"
 318 - change the assigned VLAN for the specified VF. When specified, all traffic
 319 sent from the VF will be tagged with the specified VLAN ID. Incoming traffic
 320 will be filtered for the specified VLAN ID, and will have all VLAN tags
 321 stripped before being passed to the VF. Setting this parameter to 0 disables
 322 VLAN tagging and filtering. The
 323 .B vf
 324 parameter must be specified.
 325
 326 .sp
 327 .BI qos " VLAN-QOS"
 328 - assign VLAN QOS (priority) bits for the VLAN tag. When specified, all VLAN
 329 tags transmitted by the VF will include the specified priority bits in the
 330 VLAN tag. If not specified, the value is assumed to be 0. Both the
 331 .B vf
 332 and
 333 .B vlan
 334 parameters must be specified. Setting both
 335 .B vlan
 336 and
 337 .B qos
 338 as 0 disables VLAN tagging and filtering for the VF.
 339
 340 .sp
 341 .BI rate " TXRATE"
 342 - change the allowed transmit bandwidth, in Mbps, for the specified VF.
 343 Setting this parameter to 0 disables rate limiting. The
 344 .B vf
 345 parameter must be specified.
 346
 347 .sp
 348 .BI spoofchk " on|off"
 349 - turn packet spoof checking on or off for the specified VF.
 350 .in -8
 351
 352 .TP
 353 .BI master " DEVICE"
 354 set master device of the device (enslave device).
 355
 356 .TP
 357 .BI nomaster
 358 unset master device of the device (release device).
 359
 360 .PP
 361 .B Warning:
 362 If multiple parameter changes are requested,
 363 .B ip
 364 aborts immediately after any of the changes have failed.
 365 This is the only case when
 366 .B ip
 367 can move the system to an unpredictable state.  The solution
 368 is to avoid changing several parameters with one
 369 .B ip link set
 370 call.
 371
 372 .SS  ip link show - display device attributes
 373
 374 .TP
 375 .BI dev " NAME " (default)
 376 .I NAME
 377 specifies the network device to show.
 378 If this argument is omitted all devices in the default group are listed.
 379
 380 .TP
 381 .BI group " GROUP "
 382 .I GROUP
 383 specifies what group of devices to show.
 384
 385 .TP
 386 .B up
 387 only display running interfaces.
 388
 389 .SH "EXAMPLES"
 390 .PP
 391 ip link show
 392 .RS 4
 393 Shows the state of all network interfaces on the system.
 394 .RE
 395 .PP
 396 ip link set dev ppp0 mtu 1400
 397 .RS 4
 398 Change the MTU the ppp0 device.
 399 .RE
 400 .PP
 401 ip link add link eth0 name eth0.10 type vlan id 10
 402 .RS 4
 403 Creates a new vlan device eth0.10 on device eth0.
 404 .RE
 405 .PP
 406 ip link delete dev eth0.10
 407 .RS 4
 408 Removes vlan device.
 409 .RE
 410
 411 .SH SEE ALSO
 412 .br
 413 .BR ip (8)
 414
 415 .SH AUTHOR
 416 Original Manpage by Michail Litvak <mci@owl.openwall.com>