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:
Dag Wieers 2018-03-15 22:15:24 +01:00 committed by GitHub
parent 58eb2e849d
commit cdd21e2170
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
624 changed files with 1458 additions and 9114 deletions

View file

@ -34,70 +34,53 @@ 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
local_discr:
description:
- Specifies the local discriminator of a BFD session.
The value is an integer that ranges from 1 to 16384.
required: false
default: null
remote_discr:
description:
- Specifies the remote discriminator of a BFD session.
The value is an integer that ranges from 1 to 4294967295.
required: false
default: null
min_tx_interval:
description:
- Specifies the minimum interval for receiving BFD packets.
The value is an integer that ranges from 50 to 1000, in milliseconds.
required: false
default: null
min_rx_interval:
description:
- Specifies the minimum interval for sending BFD packets.
The value is an integer that ranges from 50 to 1000, in milliseconds.
required: false
default: null
detect_multi:
description:
- Specifies the local detection multiplier of a BFD session.
The value is an integer that ranges from 3 to 50.
required: false
default: null
wtr_interval:
description:
- Specifies the WTR time of a BFD session.
The value is an integer that ranges from 1 to 60, in minutes.
The default value is 0.
required: false
default: null
tos_exp:
description:
- Specifies a priority for BFD control packets.
The value is an integer ranging from 0 to 7.
The default value is 7, which is the highest priority.
required: false
default: null
admin_down:
description:
- Enables the BFD session to enter the AdminDown state.
By default, a BFD session is enabled.
The default value is bool type.
required: false
default: false
type: bool
default: 'no'
description:
description:
- Specifies the description of a BFD session.
The value is a string of 1 to 51 case-sensitive characters with spaces.
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']
extends_documentation_fragment: ce
"""
EXAMPLES = '''