Search <book_title>...

NetBackup™ for OpenStack Administrator's Guide

Last Published: 2024-09-29

Product(s): NetBackup (10.5)

Configuring the email settings

These settings are used by NetBackup for OpenStack to send email reports of recovery points and restores to users. The email settings must be configured 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 the CLI use the following commands:

Configuring the email settings using the command-line

Set an email setting for the first time or after the deletion.
```
nbosjm 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 should 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.
Update the existing email settings.
```
nbosjm 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.
Show the existing email settings.
```
nbosjm 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.
Delete the email settings.
```
nbosjm setting-delete <setting_name>
```
- <setting_name> Name of the setting to delete.

Table: Email settings

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