xref: /netbsd-src/share/man/man4/vlan.4 (revision 3b01aba77a7a698587faaae455bbfe740923c1f5)
1.\"	$NetBSD: vlan.4,v 1.14 2001/07/01 02:04:57 gmcgarry Exp $
2.\"
3.\" Copyright (c) 2000 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Jason R. Thorpe of Zembu Labs, Inc.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\" 3. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgement:
19.\"        This product includes software developed by the NetBSD
20.\"        Foundation, Inc. and its contributors.
21.\" 4. Neither the name of The NetBSD Foundation nor the names of its
22.\"    contributors may be used to endorse or promote products derived
23.\"    from this software without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35.\" POSSIBILITY OF SUCH DAMAGE.
36.\"
37.Dd June 26, 2001
38.Dt VLAN 4
39.Os
40.Sh NAME
41.Nm vlan
42.Nd IEEE 802.1Q Virtual LAN network device
43.Sh SYNOPSIS
44.Cd "pseudo-device vlan"
45.Sh DESCRIPTION
46The
47.Nm
48interface provides support for IEEE 802.1Q Virtual LANs.  This allows the
49trunking of more than one network on a single network interface.
50This is particularly useful on routers or on hosts which must be
51connected to many different networks.
52.Pp
53To use a
54.Nm vlan
55interface, the administrator must first create the interface and then
56specify the VLAN tag and physical interface associated with the VLAN.
57This can be done by using the
58.Xr ifconfig 8
59.Sq create ,
60.Sq vlan ,
61and
62.Sq vlanif
63subcommands, or
64.Dv SIOCSIFCREATE
65and
66.Dv SIOCSIFVLAN
67ioctls.
68.Pp
69To be compatible with others 802.1Q devices, the
70.Nm
71interface shall support a 1500 bytes MTU, which means that the parent
72interface will have to handle frames that are 4 bytes larger than the
73ethernet MTU. Drivers supporting this increased MTU are:
74.Bl -dash -compact indent
75.It
76drivers using the dp8390 core
77.Ns ( Ns Xr ec 4 ,
78.Xr ne 4 ,
79.Xr we 4 ,
80possibly others)
81.It
82.Xr ea 4
83.It
84.Xr eb 4
85.It
86.Xr epic 4
87.It
88.Xr ex 4
89.It
90.Xr fxp 4
91.It
92.Xr le 4
93.It
94.Xr tlp 4
95.It
96.Xr ti 4
97.It
98.Xr xi 4
99.El
100.Nm
101can be used with devices not supporting the 802.1Q MTU, but then the MTU of the
102.Nm
103interface will be 4 bytes too small and will not interoperate properly with
104other 802.1Q devices, unless the MTU of the remote end is also lowered.
105.Sh SEE ALSO
106.Xr ifconfig 8
107.Sh HISTORY
108The
109.Nm
110device first appeared in
111.Nx 1.5.1 .
112.Sh BUGS
113The
114.Nm
115interfaces do not currently inherit changes made to the physical
116interfaces's MTU.
117.Sh AUTHOR
118The
119.Nm
120driver was integrated by
121.An Andrew Doran
122.Aq ad@netbsd.org
123and
124.An Jason R. Thorpe
125.Aq thorpej@zembu.com .
126It was derived from a VLAN implementation that appeared in
127.Fx
128and
129.Ox .
130