scale_computing.hypercore.smtp module – Modify SMTP configuration 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.smtp.

New in scale_computing.hypercore 1.2.0

Synopsis

  • Use this module to modify a SMTP configuration on HyperCore API.

Parameters

Parameter

Comments

auth_password

string

Password if SMTP server requires authentication.

Required together with auth_user.

auth_user

string

Username if SMTP server requires authentication.

Required together with auth_password.

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.

from_address

string

Email address the system alerts will be sent from.

port

integer / required

TCP port number of the SMTP server.

This parameter must always be provided.

server

string / required

IP address or hostname of the SMTP server.

This parameter must always be provided.

use_ssl

boolean

Enable/disable SSL encryption.

Using SSL is recommended to avoid sending login information in clear text. Ensure the SMTP server supports SSL/TLS connections.

Choices:

  • false ← (default)

  • true

Notes

Note

  • check_mode is not supported.

  • SMTP authentication can be configured using username and password. In this case the configured username is returned, but password is not. Returned password is always empty string (“”).

  • Module is not idempotent if authentication is used. In this case it will always report changed=True.

See Also

See also

scale_computing.hypercore.smtp_info

List SMTP configuration on HyperCore API.

Examples

- name: Modify SMTP configuration (authorization disabled)
  scale_computing.hypercore.smtp:
    server: smtp-relay.gmail.com
    port: 25
    use_ssl: false
    from_address: example@example.com

- name: Modify SMTP configuration (authorization enabled)
  scale_computing.hypercore.smtp:
    server: smtp-relay.gmail.com
    port: 25
    use_ssl: false
    auth_user: example
    auth_password: example123
    from_address: example@example.com

Return Values

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

Key

Description

record

dictionary

Created or updated SMTP Alert configuration.

Returned: success

auth_password

string

Password for authentication if use_auth is true

HyperCore API currently does not allow retrieving configured SMPT password - returned `password` field contains emtpy string “”. To be consistent module returned value is also empty string.

Returned: success

Sample: ""

auth_user

string

Username for authentication if use_auth is true

Returned: success

Sample: ""

from_address

string

Email address the system alerts will be sent from

Returned: success

Sample: "PUB6@scalecomputing.com"

latest_task_tag

dictionary

Latest Task Tag

Returned: success

Sample: {"completed": 1675435601, "created": 1675435601, "descriptionParameters": [], "formattedDescription": "Update Alert SMTP Config", "formattedMessage": "", "messageParameters": [], "modified": 1675435601, "nodeUUIDs": [], "objectUUID": "smtpconfig_guid", "progressPercent": 100, "sessionID": "92b4a736-259c-4f3c-9492-ce0c36691372", "state": "COMPLETE", "taskTag": 761}

port

integer

TCP port of the SMTP server

Returned: success

Sample: 25

server

string

IP address or hostname of the SMTP server

Returned: success

Sample: "smtp-relay.gmail.com"

use_auth

boolean

Is authentication enabled or not

Returned: success

Sample: false

use_ssl

boolean

Enable SSL encryption

Returned: success

Sample: false

uuid

string

Unique identifier

Returned: success

Sample: "smtpconfig_guid"

Authors

  • Ana Zobec (@anazobec)