IP-LINK(8) Linux IP-LINK(8)
NAME
ip-link - network device configuration
SYNOPSIS
ip link { COMMAND | help }
ip link add [ link DEVICE ] [ name ] NAME
[ txqueuelen PACKETS ]
[ address LLADDR ] [ broadcast LLADDR ]
[ mtu MTU ]
[ numtxqueues QUEUE_COUNT ] [ numrxqueues QUEUE_COUNT ]
type TYPE [ ARGS ]
ip link delete { DEVICE | group GROUP } type TYPE [ ARGS ]
ip link set { DEVICE | group GROUP }
[ { up | down } ]
[ type ETYPE TYPE_ARGS ]
[ arp { on | off } ]
[ dynamic { on | off } ]
[ multicast { on | off } ]
[ allmulticast { on | off } ]
[ promisc { on | off } ]
[ trailers { on | off } ]
[ txqueuelen PACKETS ]
[ name NEWNAME ]
[ address LLADDR ]
[ broadcast LLADDR ]
[ mtu MTU ]
[ netns { PID | NETNSNAME } ]
[ link-netnsid ID ]
[ alias NAME ]
[ vf NUM [ mac LLADDR ]
[ vlan VLANID [ qos VLAN-QOS ] ]
[ rate TXRATE ]
[ max_tx_rate TXRATE ]
[ min_tx_rate TXRATE ]
[ spoofchk { on | off } ]
[ query_rss { on | off } ]
[ state { auto | enable | disable } ]
[ trust { on | off } ] ]
[ master DEVICE ]
[ nomaster ]
[ addrgenmode { eui64 | none } ]
ip link show [ DEVICE | group GROUP ] [ up ] [ master DEVICE ] [ type ETYPE ]
ip link help [ TYPE ]
TYPE := [ bridge | bond | can | dummy | ifb | ipoib | macvlan | macvtap | vcan | veth | vlan | vxlan | ip6tnl
| ipip | sit | gre | gretap | ip6gre | ip6gretap | vti | nlmon | geneve | macsec ]
ETYPE := [ TYPE | bridge_slave | bond_slave ]
bridge - Ethernet Bridge device
bond - Bonding device
dummy - Dummy network interface
ifb - Intermediate Functional Block device
ipoib - IP over Infiniband device
macvlan - Virtual interface base on link layer address (MAC)
macvtap - Virtual interface based on link layer address (MAC) and TAP.
vcan - Virtual Controller Area Network interface
veth - Virtual ethernet interface
vlan - 802.1q tagged virtual LAN interface
vxlan - Virtual eXtended LAN
ip6tnl - Virtual tunnel interface IPv4|IPv6 over IPv6
ipip - Virtual tunnel interface IPv4 over IPv4
sit - Virtual tunnel interface IPv6 over IPv4
gre - Virtual tunnel interface GRE over IPv4
gretap - Virtual L2 tunnel interface GRE over IPv4
ip6gre - Virtual tunnel interface GRE over IPv6
ip6gretap - Virtual L2 tunnel interface GRE over IPv6
vti - Virtual tunnel interface
nlmon - Netlink monitoring device
geneve - GEneric NEtwork Virtualization Encapsulation
macsec - Interface for IEEE 802.1AE MAC Security (MACsec)
numtxqueues QUEUE_COUNT
specifies the number of transmit queues for new device.
numrxqueues QUEUE_COUNT
specifies the number of receive queues for new device.
VLAN Type Support
reorder_hdr { on | off } - specifies whether ethernet headers are reordered or not.
gvrp { on | off } - specifies whether this VLAN should be registered using GARP VLAN Registra‐
tion Protocol.
mvrp { on | off } - specifies whether this VLAN should be registered using Multiple VLAN Regis‐
tration Protocol.
loose_binding { on | off } - specifies whether the VLAN device state is bound to the physical
device state.
ingress-qos-map QOS-MAP - defines a mapping between priority code points on incoming frames.
The format is FROM:TO with multiple mappings separated by spaces.
egress-qos-map QOS-MAP - the same as ingress-qos-map but for outgoing frames.
VXLAN Type Support
For a link of type VXLAN the following additional arguments are supported:
ip link add DEVICE type vxlan id VNI [ dev PHYS_DEV ] [ { group | remote } IPADDR ] [ local { IPADDR |
any } ] [ ttl TTL ] [ tos TOS ] [ dstport PORT ] [ srcport MIN MAX ] [ [no]learning ] [ [no]proxy ] [
[no]rsc ] [ [no]l2miss ] [ [no]l3miss ] [ [no]udpcsum ] [ [no]udp6zerocsumtx ] [ [no]udp6zerocsumrx ] [
ageing SECONDS ] [ maxaddress NUMBER ] [ gbp ]
id VNI - specifies the VXLAN Network Identifer (or VXLAN Segment Identifier) to use.
dev PHYS_DEV - specifies the physical device to use for tunnel endpoint communication.
group IPADDR - specifies the multicast IP address to join. This parameter cannot be specified
with the remote parameter.
remote IPADDR - specifies the unicast destination IP address to use in outgoing packets when
the destination link layer address is not known in the VXLAN device forwarding database. This
parameter cannot be specified with the group parameter.
local IPADDR - specifies the source IP address to use in outgoing packets.
ttl TTL - specifies the TTL value to use in outgoing packets.
tos TOS - specifies the TOS value to use in outgoing packets.
dstport PORT - specifies the UDP destination port to communicate to the remote VXLAN tunnel
endpoint.
srcport MIN MAX - specifies the range of port numbers to use as UDP source ports to communicate
[no]l2miss - specifies if netlink LLADDR miss notifications are generated.
[no]l3miss - specifies if netlink IP ADDR miss notifications are generated.
[no]udpcsum - specifies if UDP checksum is calculated for transmitted packets over IPv4.
[no]udp6zerocsumtx - skip UDP checksum calculation for transmitted packets over IPv6.
[no]udp6zerocsumrx - allow incoming UDP packets over IPv6 with zero checksum field.
ageing SECONDS - specifies the lifetime in seconds of FDB entries learnt by the kernel.
maxaddress NUMBER - specifies the maximum number of FDB entries.
gbp - enables the Group Policy extension (VXLAN-GBP).
Allows to transport group policy context across VXLAN network peers. If enabled, includes
the mark of a packet in the VXLAN header for outgoing packets and fills the packet mark
based on the information found in the VXLAN header for incomming packets.
Format of upper 16 bits of packet mark (flags);
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|-|-|-|-|-|-|-|-|-|D|-|-|A|-|-|-|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
D := Don't Learn bit. When set, this bit indicates that the egress VTEP MUST NOT learn
the source address of the encapsulated frame.
A := Indicates that the group policy has already been applied to this packet. Policies
MUST NOT be applied by devices when the A bit is set.
Format of lower 16 bits of packet mark (policy ID):
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Group Policy ID |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Example:
iptables -A OUTPUT [...] -j MARK --set-mark 0x800FF
GRE, IPIP, SIT Type Support
For a link of types GRE/IPIP/SIT the following additional arguments are supported:
IP6GRE/IP6GRETAP Type Support
For a link of type IP6GRE/IP6GRETAP the following additional arguments are supported:
ip link add DEVICE type { ip6gre | ip6gretap } remote ADDR local ADDR [ [i|o]seq ] [ [i|o]key KEY ] [
[i|o]csum ] [ hoplimit TTL ] [ encaplimit ELIM ] [ tclass TCLASS ] [ flowlabel FLOWLABEL ] [ dscp
inherit ] [ dev PHYS_DEV ]
remote ADDR - specifies the remote IPv6 address of the tunnel.
local ADDR - specifies the fixed local IPv6 address for tunneled packets. It must be an
address on another interface on this host.
[i|o]seq - serialize packets. The oseq flag enables sequencing of outgoing packets. The iseq
flag requires that all input packets are serialized.
[i|o]key KEY - use keyed GRE with key KEY. KEY is either a number or an IPv4 address-like dot‐
ted quad. The key parameter specifies the same key to use in both directions. The ikey and
okey parameters specify different keys for input and output.
[i|o]csum - generate/require checksums for tunneled packets. The ocsum flag calculates check‐
sums for outgoing packets. The icsum flag requires that all input packets have the correct
checksum. The csum flag is equivalent to the combination icsum ocsum.
hoplimit TTL - specifies Hop Limit value to use in outgoing packets.
encaplimit ELIM - specifies a fixed encapsulation limit. Default is 4.
flowlabel FLOWLABEL - specifies a fixed flowlabel.
tclass TCLASS - specifies the traffic class field on tunneled packets, which can be specified
as either a two-digit hex value (e.g. c0) or a predefined string (e.g. internet). The value
inherit causes the field to be copied from the original IP header. The values inherit/STRING or
inherit/00..ff will set the field to STRING or 00..ff when tunneling non-IP packets. The
default value is 00.
IPoIB Type Support
For a link of type IPoIB the following additional arguments are supported:
ip link add DEVICE name NAME type ipoib [ pkey PKEY ] [ mode MODE ]
pkey PKEY - specifies the IB P-Key to use.
remote IPADDR - specifies the unicast destination IP address to use in outgoing packets.
ttl TTL - specifies the TTL value to use in outgoing packets.
tos TOS - specifies the TOS value to use in outgoing packets.
flowlabel FLOWLABEL - specifies the flow label to use in outgoing packets.
dstport PORT - select a destination port other than the default of 6081.
[no]external - make this tunnel externally controlled (or not, which is the default). This flag
is mutually exclusive with the id, remote, ttl, tos and flowlabel options.
[no]udpcsum - specifies if UDP checksum is calculated for transmitted packets over IPv4.
[no]udp6zerocsumtx - skip UDP checksum calculation for transmitted packets over IPv6.
[no]udp6zerocsumrx - allow incoming UDP packets over IPv6 with zero checksum field.
MACVLAN and MACVTAP Type Support
For a link of type MACVLAN or MACVTAP the following additional arguments are supported:
ip link add link DEVICE name NAME type { macvlan | macvtap } mode { private | vepa | bridge | passthru
[ nopromisc ] }
type { macvlan | macvtap } - specifies the link type to use. macvlan creates just a virtual
interface, while macvtap in addition creates a character device /dev/tapX to be used just like
a tuntap device.
mode private - Do not allow communication between macvlan instances on the same physical inter‐
face, even if the external switch supports hairpin mode.
mode vepa - Virtual Ethernet Port Aggregator mode. Data from one macvlan instance to the other
on the same physical interface is transmitted over the physical interface. Either the attached
switch needs to support hairpin mode, or there must be a TCP/IP router forwarding the packets
in order to allow communication. This is the default mode.
mode bridge - In bridge mode, all endpoints are directly connected to each other, communication
is not redirected through the physical interface's peer.
mode passthru [ nopromisc ] - This mode gives more power to a single endpoint, usually in macv‐
tap mode. It is not allowed for more than one endpoint on the same physical interface. All
check | disabled } ] [ encodingsa { 0..3 } ]
port PORT - sets the port number for this MACsec device.
sci SCI - sets the SCI for this MACsec device.
cipher CIPHER_SUITE - defines the cipher suite to use.
icvlen LENGTH - sets the length of the Integrity Check Value (ICV).
encrypt on or encrypt off - switches between authenticated encryption, or authenticity mode
only.
send_sci on or send_sci off - specifies whether the SCI is included in every packet, or only
when it is necessary.
end_station on or end_station off - sets the End Station bit.
scb on or scb off - sets the Single Copy Broadcast bit.
protect on or protect off - enables MACsec protection on the device.
replay on or replay off - enables replay protection on the device.
window SIZE - sets the size of the replay window.
validate strict or validate check or validate disabled - sets the validation mode on the
device.
encodingsa AN - sets the active secure association for transmission.
ip link delete - delete virtual link
dev DEVICE
specifies the virtual device to act operate on.
group GROUP
dev DEVICE
DEVICE specifies network device to operate on. When configuring SR-IOV Virtual Function (VF) devices,
this keyword should specify the associated Physical Function (PF) device.
group GROUP
GROUP has a dual role: If both group and dev are present, then move the device to the specified group.
If only a group is specified, then the command operates on all devices in that group.
up and down
change the state of the device to UP or DOWN.
arp on or arp off
change the NOARP flag on the device.
multicast on or multicast off
change the MULTICAST flag on the device.
dynamic on or dynamic off
change the DYNAMIC flag on the device.
name NAME
change the name of the device. This operation is not recommended if the device is running or has some
addresses already configured.
txqueuelen NUMBER
txqlen NUMBER
change the transmit queue length of the device.
mtu NUMBER
change the MTU of the device.
address LLADDRESS
change the station address of the interface.
broadcast LLADDRESS
brd LLADDRESS
peer LLADDRESS
change the link layer broadcast address or the peer address when the interface is POINTOPOINT.
work namespace only for physical devices and by process PID.
alias NAME
give the device a symbolic name for easy reference.
vf NUM specify a Virtual Function device to be configured. The associated PF device must be specified using
the dev parameter.
mac LLADDRESS - change the station address for the specified VF. The vf parameter must be spec‐
ified.
vlan VLANID - change the assigned VLAN for the specified VF. When specified, all traffic sent
from the VF will be tagged with the specified VLAN ID. Incoming traffic will be filtered for
the specified VLAN ID, and will have all VLAN tags stripped before being passed to the VF. Set‐
ting this parameter to 0 disables VLAN tagging and filtering. The vf parameter must be speci‐
fied.
qos VLAN-QOS - assign VLAN QOS (priority) bits for the VLAN tag. When specified, all VLAN tags
transmitted by the VF will include the specified priority bits in the VLAN tag. If not speci‐
fied, the value is assumed to be 0. Both the vf and vlan parameters must be specified. Setting
both vlan and qos as 0 disables VLAN tagging and filtering for the VF.
rate TXRATE -- change the allowed transmit bandwidth, in Mbps, for the specified VF. Setting
this parameter to 0 disables rate limiting. vf parameter must be specified. Please use new
API max_tx_rate option instead.
max_tx_rate TXRATE - change the allowed maximum transmit bandwidth, in Mbps, for the specified
VF. vf parameter must be specified.
min_tx_rate TXRATE - change the allowed minimum transmit bandwidth, in Mbps, for the specified
VF. Minimum TXRATE should be always <= Maximum TXRATE. vf parameter must be specified.
spoofchk on|off - turn packet spoof checking on or off for the specified VF.
query_rss on|off - toggle the ability of querying the RSS configuration of a specific VF. VF
RSS information like RSS hash key may be considered sensitive on some devices where this infor‐
mation is shared between VF and PF and thus its querying may be prohibited by default.
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.
trust on|off - trust the specified VF user. This enables that VF user can set a specific fea‐
ture which may impact security and/or performance. (e.g. VF multicast promiscuous mode)
link-netnsid
set peer netnsid for a cross-netns interface
type ETYPE TYPE_ARGS
Change type-specific settings. For a list of supported types and arguments refer to the description of
ip link add above. In addition to that, it is possible to manipulate settings to slave devices:
Bridge Slave Support
For a link with master bridge the following additional arguments are supported:
ip link set type bridge_slave [ state STATE ] [ priority PRIO ] [ cost COST ] [ guard { on | off } ] [
hairpin { on | off } ] [ fastleave { on | off } ] [ root_block { on | off } ] [ learning { on | off } ]
[ flood { on | off } ] [ proxy_arp { on | off } ] [ proxy_arp_wifi { on | off } ] [ mcast_router MULTI‐
CAST_ROUTER ] [ mcast_fast_leave { on | off} ]
state STATE - Set port state. STATE is a number representing the following states: 0 (dis‐
abled), 1 (listening), 2 (learning), 3 (forwarding), 4 (blocking).
priority PRIO - set port priority (a 16bit unsigned value).
cost COST - set port cost (a 32bit unsigned value).
guard { on | off } - block incoming BPDU packets on this port.
hairpin { on | off } - enable hairpin mode on this port. This will allow incoming packets on
this port to be reflected back.
fastleave { on | off } - enable multicast fast leave on this port.
root_block { on | off } - block this port from becoming the bridge's root port.
learning { on | off } - allow MAC address learning on this port.
flood { on | off } - open the flood gates on this port, i.e. forward all unicast frames to this
port also. Requires proxy_arp and proxy_arp_wifi to be turned off.
proxy_arp { on | off } - enable proxy ARP on this port.
proxy_arp_wifi { on | off } - enable proxy ARP on this port which meets extended requirements
by IEEE 802.11 and Hotspot 2.0 specifications.
mcast_router MULTICAST_ROUTER - configure this port for having multicast routers attached. A
port with a multicast router will receive all multicast traffic. MULTICAST_ROUTER may be
either 0 to disable multicast routers on this port, 1 to let the system detect the presence of
of routers (this is the default), 2 to permanently enable multicast traffic forwarding on this
port or 3 to enable multicast routers temporarily on this port, not depending on incoming
queries.
mcast_fast_leave { on | off } - this is a synonym to the fastleave option above.
ip link show - display device attributes
dev NAME (default)
NAME specifies the network device to show. If this argument is omitted all devices in the default
group are listed.
group GROUP
GROUP specifies what group of devices to show.
up only display running interfaces.
master DEVICE
DEVICE specifies the master device which enslaves devices to show.
type TYPE
TYPE specifies the type of devices to show.
Note that the type name is not checked against the list of supported types - instead it is sent as-is
to the kernel. Later it is used to filter the returned interface list by comparing it with the relevant
attribute in case the kernel didn't filter already. Therefore any string is accepted, but may lead to
empty output.
ip link help - display help
TYPE specifies which help of link type to dislpay.
GROUP
may be a number or a string from the file /etc/iproute2/group which can be manually filled.
EXAMPLES
ip link show
Shows the state of all network interfaces on the system.
ip link show type bridge
Shows the bridge devices.
ip link show type vlan
Shows the vlan devices.
ip link show master br0
Shows devices enslaved by br0
ip link set dev ppp0 mtu 1400
Change the MTU the ppp0 device.
ip link add link eth0 name eth0.10 type vlan id 10
Creates a new vlan device eth0.10 on device eth0.
ip link delete dev eth0.10
iproute2 13 Dec 2012 IP-LINK(8)
Back to main site | Back to man page index