man/man8/ip-link.8.in

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