Adjust booleans in net tools, web infrastructure, and clustering modules. (#5159)

This commit is contained in:
Felix Fontein 2022-08-24 20:00:11 +02:00 committed by GitHub
parent 675bdef190
commit 7533f9ac26
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
20 changed files with 72 additions and 72 deletions

View file

@ -84,7 +84,7 @@ options:
description:
- Proxy through Cloudflare network or just use DNS.
type: bool
default: no
default: false
record:
description:
- Record to add.
@ -206,7 +206,7 @@ EXAMPLES = r'''
zone: example.net
type: CNAME
value: example.com
proxied: yes
proxied: true
account_email: test@example.com
account_api_key: dummyapitoken
state: present

View file

@ -72,14 +72,14 @@ options:
- Whether the record should be the only one for that record type and record name.
- Only use with C(state) is set to C(present) on a record.
type: 'bool'
default: no
default: false
sandbox:
description:
- Use the DNSimple sandbox environment.
- Requires a dedicated account in the dnsimple sandbox environment.
- Check U(https://developer.dnsimple.com/sandbox/) for more information.
type: 'bool'
default: no
default: false
version_added: 3.5.0
requirements:
- "dnsimple >= 2.0.0"

View file

@ -41,7 +41,7 @@ options:
description:
- Decides if the sandbox API should be used. Otherwise (default) the production API of DNS Made Easy is used.
type: bool
default: 'no'
default: false
record_name:
description:
@ -80,16 +80,16 @@ options:
validate_certs:
description:
- If C(no), SSL certificates will not be validated. This should only be used
- If C(false), SSL certificates will not be validated. This should only be used
on personally controlled sites using self-signed certificates.
type: bool
default: 'yes'
default: true
monitor:
description:
- If C(yes), add or change the monitor. This is applicable only for A records.
- If C(true), add or change the monitor. This is applicable only for A records.
type: bool
default: 'no'
default: false
systemDescription:
description:
@ -147,16 +147,16 @@ options:
failover:
description:
- If C(yes), add or change the failover. This is applicable only for A records.
- If C(true), add or change the failover. This is applicable only for A records.
type: bool
default: 'no'
default: false
autoFailover:
description:
- If true, fallback to the primary IP address is manual after a failover.
- If false, fallback to the primary IP address is automatic after a failover.
type: bool
default: 'no'
default: false
ip1:
description:
@ -283,7 +283,7 @@ EXAMPLES = '''
record_name: test
record_type: A
record_value: 127.0.0.1
monitor: yes
monitor: true
ip1: 127.0.0.2
protocol: HTTP # default
port: 80 # default
@ -300,7 +300,7 @@ EXAMPLES = '''
record_name: test
record_type: A
record_value: 127.0.0.1
monitor: yes
monitor: true
ip1: 127.0.0.2
protocol: HTTP # default
port: 80 # default
@ -323,7 +323,7 @@ EXAMPLES = '''
failover: True
ip1: 127.0.0.2
ip2: 127.0.0.3
monitor: yes
monitor: true
protocol: HTTPS
port: 443
maxEmails: 1
@ -339,7 +339,7 @@ EXAMPLES = '''
record_name: test
record_type: A
record_value: 127.0.0.1
failover: no
failover: false
- name: Remove a monitor
community.general.dnsmadeeasy:
@ -350,7 +350,7 @@ EXAMPLES = '''
record_name: test
record_type: A
record_value: 127.0.0.1
monitor: no
monitor: false
'''
# ============================================

View file

@ -49,7 +49,7 @@ options:
- This can be used to terminate long-running sessions after a server is put
into maintenance mode. Overridden by the drain option.
type: bool
default: no
default: false
socket:
description:
- Path to the HAProxy socket file.
@ -68,25 +68,25 @@ options:
description:
- Disable/enable agent checks (depending on I(state) value).
type: bool
default: no
default: false
version_added: 1.0.0
health:
description:
- Disable/enable health checks (depending on I(state) value).
type: bool
default: no
default: false
version_added: "1.0.0"
fail_on_not_found:
description:
- Fail whenever trying to enable/disable a backend host that does not exist
type: bool
default: no
default: false
wait:
description:
- Wait until the server reports a status of 'UP' when C(state=enabled),
status of 'MAINT' when C(state=disabled) or status of 'DRAIN' when C(state=drain)
type: bool
default: no
default: false
wait_interval:
description:
- Number of seconds to wait between retries.
@ -118,8 +118,8 @@ EXAMPLES = r'''
community.general.haproxy:
state: disabled
host: '{{ inventory_hostname }}'
health: yes
agent: yes
health: true
agent: true
- name: Disable server without backend pool name (apply to all available backend pool)
community.general.haproxy:
@ -139,7 +139,7 @@ EXAMPLES = r'''
host: '{{ inventory_hostname }}'
socket: /var/run/haproxy.sock
backend: www
wait: yes
wait: true
# Place server in drain mode, providing a socket file. Then check the server's
# status every minute to see if it changes to maintenance mode, continuing if it
@ -149,8 +149,8 @@ EXAMPLES = r'''
host: '{{ inventory_hostname }}'
socket: /var/run/haproxy.sock
backend: www
wait: yes
drain: yes
wait: true
drain: true
wait_interval: 60
wait_retries: 60
@ -160,13 +160,13 @@ EXAMPLES = r'''
host: '{{ inventory_hostname }}'
backend: www
socket: /var/run/haproxy.sock
shutdown_sessions: yes
shutdown_sessions: true
- name: Disable server without backend pool name (apply to all available backend pool) but fail when the backend host is not found
community.general.haproxy:
state: disabled
host: '{{ inventory_hostname }}'
fail_on_not_found: yes
fail_on_not_found: true
- name: Enable server in 'www' backend pool
community.general.haproxy:
@ -179,14 +179,14 @@ EXAMPLES = r'''
state: enabled
host: '{{ inventory_hostname }}'
backend: www
wait: yes
wait: true
- name: Enable server in 'www' backend pool wait until healthy. Retry 10 times with intervals of 5 seconds to retrieve the health
community.general.haproxy:
state: enabled
host: '{{ inventory_hostname }}'
backend: www
wait: yes
wait: true
wait_retries: 10
wait_interval: 5

View file

@ -33,7 +33,7 @@ options:
description:
- When set to C(NO), SSL certificates will not be validated.
type: bool
default: yes
default: true
notes:
- Visit https://www.ipify.org to get more information.
'''

View file

@ -62,9 +62,9 @@ options:
ordered:
required: false
type: bool
default: 'no'
default: false
description:
- If C(yes), prepend list values with X-ORDERED index numbers in all
- If C(true), prepend list values with X-ORDERED index numbers in all
attributes specified in the current task. This is useful mostly with
I(olcAccess) attribute to easily manage LDAP Access Control Lists.
extends_documentation_fragment:
@ -115,7 +115,7 @@ EXAMPLES = r'''
to dn.base="dc=example,dc=com"
by dn="cn=admin,dc=example,dc=com" write
by * read
ordered: yes
ordered: true
state: exact
- name: Declare some indexes

View file

@ -35,7 +35,7 @@ options:
- Whether the connection should start on boot.
- Whether the connection profile can be automatically activated
type: bool
default: yes
default: true
conn_name:
description:
- The name used to call the connection. Pattern is <type>[-<ifname>][-<num>].
@ -155,7 +155,7 @@ options:
- Set as default route.
- This parameter is mutually_exclusive with gw4 parameter.
type: bool
default: no
default: false
version_added: 2.0.0
dns4:
description:
@ -331,7 +331,7 @@ options:
description:
- This is only used with bridge and controls whether Spanning Tree Protocol (STP) is enabled for this bridge.
type: bool
default: yes
default: true
priority:
description:
- This is only used with 'bridge' - sets STP priority.
@ -1183,7 +1183,7 @@ EXAMPLES = r'''
ip4: 192.0.2.100/24
gw4: 192.0.2.1
state: present
autoconnect: yes
autoconnect: true
- name: Optionally, at the same time specify IPv6 addresses for the device
community.general.nmcli:

View file

@ -70,7 +70,7 @@ options:
description:
- Enable dynamic DNS updates for this host.
type: bool
default: no
default: false
'''
EXAMPLES = r'''
@ -82,7 +82,7 @@ EXAMPLES = r'''
macaddr: 44:dd:ab:dd:11:44
name: server01
ip: 192.168.88.99
ddns: yes
ddns: true
statements:
- filename "pxelinux.0"
- next-server 1.1.1.1

View file

@ -108,7 +108,7 @@ EXAMPLES = """
organization: MyOrg
user_name: Foo
user_email: foo@bar.com
user_disabled: yes
user_disabled: true
- name: Make sure the user Foo is not part of MyOrg anymore
community.general.pritunl_user: