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* PAlarmExpression[]


description PAlarmDescription


*May not be presentP 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

NameTypeDescription
_thisManagedObjectReference A reference to the AlarmManager used to make the method call.
alarm PManagedObjectReference
to a Alarm

Since vSphere API 4.0
entity PManagedObjectReference
to a ManagedEntity

Since vSphere API 4.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown 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

NameTypeDescription
_thisManagedObjectReference A reference to the AlarmManager used to make the method call.
entity PManagedObjectReference
to a ManagedEntity

Since vSphere API 4.0
P Required privilege: entity

Return Value

Type Description
xsd:boolean

Faults

Type Description
RuntimeFaultThrown 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

NameTypeDescription
_thisManagedObjectReference A reference to the AlarmManager used to make the method call.
filter PAlarmFilterSpec

Since vSphere API 6.7
P Required privilege: filter

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown 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

NameTypeDescription
_thisManagedObjectReference A reference to the AlarmManager used to make the method call.
entity PManagedObjectReference
to a ManagedEntity

Since null
spec PAlarmSpec

Since null
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a Alarm

Faults

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

NameTypeDescription
_thisManagedObjectReference A reference to the AlarmManager used to make the method call.
alarm PManagedObjectReference
to a Alarm

Since vSphere API 6.9.1
entity PManagedObjectReference
to a ManagedEntity

Since vSphere API 6.9.1
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown 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

NameTypeDescription
_thisManagedObjectReference A reference to the AlarmManager used to make the method call.
alarm PManagedObjectReference
to a Alarm

Since vSphere API 6.9.1
entity PManagedObjectReference
to a ManagedEntity

Since vSphere API 6.9.1
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown 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

NameTypeDescription
_thisManagedObjectReference A reference to the AlarmManager used to make the method call.
entity PManagedObjectReference
to a ManagedEntity

Since vSphere API 4.0
enabled Pxsd:boolean

Since vSphere API 4.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown 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

NameTypeDescription
_thisManagedObjectReference A reference to the AlarmManager used to make the method call.
entity* PManagedObjectReference
to a ManagedEntity

Since null
*Need not be set P Required privilege: entity

Return Value

Type Description
ManagedObjectReference[]
to a Alarm[]

Faults

Type Description
RuntimeFaultThrown 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

NameTypeDescription
_thisManagedObjectReference A reference to the AlarmManager used to make the method call.
entity PManagedObjectReference
to a ManagedEntity

Since null
P Required privilege: entity

Return Value

Type Description
AlarmState[]

Faults

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

Events

Type
None