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