Getting information about the error notification email settings

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 gets information about settings related to the sending of email notifications for the service information messages (SIMs) of storage systems.

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

Execution permission

Storage Administrator (View Only)

Request line

GET 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

None.

Response message

Body
{
  "isEmailNotificationEnabled" : true,
  "mailServer" : {
    "serverName" : "server1",
    "smtpAuth" : {
      "isSmtpAuthEnabled" : false,
      "account" : "user1",
      "password" : "****"
    }
  },
  "fromAddress" : "from@example.com",
  "replyToAddress" : "replyTo@example.com",
  "toAddresses" : [
   {
    "attribute" : "to",
    "address" : "to@example.com"
   } 
  ],
  "description" : "description"
}

Attribute

Type

Description

isEmailNotificationEnabled

boolean

Whether notification by error notification emails is enabled
  • true: Enabled
  • false: Disabled

mailServer

object

Settings related to the server that sends the error notification emails

The IP address or host name of the server is displayed, along with the following SMTP authentication settings.

  • serverName (string)

    IP address or host name of the server

  • smtpAuth (object)

    SMTP authentication settings for the server

    • isSmtpAuthEnabled (boolean)

      Whether SMTP authentication is enabled

      true: Enabled

      false: Disabled

    • account (string)

      Account (user name) for SMTP authentication

    • password (string)

      Password for SMTP authentication

      If a password is set, four asterisks (****) are displayed.

      If no password is set, an empty character string is displayed.

fromAddress

string

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

replyToAddress

string

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

toAddresses

object[]

Array of destination addresses for error notification emails

If destination addresses for error notification emails are set, the following information is output:
  • attribute (string)

    An attribute of a destination address for error notification emails.

    Either to, cc, or bcc is output.

  • address (string)

    A destination address for error notification emails.

description

string

Information displayed at the beginning of an error notification email

Additional notification information that is displayed at the beginning of an error notification email is output.

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 GET https://192.0.2.100/ConfigurationManager/v1/objects/alert-email-settings/instance