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

Normalize more booleans. (#5247)

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -21,7 +21,7 @@ DOCUMENTATION = '''
- The format is C(host:port:db:password), for example C(localhost:6379:0:changeme). - 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 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. - 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: env:
- name: ANSIBLE_CACHE_PLUGIN_CONNECTION - name: ANSIBLE_CACHE_PLUGIN_CONNECTION
ini: ini:

View file

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

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) - 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: options:
max_mem_file: 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) 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: env:
- name: CGROUP_MAX_MEM_FILE - name: CGROUP_MAX_MEM_FILE
@ -31,7 +31,7 @@ DOCUMENTATION = '''
- section: callback_cgroupmemrecap - section: callback_cgroupmemrecap
key: max_mem_file key: max_mem_file
cur_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) description: Path to C(memory.usage_in_bytes) file. Example C(/sys/fs/cgroup/memory/ansible_profile/memory.usage_in_bytes)
env: env:
- name: CGROUP_CUR_MEM_FILE - name: CGROUP_CUR_MEM_FILE

View file

@ -713,7 +713,7 @@ playbook.yml: >
- name: Using alias vars (see ansible.cfg) - name: Using alias vars (see ansible.cfg)
ansible.builtin.debug: ansible.builtin.debug:
msg: msg:
when: False when: false
vars: vars:
ansible_callback_diy_playbook_on_task_start_msg: "" 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" 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"

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

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. description: Adds the current domain onto the address field for C(CNAME), C(MX), C(NS) and C(SRV) types.
returned: always returned: always
type: bool type: bool
sample: False sample: false
ttl: ttl:
description: Record TTL. description: Record TTL.
returned: always returned: always

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

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