# Managed Object - AlarmManager

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

## Managed Object Description

Properties

Name | Type | Description
--- | --- | ---
defaultExpression* P | AlarmExpression[] |
description P | AlarmDescription |

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

Methods

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

# AcknowledgeAlarm

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 | Since vSphere API 4.0
entity P | ManagedObjectReference to a ManagedEntity | Since vSphere API 4.0

P Required privilege - see tooltip for details

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

# AreAlarmActionsEnabled

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 | Since vSphere API 4.0

P Required privilege: entity

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

# ClearTriggeredAlarms

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 P | AlarmFilterSpec | Since vSphere API 6.7

P Required privilege: filter

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

# CreateAlarm

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 | Since null
spec P | AlarmSpec | Since null

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a Alarm |

Faults

Type | Description
--- | ---
DuplicateName |
InvalidName |
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

# DisableAlarm

Required Privileges
  None
Since
  vSphere API 6.9.1

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the AlarmManager used to make the method call.
alarm P | ManagedObjectReference to a Alarm | Since vSphere API 6.9.1
entity P | ManagedObjectReference to a ManagedEntity | Since vSphere API 6.9.1

P Required privilege - see tooltip for details

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

# EnableAlarm

Required Privileges
  None
Since
  vSphere API 6.9.1

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the AlarmManager used to make the method call.
alarm P | ManagedObjectReference to a Alarm | Since vSphere API 6.9.1
entity P | ManagedObjectReference to a ManagedEntity | Since vSphere API 6.9.1

P Required privilege - see tooltip for details

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

# EnableAlarmActions

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 | Since vSphere API 4.0
enabled P | xsd:boolean | Since vSphere API 4.0

P Required privilege - see tooltip for details

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

# GetAlarm

Required Privileges
  System.View

Parameters

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

*Need not be set P Required privilege: entity

Return Value

Type | Description
--- | ---
ManagedObjectReference[] to a Alarm[] |

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

# GetAlarmState

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 | Since null

P Required privilege: entity

Return Value

Type | Description
--- | ---
AlarmState[] |

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