xref: /freebsd/contrib/hyperv/tools/hv_kvp_daemon.8 (revision 2e3f49888ec8851bafb22011533217487764fdb0)
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
36The
37.Nm
38daemon provides the ability to store, retrieve, modify and delete
39Key Value pairs for
40.Fx
41guest partitions running on Hyper-V.
42.Pp
43Hyper-V allows administrators to store custom metadata in the form
44of Key Value pairs inside the
45.Fx
46guest partition.
47Administrators can
48use Windows Powershell scripts to add, read, modify and delete such
49Key Value pairs.
50.Pp
51The
52.Nm
53accepts Key Value pair management requests from the
54.Xr hv_utils 4
55driver and performs the actual metadata management on the file-system.
56.Pp
57The same daemon and driver combination is also used to set and get
58IP addresses from a
59.Fx
60guest.
61.Pp
62The set functionality is particularly
63useful when the
64.Fx
65guest is assigned a static IP address and is failed
66over from one Hyper-V host to another.
67After failover, Hyper-V uses the set IP
68functionality to automatically
69update the
70.Fx
71guest's IP address to its original static value.
72.Pp
73On the other hand, the get IP functionality is used to update the guest IP
74address in the Hyper-V management console window.
75.Pp
76The options are as follows:
77.Bl -tag -width indent
78.It Fl d
79Run as regular process instead of a daemon for debugging purpose.
80.It Fl n
81Generate 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
91Support for Hyper-V in the form of ports was first released in September 2013.
92The daemon was developed through a joint effort between Citrix Inc.,
93Microsoft Corp. and Network Appliance Inc..
94.Sh AUTHORS
95.An -nosplit
96.Fx
97support for
98.Nm
99was first added by
100.An Microsoft BSD Integration Services Team Aq Mt bsdic@microsoft.com .
101