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

st*: style adjustments (#9516) 

* st*: style adjustments

* lien lenght adjustments
pull/9534/head
Alexei Znamensky 2025-01-04 08:00:45 +13:00 committed by GitHub
parent d7da0ae7f6
commit 695b1abc8d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
28 changed files with 310 additions and 290 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
plugins/modules/shutdown.py
View File

@ -12,10 +12,10 @@ DOCUMENTATION = r"""
module: shutdown module: shutdown
short_description: Shut down a machine short_description: Shut down a machine
notes: notes:
- E(PATH) is ignored on the remote node when searching for the C(shutdown) command. Use O(search_paths) to specify locations to search if the - E(PATH) is ignored on the remote node when searching for the C(shutdown) command. Use O(search_paths) to specify locations
default paths do not work. to search if the default paths do not work.
- The O(msg) and O(delay) options are not supported when a shutdown command is not found in O(search_paths), instead the module will attempt - The O(msg) and O(delay) options are not supported when a shutdown command is not found in O(search_paths), instead the
to shutdown the system by calling C(systemctl shutdown). module attempts to shutdown the system by calling C(systemctl shutdown).
description: description:
- Shut downs a machine. - Shut downs a machine.
version_added: "1.1.0" version_added: "1.1.0"
@ -35,8 +35,8 @@ options:
delay: delay:
description: description:
- Seconds to wait before shutdown. Passed as a parameter to the shutdown command. - Seconds to wait before shutdown. Passed as a parameter to the shutdown command.
- On Linux, macOS and OpenBSD, this is converted to minutes and rounded down. If less than 60, it will be set to 0. - On Linux, macOS and OpenBSD, this is converted to minutes and rounded down. If less than 60, it is set to 0.
- On Solaris and FreeBSD, this will be seconds. - On Solaris and FreeBSD, this represents seconds.
type: int type: int
default: 0 default: 0
msg: msg:
@ -47,8 +47,8 @@ options:
search_paths: search_paths:
description: description:
- Paths to search on the remote machine for the C(shutdown) command. - Paths to search on the remote machine for the C(shutdown) command.
- I(Only) these paths will be searched for the C(shutdown) command. E(PATH) is ignored in the remote node when searching for the C(shutdown) - I(Only) these paths are searched for the C(shutdown) command. E(PATH) is ignored in the remote node when searching
command. for the C(shutdown) command.
type: list type: list
elements: path elements: path
default: ['/sbin', '/usr/sbin', '/usr/local/sbin'] default: ['/sbin', '/usr/sbin', '/usr/local/sbin']

6
plugins/modules/simpleinit_msb.py
View File

@ -39,10 +39,10 @@ options:
required: false required: false
choices: [running, started, stopped, restarted, reloaded] choices: [running, started, stopped, restarted, reloaded]
description: description:
- V(started)/V(stopped) are idempotent actions that will not run commands unless necessary. V(restarted) will always bounce the service. - V(started)/V(stopped) are idempotent actions that do not run commands unless necessary. V(restarted) always bounces
V(reloaded) will always reload. the service. V(reloaded) always reloads.
- At least one of O(state) and O(enabled) are required. - At least one of O(state) and O(enabled) are required.
- Note that V(reloaded) will start the service if it is not already started, even if your chosen init system would not normally. - Note that V(reloaded) starts the service if it is not already started, even if your chosen init system would not normally.
enabled: enabled:
type: bool type: bool
required: false required: false

4
plugins/modules/sl_vm.py
View File

@ -24,7 +24,7 @@ attributes:
options: options:
instance_id: instance_id:
description: description:
- Instance Id of the virtual instance to perform action option. - Instance ID of the virtual instance to perform action option.
type: str type: str
hostname: hostname:
description: description:
@ -146,7 +146,7 @@ options:
type: str type: str
ssh_keys: ssh_keys:
description: description:
- List of ssh keys by their Id to be assigned to a virtual instance. - List of ssh keys by their ID to be assigned to a virtual instance.
type: list type: list
elements: str elements: str
default: [] default: []

65
plugins/modules/slack.py
View File

@ -32,29 +32,31 @@ options:
domain: domain:
type: str type: str
description: description:
- Slack (sub)domain for your environment without protocol. (For example V(example.slack.com).) In Ansible 1.8 and beyond, this is deprecated - Slack (sub)domain for your environment without protocol. (For example V(example.slack.com).) In Ansible 1.8 and beyond,
and may be ignored. See token documentation for information. 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, depending on what method - Slack integration token. This authenticates you to the slack service. Make sure to use the correct type of token,
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, Ansible adapts to the - 'Webhook token: Prior to Ansible 1.8, a token looked like V(3Ffe373sfhRE6y42Fg3rvf4GlK). In Ansible 1.8 and above,
new slack API where tokens look like V(G922VJP24/D921DW937/3Ffe373sfhRE6y42Fg3rvf4GlK). If tokens are in the new format then slack will Ansible adapts to the new slack API where tokens look like V(G922VJP24/D921DW937/3Ffe373sfhRE6y42Fg3rvf4GlK). If tokens
ignore any value of domain. If the token is in the old format the domain is required. Ansible has no control of when slack will get rid are in the new format then slack will ignore any value of domain. If the token is in the old format the domain is
of the old API. When slack does that the old format will stop working. ** Please keep in mind the tokens are not the API tokens but are required. Ansible has no control of when slack will get rid of the old API. When slack does that the old format will
the webhook tokens. In slack these are found in the webhook URL which are obtained under the apps and integrations. The incoming webhooks stop working. ** Please keep in mind the tokens are not the API tokens but are the webhook tokens. In slack these
can be added in that area. In some cases this may be locked by your Slack admin and you must request access. It is there that the incoming are found in the webhook URL which are obtained under the apps and integrations. The incoming webhooks can be added
webhooks can be added. The key is on the end of the URL given to you in that section.' in that area. In some cases this may be locked by your Slack admin and you must request access. It is there that the
- "WebAPI token: Slack WebAPI requires a personal, bot or work application token. These tokens start with V(xoxp-), V(xoxb-) or V(xoxa-), incoming webhooks can be added. The key is on the end of the URL given to you in that section.'
for example V(xoxb-1234-56789abcdefghijklmnop). WebAPI token is required if you intend to receive thread_id. See Slack's documentation - "WebAPI token: Slack WebAPI requires a personal, bot or work application token. These tokens start with V(xoxp-),
(U(https://api.slack.com/docs/token-types)) for more information." 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."
required: true required: true
msg: msg:
type: str type: str
description: description:
- Message to send. Note that the module does not handle escaping characters. Plain-text angle brackets and ampersands should be converted - Message to send. Note that the module does not handle escaping characters. Plain-text angle brackets and ampersands
to HTML entities (for example C(&) to C(&)) before sending. See Slack's documentation (U(https://api.slack.com/docs/message-formatting)) for more. should be converted to HTML entities (for example C(&) to C(&)) before sending. See Slack's documentation
(U(https://api.slack.com/docs/message-formatting)) for more.
channel: channel:
type: str type: str
description: description:
@ -66,8 +68,8 @@ options:
message_id: message_id:
description: description:
- Optional. Message ID to edit, instead of posting a new message. - Optional. Message ID to edit, instead of posting a new message.
- If supplied O(channel) must be in form of C(C0xxxxxxx). use C({{ slack_response.channel }}) to get RV(ignore:channel) from previous task - If supplied O(channel) must be in form of C(C0xxxxxxx). use C({{ slack_response.channel }}) to get RV(ignore:channel)
run. from previous task run.
- The token needs history scope to get information on the message to edit (C(channels:history,groups:history,mpim:history,im:history)). - The token needs history scope to get information on the message to edit (C(channels:history,groups:history,mpim:history,im:history)).
- Corresponds to C(ts) in the Slack API (U(https://api.slack.com/messaging/modifying)). - Corresponds to C(ts) in the Slack API (U(https://api.slack.com/messaging/modifying)).
type: str type: str
@ -104,14 +106,17 @@ 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 self-signed certificates. - If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using
self-signed certificates.
type: bool type: bool
default: true default: true
color: color:
type: str type: str
description: description:
- Allow text to use default colors - use the default of 'normal' to not send a custom color bar at the start of the message. - Allow text to use default colors - use the default of V(normal) to not send a custom color bar at the start of the
- Allowed values for color can be one of 'normal', 'good', 'warning', 'danger', any valid 3 digit or 6 digit hex color value. message.
- Allowed values for color can be one of V(normal), V(good), V(warning), V(danger), any valid 3 digit or 6 digit hex
color value.
default: 'normal' default: 'normal'
attachments: attachments:
type: list type: list
@ -130,14 +135,13 @@ options:
type: str type: str
description: description:
- 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 prefixes only cover - 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
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 prefixes only cover a small set of the prefixes that should not have a V(#) prepended. Since an exact condition which
V(#) prefix is not known, the value V(auto) for this option will be deprecated in the future. It is best to explicitly set O(prepend_hash=always) O(channel) values must not have the V(#) prefix is not known, the value V(auto) for this option will be deprecated
or O(prepend_hash=never) to obtain the needed behavior. in the 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. - The B(current default) is V(auto), which has been B(deprecated) since community.general 10.2.0. It will change to
It will change to V(never) in community.general 12.0.0. V(never) in community.general 12.0.0. To prevent deprecation warnings you can explicitly set O(prepend_hash) to the
To prevent deprecation warnings you can explicitly set O(prepend_hash) to the value you want. value you want. We suggest to only use V(always) or V(never), but not V(auto), when explicitly setting a value.
We suggest to only use V(always) or V(never), but not V(auto), when explicitly setting a value.
choices: choices:
- 'always' - 'always'
- 'never' - 'never'
@ -164,7 +168,8 @@ EXAMPLES = r"""
parse: 'none' parse: 'none'
delegate_to: localhost delegate_to: localhost
- name: Insert a color bar in front of the message for visibility purposes and use the default webhook icon and name configured in Slack - name: Insert a color bar in front of the message for visibility purposes and use the default webhook icon and name configured
in Slack
community.general.slack: community.general.slack:
token: thetoken/generatedby/slack token: thetoken/generatedby/slack
msg: '{{ inventory_hostname }} is alive!' msg: '{{ inventory_hostname }} is alive!'

3
plugins/modules/smartos_image_info.py
View File

@ -25,7 +25,8 @@ attributes:
options: options:
filters: filters:
description: description:
- Criteria for selecting image. Can be any value from image manifest and V(published_date), V(published), V(source), V(clones), and V(size). - Criteria for selecting image. Can be any value from image manifest and V(published_date), V(published), V(source),
V(clones), and V(size).
- More information can be found at U(https://smartos.org/man/1m/imgadm) under C(imgadm list). - More information can be found at U(https://smartos.org/man/1m/imgadm) under C(imgadm list).
type: str type: str
""" """

29
plugins/modules/snap.py
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 is installed but from - When O(state=present) the module will use C(snap install) if the snap is not installed, and C(snap refresh) if it
a different channel. is installed but from a different channel.
default: present default: present
choices: [absent, present, enabled, disabled] choices: [absent, present, enabled, disabled]
type: str type: str
@ -46,28 +46,29 @@ options:
description: description:
- Install a snap that has classic confinement. - Install a snap that has classic confinement.
- This option corresponds to the C(--classic) argument of the C(snap install) command. - This option corresponds to the C(--classic) argument of the C(snap install) command.
- This level of confinement is permissive, granting full system access, similar to that of traditionally packaged applications that do not - This level of confinement is permissive, granting full system access, similar to that of traditionally packaged applications
use sandboxing mechanisms. This option can only be specified when the task involves a single snap. that do not use sandboxing mechanisms. This option can only be specified when the task involves a single snap.
- See U(https://snapcraft.io/docs/snap-confinement) for more details about classic confinement and confinement levels. - See U(https://snapcraft.io/docs/snap-confinement) for more details about classic confinement and confinement levels.
type: bool type: bool
required: false required: false
default: false default: false
channel: channel:
description: description:
- 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 - Define which release of a snap is installed and tracked for updates. This option can only be specified if there is
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 will default 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, the module will assume - If the value passed does not contain the C(track), it will default to C(latest). For example, if V(edge) is passed,
the channel to be V(latest/edge). the module will assume 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 that snap only. If - Set options with pattern C(key=value) or C(snap:key=value). If a snap name is given, the option will be applied to
the snap name is omitted, the options will be applied to all snaps listed in O(name). Options will only be applied to active snaps. that snap only. If the snap name is omitted, the options will be applied to all snaps listed in O(name). Options will
- Options will only be applied when C(state) is set to V(present). This is done after the necessary installation or refresh (upgrade/downgrade) only be applied to active snaps.
of all the snaps listed in O(name). - Options will only be applied when C(state) is set to V(present). This is done after the necessary installation or
refresh (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
@ -83,8 +84,8 @@ options:
default: false default: false
version_added: 7.2.0 version_added: 7.2.0
notes: notes:
- Privileged operations, such as installing and configuring snaps, require root priviledges. This is only the case if the user has not logged - Privileged operations, such as installing and configuring snaps, require root priviledges. This is only the case if the
in to the Snap Store. user has not logged in to the Snap Store.
author: author:
- Victor Carceler (@vcarceler) <vcarceler@iespuigcastellar.xeill.net> - Victor Carceler (@vcarceler) <vcarceler@iespuigcastellar.xeill.net>
- Stanislas Lange (@angristan) <angristan@pm.me> - Stanislas Lange (@angristan) <angristan@pm.me>

3
plugins/modules/snmp_facts.py
View File

@ -125,7 +125,8 @@ ansible_sysuptime:
type: int type: int
sample: 42388 sample: 42388
ansible_syscontact: ansible_syscontact:
description: The textual identification of the contact person for this managed node, together with information on how to contact this person. description: The textual identification of the contact person for this managed node, together with information on how to
contact this person.
returned: success returned: success
type: str type: str
sample: Me <me@example.org> sample: Me <me@example.org>

13
plugins/modules/solaris_zone.py
View File

@ -64,8 +64,9 @@ options:
type: str type: str
config: config:
description: description:
- The C(zonecfg) configuration commands for this zone. See zonecfg(1M) for the valid options and syntax. Typically this is a list of options - The C(zonecfg) configuration commands for this zone. See zonecfg(1M) for the valid options and syntax. Typically this
separated by semi-colons or new lines, for example V(set auto-boot=true;add net;set physical=bge0;set address=10.1.1.1;end). is a list of options separated by semi-colons or new lines, for example V(set auto-boot=true;add net;set physical=bge0;set
address=10.1.1.1;end).
type: str type: str
default: '' default: ''
create_options: create_options:
@ -75,14 +76,14 @@ options:
default: '' default: ''
install_options: install_options:
description: description:
- Extra options to the zoneadm(1M) install command. To automate Solaris 11 zone creation, use this to specify the profile XML file, for example - Extra options to the zoneadm(1M) install command. To automate Solaris 11 zone creation, use this to specify the profile
O(install_options=-c sc_profile.xml). XML file, for example O(install_options=-c sc_profile.xml).
type: str type: str
default: '' default: ''
attach_options: attach_options:
description: description:
- Extra options to the zoneadm attach command. For example, this can be used to specify whether a minimum or full update of packages is - Extra options to the zoneadm attach command. For example, this can be used to specify whether a minimum or full update
required and if any packages need to be deleted. For valid values, see zoneadm(1M). of packages is required and if any packages need to be deleted. For valid values, see zoneadm(1M).
type: str type: str
default: '' default: ''
timeout: timeout:

7
plugins/modules/sorcery.py
View File

@ -17,7 +17,8 @@ description:
- Manages "spells" on Source Mage GNU/Linux using I(sorcery) toolchain. - Manages "spells" on Source Mage GNU/Linux using I(sorcery) toolchain.
author: "Vlad Glagolev (@vaygr)" author: "Vlad Glagolev (@vaygr)"
notes: notes:
- When all three components are selected, the update goes by the sequence -- Sorcery -> Grimoire(s) -> Spell(s); you cannot override it. - When all three components are selected, the update goes by the sequence -- Sorcery -> Grimoire(s) -> Spell(s); you cannot
override it.
- Grimoire handling is supported since community.general 7.3.0. - Grimoire handling is supported since community.general 7.3.0.
requirements: requirements:
- bash - bash
@ -60,8 +61,8 @@ options:
depends: depends:
description: description:
- Comma-separated list of _optional_ dependencies to build a spell (or make sure it is built) with; use V(+)/V(-) in front of dependency - Comma-separated list of _optional_ dependencies to build a spell (or make sure it is built) with; use V(+)/V(-) in
to turn it on/off (V(+) is optional though). front of dependency to turn it on/off (V(+) is optional though).
- This option is ignored if O(name) parameter is equal to V(*) or contains more than one spell. - This option is ignored if O(name) parameter is equal to V(*) or contains more than one spell.
- Providers must be supplied in the form recognized by Sorcery, for example 'V(openssl(SSL\))'. - Providers must be supplied in the form recognized by Sorcery, for example 'V(openssl(SSL\))'.
type: str type: str

3
plugins/modules/spectrum_device.py
View File

@ -74,7 +74,8 @@ options:
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 self-signed certificates. - If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using
self-signed certificates.
default: true default: true
type: bool type: bool
agentport: agentport:

4
plugins/modules/spectrum_model_attrs.py
View File

@ -63,8 +63,8 @@ options:
required: true required: true
validate_certs: validate_certs:
description: description:
- Validate SSL certificates. Only change this to V(false) if you can guarantee that you are talking to the correct endpoint and there is - Validate SSL certificates. Only change this to V(false) if you can guarantee that you are talking to the correct endpoint
no man-in-the-middle attack happening. and there is no man-in-the-middle attack happening.
type: bool type: bool
default: true default: true
required: false required: false

121
plugins/modules/spotinst_aws_elastigroup.py
View File

@ -10,9 +10,10 @@ module: spotinst_aws_elastigroup
short_description: Create, update or delete Spotinst AWS Elastigroups 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, so no additional modules - Can create, update, or delete Spotinst AWS Elastigroups Launch configuration is part of the elastigroup configuration,
are necessary for handling the launch configuration. You will have to have a credentials file in this location - C($HOME/.spotinst/credentials). so no additional modules are necessary for handling the launch configuration. You will have to have a credentials file
The credentials file must contain a row that looks like this C(token = <YOUR TOKEN>). in this location - C($HOME/.spotinst/credentials). The credentials file must contain a row that looks like this C(token
= <YOUR 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
@ -40,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), or from the credentials - 'When not specified, the module will try to obtain it, in that order, from: environment variable E(SPOTINST_TOKEN),
path.' or from the credentials path.'
type: str type: str
availability_vs_cost: availability_vs_cost:
@ -53,24 +54,25 @@ options:
availability_zones: availability_zones:
description: description:
- A list of hash/dictionaries of Availability Zones that are configured in the elastigroup; '[{"key":"value", "key":"value"}]'; keys allowed - A list of hash/dictionaries of Availability Zones that are configured in the elastigroup; '[{"key":"value", "key":"value"}]';
are name (String), subnet_id (String), placement_group_name (String),. keys allowed are name (String), subnet_id (String), placement_group_name (String),.
required: true required: true
type: list type: list
elements: dict elements: dict
block_device_mappings: block_device_mappings:
description: description:
- A list of hash/dictionaries of Block Device Mappings for elastigroup instances; You can specify virtual devices and EBS volumes.; '[{"key":"value", - A list of hash/dictionaries of Block Device Mappings for elastigroup instances; You can specify virtual devices and
"key":"value"}]'; keys allowed are device_name (List of Strings), virtual_name (String), no_device (String), ebs (Object, expects the EBS volumes.; '[{"key":"value", "key":"value"}]'; keys allowed are device_name (List of Strings), virtual_name (String),
following keys- delete_on_termination(Boolean), encrypted(Boolean), iops (Integer), snapshot_id(Integer), volume_type(String), volume_size(Integer)). no_device (String), ebs (Object, expects the following keys- delete_on_termination(Boolean), encrypted(Boolean), iops
(Integer), snapshot_id(Integer), volume_type(String), volume_size(Integer)).
type: list type: list
elements: dict elements: dict
chef: chef:
description: description:
- The Chef integration configuration.; Expects the following keys - chef_server (String), organization (String), user (String), pem_key - The Chef integration configuration.; Expects the following keys - chef_server (String), organization (String), user
(String), chef_version (String). (String), pem_key (String), chef_version (String).
type: dict type: dict
draining_timeout: draining_timeout:
@ -80,13 +82,14 @@ options:
ebs_optimized: ebs_optimized:
description: description:
- Enable EBS optimization for supported instances which are not enabled by default.; Note - additional charges will be applied. - Enable EBS optimization for supported instances which are not enabled by default.; Note - additional charges will
be applied.
type: bool type: bool
ebs_volume_pool: ebs_volume_pool:
description: description:
- A list of hash/dictionaries of EBS devices to reattach to the elastigroup when available; '[{"key":"value", "key":"value"}]'; keys allowed - A list of hash/dictionaries of EBS devices to reattach to the elastigroup when available; '[{"key":"value", "key":"value"}]';
are - volume_ids (List of Strings), device_name (String). keys allowed are - volume_ids (List of Strings), device_name (String).
type: list type: list
elements: dict elements: dict
@ -97,7 +100,7 @@ options:
elastic_ips: elastic_ips:
description: description:
- List of ElasticIps Allocation Ids (example V(eipalloc-9d4e16f8)) to associate to the group instances. - List of ElasticIps Allocation IDs (example V(eipalloc-9d4e16f8)) to associate to the group instances.
type: list type: list
elements: str elements: str
@ -137,13 +140,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 field is set to id. - The group ID if it already exists and you want to update, or delete it. This will not work unless the uniqueness_by
When this is set, and the uniqueness_by field is set, the group will either be updated or deleted, but not created. field is set to ID. When this is set, and the uniqueness_by field is set, the group will either be updated or deleted,
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 be returned. - The image ID used to launch the instance.; In case of conflict between Instance type and image type, an error will
be returned.
required: true required: true
type: str type: str
@ -198,17 +203,19 @@ options:
network_interfaces: network_interfaces:
description: description:
- A list of hash/dictionaries of network interfaces to add to the elastigroup; '[{"key":"value", "key":"value"}]'; keys allowed are - description - A list of hash/dictionaries of network interfaces to add to the elastigroup; '[{"key":"value", "key":"value"}]'; keys
(String), device_index (Integer), secondary_private_ip_address_count (Integer), associate_public_ip_address (Boolean), delete_on_termination allowed are - description (String), device_index (Integer), secondary_private_ip_address_count (Integer), associate_public_ip_address
(Boolean), groups (List of Strings), network_interface_id (String), private_ip_address (String), subnet_id (String), associate_ipv6_address (Boolean), delete_on_termination (Boolean), groups (List of Strings), network_interface_id (String), private_ip_address
(Boolean), private_ip_addresses (List of Objects, Keys are privateIpAddress (String, required) and primary (Boolean)). (String), subnet_id (String), associate_ipv6_address (Boolean), private_ip_addresses (List of Objects, Keys are privateIpAddress
(String, required) and primary (Boolean)).
type: list type: list
elements: dict elements: dict
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 the risk parameter. - Number of on demand instances to launch. All other instances will be spot instances.; Either set this parameter or
the risk parameter.
type: int type: int
on_demand_instance_type: on_demand_instance_type:
@ -230,14 +237,15 @@ options:
product: product:
description: description:
- Operation system type. - Operation system type.
- 'Available choices are: V(Linux/UNIX), V(SUSE Linux), V(Windows), V(Linux/UNIX (Amazon VPC)), V(SUSE Linux (Amazon VPC)).' - 'Available choices are: V(Linux/UNIX), V(SUSE Linux), V(Windows), V(Linux/UNIX (Amazon VPC)), V(SUSE Linux (Amazon
VPC)).'
required: true required: true
type: str type: str
rancher: rancher:
description: description:
- The Rancher integration configuration.; Expects the following keys - version (String), access_key (String), secret_key (String), master_host - The Rancher integration configuration.; Expects the following keys - version (String), access_key (String), secret_key
(String). (String), master_host (String).
type: dict type: dict
right_scale: right_scale:
@ -254,15 +262,16 @@ options:
description: description:
- Roll configuration. - Roll configuration.
- If you would like the group to roll after updating, please use this feature. - If you would like the group to roll after updating, please use this feature.
- Accepts the following keys - batch_size_percentage(Integer, Required), grace_period - (Integer, Required), health_check_type(String, Optional). - Accepts the following keys - batch_size_percentage(Integer, Required), grace_period - (Integer, Required), health_check_type(String,
Optional).
type: dict type: dict
scheduled_tasks: scheduled_tasks:
description: description:
- A list of hash/dictionaries of scheduled tasks to configure in the elastigroup, as in V([{"key":"value", "key":"value"}]). - A list of hash/dictionaries of scheduled tasks to configure in the elastigroup, as in V([{"key":"value", "key":"value"}]).
- 'Keys allowed are: adjustment (Integer), scale_target_capacity (Integer), scale_min_capacity (Integer), scale_max_capacity (Integer), - 'Keys allowed are: adjustment (Integer), scale_target_capacity (Integer), scale_min_capacity (Integer), scale_max_capacity
adjustment_percentage (Integer), batch_size_percentage (Integer), cron_expression (String), frequency (String), grace_period (Integer), (Integer), adjustment_percentage (Integer), batch_size_percentage (Integer), cron_expression (String), frequency (String),
task_type (String, required), is_enabled (Boolean).' grace_period (Integer), task_type (String, required), is_enabled (Boolean).'
type: list type: list
elements: dict elements: dict
@ -281,7 +290,8 @@ options:
signals: signals:
description: description:
- A list of hash/dictionaries of signals to configure in the elastigroup; keys allowed are - name (String, required), timeout (Integer). - A list of hash/dictionaries of signals to configure in the elastigroup; keys allowed are - name (String, required),
timeout (Integer).
type: list type: list
elements: dict elements: dict
@ -343,29 +353,32 @@ options:
up_scaling_policies: up_scaling_policies:
description: description:
- A list of hash/dictionaries of scaling policies to configure in the elastigroup; '[{"key":"value", "key":"value"}]'; keys allowed are - A list of hash/dictionaries of scaling policies to configure in the elastigroup; '[{"key":"value", "key":"value"}]';
- policy_name (String, required), namespace (String, required), metric_name (String, required), dimensions (List of Objects, Keys allowed keys allowed are - policy_name (String, required), namespace (String, required), metric_name (String, required), dimensions
are name (String, required) and value (String)), statistic (String, required) evaluation_periods (String, required), period (String, required), (List of Objects, Keys allowed are name (String, required) and value (String)), statistic (String, required) evaluation_periods
threshold (String, required), cooldown (String, required), unit (String, required), operator (String, required), action_type (String, (String, required), period (String, required), threshold (String, required), cooldown (String, required), unit (String,
required), adjustment (String), min_target_capacity (String), target (String), maximum (String), minimum (String). required), operator (String, required), action_type (String, required), adjustment (String), min_target_capacity (String),
target (String), maximum (String), minimum (String).
type: list type: list
elements: dict elements: dict
down_scaling_policies: down_scaling_policies:
description: description:
- A list of hash/dictionaries of scaling policies to configure in the elastigroup; '[{"key":"value", "key":"value"}]'; keys allowed are - A list of hash/dictionaries of scaling policies to configure in the elastigroup; '[{"key":"value", "key":"value"}]';
- policy_name (String, required), namespace (String, required), metric_name (String, required), dimensions ((List of Objects), Keys allowed keys allowed are - policy_name (String, required), namespace (String, required), metric_name (String, required), dimensions
are name (String, required) and value (String)), statistic (String, required), evaluation_periods (String, required), period (String, ((List of Objects), Keys allowed are name (String, required) and value (String)), statistic (String, required), evaluation_periods
required), threshold (String, required), cooldown (String, required), unit (String, required), operator (String, required), action_type (String, required), period (String, required), threshold (String, required), cooldown (String, required), unit (String,
(String, required), adjustment (String), max_target_capacity (String), target (String), maximum (String), minimum (String). required), operator (String, required), action_type (String, required), adjustment (String), max_target_capacity (String),
target (String), maximum (String), minimum (String).
type: list type: list
elements: dict elements: dict
target_tracking_policies: target_tracking_policies:
description: description:
- A list of hash/dictionaries of target tracking policies to configure in the elastigroup; '[{"key":"value", "key":"value"}]'; keys allowed - A list of hash/dictionaries of target tracking policies to configure in the elastigroup; '[{"key":"value", "key":"value"}]';
are - policy_name (String, required), namespace (String, required), source (String, required), metric_name (String, required), statistic keys allowed are - policy_name (String, required), namespace (String, required), source (String, required), metric_name
(String, required), unit (String, required), cooldown (String, required), target (String, required). (String, required), statistic (String, required), unit (String, required), cooldown (String, required), target (String,
required).
type: list type: list
elements: dict elements: dict
@ -374,8 +387,8 @@ options:
- id - id
- 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 is set, you - If your group names are not unique, you may use this feature to update or delete a specific group. Whenever this property
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 will be created.
default: name default: name
type: str type: str
@ -684,18 +697,8 @@ instances:
description: List of active elastigroup instances and their details. description: List of active elastigroup instances and their details.
returned: success returned: success
type: dict type: dict
sample: [ sample: [{"spotInstanceRequestId": "sir-regs25zp", "instanceId": "i-09640ad8678234c", "instanceType": "m4.large", "product": "Linux/UNIX",
{ "availabilityZone": "us-west-2b", "privateIp": "180.0.2.244", "createdAt": "2017-07-17T12:46:18.000Z", "status": "fulfilled"}]
"spotInstanceRequestId": "sir-regs25zp",
"instanceId": "i-09640ad8678234c",
"instanceType": "m4.large",
"product": "Linux/UNIX",
"availabilityZone": "us-west-2b",
"privateIp": "180.0.2.244",
"createdAt": "2017-07-17T12:46:18.000Z",
"status": "fulfilled"
}
]
group_id: group_id:
description: Created / Updated group's ID. description: Created / Updated group's ID.
returned: success returned: success

