mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-02 14:40:19 -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
|
@ -36,16 +36,12 @@ options:
|
|||
- The ordered set of configuration lines to be managed and
|
||||
compared with the existing configuration on the remote
|
||||
device.
|
||||
required: false
|
||||
default: null
|
||||
src:
|
||||
description:
|
||||
- The C(src) argument specifies the path to the source config
|
||||
file to load. The source config file can either be in
|
||||
bracket format or set format. The source file can include
|
||||
Jinja2 template variables.
|
||||
required: no
|
||||
default: null
|
||||
match:
|
||||
description:
|
||||
- The C(match) argument controls the method used to match
|
||||
|
@ -54,7 +50,6 @@ options:
|
|||
deltas are loaded. If the C(match) argument is set to C(none)
|
||||
the active configuration is ignored and the configuration is
|
||||
always loaded.
|
||||
required: false
|
||||
default: line
|
||||
choices: ['line', 'none']
|
||||
backup:
|
||||
|
@ -63,15 +58,13 @@ options:
|
|||
configuration to the Ansible control host prior to making any
|
||||
changes. The backup file will be located in the backup folder
|
||||
in the root of the playbook
|
||||
required: false
|
||||
default: false
|
||||
choices: ['yes', 'no']
|
||||
type: bool
|
||||
default: 'no'
|
||||
comment:
|
||||
description:
|
||||
- Allows a commit description to be specified to be included
|
||||
when the configuration is committed. If the configuration is
|
||||
not changed or committed, this argument is ignored.
|
||||
required: false
|
||||
default: 'configured by edgeos_config'
|
||||
config:
|
||||
description:
|
||||
|
@ -79,17 +72,14 @@ options:
|
|||
to compare against the desired configuration. If this value
|
||||
is not specified, the module will automatically retrieve the
|
||||
current active configuration from the remote device.
|
||||
required: false
|
||||
default: null
|
||||
save:
|
||||
description:
|
||||
- The C(save) argument controls whether or not changes made
|
||||
to the active configuration are saved to disk. This is
|
||||
independent of committing the config. When set to C(True), the
|
||||
active configuration is saved.
|
||||
required: false
|
||||
default: false
|
||||
choices: ['yes', 'no']
|
||||
type: bool
|
||||
default: 'no'
|
||||
"""
|
||||
|
||||
EXAMPLES = """
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue