From ebfb19da57e4b5ec2abf0eb18a9191ba93d25318 Mon Sep 17 00:00:00 2001 From: Justin Cinkelj Date: Tue, 14 Mar 2023 09:29:13 +0100 Subject: [PATCH] Document VM shutdown options Signed-off-by: Justin Cinkelj --- plugins/modules/vm.py | 7 +++++++ plugins/modules/vm_params.py | 10 +++++++++- 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/plugins/modules/vm.py b/plugins/modules/vm.py index 74fa451df..529926746 100644 --- a/plugins/modules/vm.py +++ b/plugins/modules/vm.py @@ -66,6 +66,13 @@ - Desired VM state. - States C(PAUSE) and C(LIVEMIGRATE) are not exposed in this module (this can be done with raw api module). + - Note that + - I(shutdown) will trigger a graceful ACPI shutdown. + - I(reboot) will trigger a graceful ACPI reboot. + - I(stop) will trigger an abrupt shutdown (force power off). + VM might loose data, and filesystem might be corrupted afterwards. + - I(reset) will trigger an abrupt reset (force power reset). + VM might loose data, and filesystem might be corrupted afterwards. choices: [ start, shutdown, stop, reboot, reset ] type: str default: start diff --git a/plugins/modules/vm_params.py b/plugins/modules/vm_params.py index 95c6a0089..6df2f6993 100644 --- a/plugins/modules/vm_params.py +++ b/plugins/modules/vm_params.py @@ -51,7 +51,15 @@ power_state: description: - Desired VM state. - - States C(PAUSE) and C(LIVEMIGRATE) are not exposed in this module (this can be done with raw api module). + - States C(PAUSE) and C(LIVEMIGRATE) are not exposed in this module + (this can be done with raw api module). + - Note that + - I(shutdown) will trigger a graceful ACPI shutdown. + - I(reboot) will trigger a graceful ACPI reboot. + - I(stop) will trigger an abrupt shutdown (force power off). + VM might loose data, and filesystem might be corrupted afterwards. + - I(reset) will trigger an abrupt reset (force power reset). + VM might loose data, and filesystem might be corrupted afterwards. choices: [ start, shutdown, stop, reboot, reset ] type: str operating_system: