[PR #10302/580ac1e3 backport][stable-11] fix style in plugins (#10325)
Some checks are pending
EOL CI / EOL Sanity (Ⓐ2.16) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py2.7) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py3.11) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py3.6) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/3/) (push) Waiting to run
nox / Run extra sanity tests (push) Waiting to run

fix style in plugins (#10302)


(cherry picked from commit 580ac1e30d)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
patchback[bot] 2025-07-01 22:58:46 +02:00 committed by GitHub
commit da3874c96d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
42 changed files with 111 additions and 114 deletions

View file

@ -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/<ecs_role_name>) 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)"

View file

@ -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

View file

@ -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:

View file

@ -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

View file

@ -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:

View file

@ -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.
"""

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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
"""

View file

@ -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:

View file

@ -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

View file

@ -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.

View file

@ -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

View file

@ -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:

View file

@ -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

View file

@ -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
"""