mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-08-05 13:44:24 -07:00
doc style adjustments: modules r*
This commit is contained in:
parent
b458ee85ce
commit
17be4ff2f2
13 changed files with 43 additions and 42 deletions
|
@ -229,8 +229,8 @@ options:
|
||||||
description:
|
description:
|
||||||
- Custom OEM properties for HTTP Multipart Push updates.
|
- Custom OEM properties for HTTP Multipart Push updates.
|
||||||
- If set, then O(update_custom_oem_header) is required too.
|
- 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
|
- The properties are passed raw without any validation or conversion by Ansible. This means the content can be a file,
|
||||||
file, a string, or any other data. If the content is a dict that should be converted to JSON, then the content must
|
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.
|
be converted to JSON before passing it to this module using the P(ansible.builtin.to_json#filter) filter.
|
||||||
type: raw
|
type: raw
|
||||||
version_added: '10.1.0'
|
version_added: '10.1.0'
|
||||||
|
@ -830,15 +830,16 @@ return_values:
|
||||||
returned: on success
|
returned: on success
|
||||||
type: dict
|
type: dict
|
||||||
version_added: 6.1.0
|
version_added: 6.1.0
|
||||||
sample: {
|
sample:
|
||||||
"update_status": {
|
{
|
||||||
"handle": "/redfish/v1/TaskService/TaskMonitors/735",
|
"update_status": {
|
||||||
"messages": [],
|
"handle": "/redfish/v1/TaskService/TaskMonitors/735",
|
||||||
"resets_requested": [],
|
"messages": [],
|
||||||
"ret": true,
|
"resets_requested": [],
|
||||||
"status": "New"
|
"ret": true,
|
||||||
|
"status": "New"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from ansible.module_utils.basic import AnsibleModule
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
|
|
|
@ -166,9 +166,9 @@ options:
|
||||||
volume_details:
|
volume_details:
|
||||||
required: false
|
required: false
|
||||||
description:
|
description:
|
||||||
- Setting dict of volume to be created.
|
- Setting dictionary 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
|
- If C(CapacityBytes) key is not specified in this dictionary, the size of the volume is determined by the Redfish service.
|
||||||
service. It is possible the size will not be the maximum available size.
|
It is possible the size is not the maximum available size.
|
||||||
type: dict
|
type: dict
|
||||||
default: {}
|
default: {}
|
||||||
version_added: '7.5.0'
|
version_added: '7.5.0'
|
||||||
|
|
|
@ -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
|
- '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)
|
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
|
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
|
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).'
|
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
|
- 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:
|
pool_ids:
|
||||||
description:
|
description:
|
||||||
- Specify subscription pool IDs to consume.
|
- Specify subscription pool IDs to consume.
|
||||||
- 'A pool ID may be specified as a C(string) - just the pool ID (for example
|
- 'A pool ID may be specified as a C(string) - just the pool ID (for example V(0123456789abcdef0123456789abcdef)), or
|
||||||
V(0123456789abcdef0123456789abcdef)), or as a C(dict) with the pool ID as the key, and a quantity as the value (for
|
as a C(dict) with the pool ID as the key, and a quantity as the value (for example V(0123456789abcdef0123456789abcdef:
|
||||||
example V(0123456789abcdef0123456789abcdef: 2). If the quantity is provided, it is used to consume multiple entitlements
|
2). If the quantity is provided, it is used to consume multiple entitlements from a pool (the pool must support this).'
|
||||||
from a pool (the pool must support this).'
|
|
||||||
default: []
|
default: []
|
||||||
type: list
|
type: list
|
||||||
elements: raw
|
elements: raw
|
||||||
|
@ -167,8 +166,8 @@ options:
|
||||||
- Set syspurpose attributes in file C(/etc/rhsm/syspurpose/syspurpose.json) and synchronize these attributes with RHSM
|
- 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)
|
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
|
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
|
listed in the new list of attributes, the existing attribute is removed from C(syspurpose.json) file. Unknown attributes
|
||||||
attributes are ignored.
|
are ignored.
|
||||||
type: dict
|
type: dict
|
||||||
suboptions:
|
suboptions:
|
||||||
usage:
|
usage:
|
||||||
|
@ -187,7 +186,7 @@ options:
|
||||||
sync:
|
sync:
|
||||||
description:
|
description:
|
||||||
- When this option is V(true), then syspurpose attributes are synchronized with RHSM server immediately. When this
|
- 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
|
type: bool
|
||||||
default: false
|
default: false
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -33,7 +33,7 @@ options:
|
||||||
type: str
|
type: str
|
||||||
expiration:
|
expiration:
|
||||||
description:
|
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
|
required: false
|
||||||
type: int
|
type: int
|
||||||
non_existing:
|
non_existing:
|
||||||
|
|
|
@ -21,8 +21,8 @@ attributes:
|
||||||
support: partial
|
support: partial
|
||||||
details:
|
details:
|
||||||
- For C(check_mode) to work, the specified O(login_user) needs permission to run the C(GET) command on the key, otherwise
|
- 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.
|
the module fails.
|
||||||
- When using C(check_mode) the module will try to calculate the value that Redis would return. If the key is not present,
|
- 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.
|
V(0.0) is used as value.
|
||||||
diff_mode:
|
diff_mode:
|
||||||
support: none
|
support: none
|
||||||
|
|
|
@ -14,8 +14,8 @@ short_description: Set or Unset RHSM Release version
|
||||||
description:
|
description:
|
||||||
- Sets or unsets the release version used by RHSM repositories.
|
- Sets or unsets the release version used by RHSM repositories.
|
||||||
notes:
|
notes:
|
||||||
- This module will fail on an unregistered system. Use the M(community.general.redhat_subscription) module to register a
|
- This module fails on an unregistered system. Use the M(community.general.redhat_subscription) module to register a system
|
||||||
system prior to setting the RHSM release.
|
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
|
- It is possible to interact with C(subscription-manager) only as root, so root permissions are required to successfully
|
||||||
run this module.
|
run this module.
|
||||||
requirements:
|
requirements:
|
||||||
|
|
|
@ -48,7 +48,7 @@ options:
|
||||||
purge:
|
purge:
|
||||||
description:
|
description:
|
||||||
- Disable all currently enabled repositories that are not not specified in O(name). Only set this to V(true) if passing
|
- 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
|
type: bool
|
||||||
default: false
|
default: false
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -62,8 +62,8 @@ options:
|
||||||
type: str
|
type: str
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using
|
- If V(false), SSL certificates are not validated. This should only be used on personally controlled sites using self-signed
|
||||||
self-signed certificates.
|
certificates.
|
||||||
type: bool
|
type: bool
|
||||||
default: true
|
default: true
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -69,7 +69,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Emoji for the message sender. The representation for the available emojis can be got from Rocket Chat.
|
- Emoji for the message sender. The representation for the available emojis can be got from Rocket Chat.
|
||||||
- For example V(:thumbsup:).
|
- 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:
|
link_names:
|
||||||
type: int
|
type: int
|
||||||
description:
|
description:
|
||||||
|
@ -80,8 +80,8 @@ options:
|
||||||
- 0
|
- 0
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using
|
- If V(false), SSL certificates are not validated. This should only be used on personally controlled sites using self-signed
|
||||||
self-signed certificates.
|
certificates.
|
||||||
type: bool
|
type: bool
|
||||||
default: true
|
default: true
|
||||||
color:
|
color:
|
||||||
|
@ -102,10 +102,10 @@ options:
|
||||||
- Define a list of attachments.
|
- Define a list of attachments.
|
||||||
is_pre740:
|
is_pre740:
|
||||||
description:
|
description:
|
||||||
- If V(true), the payload matches Rocket.Chat prior to 7.4.0 format.
|
- If V(true), the payload matches Rocket.Chat prior to 7.4.0 format. This format has been used by the module since its
|
||||||
This format has been used by the module since its inception, but is no longer supported by Rocket.Chat 7.4.0.
|
inception, but is no longer supported by Rocket.Chat 7.4.0.
|
||||||
- The default value of the option will change to V(false) eventually.
|
- The default value of the option is going to 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.
|
- This parameter is going to be removed in a future release when Rocket.Chat 7.4.0 becomes the minimum supported version.
|
||||||
type: bool
|
type: bool
|
||||||
default: true
|
default: true
|
||||||
version_added: 10.5.0
|
version_added: 10.5.0
|
||||||
|
|
|
@ -61,7 +61,7 @@ options:
|
||||||
default: 'https://api.rollbar.com/api/1/deploy/'
|
default: 'https://api.rollbar.com/api/1/deploy/'
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
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.
|
sites using self-signed certificates.
|
||||||
required: false
|
required: false
|
||||||
default: true
|
default: true
|
||||||
|
|
|
@ -101,7 +101,7 @@ packages:
|
||||||
description: A list of packages specified.
|
description: A list of packages specified.
|
||||||
returned: always
|
returned: always
|
||||||
type: list
|
type: list
|
||||||
sample: ['nfs-utils']
|
sample: ["nfs-utils"]
|
||||||
stdout:
|
stdout:
|
||||||
description: Stdout of rpm-ostree command.
|
description: Stdout of rpm-ostree command.
|
||||||
returned: always
|
returned: always
|
||||||
|
|
|
@ -62,7 +62,7 @@ options:
|
||||||
type: int
|
type: int
|
||||||
description:
|
description:
|
||||||
- Job execution wait timeout in seconds.
|
- 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.
|
- Keep in mind that there is a sleep based on O(wait_execution_delay) after each job status check.
|
||||||
default: 120
|
default: 120
|
||||||
abort_on_timeout:
|
abort_on_timeout:
|
||||||
|
|
|
@ -30,9 +30,10 @@ options:
|
||||||
required: true
|
required: true
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- V(started)/V(stopped) are idempotent actions that will not run commands unless necessary. V(restarted) will always
|
- V(started)/V(stopped) are idempotent actions that do not run commands unless necessary.
|
||||||
bounce the service (sv restart) and V(killed) will always bounce the service (sv force-stop). V(reloaded) will send
|
- V(restarted) always bounces the service (sv restart) and V(killed) always bounces the service (sv force-stop).
|
||||||
a HUP (sv reload). V(once) will run a normally downed sv once (sv once), not really an idempotent operation.
|
- 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
|
type: str
|
||||||
choices: [killed, once, reloaded, restarted, started, stopped]
|
choices: [killed, once, reloaded, restarted, started, stopped]
|
||||||
enabled:
|
enabled:
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue