xref: /freebsd/contrib/hyperv/tools/hv_vss_daemon.8 (revision 67bc8c8b9e69bc53221a9bd914e418d81d6cdc7d)
1*168fce73SSepherosa Ziehau.\" Copyright (c) 2016 Microsoft Corp.
2*168fce73SSepherosa Ziehau.\" All rights reserved.
3*168fce73SSepherosa Ziehau.\"
4*168fce73SSepherosa Ziehau.\" Redistribution and use in source and binary forms, with or without
5*168fce73SSepherosa Ziehau.\" modification, are permitted provided that the following conditions
6*168fce73SSepherosa Ziehau.\" are met:
7*168fce73SSepherosa Ziehau.\" 1. Redistributions of source code must retain the above copyright
8*168fce73SSepherosa Ziehau.\"    notice, this list of conditions and the following disclaimer.
9*168fce73SSepherosa Ziehau.\" 2. Redistributions in binary form must reproduce the above copyright
10*168fce73SSepherosa Ziehau.\"    notice, this list of conditions and the following disclaimer in the
11*168fce73SSepherosa Ziehau.\"    documentation and/or other materials provided with the distribution.
12*168fce73SSepherosa Ziehau.\"
13*168fce73SSepherosa Ziehau.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14*168fce73SSepherosa Ziehau.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15*168fce73SSepherosa Ziehau.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16*168fce73SSepherosa Ziehau.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17*168fce73SSepherosa Ziehau.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18*168fce73SSepherosa Ziehau.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19*168fce73SSepherosa Ziehau.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20*168fce73SSepherosa Ziehau.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21*168fce73SSepherosa Ziehau.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22*168fce73SSepherosa Ziehau.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23*168fce73SSepherosa Ziehau.\" SUCH DAMAGE.
24*168fce73SSepherosa Ziehau.\"
25*168fce73SSepherosa Ziehau.\" $FreeBSD$
26*168fce73SSepherosa Ziehau.Dd October 12, 2016
27*168fce73SSepherosa Ziehau.Dt HV_VSS_DAEMON 8
28*168fce73SSepherosa Ziehau.Os
29*168fce73SSepherosa Ziehau.Sh NAME
30*168fce73SSepherosa Ziehau.Nm hv_vss_daemon
31*168fce73SSepherosa Ziehau.Nd Hyper-V Volume Shadow Copy Service Daemon
32*168fce73SSepherosa Ziehau.Sh SYNOPSIS
33*168fce73SSepherosa Ziehau.Nm
34*168fce73SSepherosa Ziehau.Op Fl dn
35*168fce73SSepherosa Ziehau.Sh DESCRIPTION
36*168fce73SSepherosa ZiehauThe
37*168fce73SSepherosa Ziehau.Nm
38*168fce73SSepherosa Ziehaudaemon provides the ability to freeze and thaw the file system for
39*168fce73SSepherosa Ziehau.Fx
40*168fce73SSepherosa Ziehauguest partitions running on Hyper-V.
41*168fce73SSepherosa Ziehau.Pp
42*168fce73SSepherosa ZiehauHyper-V allows administrators to backup or restore the
43*168fce73SSepherosa Ziehau.Fx
44*168fce73SSepherosa Ziehauguest partition.
45*168fce73SSepherosa ZiehauAdministrators can
46*168fce73SSepherosa Ziehauuse Windows Powershell scripts to backup or restore the
47*168fce73SSepherosa Ziehau.Fx
48*168fce73SSepherosa ZiehauVM.
49*168fce73SSepherosa Ziehau.Pp
50*168fce73SSepherosa ZiehauThe
51*168fce73SSepherosa Ziehau.Nm
52*168fce73SSepherosa Ziehauaccepts file system freeze and thaw requests from the
53*168fce73SSepherosa Ziehau.Xr hv_utils 4
54*168fce73SSepherosa Ziehaudriver and performs the actual file-system operation.
55*168fce73SSepherosa Ziehau.Pp
56*168fce73SSepherosa ZiehauThe file system freeze and thaw functionality is
57*168fce73SSepherosa Ziehauuseful when the Hyper-V host wants to do live backup of
58*168fce73SSepherosa Ziehau.Fx
59*168fce73SSepherosa Ziehauguest. Hyper-V host sends file system freezing request to
60*168fce73SSepherosa Ziehau.Nm
61*168fce73SSepherosa Ziehauwhich conducts the real operation. After successfully freezing file
62*168fce73SSepherosa Ziehausystem, Hyper-V host takes a snapshot of the VM. In the future,
63*168fce73SSepherosa ZiehauHyper-V host can restore the
64*168fce73SSepherosa Ziehau.Fx
65*168fce73SSepherosa ZiehauVM through that snapshot.
66*168fce73SSepherosa Ziehau.Pp
67*168fce73SSepherosa ZiehauThe options are as follows:
68*168fce73SSepherosa Ziehau.Bl -tag -width indent
69*168fce73SSepherosa Ziehau.It Fl d
70*168fce73SSepherosa ZiehauRun as regular process instead of a daemon for debugging purpose.
71*168fce73SSepherosa Ziehau.It Fl n
72*168fce73SSepherosa ZiehauGenerate debugging output.
73*168fce73SSepherosa Ziehau.El
74*168fce73SSepherosa Ziehau.Sh SEE ALSO
75*168fce73SSepherosa Ziehau.Xr hv_vmbus 4 ,
76*168fce73SSepherosa Ziehau.Xr hv_utils 4 ,
77*168fce73SSepherosa Ziehau.Xr hv_netvsc 4 ,
78*168fce73SSepherosa Ziehau.Xr hv_storvsc 4 ,
79*168fce73SSepherosa Ziehau.Xr hv_kvp 4
80*168fce73SSepherosa Ziehau.Sh HISTORY
81*168fce73SSepherosa ZiehauThe daemon was introduced in October 2016 and developed by Microsoft Corp.
82*168fce73SSepherosa Ziehau.Sh AUTHORS
83*168fce73SSepherosa Ziehau.An -nosplit
84*168fce73SSepherosa Ziehau.Fx
85*168fce73SSepherosa Ziehausupport for
86*168fce73SSepherosa Ziehau.Nm
87*168fce73SSepherosa Ziehauwas first added by
88*168fce73SSepherosa Ziehau.An Microsoft BSD Integration Services Team Aq Mt bsdic@microsoft.com .
89