Skip to content

Commit ebfb19d

Browse files
committed
Document VM shutdown options
Signed-off-by: Justin Cinkelj <justin.cinkelj@xlab.si>
1 parent 8a0ebb4 commit ebfb19d

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

plugins/modules/vm.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,13 @@
6666
- Desired VM state.
6767
- States C(PAUSE) and C(LIVEMIGRATE) are not exposed in this module
6868
(this can be done with raw api module).
69+
- Note that
70+
- I(shutdown) will trigger a graceful ACPI shutdown.
71+
- I(reboot) will trigger a graceful ACPI reboot.
72+
- I(stop) will trigger an abrupt shutdown (force power off).
73+
VM might loose data, and filesystem might be corrupted afterwards.
74+
- I(reset) will trigger an abrupt reset (force power reset).
75+
VM might loose data, and filesystem might be corrupted afterwards.
6976
choices: [ start, shutdown, stop, reboot, reset ]
7077
type: str
7178
default: start

plugins/modules/vm_params.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,15 @@
5151
power_state:
5252
description:
5353
- Desired VM state.
54-
- States C(PAUSE) and C(LIVEMIGRATE) are not exposed in this module (this can be done with raw api module).
54+
- States C(PAUSE) and C(LIVEMIGRATE) are not exposed in this module
55+
(this can be done with raw api module).
56+
- Note that
57+
- I(shutdown) will trigger a graceful ACPI shutdown.
58+
- I(reboot) will trigger a graceful ACPI reboot.
59+
- I(stop) will trigger an abrupt shutdown (force power off).
60+
VM might loose data, and filesystem might be corrupted afterwards.
61+
- I(reset) will trigger an abrupt reset (force power reset).
62+
VM might loose data, and filesystem might be corrupted afterwards.
5563
choices: [ start, shutdown, stop, reboot, reset ]
5664
type: str
5765
operating_system:

0 commit comments

Comments
 (0)