No relevant resource is found in the selected language.

This site uses cookies. By continuing to browse the site you are agreeing to our use of cookies. Read our privacy policy>Search

Reminder

To have a better experience, please upgrade your IE browser.

upgrade

Command Reference 10

OceanStor 5300 V3, 5500 V3, 5600 V3, 5800 V3, and 6800 V3 Storage System V300R003

"Based on the CLI, this document describes how to use various commands classified by functions and how to set the CLI and manage the storage system through these commands. The document that you browse online matches the latest C version of the product. Click Download to download documents of other C versions."
Rate and give feedback :
Huawei uses machine translation combined with human proofreading to translate this document to different languages in order to help you better understand the content of this document. Note: Even the most advanced machine translation cannot match the quality of professional translators. Huawei shall not bear any responsibility for translation accuracy and it is recommended that you refer to the English document (a link for which has been provided).
change notification email_extend

change notification email_extend

Function

The change notification email_extend command is used to enable the email-based notification function and configure notification mailboxes. If you want to enable the storage system to automatically send an alarm notification email to a specified mailbox when an alarm is generated, run this command.

Format

change notification email_extend enabled=? { smtp_server_ip=? | smtp_server_domain_name=? } sender=? authentication=? user=? password=? receiver_email_list=? connection_security=? smtp_server_port=? [ function_test=? ] [ clear_email_title_prefix=? ] [ email_title_prefix=? ] [ email_title_level_enable=? ]

Parameters

Parameter

Description

Value

enabled=? Whether to enable the email-based notification function.

The value can be "yes" or "no", where

  • "yes": To enable the email-based alarm notification function.
  • "no": Not to enable the email-based alarm notification function.
The default value is "no".
smtp_server_ip=? IP address of the SMTP server.

-

smtp_server_domain_name=? Domain name of the SMTP server.

The domain name consists of 2 to 255 case-insensitive letters, digits, and hyphens (-). Domain names at various levels are separated by periods (.) and cannot start or end with a hyphen (-). The top-level domain name cannot contain digits only.

sender=? Sender email.

The value consists of 5 to 255 ASCII characters.

authentication=? Whether the SMTP server must be verified by a user.

The value can be "yes" or "no", where

  • "yes": Verification is required.
  • "no": Verification is not required.
user=? Username used to log in to the SMTP server.
NOTE:
This parameter can be specified when "authentication" is set to "yes".

The value consists of 1 to 63 ASCII characters except single quotation marks('), double quotation marks (") and question mark (?).

password=? Password used to log in to the SMTP server.
NOTE:
This parameter can be specified when "authentication" is set to "yes".

The value consists of 1 to 63 ASCII characters except question mark (?).

receiver_email_list=? Recipient mail box.

Multiple email addresses can be specified. Separate email addresses for alarms of different severities with commas (,) and put the email addresses in the order of critical, major, and warning. Separate the email addresses for alarms of the same severity with colons (;). Each email address is 5 to 255 characters in length.

connection_security=? Secure connection mode between the email sending server and the client.

The value can be "none", "ssl/tls", or "starttls", where:

  • "none": No secure connection mode is used.
  • "ssl/tls": ssl/tls is used to encrypt connections to ensure connection security.
  • "starttls": starttls is used.
NOTE:
To ensure data transfer security, secure connection modes are recommended.
smtp_server_port=? Port number of the SMTP server.

The value is an integer between 1 and 65535.

function_test=? Whether to send a test email after the command is executed.

The value can be "yes" or "no", where

  • "yes": To send the test email.
  • "no": Not to send the test email.
email_title_prefix=? Email title prefix.

The value consists of 1 to 511 ASCII characters, it can not contain single quotes.

clear_email_title_prefix=? Clearing the email prefix.

The value must be "yes" which indicate the clear of email prefix.

email_title_level_enable=? Whether to show alarm severities in email titles.

The value can be "yes" or "no",where:

  • "yes": show alarm severities in email titles.
  • "no": Not to show alarm severities in email titles.

Level

Administrator

Usage Guidelines

The command is used to configure only one mail server. The "add smtp_server general", "remove smtp_server general", "change smtp_server config", and "show smtp_server general" commands are used to configure two mail servers. You are advised to use the preceding four commands to configure mail servers for alarm notification.

  • Before running this command, configure an SMTP server and a valid SMTP account.
  • A maximum of 64 email addresses can be configured for alarms of the same severity.
  • After alarm notification by email is configured, the system sends alarms to specified mailboxes by email. The email format is as follows:

    Dear OceanStor S5600T users:

    System Name: Huawei.Storage

    Location: China

    Customer Info: ClientName

    ESN: XXXXXXXXXXXXXXXXXXXX

    ID: 0x1FFFFFFFFFFFFFFB

    Level: Infor

    Occurred At: 2015-06-23 15:58:53

    Detail: This is a test message.

    Repair Suggestion: N/A

  • Each part of the email content is defined as follows:
    • Manufacturer and product type, for example, OceanStor S5600T.
    • Device name, for example, Huawei.Storage.
    • Client of the storage system, for example, ClientName.
    • Device SN, for example, XXXXXXXXXXXXXXXXXXXX.
    • Alarm ID, which indicates a certain type of alarm, expressed in the hexadecimal format, for example, 0x1FFFFFFFFFFFFFFB.
    • Alarm severity. Alarm severities include info, warning, major, and critical.
    • Time when an alarm occurs, for example, 2015-06-23 15:03:36.
    • Alarm description, for example, "This Is A Test Message.".
    • Alarm clearance suggestion, for example, N/A.
  • The value of "connection_secutity" must be consistent with the mailbox server configuration. Otherwise, emails cannot be successfully sent.
  • The query command that corresponds to this command is "show notification email_extend".
  • The following parameters or parameter sets are mutually exclusive: clear_email_title_prefix and email_title_prefix.

Example

Enabling the email-based alarm notification function and setting the sender email address to "a@b.com", SMTP server port to "4232", security connection mode to "ssl/tls", username and password for authenticating the email sending server to "admin" and "123456", email title prefix to "new", and alarm severity display switch to "on".

admin:/>change notification email_extend enabled=yes smtp_server_ip=192.168.3.3 sender=a@b.com authentication=yes user=admin password=****** receiver_email_list=c@d.com connection_security=ssl/tls smtp_server_port=4232 function_test=no email_title_prefix=new email_title_level_enable=yes
Change configuration successfully.

System Response

None

Translation
Download
Updated: 2019-04-04

Document ID: EDOC1000084195

Views: 278296

Downloads: 1559

Average rating:
This Document Applies to these Products
Related Documents
Related Version
Share
Previous Next