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: head/share/man/man4/lagg.4 243091 2012-11-15 16:54:14Z joel $
  18 .\"
  19 .Dd February 23, 2012
  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 fec ,
  65 .Ic lacp ,
  66 .Ic loadbalance ,
  67 .Ic roundrobin ,
  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 .It Ic fec
  90 Supports Cisco EtherChannel.
  91 This is an alias for
  92 .Ic loadbalance
  93 mode.
  94 .It Ic lacp
  95 Supports the IEEE 802.1AX (formerly 802.3ad) Link Aggregation Control Protocol
  96 (LACP) and the Marker Protocol.
  97 LACP will negotiate a set of aggregable links with the peer in to one or more
  98 Link Aggregated Groups.
  99 Each LAG is composed of ports of the same speed, set to full-duplex operation.
 100 The traffic will be balanced across the ports in the LAG with the greatest
 101 total speed, in most cases there will only be one LAG which contains all ports.
 102 In the event of changes in physical connectivity, Link Aggregation will quickly
 103 converge to a new configuration.
 104 .It Ic loadbalance
 105 Balances outgoing traffic across the active ports based on hashed
 106 protocol header information and accepts incoming traffic from
 107 any active port.
 108 This is a static setup and does not negotiate aggregation with the peer or
 109 exchange frames to monitor the link.
 110 The hash includes the Ethernet source and destination address, and, if
 111 available, the VLAN tag, and the IP source and destination address.
 112 .It Ic roundrobin
 113 Distributes outgoing traffic using a round-robin scheduler
 114 through all active ports and accepts incoming traffic from
 115 any active port.
 116 .It Ic none
 117 This protocol is intended to do nothing: it disables any traffic without
 118 disabling the
 119 .Nm
 120 interface itself.
 121 .El
 122 .Pp
 123 Each
 124 .Nm
 125 interface is created at runtime using interface cloning.
 126 This is
 127 most easily done with the
 128 .Xr ifconfig 8
 129 .Cm create
 130 command or using the
 131 .Va cloned_interfaces
 132 variable in
 133 .Xr rc.conf 5 .
 134 .Pp
 135 The MTU of the first interface to be added is used as the lagg MTU.
 136 All additional interfaces are required to have exactly the same value.
 137 .Pp
 138 The
 139 .Ic loadbalance
 140 and
 141 .Ic lacp
 142 modes will use the RSS hash from the network card if available to avoid
 143 computing one, this may give poor traffic distribution if the hash is invalid
 144 or uses less of the protocol header information.
 145 Local hash computation can be forced per interface by setting the
 146 .Va net.link.lagg.X.use_flowid
 147 .Xr sysctl 8
 148 variable to zero where X is the interface number.
 149 The default for new interfaces is set via the
 150 .Va net.link.lagg.default_use_flowid
 151 .Xr sysctl 8 .
 152 .Sh EXAMPLES
 153 Create a link aggregation using LACP with two
 154 .Xr bge 4
 155 Gigabit Ethernet interfaces:
 156 .Bd -literal -offset indent
 157 # ifconfig bge0 up
 158 # ifconfig bge1 up
 159 # ifconfig lagg0 laggproto lacp laggport bge0 laggport bge1 \e
 160         192.168.1.1 netmask 255.255.255.0
 161 .Ed
 162 .Pp
 163 The following example uses an active failover interface to set up roaming
 164 between wired and wireless networks using two network devices.
 165 Whenever the wired master interface is unplugged, the wireless failover
 166 device will be used:
 167 .Bd -literal -offset indent
 168 # ifconfig em0 up
 169 # ifconfig ath0 ether 00:11:22:33:44:55
 170 # ifconfig create wlan0 wlandev ath0 ssid my_net up
 171 # ifconfig lagg0 laggproto failover laggport em0 laggport wlan0 \e
 172         192.168.1.1 netmask 255.255.255.0
 173 .Ed
 174 .Pp
 175 (Note the mac address of the wireless device is forced to match the wired
 176 device as a workaround.)
 177 .Sh SEE ALSO
 178 .Xr ifmedia 4 ,
 179 .Xr ng_one2many 4 ,
 180 .Xr ifconfig 8 ,
 181 .Xr sysctl 8
 182 .Sh HISTORY
 183 The
 184 .Nm
 185 device first appeared in
 186 .Dx 3.9
 187 .Sh AUTHORS
 188 .An -nosplit
 189 The
 190 .Nm
 191 driver was written under the name
 192 .Nm trunk
 193 by
 194 .An Reyk Floeter Aq Mt reyk@openbsd.org .
 195 The LACP implementation was written by
 196 .An YAMAMOTO Takashi
 197 for
 198 .Nx .
 199 The
 200 .Fx
 201 version was ported to
 202 .Dx 3.9
 203 by
 204 .An Markus Pfeiffer Aq Mt profmakx@dragonflybsd.org .
 205 .Sh BUGS
 206 There is no way to configure LACP administrative variables, including system
 207 and port priorities.
 208 The current implementation always performs active-mode LACP and uses 0x8000 as
 209 system and port priorities.