scale_computing.hypercore.email_alert module – Create, update, delete or send test emails to Email Alert Recipients on HyperCore API.

Note

This module is part of the scale_computing.hypercore collection (version 1.6.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install scale_computing.hypercore.

To use it in a playbook, specify: scale_computing.hypercore.email_alert.

New in scale_computing.hypercore 1.2.0

Synopsis

  • Use this module to create, update, delete or send test emails to the Email Alert Recipients configuration on HyperCore API.

  • Module does not support creating or modifying multiple Email Alert Recipients with same email address.

  • Module does allow removing duplicated Email Alert Recipients.

Parameters

Parameter

Comments

cluster_instance

dictionary

Scale Computing HyperCore instance information.

auth_method

string

Select login method. If not set, the value of the SC_AUTH_METHOD environment variable will be used.

Value local - username/password is verified by the HyperCore server (the local users).

Value oidc - username/password is verified by the configured OIDC provider.

Choices:

  • "local" ← (default)

  • "oidc"

host

string / required

The HyperCore instance URL.

If not set, the value of the SC_HOST environment variable will be used.

For example “https://10.1.2.3:443”.

password

string / required

Password used for authentication.

If not set, the value of the SC_PASSWORD environment variable will be used.

timeout

float

Timeout in seconds for the connection with the Scale Computing HyperCore API instance.

If not set, the value of the SC_TIMEOUT environment variable will be used.

username

string / required

Username used for authentication.

If not set, the value of the SC_USERNAME environment variable will be used.

email

string / required

An Email address of a recipient you wish to create, update, delete or send test emails to.

email_new

string

An Email address with which the existing email on the HyperCore API will be updated.

state

string / required

The desired state of the email alert recipient on HyperCore API.

If state=present and email_new wasn’t provided, a new Email Alert Recipient will be added on the HyperCore API.

If state=absent, the Email Alert Recipient with the provided email will be removed from HyperCore API.

If state=test, a test email will be sent to the provided Email Alert Recipient on HyperCore API.

Choices:

  • "present"

  • "absent"

  • "test"

Notes

Note

  • check_mode is not supported.

See Also

See also

scale_computing.hypercore.email_alert_info

List Email Alert Recipients on HyperCore API.

Examples

- name: Create a new Email Alert Recipient
  scale_computing.hypercore.email_alert:
    email: example@example.com
    state: present

- name: Update previously created Email Alert Recipient
  scale_computing.hypercore.email_alert:
    email: example@example.com
    email_new: new@example.com
    state: present

- name: Remove previously updated Email Alert Recipient
  scale_computing.hypercore.email_alert:
    email: new@example.com
    state: absent

- name: Send a test email to an Email Alert Recipient
  scale_computing.hypercore.email_alert:
    email: recipient@example.com
    state: test

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

records

dictionary

Output from modifying entries of the Email Alert Recipients on HyperCore API.

Returned: success

alert_tag_uuid

string

Unique identifier for an AlertTag

Returned: success

Sample: "0"

email

string

Email address of the alert recipient

Returned: success

Sample: "sample@sample.com"

latest_task_tag

dictionary

Latest Task Tag

Returned: success

Sample: {"completed": 1675680830, "created": 1675680830, "descriptionParameters": [], "formattedDescription": "Create Alert Email Target", "formattedMessage": "", "messageParameters": [], "modified": 1675680830, "nodeUUIDs": [], "objectUUID": "8664ed18-c354-4bab-be96-78dae5f6377f", "progressPercent": 100, "sessionID": "2bed8c34-1ef3-4366-8895-360f4f786afe", "state": "COMPLETE", "taskTag": 813}

resend_delay

integer

Alert resend delay in seconds

Returned: success

Sample: 86400

silent_period

integer

Alerts will not resend if there are additional event triggers within this time in seconds

Returned: success

Sample: 900

uuid

string

Unique identifer

Returned: success

Sample: "default-target"

Authors

  • Ana Zobec (@anazobec)