xref: /netbsd-src/share/man/man4/vether.4 (revision cf036a1e8e0b980aa2c597acc9ddf56005d68496)
1.\"	$NetBSD: vether.4,v 1.6 2024/09/26 09:59:56 roy Exp $
2.\"
3.\"	$OpenBSD: vether.4,v 1.5 2017/10/17 22:47:58 schwarze Exp $
4.\"
5.\" Copyright (c) 2009 Theo de Raadt <deraadt@openbsd.org>
6.\"
7.\" Permission to use, copy, modify, and distribute this software for any
8.\" purpose with or without fee is hereby granted, provided that the above
9.\" copyright notice and this permission notice appear in all copies.
10.\"
11.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18.\"
19.Dd September 26, 2017
20.Dt VETHER 4
21.Os
22.Sh NAME
23.Nm vether
24.Nd virtual Ethernet interface
25.Sh SYNOPSIS
26.Cd "pseudo-device vether"
27.Sh DESCRIPTION
28The
29.Nm
30interface simulates a normal Ethernet interface by encapsulating
31standard network frames with an Ethernet header, specifically
32for use as a member in a
33.Xr bridge 4 .
34.Pp
35To use
36.Nm
37the administrator needs to configure an address onto the interface
38so that packets can be routed to it.
39An Ethernet header will be prepended and, if the
40.Nm
41interface is a member of a
42.Xr bridge 4 ,
43the frame will show up there.
44.Pp
45The
46.Nm
47link state can be controlled using
48.Xr ifconfig 8 :
49.Pp
50.Bl -tag -offset indent -width Cm -compact
51.It Cm media auto
52link state
53.Dq up
54.It Cm media none
55link state
56.Dq down
57.El
58.Sh SEE ALSO
59.Xr bridge 4 ,
60.Xr ifconfig 8
61.Sh HISTORY
62The
63.Nm
64interface first appeared in
65.Ox 4.7
66and
67.Nx 10 .
68.Sh AUTHORS
69.An Theo de Raadt Aq Mt deraadt@openbsd.org
70.Sh BUGS
71Like
72.Xr tap 4 ,
73the Ethernet address chosen will be partially random, and may
74occasionally collide with another address.
75