The alarm API allows the management of system alarms.
| acknowledged |
| description |
| enterpriseID |
| entityScope |
| errorCondition |
| externalID |
| lastUpdatedBy |
| name |
| numberOfOccurances |
| reason |
| severity |
| targetObject |
| timestamp |
This object has no members.
Flag to indicate that alarm is already acknowledged or not
SDK attribute: acknowledged
Description of the alarm
Format: free
SDK attribute: description
Enterprise that this alarm belongs to
Format: free
SDK attribute: enterpriseID
Specify if scope of entity is Data center or Enterprise level
Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope
Identifies the error condition
SDK attribute: errorCondition
External object ID. Used for integration with third party systems
Format: free
SDK attribute: externalID
ID of the user who last updated the object.
Format: free
SDK attribute: lastUpdatedBy
The alarm name. Each type of alarm will generate its own name
Format: free
SDK attribute: name
Number of times that the alarm was triggered
SDK attribute: numberOfOccurances
Provides a description of the alarm
Format: free
SDK attribute: reason
Severity of the alarm.
Allowed values: CRITICAL, INFO, MAJOR, MINOR, WARNING
SDK attribute: severity
Identifies affected Entity. Example: Alarm generated by TCA for Domain domain1(Packets towards a VM, Breach)
Format: free
SDK attribute: targetObject
Indicates the time that the alarm was triggered
SDK attribute: timestamp