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

@ -33,46 +33,33 @@ options:
description:
- Specifies a bridge domain ID.
The value is an integer ranging from 1 to 16777215.
required: false
default: null
bind_vlan_id:
description:
- Specifies the VLAN binding to a BD(Bridge Domain).
The value is an integer ranging ranging from 1 to 4094.
required: false
default: null
l2_sub_interface:
description:
- Specifies an Sub-Interface full name, i.e. "10GE1/0/41.1".
The value is a string of 1 to 63 case-insensitive characters, spaces supported.
required: false
default: null
encapsulation:
description:
- Specifies an encapsulation type of packets allowed to pass through a Layer 2 sub-interface.
choices: ['dot1q', 'default', 'untag', 'qinq', 'none']
required: false
default: null
ce_vid:
description:
- When I(encapsulation) is 'dot1q', specifies a VLAN ID in the outer VLAN tag.
When I(encapsulation) is 'qinq', specifies an outer VLAN ID for
double-tagged packets to be received by a Layer 2 sub-interface.
The value is an integer ranging from 1 to 4094.
required: false
default: null
pe_vid:
description:
- When I(encapsulation) is 'qinq', specifies an inner VLAN ID for
double-tagged packets to be received by a Layer 2 sub-interface.
The value is an integer ranging from 1 to 4094.
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']
"""