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

Normalize more booleans. (#5247)

Browse source
This commit is contained in:
Felix Fontein 2022-09-06 20:42:17 +02:00 committed by GitHub
parent 570445adc4
commit 015566fb06
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
170 changed files with 465 additions and 465 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
plugins/become/doas.py
View file

@ -55,7 +55,7 @@ DOCUMENTATION = '''
- name: ANSIBLE_DOAS_FLAGS
become_pass:
description: password for doas prompt
required: False
required: false
vars:
- name: ansible_become_password
- name: ansible_become_pass

2
plugins/become/dzdo.py
View file

@ -55,7 +55,7 @@ DOCUMENTATION = '''
- name: ANSIBLE_DZDO_FLAGS
become_pass:
description: Options to pass to dzdo
required: False
required: false
vars:
- name: ansible_become_password
- name: ansible_become_pass

4
plugins/become/ksu.py
View file

@ -25,7 +25,7 @@ DOCUMENTATION = '''
env:
- name: ANSIBLE_BECOME_USER
- name: ANSIBLE_KSU_USER
required: True
required: true
become_exe:
description: Su executable
default: ksu
@ -56,7 +56,7 @@ DOCUMENTATION = '''
- name: ANSIBLE_KSU_FLAGS
become_pass:
description: ksu password
required: False
required: false
vars:
- name: ansible_ksu_pass
- name: ansible_become_pass

2
plugins/become/machinectl.py
View file

@ -56,7 +56,7 @@ DOCUMENTATION = '''
- name: ANSIBLE_MACHINECTL_FLAGS
become_pass:
description: Password for machinectl
required: False
required: false
vars:
- name: ansible_become_password
- name: ansible_become_pass

4
plugins/become/pbrun.py
View file

@ -56,7 +56,7 @@ DOCUMENTATION = '''
- name: ANSIBLE_PBRUN_FLAGS
become_pass:
description: Password for pbrun
required: False
required: false
vars:
- name: ansible_become_password
- name: ansible_become_pass
@ -69,7 +69,7 @@ DOCUMENTATION = '''
key: password
wrap_exe:
description: Toggle to wrap the command pbrun calls in 'shell -c' or not
default: False
default: false
type: bool
ini:
- section: pbrun_become_plugin

4
plugins/become/pfexec.py
View file

@ -59,7 +59,7 @@ DOCUMENTATION = '''
- name: ANSIBLE_PFEXEC_FLAGS
become_pass:
description: pfexec password
required: False
required: false
vars:
- name: ansible_become_password
- name: ansible_become_pass
@ -72,7 +72,7 @@ DOCUMENTATION = '''
key: password
wrap_exe:
description: Toggle to wrap the command pfexec calls in 'shell -c' or not
default: False
default: false
type: bool
ini:
- section: pfexec_become_plugin

2
plugins/become/pmrun.py
View file

@ -42,7 +42,7 @@ DOCUMENTATION = '''
- name: ANSIBLE_PMRUN_FLAGS
become_pass:
description: pmrun password
required: False
required: false
vars:
- name: ansible_become_password
- name: ansible_become_pass

2
plugins/become/sesu.py
View file

@ -56,7 +56,7 @@ DOCUMENTATION = '''
- name: ANSIBLE_SESU_FLAGS
become_pass:
description: Password to pass to sesu
required: False
required: false
vars:
- name: ansible_become_password
- name: ansible_become_pass

2
plugins/cache/pickle.py vendored
View file

@ -16,7 +16,7 @@ DOCUMENTATION = '''
author: Brian Coca (@bcoca)
options:
_uri:
required: True
required: true
description:
- Path in which the cache plugin will save the files
env:

2
plugins/cache/redis.py vendored
View file

@ -21,7 +21,7 @@ DOCUMENTATION = '''
- The format is C(host:port:db:password), for example C(localhost:6379:0:changeme).
- To use encryption in transit, prefix the connection with C(tls://), as in C(tls://localhost:6379:0:changeme).
- To use redis sentinel, use separator C(;), for example C(localhost:26379;localhost:26379;0:changeme). Requires redis>=2.9.0.
required: True
required: true
env:
- name: ANSIBLE_CACHE_PLUGIN_CONNECTION
ini:

2
plugins/cache/yaml.py vendored
View file

@ -16,7 +16,7 @@ DOCUMENTATION = '''
author: Brian Coca (@bcoca)
options:
_uri:
required: True
required: true
description:
- Path in which the cache plugin will save the files
env:

4
plugins/callback/cgroup_memory_recap.py
View file

@ -23,7 +23,7 @@ DOCUMENTATION = '''
- To create the cgroup, first use a command such as C(sudo cgcreate -a ec2-user:ec2-user -t ec2-user:ec2-user -g memory:ansible_profile)
options:
max_mem_file:
required: True
required: true
description: Path to cgroups C(memory.max_usage_in_bytes) file. Example C(/sys/fs/cgroup/memory/ansible_profile/memory.max_usage_in_bytes)
env:
- name: CGROUP_MAX_MEM_FILE
@ -31,7 +31,7 @@ DOCUMENTATION = '''
- section: callback_cgroupmemrecap
key: max_mem_file
cur_mem_file:
required: True
required: true
description: Path to C(memory.usage_in_bytes) file. Example C(/sys/fs/cgroup/memory/ansible_profile/memory.usage_in_bytes)
env:
- name: CGROUP_CUR_MEM_FILE

2
plugins/callback/diy.py
View file

@ -713,7 +713,7 @@ playbook.yml: >
- name: Using alias vars (see ansible.cfg)
ansible.builtin.debug:
msg:
when: False
when: false
vars:
ansible_callback_diy_playbook_on_task_start_msg: ""
on_skipped_msg: "DIY output(via task vars): skipped example:\n\e[0m\e[38;5;4m\u25b6\u25b6 {{ ansible_callback_diy.result.task.name }}\n"

6
plugins/callback/hipchat.py
View file

@ -21,7 +21,7 @@ DOCUMENTATION = '''
options:
token:
description: HipChat API token for v1 or v2 API.
required: True
required: true
env:
- name: HIPCHAT_TOKEN
ini:
@ -29,7 +29,7 @@ DOCUMENTATION = '''
key: token
api_version:
description: HipChat API version, v1 or v2.
required: False
required: false
default: v1
env:
- name: HIPCHAT_API_VERSION
@ -55,7 +55,7 @@ DOCUMENTATION = '''
notify:
description: Add notify flag to important messages
type: bool
default: True
default: true
env:
- name: HIPCHAT_NOTIFY
ini:

8
plugins/callback/jabber.py
View file

@ -20,22 +20,22 @@ DOCUMENTATION = '''
options:
server:
description: connection info to jabber server
required: True
required: true
env:
- name: JABBER_SERV
user:
description: Jabber user to authenticate as
required: True
required: true
env:
- name: JABBER_USER
password:
description: Password for the user to the jabber server
required: True
required: true
env:
- name: JABBER_PASS
to:
description: chat identifier that will receive the message
required: True
required: true
env:
- name: JABBER_TO
'''

10
plugins/callback/logdna.py
View file

@ -18,7 +18,7 @@ DOCUMENTATION = '''
- whitelisting in configuration
options:
conf_key:
required: True
required: true
description: LogDNA Ingestion Key
type: string
env:
@ -27,7 +27,7 @@ DOCUMENTATION = '''
- section: callback_logdna
key: conf_key
plugin_ignore_errors:
required: False
required: false
description: Whether to ignore errors on failing or not
type: boolean
env:
@ -35,9 +35,9 @@ DOCUMENTATION = '''
ini:
- section: callback_logdna
key: plugin_ignore_errors
default: False
default: false
conf_hostname:
required: False
required: false
description: Alternative Host Name; the current host name by default
type: string
env:
@ -46,7 +46,7 @@ DOCUMENTATION = '''
- section: callback_logdna
key: conf_hostname
conf_tags:
required: False
required: false
description: Tags
type: string
env:

6
plugins/callback/logentries.py
View file

@ -48,7 +48,7 @@ DOCUMENTATION = '''
description: The logentries "TCP token"
env:
- name: LOGENTRIES_ANSIBLE_TOKEN
required: True
required: true
ini:
- section: callback_logentries
key: token
@ -57,7 +57,7 @@ DOCUMENTATION = '''
- Toggle to decide whether to use TLS to encrypt the communications with the API server
env:
- name: LOGENTRIES_USE_TLS
default: False
default: false
type: boolean
ini:
- section: callback_logentries
@ -65,7 +65,7 @@ DOCUMENTATION = '''
flatten:
description: flatten complex data structures into a single dictionary with complex keys
type: boolean
default: False
default: false
env:
- name: LOGENTRIES_FLATTEN
ini:

2
plugins/callback/selective.py
View file

@ -21,7 +21,7 @@ DOCUMENTATION = '''
- If you increase verbosity all tasks are printed.
options:
nocolor:
default: False
default: false
description: This setting allows suppressing colorizing output
env:
- name: ANSIBLE_NOCOLOR

4
plugins/callback/slack.py
View file

@ -21,7 +21,7 @@ DOCUMENTATION = '''
- Before 2.4 only environment variables were available for configuring this plugin
options:
webhook_url:
required: True
required: true
description: Slack Webhook URL
env:
- name: SLACK_WEBHOOK_URL
@ -51,7 +51,7 @@ DOCUMENTATION = '''
ini:
- section: callback_slack
key: validate_certs
default: True
default: true
type: bool
'''

6
plugins/doc_fragments/ibm_storage.py
View file

@ -18,17 +18,17 @@ options:
description:
- Management user on the spectrum accelerate storage system.
type: str
required: True
required: true
password:
description:
- Password for username on the spectrum accelerate storage system.
type: str
required: True
required: true
endpoints:
description:
- The hostname or management IP of Spectrum Accelerate storage system.
type: str
required: True
required: true
notes:
- This module requires pyxcli python library.
Use 'pip install pyxcli' in order to get pyxcli.

2
plugins/doc_fragments/oracle_creatable_resource.py
View file

@ -15,7 +15,7 @@ class ModuleDocFragment(object):
idempotent operation, and doesn't create the resource if it already exists. Setting this option
to true, forcefully creates a copy of the resource, even if it already exists.This option is
mutually exclusive with I(key_by).
default: False
default: false
type: bool
key_by:
description: The list of comma-separated attributes of this resource which should be used to uniquely

2
plugins/inventory/gitlab_runners.py
View file

@ -66,7 +66,7 @@ host: https://gitlab.com
# Example using constructed features to create groups and set ansible_host
plugin: community.general.gitlab_runners
host: https://gitlab.com
strict: False
strict: false
keyed_groups:
# add e.g. amd64 hosts to an arch_amd64 group
- prefix: arch

14
plugins/inventory/nmap.py
View file

@ -20,7 +20,7 @@ DOCUMENTATION = '''
options:
plugin:
description: token that ensures this is a source file for the 'nmap' plugin.
required: True
required: true
choices: ['nmap', 'community.general.nmap']
sudo:
description: Set to C(true) to execute a C(sudo nmap) plugin scan.
@ -29,7 +29,7 @@ DOCUMENTATION = '''
type: boolean
address:
description: Network IP or range of IPs to scan, you can use a simple range (10.2.2.15-25) or CIDR notation.
required: True
required: true
exclude:
description: list of addresses to exclude
type: list
@ -37,15 +37,15 @@ DOCUMENTATION = '''
ports:
description: Enable/disable scanning for open ports
type: boolean
default: True
default: true
ipv4:
description: use IPv4 type addresses
type: boolean
default: True
default: true
ipv6:
description: use IPv6 type addresses
type: boolean
default: True
default: true
notes:
- At least one of ipv4 or ipv6 is required to be True, both can be True, but they cannot both be False.
- 'TODO: add OS fingerprinting'
@ -53,14 +53,14 @@ DOCUMENTATION = '''
EXAMPLES = '''
# inventory.config file in YAML format
plugin: community.general.nmap
strict: False
strict: false
address: 192.168.0.0/24
# a sudo nmap scan to fully use nmap scan power.
plugin: community.general.nmap
sudo: true
strict: False
strict: false
address: 192.168.0.0/24
'''

4
plugins/inventory/online.py
View file

@ -16,10 +16,10 @@ DOCUMENTATION = r'''
options:
plugin:
description: token that ensures this is a source file for the 'online' plugin.
required: True
required: true
choices: ['online', 'community.general.online']
oauth_token:
required: True
required: true
description: Online OAuth token.
env:
# in order of precedence

8
plugins/inventory/opennebula.py
View file

@ -34,7 +34,7 @@ DOCUMENTATION = r'''
- If not set then the value of the C(ONE_URL) environment variable is used.
env:
- name: ONE_URL
required: True
required: true
type: string
api_username:
description:
@ -49,7 +49,7 @@ DOCUMENTATION = r'''
- If not set, the value of the C(ONE_PASSWORD) environment variable is used.
env:
- name: ONE_PASSWORD
required: False
required: false
type: string
api_authfile:
description:
@ -58,7 +58,7 @@ DOCUMENTATION = r'''
- Set environment variable C(ONE_AUTH) to override this path.
env:
- name: ONE_AUTH
required: False
required: false
type: string
hostname:
description: Field to match the hostname. Note C(v4_first_ip) corresponds to the first IPv4 found on VM.
@ -74,7 +74,7 @@ DOCUMENTATION = r'''
group_by_labels:
description: Create host groups by vm labels
type: bool
default: True
default: true
'''
EXAMPLES = r'''

2
plugins/inventory/scaleway.py
View file

@ -19,7 +19,7 @@ DOCUMENTATION = r'''
options:
plugin:
description: Token that ensures this is a source file for the 'scaleway' plugin.
required: True
required: true
choices: ['scaleway', 'community.general.scaleway']
regions:
description: Filter results on a specific Scaleway region.

4
plugins/inventory/virtualbox.py
View file

@ -20,12 +20,12 @@ DOCUMENTATION = '''
options:
plugin:
description: token that ensures this is a source file for the 'virtualbox' plugin
required: True
required: true
choices: ['virtualbox', 'community.general.virtualbox']
running_only:
description: toggles showing all vms vs only those currently running
type: boolean
default: False
default: false
settings_password_file:
description: provide a file containing the settings password (equivalent to --settingspwfile)
network_info_path:

2
plugins/lookup/cartesian.py
View file

@ -18,7 +18,7 @@ DOCUMENTATION = '''
_raw:
description:
- a set of lists
required: True
required: true
'''
EXAMPLES = """

4
plugins/lookup/chef_databag.py
View file

@ -22,11 +22,11 @@ DOCUMENTATION = '''
name:
description:
- Name of the databag
required: True
required: true
item:
description:
- Item to fetch
required: True
required: true
'''
EXAMPLES = """

4
plugins/lookup/consul_kv.py
View file

@ -25,7 +25,7 @@ DOCUMENTATION = '''
recurse:
type: boolean
description: If true, will retrieve all the values that have the given key as prefix.
default: False
default: false
index:
description:
- If the key has a value with the specified index then this is returned allowing access to historical values.
@ -56,7 +56,7 @@ DOCUMENTATION = '''
- Whether to use http or https.
- If you use C(ANSIBLE_CONSUL_URL) this value will be used from there.
validate_certs:
default: True
default: true
description: Whether to verify the ssl connection or not.
env:
- name: ANSIBLE_CONSUL_VALIDATE_CERTS

4
plugins/lookup/cyberarkpassword.py
View file

@ -22,10 +22,10 @@ DOCUMENTATION = '''
default: '/opt/CARKaim/sdk/clipasswordsdk'
appid:
description: Defines the unique ID of the application that is issuing the password request.
required: True
required: true
query:
description: Describes the filter criteria for the password retrieval.
required: True
required: true
output:
description:
- Specifies the desired output fields separated by commas.

2
plugins/lookup/dnstxt.py
View file

@ -17,7 +17,7 @@ DOCUMENTATION = '''
options:
_terms:
description: domain or list of domains to query TXT records from
required: True
required: true
type: list
elements: string
'''

4
plugins/lookup/etcd.py
View file

@ -21,7 +21,7 @@ DOCUMENTATION = '''
- the list of keys to lookup on the etcd server
type: list
elements: string
required: True
required: true
url:
description:
- Environment variable with the url for the etcd server
@ -37,7 +37,7 @@ DOCUMENTATION = '''
validate_certs:
description:
- toggle checking that the ssl certificates are valid, you normally only want to turn this off with self-signed certs.
default: True
default: true
type: boolean
'''

4
plugins/lookup/etcd3.py
View file

@ -24,12 +24,12 @@ DOCUMENTATION = '''
- The list of keys (or key prefixes) to look up on the etcd3 server.
type: list
elements: str
required: True
required: true
prefix:
description:
- Look for key or prefix key.
type: bool
default: False
default: false
endpoints:
description:
- Counterpart of C(ETCDCTL_ENDPOINTS) environment variable.

2
plugins/lookup/filetree.py
View file

@ -18,7 +18,7 @@ description:
options:
_terms:
description: path(s) of files to read
required: True
required: true
'''
EXAMPLES = r"""

2
plugins/lookup/flattened.py
View file

@ -15,7 +15,7 @@ DOCUMENTATION = '''
options:
_terms:
description: lists to flatten
required: True
required: true
notes:
- unlike 'items' which only flattens 1 level, this plugin will continue to flatten until it cannot find lists anymore.
- aka highlander plugin, there can only be one (list).

2
plugins/lookup/hiera.py
View file

@ -21,7 +21,7 @@ DOCUMENTATION = '''
- The list of keys to lookup on the Puppetmaster
type: list
elements: string
required: True
required: true
_bin_file:
description:
- Binary file to execute Hiera

8
plugins/lookup/manifold.py
View file

@ -20,24 +20,24 @@ DOCUMENTATION = '''
matched resources will be returned.
type: list
elements: string
required: False
required: false
api_token:
description:
- manifold API token
type: string
required: True
required: true
env:
- name: MANIFOLD_API_TOKEN
project:
description:
- The project label you want to get the resource for.
type: string
required: False
required: false
team:
description:
- The team label you want to get the resource for.
type: string
required: False
required: false
'''
EXAMPLES = '''

2
plugins/lookup/onepassword.py
View file

@ -22,7 +22,7 @@ DOCUMENTATION = '''
options:
_terms:
description: identifier(s) (UUID, name, or subdomain; case-insensitive) of item(s) to retrieve.
required: True
required: true
field:
description: field to return from each matching item (case-insensitive).
default: 'password'

2
plugins/lookup/onepassword_raw.py
View file

@ -22,7 +22,7 @@ DOCUMENTATION = '''
options:
_terms:
description: identifier(s) (UUID, name, or domain; case-insensitive) of item(s) to retrieve.
required: True
required: true
master_password:
description: The password used to unlock the specified vault.
aliases: ['vault_password']

2
plugins/lookup/passwordstore.py
View file

@ -20,7 +20,7 @@ DOCUMENTATION = '''
options:
_terms:
description: query key.
required: True
required: true
passwordstore:
description:
- Location of the password store.

4
plugins/lookup/shelvefile.py
View file

@ -17,10 +17,10 @@ DOCUMENTATION = '''
description: sets of key value pairs of parameters
key:
description: key to query
required: True
required: true
file:
description: path to shelve file
required: True
required: true
'''
EXAMPLES = """

18
plugins/modules/cloud/alicloud/ali_instance.py
View file

@ -101,7 +101,7 @@ options:
description:
- Specifies whether to add sequential suffixes to the host_name.
The sequential suffix ranges from 001 to 999.
default: False
default: false
type: bool
version_added: '0.2.0'
password:
@ -143,7 +143,7 @@ options:
allocate_public_ip:
description:
- Whether allocate a public ip for the new instance.
default: False
default: false
aliases: [ 'assign_public_ip' ]
type: bool
instance_charge_type:
@ -162,7 +162,7 @@ options:
description:
- Whether automate renew the charge of the instance.
type: bool
default: False
default: false
auto_renew_period:
description:
- The duration of the automatic renew the charge of the instance. Required when I(auto_renew=true).
@ -177,7 +177,7 @@ options:
force:
description:
- Whether the current operation needs to be execute forcibly.
default: False
default: false
type: bool
tags:
description:
@ -189,7 +189,7 @@ options:
description:
- Delete any tags not specified in the task that are on the instance.
If True, it means you have to specify all the desired tags on each task affecting an instance.
default: False
default: false
type: bool
version_added: '0.2.0'
key_name:
@ -236,13 +236,13 @@ options:
required parameters are set, and validates the request format, service permissions, and available ECS instances.
If the validation fails, the corresponding error code is returned. If the validation succeeds, the DryRunOperation error code is returned.
- If I(dry_run=false), A request is sent. If the validation succeeds, the instance is created.
default: False
default: false
type: bool
version_added: '0.2.0'
include_data_disks:
description:
- Whether to change instance disks charge type when changing instance charge type.
default: True
default: true
type: bool
version_added: '0.2.0'
author:
@ -265,7 +265,7 @@ EXAMPLES = '''
image: ubuntu1404_64_40G_cloudinit_20160727.raw
instance_type: ecs.n4.small
vswitch_id: vsw-abcd1234
assign_public_ip: True
assign_public_ip: true
max_bandwidth_out: 10
host_name: myhost
password: mypassword
@ -275,7 +275,7 @@ EXAMPLES = '''
security_groups: ["sg-f2rwnfh23r"]
instance_ids: ["i-abcd12346", "i-abcd12345"]
force: True
force: true
tasks:
- name: Launch ECS instance in VPC network

6
plugins/modules/cloud/atomic/atomic_container.py
View file

@ -26,18 +26,18 @@ options:
backend:
description:
- Define the backend to use for the container.
required: True
required: true
choices: ["docker", "ostree"]
type: str
name:
description:
- Name of the container.
required: True
required: true
type: str
image:
description:
- The image to use to install the container.
required: True
required: true
type: str
rootfs:
description:

2
plugins/modules/cloud/atomic/atomic_image.py
View file

@ -31,7 +31,7 @@ options:
name:
description:
- Name of the container image.
required: True
required: true
type: str
state:
description:

10
plugins/modules/cloud/centurylink/clc_aa_policy.py
View file

@ -19,17 +19,17 @@ options:
description:
- The name of the Anti Affinity Policy.
type: str
required: True
required: true
location:
description:
- Datacenter in which the policy lives/should live.
type: str
required: True
required: true
state:
description:
- Whether to create or delete the policy.
type: str
required: False
required: false
default: present
choices: ['present','absent']
requirements:
@ -55,7 +55,7 @@ EXAMPLES = '''
---
- name: Create AA Policy
hosts: localhost
gather_facts: False
gather_facts: false
connection: local
tasks:
- name: Create an Anti Affinity Policy
@ -71,7 +71,7 @@ EXAMPLES = '''
- name: Delete AA Policy
hosts: localhost
gather_facts: False
gather_facts: false
connection: local
tasks:
- name: Delete an Anti Affinity Policy

6
plugins/modules/cloud/centurylink/clc_alert_policy.py
View file

@ -20,7 +20,7 @@ options:
description:
- The alias of your CLC Account
type: str
required: True
required: true
name:
description:
- The name of the alert policy. This is mutually exclusive with id
@ -81,7 +81,7 @@ EXAMPLES = '''
---
- name: Create Alert Policy Example
hosts: localhost
gather_facts: False
gather_facts: false
connection: local
tasks:
- name: Create an Alert Policy for disk above 80% for 5 minutes
@ -102,7 +102,7 @@ EXAMPLES = '''
- name: Delete Alert Policy Example
hosts: localhost
gather_facts: False
gather_facts: false
connection: local
tasks:
- name: Delete an Alert Policy

10
plugins/modules/cloud/centurylink/clc_blueprint_package.py
View file

@ -19,24 +19,24 @@ options:
description:
- A list of server Ids to deploy the blue print package.
type: list
required: True
required: true
elements: str
package_id:
description:
- The package id of the blue print.
type: str
required: True
required: true
package_params:
description:
- The dictionary of arguments required to deploy the blue print.
type: dict
default: {}
required: False
required: false
state:
description:
- Whether to install or uninstall the package. Currently it supports only "present" for install action.
type: str
required: False
required: false
default: present
choices: ['present']
wait:
@ -44,7 +44,7 @@ options:
- Whether to wait for the tasks to finish before returning.
type: str
default: 'True'
required: False
required: false
requirements:
- python = 2.7
- requests >= 2.5.0

8
plugins/modules/cloud/centurylink/clc_firewall_policy.py
View file

@ -19,7 +19,7 @@ options:
description:
- Target datacenter for the firewall policy
type: str
required: True
required: true
state:
description:
- Whether to create or delete the firewall policy
@ -53,7 +53,7 @@ options:
description:
- CLC alias for the source account
type: str
required: True
required: true
destination_account_alias:
description:
- CLC alias for the destination account
@ -90,7 +90,7 @@ EXAMPLES = '''
---
- name: Create Firewall Policy
hosts: localhost
gather_facts: False
gather_facts: false
connection: local
tasks:
- name: Create / Verify an Firewall Policy at CenturyLink Cloud
@ -105,7 +105,7 @@ EXAMPLES = '''
- name: Delete Firewall Policy
hosts: localhost
gather_facts: False
gather_facts: false
connection: local
tasks:
- name: Delete an Firewall Policy at CenturyLink Cloud

16
plugins/modules/cloud/centurylink/clc_group.py
View file

@ -20,23 +20,23 @@ options:
description:
- The name of the Server Group
type: str
required: True
required: true
description:
description:
- A description of the Server Group
type: str
required: False
required: false
parent:
description:
- The parent group of the server group. If parent is not provided, it creates the group at top level.
type: str
required: False
required: false
location:
description:
- Datacenter to create the group in. If location is not provided, the group gets created in the default datacenter
associated with the account
type: str
required: False
required: false
state:
description:
- Whether to create or delete the group
@ -47,8 +47,8 @@ options:
description:
- Whether to wait for the tasks to finish before returning.
type: bool
default: True
required: False
default: true
required: false
requirements:
- python = 2.7
- requests >= 2.5.0
@ -73,7 +73,7 @@ EXAMPLES = '''
---
- name: Create Server Group
hosts: localhost
gather_facts: False
gather_facts: false
connection: local
tasks:
- name: Create / Verify a Server Group at CenturyLink Cloud
@ -90,7 +90,7 @@ EXAMPLES = '''
# Delete a Server Group
- name: Delete Server Group
hosts: localhost
gather_facts: False
gather_facts: false
connection: local
tasks:
- name: Delete / Verify Absent a Server Group at CenturyLink Cloud

6
plugins/modules/cloud/centurylink/clc_loadbalancer.py
View file

@ -20,7 +20,7 @@ options:
description:
- The name of the loadbalancer
type: str
required: True
required: true
description:
description:
- A description for the loadbalancer
@ -29,12 +29,12 @@ options:
description:
- The alias of your CLC Account
type: str
required: True
required: true
location:
description:
- The location of the datacenter where the load balancer resides in
type: str
required: True
required: true
method:
description:
-The balancing method for the load balancer pool

2
plugins/modules/cloud/centurylink/clc_modify_server.py
View file

@ -19,7 +19,7 @@ options:
description:
- A list of server Ids to modify.
type: list
required: True
required: true
elements: str
cpu:
description:

6
plugins/modules/cloud/centurylink/clc_publicip.py
View file

@ -30,7 +30,7 @@ options:
description:
- A list of servers to create public ips on.
type: list
required: True
required: true
elements: str
state:
description:
@ -66,7 +66,7 @@ EXAMPLES = '''
- name: Add Public IP to Server
hosts: localhost
gather_facts: False
gather_facts: false
connection: local
tasks:
- name: Create Public IP For Servers
@ -86,7 +86,7 @@ EXAMPLES = '''
- name: Delete Public IP from Server
hosts: localhost
gather_facts: False
gather_facts: false
connection: local
tasks:
- name: Create Public IP For Servers

14
plugins/modules/cloud/centurylink/clc_server_snapshot.py
View file

@ -19,26 +19,26 @@ options:
description:
- The list of CLC server Ids.
type: list
required: True
required: true
elements: str
expiration_days:
description:
- The number of days to keep the server snapshot before it expires.
type: int
default: 7
required: False
required: false
state:
description:
- The state to insure that the provided resources are in.
type: str
default: 'present'
required: False
required: false
choices: ['present', 'absent', 'restore']
wait:
description:
- Whether to wait for the provisioning tasks to finish before returning.
default: 'True'
required: False
required: false
type: str
requirements:
- python = 2.7
@ -66,7 +66,7 @@ EXAMPLES = '''
- UC1TEST-SVR01
- UC1TEST-SVR02
expiration_days: 10
wait: True
wait: true
state: present
- name: Restore server snapshot
@ -74,7 +74,7 @@ EXAMPLES = '''
server_ids:
- UC1TEST-SVR01
- UC1TEST-SVR02
wait: True
wait: true
state: restore
- name: Delete server snapshot
@ -82,7 +82,7 @@ EXAMPLES = '''
server_ids:
- UC1TEST-SVR01
- UC1TEST-SVR02
wait: True
wait: true
state: absent
'''

2
plugins/modules/cloud/huawei/hwc_vpc_eip.py
View file

@ -135,7 +135,7 @@ EXAMPLES = '''
hwc_vpc_subnet:
gateway_ip: "192.168.100.32"
name: "ansible_network_subnet_test"
dhcp_enable: True
dhcp_enable: true
vpc_id: "{{ vpc.id }}"
cidr: "192.168.100.0/26"
register: subnet

2
plugins/modules/cloud/huawei/hwc_vpc_port.py
View file

@ -119,7 +119,7 @@ EXAMPLES = '''
hwc_vpc_subnet:
gateway_ip: "192.168.100.32"
name: "ansible_network_subnet_test"
dhcp_enable: True
dhcp_enable: true
vpc_id: "{{ vpc.id }}"
cidr: "192.168.100.0/26"
register: subnet

2
plugins/modules/cloud/huawei/hwc_vpc_private_ip.py
View file

@ -63,7 +63,7 @@ EXAMPLES = '''
hwc_vpc_subnet:
gateway_ip: "192.168.100.32"
name: "ansible_network_subnet_test"
dhcp_enable: True
dhcp_enable: true
vpc_id: "{{ vpc.id }}"
cidr: "192.168.100.0/26"
register: subnet

2
plugins/modules/cloud/huawei/hwc_vpc_subnet.py
View file

@ -110,7 +110,7 @@ EXAMPLES = '''
cidr: "192.168.100.0/26"
gateway_ip: "192.168.100.32"
name: "ansible_network_subnet_test"
dhcp_enable: True
dhcp_enable: true
'''
RETURN = '''

12
plugins/modules/cloud/linode/linode.py
View file

@ -209,15 +209,15 @@ EXAMPLES = '''
wait: true
wait_timeout: 600
state: present
alert_bwquota_enabled: True
alert_bwquota_enabled: true
alert_bwquota_threshold: 80
alert_bwin_enabled: True
alert_bwin_enabled: true
alert_bwin_threshold: 10
alert_cpu_enabled: True
alert_cpu_enabled: true
alert_cpu_threshold: 210
alert_bwout_enabled: True
alert_bwout_enabled: true
alert_bwout_threshold: 10
alert_diskio_enabled: True
alert_diskio_enabled: true
alert_diskio_threshold: 10000
backupweeklyday: 1
backupwindow: 2
@ -225,7 +225,7 @@ EXAMPLES = '''
additional_disks:
- {Label: 'disk1', Size: 2500, Type: 'raw'}
- {Label: 'newdisk', Size: 2000}
watchdog: True
watchdog: true
delegate_to: localhost
register: linode_creation

2
plugins/modules/cloud/lxc/lxc_container.py
View file

@ -413,7 +413,7 @@ lxc_container:
description: if the container was cloned
returned: success, when clone_name is specified
type: bool
sample: True
sample: true
"""
import os

2
plugins/modules/cloud/memset/memset_dns_reload.py
View file

@ -42,7 +42,7 @@ EXAMPLES = '''
- name: Submit DNS reload and poll
community.general.memset_dns_reload:
api_key: 5eb86c9196ab03919abcf03857163741
poll: True
poll: true
delegate_to: localhost
'''

2
plugins/modules/cloud/memset/memset_zone_record.py
View file

@ -142,7 +142,7 @@ memset_api:
description: Adds the current domain onto the address field for C(CNAME), C(MX), C(NS) and C(SRV) types.
returned: always
type: bool
sample: False
sample: false
ttl:
description: Record TTL.
returned: always

2
plugins/modules/cloud/misc/proxmox_kvm.py
View file

@ -580,7 +580,7 @@ EXAMPLES = '''
storage: VMs_LVM_thin
format: raw
efitype: 4m
pre_enrolled_keys: False
pre_enrolled_keys: false
- name: Create VM with 1 10GB SATA disk and an EFI disk, with Secure Boot enabled by default
community.general.proxmox_kvm:

2
plugins/modules/cloud/opennebula/one_vm.py
View file

@ -68,7 +68,7 @@ options:
vm_start_on_hold:
description:
- Set to true to put vm on hold while creating
default: False
default: false
type: bool
instance_ids:
description:

2
plugins/modules/cloud/packet/packet_device.py
View file

@ -255,7 +255,7 @@ RETURN = '''
changed:
description: True if a device was altered in any way (created, modified or removed)
type: bool
sample: True
sample: true
returned: success
devices:

14
plugins/modules/cloud/packet/packet_ip_subnet.py
View file

@ -37,13 +37,13 @@ options:
hostname:
description:
- A hostname of a device to/from which to assign/remove a subnet.
required: False
required: false
type: str
device_id:
description:
- UUID of a device to/from which to assign/remove a subnet.
required: False
required: false
type: str
project_id:
@ -118,7 +118,7 @@ RETURN = '''
changed:
description: True if an IP address assignments were altered in any way (created or removed).
type: bool
sample: True
sample: true
returned: success
device_id:
@ -135,15 +135,15 @@ subnet:
assigned_to: { href : /devices/61f9aa5e-0530-47f5-97c2-113828e61ed0 }
cidr: 31
created_at: '2017-08-07T15:15:30Z'
enabled: True
enabled: true
gateway: 147.75.90.240
href: /ips/31eda960-0a16-4c0f-b196-f3dc4928529f
id: 1eda960-0a16-4c0f-b196-f3dc4928529f
manageable: True
management: True
manageable: true
management: true
netmask: 255.255.255.254
network: 147.75.90.240
public: True
public: true
returned: success
'''

2
plugins/modules/cloud/packet/packet_project.py
View file

@ -108,7 +108,7 @@ RETURN = '''
changed:
description: True if a project was created or removed.
type: bool
sample: True
sample: true
returned: success
name:

2
plugins/modules/cloud/packet/packet_sshkey.py
View file

@ -84,7 +84,7 @@ RETURN = '''
changed:
description: True if a sshkey was created or removed.
type: bool
sample: True
sample: true
returned: always
sshkeys:
description: Information about sshkeys that were created/removed.

6
plugins/modules/cloud/packet/packet_volume.py
View file

@ -84,7 +84,7 @@ options:
description:
- Create new volume locked.
type: bool
default: False
default: false
billing_cycle:
description:
@ -102,13 +102,13 @@ options:
snapshot_count:
description:
- How many snapshots to keep, a positive integer.
required: True
required: true
type: int
snapshot_frequency:
description:
- Frequency of snapshots.
required: True
required: true
choices: ["15min", "1hour", "1day", "1week", "1month", "1year"]
type: str

4
plugins/modules/cloud/rackspace/rax.py
View file

@ -179,7 +179,7 @@ extends_documentation_fragment:
EXAMPLES = '''
- name: Build a Cloud Server
gather_facts: False
gather_facts: false
tasks:
- name: Server build request
local_action:
@ -200,7 +200,7 @@ EXAMPLES = '''
- name: Build an exact count of cloud servers with incremented names
hosts: local
gather_facts: False
gather_facts: false
tasks:
- name: Server build requests
local_action:

2
plugins/modules/cloud/rackspace/rax_cbs.py
View file

@ -78,7 +78,7 @@ extends_documentation_fragment:
EXAMPLES = '''
- name: Build a Block Storage Volume
gather_facts: False
gather_facts: false
hosts: local
connection: local
tasks:

2
plugins/modules/cloud/rackspace/rax_cbs_attachments.py
View file

@ -58,7 +58,7 @@ extends_documentation_fragment:
EXAMPLES = '''
- name: Attach a Block Storage Volume
gather_facts: False
gather_facts: false
hosts: local
connection: local
tasks:

2
plugins/modules/cloud/rackspace/rax_cdb.py
View file

@ -70,7 +70,7 @@ extends_documentation_fragment:
EXAMPLES = '''
- name: Build a Cloud Databases
gather_facts: False
gather_facts: false
tasks:
- name: Server build request
local_action:

2
plugins/modules/cloud/rackspace/rax_clb.py
View file

@ -111,7 +111,7 @@ extends_documentation_fragment:
EXAMPLES = '''
- name: Build a Load Balancer
gather_facts: False
gather_facts: false
hosts: local
connection: local
tasks:

2
plugins/modules/cloud/rackspace/rax_dns.py
View file

@ -54,7 +54,7 @@ extends_documentation_fragment:
EXAMPLES = '''
- name: Create domain
hosts: all
gather_facts: False
gather_facts: false
tasks:
- name: Domain create request
local_action:

6
plugins/modules/cloud/rackspace/rax_dns_record.py
View file

@ -24,7 +24,7 @@ options:
description:
- IP address for A/AAAA record, FQDN for CNAME/MX/NS, or text data for
SRV/TXT
required: True
required: true
domain:
type: str
description:
@ -38,7 +38,7 @@ options:
type: str
description:
- FQDN record name to create
required: True
required: true
overwrite:
description:
- Add new records if data doesn't match, instead of updating existing
@ -100,7 +100,7 @@ extends_documentation_fragment:
EXAMPLES = '''
- name: Create DNS Records
hosts: all
gather_facts: False
gather_facts: false
tasks:
- name: Create A record
local_action:

2
plugins/modules/cloud/rackspace/rax_facts.py
View file

@ -37,7 +37,7 @@ extends_documentation_fragment:
EXAMPLES = '''
- name: Gather info about servers
hosts: all
gather_facts: False
gather_facts: false
tasks:
- name: Get facts about servers
local_action:

2
plugins/modules/cloud/rackspace/rax_files_objects.py
View file

@ -83,7 +83,7 @@ extends_documentation_fragment:
EXAMPLES = '''
- name: "Test Cloud Files Objects"
hosts: local
gather_facts: False
gather_facts: false
tasks:
- name: "Get objects from test container"
community.general.rax_files_objects:

2
plugins/modules/cloud/rackspace/rax_identity.py
View file

@ -32,7 +32,7 @@ extends_documentation_fragment:
EXAMPLES = '''
- name: Load Rackspace Cloud Identity
gather_facts: False
gather_facts: false
hosts: local
connection: local
tasks:

4
plugins/modules/cloud/rackspace/rax_keypair.py
View file

@ -45,7 +45,7 @@ extends_documentation_fragment:
EXAMPLES = '''
- name: Create a keypair
hosts: localhost
gather_facts: False
gather_facts: false
tasks:
- name: Keypair request
local_action:
@ -67,7 +67,7 @@ EXAMPLES = '''
- name: Create a keypair
hosts: localhost
gather_facts: False
gather_facts: false
tasks:
- name: Keypair request
local_action:

2
plugins/modules/cloud/rackspace/rax_meta.py
View file

@ -41,7 +41,7 @@ extends_documentation_fragment:
EXAMPLES = '''
- name: Set metadata for a server
hosts: all
gather_facts: False
gather_facts: false
tasks:
- name: Set metadata
local_action:

2
plugins/modules/cloud/rackspace/rax_mon_alarm.py
View file

@ -77,7 +77,7 @@ extends_documentation_fragment:
EXAMPLES = '''
- name: Alarm example
gather_facts: False
gather_facts: false
hosts: local
connection: local
tasks:

2
plugins/modules/cloud/rackspace/rax_mon_check.py
View file

@ -119,7 +119,7 @@ extends_documentation_fragment:
EXAMPLES = '''
- name: Create a monitoring check
gather_facts: False
gather_facts: false
hosts: local
connection: local
tasks:

2
plugins/modules/cloud/rackspace/rax_mon_entity.py
View file

@ -57,7 +57,7 @@ extends_documentation_fragment:
EXAMPLES = '''
- name: Entity example
gather_facts: False
gather_facts: false
hosts: local
connection: local
tasks:

2
plugins/modules/cloud/rackspace/rax_mon_notification.py
View file

@ -52,7 +52,7 @@ extends_documentation_fragment:
EXAMPLES = '''
- name: Monitoring notification example
gather_facts: False
gather_facts: false
hosts: local
connection: local
tasks:

2
plugins/modules/cloud/rackspace/rax_mon_notification_plan.py
View file

@ -58,7 +58,7 @@ extends_documentation_fragment:
EXAMPLES = '''
- name: Example notification plan
gather_facts: False
gather_facts: false
hosts: local
connection: local
tasks:

2
plugins/modules/cloud/rackspace/rax_network.py
View file

@ -42,7 +42,7 @@ extends_documentation_fragment:
EXAMPLES = '''
- name: Build an Isolated Network
gather_facts: False
gather_facts: false
tasks:
- name: Network create request

2
plugins/modules/cloud/rackspace/rax_queue.py
View file

@ -38,7 +38,7 @@ extends_documentation_fragment:
EXAMPLES = '''
- name: Build a Queue
gather_facts: False
gather_facts: false
hosts: local
connection: local
tasks:

4
plugins/modules/cloud/smartos/nictagadm.py
View file

@ -80,7 +80,7 @@ etherstub:
description: specifies if the nic tag will create and attach to an etherstub.
returned: always
type: bool
sample: False
sample: false
mtu:
description: specifies which MTU size was passed during the nictagadm add command. mtu and etherstub are mutually exclusive.
returned: always
@ -90,7 +90,7 @@ force:
description: Shows if -f was used during the deletion of a nic tag
returned: always
type: bool
sample: False
sample: false
state:
description: state of the target
returned: always

2
plugins/modules/cloud/softlayer/sl_vm.py
View file

@ -230,7 +230,7 @@ EXAMPLES = '''
- 100
os_code: UBUNTU_LATEST
ssh_keys: []
wait: True
wait: true
- hostname: instance-3
domain: anydomain.com
datacenter: dal09

16
plugins/modules/cloud/spotinst/spotinst_aws_elastigroup.py
View file

@ -523,7 +523,7 @@ EXAMPLES = '''
min_size: 0
target: 0
unit: instance
monitoring: True
monitoring: true
name: ansible-group
on_demand_instance_type: c3.large
product: Linux/UNIX
@ -561,7 +561,7 @@ EXAMPLES = '''
min_size: 0
target: 0
unit: instance
monitoring: True
monitoring: true
name: ansible-group-tal
on_demand_instance_type: c3.large
product: Linux/UNIX
@ -576,7 +576,7 @@ EXAMPLES = '''
- c3.large
do_not_update:
- image_id
wait_for_instances: True
wait_for_instances: true
wait_timeout: 600
register: result
@ -608,7 +608,7 @@ EXAMPLES = '''
min_size: 0
target: 0
unit: instance
monitoring: True
monitoring: true
name: ansible-group-tal
on_demand_instance_type: c3.large
product: Linux/UNIX
@ -627,7 +627,7 @@ EXAMPLES = '''
- c3.large
do_not_update:
- image_id
wait_for_instances: True
wait_for_instances: true
wait_timeout: 600
register: result
@ -659,7 +659,7 @@ EXAMPLES = '''
virtual_name: ephemeral0
- device_name: '/dev/xvdb/'
virtual_name: ephemeral1
monitoring: True
monitoring: true
name: ansible-group
on_demand_instance_type: c3.large
product: Linux/UNIX
@ -697,7 +697,7 @@ EXAMPLES = '''
min_size: 0
target: 0
unit: instance
monitoring: True
monitoring: true
name: ansible-group
on_demand_instance_type: c3.large
product: Linux/UNIX
@ -737,7 +737,7 @@ EXAMPLES = '''
min_size: 0
target: 2
unit: instance
monitoring: True
monitoring: true
name: ansible-group-1
on_demand_instance_type: c3.large
product: Linux/UNIX

2
plugins/modules/cloud/univention/udm_share.py
View file

@ -106,7 +106,7 @@ options:
description:
- Show in Windows network environment.
type: bool
default: True
default: true
aliases: [ samba_browsable ]
sambaCreateMode:
default: '0744'

2
plugins/modules/clustering/consul/consul_acl.py
View file

@ -79,7 +79,7 @@ options:
description:
- whether to verify the tls certificate of the consul agent
required: false
default: True
default: true
requirements:
- python-consul
- pyhcl

2
plugins/modules/clustering/consul/consul_kv.py
View file

@ -61,7 +61,7 @@ options:
description:
- If the I(state) is C(present) and I(value) is set, perform a
read after setting the value and return this value.
default: True
default: true
type: bool
session:
description:

2
plugins/modules/clustering/consul/consul_session.py
View file

@ -88,7 +88,7 @@ options:
description:
- Whether to verify the TLS certificate of the consul agent.
type: bool
default: True
default: true
behavior:
description:
- The optional behavior that can be attached to the session when it

2
plugins/modules/clustering/pacemaker_cluster.py
View file

@ -52,7 +52,7 @@ EXAMPLES = '''
RETURN = '''
changed:
description: True if the cluster state has changed
description: true if the cluster state has changed
type: bool
returned: always
out:

30
plugins/modules/database/aerospike/aerospike_migrations.py
View file

@ -23,73 +23,73 @@ options:
host:
description:
- Which host do we use as seed for info connection
required: False
required: false
type: str
default: localhost
port:
description:
- Which port to connect to Aerospike on (service port)
required: False
required: false
type: int
default: 3000
connect_timeout:
description:
- How long to try to connect before giving up (milliseconds)
required: False
required: false
type: int
default: 1000
consecutive_good_checks:
description:
- How many times should the cluster report "no migrations"
consecutively before returning OK back to ansible?
required: False
required: false
type: int
default: 3
sleep_between_checks:
description:
- How long to sleep between each check (seconds).
required: False
required: false
type: int
default: 60
tries_limit:
description:
- How many times do we poll before giving up and failing?
default: 300
required: False
required: false
type: int
local_only:
description:
- Do you wish to only check for migrations on the local node
before returning, or do you want all nodes in the cluster
to finish before returning?
required: True
required: true
type: bool
min_cluster_size:
description:
- Check will return bad until cluster size is met
or until tries is exhausted
required: False
required: false
type: int
default: 1
fail_on_cluster_change:
description:
- Fail if the cluster key changes
if something else is changing the cluster, we may want to fail
required: False
required: false
type: bool
default: True
default: true
migrate_tx_key:
description:
- The metric key used to determine if we have tx migrations
remaining. Changeable due to backwards compatibility.
required: False
required: false
type: str
default: migrate_tx_partitions_remaining
migrate_rx_key:
description:
- The metric key used to determine if we have rx migrations
remaining. Changeable due to backwards compatibility.
required: False
required: false
type: str
default: migrate_rx_partitions_remaining
target_cluster_size:
@ -102,7 +102,7 @@ options:
- If this option is specified on a cluster that has at least 1
host <4.3 then it will be ignored until the min version reaches
4.3.
required: False
required: false
type: int
'''
EXAMPLES = '''
@ -114,7 +114,7 @@ EXAMPLES = '''
consecutive_good_checks: 5
sleep_between_checks: 15
tries_limit: 600
local_only: False
local_only: false
# example playbook:
- name: Upgrade aerospike
@ -140,7 +140,7 @@ EXAMPLES = '''
# Tries Limit * Sleep Between Checks * delay * retries
- name: Wait for aerospike migrations
community.general.aerospike_migrations:
local_only: True
local_only: true
sleep_between_checks: 1
tries_limit: 5
consecutive_good_checks: 3

2
plugins/modules/database/influxdb/influxdb_user.py
View file

@ -24,7 +24,7 @@ options:
user_name:
description:
- Name of the user.
required: True
required: true
type: str
user_password:
description:

8
plugins/modules/database/misc/elasticsearch_plugin.py
View file

@ -22,7 +22,7 @@ options:
name:
description:
- Name of the plugin to install.
required: True
required: true
type: str
state:
description:
@ -40,13 +40,13 @@ options:
parameter. If, for example, the plugin is already installed, changing this has no
effect.
- For ES 1.x use url.
required: False
required: false
type: str
url:
description:
- Set exact URL to download the plugin from (Only works for ES 1.x).
- For ES 2.x and higher, use src.
required: False
required: false
type: str
timeout:
description:
@ -57,7 +57,7 @@ options:
force:
description:
- "Force batch mode when installing plugins. This is only necessary if a plugin requires additional permissions and console detection fails."
default: False
default: false
type: bool
plugin_bin:
description:

2
plugins/modules/database/misc/kibana_plugin.py
View file

@ -22,7 +22,7 @@ options:
name:
description:
- Name of the plugin to install.
required: True
required: true
type: str
state:
description:

Some files were not shown because too many files have changed in this diff Show more