Alarm

The alarm API allows the management of system alarms.

Overview

acknowledged boolean filterable   orderable  
alarmedObjectID string read only  
description string filterable  
enterpriseID string
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
errorCondition integer
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  
numberOfOccurances integer
reason string filterable   orderable  
severity enum (CRITICAL | INFO | MAJOR | MINOR | WARNING) filterable   orderable  
targetObject string filterable   orderable  
timestamp integer orderable  

API Resource

/alarms/id
delete get put

Parents

/ports/id/alarms
get
/enterprises/id/alarms
get
/redundancygroups/id/alarms
get
/vsgredundantports/id/alarms
get
/ikegatewayconnections/id/alarms
get
/gatewayredundantports/id/alarms
get
/ssidconnections/id/alarms
get
/vscs/id/alarms
get
/vports/id/alarms
get
/tcas/id/alarms
get post
/vrss/id/alarms
get
/hscs/id/alarms
get
/domains/id/alarms
get
/gateways/id/alarms
get
/services/id/alarms
get
/shuntlinks/id/alarms
get
/l2domains/id/alarms
get
/nsgateways/id/alarms
get
/vms/id/alarms
get
/vsds/id/alarms
get
/netconfmanagers/id/alarms
get
/nsgredundancygroups/id/alarms
get
/vlans/id/alarms
get
/wirelessports/id/alarms
get
/containers/id/alarms
get
/nsports/id/alarms
get

Children

/alarms/id/metadatas
get post
/alarms/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

acknowledged boolean filterable   orderable  
Discussion

Flag to indicate if the alarm has been acknowledged already.

Charateristics

SDK attribute: acknowledged

alarmedObjectID string read only  
Discussion

Alarmed Object ID

Charateristics

SDK attribute: alarmedObjectID

description string filterable  
Discussion

Description of the alarm

Charateristics

Format: free
SDK attribute: description

enterpriseID string
Discussion

Enterprise that this alarm belongs to

Charateristics

Format: free
SDK attribute: enterpriseID

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

errorCondition integer
Discussion

Identifies the error condition

Charateristics

SDK attribute: errorCondition

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

name string required   filterable   orderable  
Discussion

The alarm name. Each type of alarm will generate its own name

Charateristics

Format: free
SDK attribute: name

numberOfOccurances integer
Discussion

Number of times that the alarm was triggered

Charateristics

SDK attribute: numberOfOccurances

reason string filterable   orderable  
Discussion

Provides a description of the alarm

Charateristics

Format: free
SDK attribute: reason

severity enum filterable   orderable  
Discussion

Severity of the alarm.

Charateristics

Allowed values: CRITICAL, INFO, MAJOR, MINOR, WARNING
SDK attribute: severity

targetObject string filterable   orderable  
Discussion

Identifies affected Entity. Example: Alarm generated by TCA for Domain domain1(Packets towards a VM, Breach)

Charateristics

Format: free
SDK attribute: targetObject

timestamp integer orderable  
Discussion

Indicates the time at which the alarm was triggered

Charateristics

SDK attribute: timestamp