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

@ -32,61 +32,44 @@ options:
bfd_enable:
description:
- Enables the global Bidirectional Forwarding Detection (BFD) function.
required: false
default: null
choices: ['enable', 'disable']
default_ip:
description:
- Specifies the default multicast IP address.
The value ranges from 224.0.0.107 to 224.0.0.250.
required: false
default: null
tos_exp_dynamic:
description:
- Indicates the priority of BFD control packets for dynamic BFD sessions.
The value is an integer ranging from 0 to 7.
The default priority is 7, which is the highest priority of BFD control packets.
required: false
default: null
tos_exp_static:
description:
- Indicates the priority of BFD control packets for static BFD sessions.
The value is an integer ranging from 0 to 7.
The default priority is 7, which is the highest priority of BFD control packets.
required: false
default: null
damp_init_wait_time:
description:
- Specifies an initial flapping suppression time for a BFD session.
The value is an integer ranging from 1 to 3600000, in milliseconds.
The default value is 2000.
required: false
default: null
damp_max_wait_time:
description:
- Specifies a maximum flapping suppression time for a BFD session.
The value is an integer ranging from 1 to 3600000, in milliseconds.
The default value is 15000.
required: false
default: null
damp_second_wait_time:
description:
- Specifies a secondary flapping suppression time for a BFD session.
The value is an integer ranging from 1 to 3600000, in milliseconds.
The default value is 5000.
required: false
default: null
delay_up_time:
description:
- Specifies the delay before a BFD session becomes Up.
The value is an integer ranging from 1 to 600, in seconds.
The default value is 0, indicating that a BFD session immediately becomes Up.
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']
"""