diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 8852d7d586..b118b49d1a 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -967,7 +967,13 @@

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 + virDomainReboot, + virDomainShutdown, or + virDomainShutdownFlags. + Using virsh reboot or virsh shutdown would + also trigger the event.

@@ -1004,20 +1010,29 @@
     
destroy
The domain will be terminated completely and all resources - released
+ released.
restart
-
The domain will be terminated, and then restarted with - the same configuration
+
The domain will be terminated and then restarted with + the same configuration.
preserve
-
The domain will be terminated, and its resource preserved +
The domain will be terminated and its resource preserved to allow analysis.
rename-restart
-
The domain will be terminated, and then restarted with - a new name
+
The domain will be terminated and then restarted with + a new name.

- on_crash supports these additional + QEMU/KVM supports the on_poweroff and on_reboot + events handling the destroy and restart actions. + The preserve action for an on_reboot event + is treated as a destroy and the rename-restart + action for an on_poweroff event is treated as a + restart event. +

+ +

+ The on_crash event supports these additional actions since 0.8.4.