mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-04 15:29:10 -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
|
@ -35,55 +35,41 @@ options:
|
|||
- Specifies the name of a BFD session.
|
||||
The value is a string of 1 to 15 case-sensitive characters without spaces.
|
||||
required: true
|
||||
default: null
|
||||
create_type:
|
||||
description:
|
||||
- BFD session creation mode, the currently created BFD session
|
||||
only supports static or static auto-negotiation mode.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['static', 'auto']
|
||||
addr_type:
|
||||
description:
|
||||
- Specifies the peer IP address type.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['ipv4']
|
||||
out_if_name:
|
||||
description:
|
||||
- Specifies the type and number of the interface bound to the BFD session.
|
||||
required: false
|
||||
default: null
|
||||
dest_addr:
|
||||
description:
|
||||
- Specifies the peer IP address bound to the BFD session.
|
||||
required: false
|
||||
default: null
|
||||
src_addr:
|
||||
description:
|
||||
- Indicates the source IP address carried in BFD packets.
|
||||
required: false
|
||||
default: null
|
||||
vrf_name:
|
||||
description:
|
||||
- Specifies the name of a Virtual Private Network (VPN) instance that is bound to a BFD session.
|
||||
The value is a string of 1 to 31 case-sensitive characters, spaces not supported.
|
||||
When double quotation marks are used around the string, spaces are allowed in the string.
|
||||
The value _public_ is reserved and cannot be used as the VPN instance name.
|
||||
required: false
|
||||
default: null
|
||||
use_default_ip:
|
||||
description:
|
||||
- Indicates the default multicast IP address that is bound to a BFD session.
|
||||
By default, BFD uses the multicast IP address 224.0.0.184.
|
||||
You can set the multicast IP address by running the default-ip-address command.
|
||||
The value is a bool type.
|
||||
required: false
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
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