Specifying settings for error notification emails

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
The following request specifies settings related to the sending of email notifications for the service information messages (SIMs) of storage systems. You can specify, in a batch operation, the server that sends the error notification emails, additional information to be included in each email, and the destination addresses.

For a list of storage systems that support this API, see Overview of the initial settings of a storage system.

Note:

If you locked any resources of the target storage system by using the REST API, you will not be able to use this API function. In such cases, unlock the resources before running the API function.

Execution permission

Storage Administrator (Initial Configuration)

Request line

PATCH base-URL/v1/objects/alert-email-settings/instance

Request message

Object ID

Specify instance.

If an object has only one instance, the instance is the fixed value that specifies the object ID.

Query parameters
None.
Body
{
  "isEmailNotificationEnabled": true,
  "mailServer": {
        "serverName": "server1",
        "smtpAuth" : {
          "account": "user1",
          "password": "userPass"
        }
  },
  "fromAddress" : "from@example.com",
  "replyToAddress" : "reply@example.com",
  "toAddresses" : [
    {
       "attribute" :"to",
       "address" :"to@example.com"
    },
    {
       "attribute" :"cc",
       "address" :"cc@example.com"
    },
    {
       "attribute" :"bcc",
       "address" :"bcc@example.com"
    }    
  ],
  "description" : "description"
}

Attribute

Type

Description

isEmailNotificationEnabled

boolean

(Optional) Whether to enable the sending of error notification emails
  • true: Enabled
  • false: Disabled
If you specify true, be sure to specify at least one source (from) address and one destination address.

mailServer

object

(Optional) Settings related to the server that sends the error notification emails

  • serverName (string)

    (Optional) IP address or host name of the server

    If you want to enable sending error notification emails, be sure to specify the serverName attribute of the mailServer object.

    You can specify an IPv4 address, an IPv6 address, or a host name.

    Specify a name consisting of 1 to 255 characters.

    You can use the following characters in the host name:
    • Alphanumeric characters
    • The following symbols:

      ! $ % - . @ _ ` ~

    You cannot use spaces.

    To delete the IP address or host name of the server for sending emails, specify false for the isEmailNotificationEnabled attribute, and then specify an empty character string for this attribute.

  • smtpAuth (object)

    (Optional) SMTP authentication settings for the server

    • isSmtpAuthEnabled (boolean)

      (Optional) Whether to use SMTP authentication

      true: Use

      false: Do not use

    • account (string)

      (Optional) Account (user name) for SMTP authentication

      You must specify this attribute if true is specified for the isSmtpAuthEnabled attribute.

      Specify a name consisting of 1 to 255 characters.

      You can use the following characters:

      Alphanumeric characters

      The following symbols:

      ! $ % ( ) - . @ _ ` ~

      You cannot use spaces.

      To delete the account (user name) for SMTP authentication, specify false for the isSmtpAuthEnabled attribute, and specify an empty character string for this attribute.

    • password (string)

      (Optional) Password for SMTP authentication

      You must specify this attribute if true is specified for the isSmtpAuthEnabled attribute.

      Specify a password consisting of 1 to 255 characters.

      You can use the following characters:

      Alphanumeric characters

      The following symbols:

      ! $ % ( ) - . @ _ ` ~

      You cannot use spaces.

      To delete the SMTP authentication password, specify false for the isSmtpAuthEnabled attribute, and specify an empty character string for this attribute.

fromAddress

string

(Optional) Source (from) email address from which error notification emails are sent#

In fromAddress, specify a value consisting of 1 to 255 characters.

To delete a source (from) email address from which error notification emails are sent, specify false for the isEmailNotificationEnabled attribute, and then specify an empty character string for this attribute.

replyToAddress

string

(Optional) Reply-destination (reply-to) email address to which replies to error notification emails are to be sent#

In replyToAddress, specify a value consisting of 1 to 255 characters.

To delete the reply-destination (reply-to) address, specify an empty character string.

toAddresses

object[]

(Optional) Array of destination addresses for error notification emails

You can specify up to 32 destination addresses to which error notification emails are to be sent. If you specify this attribute, all destination addresses that are currently registered will be overwritten.

  • attribute (string)

    An attribute of a destination address for error notification emails.

    You must specify this attribute if you specify the toAddresses attribute.

    • to
    • cc
    • bcc
  • address (string)

    A destination address for error notification emails.#

    You must specify this attribute if you specify the toAddresses attribute. Specify an address consisting of 1 to 255 characters.

To delete all registered destination addresses for error notification emails, specify false for the isEmailNotificationEnabled attribute, and then specify an empty array for this attribute.

description

string

(Optional) Information displayed at the beginning of an error notification email

Specify additional notification information to be displayed at the beginning of an error notification email. You can use between 1 and 511 characters.

You can use the following characters:
  • Alphanumeric characters
  • The following symbols:

    ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~

  • Spaces
  • Newlines

    A newline character is counted as two characters.

To delete the information displayed at the beginning of an error notification email, specify an empty character string.

#: You can use the following characters for the source (from) address, reply-destination (reply-to) address, and destination address:
  • Alphanumeric characters

  • The following symbols:

    ! # $ % & ' * + - . = ? @ ^ _ ` { | } ~

You cannot use spaces.

Response message

Body

A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.

Attribute

Description

affectedResources

URL for acquiring settings information about an error notification email

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X PATCH --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/alert-email-settings/instance