mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-07 05:42:50 +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:
@@ -27,42 +27,36 @@ description:
|
||||
python module.
|
||||
options:
|
||||
balancer_url_suffix:
|
||||
default: /balancer-manager/
|
||||
description:
|
||||
- Suffix of the balancer pool url required to access the balancer pool
|
||||
status page (e.g. balancer_vhost[:port]/balancer_url_suffix).
|
||||
required: false
|
||||
default: /balancer-manager/
|
||||
balancer_vhost:
|
||||
default: None
|
||||
description:
|
||||
- (ipv4|ipv6|fqdn):port of the Apache httpd 2.4 mod_proxy balancer pool.
|
||||
required: true
|
||||
member_host:
|
||||
default: None
|
||||
description:
|
||||
- (ipv4|ipv6|fqdn) of the balancer member to get or to set attributes to.
|
||||
Port number is autodetected and should not be specified here.
|
||||
If undefined, apache2_mod_proxy module will return a members list of
|
||||
dictionaries of all the current balancer pool members' attributes.
|
||||
required: false
|
||||
state:
|
||||
default: None
|
||||
description:
|
||||
- Desired state of the member host.
|
||||
(absent|disabled),drained,hot_standby,ignore_errors can be
|
||||
simultaneously invoked by separating them with a comma (e.g. state=drained,ignore_errors).
|
||||
required: false
|
||||
choices: ["present", "absent", "enabled", "disabled", "drained", "hot_standby", "ignore_errors"]
|
||||
tls:
|
||||
default: false
|
||||
description:
|
||||
- Use https to access balancer management page.
|
||||
choices: ["true", "false"]
|
||||
type: bool
|
||||
default: 'no'
|
||||
validate_certs:
|
||||
default: true
|
||||
description:
|
||||
- Validate ssl/tls certificates.
|
||||
choices: ["true", "false"]
|
||||
type: bool
|
||||
default: 'yes'
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
||||
Reference in New Issue
Block a user