dellemc.openmanage.ome_application_alerts_smtp module – This module allows to configure SMTP or email configurations

Note

This module is part of the dellemc.openmanage collection (version 8.5.0).

To install it, use: ansible-galaxy collection install dellemc.openmanage. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: dellemc.openmanage.ome_application_alerts_smtp.

New in dellemc.openmanage 4.3.0

Synopsis

• This module allows to configure SMTP or email configurations on OpenManage Enterprise and OpenManage Enterprise Modular.

Requirements

The below requirements are needed on the host that executes this module.

• python >= 3.8.6

Parameters

Parameter	Comments
ca_path path added in dellemc.openmanage 5.0.0	The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.
credentials dictionary	The credentials for the SMTP server
password string / required	The password to access the SMTP server.
username string / required	The username to access the SMTP server.
destination_address string / required	The IP address or FQDN of the SMTP destination server.
enable_authentication boolean / required	Enable or disable authentication to access the SMTP server. The credentials are mandatory if enable_authentication is true. The module will always report change when this is true. Choices: false true
hostname string / required	OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname.
password string / required	OpenManage Enterprise or OpenManage Enterprise Modular password.
port integer	OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port. Default: 443
port_number integer	The port number of the SMTP destination server.
timeout integer added in dellemc.openmanage 5.0.0	The socket level timeout in seconds. Default: 30
use_ssl boolean	Use SSL to connect with the SMTP server. Choices: false true
username string / required	OpenManage Enterprise or OpenManage Enterprise Modular username.
validate_certs boolean added in dellemc.openmanage 5.0.0	If false, the SSL certificates will not be validated. Configure false only on personally controlled sites where self-signed certificates are used. Prior to collection version 5.0.0, the validate_certs is false by default. Choices: false true ← (default)

Notes

Note

• The module will always report change when enable_authentication is true.

• Run this module from a system that has direct access to Dell OpenManage Enterprise or OpenManage Enterprise Modular.

• This module support check_mode.

Examples

---
- name: Update SMTP destination server configuration with authentication
  dellemc.openmanage.ome_application_alerts_smtp:
    hostname: "192.168.0.1"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    destination_address: "localhost"
    port_number: 25
    use_ssl: true
    enable_authentication: true
    credentials:
      username: "username"
      password: "password"
- name: Update SMTP destination server configuration without authentication
  dellemc.openmanage.ome_application_alerts_smtp:
    hostname: "192.168.0.1"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    destination_address: "localhost"
    port_number: 25
    use_ssl: false
    enable_authentication: false

Return Values

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

Key	Description
error_info dictionary	Details of the HTTP Error. Returned: on HTTP error Sample: {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to update the SMTP settings because the entered credential is invalid or empty.", "MessageArgs": [], "MessageId": "CAPP1106", "RelatedProperties": [], "Resolution": "Either enter valid credentials or disable the Use Credentials option and retry the operation.", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}
msg string	Overall status of the SMTP settings update. Returned: always Sample: "Successfully updated the SMTP settings."
smtp_details dictionary	returned when SMTP settings are updated successfully. Returned: success Sample: {"Credential": {"Password": null, "User": "admin"}, "DestinationAddress": "localhost", "PortNumber": 25, "UseCredentials": true, "UseSSL": false}

Authors

• Sachin Apagundi(@sachin-apa)

Collection links

Issue Tracker Homepage Repository (Sources)