a-c-m
/
community.general
mirror of https://github.com/ansible-collections/community.general.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[PR #9534/aac71990 backport][stable-10] (abc*, doc frags): style adjustments (#9541) 

(abc*, doc frags): style adjustments (#9534)

(cherry picked from commit aac7199087)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
pull/9543/head
patchback[bot] 2025-01-06 22:01:09 +01:00 committed by GitHub
parent 80f43bbbf5
commit 26b8f30afa
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
28 changed files with 215 additions and 209 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
plugins/doc_fragments/clc.py
View File

@ -21,8 +21,8 @@ notes:
- E(CLC_V2_API_USERNAME), the account login ID for the Centurylink Cloud.
- E(CLC_V2_API_PASSWORD), the account password for the Centurylink Cloud.
- Alternatively, the module accepts the API token and account alias. The API token can be generated using the CLC account
login and password using the HTTP API call @ https://api.ctl.io/v2/authentication/login
- E(CLC_V2_API_TOKEN), the API token generated from https://api.ctl.io/v2/authentication/login
login and password using the HTTP API call @ U(https://api.ctl.io/v2/authentication/login).
- E(CLC_V2_API_TOKEN), the API token generated from U(https://api.ctl.io/v2/authentication/login).
- E(CLC_ACCT_ALIAS), the account alias associated with the Centurylink Cloud.
- Users can set E(CLC_V2_API_URL) to specify an endpoint for pointing to a different CLC environment.
"""

7
plugins/doc_fragments/ldap.py
View File

@ -14,9 +14,10 @@ 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) and O(bind_pw).
- 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)
and O(bind_pw).
options:
bind_dn:
description:

7
plugins/doc_fragments/oracle.py
View File

@ -40,9 +40,10 @@ options:
type: str
api_user_key_file:
description:
- Full path and filename of the private key (in PEM format). If not set, then the value of the E(OCI_USER_KEY_FILE) variable,
if any, is used. This option is required if the private key is not specified through a configuration file (See O(config_file_location)).
If the key is encrypted with a pass-phrase, the O(api_user_key_pass_phrase) option must also be provided.
- Full path and filename of the private key (in PEM format). If not set, then the value of the E(OCI_USER_KEY_FILE)
variable, if any, is used. This option is required if the private key is not specified through a configuration file
(See O(config_file_location)). If the key is encrypted with a pass-phrase, the O(api_user_key_pass_phrase) option
must also be provided.
type: path
api_user_key_pass_phrase:
description:

4
plugins/doc_fragments/oracle_creatable_resource.py
View File

@ -12,8 +12,8 @@ class ModuleDocFragment(object):
options:
force_create:
description: Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation,
and does not create the resource if it already exists. Setting this option to V(true), forcefully creates a copy of the
resource, even if it already exists. This option is mutually exclusive with O(key_by).
and does not create the resource if it already exists. Setting this option to V(true), forcefully creates a copy of
the resource, even if it already exists. This option is mutually exclusive with O(key_by).
default: false
type: bool
key_by:

3
plugins/doc_fragments/utm.py
View File

@ -31,7 +31,8 @@ options:
utm_token:
description:
- The token used to identify at the REST-API.
- See U(https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en), Chapter 2.4.2.
- See U(https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en), Chapter
2.4.2.
type: str
required: true
utm_protocol:

3
plugins/modules/aerospike_migrations.py
View File

@ -15,7 +15,8 @@ short_description: Check or wait for migrations between nodes
description:
- This can be used to check for migrations in a cluster. This makes it easy to do a rolling upgrade/update on Aerospike
nodes.
- If waiting for migrations is not desired, simply just poll until port 3000 if available or C(asinfo -v status) returns ok.
- If waiting for migrations is not desired, simply just poll until port 3000 if available or C(asinfo -v status) returns
ok.
author: "Albert Autin (@Alb0t)"
extends_documentation_fragment:
- community.general.attributes

2
plugins/modules/airbrake_deployment.py
View File

@ -71,7 +71,7 @@ options:
type: str
validate_certs:
description:
- If V(false), SSL certificates for the target url will not be validated. This should only be used on personally controlled
- If V(false), SSL certificates for the target URL will not be validated. This should only be used on personally controlled
sites using self-signed certificates.
required: false
default: true

4
plugins/modules/ali_instance.py
View File

@ -172,7 +172,7 @@ options:
type: int
instance_ids:
description:
- A list of instance ids. It is required when need to operate existing instances. If it is specified, O(count) will
- A list of instance IDs. It is required when need to operate existing instances. If it is specified, O(count) will
lose efficacy.
type: list
elements: str
@ -554,7 +554,7 @@ instances:
type: str
sample: 43.0.0.1
resource_group_id:
description: The id of the resource group to which the instance belongs.
description: The ID of the resource group to which the instance belongs.
returned: always
type: str
sample: my-ecs-group

2
plugins/modules/ali_instance_info.py
View File

@ -297,7 +297,7 @@ instances:
type: str
sample: 43.0.0.1
resource_group_id:
description: The id of the resource group to which the instance belongs.
description: The ID of the resource group to which the instance belongs.
returned: always
type: str
sample: my-ecs-group

6
plugins/modules/android_sdk.py
View File

@ -69,9 +69,9 @@ notes:
it is only possible to answer one license prompt at a time, meaning that instead of installing multiple packages as a
single invocation of the C(sdkmanager --install) command, it will be done by executing the command independently for each
package. This makes sure that at most only one license prompt will need to be answered. At the time of writing this module,
a C(sdkmanager)'s package may belong to at most one license type that needs to be accepted. However, if this changes
in the future, the module may hang as there might be more prompts generated by the C(sdkmanager) tool which the module
will not be able to answer. If this becomes the case, file an issue and in the meantime, consider accepting all the licenses
a C(sdkmanager)'s package may belong to at most one license type that needs to be accepted. However, if this changes in
the future, the module may hang as there might be more prompts generated by the C(sdkmanager) tool which the module will
not be able to answer. If this becomes the case, file an issue and in the meantime, consider accepting all the licenses
in advance, as it is described in the C(sdkmanager) L(documentation,https://developer.android.com/tools/sdkmanager#accept-licenses),
for instance, using the M(ansible.builtin.command) module.
seealso:

2
plugins/modules/bigpanda.py
View File

@ -75,7 +75,7 @@ options:
default: "https://api.bigpanda.io"
validate_certs:
description:
- If V(false), SSL certificates for the target url will not be validated. This should only be used on personally controlled
- If V(false), SSL certificates for the target URL will not be validated. This should only be used on personally controlled
sites using self-signed certificates.
required: false
default: true

2
plugins/modules/btrfs_info.py
View File

@ -49,7 +49,7 @@ filesystems:
- /dev/sda1
- /dev/sdb1
default_subvolume:
description: The id of the filesystem's default subvolume.
description: The ID of the filesystem's default subvolume.
type: int
sample: 5
subvolumes:

8
plugins/modules/cargo.py
View File

@ -38,12 +38,12 @@ options:
elements: str
required: true
path:
description: The base path where to install the Rust packages. Cargo automatically appends V(/bin). In other words,
V(/usr/local) will become V(/usr/local/bin).
description: The base path where to install the Rust packages. Cargo automatically appends V(/bin). In other words, V(/usr/local)
will become V(/usr/local/bin).
type: path
version:
description: The version to install. If O(name) contains multiple values, the module will try to install all of them
in this version.
description: The version to install. If O(name) contains multiple values, the module will try to install all of them in
this version.
type: str
required: false
locked:

4
plugins/modules/catapult.py
View File

@ -47,7 +47,7 @@ options:
user_id:
type: str
description:
- User Id from API account page.
- User ID from API account page.
required: true
api_token:
type: str
@ -62,7 +62,7 @@ options:
author: "Jonathan Mainguy (@Jmainguy)"
notes:
- Will return changed even if the media url is wrong.
- Will return changed even if the media URL is wrong.
- Will return changed if the destination number is invalid.
"""

4
plugins/modules/clc_alert_policy.py
View File

@ -36,11 +36,11 @@ options:
type: str
id:
description:
- The alert policy id. This is mutually exclusive with O(name).
- The alert policy ID. This is mutually exclusive with O(name).
type: str
alert_recipients:
description:
- A list of recipient email ids to notify the alert. This is required for O(state=present).
- A list of recipient email IDs to notify the alert. This is required for O(state=present).
type: list
elements: str
metric:

6
plugins/modules/clc_blueprint_package.py
View File

@ -27,13 +27,13 @@ attributes:
options:
server_ids:
description:
- A list of server Ids to deploy the blue print package.
- A list of server IDs to deploy the blue print package.
type: list
required: true
elements: str
package_id:
description:
- The package id of the blue print.
- The package ID of the blue print.
type: str
required: true
package_params:
@ -71,7 +71,7 @@ EXAMPLES = r"""
RETURN = r"""
server_ids:
description: The list of server ids that are changed.
description: The list of server IDs that are changed.
returned: success
type: list
sample: ["UC1TEST-SERVER1", "UC1TEST-SERVER2"]

4
plugins/modules/clc_firewall_policy.py
View File

@ -54,7 +54,7 @@ options:
elements: str
firewall_policy_id:
description:
- Id of the firewall policy. This is required to update or delete an existing firewall policy.
- ID of the firewall policy. This is required to update or delete an existing firewall policy.
type: str
source_account_alias:
description:
@ -109,7 +109,7 @@ EXAMPLES = r"""
RETURN = r"""
firewall_policy_id:
description: The firewall policy id.
description: The firewall policy ID.
returned: success
type: str
sample: fc36f1bfd47242e488a9c44346438c05

8
plugins/modules/clc_modify_server.py
View File

@ -27,7 +27,7 @@ attributes:
options:
server_ids:
description:
- A list of server Ids to modify.
- A list of server IDs to modify.
type: list
required: true
elements: str
@ -41,7 +41,7 @@ options:
type: str
anti_affinity_policy_id:
description:
- The anti affinity policy id to be set for a hyper scale server. This is mutually exclusive with O(anti_affinity_policy_name).
- The anti affinity policy ID to be set for a hyper scale server. This is mutually exclusive with O(anti_affinity_policy_name).
type: str
anti_affinity_policy_name:
description:
@ -49,7 +49,7 @@ options:
type: str
alert_policy_id:
description:
- The alert policy id to be associated to the server. This is mutually exclusive with O(alert_policy_name).
- The alert policy ID to be associated to the server. This is mutually exclusive with O(alert_policy_name).
type: str
alert_policy_name:
description:
@ -131,7 +131,7 @@ EXAMPLES = r"""
RETURN = r"""
server_ids:
description: The list of server ids that are changed.
description: The list of server IDs that are changed.
returned: success
type: list
sample: ["UC1TEST-SVR01", "UC1TEST-SVR02"]

2
plugins/modules/clc_publicip.py
View File

@ -99,7 +99,7 @@ EXAMPLES = r"""
RETURN = r"""
server_ids:
description: The list of server ids that are changed.
description: The list of server IDs that are changed.
returned: success
type: list
sample: ["UC1TEST-SVR01", "UC1TEST-SVR02"]

6
plugins/modules/clc_server.py
View File

@ -137,7 +137,7 @@ options:
type: str
public_ip_protocol:
description:
- The protocol to use for the public ip if O(add_public_ip=true).
- The protocol to use for the public IP if O(add_public_ip=true).
type: str
default: 'TCP'
choices: ['TCP', 'UDP', 'ICMP']
@ -245,12 +245,12 @@ EXAMPLES = r"""
RETURN = r"""
server_ids:
description: The list of server ids that are created.
description: The list of server IDs that are created.
returned: success
type: list
sample: ["UC1TEST-SVR01", "UC1TEST-SVR02"]
partially_created_server_ids:
description: The list of server ids that are partially created.
description: The list of server IDs that are partially created.
returned: success
type: list
sample: ["UC1TEST-SVR01", "UC1TEST-SVR02"]

4
plugins/modules/clc_server_snapshot.py
View File

@ -27,7 +27,7 @@ attributes:
options:
server_ids:
description:
- The list of CLC server Ids.
- The list of CLC server IDs.
type: list
required: true
elements: str
@ -83,7 +83,7 @@ EXAMPLES = r"""
RETURN = r"""
server_ids:
description: The list of server ids that are changed.
description: The list of server IDs that are changed.
returned: success
type: list
sample: ["UC1TEST-SVR01", "UC1TEST-SVR02"]

3
plugins/modules/composer.py
View File

@ -110,7 +110,8 @@ requirements:
- php
- composer installed in bin path (recommended C(/usr/local/bin)) or specified in O(composer_executable)
notes:
- Default options that are always appended in each execution are C(--no-ansi), C(--no-interaction) and C(--no-progress) if available.
- Default options that are always appended in each execution are C(--no-ansi), C(--no-interaction) and C(--no-progress)
if available.
- We received reports about issues on macOS if composer was installed by Homebrew. Please use the official install method
to avoid issues.
"""

6
plugins/modules/consul.py
View File

@ -16,9 +16,9 @@ description:
- Registers services and checks for an agent with a Consul cluster. A service is some process running on the agent node
that should be advertised by Consul's discovery mechanism. It may optionally supply a check definition, a periodic service
test to notify the Consul cluster of service's health.
- Checks may also be registered per node, for example disk usage, or cpu usage and notify the health of the entire node to the cluster.
Service level checks do not require a check name or id as these are derived by Consul from the Service name and id respectively
by appending V(service:) Node level checks require a O(check_name) and optionally a O(check_id).
- Checks may also be registered per node, for example disk usage, or cpu usage and notify the health of the entire node
to the cluster. Service level checks do not require a check name or ID as these are derived by Consul from the Service
name and ID respectively by appending V(service:) Node level checks require a O(check_name) and optionally a O(check_id).
- Currently, there is no complete way to retrieve the script, interval or TTL metadata for a registered check. Without this
metadata it is not possible to tell if the data supplied with ansible represents a change to a check. As a result this
does not attempt to determine changes and will always report a changed occurred. An API method is planned to supply this

4
plugins/modules/consul_agent_service.py
View File

@ -70,8 +70,8 @@ options:
type: int
enable_tag_override:
description:
- Specifies to disable the anti-entropy feature for this service's tags. If C(EnableTagOverride) is set to true then external
agents can update this service in the catalog and modify the tags.
- Specifies to disable the anti-entropy feature for this service's tags. If C(EnableTagOverride) is set to true then
external agents can update this service in the catalog and modify the tags.
type: bool
default: false
weights:

4
plugins/modules/consul_binding_rule.py
View File

@ -14,8 +14,8 @@ module: consul_binding_rule
short_description: Manipulate Consul binding rules
version_added: 8.3.0
description:
- Allows the addition, modification and deletion of binding rules in a Consul cluster using the agent. For more details on
using and configuring binding rules, see U(https://developer.hashicorp.com/consul/api-docs/acl/binding-rules).
- Allows the addition, modification and deletion of binding rules in a Consul cluster using the agent. For more details
on using and configuring binding rules, see U(https://developer.hashicorp.com/consul/api-docs/acl/binding-rules).
author:
- Florian Apolloner (@apollo13)
extends_documentation_fragment:

4
plugins/modules/consul_kv.py
View File

@ -40,8 +40,8 @@ options:
contents. If the state is V(present) and O(value) is not set, the existing value associated to the key will be returned.
The state V(absent) will remove the key/value pair, again C(changed) will be set to V(true) only if the key actually
existed prior to the removal. An attempt can be made to obtain or free the lock associated with a key/value pair with
the states V(acquire) or V(release) respectively. A valid session must be supplied to make the attempt C(changed) will
be V(true) if the attempt is successful, V(false) otherwise.
the states V(acquire) or V(release) respectively. A valid session must be supplied to make the attempt C(changed)
will be V(true) if the attempt is successful, V(false) otherwise.
type: str
choices: [absent, acquire, present, release]
default: present

4
plugins/modules/consul_role.py
View File

@ -14,8 +14,8 @@ module: consul_role
short_description: Manipulate Consul roles
version_added: 7.5.0
description:
- Allows the addition, modification and deletion of roles in a Consul cluster using the agent. For more details on using and
configuring ACLs, see U(https://www.consul.io/docs/guides/acl.html).
- Allows the addition, modification and deletion of roles in a Consul cluster using the agent. For more details on using
and configuring ACLs, see U(https://www.consul.io/docs/guides/acl.html).
author:
- Håkon Lerring (@Hakon)
extends_documentation_fragment:

9
plugins/modules/consul_session.py
View File

@ -37,10 +37,11 @@ options:
type: str
state:
description:
- Whether the session should be present, in other words it should be created if it does not exist, or absent, removed if present. If created,
the O(id) for the session is returned in the output. If V(absent), O(id) is required to remove the session. Info for
a single session, all the sessions for a node or all available sessions can be retrieved by specifying V(info), V(node)
or V(list) for the O(state); for V(node) or V(info), the node O(name) or session O(id) is required as parameter.
- Whether the session should be present, in other words it should be created if it does not exist, or absent, removed
if present. If created, the O(id) for the session is returned in the output. If V(absent), O(id) is required to remove
the session. Info for a single session, all the sessions for a node or all available sessions can be retrieved by
specifying V(info), V(node) or V(list) for the O(state); for V(node) or V(info), the node O(name) or session O(id)
is required as parameter.
choices: [absent, info, list, node, present]
type: str
default: present