mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 04:11:25 -07: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:
parent
58eb2e849d
commit
cdd21e2170
624 changed files with 1458 additions and 9114 deletions
|
@ -35,13 +35,9 @@ options:
|
|||
interface:
|
||||
description:
|
||||
- Full name of interface, i.e. 40GE1/0/10, Tunnel1.
|
||||
required: false
|
||||
default: null
|
||||
interface_type:
|
||||
description:
|
||||
- Interface type to be configured from the device.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['ge', '10ge', '25ge', '4x10ge', '40ge', '100ge', 'vlanif', 'loopback', 'meth',
|
||||
'eth-trunk', 'nve', 'tunnel', 'ethernet', 'fcoe-port', 'fabric-port', 'stack-port', 'null']
|
||||
admin_state:
|
||||
|
@ -50,31 +46,24 @@ options:
|
|||
The value is an enumerated type.
|
||||
up, An interface is in the administrative Up state.
|
||||
down, An interface is in the administrative Down state.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['up', 'down']
|
||||
description:
|
||||
description:
|
||||
- Specifies an interface description.
|
||||
The value is a string of 1 to 242 case-sensitive characters,
|
||||
spaces supported but question marks (?) not supported.
|
||||
required: false
|
||||
default: null
|
||||
mode:
|
||||
description:
|
||||
- Manage Layer 2 or Layer 3 state of the interface.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['layer2', 'layer3']
|
||||
l2sub:
|
||||
description:
|
||||
- Specifies whether the interface is a Layer 2 sub-interface.
|
||||
required: false
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
state:
|
||||
description:
|
||||
- Specify desired state of the resource.
|
||||
required: true
|
||||
default: present
|
||||
choices: ['present', 'absent', 'default']
|
||||
'''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue