Adjust booleans in misc plugins. (#5161) (#5175)

(cherry picked from commit 19ce50f6b9)

Co-authored-by: Felix Fontein <felix@fontein.de>

plugins/callback/diy.py

@@ -627,7 +627,7 @@ playbook.yml: >
   ---
   - name: "Default plugin output: play example"
     hosts: localhost
-    gather_facts: no
+    gather_facts: false
     tasks:
       - name:  Default plugin output
         ansible.builtin.debug:
@@ -635,7 +635,7 @@ playbook.yml: >
 
   - name: Override from play vars
     hosts: localhost
-    gather_facts: no
+    gather_facts: false
     vars:
       ansible_connection: local
       green: "\e[0m\e[38;5;82m"

plugins/inventory/cobbler.py

@@ -19,7 +19,7 @@ DOCUMENTATION = '''
     options:
       plugin:
         description: The name of this plugin, it should always be set to C(community.general.cobbler) for this plugin to recognize it as it's own.
-        required: yes
+        required: true
         choices: [ 'cobbler', 'community.general.cobbler' ]
       url:
         description: URL to cobbler.
@@ -28,18 +28,18 @@ DOCUMENTATION = '''
             - name: COBBLER_SERVER
       user:
         description: Cobbler authentication user.
-        required: no
+        required: false
         env:
             - name: COBBLER_USER
       password:
         description: Cobbler authentication password
-        required: no
+        required: false
         env:
             - name: COBBLER_PASSWORD
       cache_fallback:
         description: Fallback to cached results if connection to cobbler fails
         type: boolean
-        default: no
+        default: false
       exclude_profiles:
         description:
           - Profiles to exclude from inventory.
@@ -70,7 +70,7 @@ DOCUMENTATION = '''
       want_facts:
         description: Toggle, if C(true) the plugin will retrieve host facts from the server
         type: boolean
-        default: yes
+        default: true
 '''
 
 EXAMPLES = '''

plugins/inventory/gitlab_runners.py

@@ -55,7 +55,7 @@ DOCUMENTATION = '''
         verbose_output:
             description: Toggle to (not) include all available nodes metadata
             type: bool
-            default: yes
+            default: true
 '''
 
 EXAMPLES = '''

plugins/inventory/proxmox.py

@@ -26,7 +26,7 @@ DOCUMENTATION = '''
     options:
       plugin:
         description: The name of this plugin, it should always be set to C(community.general.proxmox) for this plugin to recognize it as it's own.
-        required: yes
+        required: true
         choices: ['community.general.proxmox']
         type: str
       url:
@@ -44,7 +44,7 @@ DOCUMENTATION = '''
           - Proxmox authentication user.
           - If the value is not specified in the inventory configuration, the value of environment variable C(PROXMOX_USER) will be used instead.
           - Since community.general 4.7.0 you can also use templating to specify the value of the I(user).
-        required: yes
+        required: true
         type: str
         env:
           - name: PROXMOX_USER
@@ -83,7 +83,7 @@ DOCUMENTATION = '''
       validate_certs:
         description: Verify SSL certificate if using HTTPS.
         type: boolean
-        default: yes
+        default: true
       group_prefix:
         description: Prefix to apply to Proxmox groups.
         default: proxmox_
@@ -98,14 +98,14 @@ DOCUMENTATION = '''
           - When I(want_facts) is set to C(true) more details about QEMU VM status are possible, besides the running and stopped states.
             Currently if the VM is running and it is suspended, the status will be running and the machine will be in C(running) group,
             but its actual state will be paused. See I(qemu_extended_statuses) for how to retrieve the real status.
-        default: no
+        default: false
         type: bool
       qemu_extended_statuses:
         description:
           - Requires I(want_facts) to be set to C(true) to function. This will allow you to differentiate betweend C(paused) and C(prelaunch)
             statuses of the QEMU VMs.
           - This introduces multiple groups [prefixed with I(group_prefix)] C(prelaunch) and C(paused).
-        default: no
+        default: false
         type: bool
         version_added: 5.1.0
       want_proxmox_nodes_ansible_host:

plugins/inventory/xen_orchestra.py

@@ -24,7 +24,7 @@ DOCUMENTATION = '''
     options:
         plugin:
             description: The name of this plugin, it should always be set to C(community.general.xen_orchestra) for this plugin to recognize it as its own.
-            required: yes
+            required: true
             choices: ['community.general.xen_orchestra']
             type: str
         api_host:
@@ -38,7 +38,7 @@ DOCUMENTATION = '''
             description:
                 - Xen Orchestra user.
                 - If the value is not specified in the inventory configuration, the value of environment variable C(ANSIBLE_XO_USER) will be used instead.
-            required: yes
+            required: true
             type: str
             env:
                 - name: ANSIBLE_XO_USER
@@ -46,7 +46,7 @@ DOCUMENTATION = '''
             description:
                 - Xen Orchestra password.
                 - If the value is not specified in the inventory configuration, the value of environment variable C(ANSIBLE_XO_PASSWORD) will be used instead.
-            required: yes
+            required: true
             type: str
             env:
                 - name: ANSIBLE_XO_PASSWORD

plugins/lookup/filetree.py

@@ -46,7 +46,7 @@ EXAMPLES = r"""
     dest: /web/{{ item.path }}
     state: link
     follow: false  # avoid corrupting target files if the link already exists
-    force: yes
+    force: true
     mode: '{{ item.mode }}'
   with_community.general.filetree: web/
   when: item.state == 'link'

plugins/lookup/passwordstore.py

@@ -41,7 +41,7 @@ DOCUMENTATION = '''
       overwrite:
         description: Overwrite the password if it does already exist.
         type: bool
-        default: 'no'
+        default: false
       umask:
         description:
           - Sets the umask for the created .gpg files. The first octed must be greater than 3 (user readable).
@@ -52,7 +52,7 @@ DOCUMENTATION = '''
       returnall:
         description: Return all the content of the password, not only the first line.
         type: bool
-        default: 'no'
+        default: false
       subkey:
         description: Return a specific subkey of the password. When set to C(password), always returns the first line.
         default: password
@@ -63,13 +63,13 @@ DOCUMENTATION = '''
         type: integer
         default: 16
       backup:
-        description: Used with C(overwrite=yes). Backup the previous password in a subkey.
+        description: Used with C(overwrite=true). Backup the previous password in a subkey.
         type: bool
-        default: 'no'
+        default: false
       nosymbols:
         description: use alphanumeric characters.
         type: bool
-        default: 'no'
+        default: false
       missing:
         description:
           - List of preference about what to do if the password file is missing.