mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 21:00:22 -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
|
@ -30,46 +30,34 @@ options:
|
|||
- Name of bridge or fake bridge to manage
|
||||
parent:
|
||||
version_added: "2.3"
|
||||
required: false
|
||||
default: None
|
||||
description:
|
||||
- Bridge parent of the fake bridge to manage
|
||||
vlan:
|
||||
version_added: "2.3"
|
||||
required: false
|
||||
default: None
|
||||
description:
|
||||
- The VLAN id of the fake bridge to manage (must be between 0 and
|
||||
4095). This parameter is required if I(parent) parameter is set.
|
||||
state:
|
||||
required: false
|
||||
default: "present"
|
||||
choices: [ present, absent ]
|
||||
description:
|
||||
- Whether the bridge should exist
|
||||
timeout:
|
||||
required: false
|
||||
default: 5
|
||||
description:
|
||||
- How long to wait for ovs-vswitchd to respond
|
||||
external_ids:
|
||||
version_added: 2.0
|
||||
required: false
|
||||
default: None
|
||||
description:
|
||||
- A dictionary of external-ids. Omitting this parameter is a No-op.
|
||||
To clear all external-ids pass an empty value.
|
||||
fail_mode:
|
||||
version_added: 2.0
|
||||
default: None
|
||||
required: false
|
||||
choices : [secure, standalone]
|
||||
description:
|
||||
- Set bridge fail-mode. The default value (None) is a No-op.
|
||||
set:
|
||||
version_added: 2.3
|
||||
required: false
|
||||
default: None
|
||||
description:
|
||||
- Run set command after bridge configuration. This parameter is
|
||||
non-idempotent, play will always return I(changed) state if
|
||||
|
|
|
@ -34,31 +34,25 @@ options:
|
|||
- Name of port to manage on the bridge
|
||||
tag:
|
||||
version_added: 2.2
|
||||
required: false
|
||||
description:
|
||||
- VLAN tag for this port. Must be a value between
|
||||
0 and 4095.
|
||||
state:
|
||||
required: false
|
||||
default: "present"
|
||||
choices: [ present, absent ]
|
||||
description:
|
||||
- Whether the port should exist
|
||||
timeout:
|
||||
required: false
|
||||
default: 5
|
||||
description:
|
||||
- How long to wait for ovs-vswitchd to respond
|
||||
external_ids:
|
||||
version_added: 2.0
|
||||
required: false
|
||||
default: {}
|
||||
description:
|
||||
- Dictionary of external_ids applied to a port.
|
||||
set:
|
||||
version_added: 2.0
|
||||
required: false
|
||||
default: None
|
||||
description:
|
||||
- Set a single property on a port.
|
||||
'''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue