Help Center
Choose product document...
Veeam Availability Console 3.0
RESTful API Reference

Alarms

The following resource collections represent Veeam Availability Console alarms:

  • The /notifications/alarmTemplates resource collection represents alarm templates. Alarm templates include predefined and custom alarms.
  • The /notifications/events resource collection represents triggered alarms.

Collection URL

The /notifications/alarmTemplates resource collection is located at the following URL:

https://<Availability-Console>:1281/v2/notifications/alarmTemplates

The /notifications/events resource collection is located at the following URL:

https://<Availability-Console>:1281/v2/notifications/events

Collection Representation Alarms

Alarm Templates

[

 {

   "id": 1,

   "name": "Job state",

   "category": "VM job",

   "internalId": 1,

   "knowledge": {

     "summary": "Job is in a disabled state for more than allowed time period.",

     "cause": "Veeam Backup & Replication server allows to disable scheduled backup jobs during maintenance windows. If backup job stays in a disabled state for more than allowed time period, it should be enabled back.",

     "resolution": "Open Veeam Backup & Replication console and enable all disabled backup jobs."

   },

   "predifined": true,

   "enabled": true,

   "_links": [

     {

       "rel": "self",

       "method": "GET",

       "href": "https://vac:1281/v2/notifications/alarmTemplates/1"

     },

     {

       "rel": "related",

       "method": "GET",

       "href": "https://vac:1281/v2/notifications/alarmTemplates/1/events"

     }

   ]

 },

 {

   "id": 2,

   "name": "Max allowed job duration",

   "category": "VM job",

   "internalId": 2,

   "knowledge": {

     "summary": "Job has exceeded its allowed execution time.",

     "cause": "Veeam job has exceeded the configured threshold of maximum allowed job duration.",

     "resolution": "Verify that VMware CBT was used for all VMs in the configured backup/replication job. Check the number of read and transferred data blocks for each VM, make sure your Veeam proxy servers have sufficient number of concurrently running tasks allowed. Alternatively, adjust the maximum allowed job duration threshold for this alarm."

   },

   "predifined": true,

   "enabled": true,

   "_links": [

     {

       "rel": "self",

       "method": "GET",

       "href": "https://vac:1281/v2/notifications/alarmTemplates/2"

     },

     {

       "rel": "related",

       "method": "GET",

       "href": "https://vac:1281/v2/notifications/alarmTemplates/2/events"

     }

   ]

 }

]

Triggered Alarms

[

 {

   "id": 1,

   "alarmTemplateId": 12,

   "repeatCount": 1,

   "companyId": 4,

   "locationId": 4,

   "computerName": "srv21",

   "objectName": "srv21",

   "lastActivation": {

     "time": "2018-11-23T08:54:56.9967505Z",

     "status": "Resolved",

     "message": "All metrics are back to normal.\r\n",

     "remark": "Automatically resolved.\r\n"

   },

   "_links": [

     {

       "rel": "self",

       "method": "GET",

       "href": "https://vac:1281/v2/notifications/events/2"

     },

     {

       "rel": "related",

       "method": "GET",

       "href": "https://vac:1281/v2/notifications/alarmTemplates/12"

     }

   ]

 },

 {

   "id": 2,

   "alarmTemplateId": 15,

   "repeatCount": 7,

   "companyId": 1,

   "locationId": 0,

   "computerName": "srv49",

   "objectName": "srv49",

   "lastActivation": {

     "time": "2018-11-26T10:34:45.6049307Z",

     "status": "Error",

     "message": "ConnectWise Manage plugin failed to contact Veeam Availability Console. Review debug logs for more information.\r\n",

     "remark": "\r\n"

   },

   "_links": [

     {

       "rel": "self",

       "method": "GET",

       "href": "https://vac:1281/v2/notifications/events/2"

     },

     {

       "rel": "related",

       "method": "GET",

       "href": "https://vac:1281/v2/notifications/alarmTemplates/15"

     }

   ]

 }

]

Veeam Large Logo

Deployment Guide

Guide for Service Providers

Guide for End Users

Guide for Resellers

Usage Scenarios for Service Providers

RESTful API Reference