xref: /openbsd-src/usr.sbin/vmd/vmd.8 (revision f2da64fbbbf1b03f09f390ab01267c93dfd77c4c)
1.\"	$OpenBSD: vmd.8,v 1.6 2016/06/10 18:32:40 jmc Exp $
2.\"
3.\" Copyright (c) 2015 Mike Larkin <mlarkin@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: June 10 2016 $
18.Dt VMD 8
19.Os
20.Sh NAME
21.Nm vmd
22.Nd virtual machine daemon
23.Sh SYNOPSIS
24.Nm vmd
25.Op Fl dnv
26.Op Fl D Ar macro Ns = Ns Ar value
27.Op Fl f Ar file
28.Sh DESCRIPTION
29.Nm
30is a daemon responsible for the execution of virtual machines (VMs) on a
31host.
32.Nm
33is typically started at boot time and is controlled via
34.Xr vmctl 8 .
35.Pp
36.Nm
37can be enabled during system boot by setting the following in
38.Pa /etc/rc.conf.local :
39.Pp
40.Dl vmd_flags=\&"\&"
41.Pp
42.Nm
43interfaces with the virtual machine monitor (VMM) built into the kernel.
44One instance of
45.Nm
46will be spawned for each VM running on the host, plus an extra instance
47for control operations.
48Each child
49.Nm
50will in turn create one or more VCPU (virtual CPU) threads responsible for
51driving the VM's operations using
52.Xr vmm 4 .
53.Pp
54.Nm
55is also responsible for proxying various other commands/requests from
56.Xr vmctl 8 ,
57such as stopping VMs, and retrieving information from
58.Xr vmm 4
59about running VMs.
60.Pp
61The options are as follows:
62.Bl -tag -width Dssmacro=value
63.It Fl D Ar macro Ns = Ns Ar value
64Define
65.Ar macro
66to be set to
67.Ar value
68on the command line.
69Overrides the definition of
70.Ar macro
71in the configuration file.
72.It Fl d
73Do not daemonize and log to
74.Em stderr .
75.It Fl f Ar file
76Specify an alternative configuration file.
77The default is
78.Pa /etc/vm.conf .
79.It Fl n
80Configtest mode.
81Only check the configuration file for validity.
82.It Fl v
83Verbose mode.
84Multiple
85.Fl v
86options increase the verbosity.
87.El
88.Sh FILES
89.Bl -tag -width "/var/run/vmd.sockXX" -compact
90.It Pa /etc/vm.conf
91Default configuration file.
92This is optional.
93.It Pa /var/run/vmd.sock
94.Ux Ns -domain
95socket used for communication with
96.Xr vmctl 8 .
97.El
98.Sh SEE ALSO
99.Xr vmm 4 ,
100.Xr vm.conf 5 ,
101.Xr rc.conf 8 ,
102.Xr vmctl 8
103.Sh HISTORY
104The
105.Nm
106command first appeared in
107.Ox 5.9 .
108.Sh AUTHORS
109.An Mike Larkin Aq Mt mlarkin@openbsd.org
110and
111.An Reyk Floeter Aq Mt reyk@openbsd.org
112