mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 04:11:25 -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
|
@ -48,56 +48,41 @@ options:
|
|||
description:
|
||||
- The cost associated with this interface.
|
||||
Valid values are an integer in the range from 1 to 65535.
|
||||
required: false
|
||||
default: null
|
||||
hello_interval:
|
||||
description:
|
||||
- Time between sending successive hello packets.
|
||||
Valid values are an integer in the range from 1 to 65535.
|
||||
required: false
|
||||
default: null
|
||||
dead_interval:
|
||||
description:
|
||||
- Time interval an ospf neighbor waits for a hello
|
||||
packet before tearing down adjacencies. Valid values are an
|
||||
integer in the range from 1 to 235926000.
|
||||
required: false
|
||||
default: null
|
||||
silent_interface:
|
||||
description:
|
||||
- Setting to true will prevent this interface from receiving
|
||||
HELLO packets. Valid values are 'true' and 'false'.
|
||||
required: false
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
auth_mode:
|
||||
description:
|
||||
- Specifies the authentication type.
|
||||
required: false
|
||||
choices: ['none', 'null', 'hmac-sha256', 'md5', 'hmac-md5', 'simple']
|
||||
default: null
|
||||
auth_text_simple:
|
||||
description:
|
||||
- Specifies a password for simple authentication.
|
||||
The value is a string of 1 to 8 characters.
|
||||
required: false
|
||||
default: null
|
||||
auth_key_id:
|
||||
description:
|
||||
- Authentication key id when C(auth_mode) is 'hmac-sha256', 'md5' or 'hmac-md5.
|
||||
Valid value is an integer is in the range from 1 to 255.
|
||||
required: false
|
||||
default: null
|
||||
auth_text_md5:
|
||||
description:
|
||||
- Specifies a password for MD5, HMAC-MD5, or HMAC-SHA256 authentication.
|
||||
The value is a string of 1 to 255 case-sensitive characters, spaces not supported.
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- Determines whether the config should be present or not
|
||||
on the device.
|
||||
required: false
|
||||
default: present
|
||||
choices: ['present','absent']
|
||||
"""
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue