xref: /freebsd/share/man/man4/hv_utils.4 (revision b2c76c41be32f904179efed29c0ca04d53f3996c)
1 .\"
2 .\" Copyright (c) 2012 Microsoft Corp.
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\"
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 .\" SUCH DAMAGE.
25 .\"
26 .Dd September 10, 2013
27 .Dt HYPER-V 4
28 .Os
29 .Sh NAME
30 .Nm hv_utils
31 .Nd Hyper-V Utilities Driver
32 .Sh SYNOPSIS
33 To compile this driver into the kernel, place the following lines in
34 the system kernel configuration file:
35 .Bd -ragged -offset indent
36 .Cd "device hyperv"
37 .Ed
38 .Sh DESCRIPTION
39 The
40 .Nm
41 driver provides time keeping, shutdown and heartbeat
42 functionality for
43 .Fx
44 guest partitions running on Hyper-V.
45 Hyper-V is a hypervisor-based virtualization technology from Microsoft.
46 The
47 .Nm
48 driver is one of the core drivers required to be present in guest
49 partitions running on Hyper-V.
50 This driver provides the following
51 functionalities to guest partitions:
52 .Pp
53 (a) Time Keeping: The clock inside the guest partition will remain accurate by
54 synchronizing to the clock on the virtualization server via Timesync service,
55 and with the help of the pluggable time source device.
56 .Pp
57 (b) Integrated shutdown: Guest partitions running
58 .Fx
59 can be shut down from
60 Hyper-V Manager console by using the
61 .Qq Shut down
62 command.
63 .Pp
64 (c) Heartbeat: This feature allows the virtualization server to detect whether
65 the guest partition is running and responsive.
66 .Sh SEE ALSO
67 .Xr hv_ata_pci_disengage 4 ,
68 .Xr hv_netvsc 4 ,
69 .Xr hv_storvsc 4 ,
70 .Xr hv_vmbus 4
71 .Sh HISTORY
72 Support for
73 .Nm
74 first appeared in
75 .Fx 10.0 .
76 The driver was developed through a joint effort between Citrix Incorporated,
77 Microsoft Corporation, and Network Appliance Incorporated.
78 .Sh AUTHORS
79 .An -nosplit
80 .Fx
81 support for
82 .Nm
83 was first added by
84 .An Microsoft BSD Integration Services Team Aq Mt bsdic@microsoft.com .
85