xref: /freebsd/contrib/hyperv/tools/hv_kvp_daemon.8 (revision 57718be8fa0bd5edc11ab9a72e68cc71982939a6)
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.Dd September 10, 2013
26.Dt HYPER-V 4
27.Os
28.Sh NAME
29.Nm hv_kvp_daemon
30.Nd Hyper-V Key Value Pair Daemon
31.Sh SYNOPSIS
32The \fBhv_kvp_daemon\fP daemon provides the ability to store, retrieve, modify and delete
33Key Value pairs for FreeBSD guest partitions running on Hyper-V.
34.Sh DESCRIPTION
35Hyper-V allows administrators to store custom metadata in the form
36of Key Value pairs inside the FreeBSD guest partition. Administrators can
37use Windows Powershell scripts to add, read, modify and delete such
38Key Value pairs.
39
40The \fBhv_kvp_daemon\fP accepts Key Value pair management requests from the
41\fBhv_utils\fP driver and performs the actual metadata management on the file-system.
42
43The same daemon and driver combination is also used to set and get
44IP addresses from a FreeBSD guest.
45
46The set functionality is particularly
47useful when the FreeBSD guest is assigned a static IP address and is failed
48over from one Hyper-V host to another. After failover, Hyper-V uses the set IP
49functionality to automatically
50update the FreeBSD guest's IP address to its original static value.
51
52On the other hand, the get IP functionality is used to update the guest IP
53address in the Hyper-V management console window.
54.Sh SEE ALSO
55.Xr hv_vmbus 4 ,
56.Xr hv_utils 4 ,
57.Xr hv_netvsc 4 ,
58.Xr hv_storvsc 4 ,
59.Xr hv_ata_pci_disengage 4
60.Sh HISTORY
61Support for Hyper-V in the form of ports was first released in September 2013.
62The daemon was developed through a joint effort between Citrix Inc.,
63Microsoft Corp. and Network Appliance Inc..
64.Sh AUTHORS
65.An -nosplit
66.Fx
67support for \fBhv_kvp_daemon\fP was first added by
68.An Microsoft BSD Integration Services Team Aq bsdic@microsoft.com .
69