From 580ac1e30df27ff2b02344b9ecb550417804ef1f Mon Sep 17 00:00:00 2001 From: Alexei Znamensky <103110+russoz@users.noreply.github.com> Date: Wed, 2 Jul 2025 01:15:50 +1200 Subject: [PATCH] fix style in plugins (#10302) Co-authored-by: Felix Fontein --- plugins/become/doas.py | 2 +- plugins/become/ksu.py | 2 +- plugins/become/machinectl.py | 8 ++++---- plugins/become/run0.py | 2 +- plugins/cache/pickle.py | 2 +- plugins/cache/yaml.py | 2 +- plugins/callback/counter_enabled.py | 4 ++-- plugins/callback/dense.py | 2 +- plugins/callback/diy.py | 2 +- plugins/callback/jabber.py | 2 +- plugins/callback/log_plays.py | 2 +- plugins/callback/loganalytics.py | 2 +- plugins/callback/logdna.py | 2 +- plugins/callback/logentries.py | 2 +- plugins/callback/logstash.py | 2 +- plugins/callback/mail.py | 2 +- plugins/callback/opentelemetry.py | 4 ++-- plugins/callback/say.py | 2 +- plugins/callback/splunk.py | 2 +- plugins/callback/sumologic.py | 2 +- plugins/callback/syslog_json.py | 2 +- plugins/connection/incus.py | 2 +- plugins/connection/lxd.py | 2 +- plugins/connection/wsl.py | 10 +++++----- plugins/doc_fragments/alicloud.py | 16 ++++++++-------- plugins/doc_fragments/attributes.py | 4 ++-- plugins/doc_fragments/bitbucket.py | 8 ++++---- plugins/doc_fragments/dimensiondata.py | 6 +++--- plugins/doc_fragments/django.py | 4 ++-- plugins/doc_fragments/hwc.py | 2 +- plugins/doc_fragments/influxdb.py | 10 +++++----- plugins/doc_fragments/ipa.py | 26 +++++++++++++------------- plugins/doc_fragments/ldap.py | 14 +++++++------- plugins/doc_fragments/onepassword.py | 13 ++++++------- plugins/doc_fragments/oneview.py | 12 ++++++------ plugins/doc_fragments/openswitch.py | 13 ++++++------- plugins/doc_fragments/oracle.py | 6 +++--- plugins/doc_fragments/pipx.py | 8 ++++---- plugins/doc_fragments/redfish.py | 2 +- plugins/doc_fragments/redis.py | 2 +- plugins/doc_fragments/utm.py | 4 ++-- plugins/doc_fragments/xenserver.py | 9 ++++----- 42 files changed, 111 insertions(+), 114 deletions(-) diff --git a/plugins/become/doas.py b/plugins/become/doas.py index 13aef19874..b7b82a0f80 100644 --- a/plugins/become/doas.py +++ b/plugins/become/doas.py @@ -72,7 +72,7 @@ options: prompt_l10n: description: - List of localized strings to match for prompt detection. - - If empty we will use the built in one. + - If empty the plugin uses the built-in one. type: list elements: string default: [] diff --git a/plugins/become/ksu.py b/plugins/become/ksu.py index 1c936e46da..be56fd6128 100644 --- a/plugins/become/ksu.py +++ b/plugins/become/ksu.py @@ -73,7 +73,7 @@ options: prompt_l10n: description: - List of localized strings to match for prompt detection. - - If empty we will use the built in one. + - If empty the plugin uses the built-in one. type: list elements: string default: [] diff --git a/plugins/become/machinectl.py b/plugins/become/machinectl.py index 81a9d06f86..4f608939f1 100644 --- a/plugins/become/machinectl.py +++ b/plugins/become/machinectl.py @@ -71,10 +71,10 @@ options: - section: machinectl_become_plugin key: password notes: - - When not using this plugin with user V(root), it only works correctly with a polkit rule which will alter the behaviour - of machinectl. This rule must alter the prompt behaviour to ask directly for the user credentials, if the user is allowed - to perform the action (take a look at the examples section). If such a rule is not present the plugin only work if it - is used in context with the root user, because then no further prompt will be shown by machinectl. + - When not using this plugin with user V(root), it only works correctly with a polkit rule which alters the behaviour + of C(machinectl). This rule must alter the prompt behaviour to ask directly for the user credentials, if the user is allowed + to perform the action (take a look at the examples section). If such a rule is not present the plugin only works if it + is used in context with the root user, because then no further prompt is shown by C(machinectl). """ EXAMPLES = r""" diff --git a/plugins/become/run0.py b/plugins/become/run0.py index 39e4667e7a..dce7c22448 100644 --- a/plugins/become/run0.py +++ b/plugins/become/run0.py @@ -61,7 +61,7 @@ options: - name: ANSIBLE_RUN0_FLAGS type: string notes: - - This plugin will only work when a C(polkit) rule is in place. + - This plugin only works when a C(polkit) rule is in place. """ EXAMPLES = r""" diff --git a/plugins/cache/pickle.py b/plugins/cache/pickle.py index 7dae0f2d85..1e9ffcb264 100644 --- a/plugins/cache/pickle.py +++ b/plugins/cache/pickle.py @@ -17,7 +17,7 @@ options: _uri: required: true description: - - Path in which the cache plugin will save the files. + - Path in which the cache plugin saves the files. env: - name: ANSIBLE_CACHE_PLUGIN_CONNECTION ini: diff --git a/plugins/cache/yaml.py b/plugins/cache/yaml.py index 676423d3b6..8bf61f6898 100644 --- a/plugins/cache/yaml.py +++ b/plugins/cache/yaml.py @@ -17,7 +17,7 @@ options: _uri: required: true description: - - Path in which the cache plugin will save the files. + - Path in which the cache plugin saves the files. env: - name: ANSIBLE_CACHE_PLUGIN_CONNECTION ini: diff --git a/plugins/callback/counter_enabled.py b/plugins/callback/counter_enabled.py index 833a864ef3..2377d46585 100644 --- a/plugins/callback/counter_enabled.py +++ b/plugins/callback/counter_enabled.py @@ -15,8 +15,8 @@ type: stdout short_description: Adds counters to the output items (tasks and hosts/task) description: - Use this callback when you need a kind of progress bar on a large environments. - - You will know how many tasks has the playbook to run, and which one is actually running. - - You will know how many hosts may run a task, and which of them is actually running. + - You can see how many tasks has the playbook to run, and which one is actually running. + - You can see how many hosts may run a task, and which of them is actually running. extends_documentation_fragment: - default_callback requirements: diff --git a/plugins/callback/dense.py b/plugins/callback/dense.py index cc8952e774..1fd68b5d60 100644 --- a/plugins/callback/dense.py +++ b/plugins/callback/dense.py @@ -13,7 +13,7 @@ short_description: Minimal stdout output extends_documentation_fragment: - default_callback description: - - When in verbose mode it will act the same as the default callback. + - When in verbose mode it acts the same as the default callback. author: - Dag Wieers (@dagwieers) requirements: diff --git a/plugins/callback/diy.py b/plugins/callback/diy.py index 40f3347b49..f84789d010 100644 --- a/plugins/callback/diy.py +++ b/plugins/callback/diy.py @@ -23,7 +23,7 @@ notes: that is available using the other various execution contexts, such as playbook, play, task, and so on so forth. - Options being set by their respective variable input can only be set using the variable if the variable was set in a context that is available to the respective callback. Use the C(ansible_callback_diy) dictionary to see what is available to a - callback. Additionally, C(ansible_callback_diy.top_level_var_names) will output the top level variable names available + callback. Additionally, C(ansible_callback_diy.top_level_var_names) outputs the top level variable names available to the callback. - Each option value is rendered as a template before being evaluated. This allows for the dynamic usage of an option. For example, V("{{ 'yellow' if ansible_callback_diy.result.is_changed else 'bright green' }}"). diff --git a/plugins/callback/jabber.py b/plugins/callback/jabber.py index 29838ef4fd..c5a0881e14 100644 --- a/plugins/callback/jabber.py +++ b/plugins/callback/jabber.py @@ -36,7 +36,7 @@ options: env: - name: JABBER_PASS to: - description: Chat identifier that will receive the message. + description: Chat identifier that receives the message. type: str required: true env: diff --git a/plugins/callback/log_plays.py b/plugins/callback/log_plays.py index b89d1b03af..3de6c0bec0 100644 --- a/plugins/callback/log_plays.py +++ b/plugins/callback/log_plays.py @@ -19,7 +19,7 @@ requirements: options: log_folder: default: /var/log/ansible/hosts - description: The folder where log files will be created. + description: The folder where log files are created. type: str env: - name: ANSIBLE_LOG_FOLDER diff --git a/plugins/callback/loganalytics.py b/plugins/callback/loganalytics.py index bd3ca4018d..bd6b89fde1 100644 --- a/plugins/callback/loganalytics.py +++ b/plugins/callback/loganalytics.py @@ -11,7 +11,7 @@ type: notification short_description: Posts task results to Azure Log Analytics author: "Cyrus Li (@zhcli) " description: - - This callback plugin will post task results in JSON formatted to an Azure Log Analytics workspace. + - This callback plugin posts task results in JSON formatted to an Azure Log Analytics workspace. - Credits to authors of splunk callback plugin. version_added: "2.4.0" requirements: diff --git a/plugins/callback/logdna.py b/plugins/callback/logdna.py index 90fe6d4465..9ceb6547b2 100644 --- a/plugins/callback/logdna.py +++ b/plugins/callback/logdna.py @@ -11,7 +11,7 @@ name: logdna type: notification short_description: Sends playbook logs to LogDNA description: - - This callback will report logs from playbook actions, tasks, and events to LogDNA (U(https://app.logdna.com)). + - This callback reports logs from playbook actions, tasks, and events to LogDNA (U(https://app.logdna.com)). requirements: - LogDNA Python Library (U(https://github.com/logdna/python)) - whitelisting in configuration diff --git a/plugins/callback/logentries.py b/plugins/callback/logentries.py index bc5d7e03ce..796398d6b6 100644 --- a/plugins/callback/logentries.py +++ b/plugins/callback/logentries.py @@ -11,7 +11,7 @@ name: logentries type: notification short_description: Sends events to Logentries description: - - This callback plugin will generate JSON objects and send them to Logentries using TCP for auditing/debugging purposes. + - This callback plugin generates JSON objects and send them to Logentries using TCP for auditing/debugging purposes. requirements: - whitelisting in configuration - certifi (Python library) diff --git a/plugins/callback/logstash.py b/plugins/callback/logstash.py index 9d299e50ed..7025338bf5 100644 --- a/plugins/callback/logstash.py +++ b/plugins/callback/logstash.py @@ -12,7 +12,7 @@ name: logstash type: notification short_description: Sends events to Logstash description: - - This callback will report facts and task events to Logstash U(https://www.elastic.co/products/logstash). + - This callback reports facts and task events to Logstash U(https://www.elastic.co/products/logstash). requirements: - whitelisting in configuration - logstash (Python library) diff --git a/plugins/callback/mail.py b/plugins/callback/mail.py index eb88e4dcb6..d05982cd61 100644 --- a/plugins/callback/mail.py +++ b/plugins/callback/mail.py @@ -11,7 +11,7 @@ name: mail type: notification short_description: Sends failure events through email description: - - This callback will report failures through email. + - This callback reports failures through email. author: - Dag Wieers (@dagwieers) requirements: diff --git a/plugins/callback/opentelemetry.py b/plugins/callback/opentelemetry.py index c46234b724..80f24924b9 100644 --- a/plugins/callback/opentelemetry.py +++ b/plugins/callback/opentelemetry.py @@ -35,8 +35,8 @@ options: - Whether to enable this callback only if the given environment variable exists and it is set to V(true). - This is handy when you use Configuration as Code and want to send distributed traces if running in the CI rather when running Ansible locally. - - For such, it evaluates the given O(enable_from_environment) value as environment variable and if set to true this - plugin will be enabled. + - For such, it evaluates the given O(enable_from_environment) value as environment variable and if set to V(true) this + plugin is enabled. env: - name: ANSIBLE_OPENTELEMETRY_ENABLE_FROM_ENVIRONMENT ini: diff --git a/plugins/callback/say.py b/plugins/callback/say.py index a5b82cb148..8a4e93f353 100644 --- a/plugins/callback/say.py +++ b/plugins/callback/say.py @@ -16,7 +16,7 @@ requirements: - the C(/usr/bin/say) command line program (standard on macOS) or C(espeak) command line program short_description: Notify using software speech synthesizer description: - - This plugin will use the C(say) or C(espeak) program to "speak" about play events. + - This plugin uses C(say) or C(espeak) to "speak" about play events. """ import platform diff --git a/plugins/callback/splunk.py b/plugins/callback/splunk.py index 1870bfc1d0..c385050d67 100644 --- a/plugins/callback/splunk.py +++ b/plugins/callback/splunk.py @@ -11,7 +11,7 @@ type: notification short_description: Sends task result events to Splunk HTTP Event Collector author: "Stuart Hirst (!UNKNOWN) " description: - - This callback plugin will send task results as JSON formatted events to a Splunk HTTP collector. + - This callback plugin sends task results as JSON formatted events to a Splunk HTTP collector. - The companion Splunk Monitoring & Diagnostics App is available here U(https://splunkbase.splunk.com/app/4023/). - Credit to "Ryan Currah (@ryancurrah)" for original source upon which this is based. requirements: diff --git a/plugins/callback/sumologic.py b/plugins/callback/sumologic.py index c12c852db9..7a762c30e8 100644 --- a/plugins/callback/sumologic.py +++ b/plugins/callback/sumologic.py @@ -11,7 +11,7 @@ type: notification short_description: Sends task result events to Sumologic author: "Ryan Currah (@ryancurrah)" description: - - This callback plugin will send task results as JSON formatted events to a Sumologic HTTP collector source. + - This callback plugin sends task results as JSON formatted events to a Sumologic HTTP collector source. requirements: - Whitelisting this callback plugin - 'Create a HTTP collector source in Sumologic and specify a custom timestamp format of V(yyyy-MM-dd HH:mm:ss ZZZZ) and diff --git a/plugins/callback/syslog_json.py b/plugins/callback/syslog_json.py index e4b50bbc32..cab3973be1 100644 --- a/plugins/callback/syslog_json.py +++ b/plugins/callback/syslog_json.py @@ -17,7 +17,7 @@ description: - This plugin logs ansible-playbook and ansible runs to a syslog server in JSON format. options: server: - description: Syslog server that will receive the event. + description: Syslog server that receives the event. type: str env: - name: SYSLOG_SERVER diff --git a/plugins/connection/incus.py b/plugins/connection/incus.py index 842ad8f924..62a958b504 100644 --- a/plugins/connection/incus.py +++ b/plugins/connection/incus.py @@ -52,7 +52,7 @@ options: remote_user: description: - User to login/authenticate as. - - Can be set from the CLI via the C(--user) or C(-u) options. + - Can be set from the CLI with the C(--user) or C(-u) options. type: string default: root vars: diff --git a/plugins/connection/lxd.py b/plugins/connection/lxd.py index 2670ed1b5f..2cc774a1d4 100644 --- a/plugins/connection/lxd.py +++ b/plugins/connection/lxd.py @@ -52,7 +52,7 @@ options: remote_user: description: - User to login/authenticate as. - - Can be set from the CLI via the C(--user) or C(-u) options. + - Can be set from the CLI with the C(--user) or C(-u) options. type: string default: root vars: diff --git a/plugins/connection/wsl.py b/plugins/connection/wsl.py index 24e47ecae5..1d26cefa18 100644 --- a/plugins/connection/wsl.py +++ b/plugins/connection/wsl.py @@ -11,11 +11,11 @@ from __future__ import annotations DOCUMENTATION = r""" author: Rui Lopes (@rgl) name: wsl -short_description: Run tasks in WSL distribution using wsl.exe CLI via SSH +short_description: Run tasks in WSL distribution using wsl.exe CLI using SSH requirements: - paramiko description: - - Run commands or put/fetch files to an existing WSL distribution using wsl.exe CLI via SSH. + - Run commands or put/fetch files to an existing WSL distribution using wsl.exe CLI using SSH. - Uses the Python SSH implementation (Paramiko) to connect to the WSL host. version_added: "10.6.0" options: @@ -50,7 +50,7 @@ options: remote_user: description: - User to login/authenticate as. - - Can be set from the CLI via the C(--user) or C(-u) options. + - Can be set from the CLI with the C(--user) or C(-u) options. type: string vars: - name: ansible_user @@ -69,7 +69,7 @@ options: password: description: - Secret used to either login the SSH server or as a passphrase for SSH keys that require it. - - Can be set from the CLI via the C(--ask-pass) option. + - Can be set from the CLI with the C(--ask-pass) option. type: string vars: - name: ansible_password @@ -109,7 +109,7 @@ options: proxy_command: default: "" description: - - Proxy information for running the connection via a jumphost. + - Proxy information for running the connection through a jumphost. - This option is supported by paramiko version 1.9.0 or newer. type: string env: diff --git a/plugins/doc_fragments/alicloud.py b/plugins/doc_fragments/alicloud.py index 3b810852b7..cf7255b465 100644 --- a/plugins/doc_fragments/alicloud.py +++ b/plugins/doc_fragments/alicloud.py @@ -16,31 +16,31 @@ options: alicloud_access_key: description: - Alibaba Cloud access key. If not set then the value of environment variable E(ALICLOUD_ACCESS_KEY), E(ALICLOUD_ACCESS_KEY_ID) - will be used instead. + is used instead. aliases: ['access_key_id', 'access_key'] type: str alicloud_secret_key: description: - Alibaba Cloud secret key. If not set then the value of environment variable E(ALICLOUD_SECRET_KEY), E(ALICLOUD_SECRET_ACCESS_KEY) - will be used instead. + is used instead. aliases: ['secret_access_key', 'secret_key'] type: str alicloud_region: description: - The Alibaba Cloud region to use. If not specified then the value of environment variable E(ALICLOUD_REGION), E(ALICLOUD_REGION_ID) - will be used instead. + is used instead. aliases: ['region', 'region_id'] required: true type: str alicloud_security_token: description: - The Alibaba Cloud security token. If not specified then the value of environment variable E(ALICLOUD_SECURITY_TOKEN) - will be used instead. + is used instead. aliases: ['security_token'] type: str alicloud_assume_role: description: - - If provided with a role ARN, Ansible will attempt to assume this role using the supplied credentials. + - If provided with a role ARN, Ansible attempts to assume this role using the supplied credentials. - The nested assume_role block supports C(alicloud_assume_role_arn), C(alicloud_assume_role_session_name), C(alicloud_assume_role_session_expiration) and C(alicloud_assume_role_policy). type: dict @@ -48,7 +48,7 @@ options: alicloud_assume_role_arn: description: - The Alibaba Cloud C(role_arn). The ARN of the role to assume. If ARN is set to an empty string, it does not perform - role switching. It supports environment variable E(ALICLOUD_ASSUME_ROLE_ARN). ansible will execute with provided credentials. + role switching. It supports environment variable E(ALICLOUD_ASSUME_ROLE_ARN). Ansible executes with provided credentials. aliases: ['assume_role_arn'] type: str alicloud_assume_role_session_name: @@ -68,7 +68,7 @@ options: description: - The RAM Role Name attached on a ECS instance for API operations. You can retrieve this from the 'Access Control' section of the Alibaba Cloud console. - - If you are running Ansible from an ECS instance with RAM Instance using RAM Role, Ansible will just access the metadata + - If you are running Ansible from an ECS instance with RAM Instance using RAM Role, Ansible just accesses the metadata U(http://100.100.100.200/latest/meta-data/ram/security-credentials/) to obtain the STS credential. This is a preferred approach over any other when running in ECS as you can avoid hard coding credentials. Instead these are leased on-the-fly by Ansible which reduces the chance of leakage. @@ -83,7 +83,7 @@ options: description: - This is the path to the shared credentials file. It can also be sourced from the E(ALICLOUD_SHARED_CREDENTIALS_FILE) environment variable. - - If this is not set and a profile is specified, C(~/.aliyun/config.json) will be used. + - If this is not set and a profile is specified, C(~/.aliyun/config.json) is used. type: str author: - "He Guimin (@xiaozhu36)" diff --git a/plugins/doc_fragments/attributes.py b/plugins/doc_fragments/attributes.py index d6cc2b8c25..18b02575c4 100644 --- a/plugins/doc_fragments/attributes.py +++ b/plugins/doc_fragments/attributes.py @@ -17,7 +17,7 @@ attributes: check_mode: description: Can run in C(check_mode) and return changed status prediction without modifying target. diff_mode: - description: Will return details on what has changed (or possibly needs changing in C(check_mode)), when in diff mode. + description: Returns details on what has changed (or possibly needs changing in C(check_mode)), when in diff mode. """ PLATFORM = r""" @@ -57,7 +57,7 @@ attributes: options: {} attributes: facts: - description: Action returns an C(ansible_facts) dictionary that will update existing host facts. + description: Action returns an C(ansible_facts) dictionary that updates existing host facts. """ # Should be used together with the standard fragment and the FACTS fragment diff --git a/plugins/doc_fragments/bitbucket.py b/plugins/doc_fragments/bitbucket.py index e8b9ea4df8..65c4c47b51 100644 --- a/plugins/doc_fragments/bitbucket.py +++ b/plugins/doc_fragments/bitbucket.py @@ -16,17 +16,17 @@ options: client_id: description: - The OAuth consumer key. - - If not set the environment variable E(BITBUCKET_CLIENT_ID) will be used. + - If not set the environment variable E(BITBUCKET_CLIENT_ID) is used. type: str client_secret: description: - The OAuth consumer secret. - - If not set the environment variable E(BITBUCKET_CLIENT_SECRET) will be used. + - If not set the environment variable E(BITBUCKET_CLIENT_SECRET) is used. type: str user: description: - The username. - - If not set the environment variable E(BITBUCKET_USERNAME) will be used. + - If not set the environment variable E(BITBUCKET_USERNAME) is used. - O(ignore:username) is an alias of O(user) since community.general 6.0.0. It was an alias of O(workspace) before. type: str version_added: 4.0.0 @@ -34,7 +34,7 @@ options: password: description: - The App password. - - If not set the environment variable E(BITBUCKET_PASSWORD) will be used. + - If not set the environment variable E(BITBUCKET_PASSWORD) is used. type: str version_added: 4.0.0 notes: diff --git a/plugins/doc_fragments/dimensiondata.py b/plugins/doc_fragments/dimensiondata.py index ece97addf0..890c4d741e 100644 --- a/plugins/doc_fragments/dimensiondata.py +++ b/plugins/doc_fragments/dimensiondata.py @@ -28,12 +28,12 @@ options: mcp_user: description: - The username used to authenticate to the CloudControl API. - - If not specified, will fall back to E(MCP_USER) from environment variable or C(~/.dimensiondata). + - If not specified, falls back to E(MCP_USER) from environment variable or C(~/.dimensiondata). type: str mcp_password: description: - The password used to authenticate to the CloudControl API. - - If not specified, will fall back to E(MCP_PASSWORD) from environment variable or C(~/.dimensiondata). + - If not specified, falls back to E(MCP_PASSWORD) from environment variable or C(~/.dimensiondata). - Required if O(mcp_user) is specified. type: str location: @@ -43,7 +43,7 @@ options: required: true validate_certs: description: - - If V(false), SSL certificates will not be validated. + - If V(false), SSL certificates are not validated. - This should only be used on private instances of the CloudControl API that use self-signed certificates. type: bool default: true diff --git a/plugins/doc_fragments/django.py b/plugins/doc_fragments/django.py index 3dcdb40171..5d01c8323e 100644 --- a/plugins/doc_fragments/django.py +++ b/plugins/doc_fragments/django.py @@ -18,13 +18,13 @@ options: settings: description: - Specifies the settings module to use. - - The value will be passed as is to the C(--settings) argument in C(django-admin). + - The value is passed as is to the C(--settings) argument in C(django-admin). type: str required: true pythonpath: description: - Adds the given filesystem path to the Python import search path. - - The value will be passed as is to the C(--pythonpath) argument in C(django-admin). + - The value is passed as is to the C(--pythonpath) argument in C(django-admin). type: path traceback: description: diff --git a/plugins/doc_fragments/hwc.py b/plugins/doc_fragments/hwc.py index 3d478beb59..ea54c80c09 100644 --- a/plugins/doc_fragments/hwc.py +++ b/plugins/doc_fragments/hwc.py @@ -55,5 +55,5 @@ notes: - For authentication, you can set domain using the E(ANSIBLE_HWC_DOMAIN) environment variable. - For authentication, you can set project using the E(ANSIBLE_HWC_PROJECT) environment variable. - For authentication, you can set region using the E(ANSIBLE_HWC_REGION) environment variable. - - Environment variables values will only be used if the playbook values are not set. + - Environment variables values are only used when the playbook values are not set. """ diff --git a/plugins/doc_fragments/influxdb.py b/plugins/doc_fragments/influxdb.py index 9cf47d340a..5dbebea846 100644 --- a/plugins/doc_fragments/influxdb.py +++ b/plugins/doc_fragments/influxdb.py @@ -20,13 +20,13 @@ options: default: localhost username: description: - - Username that will be used to authenticate against InfluxDB server. + - Username that is used to authenticate against InfluxDB server. type: str default: root aliases: [login_username] password: description: - - Password that will be used to authenticate against InfluxDB server. + - Password that is used to authenticate against InfluxDB server. type: str default: root aliases: [login_password] @@ -44,7 +44,7 @@ options: version_added: '0.2.0' validate_certs: description: - - If set to V(false), the SSL certificates will not be validated. + - If set to V(false), the SSL certificates are not validated. - This should only set to V(false) used on personally controlled sites using self-signed certificates. type: bool default: true @@ -55,11 +55,11 @@ options: default: false timeout: description: - - Number of seconds Requests will wait for client to establish a connection. + - Number of seconds Requests waits for client to establish a connection. type: int retries: description: - - Number of retries client will try before aborting. + - Number of retries client performs before aborting. - V(0) indicates try until success. - Only available when using C(python-influxdb) >= 4.1.0. type: int diff --git a/plugins/doc_fragments/ipa.py b/plugins/doc_fragments/ipa.py index 0edb947aa5..63ea94b465 100644 --- a/plugins/doc_fragments/ipa.py +++ b/plugins/doc_fragments/ipa.py @@ -16,43 +16,43 @@ options: ipa_port: description: - Port of FreeIPA / IPA server. - - If the value is not specified in the task, the value of environment variable E(IPA_PORT) will be used instead. + - If the value is not specified in the task, the value of environment variable E(IPA_PORT) is used instead. - If both the environment variable E(IPA_PORT) and the value are not specified in the task, then default value is set. type: int default: 443 ipa_host: description: - IP or hostname of IPA server. - - If the value is not specified in the task, the value of environment variable E(IPA_HOST) will be used instead. - - If both the environment variable E(IPA_HOST) and the value are not specified in the task, then DNS will be used to - try to discover the FreeIPA server. + - If the value is not specified in the task, the value of environment variable E(IPA_HOST) is used instead. + - If both the environment variable E(IPA_HOST) and the value are not specified in the task, then DNS is used to try + to discover the FreeIPA server. - The relevant entry needed in FreeIPA is the C(ipa-ca) entry. - If neither the DNS entry, nor the environment E(IPA_HOST), nor the value are available in the task, then the default - value will be used. + value is used. type: str default: ipa.example.com ipa_user: description: - Administrative account used on IPA server. - - If the value is not specified in the task, the value of environment variable E(IPA_USER) will be used instead. + - If the value is not specified in the task, the value of environment variable E(IPA_USER) is used instead. - If both the environment variable E(IPA_USER) and the value are not specified in the task, then default value is set. type: str default: admin ipa_pass: description: - Password of administrative user. - - If the value is not specified in the task, the value of environment variable E(IPA_PASS) will be used instead. + - If the value is not specified in the task, the value of environment variable E(IPA_PASS) is used instead. - Note that if the C(urllib_gssapi) library is available, it is possible to use GSSAPI to authenticate to FreeIPA. - - If the environment variable E(KRB5CCNAME) is available, the module will use this kerberos credentials cache to authenticate + - If the environment variable E(KRB5CCNAME) is available, the module uses this Kerberos credentials cache to authenticate to the FreeIPA server. - - If the environment variable E(KRB5_CLIENT_KTNAME) is available, and E(KRB5CCNAME) is not; the module will use this - kerberos keytab to authenticate. + - If the environment variable E(KRB5_CLIENT_KTNAME) is available, and E(KRB5CCNAME) is not; the module uses this Kerberos + keytab to authenticate. - If GSSAPI is not available, the usage of O(ipa_pass) is required. type: str ipa_prot: description: - Protocol used by IPA server. - - If the value is not specified in the task, the value of environment variable E(IPA_PROT) will be used instead. + - If the value is not specified in the task, the value of environment variable E(IPA_PROT) is used instead. - If both the environment variable E(IPA_PROT) and the value are not specified in the task, then default value is set. type: str choices: [http, https] @@ -60,7 +60,7 @@ options: validate_certs: description: - This only applies if O(ipa_prot) is V(https). - - If set to V(false), the SSL certificates will not be validated. + - If set to V(false), the SSL certificates are not validated. - This should only set to V(false) used on personally controlled sites using self-signed certificates. type: bool default: true @@ -68,7 +68,7 @@ options: description: - Specifies idle timeout (in seconds) for the connection. - For bulk operations, you may want to increase this in order to avoid timeout from IPA server. - - If the value is not specified in the task, the value of environment variable E(IPA_TIMEOUT) will be used instead. + - If the value is not specified in the task, the value of environment variable E(IPA_TIMEOUT) is used instead. - If both the environment variable E(IPA_TIMEOUT) and the value are not specified in the task, then default value is set. type: int diff --git a/plugins/doc_fragments/ldap.py b/plugins/doc_fragments/ldap.py index 4dd5fd097f..abdb32adb7 100644 --- a/plugins/doc_fragments/ldap.py +++ b/plugins/doc_fragments/ldap.py @@ -14,9 +14,9 @@ class ModuleDocFragment(object): # Standard LDAP documentation fragment DOCUMENTATION = r""" notes: - - The default authentication settings will attempt to use a SASL EXTERNAL bind over a UNIX domain socket. This works well - with the default Ubuntu install for example, which includes a C(cn=peercred,cn=external,cn=auth) ACL rule allowing root - to modify the server configuration. If you need to use a simple bind to access your server, pass the credentials in O(bind_dn) + - The default authentication settings attempts to use a SASL EXTERNAL bind over a UNIX domain socket. This works well with + the default Ubuntu install for example, which includes a C(cn=peercred,cn=external,cn=auth) ACL rule allowing root to + modify the server configuration. If you need to use a simple bind to access your server, pass the credentials in O(bind_dn) and O(bind_pw). options: bind_dn: @@ -76,7 +76,7 @@ options: default: false validate_certs: description: - - If set to V(false), SSL certificates will not be validated. + - If set to V(false), SSL certificates are not validated. - This should only be used on sites using self-signed certificates. type: bool default: true @@ -90,9 +90,9 @@ options: xorder_discovery: description: - Set the behavior on how to process Xordered DNs. - - V(enable) will perform a C(ONELEVEL) search below the superior RDN to find the matching DN. - - V(disable) will always use the DN unmodified (as passed by the O(dn) parameter). - - V(auto) will only perform a search if the first RDN does not contain an index number (C({x})). + - V(enable) performs a C(ONELEVEL) search below the superior RDN to find the matching DN. + - V(disable) always uses the DN unmodified (as passed by the O(dn) parameter). + - V(auto) only performs a search if the first RDN does not contain an index number (C({x})). type: str choices: ['enable', 'auto', 'disable'] default: auto diff --git a/plugins/doc_fragments/onepassword.py b/plugins/doc_fragments/onepassword.py index a67c9e4dc1..6fb0e252c6 100644 --- a/plugins/doc_fragments/onepassword.py +++ b/plugins/doc_fragments/onepassword.py @@ -18,8 +18,8 @@ options: aliases: ['vault_password'] type: str section: - description: Item section containing the field to retrieve (case-insensitive). If absent will return first match from - any section. + description: Item section containing the field to retrieve (case-insensitive). If absent, returns first match from any + section. domain: description: Domain of 1Password. default: '1password.com' @@ -42,7 +42,7 @@ options: - Only works with 1Password CLI version 2 or later. type: str vault: - description: Vault containing the item to retrieve (case-insensitive). If absent will search all vaults. + description: Vault containing the item to retrieve (case-insensitive). If absent, searches all vaults. type: str connect_host: description: The host for 1Password Connect. Must be used in combination with O(connect_token). @@ -65,10 +65,9 @@ options: - name: OP_SERVICE_ACCOUNT_TOKEN version_added: 8.2.0 notes: - - This lookup will use an existing 1Password session if one exists. If not, and you have already performed an initial sign - in (meaning C(~/.op/config), C(~/.config/op/config) or C(~/.config/.op/config) exists), then only the O(master_password) - is required. You may optionally specify O(subdomain) in this scenario, otherwise the last used subdomain will be used - by C(op). + - This lookup uses an existing 1Password session if one exists. If not, and you have already performed an initial sign in + (meaning C(~/.op/config), C(~/.config/op/config) or C(~/.config/.op/config) exists), then only the O(master_password) + is required. You may optionally specify O(subdomain) in this scenario, otherwise the last used subdomain is used by C(op). - This lookup can perform an initial login by providing O(subdomain), O(username), O(secret_key), and O(master_password). - Can target a specific account by providing the O(account_id). - Due to the B(very) sensitive nature of these credentials, it is B(highly) recommended that you only pass in the minimal diff --git a/plugins/doc_fragments/oneview.py b/plugins/doc_fragments/oneview.py index 3caabe4512..366e3e3e42 100644 --- a/plugins/doc_fragments/oneview.py +++ b/plugins/doc_fragments/oneview.py @@ -17,8 +17,8 @@ options: description: - Path to a JSON configuration file containing the OneView client configuration. The configuration file is optional and when used should be present in the host running the ansible commands. If the file path is not provided, the configuration - will be loaded from environment variables. For links to example configuration files or how to use the environment - variables verify the notes section. + is loaded from environment variables. For links to example configuration files or how to use the environment variables + verify the notes section. type: path api_version: description: @@ -49,16 +49,16 @@ notes: U(https://github.com/HewlettPackard/oneview-ansible/blob/master/examples/oneview_config-rename.json).' - 'Check how to use environment variables for configuration at: U(https://github.com/HewlettPackard/oneview-ansible#environment-variables).' - 'Additional Playbooks for the HPE OneView Ansible modules can be found at: U(https://github.com/HewlettPackard/oneview-ansible/tree/master/examples).' - - 'The OneView API version used will directly affect returned and expected fields in resources. Information on setting the - desired API version and can be found at: U(https://github.com/HewlettPackard/oneview-ansible#setting-your-oneview-version).' + - 'The OneView API version used directly affects returned and expected fields in resources. Information on setting the desired + API version and can be found at: U(https://github.com/HewlettPackard/oneview-ansible#setting-your-oneview-version).' """ VALIDATEETAG = r""" options: validate_etag: description: - - When the ETag Validation is enabled, the request will be conditionally processed only if the current ETag for the - resource matches the ETag provided in the data. + - When the ETag Validation is enabled, the request is conditionally processed only if the current ETag for the resource + matches the ETag provided in the data. type: bool default: true """ diff --git a/plugins/doc_fragments/openswitch.py b/plugins/doc_fragments/openswitch.py index f0e9e87c3d..30b477fbe7 100644 --- a/plugins/doc_fragments/openswitch.py +++ b/plugins/doc_fragments/openswitch.py @@ -21,8 +21,8 @@ options: port: description: - Specifies the port to use when building the connection to the remote device. This value applies to either O(transport=cli) - or O(transport=rest). The port value will default to the appropriate transport common port if none is provided in - the task. (cli=22, http=80, https=443). Note this argument does not affect the SSH transport. + or O(transport=rest). The port value defaults to the appropriate transport common port if none is provided in the + task. (cli=22, http=80, https=443). Note this argument does not affect the SSH transport. type: int default: 0 (use common port) username: @@ -30,25 +30,24 @@ options: - Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the eAPI authentication depending on which transport is used. Note this argument does not affect the SSH transport. If the value is not specified in the task, the value of environment variable E(ANSIBLE_NET_USERNAME) - will be used instead. + is used instead. type: str password: description: - Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either O(transport=cli) or O(transport=rest). Note this argument does not affect the SSH transport. If the value - is not specified in the task, the value of environment variable E(ANSIBLE_NET_PASSWORD) will be used instead. + is not specified in the task, the value of environment variable E(ANSIBLE_NET_PASSWORD) is used instead. type: str timeout: description: - Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. - If the timeout is exceeded before the operation is completed, the module will error. + If the timeout is exceeded before the operation is completed, the module fails. type: int default: 10 ssh_keyfile: description: - Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for O(transport=cli). - If the value is not specified in the task, the value of environment variable E(ANSIBLE_NET_SSH_KEYFILE) will be used - instead. + If the value is not specified in the task, the value of environment variable E(ANSIBLE_NET_SSH_KEYFILE) is used instead. type: path transport: description: diff --git a/plugins/doc_fragments/oracle.py b/plugins/doc_fragments/oracle.py index 702b77f02f..08b2948bf3 100644 --- a/plugins/doc_fragments/oracle.py +++ b/plugins/doc_fragments/oracle.py @@ -54,9 +54,9 @@ options: auth_type: description: - The type of authentication to use for making API requests. By default O(auth_type=api_key) based authentication is - performed and the API key (see O(api_user_key_file)) in your config file will be used. If this 'auth_type' module - option is not specified, the value of the E(OCI_ANSIBLE_AUTH_TYPE), if any, is used. Use O(auth_type=instance_principal) - to use instance principal based authentication when running ansible playbooks within an OCI compute instance. + performed and the API key (see O(api_user_key_file)) in your config file is used. If O(auth_type) is not specified, + the value of the E(OCI_ANSIBLE_AUTH_TYPE), if any, is used. Use O(auth_type=instance_principal) to use instance principal + based authentication when running ansible playbooks within an OCI compute instance. choices: ['api_key', 'instance_principal'] default: 'api_key' type: str diff --git a/plugins/doc_fragments/pipx.py b/plugins/doc_fragments/pipx.py index aff8e90c75..dde13f6dd3 100644 --- a/plugins/doc_fragments/pipx.py +++ b/plugins/doc_fragments/pipx.py @@ -13,13 +13,13 @@ class ModuleDocFragment(object): options: global: description: - - The module will pass the C(--global) argument to C(pipx), to execute actions in global scope. + - The module passes the C(--global) argument to C(pipx), to execute actions in global scope. type: bool default: false executable: description: - Path to the C(pipx) installed in the system. - - If not specified, the module will use C(python -m pipx) to run the tool, using the same Python interpreter as ansible + - If not specified, the module uses C(python -m pipx) to run the tool, using the same Python interpreter as ansible itself. type: path requirements: @@ -27,8 +27,8 @@ requirements: notes: - This module does not install the C(pipx) python package, however that can be easily done with the module M(ansible.builtin.pip). - This module does not require C(pipx) to be in the shell C(PATH), but it must be loadable by Python as a module. - - This module will honor C(pipx) environment variables such as but not limited to E(PIPX_HOME) and E(PIPX_BIN_DIR) passed - using the R(environment Ansible keyword, playbooks_environment). + - This module honors C(pipx) environment variables such as but not limited to E(PIPX_HOME) and E(PIPX_BIN_DIR) passed using + the R(environment Ansible keyword, playbooks_environment). seealso: - name: C(pipx) command manual page description: Manual page for the command. diff --git a/plugins/doc_fragments/redfish.py b/plugins/doc_fragments/redfish.py index f2e6b37485..a20e064988 100644 --- a/plugins/doc_fragments/redfish.py +++ b/plugins/doc_fragments/redfish.py @@ -15,7 +15,7 @@ class ModuleDocFragment(object): options: validate_certs: description: - - If V(false), TLS/SSL certificates will not be validated. + - If V(false), TLS/SSL certificates are not validated. - Set this to V(true) to enable certificate checking. Should be used together with O(ca_path). type: bool default: false diff --git a/plugins/doc_fragments/redis.py b/plugins/doc_fragments/redis.py index 149c018d79..c7bb88b81d 100644 --- a/plugins/doc_fragments/redis.py +++ b/plugins/doc_fragments/redis.py @@ -45,7 +45,7 @@ options: default: true ca_certs: description: - - Path to root certificates file. If not set and O(tls) is set to V(true), certifi ca-certificates will be used. + - Path to root certificates file. If not set and O(tls) is set to V(true), certifi's CA certificates are used. type: str client_cert_file: description: diff --git a/plugins/doc_fragments/utm.py b/plugins/doc_fragments/utm.py index 3b2118485e..32c18e93b8 100644 --- a/plugins/doc_fragments/utm.py +++ b/plugins/doc_fragments/utm.py @@ -49,8 +49,8 @@ options: state: description: - The desired state of the object. - - V(present) will create or update an object. - - V(absent) will delete an object if it was present. + - V(present) creates or updates an object. + - V(absent) deletes an object if present. type: str choices: [absent, present] default: present diff --git a/plugins/doc_fragments/xenserver.py b/plugins/doc_fragments/xenserver.py index d1377e8964..f4e0946219 100644 --- a/plugins/doc_fragments/xenserver.py +++ b/plugins/doc_fragments/xenserver.py @@ -15,28 +15,27 @@ options: hostname: description: - The hostname or IP address of the XenServer host or XenServer pool master. - - If the value is not specified in the task, the value of environment variable E(XENSERVER_HOST) will be used instead. + - If the value is not specified in the task, the value of environment variable E(XENSERVER_HOST) is used instead. type: str default: localhost aliases: [host, pool] username: description: - The username to use for connecting to XenServer. - - If the value is not specified in the task, the value of environment variable E(XENSERVER_USER) will be used instead. + - If the value is not specified in the task, the value of environment variable E(XENSERVER_USER) is used instead. type: str default: root aliases: [admin, user] password: description: - The password to use for connecting to XenServer. - - If the value is not specified in the task, the value of environment variable E(XENSERVER_PASSWORD) will be used instead. + - If the value is not specified in the task, the value of environment variable E(XENSERVER_PASSWORD) is used instead. type: str aliases: [pass, pwd] validate_certs: description: - Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted. - - If the value is not specified in the task, the value of environment variable E(XENSERVER_VALIDATE_CERTS) will be used - instead. + - If the value is not specified in the task, the value of environment variable E(XENSERVER_VALIDATE_CERTS) is used instead. type: bool default: true """