Managed Object - AlarmManager

Property of
ServiceContent
See also
Alarm, AlarmDescription, AlarmExpression, 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* PAlarmExpression[]

The default setting for each alarm expression, used to populate the initial client wizard screen.
description PAlarmDescription

The static descriptive strings used in alarms.
*May not be presentP Required privilege: System.View

Methods

Methods defined in this Managed Object
CreateAlarm, GetAlarm, GetAlarmState

CreateAlarm

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

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

The entity with which the alarm is associated.
specAlarmSpec

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



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

NameTypeDescription
_thisManagedObjectReference 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
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



GetAlarmState

The state of instantiated alarms on the entity.

Required Privileges
None

Parameters

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

The entity.
P Required privilege: System.Read

Return Value

Type Description
AlarmState[]The state of instantiated alarms.

Faults

Type Description
InvalidArgumentThrown if the referenced entity is null.
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