share/man/man4/lagg.4

   1 .\"     $OpenBSD: trunk.4,v 1.18 2006/06/09 13:53:34 jmc Exp $
   2 .\"
   3 .\" Copyright (c) 2005, 2006 Reyk Floeter <reyk@openbsd.org>
   4 .\"
   5 .\" Permission to use, copy, modify, and distribute this software for any
   6 .\" purpose with or without fee is hereby granted, provided that the above
   7 .\" copyright notice and this permission notice appear in all copies.
   8 .\"
   9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16 .\"
  17 .\" $FreeBSD$
  18 .\"
  19 .Dd January 23, 2016
  20 .Dt LAGG 4
  21 .Os
  22 .Sh NAME
  23 .Nm lagg
  24 .Nd link aggregation and link failover interface
  25 .Sh SYNOPSIS
  26 To compile this driver into the kernel,
  27 place the following line in your
  28 kernel configuration file:
  29 .Bd -ragged -offset indent
  30 .Cd "device lagg"
  31 .Ed
  32 .Pp
  33 Alternatively, to load the driver as a
  34 module at boot time, place the following line in
  35 .Xr loader.conf 5 :
  36 .Bd -literal -offset indent
  37 if_lagg_load="YES"
  38 .Ed
  39 .Sh DESCRIPTION
  40 The
  41 .Nm
  42 interface allows aggregation of multiple network interfaces as one virtual
  43 .Nm
  44 interface for the purpose of providing fault-tolerance and high-speed links.
  45 .Pp
  46 A
  47 .Nm
  48 interface can be created using the
  49 .Ic ifconfig lagg Ns Ar N Ic create
  50 command.
  51 It can use different link aggregation protocols specified
  52 using the
  53 .Ic laggproto Ar proto
  54 option.
  55 Child interfaces can be added using the
  56 .Ic laggport Ar child-iface
  57 option and removed using the
  58 .Ic -laggport Ar child-iface
  59 option.
  60 .Pp
  61 The driver currently supports the aggregation protocols
  62 .Ic failover
  63 (the default),
  64 .Ic lacp ,
  65 .Ic loadbalance ,
  66 .Ic roundrobin ,
  67 .Ic broadcast ,
  68 and
  69 .Ic none .
  70 The protocols determine which ports are used for outgoing traffic
  71 and whether a specific port accepts incoming traffic.
  72 The interface link state is used to validate if the port is active or
  73 not.
  74 .Bl -tag -width loadbalance
  75 .It Ic failover
  76 Sends traffic only through the active port.
  77 If the master port becomes unavailable,
  78 the next active port is used.
  79 The first interface added is the master port;
  80 any interfaces added after that are used as failover devices.
  81 .Pp
  82 By default, received traffic is only accepted when they are received
  83 through the active port.
  84 This constraint can be relaxed by setting the
  85 .Va net.link.lagg.failover_rx_all
  86 .Xr sysctl 8
  87 variable to a nonzero value,
  88 which is useful for certain bridged network setups.
  89 .Ic loadbalance
  90 mode.
  91 .It Ic lacp
  92 Supports the IEEE 802.1AX (formerly 802.3ad) Link Aggregation Control Protocol
  93 (LACP) and the Marker Protocol.
  94 LACP will negotiate a set of aggregable links with the peer in to one or more
  95 Link Aggregated Groups.
  96 Each LAG is composed of ports of the same speed, set to full-duplex operation.
  97 The traffic will be balanced across the ports in the LAG with the greatest
  98 total speed, in most cases there will only be one LAG which contains all ports.
  99 In the event of changes in physical connectivity, Link Aggregation will quickly
 100 converge to a new configuration.
 101 .It Ic loadbalance
 102 Balances outgoing traffic across the active ports based on hashed
 103 protocol header information and accepts incoming traffic from
 104 any active port.
 105 This is a static setup and does not negotiate aggregation with the peer or
 106 exchange frames to monitor the link.
 107 The hash includes the Ethernet source and destination address, and, if
 108 available, the VLAN tag, and the IP source and destination address.
 109 .It Ic roundrobin
 110 Distributes outgoing traffic using a round-robin scheduler
 111 through all active ports and accepts incoming traffic from
 112 any active port.
 113 Using
 114 .Ic roundrobin
 115 mode can cause unordered packet arrival at the client.
 116 Throughput might be limited as the client performs CPU-intensive packet
 117 reordering.
 118 .It Ic broadcast
 119 Sends frames to all ports of the LAG and receives frames on
 120 any port of the LAG.
 121 .It Ic none
 122 This protocol is intended to do nothing: it disables any traffic without
 123 disabling the
 124 .Nm
 125 interface itself.
 126 .El
 127 .Pp
 128 Each
 129 .Nm
 130 interface is created at runtime using interface cloning.
 131 This is
 132 most easily done with the
 133 .Xr ifconfig 8
 134 .Cm create
 135 command or using the
 136 .Va cloned_interfaces
 137 variable in
 138 .Xr rc.conf 5 .
 139 .Pp
 140 The MTU of the first interface to be added is used as the lagg MTU.
 141 All additional interfaces are required to have exactly the same value.
 142 .Pp
 143 The
 144 .Ic loadbalance
 145 and
 146 .Ic lacp
 147 modes will use the RSS hash from the network card if available to avoid
 148 computing one, this may give poor traffic distribution if the hash is invalid
 149 or uses less of the protocol header information.
 150 Local hash computation can be forced per interface by setting the
 151 .Cm use_flowid
 152 .Xr ifconfig 8
 153 flag.
 154 The default for new interfaces is set via the
 155 .Va net.link.lagg.default_use_flowid
 156 .Xr sysctl 8 .
 157 .Sh EXAMPLES
 158 Create a link aggregation using LACP with two
 159 .Xr bge 4
 160 Gigabit Ethernet interfaces:
 161 .Bd -literal -offset indent
 162 # ifconfig bge0 up
 163 # ifconfig bge1 up
 164 # ifconfig lagg0 create
 165 # ifconfig lagg0 laggproto lacp laggport bge0 laggport bge1 \e
 166         192.168.1.1 netmask 255.255.255.0
 167 .Ed
 168 .Pp
 169 Create a link aggregation using ROUNDROBIN with two
 170 .Xr bge 4
 171 Gigabit Ethernet interfaces and set the limit of 500 packets
 172 per interface:
 173 .Bd -literal -offset indent
 174 # ifconfig bge0 up
 175 # ifconfig bge1 up
 176 # ifconfig lagg0 create
 177 # ifconfig lagg0 laggproto roundrobin laggport bge0 laggport bge1 \e
 178         192.168.1.1 netmask 255.255.255.0
 179 # ifconfig lagg0 rr_limit 500
 180 .Ed
 181 .Pp
 182 The following example uses an active failover interface to set up roaming
 183 between wired and wireless networks using two network devices.
 184 Whenever the wired master interface is unplugged, the wireless failover
 185 device will be used:
 186 .Bd -literal -offset indent
 187 # ifconfig em0 up
 188 # ifconfig ath0 ether 00:11:22:33:44:55
 189 # ifconfig create wlan0 wlandev ath0 ssid my_net up
 190 # ifconfig lagg0 create
 191 # ifconfig lagg0 laggproto failover laggport em0 laggport wlan0 \e
 192         192.168.1.1 netmask 255.255.255.0
 193 .Ed
 194 .Pp
 195 (Note the mac address of the wireless device is forced to match the wired
 196 device as a workaround.)
 197 .Sh SEE ALSO
 198 .Xr ng_one2many 4 ,
 199 .Xr ifconfig 8 ,
 200 .Xr sysctl 8
 201 .Sh HISTORY
 202 The
 203 .Nm
 204 device first appeared in
 205 .Fx 6.3 .
 206 .Sh AUTHORS
 207 .An -nosplit
 208 The
 209 .Nm
 210 driver was written under the name
 211 .Nm trunk
 212 by
 213 .An Reyk Floeter Aq Mt reyk@openbsd.org .
 214 The LACP implementation was written by
 215 .An YAMAMOTO Takashi
 216 for
 217 .Nx .
 218 .Sh BUGS
 219 There is no way to configure LACP administrative variables, including system
 220 and port priorities.
 221 The current implementation always performs active-mode LACP and uses 0x8000 as
 222 system and port priorities.