mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-02 06:30: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
|
@ -32,8 +32,6 @@ options:
|
|||
lines to push into the remote device. Each line must start with
|
||||
either C(set) or C(delete). This argument is mutually exclusive
|
||||
with the I(src) argument.
|
||||
required: false
|
||||
default: null
|
||||
src:
|
||||
description:
|
||||
- The I(src) argument provides a path to the configuration file
|
||||
|
@ -41,8 +39,6 @@ options:
|
|||
system path to the configuration file if the value starts with /
|
||||
or relative to the root of the implemented role or playbook.
|
||||
This argument is mutually exclusive with the I(lines) argument.
|
||||
required: false
|
||||
default: null
|
||||
version_added: "2.2"
|
||||
src_format:
|
||||
description:
|
||||
|
@ -50,8 +46,6 @@ options:
|
|||
found int I(src). If the I(src_format) argument is not provided,
|
||||
the module will attempt to determine the format of the configuration
|
||||
file specified in I(src).
|
||||
required: false
|
||||
default: null
|
||||
choices: ['xml', 'set', 'text', 'json']
|
||||
version_added: "2.2"
|
||||
rollback:
|
||||
|
@ -61,16 +55,12 @@ options:
|
|||
argument. If the specified rollback identifier does not
|
||||
exist on the remote device, the module will fail. To rollback
|
||||
to the most recent commit, set the C(rollback) argument to 0.
|
||||
required: false
|
||||
default: null
|
||||
zeroize:
|
||||
description:
|
||||
- The C(zeroize) argument is used to completely sanitize the
|
||||
remote device configuration back to initial defaults. This
|
||||
argument will effectively remove all current configuration
|
||||
statements on the remote device.
|
||||
required: false
|
||||
default: null
|
||||
confirm:
|
||||
description:
|
||||
- The C(confirm) argument will configure a time out value for
|
||||
|
@ -78,14 +68,12 @@ options:
|
|||
rolled back. If the C(confirm) argument is set to False, this
|
||||
argument is silently ignored. If the value for this argument
|
||||
is set to 0, the commit is confirmed immediately.
|
||||
required: false
|
||||
default: 0
|
||||
comment:
|
||||
description:
|
||||
- The C(comment) argument specifies a text string to be used
|
||||
when committing the configuration. If the C(confirm) argument
|
||||
is set to False, this argument is silently ignored.
|
||||
required: false
|
||||
default: configured by junos_config
|
||||
replace:
|
||||
description:
|
||||
|
@ -97,9 +85,8 @@ options:
|
|||
the equivalent, set the I(update) argument to C(replace). This argument
|
||||
will be removed in a future release. The C(replace) and C(update) argument
|
||||
is mutually exclusive.
|
||||
required: false
|
||||
choices: ['yes', 'no']
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
backup:
|
||||
description:
|
||||
- This argument will cause the module to create a full backup of
|
||||
|
@ -107,9 +94,8 @@ options:
|
|||
changes are made. The backup file is written to the C(backup)
|
||||
folder in the playbook root directory. If the directory does not
|
||||
exist, it is created.
|
||||
required: false
|
||||
default: no
|
||||
choices: ['yes', 'no']
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.2"
|
||||
update:
|
||||
description:
|
||||
|
@ -125,7 +111,6 @@ options:
|
|||
it with the loaded configuration.
|
||||
C(replace) substitutes each hierarchy level in the loaded configuration
|
||||
for the corresponding level.
|
||||
required: false
|
||||
default: merge
|
||||
choices: ['merge', 'override', 'replace']
|
||||
version_added: "2.3"
|
||||
|
@ -133,9 +118,8 @@ options:
|
|||
description:
|
||||
- This argument will execute commit operation on remote device.
|
||||
It can be used to confirm a previous commit.
|
||||
required: false
|
||||
default: no
|
||||
choices: ['yes', 'no']
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.4"
|
||||
requirements:
|
||||
- ncclient (>=v0.5.2)
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue