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

@ -39,67 +39,46 @@ options:
- Specifies the area ID. The area with the area-id being 0 is a backbone area.
Valid values are a string, formatted as an IP address
(i.e. "0.0.0.0") or as an integer between 1 and 4294967295.
required: false
default: null
addr:
description:
- Specifies the address of the network segment where the interface resides.
The value is in dotted decimal notation.
required: false
default: null
mask:
description:
- IP network wildcard bits in decimal format between 0 and 32.
required: false
default: null
auth_mode:
description:
- Specifies the authentication type.
required: false
choices: ['none', 'hmac-sha256', 'md5', 'hmac-md5', 'simple']
default: null
auth_text_simple:
description:
- Specifies a password for simple authentication.
The value is a string of 1 to 8 characters.
required: false
default: null
auth_key_id:
description:
- Authentication key id when C(auth_mode) is 'hmac-sha256', 'md5' or 'hmac-md5.
Valid value is an integer is in the range from 1 to 255.
required: false
default: null
auth_text_md5:
description:
- Specifies a password for MD5, HMAC-MD5, or HMAC-SHA256 authentication.
The value is a string of 1 to 255 case-sensitive characters, spaces not supported.
required: false
default: null
nexthop_addr:
description:
- IPv4 address for configure next-hop address's weight.
Valid values are a string, formatted as an IP address.
required: false
default: null
nexthop_weight:
description:
- Indicates the weight of the next hop.
The smaller the value is, the higher the preference of the route is.
It is an integer that ranges from 1 to 254.
required: false
default: null
max_load_balance:
description:
- The maximum number of paths for forward packets over multiple paths.
Valid value is an integer in the range from 1 to 64.
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']
'''