fm
AlarmObject



public class AlarmObject

Properties
acknowldegedBy Indicates which user acknowledged the alarm.

type=string
default=
maximum=64
Displayed(tab/group)=Acknowledged By

additionalText Contains additional text.

type=string
default=
maximum=4000
Displayed(tab/group)=Additional Text

affectedObjectClassIndex Indicates the affected object class index.

type=int
access=read-only
default=0

affectedObjectClassName Indicates the class name of the object affected by this alarm.

type=string
default=
maximum=100
Displayed(tab/group)=Alarmed Object Type

affectedObjectDisplayedName Indicates the affected object's displayed name.

type=string
access=read-only
default=N/A
maximum=512
Displayed(tab/group)=Alarmed Object Name

affectedObjectFullName Indicates which object is affected by the alarm.

type=string
default=root
maximum=512
Displayed(tab/group)=Alarmed Object ID

affectedObjectInstanceIndex

type=long
access=read-only
default=0

alarmClassTag Indicates the alarm class tag. The alarmClassTag is a concatenation of the package where the alarm is defined and the alarm name.

type=string
access=read-only
default=
maximum=252

alarmName Indicates the alarm name.

type=int
default=0
Displayed(tab/group)=Alarm Name
values

clearedBy Indicates which user cleared the alarm.

type=string
default=
maximum=64

deletedBy Indicates which user deleted the alarm.

type=string
default=
maximum=64

firstTimeDetected Indicates the time when the alarm was first raised.

type=Date
default=0
Displayed(tab/group)=First Time Detected

fm.AlarmNoteObject-Set type=Children-Set
frequency Indicates the frequency at which the alarm is occurring, it is the number of occurrences of the alarm in the last interval.

type=long
default=0

highestSeverity Indicates the highest severity that this alarm was assigned.

type=fm.Severity
default=indeterminate

isAcknowledged Indicates whether the alarm is currently acknowledged.

type=boolean
default=false
Displayed(tab/group)=Is Acknowledged

lastTimeAcknowledged Indicates the last time the alarm was acknowledged.

type=Date
default=0

lastTimeCleared Indicates the last time the alarm was cleared.

type=Date
default=0

lastTimeDeEscalated Indicates the last time the alarm was de-escalated. Alarm escalation/de-escalation occurs when alarm severity is automatically changed based on the frequency of the alarm in a specified interval, as defined by an alarm policy.

type=Date
default=0

lastTimeDemoted Indicates the last time the alarm was demoted. Alarm promotion/demotion occurs in the event in which an alarm severity is changed manually on a specific alarm.

type=Date
default=0

lastTimeDetected Indicates the time the alarm was last raised.

type=Date
default=0
Displayed(tab/group)=Last Time Detected

lastTimeEscalated Indicates the last time the alarm was escalated. Alarm escalation/de-escalation occurs when alarm severity is automatically changed based on the frequency of the alarm in a specified interval, as defined by an alarm policy.

type=Date
default=0

lastTimePromoted Indicates the last time the alarm was promoted. Alarm promotion/demotion occurs in the event in which an alarm severity is changed manually on a specific alarm.

type=Date
default=0

lastTimeSeverityChanged Indicates the last time the alarm severity was changed.

type=Date
default=0

nodeId Indicates the node ID on which this alarm was raised.

type=string
access=read-only
default=N/A
maximum=64
Displayed(tab/group)=Site ID

nodeName Indicates the node name on which this alarm was raised.

type=string
access=read-only
default=N/A
maximum=252
Displayed(tab/group)=Site Name

nodeTimeOffset Indicates the time zone offset of the node on which the alarm is raised.

type=long
default=-1

numberOfOccurences Indicates the number of occurrences of the alarm.

type=long
default=0
Displayed(tab/group)=Number Of Occurrences

numberOfOccurencesSinceAck Indicates the number of occurrences of the alarm since it was acknowledged.

type=long
default=0

numberOfOccurencesSinceClear Indicates the number of occurrences of the alarm since it was cleared.

type=long
default=0

olcState

type=generic.OLCStates
access=read-only
default=inService
Displayed(tab/group)=OLC State

operatorAssignedUrgency Indicates the urgency of the alarm.

type=fm.Urgency
access=read-only
default=indeterminate
Displayed(tab/group)=Assigned Urgency

originalSeverity Indicates the original severity of the alarm.

type=fm.Severity
default=indeterminate

previousSeverity Indicates the previous severity of the alarm.

type=fm.Severity
default=indeterminate

probableCause Indicates the probable cause of the alarm.

type=int
default=0
Displayed(tab/group)=Probable Cause
values

severity Indicates the current severity of the alarm.

type=fm.Severity
default=indeterminate
Displayed(tab/group)=Severity

subscriberId

type=long
access=read-only
default=0

type Indicates the alarm type.

type=int
default=0
Displayed(tab/group)=Alarm Type
values

urgencyAssignedBy Indicates which user assigned the urgency.

type=string
access=read-only
default=N/A
maximum=64

userText Custom user text of the alarm

type=string
default=N/A
minimum=0
maximum=256
Displayed(tab/group)=Custom Text

wasAcknowledged Indicates whether the alarm was previously acknowledged.

type=boolean
default=false

  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed