mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 20:31:27 -07:00
Clean up module documentation (#36909)
* Clean up module documentation This PR includes: - Removal of `default: None` (and variations) - Removal of `required: false` - Fixing booleans and `type: bool` where required * Fix remaining (new) validation issues
This commit is contained in:
parent
58eb2e849d
commit
cdd21e2170
624 changed files with 1458 additions and 9114 deletions
|
@ -25,10 +25,8 @@ options:
|
|||
- Whether or not to increment a single number with the name of the
|
||||
created servers. Only applicable when used with the I(group) attribute
|
||||
or meta key.
|
||||
default: yes
|
||||
choices:
|
||||
- "yes"
|
||||
- "no"
|
||||
type: bool
|
||||
default: 'yes'
|
||||
version_added: 1.5
|
||||
boot_from_volume:
|
||||
description:
|
||||
|
@ -36,10 +34,8 @@ options:
|
|||
If C(yes) and I(image) is specified a new volume will be created at
|
||||
boot time. I(boot_volume_size) is required with I(image) to create a
|
||||
new volume at boot time.
|
||||
default: "no"
|
||||
choices:
|
||||
- "yes"
|
||||
- "no"
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: 1.9
|
||||
boot_volume:
|
||||
description:
|
||||
|
@ -56,15 +52,14 @@ options:
|
|||
description:
|
||||
- Whether the I(boot_volume) or newly created volume from I(image) will
|
||||
be terminated when the server is terminated
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: 1.9
|
||||
config_drive:
|
||||
description:
|
||||
- Attach read-only configuration drive to server as label config-2
|
||||
default: no
|
||||
choices:
|
||||
- "yes"
|
||||
- "no"
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: 1.7
|
||||
count:
|
||||
description:
|
||||
|
@ -91,10 +86,8 @@ options:
|
|||
the servers matched, servers will be deleted to match the count. If
|
||||
the number of matched servers is fewer than specified in I(count)
|
||||
additional servers will be added.
|
||||
default: no
|
||||
choices:
|
||||
- "yes"
|
||||
- "no"
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: 1.4
|
||||
extra_client_args:
|
||||
description:
|
||||
|
@ -110,11 +103,9 @@ options:
|
|||
files:
|
||||
description:
|
||||
- Files to insert into the instance. remotefilename:localcontent
|
||||
default: null
|
||||
flavor:
|
||||
description:
|
||||
- flavor to use for the instance
|
||||
default: null
|
||||
group:
|
||||
description:
|
||||
- host group to assign to server, is also used for idempotent operations
|
||||
|
@ -125,7 +116,6 @@ options:
|
|||
- image to use for the instance. Can be an C(id), C(human_id) or C(name).
|
||||
With I(boot_from_volume), a Cloud Block Storage volume will be created
|
||||
with this image
|
||||
default: null
|
||||
instance_ids:
|
||||
description:
|
||||
- list of instance ids, currently only used when state='absent' to
|
||||
|
@ -134,17 +124,14 @@ options:
|
|||
key_name:
|
||||
description:
|
||||
- key pair to use on the instance
|
||||
default: null
|
||||
aliases:
|
||||
- keypair
|
||||
meta:
|
||||
description:
|
||||
- A hash of metadata to associate with the instance
|
||||
default: null
|
||||
name:
|
||||
description:
|
||||
- Name to give the instance
|
||||
default: null
|
||||
networks:
|
||||
description:
|
||||
- The network to attach to the instances. If specified, you must include
|
||||
|
@ -169,10 +156,8 @@ options:
|
|||
wait:
|
||||
description:
|
||||
- wait for the instance to be in state 'running' before returning
|
||||
default: "no"
|
||||
choices:
|
||||
- "yes"
|
||||
- "no"
|
||||
type: bool
|
||||
default: 'no'
|
||||
wait_timeout:
|
||||
description:
|
||||
- how long before wait gives up, in seconds
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue