[PR #10480/c1bd4611 backport][stable-11] doc style adjustments: modules s* (#10487)

doc style adjustments: modules s* (#10480)

* doc style adjustments: modules s*

* adjust comment indentation

* remove empty RETURN section in stacki_host

* spectrum_model_attrs: improve formatting of example

* Apply suggestions from code review



* Update plugins/modules/spotinst_aws_elastigroup.py



* Update plugins/modules/swdepot.py



---------


(cherry picked from commit c1bd461173)

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-27 14:34:24 +00:00 committed by GitHub
commit 9e91fb0704
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
42 changed files with 191 additions and 174 deletions

View file

@ -17,7 +17,8 @@ description:
notes: notes:
- In 2.5, this module has been renamed from C(osx_say) to M(community.general.say). - In 2.5, this module has been renamed from C(osx_say) to M(community.general.say).
- If you like this module, you may also be interested in the osx_say callback plugin. - If you like this module, you may also be interested in the osx_say callback plugin.
- A list of available voices, with language, can be found by running C(say -v ?) on a OSX host and C(espeak --voices) on a Linux host. - A list of available voices, with language, can be found by running C(say -v ?) on a OSX host and C(espeak --voices) on
a Linux host.
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
attributes: attributes:

View file

@ -133,7 +133,7 @@ options:
type: str type: str
description: description:
- Security group unique identifier. - Security group unique identifier.
- If no value provided, the default security group or current security group will be used. - If no value provided, the default security group or current security group is used.
required: false required: false
""" """

View file

@ -89,7 +89,7 @@ options:
secret_environment_variables: secret_environment_variables:
description: description:
- Secret environment variables of the container namespace. - Secret environment variables of the container namespace.
- Updating those values will not output a C(changed) state in Ansible. - Updating those values does not output a C(changed) state in Ansible.
- Injected in container at runtime. - Injected in container at runtime.
type: dict type: dict
default: {} default: {}
@ -125,7 +125,7 @@ options:
max_concurrency: max_concurrency:
description: description:
- Maximum number of connections per container. - Maximum number of connections per container.
- This parameter will be used to trigger autoscaling. - This parameter is used to trigger autoscaling.
type: int type: int
protocol: protocol:

View file

@ -79,7 +79,7 @@ options:
secret_environment_variables: secret_environment_variables:
description: description:
- Secret environment variables of the container namespace. - Secret environment variables of the container namespace.
- Updating those values will not output a C(changed) state in Ansible. - Updating those values does not output a C(changed) state in Ansible.
- Injected in containers at runtime. - Injected in containers at runtime.
type: dict type: dict
default: {} default: {}

View file

@ -71,7 +71,7 @@ options:
type: str type: str
description: description:
- Default visibility policy. - Default visibility policy.
- Everyone will be able to pull images from a V(public) registry. - Everyone can pull images from a V(public) registry.
choices: choices:
- public - public
- private - private

View file

@ -89,7 +89,7 @@ options:
secret_environment_variables: secret_environment_variables:
description: description:
- Secret environment variables of the function. - Secret environment variables of the function.
- Updating those values will not output a C(changed) state in Ansible. - Updating those values does not output a C(changed) state in Ansible.
- Injected in function at runtime. - Injected in function at runtime.
type: dict type: dict
default: {} default: {}

View file

@ -79,7 +79,7 @@ options:
secret_environment_variables: secret_environment_variables:
description: description:
- Secret environment variables of the function namespace. - Secret environment variables of the function namespace.
- Updating those values will not output a C(changed) state in Ansible. - Updating those values does not output a C(changed) state in Ansible.
- Injected in functions at runtime. - Injected in functions at runtime.
type: dict type: dict
default: {} default: {}

View file

@ -57,7 +57,7 @@ scaleway_image_info:
type: list type: list
elements: dict elements: dict
sample: sample:
"scaleway_image_info": [ [
{ {
"arch": "x86_64", "arch": "x86_64",
"creation_date": "2018-07-17T16:18:49.276456+00:00", "creation_date": "2018-07-17T16:18:49.276456+00:00",

View file

@ -52,12 +52,12 @@ RETURN = r"""
scaleway_ip_info: scaleway_ip_info:
description: description:
- Response from Scaleway API. - Response from Scaleway API.
- 'For more details please refer to U(https://developers.scaleway.com/en/products/instance/api/).' - For more details please refer to U(https://developers.scaleway.com/en/products/instance/api/).
returned: success returned: success
type: list type: list
elements: dict elements: dict
sample: sample:
"scaleway_ip_info": [ [
{ {
"address": "163.172.170.243", "address": "163.172.170.243",
"id": "ea081794-a581-8899-8451-386ddaf0a451", "id": "ea081794-a581-8899-8451-386ddaf0a451",

View file

@ -44,7 +44,7 @@ scaleway_organization_info:
type: list type: list
elements: dict elements: dict
sample: sample:
"scaleway_organization_info": [ [
{ {
"address_city_name": "Paris", "address_city_name": "Paris",
"address_country_code": "FR", "address_country_code": "FR",

View file

@ -56,7 +56,7 @@ scaleway_security_group_info:
type: list type: list
elements: dict elements: dict
sample: sample:
"scaleway_security_group_info": [ [
{ {
"description": "test-ams", "description": "test-ams",
"enable_default_security": true, "enable_default_security": true,

View file

@ -57,7 +57,7 @@ scaleway_server_info:
type: list type: list
elements: dict elements: dict
sample: sample:
"scaleway_server_info": [ [
{ {
"arch": "x86_64", "arch": "x86_64",
"boot_type": "local", "boot_type": "local",

View file

@ -57,7 +57,7 @@ scaleway_snapshot_info:
type: list type: list
elements: dict elements: dict
sample: sample:
"scaleway_snapshot_info": [ [
{ {
"base_volume": { "base_volume": {
"id": "68386fae-4f55-4fbf-aabb-953036a85872", "id": "68386fae-4f55-4fbf-aabb-953036a85872",

View file

@ -57,7 +57,7 @@ scaleway_volume_info:
type: list type: list
elements: dict elements: dict
sample: sample:
"scaleway_volume_info": [ [
{ {
"creation_date": "2018-08-14T20:56:24.949660+00:00", "creation_date": "2018-08-14T20:56:24.949660+00:00",
"export_uri": null, "export_uri": null,

View file

@ -24,7 +24,7 @@ attributes:
options: options:
domain: domain:
description: description:
- The domain that will be added or removed from the list of permissive domains. - The domain that is added or removed from the list of permissive domains.
type: str type: str
required: true required: true
aliases: [name] aliases: [name]

View file

@ -34,7 +34,8 @@ options:
type: str type: str
aliases: [serange] aliases: [serange]
description: description:
- MLS/MCS Security Range (MLS/MCS Systems only) SELinux Range for SELinux login mapping defaults to the SELinux user record range. - MLS/MCS Security Range (MLS/MCS Systems only) SELinux Range for SELinux login mapping defaults to the SELinux user
record range.
default: s0 default: s0
state: state:
type: str type: str

View file

@ -17,8 +17,8 @@ description:
notes: notes:
- This module is non-idempotent because it sends an email through the external API. It is idempotent only in the case that - This module is non-idempotent because it sends an email through the external API. It is idempotent only in the case that
the module fails. the module fails.
- Like the other notification modules, this one requires an external dependency to work. In this case, you will need an - Like the other notification modules, this one requires an external dependency to work. In this case, you need an active
active SendGrid account. SendGrid account.
- In order to use O(api_key), O(cc), O(bcc), O(attachments), O(from_name), O(html_body), and O(headers) you must C(pip install - In order to use O(api_key), O(cc), O(bcc), O(attachments), O(from_name), O(html_body), and O(headers) you must C(pip install
sendgrid). sendgrid).
requirements: requirements:
@ -82,7 +82,7 @@ options:
- The name you want to appear in the from field, for example V(John Doe). - The name you want to appear in the from field, for example V(John Doe).
html_body: html_body:
description: description:
- Whether the body is html content that should be rendered. - Whether the body is HTML content that should be rendered.
type: bool type: bool
default: false default: false
headers: headers:

View file

@ -14,7 +14,7 @@ module: sensu_check
short_description: Manage Sensu checks short_description: Manage Sensu checks
description: description:
- Manage the checks that should be run on a machine by I(Sensu). - Manage the checks that should be run on a machine by I(Sensu).
- Most options do not have a default and will not be added to the check definition unless specified. - Most options do not have a default and are not added to the check definition unless specified.
- All defaults except O(path), O(state), O(backup) and O(metric) are not managed by this module, they are simply specified - All defaults except O(path), O(state), O(backup) and O(metric) are not managed by this module, they are simply specified
for your convenience. for your convenience.
deprecated: deprecated:
@ -45,8 +45,8 @@ options:
type: str type: str
description: description:
- Path to the JSON file of the check to be added/removed. - Path to the JSON file of the check to be added/removed.
- Will be created if it does not exist (unless O(state=absent)). - It is created if it does not exist (unless O(state=absent)).
- The parent folders need to exist when O(state=present), otherwise an error will be thrown. - The parent folders need to exist when O(state=present), otherwise an error is thrown.
default: /etc/sensu/conf.d/checks.json default: /etc/sensu/conf.d/checks.json
backup: backup:
description: description:
@ -99,7 +99,8 @@ options:
type: list type: list
elements: str elements: str
description: description:
- Other checks this check depends on, if dependencies fail handling of this check will be disabled. - Other checks this one depends on.
- If dependencies fail handling of this check is disabled.
metric: metric:
description: description:
- Whether the check is a metric. - Whether the check is a metric.

View file

@ -14,7 +14,7 @@ author: "David Moreau Simard (@dmsimard)"
short_description: Manages Sensu client configuration short_description: Manages Sensu client configuration
description: description:
- Manages Sensu client configuration. - Manages Sensu client configuration.
- 'For more information, refer to the L(Sensu documentation, https://sensuapp.org/docs/latest/reference/clients.html).' - For more information, refer to the L(Sensu documentation, https://sensuapp.org/docs/latest/reference/clients.html).
deprecated: deprecated:
removed_in: 13.0.0 removed_in: 13.0.0
why: Sensu Core and Sensu Enterprise products have been End of Life since 2019/20. why: Sensu Core and Sensu Enterprise products have been End of Life since 2019/20.
@ -42,8 +42,8 @@ options:
type: str type: str
description: description:
- An address to help identify and reach the client. This is only informational, usually an IP address or hostname. - An address to help identify and reach the client. This is only informational, usually an IP address or hostname.
- If not specified it defaults to non-loopback IPv4 address as determined by Ruby C(Socket.ip_address_list) (provided by - If not specified it defaults to non-loopback IPv4 address as determined by Ruby C(Socket.ip_address_list) (provided
Sensu). by Sensu).
subscriptions: subscriptions:
type: list type: list
elements: str elements: str
@ -158,7 +158,13 @@ config:
description: Effective client configuration, when state is present. description: Effective client configuration, when state is present.
returned: success returned: success
type: dict type: dict
sample: {'name': 'client', 'subscriptions': ['default']} sample:
{
"name": "client",
"subscriptions": [
"default"
]
}
file: file:
description: Path to the client configuration file. description: Path to the client configuration file.
returned: success returned: success

View file

@ -14,7 +14,7 @@ author: "David Moreau Simard (@dmsimard)"
short_description: Manages Sensu handler configuration short_description: Manages Sensu handler configuration
description: description:
- Manages Sensu handler configuration. - Manages Sensu handler configuration.
- 'For more information, refer to the L(Sensu documentation, https://sensuapp.org/docs/latest/reference/handlers.html).' - For more information, refer to the L(Sensu documentation, https://sensuapp.org/docs/latest/reference/handlers.html).
deprecated: deprecated:
removed_in: 13.0.0 removed_in: 13.0.0
why: Sensu Core and Sensu Enterprise products have been End of Life since 2019/20. why: Sensu Core and Sensu Enterprise products have been End of Life since 2019/20.
@ -57,7 +57,7 @@ options:
type: list type: list
elements: str elements: str
description: description:
- An array of check result severities the handler will handle. - An array of check result severities the handler handles.
- 'NOTE: event resolution bypasses this filtering.' - 'NOTE: event resolution bypasses this filtering.'
- "Example: [ 'warning', 'critical', 'unknown' ]." - "Example: [ 'warning', 'critical', 'unknown' ]."
mutator: mutator:
@ -155,7 +155,12 @@ config:
description: Effective handler configuration, when state is present. description: Effective handler configuration, when state is present.
returned: success returned: success
type: dict type: dict
sample: {'name': 'irc', 'type': 'pipe', 'command': '/usr/local/bin/notify-irc.sh'} sample:
{
"name": "irc",
"type": "pipe",
"command": "/usr/local/bin/notify-irc.sh"
}
file: file:
description: Path to the handler configuration file. description: Path to the handler configuration file.
returned: success returned: success

View file

@ -38,10 +38,10 @@ options:
expire: expire:
type: int type: int
description: description:
- If specified, the silence entry will be automatically cleared after this number of seconds. - If specified, the silence entry is automatically cleared after this number of seconds.
expire_on_resolve: expire_on_resolve:
description: description:
- If specified as true, the silence entry will be automatically cleared once the condition it is silencing is resolved. - If specified as true, the silence entry is automatically cleared once the condition it is silencing is resolved.
type: bool type: bool
reason: reason:
type: str type: str

View file

@ -51,7 +51,7 @@ options:
deploy: deploy:
description: description:
- Whether or not to deploy artifacts after building them. - Whether or not to deploy artifacts after building them.
- When this option is V(false) all the functions will be built, but no stack update will be run to send them out. - When this option is V(false) all the functions are built, but no stack update is run to send them out.
- This is mostly useful for generating artifacts to be stored/deployed elsewhere. - This is mostly useful for generating artifacts to be stored/deployed elsewhere.
type: bool type: bool
default: true default: true

View file

@ -32,23 +32,24 @@ options:
domain: domain:
type: str type: str
description: description:
- "When using new format 'Webhook token' and WebAPI tokens: this can be V(slack.com) or V(slack-gov.com) and is ignored otherwise." - "When using new format 'Webhook token' and WebAPI tokens: this can be V(slack.com) or V(slack-gov.com) and is ignored
otherwise."
- "When using old format 'Webhook token': Slack (sub)domain for your environment without protocol. (For example V(example.slack.com).) - "When using old format 'Webhook token': Slack (sub)domain for your environment without protocol. (For example V(example.slack.com).)
in Ansible 1.8 and beyond, this is deprecated and may be ignored. See token documentation for information." in Ansible 1.8 and beyond, this is deprecated and may be ignored. See token documentation for information."
token: token:
type: str type: str
description: description:
- Slack integration token. This authenticates you to the slack service. Make sure to use the correct type of token, - Slack integration token. This authenticates you to the Slack service. Make sure to use the correct type of token,
depending on what method you use. depending on what method you use.
- 'Webhook token: Prior to Ansible 1.8, a token looked like V(3Ffe373sfhRE6y42Fg3rvf4GlK). In Ansible 1.8 and above, - 'Webhook token: Prior to Ansible 1.8, a token looked like V(3Ffe373sfhRE6y42Fg3rvf4GlK). In Ansible 1.8 and above,
Ansible adapts to the new slack API where tokens look like V(G922VJP24/D921DW937/3Ffe373sfhRE6y42Fg3rvf4GlK). If tokens Ansible adapts to the new Slack API where tokens look like V(G922VJP24/D921DW937/3Ffe373sfhRE6y42Fg3rvf4GlK). If tokens
are in the new format then slack will ignore any value of domain except V(slack.com) or V(slack-gov.com). If the token are in the new format then Slack ignores any value of domain except V(slack.com) or V(slack-gov.com). If the token
is in the old format the domain is required. Ansible has no control of when slack will get rid of the old API. When slack is in the old format the domain is required. Ansible has no control of when Slack is going to remove the old API.
does that the old format will stop working. When Slack does that the old format is going to cease working. B(Please keep in mind the tokens are not the API tokens
** Please keep in mind the tokens are not the API tokens but are the webhook tokens. In slack these but are the webhook tokens.) In Slack these are found in the webhook URL which are obtained under the apps and integrations.
are found in the webhook URL which are obtained under the apps and integrations. The incoming webhooks can be added The incoming webhooks can be added in that area. In some cases this may be locked by your Slack admin and you must
in that area. In some cases this may be locked by your Slack admin and you must request access. It is there that the request access. It is there that the incoming webhooks can be added. The key is on the end of the URL given to you
incoming webhooks can be added. The key is on the end of the URL given to you in that section.' in that section.'
- "WebAPI token: Slack WebAPI requires a personal, bot or work application token. These tokens start with V(xoxp-), - "WebAPI token: Slack WebAPI requires a personal, bot or work application token. These tokens start with V(xoxp-),
V(xoxb-) or V(xoxa-), for example V(xoxb-1234-56789abcdefghijklmnop). WebAPI token is required if you intend to receive V(xoxb-) or V(xoxa-), for example V(xoxb-1234-56789abcdefghijklmnop). WebAPI token is required if you intend to receive
thread_id. See Slack's documentation (U(https://api.slack.com/docs/token-types)) for more information." thread_id. See Slack's documentation (U(https://api.slack.com/docs/token-types)) for more information."
@ -58,7 +59,8 @@ options:
description: description:
- Message to send. Note that the module does not handle escaping characters. Plain-text angle brackets and ampersands - Message to send. Note that the module does not handle escaping characters. Plain-text angle brackets and ampersands
should be converted to HTML entities (for example C(&) to C(&amp;)) before sending. See Slack's documentation should be converted to HTML entities (for example C(&) to C(&amp;)) before sending. See Slack's documentation
(U(https://api.slack.com/docs/message-formatting)) for more. (U(https://api.slack.com/docs/message-formatting))
for more.
channel: channel:
type: str type: str
description: description:
@ -90,7 +92,7 @@ options:
type: str type: str
description: description:
- Emoji for the message sender. See Slack documentation for options. - Emoji for the message sender. See Slack documentation for options.
- 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:
@ -108,8 +110,8 @@ options:
- 'none' - 'none'
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:
@ -139,11 +141,12 @@ options:
- Setting for automatically prepending a V(#) symbol on the passed in O(channel). - Setting for automatically prepending a V(#) symbol on the passed in O(channel).
- The V(auto) method prepends a V(#) unless O(channel) starts with one of V(#), V(@), V(C0), V(GF), V(G0), V(CP). These - The V(auto) method prepends a V(#) unless O(channel) starts with one of V(#), V(@), V(C0), V(GF), V(G0), V(CP). These
prefixes only cover a small set of the prefixes that should not have a V(#) prepended. Since an exact condition which prefixes only cover a small set of the prefixes that should not have a V(#) prepended. Since an exact condition which
O(channel) values must not have the V(#) prefix is not known, the value V(auto) for this option will be deprecated O(channel) values must not have the V(#) prefix is not known, the value V(auto) for this option is deprecated in the
in the future. It is best to explicitly set O(prepend_hash=always) or O(prepend_hash=never) to obtain the needed behavior. future. It is best to explicitly set O(prepend_hash=always) or O(prepend_hash=never) to obtain the needed behavior.
- The B(current default) is V(auto), which has been B(deprecated) since community.general 10.2.0. It will change to - The B(current default) is V(auto), which has been B(deprecated) since community.general 10.2.0. It is going to change
V(never) in community.general 12.0.0. To prevent deprecation warnings you can explicitly set O(prepend_hash) to the to V(never) in community.general 12.0.0. To prevent deprecation warnings you can explicitly set O(prepend_hash) to
value you want. We suggest to only use V(always) or V(never), but not V(auto), when explicitly setting a value. the value you want. We suggest to only use V(always) or V(never), but not V(auto), when explicitly setting a value.
# when the default changes in community.general 12.0.0, add deprecation for the `auto` value for 14.0.0
choices: choices:
- 'always' - 'always'
- 'never' - 'never'

View file

@ -47,12 +47,20 @@ EXAMPLES = r"""
- name: Print information - name: Print information
ansible.builtin.debug: ansible.builtin.debug:
msg: "{{ result.smartos_images[item]['name'] }}-{{ result.smartos_images[item]['version'] }} has {{ result.smartos_images[item]['clones'] }} VM(s)" msg: >-
{{
result.smartos_images[item]['name'] }}-{{ result.smartos_images[item]['version'] }}
has {{ result.smartos_images[item]['clones']
}} VM(s)
with_items: "{{ result.smartos_images.keys() | list }}" with_items: "{{ result.smartos_images.keys() | list }}"
- name: Print information - name: Print information
ansible.builtin.debug: ansible.builtin.debug:
msg: "{{ smartos_images[item]['name'] }}-{{ smartos_images[item]['version'] }} has {{ smartos_images[item]['clones'] }} VM(s)" msg: >-
{{
smartos_images[item]['name'] }}-{{ smartos_images[item]['version'] }}
has {{ smartos_images[item]['clones']
}} VM(s)
with_items: "{{ smartos_images.keys() | list }}" with_items: "{{ smartos_images.keys() | list }}"
""" """

View file

@ -37,8 +37,8 @@ options:
state: state:
description: description:
- Desired state of the package. - Desired state of the package.
- When O(state=present) the module will use C(snap install) if the snap is not installed, and C(snap refresh) if it - When O(state=present) the module uses C(snap install) if the snap is not installed, and C(snap refresh) if it is installed
is installed but from a different channel. but from a different channel.
default: present default: present
choices: [absent, present, enabled, disabled] choices: [absent, present, enabled, disabled]
type: str type: str
@ -56,19 +56,19 @@ options:
description: description:
- Define which release of a snap is installed and tracked for updates. This option can only be specified if there is - Define which release of a snap is installed and tracked for updates. This option can only be specified if there is
a single snap in the task. a single snap in the task.
- If not passed, the C(snap) command will default to V(stable). - If not passed, the C(snap) command defaults to V(stable).
- If the value passed does not contain the C(track), it will default to C(latest). For example, if V(edge) is passed, - If the value passed does not contain the C(track), it defaults to C(latest). For example, if V(edge) is passed, the
the module will assume the channel to be V(latest/edge). module assumes the channel to be V(latest/edge).
- See U(https://snapcraft.io/docs/channels) for more details about snap channels. - See U(https://snapcraft.io/docs/channels) for more details about snap channels.
type: str type: str
required: false required: false
options: options:
description: description:
- Set options with pattern C(key=value) or C(snap:key=value). If a snap name is given, the option will be applied to - Set options with pattern C(key=value) or C(snap:key=value). If a snap name is given, the option is applied to that
that snap only. If the snap name is omitted, the options will be applied to all snaps listed in O(name). Options will snap only. If the snap name is omitted, the options are applied to all snaps listed in O(name). Options are only applied
only be applied to active snaps. to active snaps.
- Options will only be applied when C(state) is set to V(present). This is done after the necessary installation or - Options are only applied when C(state) is set to V(present). This is done after the necessary installation or refresh
refresh (upgrade/downgrade) of all the snaps listed in O(name). (upgrade/downgrade) of all the snaps listed in O(name).
- See U(https://snapcraft.io/docs/configuration-in-snaps) for more details about snap configuration options. - See U(https://snapcraft.io/docs/configuration-in-snaps) for more details about snap configuration options.
required: false required: false
type: list type: list

View file

@ -15,7 +15,7 @@ author:
- Patrick Ogenstad (@ogenstad) - Patrick Ogenstad (@ogenstad)
short_description: Retrieve facts for a device using SNMP short_description: Retrieve facts for a device using SNMP
description: description:
- Retrieve facts for a device using SNMP, the facts will be inserted to the C(ansible_facts) key. - Retrieve facts for a device using SNMP, the facts are inserted to the C(ansible_facts) key.
requirements: requirements:
- pysnmp - pysnmp
extends_documentation_fragment: extends_documentation_fragment:

View file

@ -51,7 +51,7 @@ options:
required: true required: true
path: path:
description: description:
- The path where the zone will be created. This is required when the zone is created, but not used otherwise. - The path where the zone is created. This is required when the zone is created, but not used otherwise.
type: str type: str
sparse: sparse:
description: description:
@ -60,7 +60,7 @@ options:
default: false default: false
root_password: root_password:
description: description:
- The password hash for the root account. If not specified, the zone's root account will not have a password. - The password hash for the root account. If not specified, the zone's root account does not have a password.
type: str type: str
config: config:
description: description:

View file

@ -34,7 +34,7 @@ options:
description: description:
- Name of the spell or grimoire. - Name of the spell or grimoire.
- Multiple names can be given, separated by commas. - Multiple names can be given, separated by commas.
- Special value V(*) in conjunction with states V(latest) or V(rebuild) will update or rebuild the whole system respectively. - Special value V(*) in conjunction with states V(latest) or V(rebuild) updates or rebuilds the whole system respectively.
- The alias O(grimoire) was added in community.general 7.3.0. - The alias O(grimoire) was added in community.general 7.3.0.
aliases: ["spell", "grimoire"] aliases: ["spell", "grimoire"]
type: list type: list
@ -44,7 +44,7 @@ options:
description: description:
- Repository location. - Repository location.
- If specified, O(name) represents grimoire(s) instead of spell(s). - If specified, O(name) represents grimoire(s) instead of spell(s).
- Special value V(*) will pull grimoire from the official location. - Special value V(*) pulls grimoire from the official location.
- Only single item in O(name) in conjunction with V(*) can be used. - Only single item in O(name) in conjunction with V(*) can be used.
- O(state=absent) must be used with a special value V(*). - O(state=absent) must be used with a special value V(*).
type: str type: str

View file

@ -30,7 +30,7 @@ options:
required: true required: true
description: description:
- IP address of the device. - IP address of the device.
- If a hostname is given, it will be resolved to the IP address. - If a hostname is given, it is resolved to the IP address.
community: community:
type: str type: str
description: description:
@ -69,13 +69,13 @@ options:
- Oneclick user password. - Oneclick user password.
use_proxy: use_proxy:
description: description:
- If V(false), it will not use a proxy, even if one is defined in an environment variable on the target hosts. - If V(false), it does not use a proxy, even if one is defined in an environment variable on the target hosts.
default: true default: true
type: bool type: bool
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.
default: true default: true
type: bool type: bool
agentport: agentport:
@ -85,8 +85,8 @@ options:
- UDP port used for SNMP discovery. - UDP port used for SNMP discovery.
default: 161 default: 161
notes: notes:
- The devices will be created inside the I(Universe) container of the specified landscape. - The devices are created inside the I(Universe) container of the specified landscape.
- All the operations will be performed only on the specified landscape. - All the operations are performed only on the specified landscape.
""" """
EXAMPLES = r""" EXAMPLES = r"""
@ -119,7 +119,12 @@ device:
description: Device data when O(state=present). description: Device data when O(state=present).
returned: success returned: success
type: dict type: dict
sample: {'model_handle': '0x1007ab', 'landscape': '0x100000', 'address': '10.10.5.1'} sample:
{
"model_handle": "0x1007ab",
"landscape": "0x100000",
"address": "10.10.5.1"
}
""" """
from socket import gethostbyname, gaierror from socket import gethostbyname, gaierror

View file

@ -47,7 +47,7 @@ options:
aliases: [password] aliases: [password]
use_proxy: use_proxy:
description: description:
- If V(false), it will not use a proxy, even if one is defined in an environment variable on the target hosts. - If V(false), it does not use a proxy, even if one is defined in an environment variable on the target hosts.
default: true default: true
required: false required: false
type: bool type: bool
@ -99,7 +99,7 @@ options:
- C(sysName) (C(0x10b5b)); - C(sysName) (C(0x10b5b));
- C(Vendor_Name) (C(0x11570)); - C(Vendor_Name) (C(0x11570));
- C(Description) (C(0x230017)). - C(Description) (C(0x230017)).
- Hex IDs are the direct identifiers in Spectrum and will always work. - Hex IDs are the direct identifiers in Spectrum and always work.
- 'To lookup hex IDs go to the UI: Locator -> Devices -> By Model Name -> <enter any model> -> Attributes tab.' - 'To lookup hex IDs go to the UI: Locator -> Devices -> By Model Name -> <enter any model> -> Attributes tab.'
type: str type: str
required: true required: true
@ -123,7 +123,9 @@ EXAMPLES = r"""
- name: "isManaged" - name: "isManaged"
value: "false" value: "false"
- name: "Notes" - name: "Notes"
value: "MM set on {{ ansible_date_time.iso8601 }} via CO {{ CO }} by {{ tower_user_name | default(ansible_user_id) }}" value: >-
MM set on {{ ansible_date_time.iso8601 }} via CO {{ CO }}
by {{ tower_user_name | default(ansible_user_id) }}
delegate_to: localhost delegate_to: localhost
register: spectrum_model_attrs_status register: spectrum_model_attrs_status
""" """

View file

@ -11,9 +11,9 @@ short_description: Create, update or delete Spotinst AWS Elastigroups
author: Spotinst (@talzur) author: Spotinst (@talzur)
description: description:
- Can create, update, or delete Spotinst AWS Elastigroups Launch configuration is part of the elastigroup configuration, - Can create, update, or delete Spotinst AWS Elastigroups Launch configuration is part of the elastigroup configuration,
so no additional modules are necessary for handling the launch configuration. You will have to have a credentials file so no additional modules are necessary for handling the launch configuration. You must have a credentials file in this
in this location - C($HOME/.spotinst/credentials). The credentials file must contain a row that looks like this C(token location - C($HOME/.spotinst/credentials). The credentials file must contain a row that looks like this C(token = <YOUR
= <YOUR TOKEN>). TOKEN>).
- Full documentation available at U(https://help.spotinst.com/hc/en-us/articles/115003530285-Ansible-). - Full documentation available at U(https://help.spotinst.com/hc/en-us/articles/115003530285-Ansible-).
requirements: requirements:
- spotinst_sdk >= 1.0.38 - spotinst_sdk >= 1.0.38
@ -41,8 +41,8 @@ options:
token: token:
description: description:
- A Personal API Access Token issued by Spotinst. - A Personal API Access Token issued by Spotinst.
- 'When not specified, the module will try to obtain it, in that order, from: environment variable E(SPOTINST_TOKEN), - When not specified, the module tries to obtain it, in that order, from environment variable E(SPOTINST_TOKEN), or
or from the credentials path.' from the credentials path.
type: str type: str
availability_vs_cost: availability_vs_cost:
@ -82,8 +82,7 @@ options:
ebs_optimized: ebs_optimized:
description: description:
- Enable EBS optimization for supported instances which are not enabled by default.; Note - additional charges will - Enable EBS optimization for supported instances which are not enabled by default. Note - additional charges are applied.
be applied.
type: bool type: bool
ebs_volume_pool: ebs_volume_pool:
@ -106,7 +105,7 @@ options:
fallback_to_od: fallback_to_od:
description: description:
- In case of no spots available, Elastigroup will launch an On-demand instance instead. - In case of no spots available, Elastigroup launches an On-demand instance instead.
type: bool type: bool
health_check_grace_period: health_check_grace_period:
@ -140,15 +139,15 @@ options:
id: id:
description: description:
- The group ID if it already exists and you want to update, or delete it. This will not work unless the uniqueness_by - The group ID if it already exists and you want to update, or delete it. This does not work unless the O(uniqueness_by)
field is set to ID. When this is set, and the uniqueness_by field is set, the group will either be updated or deleted, field is set to ID. When this is set, and the O(uniqueness_by) field is set, the group is either updated or deleted,
but not created. but not created.
type: str type: str
image_id: image_id:
description: description:
- The image ID used to launch the instance.; In case of conflict between Instance type and image type, an error will - The image ID used to launch the instance.; In case of conflict between Instance type and image type, an error is be
be returned. returned.
required: true required: true
type: str type: str
@ -214,13 +213,13 @@ options:
on_demand_count: on_demand_count:
description: description:
- Required if risk is not set. - Required if risk is not set.
- Number of on demand instances to launch. All other instances will be spot instances.; Either set this parameter or - Number of on demand instances to launch. All other instances are spot instances.; Either set this parameter or the
the risk parameter. O(risk) parameter.
type: int type: int
on_demand_instance_type: on_demand_instance_type:
description: description:
- On-demand instance type that will be provisioned. - On-demand instance type that is provisioned.
type: str type: str
opsworks: opsworks:
@ -278,7 +277,7 @@ options:
security_group_ids: security_group_ids:
description: description:
- One or more security group IDs. - One or more security group IDs.
- In case of update it will override the existing Security Group with the new given array. - In case of update it overrides the existing Security Group with the new given array.
required: true required: true
type: list type: list
elements: str elements: str
@ -302,7 +301,7 @@ options:
spot_instance_types: spot_instance_types:
description: description:
- Spot instance type that will be provisioned. - Spot instance type that is provisioned.
required: true required: true
type: list type: list
elements: str elements: str
@ -388,7 +387,7 @@ options:
- name - name
description: description:
- If your group names are not unique, you may use this feature to update or delete a specific group. Whenever this property - If your group names are not unique, you may use this feature to update or delete a specific group. Whenever this property
is set, you must set a group_id in order to update or delete a group, otherwise a group will be created. is set, you must set a group_id in order to update or delete a group, otherwise a group is created.
default: name default: name
type: str type: str
@ -399,7 +398,7 @@ options:
utilize_reserved_instances: utilize_reserved_instances:
description: description:
- In case of any available Reserved Instances, Elastigroup will utilize your reservations before purchasing Spot instances. - In case of any available Reserved Instances, Elastigroup utilizes your reservations before purchasing Spot instances.
type: bool type: bool
wait_for_instances: wait_for_instances:

View file

@ -38,7 +38,7 @@ options:
type: str type: str
domain: domain:
description: description:
- Specifies the name of the domain in which the object will reside. - Specifies the name of the domain in which the object resides.
type: str type: str
growth_increment: growth_increment:
description: description:
@ -46,7 +46,8 @@ options:
type: str type: str
growth_limit: growth_limit:
description: description:
- Specifies that the autogrow operation is limited to the specified storage amount that sets the growth limit(in MiB, GiB or TiB). - Specifies that the autogrow operation is limited to the specified storage amount that sets the growth limit (in MiB,
GiB or TiB).
type: str type: str
growth_warning: growth_warning:
description: description:

View file

@ -49,7 +49,7 @@ options:
host: host:
description: description:
- The endpoint this configuration is valid for. - The endpoint this configuration is valid for.
- Can be an actual address on the internet or an alias that will connect to the value of O(hostname). - It can be an actual address on the internet or an alias that connects to the value of O(hostname).
required: true required: true
type: str type: str
hostname: hostname:
@ -66,7 +66,7 @@ options:
type: str type: str
identity_file: identity_file:
description: description:
- The path to an identity file (SSH private key) that will be used when connecting to this host. - The path to an identity file (SSH private key) that is used when connecting to this host.
- File need to exist and have mode V(0600) to be valid. - File need to exist and have mode V(0600) to be valid.
type: path type: path
identities_only: identities_only:
@ -141,7 +141,7 @@ options:
version_added: 10.1.0 version_added: 10.1.0
other_options: other_options:
description: description:
- Provides the option to specify arbitrary SSH config entry options via a dictionary. - Allows specifying arbitrary SSH config entry options using a dictionary.
- The key names must be lower case. Keys with upper case values are rejected. - The key names must be lower case. Keys with upper case values are rejected.
- The values must be strings. Other values are rejected. - The values must be strings. Other values are rejected.
type: dict type: dict
@ -198,17 +198,22 @@ hosts_change_diff:
description: A list of host diff changes. description: A list of host diff changes.
returned: on change returned: on change
type: list type: list
sample: [ sample:
[
{ {
"example.com": { "example.com": {
"new": { "new": {
"hostname": "github.com", "hostname": "github.com",
"identityfile": ["/tmp/test_ssh_config/fake_id_rsa"], "identityfile": [
"/tmp/test_ssh_config/fake_id_rsa"
],
"port": "2224" "port": "2224"
}, },
"old": { "old": {
"hostname": "github.com", "hostname": "github.com",
"identityfile": ["/tmp/test_ssh_config/fake_id_rsa"], "identityfile": [
"/tmp/test_ssh_config/fake_id_rsa"
],
"port": "2224" "port": "2224"
} }
} }

View file

@ -119,25 +119,6 @@ EXAMPLES = r"""
state: absent state: absent
""" """
RETURN = r"""
changed:
description: Response to whether or not the API call completed successfully.
returned: always
type: bool
sample: true
stdout:
description: The set of responses from the commands.
returned: always
type: list
sample: ['...', '...']
stdout_lines:
description: The value of stdout split into a list.
returned: always
type: list
sample: [['...', '...'], ['...'], ['...']]
"""
import json import json

View file

@ -111,7 +111,7 @@ options:
minutes: minutes:
type: int type: int
description: description:
- The length of time in UTC that the maintenance will run (starting from playbook runtime). - The duration of the maintenance window (starting from playbook runtime).
default: 10 default: 10
start_date: start_date:
type: str type: str

View file

@ -42,7 +42,7 @@ options:
required: true required: true
description: description:
- The name of the sudoers rule. - The name of the sudoers rule.
- This will be used for the filename for the sudoers file managed by this rule. - This is used for the filename for the sudoers file managed by this rule.
type: str type: str
noexec: noexec:
description: description:
@ -69,12 +69,12 @@ options:
version_added: 6.2.0 version_added: 6.2.0
runas: runas:
description: description:
- Specify the target user the command(s) will run as. - Specify the target user the command(s) runs as.
type: str type: str
version_added: 4.7.0 version_added: 4.7.0
sudoers_path: sudoers_path:
description: description:
- The path which sudoers config files will be managed in. - The path which sudoers config files are managed in.
default: /etc/sudoers.d default: /etc/sudoers.d
type: str type: str
state: state:
@ -92,9 +92,9 @@ options:
type: str type: str
validation: validation:
description: description:
- If V(absent), the sudoers rule will be added without validation. - If V(absent), the sudoers rule is added without validation.
- If V(detect) and visudo is available, then the sudoers rule will be validated by visudo. - If V(detect) and C(visudo) is available, then the sudoers rule is validated by C(visudo).
- If V(required), visudo must be available to validate the sudoers rule. - If V(required), C(visudo) must be available to validate the sudoers rule.
type: str type: str
default: detect default: detect
choices: [absent, detect, required] choices: [absent, detect, required]

View file

@ -26,8 +26,8 @@ options:
type: str type: str
description: description:
- The name of the supervisord program or group to manage. - The name of the supervisord program or group to manage.
- The name will be taken as group name when it ends with a colon V(:). - The name is taken as group name when it ends with a colon V(:).
- If O(name=all), all programs and program groups will be managed. - If O(name=all), all programs and program groups are managed.
required: true required: true
config: config:
type: path type: path
@ -67,12 +67,11 @@ options:
description: description:
- Path to C(supervisorctl) executable. - Path to C(supervisorctl) executable.
notes: notes:
- When O(state=present), the module will call C(supervisorctl reread) then C(supervisorctl add) if the program/group does - When O(state=present), the module calls C(supervisorctl reread) then C(supervisorctl add) if the program/group does not
not exist. exist.
- When O(state=restarted), the module will call C(supervisorctl update) then call C(supervisorctl restart). - When O(state=restarted), the module calls C(supervisorctl update) then calls C(supervisorctl restart).
- When O(state=absent), the module will call C(supervisorctl reread) then C(supervisorctl remove) to remove the target program/group. - When O(state=absent), the module calls C(supervisorctl reread) then C(supervisorctl remove) to remove the target program/group.
If the program/group is still running, the action will fail. If you want to stop the program/group before removing, use If the program/group is still running, the action fails. If you want to stop the program/group before removing, use O(stop_before_removing=true).
O(stop_before_removing=true).
requirements: ["supervisorctl"] requirements: ["supervisorctl"]
author: author:
- "Matt Wright (@mattupstate)" - "Matt Wright (@mattupstate)"

View file

@ -30,10 +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(started)/V(stopped) are idempotent actions that do not run commands unless necessary.
- V(restarted) will always bounce the svc (svc -t) and V(killed) will always bounce the svc (svc -k). - V(restarted) always bounces the svc (svc -t) and V(killed) always bounces the svc (svc -k).
- V(reloaded) will send a sigusr1 (svc -1). - V(reloaded) sends a sigusr1 (svc -1).
- V(once) will run a normally downed svc once (svc -o), not really an idempotent operation. - V(once) runs a normally downed svc once (svc -o), not really an idempotent operation.
type: str type: str
choices: [killed, once, reloaded, restarted, started, stopped] choices: [killed, once, reloaded, restarted, started, stopped]
downed: downed:

View file

@ -16,7 +16,7 @@ short_description: Manage Solaris SVR4 packages
description: description:
- Manages SVR4 packages on Solaris 10 and 11. - Manages SVR4 packages on Solaris 10 and 11.
- These were the native packages on Solaris <= 10 and are available as a legacy feature in Solaris 11. - These were the native packages on Solaris <= 10 and are available as a legacy feature in Solaris 11.
- Note that this is a very basic packaging system. It will not enforce dependencies on install or remove. - Note that this is a very basic packaging system. It does not enforce dependencies on install or remove.
author: "Boyd Adamson (@brontitall)" author: "Boyd Adamson (@brontitall)"
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes

View file

@ -16,7 +16,7 @@ DOCUMENTATION = r"""
module: swdepot module: swdepot
short_description: Manage packages with swdepot package manager (HP-UX) short_description: Manage packages with swdepot package manager (HP-UX)
description: description:
- Will install, upgrade and remove packages with swdepot package manager (HP-UX). - Installs, upgrades, and removes packages with C(swdepot) package manager (HP-UX).
notes: [] notes: []
author: "Raul Melo (@melodous)" author: "Raul Melo (@melodous)"
extends_documentation_fragment: extends_documentation_fragment:

View file

@ -14,13 +14,13 @@ short_description: Gather C(systemd) unit info
description: description:
- This module gathers info about systemd units (services, targets, sockets, mounts, timers). - This module gathers info about systemd units (services, targets, sockets, mounts, timers).
- Timer units are supported since community.general 10.5.0. - Timer units are supported since community.general 10.5.0.
- It runs C(systemctl list-units) (or processes selected units) and collects properties - It runs C(systemctl list-units) (or processes selected units) and collects properties for each unit using C(systemctl
for each unit using C(systemctl show). show).
- In case a unit has multiple properties with the same name, only the value of the first one will be collected. - In case a unit has multiple properties with the same name, only the value of the first one is collected.
- Even if a unit has a RV(units.loadstate) of V(not-found) or V(masked), it is returned, - Even if a unit has a RV(units.loadstate) of V(not-found) or V(masked), it is returned, but only with the minimal properties
but only with the minimal properties (RV(units.name), RV(units.loadstate), RV(units.activestate), RV(units.substate)). (RV(units.name), RV(units.loadstate), RV(units.activestate), RV(units.substate)).
- When O(unitname) and O(extra_properties) are used, the module first checks if the unit exists, - When O(unitname) and O(extra_properties) are used, the module first checks if the unit exists, then check if properties
then check if properties exist. If not, the module fails. exist. If not, the module fails.
- When O(unitname) is used with wildcard expressions, the module checks for units that match the indicated expressions, - When O(unitname) is used with wildcard expressions, the module checks for units that match the indicated expressions,
if units are not present for all the indicated expressions, the module fails. if units are not present for all the indicated expressions, the module fails.
version_added: "10.4.0" version_added: "10.4.0"
@ -89,7 +89,7 @@ RETURN = r"""
units: units:
description: description:
- Dictionary of systemd unit info keyed by unit name. - Dictionary of systemd unit info keyed by unit name.
- Additional fields will be returned depending on the value of O(extra_properties). - Additional fields are returned depending on the value of O(extra_properties).
returned: success returned: success
type: dict type: dict
elements: dict elements: dict
@ -116,7 +116,8 @@ units:
substate: substate:
description: description:
- The detailed sub state of the unit. - The detailed sub state of the unit.
- The most common values are V(running), V(dead), V(exited), V(failed), V(listening), V(active), and V(mounted), but other values are possible as well. - The most common values are V(running), V(dead), V(exited), V(failed), V(listening), V(active), and V(mounted), but
other values are possible as well.
returned: always returned: always
type: str type: str
sample: running sample: running

View file

@ -25,7 +25,7 @@ options:
snapshot: snapshot:
description: description:
- Apply the latest snapshot. - Apply the latest snapshot.
- Otherwise release will be applied. - Otherwise release is applied.
default: false default: false
type: bool type: bool
force: force:
@ -36,14 +36,13 @@ options:
keep_files: keep_files:
description: description:
- Keep the files under C(/home/_sysupgrade). - Keep the files under C(/home/_sysupgrade).
- By default, the files will be deleted after the upgrade. - By default, the files are deleted after the upgrade.
default: false default: false
type: bool type: bool
fetch_only: fetch_only:
description: description:
- Fetch and verify files and create C(/bsd.upgrade) but do not reboot. - Fetch and verify files and create C(/bsd.upgrade) but do not reboot.
- Set to V(false) if you want C(sysupgrade) to reboot. This will cause Ansible to error, as it expects the module to - Set to V(false) if you want C(sysupgrade) to reboot. This causes the module to fail. See the examples.
exit gracefully. See the examples.
default: true default: true
type: bool type: bool
installurl: installurl: