close

keyboard_arrow_left

Table of Contents Expand all

play_arrow Introduction
- play_arrow Overview
- play_arrow Access and Manage Paragon Automation Account
play_arrow Administration
- play_arrow Introduction
  - Administration Overview
  - Administration Workflow
- play_arrow Organization Management
- play_arrow Site Management
- play_arrow User Management
- play_arrow Inventory Management
- play_arrow Audit Logs
  - Audit Logs Overview
  - About the Audit Logs Page
- play_arrow Tags
  - About the Tags Page
  - Manage Tags
play_arrow Device Life Cycle Management
- play_arrow Introduction
- play_arrow Day-Wise Activities for Device Life Cycle Management
- play_arrow Field Technician User Interface
  - Field Technician UI Overview
  - Working with Field Technician UI Pages
- play_arrow Onboarding Profiles
- play_arrow Plan Device Onboarding
- play_arrow View Device Onboarding
- play_arrow Device Management
play_arrow Observability
- play_arrow Introduction
  - Observability Overview
- play_arrow Health Dashboard
- play_arrow Troubleshoot Devices
- play_arrow View Network Topology
play_arrow Trust and Compliance
- play_arrow Introduction
  - Trust and Compliance Overview
  - Perform Compliance Scan and Manage Checklists
- play_arrow Manage Trust Settings and Trust Scores
- play_arrow Manage Compliance Scans
- play_arrow Manage Vulnerabilities
- play_arrow Monitor Integrity
play_arrow Service Orchestration
- play_arrow Introduction
  - Service Orchestration Overview
  - Service Provisioning Workflow
- play_arrow View Service Design Catalog
- play_arrow Manage Customers
- play_arrow Add Resources for Network Services
- play_arrow Manage Service Instances
- play_arrow Provision VPN Services
- play_arrow Monitor Service Order Execution Workflows
play_arrow Active Assurance
- play_arrow Introduction
- play_arrow Test Agents
- play_arrow Tests and Monitors
- play_arrow Test Templates
  - About the Test Templates Page
  - Create a Test Template
play_arrow Paragon Shell CLI Reference

list Table of Contents

English

Configure SMTP Settings in Paragon Shell

date_range 14-Nov-24

arrow_backward

arrow_forward

SMTP must be configured in Paragon Automation for Paragon Automation 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 Paragon Automaiton 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 Paragon Automation E-mail notifications are not sent to users.
Enabled	Enabled	User is authenticated locally based on user accounts created within Paragon Automation. 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 Paragon Automation. E-mail notifications are not sent for subscribed alerts or events.

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.

content_copy zoom_out_map
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

[edit]
root@eop-primary# set paragon cluster mail-server smtp-enabled true
```
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 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 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.

content_copy zoom_out_map
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.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
```
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.

content_copy zoom_out_map
root@eop-primary> request paragon deploy cluster input "-t addon-apps,papi -e target_components=papi-kafka-emitter,mailservice"
Process running with PID: 2xxxxx2

The deployment takes about two to three minutes to complete.

(Optional) Monitor the progress of the deployment.
```
root@eop-primary> monitor start /epic/config/log
```
After SMTP is enabled, when a superuser 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.

content_copy zoom_out_map
root@eop-primary> configure
Entering configuration mode

[edit]

Disable the SMTP-based user management configurations.
```
root@eop-primary# set paragon cluster mail-server smtp-enabled false
```

Enable local user management.

content_copy zoom_out_map
root@eop-primary# set paragon cluster papi papi-local-user-management true

Commit the changes and exit the configuration mode.

content_copy zoom_out_map
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_servers

ingress_vip

test_agent_gateway_vip

web_admin_user

web_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=papi-kafka-emitter,mailservice"
Process running with PID: 2xxxxx2
```
The deployment takes about two to three minutes to complete.
SMTP 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.

arrow_backward PREVIOUS Predefined User Roles Overview

NEXT arrow_forward Add Users to an Organization Overview

Juniper Paragon Automation User Guide

ON THIS PAGE

Configure SMTP Settings in Paragon Shell

Enable SMTP Based User Management

Disable SMTP Based User Management

Stay in touch

Helped me install or use the product
Accelerated my deployment

Discuss the product with a co-worker
Make a purchase inquiry

Juniper Paragon Automation User Guide

ON THIS PAGE

Configure SMTP Settings in Paragon Shell

Enable SMTP Based User Management

Disable SMTP Based User Management

See Also

Stay in touch