mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-07 13:52:54 +00:00
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:
@@ -45,12 +45,9 @@ options:
|
||||
description:
|
||||
- The name of the target VLAN.
|
||||
- Required if C(state) is C(present).
|
||||
required: false
|
||||
description:
|
||||
description:
|
||||
- A description of the VLAN.
|
||||
required: false
|
||||
default: null
|
||||
network_domain:
|
||||
description:
|
||||
- The Id or name of the target network domain.
|
||||
@@ -58,12 +55,10 @@ options:
|
||||
private_ipv4_base_address:
|
||||
description:
|
||||
- The base address for the VLAN's IPv4 network (e.g. 192.168.1.0).
|
||||
required: false
|
||||
private_ipv4_prefix_size:
|
||||
description:
|
||||
- The size of the IPv4 address space, e.g 24.
|
||||
- Required, if C(private_ipv4_base_address) is specified.
|
||||
required: false
|
||||
state:
|
||||
description:
|
||||
- The desired state for the target VLAN.
|
||||
@@ -75,8 +70,8 @@ options:
|
||||
- Permit expansion of the target VLAN's network if the module parameters specify a larger network than the VLAN currently posesses?
|
||||
- If C(False), the module will fail under these conditions.
|
||||
- This is intended to prevent accidental expansion of a VLAN's network (since this operation is not reversible).
|
||||
required: false
|
||||
default: False
|
||||
type: bool
|
||||
default: 'no'
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
||||
Reference in New Issue
Block a user