ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-27 23:21:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

fix style in plugins (#10303)

Browse source
This commit is contained in:
Alexei Znamensky 2025-07-02 01:15:01 +12:00 • committed by GitHub
commit 329c2222fc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
35 changed files with 98 additions and 97 deletions
Download patch file Download diff file Expand all files Collapse all files

2
plugins/lookup/bitwarden.py
View file

@ -57,7 +57,7 @@ options:
version_added: 8.4.0
result_count:
description:
- Number of results expected for the lookup query. Task will fail if O(result_count) is set but does not match the number
- Number of results expected for the lookup query. Task fails if O(result_count) is set but does not match the number
of query results. Leave empty to skip this check.
type: int
version_added: 10.4.0

2
plugins/lookup/cartesian.py
View file

@ -9,7 +9,7 @@ __metaclass__ = type
DOCUMENTATION = r"""
author: Unknown (!UNKNOWN)
name: cartesian
short_description: returns the cartesian product of lists
short_description: Returns the cartesian product of lists
description:
- Takes the input lists and returns a list that represents the product of the input lists.
- It is clearer with an example, it turns [1, 2, 3], [a, b] into [1, a], [1, b], [2, a], [2, b], [3, a], [3, b].

2
plugins/lookup/chef_databag.py
View file

@ -9,7 +9,7 @@ __metaclass__ = type
DOCUMENTATION = r"""
author: Unknown (!UNKNOWN)
name: chef_databag
short_description: fetches data from a Chef Databag
short_description: Fetches data from a Chef Databag
description:
- 'This is a lookup plugin to provide access to chef data bags using the pychef package. It interfaces with the chef server
API using the same methods to find a knife or chef-client config file to load parameters from, starting from either the

4
plugins/lookup/collection_version.py
View file

@ -49,8 +49,8 @@ RETURN = r"""
_raw:
description:
- The version number of the collections listed as input.
- If a collection can not be found, it will return the value provided in O(result_not_found). By default, this is V(none).
- If a collection can be found, but the version not identified, it will return the value provided in O(result_no_version).
- If a collection can not be found, it returns the value provided in O(result_not_found). By default, this is V(none).
- If a collection can be found, but the version not identified, it returns the value provided in O(result_no_version).
By default, this is V(*). This can happen for collections installed from git which do not have a version number in V(galaxy.yml).
type: list
elements: str

8
plugins/lookup/consul_kv.py
View file

@ -24,7 +24,7 @@ options:
elements: string
recurse:
type: boolean
description: If true, will retrieve all the values that have the given key as prefix.
description: If V(true), retrieves all the values that have the given key as prefix.
default: false
index:
description:
@ -42,14 +42,14 @@ options:
type: str
description:
- The target to connect to, must be a resolvable address.
- Will be determined from E(ANSIBLE_CONSUL_URL) if that is set.
- It is determined from E(ANSIBLE_CONSUL_URL) if that is set.
ini:
- section: lookup_consul
key: host
port:
description:
- The port of the target host to connect to.
- If you use E(ANSIBLE_CONSUL_URL) this value will be used from there.
- If you use E(ANSIBLE_CONSUL_URL) this value is used from there.
type: int
default: 8500
scheme:
@ -57,7 +57,7 @@ options:
type: str
description:
- Whether to use http or https.
- If you use E(ANSIBLE_CONSUL_URL) this value will be used from there.
- If you use E(ANSIBLE_CONSUL_URL) this value is used from there.
validate_certs:
default: true
description: Whether to verify the TLS connection or not.

2
plugins/lookup/credstash.py
View file

@ -9,7 +9,7 @@ __metaclass__ = type
DOCUMENTATION = r"""
author: Unknown (!UNKNOWN)
name: credstash
short_description: retrieve secrets from Credstash on AWS
short_description: Retrieve secrets from Credstash on AWS
requirements:
- credstash (python library)
description:

6
plugins/lookup/cyberarkpassword.py
View file

@ -9,7 +9,7 @@ __metaclass__ = type
DOCUMENTATION = r"""
author: Unknown (!UNKNOWN)
name: cyberarkpassword
short_description: get secrets from CyberArk AIM
short_description: Get secrets from CyberArk AIM
requirements:
- CyberArk AIM tool installed
description:
@ -39,8 +39,8 @@ options:
description: For extra_params values please check parameters for clipasswordsdk in CyberArk's "Credential Provider and
ASCP Implementation Guide".
notes:
- For Ansible on Windows, please change the -parameters (C(-p), C(-d), and C(-o)) to /parameters (C(/p), C(/d), and C(/o)) and change the
location of C(CLIPasswordSDK.exe).
- For Ansible on Windows, please change the -parameters (C(-p), C(-d), and C(-o)) to /parameters (C(/p), C(/d), and C(/o))
and change the location of C(CLIPasswordSDK.exe).
"""
EXAMPLES = r"""

23
plugins/lookup/dig.py
View file

@ -9,7 +9,7 @@ __metaclass__ = type
DOCUMENTATION = r"""
name: dig
author: Jan-Piet Mens (@jpmens) <jpmens(at)gmail.com>
short_description: query DNS using the dnspython library
short_description: Query DNS using the dnspython library
requirements:
- dnspython (python library, http://www.dnspython.org/)
description:
@ -21,10 +21,10 @@ description:
- In addition to (default) A record, it is also possible to specify a different record type that should be queried. This
can be done by either passing-in additional parameter of format qtype=TYPE to the dig lookup, or by appending /TYPE to
the FQDN being queried.
- If multiple values are associated with the requested record, the results will be returned as a comma-separated list. In
- If multiple values are associated with the requested record, the results are returned as a comma-separated list. In
such cases you may want to pass option C(wantlist=true) to the lookup call, or alternatively use C(query) instead of C(lookup),
which will result in the record values being returned as a list over which you can iterate later on.
- By default, the lookup will rely on system-wide configured DNS servers for performing the query. It is also possible to
which results in the record values being returned as a list over which you can iterate later on.
- By default, the lookup relies on system-wide configured DNS servers for performing the query. It is also possible to
explicitly specify DNS servers to query using the @DNS_SERVER_1,DNS_SERVER_2,...,DNS_SERVER_N notation. This needs to
be passed-in as an additional parameter to the lookup.
options:
@ -75,16 +75,16 @@ options:
fail_on_error:
description:
- Abort execution on lookup errors.
- The default for this option will likely change to V(true) in the future. The current default, V(false), is used for
backwards compatibility, and will result in empty strings or the string V(NXDOMAIN) in the result in case of errors.
- The default for this option is likely to change to V(true) in the future. The current default, V(false), is used for
backwards compatibility, and results in empty strings or the string V(NXDOMAIN) in the result in case of errors.
default: false
type: bool
version_added: 5.4.0
real_empty:
description:
- Return empty result without empty strings, and return empty list instead of V(NXDOMAIN).
- The default for this option will likely change to V(true) in the future.
- This option will be forced to V(true) if multiple domains to be queried are specified.
- The default for this option is likely to change to V(true) in the future.
- This option is forced to V(true) if multiple domains to be queried are specified.
default: false
type: bool
version_added: 6.0.0
@ -104,10 +104,9 @@ options:
type: int
version_added: 9.5.0
notes:
- V(ALL) is not a record in itself, merely the listed fields are available for any record results you retrieve in the form of
a dictionary.
- While the plugin supports anything which C(dnspython) supports out of the box, only a subset can be converted
into a dictionary.
- V(ALL) is not a record in itself, merely the listed fields are available for any record results you retrieve in the form
of a dictionary.
- While the plugin supports anything which C(dnspython) supports out of the box, only a subset can be converted into a dictionary.
- If you need to obtain the AAAA record (IPv6 address), you must specify the record type explicitly. Syntax for specifying
the record type is shown in the examples below.
- The trailing dot in most of the examples listed is purely optional, but is specified for completeness/correctness sake.

4
plugins/lookup/dnstxt.py
View file

@ -9,7 +9,7 @@ __metaclass__ = type
DOCUMENTATION = r"""
name: dnstxt
author: Jan-Piet Mens (@jpmens) <jpmens(at)gmail.com>
short_description: query a domain(s)'s DNS txt fields
short_description: Query a domain(s)'s DNS txt fields
requirements:
- dns/dns.resolver (python library)
description:
@ -23,7 +23,7 @@ options:
real_empty:
description:
- Return empty result without empty strings, and return empty list instead of V(NXDOMAIN).
- The default for this option will likely change to V(true) in the future.
- The default for this option is likely to change to V(true) in the future.
default: false
type: bool
version_added: 6.0.0

2
plugins/lookup/etcd.py
View file

@ -12,7 +12,7 @@ DOCUMENTATION = r"""
author:
- Jan-Piet Mens (@jpmens)
name: etcd
short_description: get info from an etcd server
short_description: Get info from an etcd server
description:
- Retrieves data from an etcd server.
options:

4
plugins/lookup/filetree.py
View file

@ -9,11 +9,11 @@ __metaclass__ = type
DOCUMENTATION = r"""
name: filetree
author: Dag Wieers (@dagwieers) <dag@wieers.com>
short_description: recursively match all files in a directory tree
short_description: Recursively match all files in a directory tree
description:
- This lookup enables you to template a complete tree of files on a target system while retaining permissions and ownership.
- Supports directories, files and symlinks, including SELinux and other file properties.
- If you provide more than one path, it will implement a first_found logic, and will not process entries it already processed
- If you provide more than one path, it implements a first_found logic, and does not process entries it already processed
in previous paths. This enables merging different trees in order of importance, or add role_vars to specific paths to
influence different instances of the same role.
options:

6
plugins/lookup/flattened.py
View file

@ -9,9 +9,9 @@ __metaclass__ = type
DOCUMENTATION = r"""
name: flattened
author: Serge van Ginderachter (!UNKNOWN) <serge@vanginderachter.be>
short_description: return single list completely flattened
short_description: Return single list completely flattened
description:
- Given one or more lists, this lookup will flatten any list elements found recursively until only 1 list is left.
- Given one or more lists, this lookup flattens any list elements found recursively until only 1 list is left.
options:
_terms:
description: Lists to flatten.
@ -19,7 +19,7 @@ options:
elements: raw
required: true
notes:
- Unlike the P(ansible.builtin.items#lookup) lookup which only flattens 1 level, this plugin will continue to flatten until
- Unlike the P(ansible.builtin.items#lookup) lookup which only flattens 1 level, this plugin continues to flatten until
it cannot find lists anymore.
- Aka highlander plugin, there can only be one (list).
"""

2
plugins/lookup/hiera.py
View file

@ -10,7 +10,7 @@ DOCUMENTATION = r"""
author:
- Juan Manuel Parrilla (@jparrill)
name: hiera
short_description: get info from hiera data
short_description: Get info from hiera data
requirements:
- hiera (command line utility)
description:

2
plugins/lookup/keyring.py
View file

@ -13,7 +13,7 @@ author:
- Samuel Boucher (!UNKNOWN) <boucher.samuel.c@gmail.com>
requirements:
- keyring (python library)
short_description: grab secrets from the OS keyring
short_description: Grab secrets from the OS keyring
description:
- Allows you to access data stored in the OS provided keyring/keychain.
"""

2
plugins/lookup/lastpass.py
View file

@ -13,7 +13,7 @@ author:
requirements:
- lpass (command line utility)
- must have already logged into LastPass
short_description: fetch data from LastPass
short_description: Fetch data from LastPass
description:
- Use the lpass command line utility to fetch specific fields from LastPass.
options:

2
plugins/lookup/lmdb_kv.py
View file

@ -11,7 +11,7 @@ name: lmdb_kv
author:
- Jan-Piet Mens (@jpmens)
version_added: '0.2.0'
short_description: fetch data from LMDB
short_description: Fetch data from LMDB
description:
- This lookup returns a list of results from an LMDB DB corresponding to a list of items given to it.
requirements:

15
plugins/lookup/merge_variables.py
View file

@ -12,7 +12,7 @@ author:
- Mark Ettema (@m-a-r-k-e)
- Alexander Petrenz (@alpex8)
name: merge_variables
short_description: merge variables whose names match a given pattern
short_description: Merge variables whose names match a given pattern
description:
- This lookup returns the merged result of all variables in scope that match the given prefixes, suffixes, or regular expressions,
optionally.
@ -20,8 +20,8 @@ version_added: 6.5.0
options:
_terms:
description:
- Depending on the value of O(pattern_type), this is a list of prefixes, suffixes, or regular expressions that will
be used to match all variables that should be merged.
- Depending on the value of O(pattern_type), this is a list of prefixes, suffixes, or regular expressions that is used
to match all variables that should be merged.
required: true
type: list
elements: str
@ -45,11 +45,11 @@ options:
type: raw
override:
description:
- Return an error, print a warning or ignore it when a key will be overwritten.
- Return an error, print a warning or ignore it when a key is overwritten.
- The default behavior V(error) makes the plugin fail when a key would be overwritten.
- When V(warn) and V(ignore) are used, note that it is important to know that the variables are sorted by name before
being merged. Keys for later variables in this order will overwrite keys of the same name for variables earlier in
this order. To avoid potential confusion, better use O(override=error) whenever possible.
being merged. Keys for later variables in this order overwrite keys of the same name for variables earlier in this
order. To avoid potential confusion, better use O(override=error) whenever possible.
type: str
default: 'error'
choices:
@ -111,8 +111,7 @@ example_b: "{{ lookup('community.general.merge_variables', '^.+__test_list$', in
RETURN = r"""
_raw:
description: In case the search matches list items, a list will be returned. In case the search matches dicts, a dict will
be returned.
description: In case the search matches list items, a list is returned. In case the search matches dicts, a dict is returned.
type: raw
elements: raw
"""

1
plugins/lookup/onepassword.py
View file

@ -41,7 +41,6 @@ extends_documentation_fragment:
"""
EXAMPLES = r"""
---
# These examples only work when already signed in to 1Password
- name: Retrieve password for KITT when already signed in to 1Password
ansible.builtin.debug:

16
plugins/lookup/passwordstore.py
View file

@ -11,7 +11,7 @@ DOCUMENTATION = r"""
name: passwordstore
author:
- Patrick Deelman (!UNKNOWN) <patrick@patrickdeelman.nl>
short_description: manage passwords with passwordstore.org's pass utility
short_description: Manage passwords with passwordstore.org's pass utility
description:
- Enables Ansible to retrieve, create or update passwords from the passwordstore.org pass utility. It can also retrieve,
create or update YAML style keys stored as multilines in the passwordfile.
@ -55,7 +55,7 @@ options:
subkey:
description:
- By default return a specific subkey of the password. When set to V(password), always returns the first line.
- With O(overwrite=true), it will create the subkey and return it.
- With O(overwrite=true), it creates the subkey and returns it.
type: str
default: password
userpass:
@ -77,10 +77,10 @@ options:
description:
- List of preference about what to do if the password file is missing.
- If O(create=true), the value for this option is ignored and assumed to be V(create).
- If set to V(error), the lookup will error out if the passname does not exist.
- If set to V(create), the passname will be created with the provided length O(length) if it does not exist.
- If set to V(empty) or V(warn), will return a V(none) in case the passname does not exist. When using C(lookup) and
not C(query), this will be translated to an empty string.
- If set to V(error), the lookup fails out if the passname does not exist.
- If set to V(create), the passname is created with the provided length O(length) if it does not exist.
- If set to V(empty) or V(warn), it returns a V(none) in case the passname does not exist. When using C(lookup) and
not C(query), this is translated to an empty string.
version_added: 3.1.0
type: str
default: error
@ -146,8 +146,8 @@ options:
missing_subkey:
description:
- Preference about what to do if the password subkey is missing.
- If set to V(error), the lookup will error out if the subkey does not exist.
- If set to V(empty) or V(warn), will return a V(none) in case the subkey does not exist.
- If set to V(error), the lookup fails out if the subkey does not exist.
- If set to V(empty) or V(warn), it returns a V(none) in case the subkey does not exist.
version_added: 8.6.0
type: str
default: empty

2
plugins/lookup/random_pet.py
View file

@ -27,7 +27,7 @@ options:
length:
description:
- The maximal length of every component of the pet name.
- Values below 3 will be set to 3 by petname.
- Values below V(3) are set to V(3) by petname.
default: 6
type: int
prefix:

6
plugins/lookup/random_string.py
View file

@ -41,9 +41,9 @@ options:
special:
description:
- Include special characters in the string.
- Special characters are taken from Python standard library C(string).
See L(the documentation of string.punctuation,https://docs.python.org/3/library/string.html#string.punctuation)
for which characters will be used.
- Special characters are taken from Python standard library C(string). See L(the documentation of
string.punctuation,https://docs.python.org/3/library/string.html#string.punctuation)
for which characters are used.
- The choice of special characters can be changed to setting O(override_special).
default: true
type: bool

2
plugins/lookup/redis.py
View file

@ -11,7 +11,7 @@ name: redis
author:
- Jan-Piet Mens (@jpmens) <jpmens(at)gmail.com>
- Ansible Core Team
short_description: fetch data from Redis
short_description: Fetch data from Redis
description:
- This lookup returns a list of results from a Redis DB corresponding to a list of items given to it.
requirements:

8
plugins/lookup/revbitspss.py
View file

@ -19,18 +19,18 @@ requirements:
options:
_terms:
description:
- This will be an array of keys for secrets which you want to fetch from RevBits PAM.
- This is an array of keys for secrets which you want to fetch from RevBits PAM.
required: true
type: list
elements: string
base_url:
description:
- This will be the base URL of the server, for example V(https://server-url-here).
- This is the base URL of the server, for example V(https://server-url-here).
required: true
type: string
api_key:
description:
- This will be the API key for authentication. You can get it from the RevBits PAM secret manager module.
- This is the API key for authentication. You can get it from the RevBits PAM secret manager module.
required: true
type: string
"""
@ -39,7 +39,7 @@ RETURN = r"""
_list:
description:
- The JSON responses which you can access with defined keys.
- If you are fetching secrets named as UUID, PASSWORD it will gives you the dict of all secrets.
- If you are fetching secrets named as UUID, PASSWORD it returns the dict of all secrets.
type: list
elements: dict
"""

2
plugins/lookup/shelvefile.py
View file

@ -9,7 +9,7 @@ __metaclass__ = type
DOCUMENTATION = r"""
name: shelvefile
author: Alejandro Guirao (!UNKNOWN) <lekumberri@gmail.com>
short_description: read keys from Python shelve file
short_description: Read keys from Python shelve file
description:
- Read keys from Python shelve file.
options:

6
plugins/lookup/tss.py
View file

@ -33,14 +33,14 @@ options:
fetch_secret_ids_from_folder:
description:
- Boolean flag which indicates whether secret IDs are in a folder is fetched by folder ID or not.
- V(true) then the terms will be considered as a folder IDs. Otherwise (default), they are considered as secret IDs.
- V(true) then the terms are considered as a folder IDs. Otherwise (default), they are considered as secret IDs.
required: false
type: bool
version_added: 7.1.0
fetch_attachments:
description:
- Boolean flag which indicates whether attached files will get downloaded or not.
- The download will only happen if O(file_download_path) has been provided.
- Boolean flag which indicates whether attached files are downloaded or not.
- The download only happens if O(file_download_path) has been provided.
required: false
type: bool
version_added: 7.0.0