diff --git a/plugins/modules/clustering/consul/consul.py b/plugins/modules/clustering/consul/consul.py index 039e67b254..152d4577a1 100644 --- a/plugins/modules/clustering/consul/consul.py +++ b/plugins/modules/clustering/consul/consul.py @@ -70,7 +70,7 @@ options: description: - whether to verify the TLS certificate of the consul agent type: bool - default: 'yes' + default: true notes: type: str description: diff --git a/plugins/modules/clustering/consul/consul_kv.py b/plugins/modules/clustering/consul/consul_kv.py index 9fdfb53342..2b0391389a 100644 --- a/plugins/modules/clustering/consul/consul_kv.py +++ b/plugins/modules/clustering/consul/consul_kv.py @@ -46,7 +46,7 @@ options: description: - The key at which the value should be stored. type: str - required: yes + required: true value: description: - The value should be associated with the given key, required if C(state) @@ -55,7 +55,7 @@ options: recurse: description: - If the key represents a prefix, each entry with the prefix can be - retrieved by setting this to C(yes). + retrieved by setting this to C(true). type: bool retrieve: description: @@ -103,7 +103,7 @@ options: description: - Whether to verify the tls certificate of the consul agent. type: bool - default: 'yes' + default: true ''' diff --git a/plugins/modules/clustering/pacemaker_cluster.py b/plugins/modules/clustering/pacemaker_cluster.py index 6e9d30c66c..823bb76257 100644 --- a/plugins/modules/clustering/pacemaker_cluster.py +++ b/plugins/modules/clustering/pacemaker_cluster.py @@ -37,13 +37,13 @@ options: description: - Force the change of the cluster state type: bool - default: 'yes' + default: true ''' EXAMPLES = ''' --- - name: Set cluster Online hosts: localhost - gather_facts: no + gather_facts: false tasks: - name: Get cluster state community.general.pacemaker_cluster: diff --git a/plugins/modules/clustering/znode.py b/plugins/modules/clustering/znode.py index 2c42d55643..07be85c145 100644 --- a/plugins/modules/clustering/znode.py +++ b/plugins/modules/clustering/znode.py @@ -48,7 +48,7 @@ options: description: - Recursively delete node and all its children. type: bool - default: 'no' + default: false requirements: - kazoo >= 2.1 - python >= 2.6 diff --git a/plugins/modules/net_tools/cloudflare_dns.py b/plugins/modules/net_tools/cloudflare_dns.py index 34e1d84500..12cd484565 100644 --- a/plugins/modules/net_tools/cloudflare_dns.py +++ b/plugins/modules/net_tools/cloudflare_dns.py @@ -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 diff --git a/plugins/modules/net_tools/dnsimple.py b/plugins/modules/net_tools/dnsimple.py index 79a8a7400a..e96c22613f 100644 --- a/plugins/modules/net_tools/dnsimple.py +++ b/plugins/modules/net_tools/dnsimple.py @@ -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" diff --git a/plugins/modules/net_tools/dnsmadeeasy.py b/plugins/modules/net_tools/dnsmadeeasy.py index 121f16584f..0efbe5b6e0 100644 --- a/plugins/modules/net_tools/dnsmadeeasy.py +++ b/plugins/modules/net_tools/dnsmadeeasy.py @@ -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 ''' # ============================================ diff --git a/plugins/modules/net_tools/haproxy.py b/plugins/modules/net_tools/haproxy.py index 71035c4ba8..322d2344bc 100644 --- a/plugins/modules/net_tools/haproxy.py +++ b/plugins/modules/net_tools/haproxy.py @@ -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 diff --git a/plugins/modules/net_tools/ipify_facts.py b/plugins/modules/net_tools/ipify_facts.py index 2abc13af2a..8953c02940 100644 --- a/plugins/modules/net_tools/ipify_facts.py +++ b/plugins/modules/net_tools/ipify_facts.py @@ -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. ''' diff --git a/plugins/modules/net_tools/ldap/ldap_attrs.py b/plugins/modules/net_tools/ldap/ldap_attrs.py index 39f6a59d34..df61233ab1 100644 --- a/plugins/modules/net_tools/ldap/ldap_attrs.py +++ b/plugins/modules/net_tools/ldap/ldap_attrs.py @@ -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 diff --git a/plugins/modules/net_tools/nmcli.py b/plugins/modules/net_tools/nmcli.py index e195249360..83bd984437 100644 --- a/plugins/modules/net_tools/nmcli.py +++ b/plugins/modules/net_tools/nmcli.py @@ -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 [-][-]. @@ -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: diff --git a/plugins/modules/net_tools/omapi_host.py b/plugins/modules/net_tools/omapi_host.py index a0c62b74e9..7d1897ca55 100644 --- a/plugins/modules/net_tools/omapi_host.py +++ b/plugins/modules/net_tools/omapi_host.py @@ -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 diff --git a/plugins/modules/net_tools/pritunl/pritunl_user.py b/plugins/modules/net_tools/pritunl/pritunl_user.py index 1ddd8a97af..817d6fb3f6 100644 --- a/plugins/modules/net_tools/pritunl/pritunl_user.py +++ b/plugins/modules/net_tools/pritunl/pritunl_user.py @@ -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: diff --git a/plugins/modules/web_infrastructure/apache2_mod_proxy.py b/plugins/modules/web_infrastructure/apache2_mod_proxy.py index 5e444047fd..70ab5a42ed 100644 --- a/plugins/modules/web_infrastructure/apache2_mod_proxy.py +++ b/plugins/modules/web_infrastructure/apache2_mod_proxy.py @@ -50,12 +50,12 @@ options: description: - Use https to access balancer management page. type: bool - default: 'no' + default: false validate_certs: description: - Validate ssl/tls certificates. type: bool - default: 'yes' + default: true ''' EXAMPLES = ''' diff --git a/plugins/modules/web_infrastructure/deploy_helper.py b/plugins/modules/web_infrastructure/deploy_helper.py index 7ab10dc5b8..721f51f3c7 100644 --- a/plugins/modules/web_infrastructure/deploy_helper.py +++ b/plugins/modules/web_infrastructure/deploy_helper.py @@ -94,7 +94,7 @@ options: description: - Whether to run the clean procedure in case of C(state=finalize). type: bool - default: 'yes' + default: true keep_releases: type: int diff --git a/plugins/modules/web_infrastructure/django_manage.py b/plugins/modules/web_infrastructure/django_manage.py index 5d68ae9bcf..0d68e926eb 100644 --- a/plugins/modules/web_infrastructure/django_manage.py +++ b/plugins/modules/web_infrastructure/django_manage.py @@ -65,7 +65,7 @@ options: - Clear the existing files before trying to copy or link the original file. - Used only with the C(collectstatic) command. The C(--noinput) argument will be added automatically. required: false - default: no + default: false type: bool database: description: diff --git a/plugins/modules/web_infrastructure/htpasswd.py b/plugins/modules/web_infrastructure/htpasswd.py index 28dfeda158..4590607cc7 100644 --- a/plugins/modules/web_infrastructure/htpasswd.py +++ b/plugins/modules/web_infrastructure/htpasswd.py @@ -54,10 +54,10 @@ options: create: required: false type: bool - default: "yes" + default: true description: - Used with C(state=present). If specified, the file will be created - if it does not already exist. If set to "no", will fail if the + if it does not already exist. If set to C(false), will fail if the file does not exist notes: - "This module depends on the I(passlib) Python library, which needs to be installed on all target systems." diff --git a/plugins/modules/web_infrastructure/jenkins_job.py b/plugins/modules/web_infrastructure/jenkins_job.py index a2c15f55d5..7930766b8e 100644 --- a/plugins/modules/web_infrastructure/jenkins_job.py +++ b/plugins/modules/web_infrastructure/jenkins_job.py @@ -68,10 +68,10 @@ options: required: false validate_certs: type: bool - default: yes + default: true description: - - If set to C(no), the SSL certificates will not be validated. - This should only set to C(no) used on personally controlled sites + - If set to C(false), the SSL certificates will not be validated. + This should only set to C(false) used on personally controlled sites using self-signed certificates as it avoids verifying the source site. - The C(python-jenkins) library only handles this by using the environment variable C(PYTHONHTTPSVERIFY). version_added: 2.3.0 diff --git a/plugins/modules/web_infrastructure/jenkins_plugin.py b/plugins/modules/web_infrastructure/jenkins_plugin.py index 478bd0be08..3142e1672d 100644 --- a/plugins/modules/web_infrastructure/jenkins_plugin.py +++ b/plugins/modules/web_infrastructure/jenkins_plugin.py @@ -37,7 +37,7 @@ options: type: str description: - Plugin name. - required: yes + required: true owner: type: str description: @@ -114,7 +114,7 @@ options: - Defines whether to install plugin dependencies. - This option takes effect only if the I(version) is not defined. type: bool - default: yes + default: true notes: - Plugin installation should be run under root or the same user which owns @@ -141,7 +141,7 @@ EXAMPLES = ''' - name: Install plugin without its dependencies community.general.jenkins_plugin: name: build-pipeline-plugin - with_dependencies: no + with_dependencies: false - name: Make sure the plugin is always up-to-date community.general.jenkins_plugin: @@ -196,11 +196,11 @@ EXAMPLES = ''' vars: my_jenkins_plugins: token-macro: - enabled: yes + enabled: true build-pipeline-plugin: version: "1.4.9" - pinned: no - enabled: yes + pinned: false + enabled: true tasks: - name: Install plugins without a specific version community.general.jenkins_plugin: @@ -221,17 +221,17 @@ EXAMPLES = ''' - name: Initiate the fact ansible.builtin.set_fact: - jenkins_restart_required: no + jenkins_restart_required: false - name: Check if restart is required by any of the versioned plugins ansible.builtin.set_fact: - jenkins_restart_required: yes + jenkins_restart_required: true when: item.changed with_items: "{{ my_jenkins_plugin_versioned.results }}" - name: Check if restart is required by any of the unversioned plugins ansible.builtin.set_fact: - jenkins_restart_required: yes + jenkins_restart_required: true when: item.changed with_items: "{{ my_jenkins_plugin_unversioned.results }}" @@ -257,7 +257,7 @@ EXAMPLES = ''' - name: Reset the fact ansible.builtin.set_fact: - jenkins_restart_required: no + jenkins_restart_required: false when: jenkins_restart_required - name: Plugin pinning diff --git a/plugins/modules/web_infrastructure/jenkins_script.py b/plugins/modules/web_infrastructure/jenkins_script.py index c7cad4655d..58d8e2c642 100644 --- a/plugins/modules/web_infrastructure/jenkins_script.py +++ b/plugins/modules/web_infrastructure/jenkins_script.py @@ -33,11 +33,11 @@ options: default: http://localhost:8080 validate_certs: description: - - If set to C(no), the SSL certificates will not be validated. - This should only set to C(no) used on personally controlled sites + - If set to C(false), the SSL certificates will not be validated. + This should only set to C(false) used on personally controlled sites using self-signed certificates as it avoids verifying the source site. type: bool - default: 'yes' + default: true user: type: str description: @@ -90,7 +90,7 @@ EXAMPLES = ''' user: admin password: admin url: https://localhost - validate_certs: no + validate_certs: false ''' RETURN = '''