Email template variables

The values you specify for the body, from, and subject properties of the emailTemplate data type can include variables that correspond to the information available for each log message (for example, the severity of the event that triggered the message or the short description of the event). When sending email, HCP replaces the variables in the email message with the applicable information.

To include a variable in the email template, you specify the variable name preceded by the dollar sign ($). A dollar sign followed by anything other than a variable name is displayed as a dollar sign in the email HCP sends.

The table below lists the variables you can use in the email template.

Variable

Description

$action

The action to take in response to the message

$date

The date and time at which the event occurred (for example, Wed Feb 8 2017 3:15:57 PM EST)

$fullText

The full text of the message

$id

The message ID

$location

The fully qualified name of the HCP system on which the event occurred (for example, hcp-ma.example.com)

$origin

For user-initiated events, the IP address from which the event request was sent and the port through which HCP received the event request, separated by a colon (for example, 192.168.152.181:8000)

$reason

The reason why HCP issued the message

$severity

The severity of the event that triggered the message

$shortText

A brief description of the event that triggered the message

$type

The type of message (General, Security, or Compliance), preceded by Important and a comma if the message is important (for example, Important, Security)

$user

The user ID and username of the event initiator (for example, 105ff38f-4770-4f98-b5b3-8371ab0af359 lgreen)

© 2015, 2020 Hitachi Vantara LLC. All rights reserved.