6
plugins/modules/ssh_config.py
View File

@ -71,9 +71,9 @@ options:
type: path type: path
identities_only: identities_only:
description: description:
- Specifies that SSH should only use the configured authentication identity and certificate files (either the default files, or those explicitly - Specifies that SSH should only use the configured authentication identity and certificate files (either the default
configured in the C(ssh_config) files or passed on the ssh command-line), even if ssh-agent or a PKCS11Provider or SecurityKeyProvider files, or those explicitly configured in the C(ssh_config) files or passed on the ssh command-line), even if C(ssh-agent)
offers more identities. or a C(PKCS11Provider) or C(SecurityKeyProvider) offers more identities.
type: bool type: bool
version_added: 8.2.0 version_added: 8.2.0
user_known_hosts_file: user_known_hosts_file:

6
plugins/modules/stacki_host.py
View File

@ -29,12 +29,14 @@ options:
type: str type: str
stacki_user: stacki_user:
description: description:
- Username for authenticating with Stacki API, but if not specified, the environment variable E(stacki_user) is used instead. - Username for authenticating with Stacki API, but if not specified, the environment variable E(stacki_user) is used
instead.
required: true required: true
type: str type: str
stacki_password: stacki_password:
description: description:
- Password for authenticating with Stacki API, but if not specified, the environment variable E(stacki_password) is used instead. - Password for authenticating with Stacki API, but if not specified, the environment variable E(stacki_password) is
used instead.
required: true required: true
type: str type: str
stacki_endpoint: stacki_endpoint:

