Skip to main content
Versa Networks

Configure SMTP Notifications

Versa-logo-release-icon.pngFor supported software information, click here.

You can configure Simple Mail Transfer Protocol (SMTP) notifications on Versa Director so that the Director node can send email notifications. For Releases 22.1.3 and later, you can configure SMTP notifications at the system level and for individual tenants.

Configure System-Level SMTP Notifications

To configure SMTP Notifications at the system level:

  1. In Director view, select the Administration tab in the top menu bar.
  2. Select Notification Configuration > SMTP > System in the left menu bar.

    Notification-Configuration-system-level-v2-border.png
     
  3. Click the add-icon.png Add icon. In the SMTP Configuration popup window, enter information for the following fields.

    SMTP-Configuration-border.png
     
    Field Description
    Configuration Name (Required) Enter a name for the SMTP configuration.
    Host Name (Required) Enter the hostname of the SMTP server.
    SSL Port (Required) Enter the SSL port to use on the SMTP server.
    SSL Connection (Group of Fields)
    • Use SSL to connect
    Click to enable SSL security on the email connection.
    • Username
    Enter the username to use to connect to the SMTP server.
    • Password
    Enter the password to use to connect to the SMTP server.
    • Confirm Password
    Enter the password again.
    From (Required) Enter the email address to place in the From: field of the email.
    To Enter the email address to place in the To: field of the email. This is the address that receives the email notification.
    Default Configuration Click to make this the default SMTP configuration.
  4. Click OK.

To send a test email, in the SMTP > System screen, select a hostname and then click the send-test-email-icon.png Send Test Email icon.

send-test-email-system-v2-border.png

Configure SMTP for Tenants

For Releases 22.1.3 and later.

You can configure SMTP notifications at the tenant level to allow client functions, such as SecureAccess and ForgotPassword, to send email notifications to users in the tenant organization. You can configure multiple SMTP notifications for a single organization, but an organization can have only one default configuration.

You can configure a tenant to push its SMTP configuration to any of its child tenants. If you do not configure SMTP notifications for a tenant organization or its parent organization, any existing SMTP configurations from previous releases are used for the system-level SMTP notification configuration.

When configuring SMTP notifications for tenants, note the following:

  • You cannot create multiple SMTP notification configurations that have the same hostname and username.
  • Saving or updating an SMTP notification configuration to be the default overrides any existing default configuration.
  • Only the owner organization can update the SMTP configuration. If a non-owner organization attempts to update the SMTP configuration, an error occurs.
  • Only the owner organization that created the configuration can delete it unless no other organization is linked to the configuration.
  • Deleting a non-owner SMTP notification configuration deletes only the link to that configuration. The actual SMTP configuration continues to exist in the owner organization.
  • An SMTP notification configuration can be inherited only once.
  • All the SMTP notification configurations that are being linked must belong to the parent organization.
  • If a child tenant inherits an SMTP configuration from a parent tenant, only the following SMTP configuration details are displayed:
    • configName
    • defaultConfig
    • isInherited

To configure SMTP notifications for a tenant:

  1. In Director view, select the Administration tab in the top menu bar.
  2. Select Notification Configuration > SMTP > Tenant in the left menu bar.
  3. Select the organization in the horizontal menu bar.

    Notification-Configuration-tenant-level-add-border.png
     
  4. To add a new SMTP configuration, click the add-icon.png Add icon. In the SMTP Configuration popup window, enter information for the following fields.

    SMTP-Configuration-border.png
     
    Field Description
    Configuration Name (Required) Enter a name for the SMTP configuration.
    Host Name (Required) Enter the hostname of the SMTP server.
    SSL Port (Required) Enter the SSL port to use on the SMTP server.
    SSL Connection (Group of Fields)
    • Use SSL to connect
    Click to enable SSL security on the email connection.
    • Username
    Enter the username to use to connect to the SMTP server.
    • Password
    Enter the password to use to connect to the SMTP server.
    • Confirm Password
    Enter the password again.
    From (Required) Enter the email address to place in the From: field of the email.
    To Enter the email address to place in the To: field of the email. This is the address that receives the email notification.
    Default Configuration Click to make this the default SMTP configuration.
  5. Click OK.
  6. To send a test email, in the SMTP > Tenant screen, select a hostname and then click the click the send-test-email-icon.png Send Test Email icon.

    send-test-email-tenant-border.png
     

To have a tenant organization push an SMTP configuration to one or more child tenants:

  1. In Director view, select the Administration tab in the top menu bar.
  2. Select Notification Configuration > SMTP > Tenant in the left menu bar.
  3. Select the organization in the horizontal menu bar.

    Notification-Configuration-tenant-level-push-border.png
  4. Click the Push SMTP Configurations icon. The Available pane displays a list of the SMTP configurations that have already been created.

    push-SMTP-configs.png
     
  5. In the Available pane, click Select to select the configuration to push to the tenant. The SMTP configuration moves to the Selected pane. To make a configuration name the default SMTP configuration, click the checkbox in the Selected pane.

    push-SMTP-configs-default-border.png
     
  6. Click OK.

Supported Software Information

Releases 20.2 and later support all content described in this article, except:

  • Releases 22.1.3 and later add support for tenant-level SMTP configuration; SMTP configuration screen has its own UI screen, separate from the SMS Notifications configuration UI screen.