External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-12-22 21:55:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update formatdomain for lifecycle events

Browse Source
This commit is contained in:
John Ferlan 2013-04-23 17:51:08 -04:00
parent efdcc92faa
commit f60bd7c7a7
1 changed files with 23 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs/formatdomain.html.in
View File

@ -967,7 +967,13 @@
<p>
It is sometimes necessary to override the default actions taken
on various events.
on various events. Not all hypervisors support all events and actions.
The actions may be taken as a result of calls to libvirt APIs
<code class='docref'>virDomainReboot</code>,
<code class='docref'>virDomainShutdown</code>, or
<code class='docref'>virDomainShutdownFlags</code>.
Using <code>virsh reboot</code> or <code>virsh shutdown</code> would
also trigger the event.
</p>
<pre>
@ -1004,20 +1010,29 @@
<dl>
<dt><code>destroy</code></dt>
<dd>The domain will be terminated completely and all resources
released</dd>
released.</dd>
<dt><code>restart</code></dt>
<dd>The domain will be terminated, and then restarted with
the same configuration</dd>
<dd>The domain will be terminated and then restarted with
the same configuration.</dd>
<dt><code>preserve</code></dt>
<dd>The domain will be terminated, and its resource preserved
<dd>The domain will be terminated and its resource preserved
to allow analysis.</dd>
<dt><code>rename-restart</code></dt>
<dd>The domain will be terminated, and then restarted with
a new name</dd>
<dd>The domain will be terminated and then restarted with
a new name.</dd>
</dl>
<p>
on_crash supports these additional
QEMU/KVM supports the <code>on_poweroff</code> and <code>on_reboot</code>
events handling the <code>destroy</code> and <code>restart</code> actions.
The <code>preserve</code> action for an <code>on_reboot</code> event
is treated as a <code>destroy</code> and the <code>rename-restart</code>
action for an <code>on_poweroff</code> event is treated as a
<code>restart</code> event.
</p>
<p>
The <code>on_crash</code> event supports these additional
actions <span class="since">since 0.8.4</span>.
</p>