Search <book_title>...

Veritas NetBackup™ for OpenStack Administrator's Guide

Last Published: 2021-06-07

Product(s): NetBackup (9.1)

Email Settings

These settings are used by NetBackup for OpenStack to send email reports of snapshots and restores to users.

Configuring the Email settings is a must-have to provide Email notification to OpenStack users.

The following information is required to configure the email settings:

SMTP server
SMTP username
SMTP password
SMTP port
SMTP time-out
Sender email address

A test email can be sent directly from the configuration page.

To work with email settings through CLI use the following commands:

To set an email setting for the first time or after deletion use:

workloadmgr setting-create [--description <description>]
                           [--category <category>]
                           [--type <type>]
                           [--is-public {True,False}]
                           [--is-hidden {True,False}]
                           [--metadata <key=value>]
                           <name> <value>

--description Optional description (Default=None). Not required for email settings.
--category Optional setting category (Default=None). Not required for email settings.
--type Settings type. Set to email_settings
--is-public Sets if the setting can be seen publicly. Set to False.
--is-hidden Sets if the setting will always be hidden. Set to False.
--metadata Sets if the setting can be seen publicly. Not required for email settings.
<name> Name of the setting.
<value> Value of the setting.

To update an already set email setting through CLI use:

workloadmgr setting-update [--description <description>]
                           [--category <category>]
                           [--type <type>]
                           [--is-public {True,False}]
                           [--is-hidden {True,False}]
                           [--metadata <key=value>]
                           <name> <value>

--description Optional description (Default=None). Not required for email settings.
--category Optional setting category (Default=None). Not required for email settings.
--type Settings type. Set to email_settings.
--is-public Sets if the setting can be seen publicly. Set to False.
--is-hidden Sets if the setting will always be hidden. Set to False.
--metadata Sets if the setting can be seen publicly. Not required for email settings.
<name> Name of the setting.
<value> Value of the setting.

To show an already set email setting use:

workloadmgr setting-show [--get_hidden {True,False}] <setting_name>

--get_hidden Hidden settings (True) or not (False). Not required for email settings, use False if set.
<setting_name> Name of the setting to show.

To delete a set email setting use:

workloadmgr setting-delete <setting_name>

<setting_name> Name of the setting to delete.

Setting name	Value type	Example
smtp_default___recipient	String	admin@example.net
smtp_default___sender	String	admin@example.net
smtp_port	Integer	587
smtp_server_name	String	Mailserver_A
smtp_server_username	String	admin
smtp_server_password	String	password
smtp_timeout	Integer	10
smtp_email_enable	Boolean	True