Skip to main content
Version: 3.0

Configure Email Alerts through SMTP Server

Applicable to both Classic and Federated modes

A Portworx Backup user with the px-backup-infra.admin role can configure an SMTP server and add email addresses to send alerts to intended recipients. Data from the Alerts page is sent to the receiver's email for further action. A Portworx Backup user with the px-backup-app.user role can add email addresses (one or multiple) to an existing SMTP configuration created by an infra admin user.

As a Portworx Backup infra admin, you can add a new SMTP configuration using the following instructions.

Prerequisites​

  • SMTP server
  • px-backup-infra.admin role in Portworx Backup

To configure an email alert through SMTP server:

  1. Navigate to Alerts from the left navigation pane and click Email Alerts Configuration tab.

  2. Click Configure Email Alert.

  3. In the Configure SMTP Server for Email Alerts window, populate the following fields:

    Fields marked with an asterisk (*) are mandatory.

    • Name: type a unique identifier for the SMTP configuration

    • Host: enter the hostname or IP address of the SMTP server

    • Port: enter the port number of SMTP server. Standard SMTP ports are listed here:

      • port 25: for server-to-server communication (if not blocked)
      • port 465: if you need direct SSL/TLS encryption and the server supports it
      • port 587: use with STARTTLS for secure email submission from clients (recommended in most cases)

    • From Email: enter the sender's email address that will appear as the sender in the alert email

    • To Email: enter the recipient's email address(es) for the alerts, multiple email addresses are allowed. You can also add email groups of a specific department/team to bulk add multiple email addresses in one go.

  4. Enable the User Authorization toggle to enable SMTP authentication with user ID and password for enhanced security. When you enable this option, the window displays the SMTP user ID and password fields.

    • SMTP User ID: The user ID for the SMTP server authentication

    • Password: the password for the SMTP server authentication

  5. Enable STARTTLS?: if your SMTP server supports STARTTLS protocol, select yes to enable the protocol. By default, STARTTLS option is set to false.

  6. Use Custom Certificates: enable to use custom SSL/TLS certificates for secure connection between the SMTP client and server

    • Certificate File: enter your certificate file data here. This certificate authenticates your SMTP server to establish secure connection.

    • Key File (Optional) : if you have the private key file content associated with your TLS certificate, enter that data here

    • CA File (Optional): key in Certificate Authority (CA) certificate data here. This is optional and validates the SSL/TLS certificate.

    After Portworx Backup adds this configuration, you can view this configuration entry in the Email Alerts Configuration.

  7. Click Validate to check the input data for errors and to verify the successful connection with the SMTP server either with STARTTLS enabled or disabled based on your requirements.

    Upon successful validation, Portworx Backup web console displays a successful notification message.

  8. Click Create to add these configuration settings and set up email alerts.

    After Portworx Backup adds this configuration, you can view this configuration entry in the Email Alerts Configuration.

    After adding an SMTP configuration, the following options are available in the Vertical ellipsis:

    • Manage Email ID's: allows you to add new email IDs/groups or delete the old email IDs/groups
    • Edit: helps you to edit the SMTP configuration if there are any configuration changes
    • Disable: disables sending emails to the email addresses/groups added by the user
    • Remove: allows you to delete this configuration permanently when no longer needed

Add email addresses to SMTP configuration​

Prerequisites​

  • px-backup-app.user role in Portworx Backup

To add users to the existing SMTP configuration:

  1. Navigate to Alerts from the left navigation pane and click Email Alerts Configuration tab.

  2. Click Configure Email Alert. An SMTP configuration appears on this page if the Portworx Backup infra admin has configured an SMTP server for email alerts.

  3. To add email addresses, navigate to the vertical ellipsis of that SMTP configuration and choose Manage Email ID's.

  4. In the Manage Email ID's window, add the required email addresses and click Save. If you need to add multiple email addresses, separate them with a comma.

    note

    • After you have added email addresses, if you need to disable email alerts for all recipients, choose the Disable option from the vertical ellipsis of the SMTP configuration.

    • To remove specific email addresses from receiving email alerts, navigate to the vertical ellipsis, choose Manage Email ID's, and delete the addresses that are no longer required.

Last updated on