ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-08-03 04:34:24 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

doc style adjustments: modules r*

Browse source
This commit is contained in:
Alexei Znamensky 2025-07-27 17:10:19 +12:00
commit 17be4ff2f2
13 changed files with 43 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

21
plugins/modules/redfish_command.py
View file

@ -229,8 +229,8 @@ options:
description:
- Custom OEM properties for HTTP Multipart Push updates.
- If set, then O(update_custom_oem_header) is required too.
- The properties will be passed raw without any validation or conversion by Ansible. This means the content can be a
file, a string, or any other data. If the content is a dict that should be converted to JSON, then the content must
- The properties are passed raw without any validation or conversion by Ansible. This means the content can be a file,
a string, or any other data. If the content is a dictionary that should be converted to JSON, then the content must
be converted to JSON before passing it to this module using the P(ansible.builtin.to_json#filter) filter.
type: raw
version_added: '10.1.0'
@ -830,15 +830,16 @@ return_values:
returned: on success
type: dict
version_added: 6.1.0
sample: {
"update_status": {
"handle": "/redfish/v1/TaskService/TaskMonitors/735",
"messages": [],
"resets_requested": [],
"ret": true,
"status": "New"
sample:
{
"update_status": {
"handle": "/redfish/v1/TaskService/TaskMonitors/735",
"messages": [],
"resets_requested": [],
"ret": true,
"status": "New"
}
}
}
"""
from ansible.module_utils.basic import AnsibleModule

6
plugins/modules/redfish_config.py
View file

@ -166,9 +166,9 @@ options:
volume_details:
required: false
description:
- Setting dict of volume to be created.
- If C(CapacityBytes) key is not specified in this dictionary, the size of the volume will be determined by the Redfish
service. It is possible the size will not be the maximum available size.
- Setting dictionary of volume to be created.
- If C(CapacityBytes) key is not specified in this dictionary, the size of the volume is determined by the Redfish service.
It is possible the size is not the maximum available size.
type: dict
default: {}
version_added: '7.5.0'

15
plugins/modules/redhat_subscription.py
View file

@ -21,7 +21,7 @@ notes:
- 'The module tries to use the D-Bus C(rhsm) service (part of C(subscription-manager)) to register, starting from community.general
6.5.0: this is done so credentials (username, password, activation keys) can be passed to C(rhsm) in a secure way. C(subscription-manager)
itself gets credentials only as arguments of command line parameters, which is I(not) secure, as they can be easily stolen
by checking the process listing on the system. Due to limitations of the D-Bus interface of C(rhsm), the module will I(not)
by checking the process listing on the system. Due to limitations of the D-Bus interface of C(rhsm), the module does I(not)
use D-Bus for registration when trying either to register using O(token), or when specifying O(environment), or when the
system is old (typically RHEL 7 older than 7.4, RHEL 6, and older).'
- In order to register a system, subscription-manager requires either a username and password, or an activationkey and an
@ -132,10 +132,9 @@ options:
pool_ids:
description:
- Specify subscription pool IDs to consume.
- 'A pool ID may be specified as a C(string) - just the pool ID (for example
V(0123456789abcdef0123456789abcdef)), or as a C(dict) with the pool ID as the key, and a quantity as the value (for
example V(0123456789abcdef0123456789abcdef: 2). If the quantity is provided, it is used to consume multiple entitlements
from a pool (the pool must support this).'
- 'A pool ID may be specified as a C(string) - just the pool ID (for example V(0123456789abcdef0123456789abcdef)), or
as a C(dict) with the pool ID as the key, and a quantity as the value (for example V(0123456789abcdef0123456789abcdef:
2). If the quantity is provided, it is used to consume multiple entitlements from a pool (the pool must support this).'
default: []
type: list
elements: raw
@ -167,8 +166,8 @@ options:
- Set syspurpose attributes in file C(/etc/rhsm/syspurpose/syspurpose.json) and synchronize these attributes with RHSM
server. Syspurpose attributes help attach the most appropriate subscriptions to the system automatically. When C(syspurpose.json)
file already contains some attributes, then new attributes overwrite existing attributes. When some attribute is not
listed in the new list of attributes, the existing attribute will be removed from C(syspurpose.json) file. Unknown
attributes are ignored.
listed in the new list of attributes, the existing attribute is removed from C(syspurpose.json) file. Unknown attributes
are ignored.
type: dict
suboptions:
usage:
@ -187,7 +186,7 @@ options:
sync:
description:
- When this option is V(true), then syspurpose attributes are synchronized with RHSM server immediately. When this
option is V(false), then syspurpose attributes will be synchronized with RHSM server by rhsmcertd daemon.
option is V(false), then syspurpose attributes are synchronized with RHSM server by rhsmcertd daemon.
type: bool
default: false
"""

2
plugins/modules/redis_data.py
View file

@ -33,7 +33,7 @@ options:
type: str
expiration:
description:
- Expiration time in milliseconds. Setting this flag will always result in a change in the database.
- Expiration time in milliseconds. Setting this flag always results in a change in the database.
required: false
type: int
non_existing:

4
plugins/modules/redis_data_incr.py
View file

@ -21,8 +21,8 @@ attributes:
support: partial
details:
- For C(check_mode) to work, the specified O(login_user) needs permission to run the C(GET) command on the key, otherwise
the module will fail.
- When using C(check_mode) the module will try to calculate the value that Redis would return. If the key is not present,
the module fails.
- When using C(check_mode) the module tries to calculate the value that Redis would return. If the key is not present,
V(0.0) is used as value.
diff_mode:
support: none

4
plugins/modules/rhsm_release.py
View file

@ -14,8 +14,8 @@ short_description: Set or Unset RHSM Release version
description:
- Sets or unsets the release version used by RHSM repositories.
notes:
- This module will fail on an unregistered system. Use the M(community.general.redhat_subscription) module to register a
system prior to setting the RHSM release.
- This module fails on an unregistered system. Use the M(community.general.redhat_subscription) module to register a system
prior to setting the RHSM release.
- It is possible to interact with C(subscription-manager) only as root, so root permissions are required to successfully
run this module.
requirements:

2
plugins/modules/rhsm_repository.py
View file

@ -48,7 +48,7 @@ options:
purge:
description:
- Disable all currently enabled repositories that are not not specified in O(name). Only set this to V(true) if passing
in a list of repositories to the O(name) field. Using this with C(loop) will most likely not have the desired result.
in a list of repositories to the O(name) field. Using this with C(loop) is likely not to have the desired result.
type: bool
default: false
"""

4
plugins/modules/riak.py
View file

@ -62,8 +62,8 @@ options:
type: str
validate_certs:
description:
- If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using
self-signed certificates.
- If V(false), SSL certificates are not validated. This should only be used on personally controlled sites using self-signed
certificates.
type: bool
default: true
"""

14
plugins/modules/rocketchat.py
View file

@ -69,7 +69,7 @@ options:
description:
- Emoji for the message sender. The representation for the available emojis can be got from Rocket Chat.
- For example V(:thumbsup:).
- If O(icon_emoji) is set, O(icon_url) will not be used.
- If O(icon_emoji) is set, O(icon_url) is not used.
link_names:
type: int
description:
@ -80,8 +80,8 @@ options:
- 0
validate_certs:
description:
- If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using
self-signed certificates.
- If V(false), SSL certificates are not validated. This should only be used on personally controlled sites using self-signed
certificates.
type: bool
default: true
color:
@ -102,10 +102,10 @@ options:
- Define a list of attachments.
is_pre740:
description:
- If V(true), the payload matches Rocket.Chat prior to 7.4.0 format.
This format has been used by the module since its inception, but is no longer supported by Rocket.Chat 7.4.0.
- The default value of the option will change to V(false) eventually.
- This parameter will be removed in a future release when Rocket.Chat 7.4.0 becomes the minimum supported version.
- If V(true), the payload matches Rocket.Chat prior to 7.4.0 format. This format has been used by the module since its
inception, but is no longer supported by Rocket.Chat 7.4.0.
- The default value of the option is going to change to V(false) eventually.
- This parameter is going to be removed in a future release when Rocket.Chat 7.4.0 becomes the minimum supported version.
type: bool
default: true
version_added: 10.5.0

2
plugins/modules/rollbar_deployment.py
View file

@ -61,7 +61,7 @@ options:
default: 'https://api.rollbar.com/api/1/deploy/'
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 are not validated. This should only be used on personally controlled
sites using self-signed certificates.
required: false
default: true

2
plugins/modules/rpm_ostree_pkg.py
View file

@ -101,7 +101,7 @@ packages:
description: A list of packages specified.
returned: always
type: list
sample: ['nfs-utils']
sample: ["nfs-utils"]
stdout:
description: Stdout of rpm-ostree command.
returned: always

2
plugins/modules/rundeck_job_run.py
View file

@ -62,7 +62,7 @@ options:
type: int
description:
- Job execution wait timeout in seconds.
- If the timeout is reached, the job will be aborted.
- If the timeout is reached, the job is aborted.
- Keep in mind that there is a sleep based on O(wait_execution_delay) after each job status check.
default: 120
abort_on_timeout:

7
plugins/modules/runit.py
View file

@ -30,9 +30,10 @@ options:
required: true
state:
description:
- V(started)/V(stopped) are idempotent actions that will not run commands unless necessary. V(restarted) will always
bounce the service (sv restart) and V(killed) will always bounce the service (sv force-stop). V(reloaded) will send
a HUP (sv reload). V(once) will run a normally downed sv once (sv once), not really an idempotent operation.
- V(started)/V(stopped) are idempotent actions that do not run commands unless necessary.
- V(restarted) always bounces the service (sv restart) and V(killed) always bounces the service (sv force-stop).
- V(reloaded) always sends a HUP (sv reload).
- V(once) runs a normally downed sv once (sv once), not really an idempotent operation.
type: str
choices: [killed, once, reloaded, restarted, started, stopped]
enabled: