contrib/hyperv/tools/hv_kvp_daemon.8

   1 .\" Copyright (c) 2014 Microsoft Corp.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .Dd October 27, 2014
  27 .Dt HV_KVP_DAEMON 8
  28 .Os
  29 .Sh NAME
  30 .Nm hv_kvp_daemon
  31 .Nd Hyper-V Key Value Pair Daemon
  32 .Sh SYNOPSIS
  33 .Nm
  34 .Op Fl dn
  35 .Sh DESCRIPTION
  36 The
  37 .Nm
  38 daemon provides the ability to store, retrieve, modify and delete
  39 Key Value pairs for
  40 .Fx
  41 guest partitions running on Hyper-V.
  42 .Pp
  43 Hyper-V allows administrators to store custom metadata in the form
  44 of Key Value pairs inside the
  45 .Fx
  46 guest partition.
  47 Administrators can
  48 use Windows Powershell scripts to add, read, modify and delete such
  49 Key Value pairs.
  50 .Pp
  51 The
  52 .Nm
  53 accepts Key Value pair management requests from the
  54 .Xr hv_utils 4
  55 driver and performs the actual metadata management on the file-system.
  56 .Pp
  57 The same daemon and driver combination is also used to set and get
  58 IP addresses from a
  59 .Fx
  60 guest.
  61 .Pp
  62 The set functionality is particularly
  63 useful when the
  64 .Fx
  65 guest is assigned a static IP address and is failed
  66 over from one Hyper-V host to another.
  67 After failover, Hyper-V uses the set IP
  68 functionality to automatically
  69 update the
  70 .Fx
  71 guest's IP address to its original static value.
  72 .Pp
  73 On the other hand, the get IP functionality is used to update the guest IP
  74 address in the Hyper-V management console window.
  75 .Pp
  76 The options are as follows:
  77 .Bl -tag -width indent
  78 .It Fl d
  79 Run as regular process instead of a daemon for debugging purpose.
  80 .It Fl n
  81 Generate debugging output.
  82 .El
  83 .Sh SEE ALSO
  84 .Xr hv_vmbus 4 ,
  85 .Xr hv_utils 4 ,
  86 .Xr hv_netvsc 4 ,
  87 .Xr hv_storvsc 4 ,
  88 .Xr hv_ata_pci_disengage 4 ,
  89 .Xr hv_kvp 4
  90 .Sh HISTORY
  91 Support for Hyper-V in the form of ports was first released in September 2013.
  92 The daemon was developed through a joint effort between Citrix Inc.,
  93 Microsoft Corp. and Network Appliance Inc..
  94 .Sh AUTHORS
  95 .An -nosplit
  96 .Fx
  97 support for
  98 .Nm
  99 was first added by
 100 .An Microsoft BSD Integration Services Team Aq Mt bsdic@microsoft.com .