diff --git a/plugins/filter/replace_keys.py b/plugins/filter/replace_keys.py index d47468bd3c..69fe02832b 100644 --- a/plugins/filter/replace_keys.py +++ b/plugins/filter/replace_keys.py @@ -34,7 +34,7 @@ options: description: - A key or key pattern to change. - The interpretation of O(target[].before) depends on O(matching_parameter). - - For a key that matches multiple O(target[].before)s, the B(first) matching O(target[].after) will be used. + - For a key that matches multiple O(target[].before)s, the B(first) matching O(target[].after) is used. type: str after: description: A matching key change to. diff --git a/plugins/filter/to_prettytable.py b/plugins/filter/to_prettytable.py index 34da0481d4..269ac318ff 100644 --- a/plugins/filter/to_prettytable.py +++ b/plugins/filter/to_prettytable.py @@ -32,8 +32,8 @@ options: description: - Dictionary where keys are column names and values are alignment settings. Valid alignment values are C(left), C(center), C(right), C(l), C(c), or C(r). - - "For example, V({'name': 'left', 'id': 'right'}) will align the C(name) column to the left and the C(id) column to - the right." + - "For example, V({'name': 'left', 'id': 'right'}) aligns the C(name) column to the left and the C(id) column to the + right." type: dictionary """ diff --git a/plugins/inventory/cobbler.py b/plugins/inventory/cobbler.py index 4646a07b2a..677e1a3ad5 100644 --- a/plugins/inventory/cobbler.py +++ b/plugins/inventory/cobbler.py @@ -12,14 +12,17 @@ short_description: Cobbler inventory source version_added: 1.0.0 description: - Get inventory hosts from the cobbler service. - - "Uses a configuration file as an inventory source, it must end in C(.cobbler.yml) or C(.cobbler.yaml) and have a C(plugin: cobbler) entry." - - Adds the primary IP addresses to C(cobbler_ipv4_address) and C(cobbler_ipv6_address) host variables if defined in Cobbler. The primary IP address is - defined as the management interface if defined, or the interface who's DNS name matches the hostname of the system, or else the first interface found. + - 'Uses a configuration file as an inventory source, it must end in C(.cobbler.yml) or C(.cobbler.yaml) and have a C(plugin: + cobbler) entry.' + - Adds the primary IP addresses to C(cobbler_ipv4_address) and C(cobbler_ipv6_address) host variables if defined in Cobbler. + The primary IP address is defined as the management interface if defined, or the interface who's DNS name matches the + hostname of the system, or else the first interface found. extends_documentation_fragment: - inventory_cache options: plugin: - description: The name of this plugin, it should always be set to V(community.general.cobbler) for this plugin to recognize it as its own. + description: The name of this plugin, it should always be set to V(community.general.cobbler) for this plugin to recognize + it as its own. type: string required: true choices: ['cobbler', 'community.general.cobbler'] @@ -72,7 +75,7 @@ options: include_profiles: description: - Profiles to include from inventory. - - If specified, all other profiles will be excluded. + - If specified, all other profiles are excluded. - O(exclude_profiles) is ignored if O(include_profiles) is specified. type: list default: [] @@ -81,7 +84,8 @@ options: inventory_hostname: description: - What to use for the ansible inventory hostname. - - By default the networking hostname is used if defined, otherwise the DNS name of the management or first non-static interface. + - By default the networking hostname is used if defined, otherwise the DNS name of the management or first non-static + interface. - If set to V(system), the cobbler system name is used. type: str choices: ['hostname', 'system'] @@ -99,12 +103,12 @@ options: description: Prefix to apply to cobbler groups. default: cobbler_ want_facts: - description: Toggle, if V(true) the plugin will retrieve all host facts from the server. + description: Toggle, if V(true) the plugin retrieves all host facts from the server. type: boolean default: true want_ip_addresses: description: - - Toggle, if V(true) the plugin will add a C(cobbler_ipv4_addresses) and C(cobbler_ipv6_addresses) dictionary to the + - Toggle, if V(true) the plugin adds a C(cobbler_ipv4_addresses) and C(cobbler_ipv6_addresses) dictionary to the defined O(group) mapping interface DNS names to IP addresses. type: boolean default: true diff --git a/plugins/inventory/gitlab_runners.py b/plugins/inventory/gitlab_runners.py index 5b7f4c504c..7a10b553a2 100644 --- a/plugins/inventory/gitlab_runners.py +++ b/plugins/inventory/gitlab_runners.py @@ -21,7 +21,7 @@ description: - Uses a YAML configuration file gitlab_runners.[yml|yaml]. options: plugin: - description: The name of this plugin, it should always be set to 'gitlab_runners' for this plugin to recognize it as its own. + description: The name of this plugin, it should always be set to V(gitlab_runners) for this plugin to recognize it as its own. type: str required: true choices: diff --git a/plugins/inventory/lxd.py b/plugins/inventory/lxd.py index b1492d663c..efdca6563e 100644 --- a/plugins/inventory/lxd.py +++ b/plugins/inventory/lxd.py @@ -48,20 +48,19 @@ options: version_added: 8.0.0 server_check_hostname: description: - - This option controls if the server's hostname is checked as part of the HTTPS connection verification. - This can be useful to disable, if for example, the server certificate provided (see O(server_cert) option) - does not cover a name matching the one used to communicate with the server. Such mismatch is common as LXD - generates self-signed server certificates by default. + - This option controls if the server's hostname is checked as part of the HTTPS connection verification. This can be + useful to disable, if for example, the server certificate provided (see O(server_cert) option) does not cover a name + matching the one used to communicate with the server. Such mismatch is common as LXD generates self-signed server + certificates by default. type: bool default: true version_added: 8.0.0 trust_password: description: - The client trusted password. - - You need to set this password on the lxd server before - running this module using the following command - C(lxc config set core.trust_password ) - See U(https://documentation.ubuntu.com/lxd/en/latest/authentication/#adding-client-certificates-using-a-trust-password). + - You need to set this password on the lxd server before running this module using the following command C(lxc config + set core.trust_password ) See + U(https://documentation.ubuntu.com/lxd/en/latest/authentication/#adding-client-certificates-using-a-trust-password). - If O(trust_password) is set, this module send a request for authentication before sending any requests. type: str state: @@ -85,7 +84,7 @@ options: prefered_instance_network_interface: description: - If an instance has multiple network interfaces, select which one is the preferred as pattern. - - Combined with the first number that can be found e.g. 'eth' + 0. + - Combined with the first number that can be found, for example C(eth) + C(0). - The option has been renamed from O(prefered_container_network_interface) to O(prefered_instance_network_interface) in community.general 3.8.0. The old name still works as an alias. type: str @@ -101,7 +100,8 @@ options: choices: ['inet', 'inet6'] groupby: description: - - Create groups by the following keywords C(location), C(network_range), C(os), C(pattern), C(profile), C(release), C(type), C(vlanid). + - Create groups by the following keywords C(location), C(network_range), C(os), C(pattern), C(profile), C(release), + C(type), C(vlanid). - See example for syntax. type: dict """ diff --git a/plugins/inventory/nmap.py b/plugins/inventory/nmap.py index 502fbf2840..3339d66b46 100644 --- a/plugins/inventory/nmap.py +++ b/plugins/inventory/nmap.py @@ -64,14 +64,14 @@ options: default: true udp_scan: description: - - Scan via UDP. + - Scan using UDP. - Depending on your system you might need O(sudo=true) for this to work. type: boolean default: false version_added: 6.1.0 icmp_timestamp: description: - - Scan via ICMP Timestamp (C(-PP)). + - Scan using ICMP Timestamp (C(-PP)). - Depending on your system you might need O(sudo=true) for this to work. type: boolean default: false diff --git a/plugins/inventory/opennebula.py b/plugins/inventory/opennebula.py index b547d595eb..8ced301dd1 100644 --- a/plugins/inventory/opennebula.py +++ b/plugins/inventory/opennebula.py @@ -50,7 +50,7 @@ options: type: string api_authfile: description: - - If both O(api_username) or O(api_password) are not set, then it will try authenticate with ONE auth file. Default + - If both O(api_username) or O(api_password) are not set, then it tries to authenticate with ONE auth file. Default path is C(~/.one/one_auth). - Set environment variable E(ONE_AUTH) to override this path. env: diff --git a/plugins/inventory/scaleway.py b/plugins/inventory/scaleway.py index c258008e41..c730049833 100644 --- a/plugins/inventory/scaleway.py +++ b/plugins/inventory/scaleway.py @@ -44,7 +44,7 @@ options: oauth_token: description: - Scaleway OAuth token. - - If not explicitly defined or in environment variables, it will try to lookup in the scaleway-cli configuration file + - If not explicitly defined or in environment variables, it tries to lookup in the C(scaleway-cli) configuration file (C($SCW_CONFIG_PATH), C($XDG_CONFIG_HOME/scw/config.yaml), or C(~/.config/scw/config.yaml)). - More details on L(how to generate token, https://www.scaleway.com/en/docs/generate-api-keys/). type: string diff --git a/plugins/inventory/virtualbox.py b/plugins/inventory/virtualbox.py index dc28e76cc4..2eb52a617c 100644 --- a/plugins/inventory/virtualbox.py +++ b/plugins/inventory/virtualbox.py @@ -48,7 +48,7 @@ options: according to U(https://www.virtualbox.org/manual/UserManual.html#gui-vmgroups). Groups are now split using the V(,) character, and the V(/) character indicates nested groups. - When enabled, a VM that's been configured using V(VBoxManage modifyvm "vm01" --groups "/TestGroup/TestGroup2,/TestGroup3") - will result in the group C(TestGroup2) being a child group of C(TestGroup); and the VM being a part of C(TestGroup2) + results in the group C(TestGroup2) being a child group of C(TestGroup); and the VM being a part of C(TestGroup2) and C(TestGroup3). default: false type: bool diff --git a/plugins/inventory/xen_orchestra.py b/plugins/inventory/xen_orchestra.py index 3ad7767542..e6d828845a 100644 --- a/plugins/inventory/xen_orchestra.py +++ b/plugins/inventory/xen_orchestra.py @@ -31,7 +31,7 @@ options: description: - API host to XOA API. - If the value is not specified in the inventory configuration, the value of environment variable E(ANSIBLE_XO_HOST) - will be used instead. + is used instead. type: str env: - name: ANSIBLE_XO_HOST @@ -39,7 +39,7 @@ options: description: - Xen Orchestra user. - If the value is not specified in the inventory configuration, the value of environment variable E(ANSIBLE_XO_USER) - will be used instead. + is used instead. required: true type: str env: @@ -48,7 +48,7 @@ options: description: - Xen Orchestra password. - If the value is not specified in the inventory configuration, the value of environment variable E(ANSIBLE_XO_PASSWORD) - will be used instead. + is used instead. required: true type: str env: diff --git a/plugins/lookup/bitwarden.py b/plugins/lookup/bitwarden.py index 13bf43b0d4..7d65792b7f 100644 --- a/plugins/lookup/bitwarden.py +++ b/plugins/lookup/bitwarden.py @@ -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 diff --git a/plugins/lookup/cartesian.py b/plugins/lookup/cartesian.py index b41f7d8b5d..f2ad576907 100644 --- a/plugins/lookup/cartesian.py +++ b/plugins/lookup/cartesian.py @@ -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]. diff --git a/plugins/lookup/chef_databag.py b/plugins/lookup/chef_databag.py index f3302c6e31..8fe53744ee 100644 --- a/plugins/lookup/chef_databag.py +++ b/plugins/lookup/chef_databag.py @@ -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 diff --git a/plugins/lookup/collection_version.py b/plugins/lookup/collection_version.py index 2ed8a0c466..142c516df5 100644 --- a/plugins/lookup/collection_version.py +++ b/plugins/lookup/collection_version.py @@ -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 diff --git a/plugins/lookup/consul_kv.py b/plugins/lookup/consul_kv.py index 349b7f3db2..f57b3da891 100644 --- a/plugins/lookup/consul_kv.py +++ b/plugins/lookup/consul_kv.py @@ -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. diff --git a/plugins/lookup/credstash.py b/plugins/lookup/credstash.py index 4273aa184a..a170b13d03 100644 --- a/plugins/lookup/credstash.py +++ b/plugins/lookup/credstash.py @@ -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: diff --git a/plugins/lookup/cyberarkpassword.py b/plugins/lookup/cyberarkpassword.py index a3a1468049..63834dce9b 100644 --- a/plugins/lookup/cyberarkpassword.py +++ b/plugins/lookup/cyberarkpassword.py @@ -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""" diff --git a/plugins/lookup/dig.py b/plugins/lookup/dig.py index d958cf186f..07fc287d71 100644 --- a/plugins/lookup/dig.py +++ b/plugins/lookup/dig.py @@ -9,7 +9,7 @@ __metaclass__ = type DOCUMENTATION = r""" name: dig author: Jan-Piet Mens (@jpmens) -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. diff --git a/plugins/lookup/dnstxt.py b/plugins/lookup/dnstxt.py index eb24a63e99..fb0a5d5138 100644 --- a/plugins/lookup/dnstxt.py +++ b/plugins/lookup/dnstxt.py @@ -9,7 +9,7 @@ __metaclass__ = type DOCUMENTATION = r""" name: dnstxt author: Jan-Piet Mens (@jpmens) -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 diff --git a/plugins/lookup/etcd.py b/plugins/lookup/etcd.py index d8c708bfc8..d8d992e79f 100644 --- a/plugins/lookup/etcd.py +++ b/plugins/lookup/etcd.py @@ -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: diff --git a/plugins/lookup/filetree.py b/plugins/lookup/filetree.py index fd064cb4e6..24e0c20eea 100644 --- a/plugins/lookup/filetree.py +++ b/plugins/lookup/filetree.py @@ -9,11 +9,11 @@ __metaclass__ = type DOCUMENTATION = r""" name: filetree author: Dag Wieers (@dagwieers) -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: diff --git a/plugins/lookup/flattened.py b/plugins/lookup/flattened.py index 4b703458cc..de4a21fbdd 100644 --- a/plugins/lookup/flattened.py +++ b/plugins/lookup/flattened.py @@ -9,9 +9,9 @@ __metaclass__ = type DOCUMENTATION = r""" name: flattened author: Serge van Ginderachter (!UNKNOWN) -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). """ diff --git a/plugins/lookup/hiera.py b/plugins/lookup/hiera.py index 7aacad4e26..27f133d78a 100644 --- a/plugins/lookup/hiera.py +++ b/plugins/lookup/hiera.py @@ -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: diff --git a/plugins/lookup/keyring.py b/plugins/lookup/keyring.py index 2cbc2ea8c2..75d808e736 100644 --- a/plugins/lookup/keyring.py +++ b/plugins/lookup/keyring.py @@ -13,7 +13,7 @@ author: - Samuel Boucher (!UNKNOWN) 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. """ diff --git a/plugins/lookup/lastpass.py b/plugins/lookup/lastpass.py index 28b9af3466..2633848937 100644 --- a/plugins/lookup/lastpass.py +++ b/plugins/lookup/lastpass.py @@ -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: diff --git a/plugins/lookup/lmdb_kv.py b/plugins/lookup/lmdb_kv.py index d44aac55c3..b3728abb17 100644 --- a/plugins/lookup/lmdb_kv.py +++ b/plugins/lookup/lmdb_kv.py @@ -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: diff --git a/plugins/lookup/merge_variables.py b/plugins/lookup/merge_variables.py index f3f185a164..ffe76c3ea0 100644 --- a/plugins/lookup/merge_variables.py +++ b/plugins/lookup/merge_variables.py @@ -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 """ diff --git a/plugins/lookup/onepassword.py b/plugins/lookup/onepassword.py index d30234f14d..3dc589eaaf 100644 --- a/plugins/lookup/onepassword.py +++ b/plugins/lookup/onepassword.py @@ -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: diff --git a/plugins/lookup/passwordstore.py b/plugins/lookup/passwordstore.py index 54e89d6f8f..8f87e87034 100644 --- a/plugins/lookup/passwordstore.py +++ b/plugins/lookup/passwordstore.py @@ -11,7 +11,7 @@ DOCUMENTATION = r""" name: passwordstore author: - Patrick Deelman (!UNKNOWN) -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 diff --git a/plugins/lookup/random_pet.py b/plugins/lookup/random_pet.py index ff51fc8b31..8f9b3cbd00 100644 --- a/plugins/lookup/random_pet.py +++ b/plugins/lookup/random_pet.py @@ -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: diff --git a/plugins/lookup/random_string.py b/plugins/lookup/random_string.py index bd72916d92..4b227d3dca 100644 --- a/plugins/lookup/random_string.py +++ b/plugins/lookup/random_string.py @@ -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 diff --git a/plugins/lookup/redis.py b/plugins/lookup/redis.py index 3c8ff07a23..bb5a122da3 100644 --- a/plugins/lookup/redis.py +++ b/plugins/lookup/redis.py @@ -11,7 +11,7 @@ name: redis author: - Jan-Piet Mens (@jpmens) - 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: diff --git a/plugins/lookup/revbitspss.py b/plugins/lookup/revbitspss.py index c40140671d..6b31963f4a 100644 --- a/plugins/lookup/revbitspss.py +++ b/plugins/lookup/revbitspss.py @@ -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 """ diff --git a/plugins/lookup/shelvefile.py b/plugins/lookup/shelvefile.py index 4921e050a0..f4142f67c6 100644 --- a/plugins/lookup/shelvefile.py +++ b/plugins/lookup/shelvefile.py @@ -9,7 +9,7 @@ __metaclass__ = type DOCUMENTATION = r""" name: shelvefile author: Alejandro Guirao (!UNKNOWN) -short_description: read keys from Python shelve file +short_description: Read keys from Python shelve file description: - Read keys from Python shelve file. options: diff --git a/plugins/lookup/tss.py b/plugins/lookup/tss.py index 6a97d4b29c..3d73fcbe99 100644 --- a/plugins/lookup/tss.py +++ b/plugins/lookup/tss.py @@ -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