xref: /freebsd/share/man/man4/hv_utils.4 (revision f81cdf24ba5436367377f7c8e8f51f6df2a75ca7)
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
33To compile this driver into the kernel, place the following lines in
34the system kernel configuration file:
35.Bd -ragged -offset indent
36.Cd "device hyperv"
37.Ed
38.Sh DESCRIPTION
39The
40.Nm
41driver provides time keeping, shutdown and heartbeat
42functionality for
43.Fx
44guest partitions running on Hyper-V.
45Hyper-V is a hypervisor-based virtualization technology from Microsoft.
46The
47.Nm
48driver is one of the core drivers required to be present in guest
49partitions running on Hyper-V.
50This driver provides the following
51functionalities to guest partitions:
52.Pp
53(a) Time Keeping: The clock inside the guest partition will remain accurate by
54synchronizing to the clock on the virtualization server via Timesync service,
55and with the help of the pluggable time source device.
56.Pp
57(b) Integrated shutdown: Guest partitions running
58.Fx
59can be shut down from
60Hyper-V Manager console by using the
61.Qq Shut down
62command.
63.Pp
64(c) Heartbeat: This feature allows the virtualization server to detect whether
65the 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
72Support for
73.Nm
74first appeared in
75.Fx 10.0 .
76The driver was developed through a joint effort between Citrix Incorporated,
77Microsoft Corporation, and Network Appliance Incorporated.
78.Sh AUTHORS
79.An -nosplit
80.Fx
81support for
82.Nm
83was first added by
84.An Microsoft BSD Integration Services Team Aq Mt bsdic@microsoft.com .
85