ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-26 20:31:27 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

Clean up module documentation (#36909)

Browse source 
* 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
Download patch file Download diff file Expand all files Collapse all files

44
lib/ansible/modules/network/cloudengine/ce_ospf_vrf.py
View file

@ -34,95 +34,71 @@ options:
- The ID of the ospf process.
Valid values are an integer, 1 - 4294967295, the default value is 1.
required: true
default: null
route_id:
description:
- Specifies the ospf private route id,.
Valid values are a string, formatted as an IP address
(i.e. "10.1.1.1") the length is 0 - 20.
required: false
default: null
vrf:
description:
- Specifies the vpn instance which use ospf,length is 1 - 31.
Valid values are a string.
required: false
default: _public_
description:
description:
- Specifies the description information of ospf process.
required: false
default: null
bandwidth:
description:
- Specifies the reference bandwidth used to assign ospf cost.
Valid values are an integer, in Mbps, 1 - 2147483648, the default value is 100.
required: false
default: null
lsaalflag:
description:
- Specifies the mode of timer to calculate interval of arrive LSA.
If set the parameter but not specifies value, the default will be used.
If true use general timer.
If false use intelligent timer.
required: false
default: False
type: bool
default: 'no'
lsaainterval:
description:
- Specifies the interval of arrive LSA when use the general timer.
Valid value is an integer, in millisecond, from 0 to 10000.
required: false
default: null
lsaamaxinterval:
description:
- Specifies the max interval of arrive LSA when use the intelligent timer.
Valid value is an integer, in millisecond, from 0 to 10000, the default value is 1000.
required: false
default: null
lsaastartinterval:
description:
- Specifies the start interval of arrive LSA when use the intelligent timer.
Valid value is an integer, in millisecond, from 0 to 10000, the default value is 500.
required: false
default: null
lsaaholdinterval:
description:
- Specifies the hold interval of arrive LSA when use the intelligent timer.
Valid value is an integer, in millisecond, from 0 to 10000, the default value is 500.
required: false
default: null
lsaointervalflag:
description:
- Specifies whether cancel the interval of LSA originate or not.
If set the parameter but noe specifies value, the default will be used.
true:cancel the interval of LSA originate, the interval is 0.
false:do not cancel the interval of LSA originate.
required: false
default: False
type: bool
default: 'no'
lsaointerval:
description:
- Specifies the interval of originate LSA .
Valid value is an integer, in second, from 0 to 10, the default value is 5.
required: false
default: null
lsaomaxinterval:
description:
- Specifies the max interval of originate LSA .
Valid value is an integer, in millisecond, from 1 to 10000, the default value is 5000.
required: false
default: null
lsaostartinterval:
description:
- Specifies the start interval of originate LSA .
Valid value is an integer, in millisecond, from 0 to 1000, the default value is 500.
required: false
default: null
lsaoholdinterval:
description:
- Specifies the hold interval of originate LSA .
Valid value is an integer, in millisecond, from 0 to 5000, the default value is 1000.
required: false
default: null
spfintervaltype:
description:
- Specifies the mode of timer which used to calculate SPF.
@ -130,43 +106,31 @@ options:
If is intelligent-timer, then use intelligent timer.
If is timer, then use second level timer.
If is millisecond, then use millisecond level timer.
required: false
choices: ['intelligent-timer','timer','millisecond']
default: intelligent-timer
spfinterval:
description:
- Specifies the interval to calculate SPF when use second level timer.
Valid value is an integer, in second, from 1 to 10.
required: false
default: null
spfintervalmi:
description:
- Specifies the interval to calculate SPF when use millisecond level timer.
Valid value is an integer, in millisecond, from 1 to 10000.
required: false
default: null
spfmaxinterval:
description:
- Specifies the max interval to calculate SPF when use intelligent timer.
Valid value is an integer, in millisecond, from 1 to 20000, the default value is 5000.
required: false
default: null
spfstartinterval:
description:
- Specifies the start interval to calculate SPF when use intelligent timer.
Valid value is an integer, in millisecond, from 1 to 1000, the default value is 50.
required: false
default: null
spfholdinterval:
description:
- Specifies the hold interval to calculate SPF when use intelligent timer.
Valid value is an integer, in millisecond, from 1 to 5000, the default value is 200.
required: false
default: null
state:
description:
- Specify desired state of the resource.
required: false
choices: ['present', 'absent']
default: present
'''