Skip to content

Document VM shutdown options #169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 14, 2023
Merged

Document VM shutdown options #169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions plugins/modules/vm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 9 additions & 1 deletion plugins/modules/vm_params.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down