SMTP
SMTP stands for Simple Mail Transfer Protocol. This protocol facilitates the flow of emails over the Internet. You can configure CipherTrust Manager to automatically send email notifications for record-based alarms to a set of email addresses, by configuring an SMTP server.
Note
Email notifications will be sent for built-in alarms such as Disk Full
, Cluster Node Down
, and NAE TLS Disabled
.
Note
CipherTrust Manager 2.3.0 supports both TLS and TCP based SMTP connection. Default is TLS.
Adding a New SMTP Server
To add a new SMTP server:
Log on to the CipherTrust Manager console as administrator.
Click Admin Settings.
Go to the Notifications > SMTP section.
Click New SMTP Server. The Configure a SMTP Server dialog box is displayed.
Specify the following details:
Hostname or IP Address: Specify the hostname or IP address of the SMTP server.
Note
If using a Hostname, make sure that it is added to the CipherTrust Manager. To read more, go to Configuring DNS Hosts .
Port: Specify the port of the SMTP server.
Allow TCP: Select the check box to allow TCP connection with SMTP server. The default value is false.
Note
When both TLS and TCP (allow TCP is true) connections are available with SMTP server, then by default TLS connection will be used.
Username: Specify the Username for the SMTP server.
Sender's Email: Specify the email address from where the email is to be sent.
Password: Specify the Password for the SMTP server's Username.
Click Save. The SMTP server is configured. The server details will appear in the SMTP Server Settings section.
Note
You can configure only one SMTP server at a time. If you add a new SMTP server, the new server will replace the older SMTP server configuration.
Tip
After configuring the SMTP server, click Test SMTP Connection button to test the connection with the SMTP server. If the server is configured correctly, the Sender's email address will receive a test email.
Note
After updating the SMTP settings, wait for sometime (approx. 3-5 minutes) for the changes to be effective.
Adding/Deleting Emails in the Notification Address List
To view, add, or delete the email addresses that will receive the email notifications:
Log on to the CipherTrust Manager console as administrator.
Click Admin Settings.
Go to the Notifications > SMTP section.
The list of notification email address will be displayed under Email Notification Settings section.
To add a new email address, click Add Email. Specify the desired email address and click Save.
To delete an existing email address, click Delete.
Managing SMTP Servers using ksctl
The following operations can be performed:
Add SMTP Servers
List all SMTP Servers
Delete SMTP Servers
Adding SMTP Servers
To add a SMTP server, run:
Syntax
ksctl notification smtp-servers add --server <Server-Name> --port <Port> --username <Username> --emailfrom <Email-Sender> --smtppw <Password> --allow-tcp
Example Request
ksctl notification smtp-servers add --server smtp.gmail.com --port 587 --username abc@xyz.com --emailfrom abc@xyz.com --smtppw admin123 --allow-tcp
Example Response
{
"id": "404a8530-4d49-40bc-a372-8ccd496e1ad3",
"uri": "kylo:kylo:notification:smtp_server:404a8530-4d49-40bc-a372-8ccd496e1ad3",
"account": "kylo:kylo:admin:accounts:kylo",
"application": "ncryptify:gemalto:admin:apps:kylo",
"devAccount": "ncryptify:gemalto:admin:accounts:gemalto",
"createdAt": "2021-02-18T06:35:40.542578Z",
"server": "smtp.gmail.com",
"port": 587,
"username": "abc@xyz.com",
"email_from": "abc@xyz.com",
"allow_tcp": true,
"updatedAt": "2021-02-18T06:36:10.154286327Z"
}
Getting List of SMTP Servers
To get a list of SMTP servers, run:
Syntax
ksctl notification smtp-servers list
Example Request
ksctl notification smtp-servers list
Example Response
{
"skip": 0,
"limit": 10,
"total": 1,
"resources": [
{
"id": "404a8530-4d49-40bc-a372-8ccd496e1ad3",
"uri": "kylo:kylo:notification:smtp_server:404a8530-4d49-40bc-a372-8ccd496e1ad3",
"account": "kylo:kylo:admin:accounts:kylo",
"application": "ncryptify:gemalto:admin:apps:kylo",
"devAccount": "ncryptify:gemalto:admin:accounts:gemalto",
"createdAt": "2021-02-18T06:35:40.542578Z",
"server": "smtp.gmail.com",
"port": 587,
"username": "abc@xyz.com",
"email_from": "abc@xyz.com",
"allow_tcp": true,
"updatedAt": "2021-02-18T06:36:10.154286Z"
}
]
}
Deleting SMTP Servers
To delete a SMTP server, run:
Syntax
ksctl notification smtp-servers delete --id
Example Request
ksctl notification smtp-servers delete --id 404a8530-4d49-40bc-a372-8ccd496e1ad3
There will be no response if SMTP server is deleted successfully.
Managing Email Notification Settings using ksctl
The following operations can be performed:
Add email address to notification list
Get details of email addresses from notification list
Fetch email addresses from notification list
Delete email addresses from notification list
Adding Email Address to Notification List
To add an email address to the notification list, run:
Syntax
ksctl notification email add --emailaddr <Email-Address> --meta <String/JSON-File>
Example Request 1
ksctl notification email add --emailaddr abc@xyz.com
Example Response 1
{
"id": "104314bc-b39f-4a5c-be78-4c52b875ef4c",
"uri": "kylo:kylo:notification:email-addresses:104314bc-b39f-4a5c-be78-4c52b875ef4c",
"account": "kylo:kylo:admin:accounts:kylo",
"application": "ncryptify:gemalto:admin:apps:kylo",
"devAccount": "ncryptify:gemalto:admin:accounts:gemalto",
"createdAt": "2021-02-19T09:36:43.419179Z",
"email_id": "abc@xyz.com"
}
Example Request 2
ksctl notification email add --emailaddr abc@xyz.com --meta 'admin email address'
Example Response 2
{
"id": "37ac2548-5deb-4e5d-bb8e-96a17c447e94",
"uri": "kylo:kylo:notification:email-addresses:37ac2548-5deb-4e5d-bb8e-96a17c447e94",
"account": "kylo:kylo:admin:accounts:kylo",
"application": "ncryptify:gemalto:admin:apps:kylo",
"devAccount": "ncryptify:gemalto:admin:accounts:gemalto",
"createdAt": "2021-05-27T04:42:00.377132Z",
"email_id": "abc@xyz.com",
"meta": "admin email address"
}
Example Request 3
ksctl notification email add --emailaddr bob@xyz.com --meta-jsonfile emailMeta.json
Example Response 3
{
"id": "f53c7e4a-0e9a-44de-839b-5142787e3b6a",
"uri": "kylo:kylo:notification:email-addresses:f53c7e4a-0e9a-44de-839b-5142787e3b6a",
"account": "kylo:kylo:admin:accounts:kylo",
"application": "ncryptify:gemalto:admin:apps:kylo",
"devAccount": "ncryptify:gemalto:admin:accounts:gemalto",
"createdAt": "2021-05-27T04:46:47.7163Z",
"email_id": "bob@xyz.com",
"meta": {
"name": "bob"
}
}
Note
Meta field is used to provide additional information (for example, notes/description) that helps to manage email notifications. You can pass meta information through String or JSON file.
Getting Details of Email Addresses from Notification List
To get details of an email address from the notification list, run:
Syntax
ksctl notification email get --id <Resource-ID>
Example Request
ksctl notification email get --id 104314bc-b39f-4a5c-be78-4c52b875ef4c
Example Response
{
"id": "104314bc-b39f-4a5c-be78-4c52b875ef4c",
"uri": "kylo:kylo:notification:email-addresses:104314bc-b39f-4a5c-be78-4c52b875ef4c",
"account": "kylo:kylo:admin:accounts:kylo",
"application": "ncryptify:gemalto:admin:apps:kylo",
"devAccount": "ncryptify:gemalto:admin:accounts:gemalto",
"createdAt": "2021-02-19T09:36:43.419179Z",
"email_id": "abc@xyz.com"
}
Fetching Email Addresses from Notification List
To fetch email addresses from the notification list, run:
Syntax
ksctl notification email list
Example Request
ksctl notification email list
Example Response
{
"skip": 0,
"limit": 10,
"total": 1,
"resources": [
{
"id": "104314bc-b39f-4a5c-be78-4c52b875ef4c",
"uri": "kylo:kylo:notification:email-addresses:104314bc-b39f-4a5c-be78-4c52b875ef4c",
"account": "kylo:kylo:admin:accounts:kylo",
"application": "ncryptify:gemalto:admin:apps:kylo",
"devAccount": "ncryptify:gemalto:admin:accounts:gemalto",
"createdAt": "2021-02-19T09:36:43.419179Z",
"email_id": "abc@xyz.com"
}
]
}
Deleting Email Addresses from Notification List
To delete an email address from the notification list, run:
Syntax
ksctl notification email delete --id <Resource-ID>
Example Request
ksctl notification email delete --id 104314bc-b39f-4a5c-be78-4c52b875ef4c
There will be no response if notification email is deleted successfully.