Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

Configure SMTP Settings in Deployment Shell

SMTP must be configured in Routing Director for Routing Director to send e-mail notifications to users when their account is created or modified and when subscribed events occur. By default, SMTP is not configured in Routing Director and notifications are not sent.

Table 1 lists the behavior for different scenarios when SMTP and local authentication are configured.

Table 1: Behavior for Different Scenarios when SMTP and Local Authentication are configured

Local Authentication

SMTP

Behavior

Enabled

Disabled

User is authenticated locally based on user accounts created within Routing Director E-mail notifications are not sent to users.

Enabled

Enabled

User is authenticated locally based on user accounts created within Routing Director. E-mail notifications are sent when subscribed alerts or events occur.

Disabled

Enabled

Users are invited to access an organization over an e-mail. Also, users receive notifications for subscribed alerts or events over an e-mail.

Disabled

Disabled

This is not a valid combination. However, a user is locally authenticated based on user account created in Routing Director.

E-mail notifications are not sent for subscribed alerts or events.

A system administrator can configure SMTP in Deployment Shell so that users can be notified when their account is created, activated, or modified.

Enable SMTP Based User Management

To enable SMTP settings in Deployment Shell:

  1. SSH to the node on which you deployed the Routing Director cluster.
  2. Log in to Deployment Shell as the root user.
    You are placed in the operational mode.
  3. Enter the configuration mode.
  4. Configure the following SMTP parameters.
    Where:

    smtp-allowed-sender-domains are the e-mail domains from which Routing Director sends e-mails to users.

    relayhost-hostname is the name of the SMTP server that relays messages.

    relayhost-username (optional) is the username to access the SMTP (relay) server.

    relayhost-password (optional) is the password for the SMTP (relay) server.

    sender-e-mail-address is the e-mail address that appears as the sender's e-mail address to the e-mail recipient.

    sender-name is the name that appears as the sender’s name in the e-mails sent to users from Routing Director.

  5. Disable local user management to perform SMTP-based user management configurations.
  6. Commit the changes and exit the configuration mode.
  7. Add the SMTP configuration parameters to the configuration files.
    Note:

    Ensure that the following parameters are configured in the config.yml configuration file before adding the SMTP parameters to the file.

    • ntp_servers
    • ingress_vip
    • test_agent_gateway_vip
    • web_admin_user
    • web_admin_password
  8. Deploy the SMTP configuration on the node.
    The deployment takes about two to three minutes to complete.
  9. (Optional) Monitor the progress of the deployment.
    After SMTP is enabled, when a superuser invites users to an organization, Routing Director sends e-mail invitations to the users. Routing Director also validates user accounts and notifies users of any modifications to their accounts through e-mails.

Disable SMTP Based User Management

To disable SMTP settings in Deployment Shell:

  1. SSH to the node on which you deployed the Routing Director cluster.
  2. Log in to Deployment Shell as the root user.
    You are placed in the operational mode.
  3. Enter the configuration mode.
  4. Disable the SMTP-based user management configurations.
  5. Enable local user management.
  6. Commit the changes and exit the configuration mode.
  7. Add the updated configuration parameters to the configuration files.
    Note:

    Ensure that the following parameters are configured in the config.yml configuration file before adding the SMTP parameters to the file.

    • ntp_servers
    • ingress_vip
    • test_agent_gateway_vip
    • web_admin_user
    • web_admin_password
  8. Deploy the SMTP configuration on the node.
    The deployment takes about two to three minutes to complete.
    SMTP is disabled in Routing Director.
    Users will not be notified when their account is created, activated, or modified. After adding users to an organization, superusers must manually share the Web URL of Routing Director and credentials (e-mail ID and temporary password) to log in, with the users.

See Also