Skip to content

Commit

Permalink
proxmox_kvm: document that force requires archive (#8503)
Browse files Browse the repository at this point in the history
* proxmox_kvm: document that force requires archive

As per `qm(1)`, the force option requires `archive`. Add this
information in the `proxmox_kvm` module so one will know they have to
define `archive` when using `force`.

* fix: parameter is an option O(archive)

Co-authored-by: Felix Fontein <[email protected]>

---------

Co-authored-by: Felix Fontein <[email protected]>
  • Loading branch information
btravouillon and felixfontein authored Jun 17, 2024
1 parent b11da28 commit 3314d5c
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions plugins/modules/proxmox_kvm.py
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@
- Allow to force stop VM.
- Can be used with states V(stopped), V(restarted), and V(absent).
- This option has no default unless O(proxmox_default_behavior) is set to V(compatibility); then the default is V(false).
- Requires parameter O(archive).
type: bool
format:
description:
Expand Down

0 comments on commit 3314d5c

Please sign in to comment.