Introduction
The Utility Tokens are used in the Alert escalation policy configuration for alert details and resource in the notifications template or incident creation.
Alert
Alert
| Name | Token | Description |
|---|---|---|
| Alert partner name | $alert.mspName | Partner organization of the escalated alert. |
| Alert client name | $alert.resource.clientName | Client organization of the escalated alert. |
| Alert id | $alert.uniqueId | ID of the escalated alert. |
| Alert subject | $alert.subject | Subject of the escalated alert. |
| Alert description | $alert.description | Description of the escalated alert. |
| Alert created time | $alert.createdDate | Time when the escalated alert was created. |
| Alert updated time | $alert.updatedTime | Time when the escalated alert last repeated. |
| Alert last updated time | $alert.alertTime | Time when the escalated alert was last updated. |
| Alert state | $alert.currentState | Current state of the escalated alert. |
| Alert metric | $alert.serviceName | Metric that generated the escalated alert. |
| Alert repeat count | $alert.repeatCount | Number of times the escalated alert repeated. |
| Alert external id | $alert.extAlertId | External ID of an third party alert that is currently escalated in OpaRamp. |
| Alert elapsed time | $alert.elapsedTimeString | Duration for which the escalated alert has remained open. |
| Alert priority | $alert.priority | Alert priority |
| Alert acknowledged | $alert.acknowledged | Acknowledge the escalated alert by clicking this URL. |
| Alert suppressed | $alert.suppressed | Suppress the escalated alerts by clicking this URL. |
| Alert healed time | $alert.healedTimeString | Show healed time of recovery alert. |
| Recovery alert | $alert.isRecoveryAlert | Verifying given alert is recovery alert or not. |
| Alert technology | $alert.app | Alert Technology |
| Alert type | $alert.alertType | Alert Type |
| Ignore recovery noise | $alert.ignoreRecoveryNoise | Ignore Recovery Noise |
| Alert client id | $alert.clientUniqueId | Client Unique Id of alert. |
| Alert Component | $alert.component | Alert Component |
| Correlated Alerts | $alert.correlatedAlerts | Correlated alert details of the Inference. |
| Availability Alert | $alert.availability | Verifying the alert is availability alert or not. |
| Alert Problem Area | $alert.problemArea | Alert Problem Area | Alert action | $utils.getAlertAction ($alert.uniqueId) | alert action detail |
| Alert Description in plain format | $alert.plainDescription | Alert Description in plain format. |
| Alert Created Date in Format | $function.convertDate ($alert.createdDate, "yyyy-MM-dd HH:mm:ssZ", "GMT") | Alert Created Date in required format. Note: You can modify the time format and time zone. |
| Alert Updated Date in Format | $function.convertDate ($alert.updatedTime, "yyyy-MM-dd HH:mm:ssZ", "GMT") | Alert Updated Date in required format. Note: You can modify the time format and time zone. |
| Alert Created Date in Client's Time Zone | $function.convertDate ($alert.clientUniqueId, $alert.createdDate, "yyyy-MM-dd HH:mm:ssZ") | Alert created Date in client timezone. Note: You can modify the time format and time zone. |
| Alert Updated in Client's Time Zone | $function.convertDate ($alert.clientUniqueId, $alert.updatedTime, "yyyy-MM-dd HH:mm:ssZ") | Alert Updated Date in client timezone. Note: You can modify the time format and time zone. |
| Resource Components/Dependencies | $function.deviceDependencies ($alert.resource.uniqueId, $alert.clientUniqueId) | Resource Components/ Resource Dependencies |
Client
Client
| Name | Token | Description |
|---|---|---|
| Client Service Name | $alert.clientServiceName | Purchased Service of client. |
Resource
Resource
| Name | Token | Description |
|---|---|---|
| Resource name | $alert.resource.name | Name of resources whose alerts are currently escalated by a policy. |
| Resource IP | $alert.resource.ipAddress | IP address of resource on which escalated alert was generated. |
| Resource alias name | $alert.resource.aliasName | Alias name of resources whose alerts are currently escalated by a policy. |
| Resource device group | $alert.resource.deviceGroups | Device group of the escalated alerts resource. |
| Resource site name | $alert.resource.siteName | Site of the escalated alerts resource. |
| Resource service group | $alert.resource.serviceGroups | Service group of the escalated alerts resource. |
| Resource AWS account id | $alert.resource.awsAccountId | Alert device AWS Account id. |
| Resource AWS instance name | $alert.resource.awsCustomAttrName | Alert AWS Instance name. |
| Resource instance id | $alert.resource.instanceId | Alert Resource Instance id. |
| Resource RDS DB name | $alert.resource.rdsDbName | Alert Resource RDS DB Name. |
| Resource Alternate IP | $alert.resource.alternateIP | Alternate IP address of resource on which escalated alert was generated. |
| Alert Resource Type | $alert.resource.resourceType | Resource Type for which escalated alert was generated. |
| Resource Serial Number | $alert.resource.serialNumber | Serial Number of Resource. |
| Resource DNS Name | $alert.resource.dnsName | DNS Name of Resource. |
| Resource UUID | $alert.resource.uniqueId | Resource UUID |
| Resource OS Name | $alert.resource.osName | OS Name of Resource. |
| Resource Make | $alert.resource.make | Make of Resource. |
| Resource Model | $alert.resource.model | Model of Resource. |
| Resource description | $alert.resource.description | Description of Resource. |
Policy
Policy
| Name | Token | Description |
|---|---|---|
| Policy name | $policy.name | Policy name |
Notification
Notification
| Name | Token | Description |
|---|---|---|
| Users notified | $notification.recipients.user.name | Users notified |
| Notification priority | $notification.priority | Notification priority |
Email Subject
Email Subject
| Name | Token | Description |
|---|---|---|
| Escalate alert policy | $policyName | Name of the escalate alert policy. |
| Escalated resource count | $resourcesCount | Total number of resources whose alerts are currently escalated by a policy. |
| Escalated alert count | $alertsCount | Total number of alerts which are currently escalated by a policy. |
| Resource Alias Name | $resourceAliasName | Alias name of resources whose alerts are currently escalated by a policy. |
| Escalate alert priority | $priority | Priority of the escalate alert policy. |
| Alert ID | $alert.id | ID of the escalated alert. |
| Alert subject | $alert.subject | Subject of the escalated alert. |
| Alert partner name | $alert.mspName | Partner organization of the escalated alert. |
| Alert client name | $alert.clientName | Client organization of the escalated alert. |
| Alert resource name | $alert.deviceName | Name of resource on which escalated alert was generated. |
| Alert resource IP | $alert.deviceIp | IP address of resource on which escalated alert was generated. |
| Alert state | $alert.state | Current state of the escalated alert. |
| Metric | $alert.serviceName | Metric that generated the escalated alert. |
| Recovery Alert | $isRecoveryAlert | Verifying given alert is recovery alert or not. |
| Alert Healed Time | $alertHealedIn | Show healed time of recovery alert. |
Email Content
Email Content
| Name | Token | Description |
|---|---|---|
| Escalate alert policy | $policyName | Name of the escalate alert policy. |
| Other users notified | $notifiedUsers | Users in current and previous levels who received notification. |
| Escalated resource count | $resourcesCount | Total number of resources whose alerts are currently escalated by a policy. |
| Escalated alert count | $alertsCount | Total number of alerts which are currently escalated by a policy. |
| Customer | $customerNames | List of customers applicable for escalate alert policy. |
| Escalated resource name | $resourceNames | Name of resources whose alerts are currently escalated by a policy. |
| Escalated resource alias name | $resourceAliasName | Alias name of resources whose alerts are currently escalated by a policy. |
| Escalate alert priority | $priority | Priority of the escalate alert policy. |
| Alert ID | $alert.id | ID of the escalated alert. |
| Alert subject | $alert.subject | Subject of the escalated alert. |
| Alert description | $alert.description | Description of the escalated alert. |
| Alert partner name | $alert.mspName | Partner organization of the escalated alert. |
| Alert client name | $alert.clientName | Client organization of the escalated alert. |
| Alert priority name | $alert.priorityName | Name of alert priority. |
| First alert time | $alert.createdDateString | Time when the escalated alert was created. |
| Last alert time | $alert.updatedDateString | Time when the escalated alert last repeated. |
| Alert last update time | $alert.alertTime | Time when the escalated alert was last updated. |
| Alert elapsed time | $duration | Duration for which the escalated alert has remained open. |
| Alert resource name | $alert.deviceName | Name of resource on which escalated alert was generated. |
| Alert resource IP | $alert.deviceIp | IP address of resource on which escalated alert was generated. |
| Alert state | $alert.state | Current state of the escalated alert. |
| Metric | $alert.serviceName | Metric that generated the escalated alert. |
| Alert repeat count | $alert.count | Number of times the escalated alert repeated. |
| Alert external ID | $alert.extAlertId | External ID of an third party alert that is currently escalated in OpsRamp. |
| Acknowledge Alert | $acknowledge | Acknowledge the escalated alerts by clicking this URL. |
| Device Group | $deviceGroups | Device group of the escalated alerts resource. |
| Site | $sites | Site of the escalated alerts resource. |
| Service Group | $services | Service group of the escalated alerts resource. |
| Suppress Alert | $suppress | Suppress the escalated alerts by clicking this URL. |
| Recovery Alert | $isRecoveryAlert | Verifying given alert is recovery alert or not. |
| Alert Healed Time | $alertHealedIn | Show healed time of recovery alert. |
SMS content
SMS content
| Name | Token | Description |
|---|---|---|
| Escalate alert policy | $policyName | Name of the escalate alert policy. |
| Escalated resource count | $resourcesCount | Total number of resources whose alerts are currently escalated by a policy. |
| Escalated alert count | $alertsCount | Total number of alerts which are currently escalated by a policy. |
| Customer | $customerNames | List of customers applicable for escalate alert policy. |
| Escalated resource name | $resourceNames | Name of resources whose alerts are currently escalated by a policy. |
| Escalate alert priority | $priority | Priority of the escalate alert policy. |
| Alert ID | $alert.id | ID of the escalated alert. |
| Alert subject | $alert.subject | Subject of the escalated alert. |
| First alert time | $alert.createdDateString | Time when the escalated alert was created. |
| Alert resource name | $alert.deviceName | Name of resource on which escalated alert was generated. |
| Alert resource IP | $alert.deviceIp | IP address of resource on which escalated alert was generated. |
| Alert state | $alert.state | Current state of the escalated alert. |
| Metric | $alert.serviceName | Metric that generated the escalated alert. |
| Alert repeat count | $alert.count | Number of times the escalated alert repeated. |