# Managed Object - Alarm(vim.alarm.Alarm)

Property of
  AlarmEventArgument, AlarmInfo, AlarmState, EventFilterSpec, TaskFilterSpec, TaskReasonAlarm
Parameter to
  AcknowledgeAlarm, DisableAlarm, EnableAlarm
Returned by
  CreateAlarm, GetAlarm
Extends
  ExtensibleManagedObject
See also
  AlarmInfo, AlarmSpec
Since
  2.0

## Managed Object Description

This managed object type defines an alarm that is triggered and an action that occurs due to the triggered alarm when certain conditions are met on a specific ManagedEntity object.

Properties

Name | Type | Description
--- | --- | ---
info P | AlarmInfo | Information about this alarm.
Properties inherited from ExtensibleManagedObject
availableField, value

P Required privilege: System.View

Methods

Methods defined in this Managed Object
ReconfigureAlarm, RemoveAlarm
Methods inherited from ExtensibleManagedObject
setCustomValue

# ReconfigureAlarm(reconfigure)

Reconfigures the alarm properties. This operation requires access privileges on the entity with which the alarm is associated.

In addition to the Alarm.Edit privilege, may also require the Global.ScriptAction if a RunScriptAction action is specified in the AlarmSpec.

Required Privileges
  Alarm.Edit

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the Alarm used to make the method call.
spec P | AlarmSpec | The new specification for the alarm. Since 2.0

P Required privilege: spec

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
DuplicateName | Thrown if an alarm with the name already exists.
InvalidName | Thrown if the alarm name is empty or too long.
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="ReconfigureAlarm" type="vsan:ReconfigureAlarmRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="ReconfigureAlarmResponse"> <complexType/> </element>

# RemoveAlarm(remove)

Removes the alarm.

Required Privileges
  Alarm.Delete

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the Alarm used to make the method call.

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="RemoveAlarm" type="vsan:RemoveAlarmRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="RemoveAlarmResponse"> <complexType/> </element>