Skip to main content
Version: 2.8

Configure email alerts through SMTP server

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

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

Prerequisites​

  • Valid and active SMTP server account
  • px-backup-infra.admin role in Portworx Backup
note

Portworx Backup does not support configuring email alerts using TLS protocol-based SMTP server with custom certificates.

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 an unique identifier for the SMTP configuration
  • 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.
  • Host: enter the hostname or IP address of the SMTP server
  • Port: enter the port number of SMTP server,

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

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

    • Password: the password for the SMTP server authentication

  2. Click Validate to check the input data for errors and to verify the successful connection with the SMTP server

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

  3. Click Create to add this configuration settings to 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, you will see the following options 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 ID(s) 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. You will see an SMTP configuration in this page if the Portworx Backup infra admin has configured SMTP server for email alerts.

  3. To add email ID(s), 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 ID(s) and click Save. If you need to add multiple email IDs separate them with a comma.

    note
    • After you have added email ID(s) and if you need to disable email alerts later for all the email ID(s), you can choose Disable option from the vertical ellipsis of the SMTP configuration.
    • If you want to remove specific email ID(s) from receiving email alerts, navigate to vertical ellipsis, choose Manage Email ID's option and delete the email ID(s) that are no longer required.
Last updated on