1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Adjust booleans in misc plugins. (#5161)

This commit is contained in:
Felix Fontein 2022-08-24 20:00:39 +02:00 committed by GitHub
parent 403c4f7477
commit 19ce50f6b9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 22 additions and 22 deletions

View file

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

View file

@ -19,7 +19,7 @@ DOCUMENTATION = '''
options: options:
plugin: 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. 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' ] choices: [ 'cobbler', 'community.general.cobbler' ]
url: url:
description: URL to cobbler. description: URL to cobbler.
@ -28,18 +28,18 @@ DOCUMENTATION = '''
- name: COBBLER_SERVER - name: COBBLER_SERVER
user: user:
description: Cobbler authentication user. description: Cobbler authentication user.
required: no required: false
env: env:
- name: COBBLER_USER - name: COBBLER_USER
password: password:
description: Cobbler authentication password description: Cobbler authentication password
required: no required: false
env: env:
- name: COBBLER_PASSWORD - name: COBBLER_PASSWORD
cache_fallback: cache_fallback:
description: Fallback to cached results if connection to cobbler fails description: Fallback to cached results if connection to cobbler fails
type: boolean type: boolean
default: no default: false
exclude_profiles: exclude_profiles:
description: description:
- Profiles to exclude from inventory. - Profiles to exclude from inventory.
@ -70,7 +70,7 @@ DOCUMENTATION = '''
want_facts: want_facts:
description: Toggle, if C(true) the plugin will retrieve host facts from the server description: Toggle, if C(true) the plugin will retrieve host facts from the server
type: boolean type: boolean
default: yes default: true
''' '''
EXAMPLES = ''' EXAMPLES = '''

View file

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

View file

@ -26,7 +26,7 @@ DOCUMENTATION = '''
options: options:
plugin: 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. 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'] choices: ['community.general.proxmox']
type: str type: str
url: url:
@ -44,7 +44,7 @@ DOCUMENTATION = '''
- Proxmox authentication user. - 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. - 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). - 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 type: str
env: env:
- name: PROXMOX_USER - name: PROXMOX_USER
@ -83,7 +83,7 @@ DOCUMENTATION = '''
validate_certs: validate_certs:
description: Verify SSL certificate if using HTTPS. description: Verify SSL certificate if using HTTPS.
type: boolean type: boolean
default: yes default: true
group_prefix: group_prefix:
description: Prefix to apply to Proxmox groups. description: Prefix to apply to Proxmox groups.
default: proxmox_ 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. - 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, 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. 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 type: bool
qemu_extended_statuses: qemu_extended_statuses:
description: 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) - 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. statuses of the QEMU VMs.
- This introduces multiple groups [prefixed with I(group_prefix)] C(prelaunch) and C(paused). - This introduces multiple groups [prefixed with I(group_prefix)] C(prelaunch) and C(paused).
default: no default: false
type: bool type: bool
version_added: 5.1.0 version_added: 5.1.0
want_proxmox_nodes_ansible_host: want_proxmox_nodes_ansible_host:

View file

@ -24,7 +24,7 @@ DOCUMENTATION = '''
options: options:
plugin: 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. 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'] choices: ['community.general.xen_orchestra']
type: str type: str
api_host: api_host:
@ -38,7 +38,7 @@ DOCUMENTATION = '''
description: description:
- Xen Orchestra user. - 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. - 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 type: str
env: env:
- name: ANSIBLE_XO_USER - name: ANSIBLE_XO_USER
@ -46,7 +46,7 @@ DOCUMENTATION = '''
description: description:
- Xen Orchestra password. - 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. - 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 type: str
env: env:
- name: ANSIBLE_XO_PASSWORD - name: ANSIBLE_XO_PASSWORD

View file

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

View file

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