mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 11:51:26 -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
|
@ -33,7 +33,6 @@ options:
|
|||
backend:
|
||||
description:
|
||||
- Name of the HAProxy backend pool.
|
||||
required: false
|
||||
default: auto-detected
|
||||
drain:
|
||||
description:
|
||||
|
@ -41,25 +40,22 @@ options:
|
|||
determined by wait_interval and wait_retries is reached. Continue only
|
||||
after the status changes to 'MAINT'. This overrides the
|
||||
shutdown_sessions option.
|
||||
default: false
|
||||
version_added: "2.4"
|
||||
host:
|
||||
description:
|
||||
- Name of the backend host to change.
|
||||
required: true
|
||||
default: null
|
||||
shutdown_sessions:
|
||||
description:
|
||||
- When disabling a server, immediately terminate all the sessions attached
|
||||
to the specified server. This can be used to terminate long-running
|
||||
sessions after a server is put into maintenance mode. Overridden by the
|
||||
drain option.
|
||||
required: false
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
socket:
|
||||
description:
|
||||
- Path to the HAProxy socket file.
|
||||
required: false
|
||||
default: /var/run/haproxy.sock
|
||||
state:
|
||||
description:
|
||||
|
@ -67,31 +63,28 @@ options:
|
|||
- Note that C(drain) state was added in version 2.4. It is supported only by HAProxy version 1.5 or later,
|
||||
if used on versions < 1.5, it will be ignored.
|
||||
required: true
|
||||
default: null
|
||||
choices: [ "enabled", "disabled", "drain" ]
|
||||
fail_on_not_found:
|
||||
description:
|
||||
- Fail whenever trying to enable/disable a backend host that does not exist
|
||||
required: false
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.2"
|
||||
wait:
|
||||
description:
|
||||
- Wait until the server reports a status of 'UP' when `state=enabled`,
|
||||
status of 'MAINT' when `state=disabled` or status of 'DRAIN' when `state=drain`
|
||||
required: false
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.0"
|
||||
wait_interval:
|
||||
description:
|
||||
- Number of seconds to wait between retries.
|
||||
required: false
|
||||
default: 5
|
||||
version_added: "2.0"
|
||||
wait_retries:
|
||||
description:
|
||||
- Number of times to check for status after changing the state.
|
||||
required: false
|
||||
default: 25
|
||||
version_added: "2.0"
|
||||
weight:
|
||||
|
@ -100,8 +93,6 @@ options:
|
|||
the new weight will be relative to the initially configured weight.
|
||||
Relative weights are only permitted between 0 and 100% and absolute
|
||||
weights are permitted between 0 and 256.
|
||||
required: false
|
||||
default: null
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue