From ae60f3032567d6996989d49443df6fe1bf6c37de Mon Sep 17 00:00:00 2001 From: Samori Gorse Date: Wed, 12 Feb 2025 16:39:43 +0100 Subject: [PATCH] Updated state documentation --- plugins/modules/xen_orchestra_instance.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/plugins/modules/xen_orchestra_instance.py b/plugins/modules/xen_orchestra_instance.py index b2dd3f44e1..77eb01508e 100644 --- a/plugins/modules/xen_orchestra_instance.py +++ b/plugins/modules/xen_orchestra_instance.py @@ -41,7 +41,12 @@ options: type: bool default: true state: - description: State in which the Virtual Machine should be. + description: + - State in which the Virtual Machine should be. + - If O(state=present) then O(template) and O(label) are required. + - If O(state=absent), O(state=started), O(state=stopped) or O(state=restarted) then O(vm_uid) is required. + - When state is O(present) then O(boot_after_create) can be used to boot the VM after creation. + - There is no idempotence guarantee when O(state=present), a new VM will always be created. type: str choices: ['present', 'started', 'absent', 'stopped', 'restarted'] default: present