Class VcAlarmState

Extends VcDynamicData
Information about the alarm's state.


Name Type Description
acknowledged boolean Flag to indicate if the alarm's actions have been acknowledged for the associated ManagedEntity.
acknowledgedByUser String The user who acknowledged this triggering. If the triggering has not been acknowledged, then the value is not valid.
acknowledgedTime Date The time this triggering was acknowledged. If the triggering has not been acknowledged, then the value is not valid.
alarm VcAlarm Alarm object from which the AlarmState object is instantiated.
entity VcManagedEntity Entity on which the alarm is instantiated.
eventKey Number Contains the key of the event that has triggered the alarm. The value is set only for event based alarms. The value is not set for gray or manually reset alarms (via vim.AlarmManager.setAlarmStatus).
key String Unique key that identifies the alarm.
overallStatus VcManagedEntityStatus Overall status of the alarm object. This is the value of the alarm's top-level expression. In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Since this property is on a DataObject, an update returned by WaitForUpdatesEx may contain values for this property when some other property on the DataObject changes. If this update is a result of a call to WaitForUpdatesEx with a non-empty version parameter, the value for this property may not be current.
time Date Time the alarm triggered.


Name Returns
VcAlarmState() constructor

Returned by

Method Returns
com.vmware.vmo.plugin.vi4.model.VimManagedEntity.getDeclaredAlarmState() VcAlarmState[]
com.vmware.vmo.plugin.vi4.model.VimManagedEntity.getTriggeredAlarmState() VcAlarmState[]
VcAlarmManager.getAlarmState(VcManagedEntity entity) VcAlarmState[]

Referenced in