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 " ]"
  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 .in -8
 163
 164 .TP
 165 .BI numtxqueues " QUEUE_COUNT "
 166 specifies the number of transmit queues for new device.
 167
 168 .TP
 169 .BI numrxqueues " QUEUE_COUNT "
 170 specifies the number of receive queues for new device.
 171
 172 .SS ip link delete - delete virtual link
 173 .I DEVICE
 174 specifies the virtual  device to act operate on.
 175 .I TYPE
 176 specifies the type of the device.
 177
 178
 179 .TP
 180 .BI dev " DEVICE "
 181 specifies the physical device to act operate on.
 182
 183 .SS ip link set - change device attributes
 184
 185 .TP
 186 .BI dev " DEVICE "
 187 .I DEVICE
 188 specifies network device to operate on. When configuring SR-IOV Virtual Fuction
 189 (VF) devices, this keyword should specify the associated Physical Function (PF)
 190 device.
 191
 192 .TP
 193 .BI group " GROUP "
 194 .I GROUP
 195 has a dual role: If both group and dev are present, then move the device to the
 196 specified group.  If only a group is specified, then the command operates on
 197 all devices in that group.
 198
 199 .TP
 200 .BR up " and " down
 201 change the state of the device to
 202 .B UP
 203 or
 204 .BR "DOWN" .
 205
 206 .TP
 207 .BR "arp on " or " arp off"
 208 change the
 209 .B NOARP
 210 flag on the device.
 211
 212 .TP
 213 .BR "multicast on " or " multicast off"
 214 change the
 215 .B MULTICAST
 216 flag on the device.
 217
 218 .TP
 219 .BR "dynamic on " or " dynamic off"
 220 change the
 221 .B DYNAMIC
 222 flag on the device.
 223
 224 .TP
 225 .BI name " NAME"
 226 change the name of the device.  This operation is not
 227 recommended if the device is running or has some addresses
 228 already configured.
 229
 230 .TP
 231 .BI txqueuelen " NUMBER"
 232 .TP
 233 .BI txqlen " NUMBER"
 234 change the transmit queue length of the device.
 235
 236 .TP
 237 .BI mtu " NUMBER"
 238 change the
 239 .I MTU
 240 of the device.
 241
 242 .TP
 243 .BI address " LLADDRESS"
 244 change the station address of the interface.
 245
 246 .TP
 247 .BI broadcast " LLADDRESS"
 248 .TP
 249 .BI brd " LLADDRESS"
 250 .TP
 251 .BI peer " LLADDRESS"
 252 change the link layer broadcast address or the peer address when
 253 the interface is
 254 .IR "POINTOPOINT" .
 255
 256 .TP
 257 .BI netns " PID"
 258 move the device to the network namespace associated with the process
 259 .IR "PID".
 260
 261 .TP
 262 .BI netns " NETNSNAME"
 263 move the device to the network namespace associated with name
 264 .IR "NETNSNAME".
 265
 266 .TP
 267 .BI alias " NAME"
 268 give the device a symbolic name for easy reference.
 269
 270 .TP
 271 .BI group " GROUP"
 272 specify the group the device belongs to.
 273 The available groups are listed in file
 274 .BR "@SYSCONFDIR@/group" .
 275
 276 .TP
 277 .BI vf " NUM"
 278 specify a Virtual Function device to be configured. The associated PF device
 279 must be specified using the
 280 .B dev
 281 parameter.
 282
 283 .in +8
 284 .BI mac " LLADDRESS"
 285 - change the station address for the specified VF. The
 286 .B vf
 287 parameter must be specified.
 288
 289 .sp
 290 .BI vlan " VLANID"
 291 - change the assigned VLAN for the specified VF. When specified, all traffic
 292 sent from the VF will be tagged with the specified VLAN ID. Incoming traffic
 293 will be filtered for the specified VLAN ID, and will have all VLAN tags
 294 stripped before being passed to the VF. Setting this parameter to 0 disables
 295 VLAN tagging and filtering. The
 296 .B vf
 297 parameter must be specified.
 298
 299 .sp
 300 .BI qos " VLAN-QOS"
 301 - assign VLAN QOS (priority) bits for the VLAN tag. When specified, all VLAN
 302 tags transmitted by the VF will include the specified priority bits in the
 303 VLAN tag. If not specified, the value is assumed to be 0. Both the
 304 .B vf
 305 and
 306 .B vlan
 307 parameters must be specified. Setting both
 308 .B vlan
 309 and
 310 .B qos
 311 as 0 disables VLAN tagging and filtering for the VF.
 312
 313 .sp
 314 .BI rate " TXRATE"
 315 - change the allowed transmit bandwidth, in Mbps, for the specified VF.
 316 Setting this parameter to 0 disables rate limiting. The
 317 .B vf
 318 parameter must be specified.
 319
 320 .sp
 321 .BI spoofchk " on|off"
 322 - turn packet spoof checking on or off for the specified VF.
 323 .in -8
 324
 325 .TP
 326 .BI master " DEVICE"
 327 set master device of the device (enslave device).
 328
 329 .TP
 330 .BI nomaster
 331 unset master device of the device (release device).
 332
 333 .PP
 334 .B Warning:
 335 If multiple parameter changes are requested,
 336 .B ip
 337 aborts immediately after any of the changes have failed.
 338 This is the only case when
 339 .B ip
 340 can move the system to an unpredictable state.  The solution
 341 is to avoid changing several parameters with one
 342 .B ip link set
 343 call.
 344
 345 .SS  ip link show - display device attributes
 346
 347 .TP
 348 .BI dev " NAME " (default)
 349 .I NAME
 350 specifies the network device to show.
 351 If this argument is omitted all devices in the default group are listed.
 352
 353 .TP
 354 .BI group " GROUP "
 355 .I GROUP
 356 specifies what group of devices to show.
 357
 358 .TP
 359 .B up
 360 only display running interfaces.
 361
 362 .SH "EXAMPLES"
 363 .PP
 364 ip link show
 365 .RS 4
 366 Shows the state of all network interfaces on the system.
 367 .RE
 368 .PP
 369 ip link set dev ppp0 mtu 1400
 370 .RS 4
 371 Change the MTU the ppp0 device.
 372 .RE
 373 .PP
 374 ip link add link eth0 name eth0.10 type vlan id 10
 375 .RS 4
 376 Creates a new vlan device eth0.10 on device eth0.
 377 .RE
 378 .PP
 379 ip link delete dev eth0.10
 380 .RS 4
 381 Removes vlan device.
 382 .RE
 383
 384 .SH SEE ALSO
 385 .br
 386 .BR ip (8)
 387
 388 .SH AUTHOR
 389 Original Manpage by Michail Litvak <mci@owl.openwall.com>