mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-08 01:14:03 -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
|
@ -51,66 +51,47 @@ options:
|
|||
sparse:
|
||||
description:
|
||||
- Enable/disable sparse-mode on the interface.
|
||||
required: false
|
||||
default: false
|
||||
choices: ['true', 'false']
|
||||
type: bool
|
||||
default: 'no'
|
||||
dr_prio:
|
||||
description:
|
||||
- Configures priority for PIM DR election on interface.
|
||||
hello_auth_key:
|
||||
description:
|
||||
- Authentication for hellos on this interface.
|
||||
required: false
|
||||
default: null
|
||||
hello_interval:
|
||||
description:
|
||||
- Hello interval in milliseconds for this interface.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['true', 'false']
|
||||
type: bool
|
||||
jp_policy_out:
|
||||
description:
|
||||
- Policy for join-prune messages (outbound).
|
||||
required: true
|
||||
default: null
|
||||
jp_policy_in:
|
||||
description:
|
||||
- Policy for join-prune messages (inbound).
|
||||
required: false
|
||||
default: null
|
||||
jp_type_out:
|
||||
description:
|
||||
- Type of policy mapped to C(jp_policy_out).
|
||||
required: false
|
||||
default: null
|
||||
choices: ['prefix', 'routemap']
|
||||
jp_type_in:
|
||||
description:
|
||||
- Type of policy mapped to C(jp_policy_in).
|
||||
required: false
|
||||
default: null
|
||||
choices: ['prefix', 'routemap']
|
||||
border:
|
||||
description:
|
||||
- Configures interface to be a boundary of a PIM domain.
|
||||
required: false
|
||||
default: false
|
||||
choices: ['true', 'false']
|
||||
type: bool
|
||||
default: 'no'
|
||||
neighbor_policy:
|
||||
description:
|
||||
- Configures a neighbor policy for filtering adjacencies.
|
||||
required: false
|
||||
default: null
|
||||
neighbor_type:
|
||||
description:
|
||||
- Type of policy mapped to neighbor_policy.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['prefix', 'routemap']
|
||||
state:
|
||||
description:
|
||||
- Manages desired state of the resource.
|
||||
required: false
|
||||
default: present
|
||||
choices: ['present', 'default']
|
||||
'''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue