Home : Computers : Linux : Man Pages : ip-link

ip-link


SYNOPSIS

       ip link  { COMMAND | help }

       ip link add [ link DEVICE ] [ name ] NAME
               [ txqueuelen PACKETS ]
               [ address LLADDR ] [ broadcast LLADDR ]
               [ mtu MTU ] [ index IDX ]
               [ 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 } ]
               [ protodown { 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 ]
                        [ VFVLAN-LIST ]
                        [ rate TXRATE ]
                        [ max_tx_rate TXRATE ]
                        [ min_tx_rate TXRATE ]
                        [ spoofchk { on | off } ]
                        [ query_rss { on | off } ]
                        [ state { auto | enable | disable } ]
                        [ trust { on | off } ]
                        [ node_guid eui64 ]
                        [ port_guid eui64 ] ]
               [ xdp { off |
                       object FILE [ section NAME ] [ verbose ] |
                       pinned FILE } ]
               [ master DEVICE ]
               [ nomaster ]
               [ vrf NAME ]
               [ addrgenmode { eui64 | none | stable_secret | random } ]
               [ macaddr { flush | { add | del } MACADDR | set [ MACADDR [
               MACADDR [ ... ] ] ] } ]

       ETYPE := [ TYPE | bridge_slave | bond_slave ]

       VFVLAN-LIST := [ VFVLAN-LIST ] VFVLAN

       VFVLAN := [ vlan VLANID [ qos VLAN-QOS ] [ proto VLAN-PROTO ] ]


DESCRIPTION

   ip link add - add virtual link
       link DEVICE
              specifies the physical device to act operate on.

              NAME specifies the name of the new virtual device.

              TYPE specifies the type of the new device.

              Link types:

                      bridge - Ethernet Bridge device

                      bond - Bonding device can - Controller Area Network
                      interface

                      dummy - Dummy network interface

                      hsr - High-availability Seamless Redundancy device

                      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
                      / Bluetooth

                      geneve - GEneric NEtwork Virtualization Encapsulation

                      macsec - Interface for IEEE 802.1AE MAC Security (MAC-
                      sec)

                      vrf - Interface for L3 VRF domains

       numtxqueues QUEUE_COUNT
              specifies the number of transmit queues for new device.

       numrxqueues QUEUE_COUNT
              specifies the number of receive queues for new device.

       index IDX
              specifies the desired index of the new virtual device. The link
              creation fails, if the index is busy.

       VLAN Type Support
              For a link of type VLAN the following additional arguments are
              supported:

              ip link add link DEVICE name NAME type vlan [ protocol
              VLAN_PROTO ] id VLANID [ reorder_hdr { on | off } ] [ gvrp { on
              | off } ] [ mvrp { on | off } ] [ loose_binding { on | off } ] [
              ingress-qos-map QOS-MAP ] [ egress-qos-map QOS-MAP ]

                      protocol VLAN_PROTO - either 802.1Q or 802.1ad.

                      id VLANID - specifies the VLAN Identifer to use. Note
                      that numbers with a leading " 0 " or " 0x " are inter-
                      preted as octal or hexadeimal, respectively.

                      reorder_hdr { on | off } - specifies whether ethernet
                      headers are reordered or not (default is on).

                          If reorder_hdr is on then VLAN header will be not
                          inserted immediately but only before passing to the
                          physical device (if this device does not support
                          VLAN offloading), the similar on the RX direction -
                          by default the packet will be untagged before being
                          received by VLAN device. Reordering allows to accel-
                          erate tagging on egress and to hide VLAN header on
                          ingress so the packet looks like regular Ethernet
                          packet, at the same time it might be confusing for
                          packet capture as the VLAN header does not exist

                      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 of VLAN
                      header prio field to the Linux internal packet priority
                      on incoming frames. The format is FROM:TO with multiple
                      mappings separated by spaces.

                      egress-qos-map QOS-MAP - defines a mapping of Linux
                      internal packet priority to VLAN header prio field but
                      for outgoing frames. The format is the same as for
                      ingress-qos-map.

                          Linux packet priority can be set by iptables(8):

                              iptables -t mangle -A POSTROUTING [...] -j CLAS-
                              SIFY --set-class 0:4

                          and this "4" priority can be used in the egress qos
                          mapping to set VLAN prio "5":

                              ip link set veth0.10 type vlan egress 4:5

       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 ] [ flowlabel FLOWLABEL ] [ 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 ] [
              [no]external ] [ gbp ] [ gpe ]

                      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
                      packets.

                      flowlabel FLOWLABEL - specifies the flow label 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 to the remote
                      VXLAN tunnel endpoint.

                      [no]learning - specifies if unknown source link layer
                      addresses and IP addresses are entered into the VXLAN
                      device forwarding database.

                      [no]rsc - specifies if route short circuit is turned on.

                      [no]proxy - specifies ARP proxy is turned on.

                      [no]l2miss - specifies if netlink LLADDR miss notifica-
                      tions are generated.

                      [no]l3miss - specifies if netlink IP ADDR miss notifica-
                      tions 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
                          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

                      gpe - enables the Generic Protocol extension (VXLAN-
                      GPE). Currently, this is only supported together with
                      the external keyword.

       GRE, IPIP, SIT Type Support
              For a link of types GRE/IPIP/SIT the following additional argu-
              ments are supported:

              ip link add DEVICE type { gre | ipip | sit }  remote ADDR local
              ADDR [ encap { fou | gue | none } ] [ encap-sport { PORT | auto
              } ] [ encap-dport PORT ] [ [no]encap-csum ] [ [no]encap-remcsum
              ]

                      remote ADDR - specifies the remote address of the tun-
                      nel.

                      local ADDR - specifies the fixed local address for tun-
                      neled packets.  It must be an address on another inter-
                      face on this host.

                      in the secondary encapsulation.

                      [no]encap-remcsum - specifies if Remote Checksum Offload
                      is enabled. This is only applicable for Generic UDP
                      Encapsulation.

       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 dotted quad.  The key
                      parameter specifies the same key to use in both direc-
                      tions.  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 checksums for outgo-
                      ing 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 out-
                      going packets.

                      encaplimit ELIM - specifies a fixed encapsulation limit.

       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.

                      mode MODE - specifies the mode (datagram or connected)
                      to use.

       GENEVE Type Support
              For a link of type GENEVE the following additional arguments are
              supported:

              ip link add DEVICE type geneve id VNI remote IPADDR [ ttl TTL ]
              [ tos TOS ] [ flowlabel FLOWLABEL ] [ dstport PORT ] [
              [no]external ] [ [no]udpcsum ] [ [no]udp6zerocsumtx ] [
              [no]udp6zerocsumrx ]

                      id VNI - specifies the Virtual Network Identifer 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

       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 ] |
              source }

                      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 interface, 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 phys-
                      ical interface is transmitted over the physical inter-
                      face. Either the attached switch needs to support hair-
                      pin 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 macvtap mode. It is not
                      allowed for more than one endpoint on the same physical
                      interface. All traffic will be forwarded to this end-
                      point, allowing virtio guests to change MAC address or
                      set promiscuous mode in order to bridge the interface or
                      create vlan interfaces on top of it. By default, this
                      mode forces the underlying interface into promiscuous
                      mode. Passing the nopromisc flag prevents this, so the
                      promisc flag may be controlled using standard tools.

                      mode source - allows one to set a list of allowed mac
                      address, which is used to match against source mac
                      address from received frames on underlying interface.
                      This allows creating mac based VLAN associations,
                      instead of standard port or tag based. The feature is
                      useful to deploy 802.1x mac based behavior, where driv-
                      ers of underlying interfaces doesn't allows that.

                      slave2 SLAVE2-IF - Specifies the physical device used
                      for the second of the two ring ports.

                      supervision ADDR-BYTE - The last byte of the multicast
                      address used for HSR supervision frames.  Default option
                      is "0", possible values 0-255.

                      version { 0 | 1 } - Selects the protocol version of the
                      interface. Default option is "0", which corresponds to
                      the 2010 version of the HSR standard. Option "1" acti-
                      vates the 2012 version.

       BRIDGE Type Support
              For a link of type BRIDGE the following additional arguments are
              supported:

              ip link add DEVICE type bridge [ ageing_time AGEING_TIME ] [
              group_fwd_mask MASK ] [ group_address ADDRESS ] [ forward_delay
              FORWARD_DELAY ] [ hello_time HELLO_TIME ] [ max_age MAX_AGE ] [
              stp_state STP_STATE ] [ priority PRIORITY ] [ vlan_filtering
              VLAN_FILTERING ] [ vlan_protocol VLAN_PROTOCOL ] [
              vlan_default_pvid VLAN_DEFAULT_PVID ] [ vlan_stats_enabled
              VLAN_STATS_ENABLED ] [ mcast_snooping MULTICAST_SNOOPING ] [
              mcast_router MULTICAST_ROUTER ] [ mcast_query_use_ifaddr
              MCAST_QUERY_USE_IFADDR ] [ mcast_querier MULTICAST_QUERIER ] [
              mcast_hash_elasticity HASH_ELASTICITY ] [ mcast_hash_max
              HASH_MAX ] [ mcast_last_member_count LAST_MEMBER_COUNT ] [
              mcast_startup_query_count STARTUP_QUERY_COUNT ] [
              mcast_last_member_interval LAST_MEMBER_INTERVAL ] [ mcast_mem-
              bership_interval MEMBERSHIP_INTERVAL ] [ mcast_querier_interval
              QUERIER_INTERVAL ] [ mcast_query_interval QUERY_INTERVAL ] [
              mcast_query_response_interval QUERY_RESPONSE_INTERVAL ] [
              mcast_startup_query_interval STARTUP_QUERY_INTERVAL ] [
              mcast_stats_enabled MCAST_STATS_ENABLED ] [ mcast_igmp_version
              IGMP_VERSION ] [ mcast_mld_version MLD_VERSION ] [ nf_call_ipta-
              bles NF_CALL_IPTABLES ] [ nf_call_ip6tables NF_CALL_IP6TABLES ]
              [ nf_call_arptables NF_CALL_ARPTABLES ]

                      ageing_time AGEING_TIME - configure the bridge's FDB
                      entries ageing time, ie the number of seconds a MAC
                      address will be kept in the FDB after a packet has been
                      received from that address. after this time has passed,
                      entries are cleaned up.

                      group_fwd_mask MASK - set the group forward mask. This
                      is the bitmask that is applied to decide whether to for-
                      ward incoming frames destined to link-local addresses,
                      ie addresses of the form 01:80:C2:00:00:0X (defaults to
                      0, ie the bridge does not forward any link-local
                      frames).
                      hello packets sent by the bridge, when it is a root
                      bridge or a designated bridges. Only relevant if STP is
                      enabled. Valid values are between 1 and 10.

                      max_age MAX_AGE - set the hello packet timeout, ie the
                      time in seconds until another bridge in the spanning
                      tree is assumed to be dead, after reception of its last
                      hello message. Only relevant if STP is enabled. Valid
                      values are between 6 and 40.

                      stp_state STP_STATE - turn spanning tree protocol on
                      (STP_STATE > 0) or off (STP_STATE == 0).  for this
                      bridge.

                      priority PRIORITY - set this bridge's spanning tree pri-
                      ority, used during STP root bridge election.  PRIORITY
                      is a 16bit unsigned integer.

                      vlan_filtering VLAN_FILTERING - turn VLAN filtering on
                      (VLAN_FILTERING > 0) or off (VLAN_FILTERING == 0).  When
                      disabled, the bridge will not consider the VLAN tag when
                      handling packets.

                      vlan_protocol { 802.1Q | 802.1ad } - set the protocol
                      used for VLAN filtering.

                      vlan_default_pvid VLAN_DEFAULT_PVID - set the default
                      PVID (native/untagged VLAN ID) for this bridge.

                      vlan_stats_enabled VLAN_STATS_ENABLED - enable
                      (VLAN_STATS_ENABLED == 1) or disable (VLAN_STATS_ENABLED
                      == 0) per-VLAN stats accounting.

                      mcast_snooping MULTICAST_SNOOPING - turn multicast
                      snooping on (MULTICAST_SNOOPING > 0) or off (MULTI-
                      CAST_SNOOPING == 0).

                      mcast_router MULTICAST_ROUTER - set bridge's multicast
                      router if IGMP snooping is enabled.  MULTICAST_ROUTER is
                      an integer value having the following meaning:

                              0 - disabled.

                              1 - automatic (queried).

                              2 - permanently enabled.

                      mcast_query_use_ifaddr MCAST_QUERY_USE_IFADDR - whether
                      to use the bridge's own IP address as source address for
                      IGMP queries (MCAST_QUERY_USE_IFADDR > 0) or the default
                      of 0.0.0.0 (MCAST_QUERY_USE_IFADDR == 0).


                      mcast_hash_max HASH_MAX - set maximum size of multicast
                      hash table (defaults to 512, value must be a power of
                      2).

                      mcast_last_member_count LAST_MEMBER_COUNT - set multi-
                      cast last member count, ie the number of queries the
                      bridge will send before stopping forwarding a multicast
                      group after a "leave" message has been received
                      (defaults to 2).

                      mcast_last_member_interval LAST_MEMBER_INTERVAL - inter-
                      val between queries to find remaining members of a
                      group, after a "leave" message is received.

                      mcast_startup_query_count STARTUP_QUERY_COUNT - set the
                      number of IGMP queries to send during startup phase
                      (defaults to 2).

                      mcast_startup_query_interval STARTUP_QUERY_INTERVAL -
                      interval between queries in the startup phase.

                      mcast_query_interval QUERY_INTERVAL - interval between
                      queries sent by the bridge after the end of the startup
                      phase.

                      mcast_query_response_interval QUERY_RESPONSE_INTERVAL -
                      set the Max Response Time/Maximum Response Delay for
                      IGMP/MLD queries sent by the bridge.

                      mcast_membership_interval MEMBERSHIP_INTERVAL - delay
                      after which the bridge will leave a group, if no member-
                      ship reports for this group are received.

                      mcast_stats_enabled MCAST_STATS_ENABLED - enable
                      (MCAST_STATS_ENABLED > 0) or disable
                      (MCAST_STATS_ENABLED == 0) multicast (IGMP/MLD) stats
                      accounting.

                      mcast_igmp_version IGMP_VERSION - set the IGMP version.

                      mcast_mld_version MLD_VERSION - set the MLD version.

                      nf_call_iptables NF_CALL_IPTABLES - enable (NF_CALL_IPT-
                      ABLES > 0) or disable (NF_CALL_IPTABLES == 0) iptables
                      hooks on the bridge.

                      nf_call_ip6tables NF_CALL_IP6TABLES - enable
                      (NF_CALL_IP6TABLES > 0) or disable (NF_CALL_IP6TABLES ==
                      0) ip6tables hooks on the bridge.

                      nf_call_arptables NF_CALL_ARPTABLES - enable

              tect { on | off } ] [ replay { on | off } window { 0..2^32-1 } ]
              [ validate { strict | check | disabled } ] [ encodingsa { 0..3 }
              ]

                      address <lladdr> - sets the system identifier component
                      of secure channel for this MACsec device.

                      port PORT - sets the port number component of secure
                      channel for this MACsec device, in a range from 1 to
                      65535 inclusive. Numbers with a leading " 0 " or " 0x "
                      are interpreted as octal and hexadecimal, respectively.

                      sci SCI - sets the secure channel identifier for this
                      MACsec device.  SCI is a 64bit wide number in hexadeci-
                      mal format.

                      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 authenti-
                      cated 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 neces-
                      sary.

                      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.

       VRF Type Support
              For a link of type VRF the following additional arguments are
              supported:

              ip link add DEVICE type vrf table TABLE

                      table table id associated with VRF device

   ip link delete - delete virtual link
       dev DEVICE
              specifies the virtual device to act operate on.

       group GROUP
              specifies the group of virtual links to delete. Group 0 is not
              allowed to be deleted since it is the default group.

       type TYPE
              specifies the type of the device.

   ip link set - change device attributes
       Warning: If multiple parameter changes are requested, ip aborts immedi-
       ately after any of the changes have failed.  This is the only case when
       ip can move the system to an unpredictable state. The solution is to
       avoid changing several parameters with one ip link set call.

       dev DEVICE
              DEVICE specifies network device to operate on. When configuring
              SR-IOV Virtual Function (VF) devices, this keyword should spec-
              ify 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 spec-
              ified, 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.


       name NAME
              change the name of the device. This operation is not recommended
              if the device is running or has some addresses already config-
              ured.

       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.

       netns NETNSNAME | PID
              move the device to the network namespace associated with name
              NETNSNAME or process PID.

              Some devices are not allowed to change network namespace: loop-
              back, bridge, ppp, wireless. These are network namespace local
              devices. In such case ip tool will return "Invalid argument"
              error. It is possible to find out if device is local to a single
              network namespace by checking netns-local flag in the output of
              the ethtool:

                      ethtool -k DEVICE

              To change network namespace for wireless devices the iw tool can
              be used. But it allows to change network namespace only for
              physical devices and by process PID.

       alias NAME
              give the device a symbolic name for easy reference.

                      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 fil-
                      tering. The vf parameter must be specified.

                      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 specified, 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.

                      proto VLAN-PROTO - assign VLAN PROTOCOL for the VLAN
                      tag, either 802.1Q or 802.1ad.  Setting to 802.1ad, all
                      traffic sent from the VF will be tagged with VLAN S-Tag.
                      Incoming traffic will have VLAN S-Tags stripped before
                      being passed to the VF.  Setting to 802.1ad also enables
                      an option to concatenate another VLAN tag, so both S-TAG
                      and C-TAG will be inserted/stripped for outgoing/incom-
                      ing traffic, respectively.  If not specified, the value
                      is assumed to be 802.1Q. Both the vf and vlan parameters
                      must be specified.

                      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

                      node_guid eui64 - configure node GUID for Infiniband
                      VFs.

                      port_guid eui64 - configure port GUID for Infiniband
                      VFs.

       xdp object | pinned | off
              set (or unset) a XDP ("express data path") BPF program to run on
              every packet at driver level.

              off (or none ) - Detaches any currently attached XDP/BPF program
              from the given device.

              object FILE - Attaches a XDP/BPF program to the given device.
              The FILE points to a BPF ELF file (f.e. generated by LLVM) that
              contains the BPF program code, map specifications, etc. If a
              XDP/BPF program is already attached to the given device, an
              error will be thrown. If no XDP/BPF program is currently
              attached, the device supports XDP and the program from the BPF
              ELF file passes the kernel verifier, then it will be attached to
              the device. If the option -force is passed to ip then any prior
              attached XDP/BPF program will be atomically overridden and no
              error will be thrown in this case. If no section option is
              passed, then the default section name ("prog") will be assumed,
              otherwise the provided section name will be used. If no verbose
              option is passed, then a verifier log will only be dumped on
              load error.  See also EXAMPLES section for usage examples.

              section NAME - Specifies a section name that contains the BPF
              program code. If no section name is specified, the default one
              ("prog") will be used. This option is to be passed with the
              object option.

              verbose - Act in verbose mode. For example, even in case of suc-
              cess, this will print the verifier log in case a program was
              loaded from a BPF ELF file.

              pinned FILE - Attaches a XDP/BPF program to the given device.
              The FILE points to an already pinned BPF program in the BPF file
              system. The option section doesn't apply here, but otherwise
              semantics are the same as with the option object described
              already.

       master DEVICE
              set master device of the device (enslave device).

       nomaster
              unset master device of the device (release device).

       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 [ fdb_flush ] [ 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
              MULTICAST_ROUTER ] [ mcast_fast_leave { on | off} ] [
              mcast_flood { on | off } ]

                      fdb_flush - flush bridge slave's fdb dynamic entries.

                      state STATE - Set port state.  STATE is a number repre-
                      senting the following states: 0 (disabled), 1 (listen-
                      ing), 2 (learning), 3 (forwarding), 4 (blocking).

                      priority PRIO - set port priority (allowed values are
                      between 0 and 63, inclusively).

                      cost COST - set port cost (allowed values are between 1
                      and 65535, inclusively).

                      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
                      cast router will receive all multicast traffic.  MULTI-
                      CAST_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.

                      mcast_flood { on | off } - controls whether a given port
                      will be flooded with multicast traffic for which there
                      is no MDB entry.

       Bonding Slave Support
              For a link with master bond the following additional arguments
              are supported:

              ip link set type bond_slave [ queue_id ID ]

                      queue_id ID - set the slave's queue ID (a 16bit unsigned
                      value).

       MACVLAN and MACVTAP Support
              Modify list of allowed macaddr for link in source mode.

              ip link set type { macvlan | macvap } [ macaddr COMMAND MACADDR
              ...  ]

              Commands:
                      add - add MACADDR to allowed list

                      set - replace allowed list

                      del - remove MACADDR from allowed list

                      flush - flush whole allowed list

   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.

              NAME speficies the VRF 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 sup-
              ported 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 xstats - display extended statistics
       type TYPE
              TYPE specifies the type of devices to display extended statis-
              tics for.

   ip link afstats - display address-family specific statistics
       dev DEVICE
              DEVICE specifies the device to display address-family statistics
              for.

   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

       ip link set dev eth0 xdp obj prog.o
           Attaches a XDP/BPF program to device eth0, where the program is
           located in prog.o, section "prog" (default section). In case a
           XDP/BPF program is already attached, throw an error.

       ip -force link set dev eth0 xdp obj prog.o sec foo
           Attaches a XDP/BPF program to device eth0, where the program is
           located in prog.o, section "foo". In case a XDP/BPF program is
           already attached, it will be overridden by the new one.

       ip -force link set dev eth0 xdp pinned /sys/fs/bpf/foo
           Attaches a XDP/BPF program to device eth0, where the program was
           previously pinned as an object node into BPF file system under name
           foo.

       ip link set dev eth0 xdp off
           If a XDP/BPF program is attached on device eth0, detach it and
           effectively turn off XDP for device eth0.

       ip link add link wpan0 lowpan0 type lowpan
           Creates a 6LoWPAN interface named lowpan0 on the underlying IEEE
           802.15.4 device wpan0.


SEE ALSO

       ip(8), ip-netns(8), ethtool(8), iptables(8)


AUTHOR

       Original Manpage by Michail Litvak <mci@owl.openwall.com>


iproute2 13 Dec 2012 IP-LINK(8)



Subscribe to us on YouTube