2
plugins/modules/statusio_maintenance.py
View File

@ -107,7 +107,7 @@ options:
maintenance_id: maintenance_id:
type: str type: str
description: description:
- The maintenance id number when deleting a maintenance window. - The maintenance ID number when deleting a maintenance window.
minutes: minutes:
type: int type: int
description: description:

10
plugins/modules/supervisorctl.py
View File

@ -11,7 +11,7 @@ __metaclass__ = type
DOCUMENTATION = r""" DOCUMENTATION = r"""
module: supervisorctl module: supervisorctl
short_description: Manage the state of a program or group of programs managed by C(supervisord). short_description: Manage the state of a program or group of programs managed by C(supervisord)
description: description:
- Manage the state of a program or group of programs managed by C(supervisord). - Manage the state of a program or group of programs managed by C(supervisord).
extends_documentation_fragment: extends_documentation_fragment:
@ -67,10 +67,12 @@ 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 not exist. - When O(state=present), the module will call C(supervisorctl reread) then C(supervisorctl add) if the program/group does
not exist.
- When O(state=restarted), the module will call C(supervisorctl update) then call C(supervisorctl restart). - When O(state=restarted), the module will call C(supervisorctl update) then call C(supervisorctl restart).
- When O(state=absent), the module will call C(supervisorctl reread) then C(supervisorctl remove) to remove the target program/group. If the - When O(state=absent), the module will call C(supervisorctl reread) then C(supervisorctl remove) to remove the target program/group.
program/group is still running, the action will fail. If you want to stop the program/group before removing, use O(stop_before_removing=true). If the program/group is still running, the action will fail. If you want to stop the program/group before removing, use
O(stop_before_removing=true).
requirements: ["supervisorctl"] requirements: ["supervisorctl"]
author: author:
- "Matt Wright (@mattupstate)" - "Matt Wright (@mattupstate)"

