dellemc.openmanage.ome_application_alerts_smtp (9.1.0) — module

Install collection

Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0

Add to requirements.yml

  collections:
    - name: dellemc.openmanage
      version: 9.1.0

Description

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

Requirements

• python >= 3.8.6

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

---
- 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"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
port:
    default: 443
    description: OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port.
    type: int

ca_path:
    description:
    - The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for
      the validation.
    type: path
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

timeout:
    default: 30
    description: The socket level timeout in seconds.
    type: int
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

use_ssl:
    description: Use SSL to connect with the SMTP server.
    type: bool

hostname:
    description: OpenManage Enterprise or OpenManage Enterprise Modular IP address or
      hostname.
    required: true
    type: str

password:
    description:
    - OpenManage Enterprise or OpenManage Enterprise Modular password.
    - If the password is not provided, then the environment variable C(OME_PASSWORD) is
      used.
    - 'Example: export OME_PASSWORD=password'
    required: true
    type: str

username:
    description:
    - OpenManage Enterprise or OpenManage Enterprise Modular username.
    - If the username is not provided, then the environment variable C(OME_USERNAME) is
      used.
    - 'Example: export OME_USERNAME=username'
    required: true
    type: str

credentials:
    description: The credentials for the SMTP server
    suboptions:
      password:
        description:
        - The password to access the SMTP server.
        required: true
        type: str
      username:
        description:
        - The username to access the SMTP server.
        required: true
        type: str
    type: dict

port_number:
    description: The port number of the SMTP destination server.
    type: int

validate_certs:
    default: true
    description:
    - If C(false), the SSL certificates will not be validated.
    - Configure C(false) only on personally controlled sites where self-signed certificates
      are used.
    - Prior to collection version C(5.0.0), the I(validate_certs) is C(false) by default.
    type: bool
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

destination_address:
    description: The IP address or FQDN of the SMTP destination server.
    required: true
    type: str

enable_authentication:
    description:
    - Enable or disable authentication to access the SMTP server.
    - The I(credentials) are mandatory if I(enable_authentication) is C(true).
    - The module will always report change when this is C(true).
    required: true
    type: bool

Outputs

error_info:
  description: 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.
  type: dict
msg:
  description: Overall status of the SMTP settings update.
  returned: always
  sample: Successfully updated the SMTP settings.
  type: str
smtp_details:
  description: returned when SMTP settings are updated successfully.
  returned: success
  sample:
    Credential:
      Password: null
      User: admin
    DestinationAddress: localhost
    PortNumber: 25
    UseCredentials: true
    UseSSL: false
  type: dict