mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-05-28 03:49:09 -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
|
@ -29,12 +29,11 @@ options:
|
|||
attempt to execute all commands in non-privileged mode. If the value
|
||||
is not specified in the task, the value of environment variable
|
||||
C(ANSIBLE_NET_AUTHORIZE) will be used instead.
|
||||
default: no
|
||||
choices: ['yes', 'no']
|
||||
type: bool
|
||||
default: 'no'
|
||||
provider:
|
||||
description:
|
||||
- A dict object containing connection details.
|
||||
default: null
|
||||
suboptions:
|
||||
host:
|
||||
description:
|
||||
|
@ -58,7 +57,6 @@ options:
|
|||
the remote device. This value is used to authenticate
|
||||
the SSH session. If the value is not specified in the task, the
|
||||
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
|
||||
default: null
|
||||
ssh_keyfile:
|
||||
description:
|
||||
- Specifies the SSH key to use to authenticate the connection to
|
||||
|
@ -73,15 +71,14 @@ options:
|
|||
attempt to execute all commands in non-privileged mode. If the value
|
||||
is not specified in the task, the value of environment variable
|
||||
C(ANSIBLE_NET_AUTHORIZE) will be used instead.
|
||||
default: no
|
||||
choices: ['yes', 'no']
|
||||
type: bool
|
||||
default: 'no'
|
||||
auth_pass:
|
||||
description:
|
||||
- Specifies the password to use if required to enter privileged mode
|
||||
on the remote device. If I(authorize) is false, then this argument
|
||||
does nothing. If the value is not specified in the task, the value of
|
||||
environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead.
|
||||
default: none
|
||||
timeout:
|
||||
description:
|
||||
- Specifies idle timeout in seconds for the connection, in seconds. Useful
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue