mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 11:51:26 -07:00
[PR #6744/13e9e4b1 backport][stable-7] Add more semantic markup (#6747)
Add more semantic markup (#6744)
Add more semantic markup.
(cherry picked from commit 13e9e4b196
)
Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
parent
c35d8b560c
commit
ba559d24cd
143 changed files with 346 additions and 348 deletions
|
@ -39,8 +39,8 @@ options:
|
|||
state:
|
||||
description:
|
||||
- Specify the state VM should be in.
|
||||
- If C(state) is set to value other than C(present), then VM is transitioned into required state and facts are returned.
|
||||
- If C(state) is set to C(present), then VM is just checked for existence and facts are returned.
|
||||
- If O(state) is set to value other than V(present), then VM is transitioned into required state and facts are returned.
|
||||
- If O(state) is set to V(present), then VM is just checked for existence and facts are returned.
|
||||
type: str
|
||||
default: present
|
||||
choices: [ powered-on, powered-off, restarted, shutdown-guest, reboot-guest, suspended, present ]
|
||||
|
@ -48,7 +48,7 @@ options:
|
|||
description:
|
||||
- Name of the VM to manage.
|
||||
- VMs running on XenServer do not necessarily have unique names. The module will fail if multiple VMs with same name are found.
|
||||
- In case of multiple VMs with same name, use C(uuid) to uniquely specify VM to manage.
|
||||
- In case of multiple VMs with same name, use O(uuid) to uniquely specify VM to manage.
|
||||
- This parameter is case sensitive.
|
||||
type: str
|
||||
aliases: [ name_label ]
|
||||
|
@ -65,7 +65,7 @@ options:
|
|||
default: false
|
||||
state_change_timeout:
|
||||
description:
|
||||
- 'By default, module will wait indefinitely for VM to change state or acquire an IP address if C(wait_for_ip_address: true).'
|
||||
- 'By default, module will wait indefinitely for VM to change state or acquire an IP address if O(wait_for_ip_address=true).'
|
||||
- If this parameter is set to positive value, the module will instead wait specified number of seconds for the state change.
|
||||
- In case of timeout, module will generate an error message.
|
||||
type: int
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue