The alarm API allows the management of system alarms.
| acknowledged |
| alarmedObjectID |
| description |
| embeddedMetadata |
| enterpriseID |
| entityScope |
| errorCondition |
| externalID |
| lastUpdatedBy |
| numberOfOccurances |
| remedy |
| severity |
| targetObject |
| timestamp |
| title |
This object has no members.
Flag to indicate if the alarm has been acknowledged already.
SDK attribute: acknowledged
Alarmed Object ID
SDK attribute: alarmedObjectID
Description of the alarm
Format: free
SDK attribute: description
Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.
SDK attribute: embeddedMetadata
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
Number of times that the alarm was triggered
SDK attribute: numberOfOccurances
Remedial Actions for the alarm.
Format: free
SDK attribute: remedy
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 at which the alarm was triggered
SDK attribute: timestamp
The alarm title. Each type of alarm will generate its own title
Format: free
SDK attribute: title