7
plugins/modules/svc.py
View File

@ -38,12 +38,13 @@ options:
choices: [killed, once, reloaded, restarted, started, stopped] choices: [killed, once, reloaded, restarted, started, stopped]
downed: downed:
description: description:
- Should a C(down) file exist or not, if it exists it disables auto startup. Defaults to V(false). Downed does not imply stopped. - Should a C(down) file exist or not, if it exists it disables auto startup. Defaults to V(false). Downed does not imply
stopped.
type: bool type: bool
enabled: enabled:
description: description:
- Whether the service is enabled or not, if disabled it also implies O(state=stopped). Take note that a service can be enabled and downed (no auto - Whether the service is enabled or not, if disabled it also implies O(state=stopped). Take note that a service can
restart). be enabled and downed (no auto restart).
type: bool type: bool
service_dir: service_dir:
description: description:

10
plugins/modules/svr4pkg.py
View File

@ -36,7 +36,8 @@ options:
description: description:
- Whether to install (V(present)), or remove (V(absent)) a package. - Whether to install (V(present)), or remove (V(absent)) a package.
- If the package is to be installed, then O(src) is required. - If the package is to be installed, then O(src) is required.
- The SVR4 package system does not provide an upgrade operation. You need to uninstall the old, then install the new package. - The SVR4 package system does not provide an upgrade operation. You need to uninstall the old, then install the new
package.
required: true required: true
choices: ["present", "absent"] choices: ["present", "absent"]
type: str type: str
@ -44,9 +45,10 @@ options:
src: src:
description: description:
- Specifies the location to install the package from. Required when O(state=present). - Specifies the location to install the package from. Required when O(state=present).
- "Can be any path acceptable to the C(pkgadd) command's C(-d) option. For example: V(somefile.pkg), V(/dir/with/pkgs), V(http://server/mypkgs.pkg)." - "Can be any path acceptable to the C(pkgadd) command's C(-d) option. For example: V(somefile.pkg), V(/dir/with/pkgs),
- If using a file or directory, they must already be accessible by the host. See the M(ansible.builtin.copy) module for a way to get them V(http://server/mypkgs.pkg)."
there. - If using a file or directory, they must already be accessible by the host. See the M(ansible.builtin.copy) module
for a way to get them there.
type: str type: str
proxy: proxy:
description: description:

7
plugins/modules/swupd.py
View File

@ -35,8 +35,8 @@ options:
type: str type: str
manifest: manifest:
description: description:
- The manifest contains information about the bundles at certain version of the OS. Specify a Manifest version to verify against that version - The manifest contains information about the bundles at certain version of the OS. Specify a Manifest version to verify
or leave unspecified to verify against the current version. against that version or leave unspecified to verify against the current version.
aliases: [release, version] aliases: [release, version]
type: int type: int
name: name:
@ -46,7 +46,8 @@ options:
type: str type: str
state: state:
description: description:
- Indicates the desired (I)bundle state. V(present) ensures the bundle is installed while V(absent) ensures the (I)bundle is not installed. - Indicates the desired (I)bundle state. V(present) ensures the bundle is installed while V(absent) ensures the (I)bundle
is not installed.
default: present default: present
choices: [present, absent] choices: [present, absent]
type: str type: str

4
plugins/modules/syslogger.py
View File

@ -35,8 +35,8 @@ options:
type: str type: str
description: description:
- Set the log facility. - Set the log facility.
choices: ["kern", "user", "mail", "daemon", "auth", "lpr", "news", "uucp", "cron", "syslog", "local0", "local1", "local2", "local3", "local4", choices: ["kern", "user", "mail", "daemon", "auth", "lpr", "news", "uucp", "cron", "syslog", "local0", "local1", "local2",
"local5", "local6", "local7"] "local3", "local4", "local5", "local6", "local7"]
default: "daemon" default: "daemon"
log_pid: log_pid:
description: description:

98
plugins/modules/systemd_creds_decrypt.py
View File

@ -13,9 +13,9 @@ DOCUMENTATION = r"""
module: systemd_creds_decrypt module: systemd_creds_decrypt
short_description: C(systemd)'s C(systemd-creds decrypt) plugin short_description: C(systemd)'s C(systemd-creds decrypt) plugin
description: description:
- This module decrypts input using C(systemd)'s C(systemd-creds decrypt). - This module decrypts input using C(systemd)'s C(systemd-creds decrypt).
author: author:
- Thomas Sjögren (@konstruktoid) - Thomas Sjögren (@konstruktoid)
version_added: '10.2.0' version_added: '10.2.0'
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
@ -29,50 +29,46 @@ attributes:
details: details:
- This action does not modify state. - This action does not modify state.
options: options:
name: name:
description: description:
- The credential name to validate the embedded credential name. - The credential name to validate the embedded credential name.
type: str type: str
required: false required: false
newline: newline:
description: description:
- Whether to add a trailing newline character to the end of the output, - Whether to add a trailing newline character to the end of the output, if not present.
if not present. type: bool
type: bool required: false
required: false default: false
default: false secret:
secret: description:
description: - The secret to decrypt.
- The secret to decrypt. type: str
type: str required: true
required: true timestamp:
timestamp: description:
description: - The timestamp to use to validate the V(not-after) timestamp that was used during encryption.
- The timestamp to use to validate the V(not-after) timestamp that - Takes a timestamp specification in the format described in V(systemd.time(7\)).
was used during encryption. type: str
- Takes a timestamp specification in the format described in required: false
V(systemd.time(7\)). transcode:
type: str description:
required: false - Whether to transcode the output before returning it.
transcode: type: str
description: choices: [base64, unbase64, hex, unhex]
- Whether to transcode the output before returning it. required: false
type: str user:
choices: [ base64, unbase64, hex, unhex ] description:
required: false - A user name or numeric UID when decrypting from a specific user context.
user: - If set to the special string V(self) it sets the user to the user of the calling process.
description: - Requires C(systemd) 256 or later.
- A user name or numeric UID when decrypting from a specific user context. type: str
- If set to the special string V(self) it sets the user to the user required: false
of the calling process.
- Requires C(systemd) 256 or later.
type: str
required: false
notes: notes:
- C(systemd-creds) requires C(systemd) 250 or later. - C(systemd-creds) requires C(systemd) 250 or later.
""" """
EXAMPLES = """ EXAMPLES = r"""
- name: Decrypt secret - name: Decrypt secret
community.general.systemd_creds_decrypt: community.general.systemd_creds_decrypt:
name: db name: db
@ -86,16 +82,14 @@ EXAMPLES = """
RETURN = r""" RETURN = r"""
value: value:
description: description:
- The decrypted secret. - The decrypted secret.
- Note that Ansible only supports returning UTF-8 encoded strings. - Note that Ansible only supports returning UTF-8 encoded strings. If the decrypted secret is binary data, or a string
If the decrypted secret is binary data, or a string encoded in another encoded in another way, use O(transcode=base64) or O(transcode=hex) to circument this restriction. You then need to
way, use O(transcode=base64) or O(transcode=hex) to circument this decode the data when using it, for example using the P(ansible.builtin.b64decode#filter) filter.
restriction. You then need to decode the data when using it, for type: str
example using the P(ansible.builtin.b64decode#filter) filter. returned: always
type: str sample: "access_token"
returned: always
sample: "access_token"
""" """

88
plugins/modules/systemd_creds_encrypt.py
View File

@ -13,9 +13,9 @@ DOCUMENTATION = r"""
module: systemd_creds_encrypt module: systemd_creds_encrypt
short_description: C(systemd)'s C(systemd-creds encrypt) plugin short_description: C(systemd)'s C(systemd-creds encrypt) plugin
description: description:
- This module encrypts input using C(systemd)'s C(systemd-creds encrypt). - This module encrypts input using C(systemd)'s C(systemd-creds encrypt).
author: author:
- Thomas Sjögren (@konstruktoid) - Thomas Sjögren (@konstruktoid)
version_added: '10.2.0' version_added: '10.2.0'
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
@ -29,50 +29,46 @@ attributes:
details: details:
- This action does not modify state. - This action does not modify state.
options: options:
name: name:
description: description:
- The credential name to embed in the encrypted credential data. - The credential name to embed in the encrypted credential data.
type: str type: str
required: false required: false
not_after: not_after:
description: description:
- The time when the credential shall not be used anymore. - The time when the credential shall not be used anymore.
- Takes a timestamp specification in the format described in - Takes a timestamp specification in the format described in V(systemd.time(7\)).
V(systemd.time(7\)). type: str
type: str required: false
required: false pretty:
pretty: description:
description: - Pretty print the output so that it may be pasted directly into a unit file.
- Pretty print the output so that it may be pasted directly into a type: bool
unit file. required: false
type: bool default: false
required: false secret:
default: false description:
secret: - The secret to encrypt.
description: type: str
- The secret to encrypt. required: true
type: str timestamp:
required: true description:
timestamp: - The timestamp to embed into the encrypted credential.
description: - Takes a timestamp specification in the format described in V(systemd.time(7\)).
- The timestamp to embed into the encrypted credential. type: str
- Takes a timestamp specification in the format described in required: false
V(systemd.time(7\)). user:
type: str description:
required: false - A user name or numeric UID to encrypt the credential for.
user: - If set to the special string V(self) it sets the user to the user of the calling process.
description: - Requires C(systemd) 256 or later.
- A user name or numeric UID to encrypt the credential for. type: str
- If set to the special string V(self) it sets the user to the user required: false
of the calling process.
- Requires C(systemd) 256 or later.
type: str
required: false
notes: notes:
- C(systemd-creds) requires C(systemd) 250 or later. - C(systemd-creds) requires C(systemd) 250 or later.
""" """
EXAMPLES = """ EXAMPLES = r"""
- name: Encrypt secret - name: Encrypt secret
become: true become: true
community.general.systemd_creds_encrypt: community.general.systemd_creds_encrypt:
@ -88,10 +84,10 @@ EXAMPLES = """
RETURN = r""" RETURN = r"""
value: value:
description: The Base64 encoded encrypted secret. description: The Base64 encoded encrypted secret.
type: str type: str
returned: always returned: always
sample: "WhQZht+JQJax1aZemmGLxmAAAA..." sample: "WhQZht+JQJax1aZemmGLxmAAAA..."
""" """
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule

3
plugins/modules/sysupgrade.py
View File

@ -42,7 +42,8 @@ options:
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 exit gracefully. See the examples. - Set to V(false) if you want C(sysupgrade) to reboot. This will cause Ansible to error, as it expects the module to
exit gracefully. See the examples.
default: true default: true
type: bool type: bool
installurl: installurl:

4
plugins/modules/taiga_issue.py
View File

@ -88,8 +88,8 @@ options:
author: Alejandro Guirao (@lekum) author: Alejandro Guirao (@lekum)
requirements: [python-taiga] requirements: [python-taiga]
notes: notes:
- The authentication is achieved either by the environment variable E(TAIGA_TOKEN) or by the pair - The authentication is achieved either by the environment variable E(TAIGA_TOKEN) or by the pair of environment variables
of environment variables E(TAIGA_USERNAME) and E(TAIGA_PASSWORD). E(TAIGA_USERNAME) and E(TAIGA_PASSWORD).
""" """
EXAMPLES = r""" EXAMPLES = r"""

51
plugins/modules/terraform.py
View File

@ -44,15 +44,15 @@ options:
- When set, the plugin discovery and auto-download behavior of Terraform is disabled. - When set, the plugin discovery and auto-download behavior of Terraform is disabled.
- The directory structure in the plugin path can be tricky. The Terraform docs - The directory structure in the plugin path can be tricky. The Terraform docs
U(https://learn.hashicorp.com/tutorials/terraform/automate-terraform#pre-installed-plugins) U(https://learn.hashicorp.com/tutorials/terraform/automate-terraform#pre-installed-plugins)
show a simple directory of files, but actually, the directory structure has to follow the same structure you would see if Terraform auto-downloaded show a simple directory of files, but actually, the directory structure has to follow the same structure you would
the plugins. See the examples below for a tree output of an example plugin directory. see if Terraform auto-downloaded the plugins. See the examples below for a tree output of an example plugin directory.
type: list type: list
elements: path elements: path
version_added: 3.0.0 version_added: 3.0.0
workspace: workspace:
description: description:
- The terraform workspace to work with. This sets the E(TF_WORKSPACE) environmental variable that is used to override workspace selection. - The terraform workspace to work with. This sets the E(TF_WORKSPACE) environmental variable that is used to override
For more information about workspaces have a look at U(https://developer.hashicorp.com/terraform/language/state/workspaces). workspace selection. For more information about workspaces have a look at U(https://developer.hashicorp.com/terraform/language/state/workspaces).
type: str type: str
default: default default: default
purge_workspace: purge_workspace:
@ -64,26 +64,28 @@ options:
type: bool type: bool
plan_file: plan_file:
description: description:
- The path to an existing Terraform plan file to apply. If this is not specified, Ansible will build a new TF plan and execute it. Note - The path to an existing Terraform plan file to apply. If this is not specified, Ansible will build a new TF plan and
that this option is required if 'state' has the 'planned' value. execute it. Note that this option is required if 'state' has the 'planned' value.
type: path type: path
state_file: state_file:
description: description:
- The path to an existing Terraform state file to use when building plan. If this is not specified, the default C(terraform.tfstate) will - The path to an existing Terraform state file to use when building plan. If this is not specified, the default C(terraform.tfstate)
be used. will be used.
- This option is ignored when plan is specified. - This option is ignored when plan is specified.
type: path type: path
variables_files: variables_files:
description: description:
- The path to a variables file for Terraform to fill into the TF configurations. This can accept a list of paths to multiple variables files. - The path to a variables file for Terraform to fill into the TF configurations. This can accept a list of paths to
multiple variables files.
type: list type: list
elements: path elements: path
aliases: ['variables_file'] aliases: ['variables_file']
variables: variables:
description: description:
- A group of key-values pairs to override template variables or those in variables files. By default, only string and number values are - A group of key-values pairs to override template variables or those in variables files. By default, only string and
allowed, which are passed on unquoted. number values are allowed, which are passed on unquoted.
- Support complex variable structures (lists, dictionaries, numbers, and booleans) to reflect terraform variable syntax when O(complex_vars=true). - Support complex variable structures (lists, dictionaries, numbers, and booleans) to reflect terraform variable syntax
when O(complex_vars=true).
- Ansible integers or floats are mapped to terraform numbers. - Ansible integers or floats are mapped to terraform numbers.
- Ansible strings are mapped to terraform strings. - Ansible strings are mapped to terraform strings.
- Ansible dictionaries are mapped to terraform objects. - Ansible dictionaries are mapped to terraform objects.
@ -94,15 +96,16 @@ options:
complex_vars: complex_vars:
description: description:
- Enable/disable capability to handle complex variable structures for C(terraform). - Enable/disable capability to handle complex variable structures for C(terraform).
- If V(true) the O(variables) also accepts dictionaries, lists, and booleans to be passed to C(terraform). Strings that are passed are correctly - If V(true) the O(variables) also accepts dictionaries, lists, and booleans to be passed to C(terraform). Strings that
quoted. are passed are correctly quoted.
- When disabled, supports only simple variables (strings, integers, and floats), and passes them on unquoted. - When disabled, supports only simple variables (strings, integers, and floats), and passes them on unquoted.
type: bool type: bool
default: false default: false
version_added: 5.7.0 version_added: 5.7.0
targets: targets:
description: description:
- A list of specific resources to target in this plan/application. The resources selected here will also auto-include any dependencies. - A list of specific resources to target in this plan/application. The resources selected here will also auto-include
any dependencies.
type: list type: list
elements: str elements: str
default: [] default: []
@ -117,8 +120,8 @@ options:
type: int type: int
force_init: force_init:
description: description:
- To avoid duplicating infra, if a state file cannot be found this will force a C(terraform init). Generally, this should be turned off unless - To avoid duplicating infra, if a state file cannot be found this will force a C(terraform init). Generally, this should
you intend to provision an entirely new Terraform deployment. be turned off unless you intend to provision an entirely new Terraform deployment.
default: false default: false
type: bool type: bool
overwrite_init: overwrite_init:
@ -133,8 +136,8 @@ options:
type: dict type: dict
backend_config_files: backend_config_files:
description: description:
- The path to a configuration file to provide at init state to the -backend-config parameter. This can accept a list of paths to multiple - The path to a configuration file to provide at init state to the -backend-config parameter. This can accept a list
configuration files. of paths to multiple configuration files.
type: list type: list
elements: path elements: path
version_added: '0.2.0' version_added: '0.2.0'
@ -152,8 +155,8 @@ options:
version_added: '1.3.0' version_added: '1.3.0'
check_destroy: check_destroy:
description: description:
- Apply only when no resources are destroyed. Note that this only prevents "destroy" actions, but not "destroy and re-create" actions. This - Apply only when no resources are destroyed. Note that this only prevents "destroy" actions, but not "destroy and re-create"
option is ignored when O(state=absent). actions. This option is ignored when O(state=absent).
type: bool type: bool
default: false default: false
version_added: '3.3.0' version_added: '3.3.0'
@ -239,7 +242,8 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
outputs: outputs:
type: complex type: complex
description: A dictionary of all the TF outputs by their assigned name. Use RV(ignore:outputs.MyOutputName.value) to access the value. description: A dictionary of all the TF outputs by their assigned name. Use RV(ignore:outputs.MyOutputName.value) to access
the value.
returned: on success returned: on success
sample: '{"bukkit_arn": {"sensitive": false, "type": "string", "value": "arn:aws:s3:::tf-test-bukkit"}' sample: '{"bukkit_arn": {"sensitive": false, "type": "string", "value": "arn:aws:s3:::tf-test-bukkit"}'
contains: contains:
@ -262,7 +266,8 @@ stdout:
sample: '' sample: ''
command: command:
type: str type: str
description: Full C(terraform) command built by this module, in case you want to re-run the command outside the module or debug a problem. description: Full C(terraform) command built by this module, in case you want to re-run the command outside the module or
debug a problem.
returned: always returned: always
sample: terraform apply ... sample: terraform apply ...
""" """

21
plugins/modules/timezone.py
View File

@ -12,14 +12,14 @@ DOCUMENTATION = r"""
module: timezone module: timezone
short_description: Configure timezone setting short_description: Configure timezone setting
description: description:
- This module configures the timezone setting, both of the system clock and of the hardware clock. If you want to set up the NTP, use - This module configures the timezone setting, both of the system clock and of the hardware clock. If you want to set up
M(ansible.builtin.service) module. the NTP, use M(ansible.builtin.service) module.
- It is recommended to restart C(crond) after changing the timezone, otherwise the jobs may run at the wrong time. - It is recommended to restart C(crond) after changing the timezone, otherwise the jobs may run at the wrong time.
- Several different tools are used depending on the OS/Distribution involved. For Linux it can use C(timedatectl) or edit C(/etc/sysconfig/clock) - Several different tools are used depending on the OS/Distribution involved. For Linux it can use C(timedatectl) or edit
or C(/etc/timezone) and C(hwclock). On SmartOS, C(sm-set-timezone), for macOS, C(systemsetup), for BSD, C(/etc/localtime) is modified. On C(/etc/sysconfig/clock) or C(/etc/timezone) and C(hwclock). On SmartOS, C(sm-set-timezone), for macOS, C(systemsetup),
AIX, C(chtz) is used. for BSD, C(/etc/localtime) is modified. On AIX, C(chtz) is used.
- Make sure that the zoneinfo files are installed with the appropriate OS package, like C(tzdata) (usually always installed, when not using - Make sure that the zoneinfo files are installed with the appropriate OS package, like C(tzdata) (usually always installed,
a minimal installation like Alpine Linux). when not using a minimal installation like Alpine Linux).
- Windows and HPUX are not supported, please let us know if you find any other OS/distro in which this fails. - Windows and HPUX are not supported, please let us know if you find any other OS/distro in which this fails.
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
@ -39,7 +39,8 @@ options:
description: description:
- Whether the hardware clock is in UTC or in local timezone. - Whether the hardware clock is in UTC or in local timezone.
- Default is to keep current setting. - Default is to keep current setting.
- Note that this option is recommended not to change and may fail to configure, especially on virtual environments such as AWS. - Note that this option is recommended not to change and may fail to configure, especially on virtual environments such
as AWS.
- B(At least one) of O(name) and O(hwclock) are required. - B(At least one) of O(name) and O(hwclock) are required.
- I(Only used on Linux). - I(Only used on Linux).
type: str type: str
@ -48,8 +49,8 @@ options:
notes: notes:
- On Ubuntu 24.04 the C(util-linux-extra) package is required to provide the C(hwclock) command. - On Ubuntu 24.04 the C(util-linux-extra) package is required to provide the C(hwclock) command.
- On SmartOS the C(sm-set-timezone) utility (part of the smtools package) is required to set the zone timezone. - On SmartOS the C(sm-set-timezone) utility (part of the smtools package) is required to set the zone timezone.
- On AIX only Olson/tz database timezones are usable (POSIX is not supported). An OS reboot is also required on AIX for the new timezone setting - On AIX only Olson/tz database timezones are usable (POSIX is not supported). An OS reboot is also required on AIX for
to take effect. Note that AIX 6.1+ is needed (OS level 61 or newer). the new timezone setting to take effect. Note that AIX 6.1+ is needed (OS level 61 or newer).
author: author:
- Shinichi TAMURA (@tmshn) - Shinichi TAMURA (@tmshn)
- Jasper Lievisse Adriaanse (@jasperla) - Jasper Lievisse Adriaanse (@jasperla)

7
plugins/modules/twilio.py
View File

@ -15,9 +15,10 @@ short_description: Sends a text message to a mobile phone through Twilio
description: description:
- Sends a text message to a phone number through the Twilio messaging API. - Sends a text message to a phone number through the Twilio messaging API.
notes: notes:
- 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. - This module is non-idempotent because it sends an email through the external API. It is idempotent only in the case that
- Like the other notification modules, this one requires an external dependency to work. In this case, you need a Twilio account with a purchased the module fails.
or verified phone number to send the text message. - Like the other notification modules, this one requires an external dependency to work. In this case, you need a Twilio
account with a purchased or verified phone number to send the text message.
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
attributes: attributes:

2
plugins/modules/typetalk.py
View File

@ -35,7 +35,7 @@ options:
topic: topic:
type: int type: int
description: description:
- Topic id to post message. - Topic ID to post message.
required: true required: true
msg: msg:
type: str type: str