Configure SMTP Settings in Paragon Shell
A system administrator can configure SMTP in Paragon 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 Paragon Shell:
- SSH to the node on which you deployed the Paragon Automation cluster.
-
Log in to Paragon Shell as the root user.
You are placed in the operational mode.
-
Enter the configuration mode.
root@eop-primary> configure Entering configuration mode [edit]
-
Configure the following SMTP parameters.
root@eop-primary# set paragon cluster mail-server smtp-allowed-sender-domains sender-domains [edit] root@eop-primary# set paragon cluster mail-server smtp-relayhost relayhost-hostname [edit] root@eop-primary# set paragon cluster mail-server smtp-relayhost-username relayhost-username [edit] root@eop-primary# set paragon cluster mail-server smtp-relayhost-password relayhost-password [edit] root@eop-primary# set paragon cluster mail-server smtp-sender-email sender-e-mail-address [edit] root@eop-primary# set paragon cluster mail-server smtp-sender-name sender-name
Where:smtp-allowed-sender-domains are the e-mail domains from which Paragon Automation sends e-mails to users.
relayhost-hostname is the name of the SMTP server that relays messages.
relayhost-username (optional) is the user name 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 Paragon Automation.
-
Disable local user management to perform SMTP-based user management
configurations.
root@eop-primary# set paragon cluster papi papi-local-user-management False
-
Commit the changes and exit the configuration mode.
root@eop-primary# commit and-quit commit complete Exiting configuration mode
-
Add the SMTP configuration parameters to the configuration files.
Note:
Ensure that the following parameters are configured in the config.ymlconfiguration file before adding the SMTP parameters to the file.
ntp_serversingress_viptest_agent_gateway_vipweb_admin_userweb_admin_password
root@eop-primary> request paragon config Paragon inventory file saved at /epic/config/inventory Paragon config file saved at /epic/config/config.yml
-
Deploy the SMTP configuration on the node.
root@eop-primary> request paragon deploy cluster input "-t addon-apps,papi -e target_components=mailservice" Process running with PID: 2xxxxx2
-
(Optional) Monitor the progress of the deployment.
root@eop-primary> monitor start /epic/config/log
After SMTP is enabled, when a Super User invites users to an organization, Paragon Automation sends e-mail invitations to the users. Paragon Automation 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 Paragon Shell:
- SSH to the node on which you deployed the Paragon Automation cluster.
-
Log in to Paragon Shell as the root user.
You are placed in the operational mode.
-
Enter the configuration mode.
root@eop-primary> configure Entering configuration mode [edit]
-
Disable the SMTP-based user management configurations.
root@eop-primary# set paragon cluster papi papi-local-user-management True
-
Commit the changes and exit the configuration mode.
root@eop-primary# commit and-quit commit complete Exiting configuration mode
-
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_serversingress_viptest_agent_gateway_vipweb_admin_userweb_admin_password
root@eop-primary> request paragon config Paragon inventory file saved at /epic/config/inventory Paragon config file saved at /epic/config/config.yml
-
Deploy the SMTP configuration on the node.
root@eop-primary> request paragon deploy cluster input "-t papi" Process running with PID: 2xxxxx2
SMTP settings is disabled in Paragon Automation.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 Paragon Automation and credentials (e-mail ID and temporary password) to log in, with the users.