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

Property of
  ServiceContent
See also
  Alarm, AlarmDescription, AlarmExpression, AlarmFilterSpec, AlarmSpec, AlarmState, ManagedEntity

## Managed Object Description

The alarm manager is a singleton object for managing alarms within a service instance.

Properties

Name | Type | Description
--- | --- | ---
defaultExpression* P | AlarmExpression[] | The default setting for each alarm expression, used to populate the initial client wizard screen.
description P | AlarmDescription | The static descriptive strings used in alarms.

*May not be present P Required privilege: System.View

Methods

Methods defined in this Managed Object
AcknowledgeAlarm, AreAlarmActionsEnabled, ClearTriggeredAlarms, CreateAlarm, EnableAlarmActions, GetAlarm, GetAlarmState

# AcknowledgeAlarm(acknowledgeAlarm)

Acknowledge the alarm on a managed entity. The actions associated with the alarm will not fire until the alarm's next distinct occurrence; that is, until after the alarm has entered the green or gray states at least once. Calling this method on an acknowledged or non-triggered alarm.

Required Privileges
  None
Since
  vSphere API 4.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the AlarmManager used to make the method call.
alarm P | ManagedObjectReference to a Alarm | The Alarm to acknowledge.
entity P | ManagedObjectReference to a ManagedEntity | The ManagedEntity for which to acknowledge the Alarm.

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
InvalidArgument | Thrown if the tuple doesn't exist.
InvalidRequest | Thrown if the referenced alarm/entity is null
ManagedObjectNotFound | Thrown if the referenced alarm/entity is invalid.
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="AcknowledgeAlarm" type="vsan:AcknowledgeAlarmRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="AcknowledgeAlarmResponse"> <complexType/> </element>

# AreAlarmActionsEnabled(getAlarmActionsEnabled)

Returns true if alarm actions are enabled on the specified managed entity.

Required Privileges
  None
Since
  vSphere API 4.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the AlarmManager used to make the method call.
entity P | ManagedObjectReference to a ManagedEntity | The managed entity to look up.

P Required privilege: System.Read

Return Value

Type | Description
--- | ---
xsd:boolean |

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="AreAlarmActionsEnabled" type="vsan:AreAlarmActionsEnabledRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="AreAlarmActionsEnabledResponse"> <complexType> <sequence> <element name="returnval" type="xsd:boolean"/> </sequence> </complexType> </element>

# ClearTriggeredAlarms(clearTriggeredAlarms)

Resets all triggered alarms to green. Should be used when mass alarm reset is needed.

Required Privileges
  Alarm.SetStatus
Since
  vSphere API 6.7

Parameters

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

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="ClearTriggeredAlarms" type="vsan:ClearTriggeredAlarmsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="ClearTriggeredAlarmsResponse"> <complexType/> </element>

# CreateAlarm(create)

Creates an alarm.

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

Required Privileges
  None

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the AlarmManager used to make the method call.
entity P | ManagedObjectReference to a ManagedEntity | The entity with which the alarm is associated.
spec | AlarmSpec | The specification for the new alarm.

P Required privilege: Alarm.Create

Return Value

Type | Description
--- | ---
ManagedObjectReference to a Alarm | A reference to the Alarm object created by the operation.

Faults

Type | Description
--- | ---
DuplicateName | Thrown if an alarm with the name already exists.
InvalidArgument | Thrown if the specification is invalid.
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="CreateAlarm" type="vsan:CreateAlarmRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="CreateAlarmResponse"> <complexType> <sequence> <element name="returnval" type="vsan:ManagedObjectReference"/> </sequence> </complexType> </element>

# EnableAlarmActions(setAlarmActionsEnabled)

Enables or disables alarms on the specified managed entity.

Required Privileges
  None
Since
  vSphere API 4.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the AlarmManager used to make the method call.
entity P | ManagedObjectReference to a ManagedEntity | The managed entity on which to set a schedule.
enabled | xsd:boolean | true, if alarms are enabled during the schedule.

P Required privilege: Alarm.DisableActions

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="EnableAlarmActions" type="vsan:EnableAlarmActionsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="EnableAlarmActionsResponse"> <complexType/> </element>

# GetAlarm(getAlarm)

Available alarms defined on the entity. These alarms do not include any inherited alarms; that is, alarms associated with parent entities.

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the AlarmManager used to make the method call.
entity* | ManagedObjectReference to a ManagedEntity | The entity. If not set, alarms are returned for all visible entities.

*Need not be set

Return Value

Type | Description
--- | ---
ManagedObjectReference[] to a Alarm[] | A reference to the Alarm objects returned by the operation.

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="GetAlarm" type="vsan:GetAlarmRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="GetAlarmResponse"> <complexType> <sequence> <element name="returnval" type="vsan:ManagedObjectReference" minOccurs="0" maxOccurs="unbounded"/> </sequence> </complexType> </element>

# GetAlarmState(getAlarmState)

The state of instantiated alarms on the entity.

Required Privileges
  None

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the AlarmManager used to make the method call.
entity P | ManagedObjectReference to a ManagedEntity | The entity.

P Required privilege: System.Read

Return Value

Type | Description
--- | ---
AlarmState[] | The state of instantiated alarms.

Faults

Type | Description
--- | ---
InvalidRequest | Thrown if the referenced entity is null.
ManagedObjectNotFound | Thrown if the referenced entity is invalid.
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="GetAlarmState" type="vsan:GetAlarmStateRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="GetAlarmStateResponse"> <complexType> <sequence> <element name="returnval" type="vsan:AlarmState" minOccurs="0" maxOccurs="unbounded"/> </sequence> </complexType> </element>