xref: /netbsd-src/share/man/man4/vmt.4 (revision 82d56013d7b633d116a93943de88e08335357a7c)
1.\"	$NetBSD: vmt.4,v 1.3 2020/10/27 08:57:10 ryo Exp $
2.\"	$OpenBSD: vmt.4,v 1.4 2010/10/26 05:07:31 jmc Exp $
3.\"
4.\" Copyright (c) 2008 Marco Peereboom <marco@openbsd.org>
5.\" Text was heavily borrowed from the IPMI spec V1.5
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 TORTIOUS ACTION, ARISING OUT OF
17.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18.Dd October 6, 2013
19.Dt VMT 4 x86
20.Os
21.Sh NAME
22.Nm vmt
23.Nd VMware Tools driver
24.Sh SYNOPSIS
25.Cd "vmt0 at cpu0"
26.Cd "vmt0 at fdt?"
27.Sh DESCRIPTION
28The
29.Nm
30driver is a kernel level implementation of VMware Tools.
31VMware Tools are intended to provide better support for operating systems
32running inside virtual machines.
33.Pp
34.Nm
35handles shutdown, reboot, resume requests from the host by sending
36events using
37.Xr sysmon_pswitch 9
38of type PSWITCH_TYPE_POWER, PSWITCH_TYPE_RESET, and PSWITCH_TYPE_SLEEP that
39can be handled by
40.Xr powerd 8 .
41.Nm
42will log notifications that the guest has been suspended or resumed by the
43host.
44.\" It also provides access to the host machine's clock as a timedelta sensor.
45.Pp
46.Nm
47reports the guest's hostname and first non-loopback IP address to the host.
48.Ss Clock synchronization
49The
50.Nm
51driver synchronizes the virtual machine's clock with the host clock in the
52following situations:
53.Bl -bullet
54.It
55When the virtual machine resumes after having been suspended.
56.It
57Periodically with the interval indicated by the
58.Va machdep.vmt0.clock_sync.period
59.Xr sysctl 8
60variable.
61This is done so that the virtual machine can keep its clock synchronized
62when the host is suspended, because in this case the
63.Nm
64driver receives no notification of such an event.
65Setting this tunable to zero disables clock synchronization.
66.El
67.Sh SEE ALSO
68.\" .Xr cpu 4 ,
69.Xr powerd 8
70.Sh HISTORY
71The
72.Nm
73driver first appeared in
74.Ox 4.4
75and was then ported to
76.Nx 6.0 .
77.Sh AUTHORS
78The
79.Nm
80driver was written by
81.An David Gwynne Aq Mt dlg@openbsd.org .
82