Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Alerts object model

The object model describing this resource contains the following objects.

syslogAlerts
Attribute JSON Type Data Type Description
notificationFrequencyInfostringstring

Frequency to send Information level alerts. Possible values are:

  • IMMEDIATELY
  • NEVER
notificationFrequencySeverestringstring

Frequency to send Severe level alerts. Possible values are:

  • IMMEDIATELY
  • NEVER
notificationFrequencyWarningstringstring

Frequency to send Warning level alerts. Possible values are:

  • IMMEDIATELY
  • NEVER
recipientsarraystringA list of recipients that will be sent syslog messages.
trapDestination
AttributeJSON TypeData TypeDescription
communitystringstringCommunity string for the host.
hoststringstringHost that will receive SNMP traps.
snmpAlerts
AttributeJSON TypeData TypeDescription
notificationFrequencyInfostringstring

Frequency to send Information level alerts. Possible values are:

  • IMMEDIATELY
  • NEVER
notificationFrequencySeverestringstring

Frequency to send Severe level alerts. Possible values are:

  • IMMEDIATELY
  • NEVER
notificationFrequencyWarningstringstring

Frequency to send Warning level alerts. Possible values are:

  • IMMEDIATELY
  • NEVER
portnumberintegerUDP port to use when sending SNMP trap messages. The default port for SNMP traps is 162.
recipientsarrayobjectsA list of trapDestination objects, that specify the recipients of SNMP traps.
smtpAlerts
AttributeJSON TypeData TypeDescription
fromAddressstringstringEmail address used when sending email alert messages.
smtpServerstringstringAddress of the SMTP email server.
emailProfiles
AttributeJSON TypeData TypeDescription
discloseDetailsbooleanbooleanTrue if details are disclosed in the emails – IP address, etc.
excludeAttachmentsbooleanbooleanTrue if attachments are not to be sent.
htmlFormatbooleanbooleanTrue if emails are sent in HTML format.
ignoreNdmpEventsbooleanbooleanTrue if NDMP events are not sent as part of the emails.
isEnabledbooleanbooleanTrue if the email profile is enabled.
maxEmailLengthnumberintegerMaximum size the email is allowed to be, in bytes. Multiple emails will be sent if the size exceeds the maximum length.
namestringstringName of the email profile.
notificationFrequencyInfostringstring

Frequency to send Information level alerts. Possible values are:

  • IMMEDIATELY
  • SUMMARY
  • NEVER
notificationFrequencySeverestringstring

Frequency to send Severe level alerts. Possible values are:

  • IMMEDIATELY
  • SUMMARY
  • NEVER
notificationFrequencyWarningstringstring

Frequency to send Warning level alerts. Possible values are:

  • IMMEDIATELY
  • SUMMARY
  • NEVER
recipientsarraystringA list of email addresses that will receive emails for this profile.
sendDailyStatusEmailsbooleanbooleanTrue if daily status emails are to be sent.
sendEmptyEmailsbooleanbooleanTrue if emails are sent at specific times, even if they contain no events.
summaryTimesarraystringList of times that summary emails will be sent, if enabled.
textstringstringArbitrary text that can be included at the beginning of each email.
uuEncodebooleanbooleanTrue if diagnostic email attachments are uuencoded.

 

  • Was this article helpful?