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