mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-25 14:20:22 -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
|
@ -33,8 +33,6 @@ options:
|
|||
command syntax as some commands are automatically modified by the
|
||||
device config parser. The I(lines) argument only supports current
|
||||
context lines. See EXAMPLES
|
||||
required: false
|
||||
default: null
|
||||
aliases: ['commands']
|
||||
parents:
|
||||
description:
|
||||
|
@ -42,8 +40,6 @@ options:
|
|||
the commands should be checked against. If the parents argument
|
||||
is omitted, the commands are checked against the set of top
|
||||
level or global commands.
|
||||
required: false
|
||||
default: null
|
||||
src:
|
||||
description:
|
||||
- Specifies the source path to the file that contains the configuration
|
||||
|
@ -51,8 +47,6 @@ options:
|
|||
either be the full path on the Ansible control host or a relative
|
||||
path from the playbook or role root directory. This argument is mutually
|
||||
exclusive with I(lines), I(parents).
|
||||
required: false
|
||||
default: null
|
||||
version_added: "2.2"
|
||||
before:
|
||||
description:
|
||||
|
@ -61,16 +55,12 @@ options:
|
|||
the opportunity to perform configuration commands prior to pushing
|
||||
any changes without affecting how the set of commands are matched
|
||||
against the system.
|
||||
required: false
|
||||
default: null
|
||||
after:
|
||||
description:
|
||||
- The ordered set of commands to append to the end of the command
|
||||
stack if a change needs to be made. Just like with I(before) this
|
||||
allows the playbook designer to append a set of commands to be
|
||||
executed after the command set.
|
||||
required: false
|
||||
default: null
|
||||
match:
|
||||
description:
|
||||
- Instructs the module on the way to perform the matching of
|
||||
|
@ -81,7 +71,6 @@ options:
|
|||
must be an equal match. Finally, if match is set to I(none), the
|
||||
module will not attempt to compare the source configuration with
|
||||
the running configuration on the remote device.
|
||||
required: false
|
||||
default: line
|
||||
choices: ['line', 'strict', 'exact', 'none']
|
||||
replace:
|
||||
|
@ -92,7 +81,6 @@ options:
|
|||
mode. If the replace argument is set to I(block) then the entire
|
||||
command block is pushed to the device in configuration mode if any
|
||||
line is not correct.
|
||||
required: false
|
||||
default: line
|
||||
choices: ['line', 'block']
|
||||
force:
|
||||
|
@ -104,9 +92,7 @@ options:
|
|||
- Note this argument should be considered deprecated. To achieve
|
||||
the equivalent, set the C(match=none) which is idempotent. This argument
|
||||
will be removed in a future release.
|
||||
required: false
|
||||
default: false
|
||||
choices: [ "true", "false" ]
|
||||
type: bool
|
||||
version_added: "2.2"
|
||||
backup:
|
||||
description:
|
||||
|
@ -115,9 +101,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"
|
||||
config:
|
||||
description:
|
||||
|
@ -125,8 +110,6 @@ options:
|
|||
the base configuration to be used to validate configuration
|
||||
changes necessary. If this argument is provided, the module
|
||||
will not download the running-config from the remote node.
|
||||
required: false
|
||||
default: null
|
||||
version_added: "2.2"
|
||||
defaults:
|
||||
description:
|
||||
|
@ -134,9 +117,8 @@ options:
|
|||
when getting the remote device running config. When enabled,
|
||||
the module will get the current config by issuing the command
|
||||
C(show running-config all).
|
||||
required: false
|
||||
default: no
|
||||
choices: ['yes', 'no']
|
||||
type: bool
|
||||
default: 'no'
|
||||
aliases: ['detail']
|
||||
version_added: "2.2"
|
||||
save:
|
||||
|
@ -144,9 +126,8 @@ options:
|
|||
- The C(save) argument instructs the module to save the running-
|
||||
config to the startup-config at the conclusion of the module
|
||||
running. If check mode is specified, this argument is ignored.
|
||||
required: false
|
||||
default: no
|
||||
choices: ['yes', 'no']
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.2"
|
||||
"""
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue