libvirt-guests(8)

1LIBVIRT-GUESTS(8)           Virtualization Support           LIBVIRT-GUESTS(8)
2
3
4

NAME

6       libvirt-guests - suspend/resume running libvirt guests
7

SYNOPSIS

9       libvirt-guests COMMAND
10

DESCRIPTION

12       libvirt-guests  is  a  service that can be used to coordinate guest and
13       host lifecycle actions. By default, libvirt-guests will suspend running
14       guests when the host shuts down, and restore them to their pre-shutdown
15       state when the host reboots.
16
17       libvirt-guests  is  typically  under  control  of  systemd.  When  lib‐
18       virt-guests.service  is  enabled, systemd will call libvirt-guests with
19       the start COMMAND when the host boots. Conversely,  systemd  will  call
20       libvirt-guests with the stop COMMAND when the host shuts down.
21
22       libvirt-guests  can be used directly. In addition to the start and stop
23       COMMANDs, it also supports status, restart,  condrestart,  try-restart,
24       reload, force-reload, gueststatus, and shutdown COMMANDs.
25

FILES

27       libvirt-guests  defines  several variables to control service behavior.
28       The default value of these variables can be overridden in:
29
30       • /etc/sysconfig/libvirt-guests
31
32       The following variables are supported:
33
34       • URIS=default
35
36         URIs to check for running guests. Example: URIS='default  xen:///sys‐
37         tem xen+tcp://host/system lxc:///system'
38
39       • ON_BOOT=start
40
41         Action taken on host boot
42
43         • start
44
45           All  guests  which were running on shutdown are started on boot re‐
46           gardless of their autostart settings
47
48         • ignore
49
50           libvirt-guests won't start  any  guest  on  boot,  however,  guests
51           marked as autostart will still be automatically started by libvirtd
52
53       • START_DELAY=0
54
55         Number of seconds to wait between each guest start. Set to 0 to allow
56         parallel startup.
57
58       • ON_SHUTDOWN=suspend
59
60         Action taken on host shutdown
61
62         • suspend
63
64           All running guests are suspended using virsh managedsave
65
66         • shutdown
67
68           All running guests are asked to shutdown. Please  be  careful  with
69           this  settings since there is no way to distinguish between a guest
70           which is stuck or ignores shutdown requests and a guest which  just
71           needs  a  long time to shutdown. When setting ON_SHUTDOWN=shutdown,
72           you must also set SHUTDOWN_TIMEOUT to a  value  suitable  for  your
73           guests.
74
75       • PARALLEL_SHUTDOWN=0
76
77         Number  of  guests  will be shutdown concurrently, taking effect when
78         "ON_SHUTDOWN" is set to "shutdown". If Set to 0, guests will be shut‐
79         down one after another. Number of guests on shutdown at any time will
80         not exceed number set in this variable.
81
82       • SHUTDOWN_TIMEOUT=300
83
84         Number of seconds we're willing to wait for a guest to shut down.  If
85         parallel  shutdown  is enabled, this timeout applies as a timeout for
86         shutting down all guests on a single  URI  defined  in  the  variable
87         URIS.  If  this is 0, then there is no time out (use with caution, as
88         guests might not respond to a shutdown request). The default value is
89         300 seconds (5 minutes).
90
91       • BYPASS_CACHE=0
92
93         If  non-zero,  try  to  bypass  the file system cache when saving and
94         restoring guests, even though this may give slower operation for some
95         file systems.
96
97       • SYNC_TIME=0
98
99         If  non-zero, try to sync guest time on domain resume. Be aware, that
100         this requires guest agent with support for time synchronization  run‐
101         ning in the guest. By default, this functionality is turned off.
102

BUGS

104       Please report all bugs you discover.  This should be done via either:
105
106       1. the mailing list
107
108          https://libvirt.org/contact.html
109
110       2. the bug tracker
111
112          https://libvirt.org/bugs.html
113
114       Alternatively,  you may report bugs to your software distributor / ven‐
115       dor.
116

AUTHORS

118       Please refer to the AUTHORS file distributed with libvirt.
119

LICENSE

121       libvirt-guests is distributed under the terms of the  GNU  LGPL  v2.1+.
122       This  is free software; see the source for copying conditions. There is
123       NO warranty; not even for MERCHANTABILITY or FITNESS FOR  A  PARTICULAR
124       PURPOSE
125