From 695b1abc8dd095d768893e8e78f8b32110058bdc Mon Sep 17 00:00:00 2001 From: Alexei Znamensky <103110+russoz@users.noreply.github.com> Date: Sat, 4 Jan 2025 08:00:45 +1300 Subject: [PATCH] st*: style adjustments (#9516) * st*: style adjustments * lien lenght adjustments --- plugins/modules/shutdown.py | 16 +-- plugins/modules/simpleinit_msb.py | 6 +- plugins/modules/sl_vm.py | 4 +- plugins/modules/slack.py | 65 ++++++----- plugins/modules/smartos_image_info.py | 3 +- plugins/modules/snap.py | 29 ++--- plugins/modules/snmp_facts.py | 3 +- plugins/modules/solaris_zone.py | 13 ++- plugins/modules/sorcery.py | 7 +- plugins/modules/spectrum_device.py | 3 +- plugins/modules/spectrum_model_attrs.py | 4 +- plugins/modules/spotinst_aws_elastigroup.py | 121 ++++++++++---------- plugins/modules/ssh_config.py | 6 +- plugins/modules/stacki_host.py | 6 +- plugins/modules/statusio_maintenance.py | 2 +- plugins/modules/supervisorctl.py | 10 +- plugins/modules/svc.py | 7 +- plugins/modules/svr4pkg.py | 10 +- plugins/modules/swupd.py | 7 +- plugins/modules/syslogger.py | 4 +- plugins/modules/systemd_creds_decrypt.py | 98 ++++++++-------- plugins/modules/systemd_creds_encrypt.py | 88 +++++++------- plugins/modules/sysupgrade.py | 3 +- plugins/modules/taiga_issue.py | 4 +- plugins/modules/terraform.py | 51 +++++---- plugins/modules/timezone.py | 21 ++-- plugins/modules/twilio.py | 7 +- plugins/modules/typetalk.py | 2 +- 28 files changed, 310 insertions(+), 290 deletions(-) diff --git a/plugins/modules/shutdown.py b/plugins/modules/shutdown.py index 6f2dac14b1..d6bd7ecc6b 100644 --- a/plugins/modules/shutdown.py +++ b/plugins/modules/shutdown.py @@ -12,10 +12,10 @@ DOCUMENTATION = r""" module: shutdown short_description: Shut down a machine 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 - 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 - to shutdown the system by calling C(systemctl shutdown). + - 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 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 attempts to shutdown the system by calling C(systemctl shutdown). description: - Shut downs a machine. version_added: "1.1.0" @@ -35,8 +35,8 @@ options: delay: description: - 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 Solaris and FreeBSD, this will be seconds. + - 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 represents seconds. type: int default: 0 msg: @@ -47,8 +47,8 @@ options: search_paths: description: - 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) - command. + - I(Only) these paths are searched for the C(shutdown) command. E(PATH) is ignored in the remote node when searching + for the C(shutdown) command. type: list elements: path default: ['/sbin', '/usr/sbin', '/usr/local/sbin'] diff --git a/plugins/modules/simpleinit_msb.py b/plugins/modules/simpleinit_msb.py index 2b1b865d2c..f4b017a410 100644 --- a/plugins/modules/simpleinit_msb.py +++ b/plugins/modules/simpleinit_msb.py @@ -39,10 +39,10 @@ options: required: false choices: [running, started, stopped, restarted, reloaded] description: - - V(started)/V(stopped) are idempotent actions that will not run commands unless necessary. V(restarted) will always bounce the service. - V(reloaded) will always reload. + - V(started)/V(stopped) are idempotent actions that do not run commands unless necessary. V(restarted) always bounces + the service. V(reloaded) always reloads. - 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: type: bool required: false diff --git a/plugins/modules/sl_vm.py b/plugins/modules/sl_vm.py index ea48340f1c..c5a986843c 100644 --- a/plugins/modules/sl_vm.py +++ b/plugins/modules/sl_vm.py @@ -24,7 +24,7 @@ attributes: options: instance_id: description: - - Instance Id of the virtual instance to perform action option. + - Instance ID of the virtual instance to perform action option. type: str hostname: description: @@ -146,7 +146,7 @@ options: type: str ssh_keys: 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 elements: str default: [] diff --git a/plugins/modules/slack.py b/plugins/modules/slack.py index 05d34e94b9..61ccfbfc9e 100644 --- a/plugins/modules/slack.py +++ b/plugins/modules/slack.py @@ -32,29 +32,31 @@ options: domain: type: str description: - - 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. + - 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. token: type: str description: - - 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. - - '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 are in the new format then slack will - 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 - 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 - the webhook tokens. In slack these are found in the webhook URL which are obtained under the apps and integrations. The incoming webhooks - 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 - webhooks can be added. The key is on the end of the URL given to you in that section.' - - "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 thread_id. See Slack's documentation - (U(https://api.slack.com/docs/token-types)) for more information." + - 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. + - '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 + are in the new format then slack will 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 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 the webhook tokens. In slack these + are found in the webhook URL which are obtained under the apps and integrations. The incoming webhooks 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 webhooks can be added. The key is on the end of the URL given to you in that section.' + - "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 + thread_id. See Slack's documentation (U(https://api.slack.com/docs/token-types)) for more information." required: true msg: type: str description: - - 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(&)) before sending. See Slack's documentation (U(https://api.slack.com/docs/message-formatting)) for more. + - 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(&)) before sending. See Slack's documentation + (U(https://api.slack.com/docs/message-formatting)) for more. channel: type: str description: @@ -66,8 +68,8 @@ options: message_id: description: - 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 - run. + - If supplied O(channel) must be in form of C(C0xxxxxxx). use C({{ slack_response.channel }}) to get RV(ignore:channel) + 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)). - Corresponds to C(ts) in the Slack API (U(https://api.slack.com/messaging/modifying)). type: str @@ -104,14 +106,17 @@ options: - 'none' validate_certs: description: - - If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + - If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using + self-signed certificates. type: bool default: true color: type: str 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. - - Allowed values for color can be one of 'normal', 'good', 'warning', 'danger', any valid 3 digit or 6 digit hex color value. + - Allow text to use default colors - use the default of V(normal) to not send a custom color bar at the start of the + 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' attachments: type: list @@ -130,14 +135,13 @@ options: type: str description: - 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 - 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 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. - It will change to V(never) in community.general 12.0.0. - To prevent deprecation warnings you can explicitly set O(prepend_hash) to the value you want. - We suggest to only use V(always) or V(never), but not V(auto), when explicitly setting a value. + - 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 + O(channel) values must not have the 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) 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 + V(never) in community.general 12.0.0. To prevent deprecation warnings you can explicitly set O(prepend_hash) to the + value you want. We suggest to only use V(always) or V(never), but not V(auto), when explicitly setting a value. choices: - 'always' - 'never' @@ -164,7 +168,8 @@ EXAMPLES = r""" parse: 'none' 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: token: thetoken/generatedby/slack msg: '{{ inventory_hostname }} is alive!' diff --git a/plugins/modules/smartos_image_info.py b/plugins/modules/smartos_image_info.py index 96bf9b0575..19ad740b72 100644 --- a/plugins/modules/smartos_image_info.py +++ b/plugins/modules/smartos_image_info.py @@ -25,7 +25,8 @@ attributes: options: filters: 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). type: str """ diff --git a/plugins/modules/snap.py b/plugins/modules/snap.py index 1de829801d..3cb34a1548 100644 --- a/plugins/modules/snap.py +++ b/plugins/modules/snap.py @@ -37,8 +37,8 @@ options: state: description: - 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 - a different channel. + - 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 a different channel. default: present choices: [absent, present, enabled, disabled] type: str @@ -46,28 +46,29 @@ options: description: - Install a snap that has classic confinement. - 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 - use sandboxing mechanisms. This option can only be specified when the task involves a single snap. + - This level of confinement is permissive, granting full system access, similar to that of traditionally packaged applications + 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. type: bool required: false default: false channel: 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 - task. + - 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. - 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 - the channel to be V(latest/edge). + - 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 the channel to be V(latest/edge). - See U(https://snapcraft.io/docs/channels) for more details about snap channels. type: str required: false options: 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 - 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. - - 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). + - 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 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. + - 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. required: false type: list @@ -83,8 +84,8 @@ options: default: false version_added: 7.2.0 notes: - - Privileged operations, such as installing and configuring snaps, require root priviledges. This is only the case if the user has not logged - in to the Snap Store. + - Privileged operations, such as installing and configuring snaps, require root priviledges. This is only the case if the + user has not logged in to the Snap Store. author: - Victor Carceler (@vcarceler) - Stanislas Lange (@angristan) diff --git a/plugins/modules/snmp_facts.py b/plugins/modules/snmp_facts.py index af0abf9479..74aca27c40 100644 --- a/plugins/modules/snmp_facts.py +++ b/plugins/modules/snmp_facts.py @@ -125,7 +125,8 @@ ansible_sysuptime: type: int sample: 42388 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 type: str sample: Me diff --git a/plugins/modules/solaris_zone.py b/plugins/modules/solaris_zone.py index 6aa8608be4..c0959901ff 100644 --- a/plugins/modules/solaris_zone.py +++ b/plugins/modules/solaris_zone.py @@ -64,8 +64,9 @@ options: type: str config: 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 - 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). + - The C(zonecfg) configuration commands for this zone. See zonecfg(1M) for the valid options and syntax. Typically this + 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 default: '' create_options: @@ -75,14 +76,14 @@ options: default: '' install_options: 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 - O(install_options=-c sc_profile.xml). + - Extra options to the zoneadm(1M) install command. To automate Solaris 11 zone creation, use this to specify the profile + XML file, for example O(install_options=-c sc_profile.xml). type: str default: '' attach_options: 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 - required and if any packages need to be deleted. For valid values, see zoneadm(1M). + - Extra options to the zoneadm attach command. For example, this can be used to specify whether a minimum or full update + of packages is required and if any packages need to be deleted. For valid values, see zoneadm(1M). type: str default: '' timeout: diff --git a/plugins/modules/sorcery.py b/plugins/modules/sorcery.py index 9ad3d30f3b..52c6e30b18 100644 --- a/plugins/modules/sorcery.py +++ b/plugins/modules/sorcery.py @@ -17,7 +17,8 @@ description: - Manages "spells" on Source Mage GNU/Linux using I(sorcery) toolchain. author: "Vlad Glagolev (@vaygr)" 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. requirements: - bash @@ -60,8 +61,8 @@ options: depends: 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 - to turn it on/off (V(+) is optional though). + - Comma-separated list of _optional_ dependencies to build a spell (or make sure it is built) with; use V(+)/V(-) in + 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. - Providers must be supplied in the form recognized by Sorcery, for example 'V(openssl(SSL\))'. type: str diff --git a/plugins/modules/spectrum_device.py b/plugins/modules/spectrum_device.py index bb9761d37d..8bf4aa41b5 100644 --- a/plugins/modules/spectrum_device.py +++ b/plugins/modules/spectrum_device.py @@ -74,7 +74,8 @@ options: type: bool validate_certs: description: - - If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + - If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using + self-signed certificates. default: true type: bool agentport: diff --git a/plugins/modules/spectrum_model_attrs.py b/plugins/modules/spectrum_model_attrs.py index 3057f04c15..9c9fba4deb 100644 --- a/plugins/modules/spectrum_model_attrs.py +++ b/plugins/modules/spectrum_model_attrs.py @@ -63,8 +63,8 @@ options: required: true validate_certs: 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 - no man-in-the-middle attack happening. + - Validate SSL certificates. Only change this to V(false) if you can guarantee that you are talking to the correct endpoint + and there is no man-in-the-middle attack happening. type: bool default: true required: false diff --git a/plugins/modules/spotinst_aws_elastigroup.py b/plugins/modules/spotinst_aws_elastigroup.py index a55e7506ea..959dc6acca 100644 --- a/plugins/modules/spotinst_aws_elastigroup.py +++ b/plugins/modules/spotinst_aws_elastigroup.py @@ -10,9 +10,10 @@ module: spotinst_aws_elastigroup short_description: Create, update or delete Spotinst AWS Elastigroups author: Spotinst (@talzur) description: - - 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 in this location - C($HOME/.spotinst/credentials). - The credentials file must contain a row that looks like this C(token = ). + - 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 + in this location - C($HOME/.spotinst/credentials). The credentials file must contain a row that looks like this C(token + = ). - Full documentation available at U(https://help.spotinst.com/hc/en-us/articles/115003530285-Ansible-). requirements: - spotinst_sdk >= 1.0.38 @@ -40,8 +41,8 @@ options: token: description: - 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 - path.' + - 'When not specified, the module will try to obtain it, in that order, from: environment variable E(SPOTINST_TOKEN), + or from the credentials path.' type: str availability_vs_cost: @@ -53,24 +54,25 @@ options: availability_zones: description: - - A list of hash/dictionaries of Availability Zones that are configured in the elastigroup; '[{"key":"value", "key":"value"}]'; keys allowed - are name (String), subnet_id (String), placement_group_name (String),. + - A list of hash/dictionaries of Availability Zones that are configured in the elastigroup; '[{"key":"value", "key":"value"}]'; + keys allowed are name (String), subnet_id (String), placement_group_name (String),. required: true type: list elements: dict block_device_mappings: description: - - A list of hash/dictionaries of Block Device Mappings for elastigroup instances; You can specify virtual devices and EBS volumes.; '[{"key":"value", - "key":"value"}]'; keys allowed are device_name (List of Strings), virtual_name (String), 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)). + - A list of hash/dictionaries of Block Device Mappings for elastigroup instances; You can specify virtual devices and + EBS volumes.; '[{"key":"value", "key":"value"}]'; keys allowed are device_name (List of Strings), virtual_name (String), + 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 elements: dict chef: description: - - The Chef integration configuration.; Expects the following keys - chef_server (String), organization (String), user (String), pem_key - (String), chef_version (String). + - The Chef integration configuration.; Expects the following keys - chef_server (String), organization (String), user + (String), pem_key (String), chef_version (String). type: dict draining_timeout: @@ -80,13 +82,14 @@ options: ebs_optimized: 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 ebs_volume_pool: description: - - A list of hash/dictionaries of EBS devices to reattach to the elastigroup when available; '[{"key":"value", "key":"value"}]'; keys allowed - are - volume_ids (List of Strings), device_name (String). + - A list of hash/dictionaries of EBS devices to reattach to the elastigroup when available; '[{"key":"value", "key":"value"}]'; + keys allowed are - volume_ids (List of Strings), device_name (String). type: list elements: dict @@ -97,7 +100,7 @@ options: elastic_ips: 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 elements: str @@ -137,13 +140,15 @@ options: id: 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. - When this is set, and the uniqueness_by field is set, the group will either be updated or deleted, but not created. + - 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. When this is set, and the uniqueness_by field is set, the group will either be updated or deleted, + but not created. type: str image_id: 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 type: str @@ -198,17 +203,19 @@ options: network_interfaces: description: - - A list of hash/dictionaries of network interfaces to add to the elastigroup; '[{"key":"value", "key":"value"}]'; keys allowed are - description - (String), device_index (Integer), secondary_private_ip_address_count (Integer), associate_public_ip_address (Boolean), delete_on_termination - (Boolean), groups (List of Strings), network_interface_id (String), private_ip_address (String), subnet_id (String), associate_ipv6_address - (Boolean), private_ip_addresses (List of Objects, Keys are privateIpAddress (String, required) and primary (Boolean)). + - A list of hash/dictionaries of network interfaces to add to the elastigroup; '[{"key":"value", "key":"value"}]'; keys + allowed are - description (String), device_index (Integer), secondary_private_ip_address_count (Integer), associate_public_ip_address + (Boolean), delete_on_termination (Boolean), groups (List of Strings), network_interface_id (String), private_ip_address + (String), subnet_id (String), associate_ipv6_address (Boolean), private_ip_addresses (List of Objects, Keys are privateIpAddress + (String, required) and primary (Boolean)). type: list elements: dict on_demand_count: description: - 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 on_demand_instance_type: @@ -230,14 +237,15 @@ options: product: description: - 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 type: str rancher: description: - - The Rancher integration configuration.; Expects the following keys - version (String), access_key (String), secret_key (String), master_host - (String). + - The Rancher integration configuration.; Expects the following keys - version (String), access_key (String), secret_key + (String), master_host (String). type: dict right_scale: @@ -254,15 +262,16 @@ options: description: - Roll configuration. - 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 scheduled_tasks: description: - 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), - adjustment_percentage (Integer), batch_size_percentage (Integer), cron_expression (String), frequency (String), grace_period (Integer), - task_type (String, required), is_enabled (Boolean).' + - 'Keys allowed are: adjustment (Integer), scale_target_capacity (Integer), scale_min_capacity (Integer), scale_max_capacity + (Integer), adjustment_percentage (Integer), batch_size_percentage (Integer), cron_expression (String), frequency (String), + grace_period (Integer), task_type (String, required), is_enabled (Boolean).' type: list elements: dict @@ -281,7 +290,8 @@ options: signals: 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 elements: dict @@ -343,29 +353,32 @@ options: up_scaling_policies: description: - - A list of hash/dictionaries of scaling policies to configure in the elastigroup; '[{"key":"value", "key":"value"}]'; keys allowed are - - policy_name (String, required), namespace (String, required), metric_name (String, required), dimensions (List of Objects, Keys allowed - are name (String, required) and value (String)), statistic (String, required) evaluation_periods (String, required), period (String, required), - threshold (String, required), cooldown (String, required), unit (String, required), operator (String, required), action_type (String, - required), adjustment (String), min_target_capacity (String), target (String), maximum (String), minimum (String). + - A list of hash/dictionaries of scaling policies to configure in the elastigroup; '[{"key":"value", "key":"value"}]'; + keys allowed are - policy_name (String, required), namespace (String, required), metric_name (String, required), dimensions + (List of Objects, Keys allowed are name (String, required) and value (String)), statistic (String, required) evaluation_periods + (String, required), period (String, required), threshold (String, required), cooldown (String, required), unit (String, + required), operator (String, required), action_type (String, required), adjustment (String), min_target_capacity (String), + target (String), maximum (String), minimum (String). type: list elements: dict down_scaling_policies: description: - - A list of hash/dictionaries of scaling policies to configure in the elastigroup; '[{"key":"value", "key":"value"}]'; keys allowed are - - policy_name (String, required), namespace (String, required), metric_name (String, required), dimensions ((List of Objects), Keys allowed - are name (String, required) and value (String)), statistic (String, required), evaluation_periods (String, required), period (String, - required), threshold (String, required), cooldown (String, required), unit (String, required), operator (String, required), action_type - (String, required), adjustment (String), max_target_capacity (String), target (String), maximum (String), minimum (String). + - A list of hash/dictionaries of scaling policies to configure in the elastigroup; '[{"key":"value", "key":"value"}]'; + keys allowed are - policy_name (String, required), namespace (String, required), metric_name (String, required), dimensions + ((List of Objects), Keys allowed are name (String, required) and value (String)), statistic (String, required), evaluation_periods + (String, required), period (String, required), threshold (String, required), cooldown (String, required), unit (String, + required), operator (String, required), action_type (String, required), adjustment (String), max_target_capacity (String), + target (String), maximum (String), minimum (String). type: list elements: dict target_tracking_policies: description: - - A list of hash/dictionaries of target tracking policies to configure in the elastigroup; '[{"key":"value", "key":"value"}]'; keys allowed - are - policy_name (String, required), namespace (String, required), source (String, required), metric_name (String, required), statistic - (String, required), unit (String, required), cooldown (String, required), target (String, required). + - A list of hash/dictionaries of target tracking policies to configure in the elastigroup; '[{"key":"value", "key":"value"}]'; + keys allowed are - policy_name (String, required), namespace (String, required), source (String, required), metric_name + (String, required), statistic (String, required), unit (String, required), cooldown (String, required), target (String, + required). type: list elements: dict @@ -374,8 +387,8 @@ options: - id - name 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 - must set a group_id in order to update or delete a group, otherwise a group will be created. + - 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. default: name type: str @@ -684,18 +697,8 @@ instances: description: List of active elastigroup instances and their details. returned: success type: dict - 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" - } - ] + 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"}] group_id: description: Created / Updated group's ID. returned: success diff --git a/plugins/modules/ssh_config.py b/plugins/modules/ssh_config.py index 582d7c127e..8a478ffd8c 100644 --- a/plugins/modules/ssh_config.py +++ b/plugins/modules/ssh_config.py @@ -71,9 +71,9 @@ options: type: path identities_only: description: - - Specifies that SSH should only use the configured authentication identity and certificate files (either the default files, or those explicitly - configured in the C(ssh_config) files or passed on the ssh command-line), even if ssh-agent or a PKCS11Provider or SecurityKeyProvider - offers more identities. + - Specifies that SSH should only use the configured authentication identity and certificate files (either the default + files, or those explicitly configured in the C(ssh_config) files or passed on the ssh command-line), even if C(ssh-agent) + or a C(PKCS11Provider) or C(SecurityKeyProvider) offers more identities. type: bool version_added: 8.2.0 user_known_hosts_file: diff --git a/plugins/modules/stacki_host.py b/plugins/modules/stacki_host.py index 4d2a999317..bfa4cccff5 100644 --- a/plugins/modules/stacki_host.py +++ b/plugins/modules/stacki_host.py @@ -29,12 +29,14 @@ options: type: str stacki_user: 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 type: str stacki_password: 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 type: str stacki_endpoint: diff --git a/plugins/modules/statusio_maintenance.py b/plugins/modules/statusio_maintenance.py index 6f17523e25..9928267bde 100644 --- a/plugins/modules/statusio_maintenance.py +++ b/plugins/modules/statusio_maintenance.py @@ -107,7 +107,7 @@ options: maintenance_id: type: str description: - - The maintenance id number when deleting a maintenance window. + - The maintenance ID number when deleting a maintenance window. minutes: type: int description: diff --git a/plugins/modules/supervisorctl.py b/plugins/modules/supervisorctl.py index e94a2f770b..7df1674fea 100644 --- a/plugins/modules/supervisorctl.py +++ b/plugins/modules/supervisorctl.py @@ -11,7 +11,7 @@ __metaclass__ = type DOCUMENTATION = r""" 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: - Manage the state of a program or group of programs managed by C(supervisord). extends_documentation_fragment: @@ -67,10 +67,12 @@ options: description: - Path to C(supervisorctl) executable. 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=absent), the module will call 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 O(stop_before_removing=true). + - When O(state=absent), the module will call 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 + O(stop_before_removing=true). requirements: ["supervisorctl"] author: - "Matt Wright (@mattupstate)" diff --git a/plugins/modules/svc.py b/plugins/modules/svc.py index 110b61856a..42b6bcbeb9 100644 --- a/plugins/modules/svc.py +++ b/plugins/modules/svc.py @@ -38,12 +38,13 @@ options: choices: [killed, once, reloaded, restarted, started, stopped] downed: 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 enabled: 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 - restart). + - 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 restart). type: bool service_dir: description: diff --git a/plugins/modules/svr4pkg.py b/plugins/modules/svr4pkg.py index 926dbad448..34aa599e01 100644 --- a/plugins/modules/svr4pkg.py +++ b/plugins/modules/svr4pkg.py @@ -36,7 +36,8 @@ options: description: - Whether to install (V(present)), or remove (V(absent)) a package. - 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 choices: ["present", "absent"] type: str @@ -44,9 +45,10 @@ options: src: description: - 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)." - - 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. + - "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)." + - 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 proxy: description: diff --git a/plugins/modules/swupd.py b/plugins/modules/swupd.py index 14c381bc5a..5b5dbbc48a 100644 --- a/plugins/modules/swupd.py +++ b/plugins/modules/swupd.py @@ -35,8 +35,8 @@ options: type: str manifest: description: - - The manifest contains information about the bundles at certain version of the OS. Specify a Manifest version to verify against that version - or leave unspecified to verify against the current version. + - The manifest contains information about the bundles at certain version of the OS. Specify a Manifest version to verify + against that version or leave unspecified to verify against the current version. aliases: [release, version] type: int name: @@ -46,7 +46,8 @@ options: type: str state: 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 choices: [present, absent] type: str diff --git a/plugins/modules/syslogger.py b/plugins/modules/syslogger.py index ca9aebfcfc..382f1c8422 100644 --- a/plugins/modules/syslogger.py +++ b/plugins/modules/syslogger.py @@ -35,8 +35,8 @@ options: type: str description: - Set the log facility. - choices: ["kern", "user", "mail", "daemon", "auth", "lpr", "news", "uucp", "cron", "syslog", "local0", "local1", "local2", "local3", "local4", - "local5", "local6", "local7"] + choices: ["kern", "user", "mail", "daemon", "auth", "lpr", "news", "uucp", "cron", "syslog", "local0", "local1", "local2", + "local3", "local4", "local5", "local6", "local7"] default: "daemon" log_pid: description: diff --git a/plugins/modules/systemd_creds_decrypt.py b/plugins/modules/systemd_creds_decrypt.py index a6c7126b2e..fbe80f2f16 100644 --- a/plugins/modules/systemd_creds_decrypt.py +++ b/plugins/modules/systemd_creds_decrypt.py @@ -13,9 +13,9 @@ DOCUMENTATION = r""" module: systemd_creds_decrypt short_description: C(systemd)'s C(systemd-creds decrypt) plugin 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: - - Thomas Sjögren (@konstruktoid) + - Thomas Sjögren (@konstruktoid) version_added: '10.2.0' extends_documentation_fragment: - community.general.attributes @@ -29,50 +29,46 @@ attributes: details: - This action does not modify state. options: - name: - description: - - The credential name to validate the embedded credential name. - type: str - required: false - newline: - description: - - Whether to add a trailing newline character to the end of the output, - if not present. - type: bool - required: false - default: false - secret: - description: - - The secret to decrypt. - type: str - required: true - timestamp: - description: - - The timestamp to use to validate the V(not-after) timestamp that - was used during encryption. - - Takes a timestamp specification in the format described in - V(systemd.time(7\)). - type: str - required: false - transcode: - description: - - Whether to transcode the output before returning it. - type: str - choices: [ base64, unbase64, hex, unhex ] - required: false - user: - description: - - A user name or numeric UID when decrypting from a specific user context. - - If set to the special string V(self) it sets the user to the user - of the calling process. - - Requires C(systemd) 256 or later. - type: str - required: false + name: + description: + - The credential name to validate the embedded credential name. + type: str + required: false + newline: + description: + - Whether to add a trailing newline character to the end of the output, if not present. + type: bool + required: false + default: false + secret: + description: + - The secret to decrypt. + type: str + required: true + timestamp: + description: + - The timestamp to use to validate the V(not-after) timestamp that was used during encryption. + - Takes a timestamp specification in the format described in V(systemd.time(7\)). + type: str + required: false + transcode: + description: + - Whether to transcode the output before returning it. + type: str + choices: [base64, unbase64, hex, unhex] + required: false + user: + description: + - A user name or numeric UID when decrypting from a specific user context. + - If set to the special string V(self) it sets the user to the user of the calling process. + - Requires C(systemd) 256 or later. + type: str + required: false notes: - C(systemd-creds) requires C(systemd) 250 or later. """ -EXAMPLES = """ +EXAMPLES = r""" - name: Decrypt secret community.general.systemd_creds_decrypt: name: db @@ -86,16 +82,14 @@ EXAMPLES = """ RETURN = r""" value: - description: - - The decrypted secret. - - Note that Ansible only supports returning UTF-8 encoded strings. - If the decrypted secret is binary data, or a string encoded in another - way, use O(transcode=base64) or O(transcode=hex) to circument this - restriction. You then need to decode the data when using it, for - example using the P(ansible.builtin.b64decode#filter) filter. - type: str - returned: always - sample: "access_token" + description: + - The decrypted secret. + - Note that Ansible only supports returning UTF-8 encoded strings. If the decrypted secret is binary data, or a string + encoded in another way, use O(transcode=base64) or O(transcode=hex) to circument this restriction. You then need to + decode the data when using it, for example using the P(ansible.builtin.b64decode#filter) filter. + type: str + returned: always + sample: "access_token" """ diff --git a/plugins/modules/systemd_creds_encrypt.py b/plugins/modules/systemd_creds_encrypt.py index 07b68f96f2..6f6e635416 100644 --- a/plugins/modules/systemd_creds_encrypt.py +++ b/plugins/modules/systemd_creds_encrypt.py @@ -13,9 +13,9 @@ DOCUMENTATION = r""" module: systemd_creds_encrypt short_description: C(systemd)'s C(systemd-creds encrypt) plugin 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: - - Thomas Sjögren (@konstruktoid) + - Thomas Sjögren (@konstruktoid) version_added: '10.2.0' extends_documentation_fragment: - community.general.attributes @@ -29,50 +29,46 @@ attributes: details: - This action does not modify state. options: - name: - description: - - The credential name to embed in the encrypted credential data. - type: str - required: false - not_after: - description: - - The time when the credential shall not be used anymore. - - Takes a timestamp specification in the format described in - V(systemd.time(7\)). - type: str - required: false - pretty: - description: - - Pretty print the output so that it may be pasted directly into a - unit file. - type: bool - required: false - default: false - secret: - description: - - The secret to encrypt. - type: str - required: true - timestamp: - description: - - The timestamp to embed into the encrypted credential. - - Takes a timestamp specification in the format described in - V(systemd.time(7\)). - type: str - required: false - user: - description: - - A user name or numeric UID to encrypt the credential for. - - If set to the special string V(self) it sets the user to the user - of the calling process. - - Requires C(systemd) 256 or later. - type: str - required: false + name: + description: + - The credential name to embed in the encrypted credential data. + type: str + required: false + not_after: + description: + - The time when the credential shall not be used anymore. + - Takes a timestamp specification in the format described in V(systemd.time(7\)). + type: str + required: false + pretty: + description: + - Pretty print the output so that it may be pasted directly into a unit file. + type: bool + required: false + default: false + secret: + description: + - The secret to encrypt. + type: str + required: true + timestamp: + description: + - The timestamp to embed into the encrypted credential. + - Takes a timestamp specification in the format described in V(systemd.time(7\)). + type: str + required: false + user: + description: + - A user name or numeric UID to encrypt the credential for. + - If set to the special string V(self) it sets the user to the user of the calling process. + - Requires C(systemd) 256 or later. + type: str + required: false notes: - C(systemd-creds) requires C(systemd) 250 or later. """ -EXAMPLES = """ +EXAMPLES = r""" - name: Encrypt secret become: true community.general.systemd_creds_encrypt: @@ -88,10 +84,10 @@ EXAMPLES = """ RETURN = r""" value: - description: The Base64 encoded encrypted secret. - type: str - returned: always - sample: "WhQZht+JQJax1aZemmGLxmAAAA..." + description: The Base64 encoded encrypted secret. + type: str + returned: always + sample: "WhQZht+JQJax1aZemmGLxmAAAA..." """ from ansible.module_utils.basic import AnsibleModule diff --git a/plugins/modules/sysupgrade.py b/plugins/modules/sysupgrade.py index 26232cd98d..cb9eb08226 100644 --- a/plugins/modules/sysupgrade.py +++ b/plugins/modules/sysupgrade.py @@ -42,7 +42,8 @@ options: fetch_only: description: - 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 type: bool installurl: diff --git a/plugins/modules/taiga_issue.py b/plugins/modules/taiga_issue.py index b66db29dba..4e6f3aa676 100644 --- a/plugins/modules/taiga_issue.py +++ b/plugins/modules/taiga_issue.py @@ -88,8 +88,8 @@ options: author: Alejandro Guirao (@lekum) requirements: [python-taiga] notes: - - The authentication is achieved either by the environment variable E(TAIGA_TOKEN) or by the pair - of environment variables E(TAIGA_USERNAME) and E(TAIGA_PASSWORD). + - The authentication is achieved either by the environment variable E(TAIGA_TOKEN) or by the pair of environment variables + E(TAIGA_USERNAME) and E(TAIGA_PASSWORD). """ EXAMPLES = r""" diff --git a/plugins/modules/terraform.py b/plugins/modules/terraform.py index 9db63df68d..106702ea01 100644 --- a/plugins/modules/terraform.py +++ b/plugins/modules/terraform.py @@ -44,15 +44,15 @@ options: - 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 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 - the plugins. See the examples below for a tree output of an example plugin directory. + show a simple directory of files, but actually, the directory structure has to follow the same structure you would + see if Terraform auto-downloaded the plugins. See the examples below for a tree output of an example plugin directory. type: list elements: path version_added: 3.0.0 workspace: description: - - The terraform workspace to work with. This sets the E(TF_WORKSPACE) environmental variable that is used to override workspace selection. - For more information about workspaces have a look at U(https://developer.hashicorp.com/terraform/language/state/workspaces). + - The terraform workspace to work with. This sets the E(TF_WORKSPACE) environmental variable that is used to override + workspace selection. For more information about workspaces have a look at U(https://developer.hashicorp.com/terraform/language/state/workspaces). type: str default: default purge_workspace: @@ -64,26 +64,28 @@ options: type: bool plan_file: 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 - that this option is required if 'state' has the 'planned' value. + - 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 that this option is required if 'state' has the 'planned' value. type: path state_file: 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 - be used. + - The path to an existing Terraform state file to use when building plan. If this is not specified, the default C(terraform.tfstate) + will be used. - This option is ignored when plan is specified. type: path variables_files: 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 elements: path aliases: ['variables_file'] variables: description: - - A group of key-values pairs to override template variables or those in variables files. By default, only string and 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). + - A group of key-values pairs to override template variables or those in variables files. By default, only string and + 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). - Ansible integers or floats are mapped to terraform numbers. - Ansible strings are mapped to terraform strings. - Ansible dictionaries are mapped to terraform objects. @@ -94,15 +96,16 @@ options: complex_vars: description: - 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 - quoted. + - If V(true) the O(variables) also accepts dictionaries, lists, and booleans to be passed to C(terraform). Strings that + are passed are correctly quoted. - When disabled, supports only simple variables (strings, integers, and floats), and passes them on unquoted. type: bool default: false version_added: 5.7.0 targets: 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 elements: str default: [] @@ -117,8 +120,8 @@ options: type: int force_init: 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 - you intend to provision an entirely new Terraform deployment. + - 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 you intend to provision an entirely new Terraform deployment. default: false type: bool overwrite_init: @@ -133,8 +136,8 @@ options: type: dict backend_config_files: 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 - configuration files. + - 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 configuration files. type: list elements: path version_added: '0.2.0' @@ -152,8 +155,8 @@ options: version_added: '1.3.0' check_destroy: description: - - Apply only when no resources are destroyed. Note that this only prevents "destroy" actions, but not "destroy and re-create" actions. This - option is ignored when O(state=absent). + - Apply only when no resources are destroyed. Note that this only prevents "destroy" actions, but not "destroy and re-create" + actions. This option is ignored when O(state=absent). type: bool default: false version_added: '3.3.0' @@ -239,7 +242,8 @@ EXAMPLES = r""" RETURN = r""" outputs: 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 sample: '{"bukkit_arn": {"sensitive": false, "type": "string", "value": "arn:aws:s3:::tf-test-bukkit"}' contains: @@ -262,7 +266,8 @@ stdout: sample: '' command: 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 sample: terraform apply ... """ diff --git a/plugins/modules/timezone.py b/plugins/modules/timezone.py index 12a0addd33..c0eb9e5872 100644 --- a/plugins/modules/timezone.py +++ b/plugins/modules/timezone.py @@ -12,14 +12,14 @@ DOCUMENTATION = r""" module: timezone short_description: Configure timezone setting 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 - M(ansible.builtin.service) module. + - 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 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. - - Several different tools are used depending on the OS/Distribution involved. For Linux it can use C(timedatectl) or edit C(/etc/sysconfig/clock) - 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 - 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 - a minimal installation like Alpine Linux). + - Several different tools are used depending on the OS/Distribution involved. For Linux it can use C(timedatectl) or edit + C(/etc/sysconfig/clock) 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 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 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. extends_documentation_fragment: - community.general.attributes @@ -39,7 +39,8 @@ options: description: - Whether the hardware clock is in UTC or in local timezone. - 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. - I(Only used on Linux). type: str @@ -48,8 +49,8 @@ options: notes: - 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 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 - to take effect. Note that AIX 6.1+ is needed (OS level 61 or newer). + - 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 to take effect. Note that AIX 6.1+ is needed (OS level 61 or newer). author: - Shinichi TAMURA (@tmshn) - Jasper Lievisse Adriaanse (@jasperla) diff --git a/plugins/modules/twilio.py b/plugins/modules/twilio.py index 21cc09a272..09169075a1 100644 --- a/plugins/modules/twilio.py +++ b/plugins/modules/twilio.py @@ -15,9 +15,10 @@ short_description: Sends a text message to a mobile phone through Twilio description: - Sends a text message to a phone number through the Twilio messaging API. 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. - - 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. + - 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. + - 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: - community.general.attributes attributes: diff --git a/plugins/modules/typetalk.py b/plugins/modules/typetalk.py index 6364cdc45b..505c1a4abd 100644 --- a/plugins/modules/typetalk.py +++ b/plugins/modules/typetalk.py @@ -35,7 +35,7 @@ options: topic: type: int description: - - Topic id to post message. + - Topic ID to post message. required: true msg: type: str