# Data Object - AlarmSpec(vim.alarm.AlarmSpec)

Parameter to
  CreateAlarm, ReconfigureAlarm
Extended by
  AlarmInfo
Extends
  DynamicData
See also
  AlarmAction, AlarmExpression, AlarmSetting
Since
  2.0

## Data Object Description

Parameters for alarm creation.

Properties

Name | Type | Description
--- | --- | ---
action* | AlarmAction | Action to perform when the alarm is triggered.
actionFrequency* | xsd:int | Frequency in seconds, which specifies how often appropriate actions should repeat when an alarm does not change state. Since vSphere API 4.0
description | xsd:string | Description of the alarm.
enabled | xsd:boolean | Flag to indicate whether or not the alarm is enabled or disabled.
expression | AlarmExpression | Top-level alarm expression that defines trigger conditions.
name | xsd:string | Name of the alarm.
setting* | AlarmSetting | Tolerance and maximum frequency settings.
systemName* | xsd:string | System name of the alarm. This is set only for predefined Alarms - i.e. Alarms created by the server or extensions automatically. After creation this value cannot be modified. User-created Alarms do not have a systemName at all. The purpose of this field is to identify system-created Alarms reliably, even if they are edited by users. When creating Alarms with systemName, the systemName and the name of the alarm should be equal. When reconfiguring an Alarm with systemName, the same systemName should be passed in the new AlarmSpec. Renaming Alarms with systemName is not allowed, i.e. when reconfiguring, the name passed in the new AlarmSpec should be equal to either the systemName or its localized version (the current name in the Alarm's info). Since vSphere API 5.0
Properties inherited from DynamicData
None

*Need not be set
Show WSDL type definition
<complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="AlarmSpec"> <complexContent> <extension base="vsan:DynamicData"> <sequence> <element name="name" type="xsd:string"/> <element name="systemName" type="xsd:string" minOccurs="0"/> <element name="description" type="xsd:string"/> <element name="enabled" type="xsd:boolean"/> <element name="expression" type="vsan:AlarmExpression"/> <element name="action" type="vsan:AlarmAction" minOccurs="0"/> <element name="actionFrequency" type="xsd:int" minOccurs="0"/> <element name="setting" type="vsan:AlarmSetting" minOccurs="0"/> </sequence> </extension> </complexContent> </complexType>