xref: /openbsd-src/share/man/man4/aggr.4 (revision e4ffe84e4fab883d1d9f3b63f69a377c9ebedceb)
1.\" $OpenBSD: aggr.4,v 1.4 2020/09/02 05:53:55 jmc Exp $
2.\"
3.\" Copyright (c) 2019 David Gwynne <dlg@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.Dd $Mdocdate: September 2 2020 $
18.Dt AGGR 4
19.Os
20.Sh NAME
21.Nm aggr
22.Nd IEEE 802.1AX Link Aggregation network interface
23.Sh SYNOPSIS
24.Cd "pseudo-device aggr"
25.Sh DESCRIPTION
26The
27.Nm
28driver implements IEEE 802.1AX (formerly 802.3ad) Link Aggregation
29for combining one or more Ethernet interfaces into a single logical
30interface.
31The Link Aggregation Control Protocol (LACP) is used to negotiate the
32aggregation of member interfaces with a partner device.
33.Pp
34.Nm
35interfaces must be configured to use one or more Ethernet interfaces
36as ports, and communicate with a partner device over those
37ports using LACP.
38Member interfaces that negotiate with a partner device are
39aggregated into a single logical link.
40Packets transmitted through an
41.Nm
42interface select an aggregated interface for transmission.
43Packets received by an aggregated device appear to be received
44by the
45.Nm
46interface it is a member of.
47.Pp
48.Nm
49interfaces can be created at runtime using the
50.Ic ifconfig aggr Ns Ar N Ic create
51command or by setting up a
52.Xr hostname.if 5
53configuration file for
54.Xr netstart 8 .
55The interface itself can be configured with
56.Xr ifconfig 8 ;
57see its manual page for more information.
58.Pp
59A random MAC address is generated when an
60.Nm
61interface is created.
62A specific MAC address can be assigned using the
63.Xr ifconfig 8
64command
65.Cm lladdr Ar etheraddr .
66.\" document the ioctls?
67.Pp
68Other forms of aggregation of Ethernet interfaces are available
69using the
70.Xr trunk 4
71driver.
72.Sh EXAMPLES
73Create an
74.Nm
75virtual interface on top of two physical interfaces:
76.Bd -literal -offset indent
77# ifconfig aggr0 create
78# ifconfig aggr0 trunkport em0
79# ifconfig aggr0 trunkport em1
80# ifconfig aggr0 10.1.1.100/24
81# ifconfig aggr0 up
82.Ed
83.Sh SEE ALSO
84.Xr inet 4 ,
85.Xr ip 4 ,
86.Xr netintro 4 ,
87.Xr trunk 4 ,
88.Xr hostname.if 5 ,
89.Xr ifconfig 8 ,
90.Xr netstart 8
91.Sh STANDARDS
92.Rs
93.%T IEEE 802.1AX Link Aggregation
94.Re
95.Sh HISTORY
96The
97.Nm
98driver first appeared in
99.Ox 6.6 .
100