mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-24 13:50: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,7 +33,6 @@ options:
|
|||
The I(src) argument can be either a localized path or a full
|
||||
path to the package file to install.
|
||||
required: true
|
||||
default: null
|
||||
aliases: ['package']
|
||||
version:
|
||||
description:
|
||||
|
@ -41,8 +40,6 @@ options:
|
|||
version of the package that should be installed on the remote
|
||||
device. If the I(version) argument is not specified, then
|
||||
the version is extracts from the I(src) filename.
|
||||
required: false
|
||||
default: null
|
||||
reboot:
|
||||
description:
|
||||
- In order for a package to take effect, the remote device must be
|
||||
|
@ -51,16 +48,15 @@ options:
|
|||
If disabled or the remote package does not need to be changed,
|
||||
the device will not be started.
|
||||
required: true
|
||||
default: true
|
||||
choices: ['true', 'false']
|
||||
type: bool
|
||||
default: 'yes'
|
||||
no_copy:
|
||||
description:
|
||||
- The I(no_copy) argument is responsible for instructing the remote
|
||||
device on where to install the package from. When enabled, the
|
||||
package is transferred to the remote device prior to installing.
|
||||
required: false
|
||||
default: false
|
||||
choices: ['true', 'false']
|
||||
type: bool
|
||||
default: 'no'
|
||||
validate:
|
||||
description:
|
||||
- The I(validate) argument is responsible for instructing the remote
|
||||
|
@ -68,17 +64,16 @@ options:
|
|||
compatibility with the package being installed. When set to false
|
||||
validation is not performed.
|
||||
version_added: 2.5
|
||||
required: false
|
||||
default: true
|
||||
choices: ['true', 'false']
|
||||
type: bool
|
||||
default: 'yes'
|
||||
force:
|
||||
description:
|
||||
- The I(force) argument instructs the module to bypass the package
|
||||
version check and install the packaged identified in I(src) on
|
||||
the remote device.
|
||||
required: true
|
||||
default: false
|
||||
choices: ['true', 'false']
|
||||
type: bool
|
||||
default: 'no'
|
||||
requirements:
|
||||
- junos-eznc
|
||||
- ncclient (>=v0.5.2)
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue