Managed Object - Alarm

Property of
AlarmEventArgument, AlarmInfo, AlarmState, EventFilterSpec, TaskFilterSpec, TaskReasonAlarm
Returned by
CreateAlarm, GetAlarm
Extends
ExtensibleManagedObject
See also
AlarmInfo, AlarmSpec


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 PAlarmInfo

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

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

NameTypeDescription
_thisManagedObjectReference A reference to the Alarm used to make the method call.
specAlarmSpec

The new specification for the alarm.

Return Value

Type Description
None

Faults

Type Description
DuplicateNameThrown if an alarm with the name already exists.
InvalidArgumentThrown if the specification is invalid.
InvalidNameThrown if the alarm name is empty or too long.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



RemoveAlarm

Removes the alarm.
Required Privileges
Alarm.Delete

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Alarm used to make the method call.

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.

Show WSDL type definition