share/man/man4/hv_utils.4

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