Data Object Description

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 automatically. Editing or renaming Alarms from the UI does not affect this value, and 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. *Since* vSphere API 5.0
Properties inherited from DynamicData
dynamicProperty, dynamicType

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 automatically. Editing or renaming Alarms from the UI does not affect this value, and 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.

Since vSphere API 5.0

Properties inherited from DynamicData

dynamicProperty, dynamicType

Need not be set

Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="AlarmSpec">
            <complexContent>
               <extension base="vim25: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="vim25:AlarmExpression"/>
                     <element name="action" type="vim25:AlarmAction" minOccurs="0"/>
                     <element name="actionFrequency" type="xsd:int" minOccurs="0"/>
                     <element name="setting" type="vim25:AlarmSetting" minOccurs="0"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

Data Object - AlarmSpec

Data Object Description