trapmapper
AlarmMapping

The Generic NE Alarm Mapping type. Allows the definition of a trap to alarm mapping specifying the alarm type, probable cause, alarmed object, severity and additional text to be used when creating an alarm from a received trap.



public class AlarmMapping

Properties
additionalText A template that should be processed by the mapper into a string. This result string will be added to the additional text of the alarm if non-null and non-empty.

type=string
default=Source Trap OID ${trapOid}
minimum=0
maximum=300
Displayed(tab/group)=Additional Text (/Alarm)

adminState Indicates whether mapping should be used during trap processing.

type=trapmapper.AdminStatus
default=up
Displayed(tab/group)=Administrative State

alarmName The name of the alarm to be raised.

type=trapmapper.GneAlarmNameType
default=GneCommunicationAlarm
Displayed(tab/group)=Alarm Name (/Alarm Name)

alarmNameVarBindIdx Indicates the varbind position that contains the in-value passed to the alarm name transform function used in an alarm mapping.

type=long
default=1
minimum=1
maximum=99
Displayed(tab/group)=Varbind Position (/Alarm Name)

clearingMapping If the mappingType is raising and the mapping is implicitlyCleared, points to the mapping (clearing mapping) that handles the clearing of the alarm raised through this mapping. The clearing mapping exists in the same catalogue as this mapping. The property will be automatically set, when specifying a clearing mapping for this mapping.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Clearing Mapping (/Clearing Mapping)

fdnExtension A template that should be processed by the mapper into a string. This result string will be added to the alarm name and additional text of the alarm if non-null and non-empty. The result string will be truncated to be no longer than 128 characters.

type=string
minimum=0
maximum=300
Displayed(tab/group)=FDN Extension (/Alarm)

implicitlyCleared Indicates whether the generated alarm will be marked as implicitly cleared.

type=boolean
access=read-only
default=false
Displayed(tab/group)=Implicitly Cleared (/Alarm)

interfaceIndexVarBindIdx Indicates the varbind position that contains the interface index of the NE on which the alarm is to be raised. A value of 0 indicates that the alarm shall be raised against the NE.

type=long
default=0
minimum=0
maximum=99
Displayed(tab/group)=Interface Index Varbind Position (/Alarmed Object)

mappingType The type of the mapping: either Raising, Clearing, or Raising/Clearing. A raising mapping will raise an alarm, while a clearing mapping will clear an alarm (severity is cleared). A clearing mapping is always linked to exactly one raising mapping, while a raising mapping can exist without a clearing mapping.

type=trapmapper.MappingType
access=read-only
default=Raising
Displayed(tab/group)=Mapping Type

probableCause Indicates the probable cause of the alarm to be raised. See the first column of fm.probableCause for values for this property.

type=string
Displayed(tab/group)=Probable Cause (/Probable Cause)

probableCauseVarBindIdx Indicates the varbind position that contains the in-value passed to the probable cause transform function used in an alarm mapping.

type=long
default=1
minimum=1
maximum=99
Displayed(tab/group)=Varbind Position (/Probable Cause)

raisingMapping If the mappingType is clearing (clearing mapping), points to the mapping (raising mapping) that handles the raising of the alarm cleared through this mapping. The raising mapping has to exists in the same catalogue as this mapping. When specifying a clearing mapping, this property has to be set to a non-default value. The property cannot be modified after creation of this clearing mapping.

type=Pointer
default=
Displayed(tab/group)=Raising Mapping (/Raising Mapping)

severity Indicates the severity of the alarm to be raised.

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

severityVarBindIdx Indicates the varbind position that contains the in-value passed to the severity transform function used in an alarm mapping.

type=long
default=1
minimum=1
maximum=99
Displayed(tab/group)=Varbind Position (/Severity)

systemAddressVarBindIdx Indicates the varbind position that contains the system address of the NE on which the alarm is to be raised. A value of 0 indicates that the alarm shall be raised against the NE that issued the trap.

type=long
default=0
minimum=0
maximum=99
Displayed(tab/group)=System Address Varbind Position (/Alarmed Object)

transformFnAlarmNamePointer Indicates the full name of the alarm name transform function to be used in an alarm mapping.

type=Pointer
default=
Displayed(tab/group)=Transform Function (/Alarm Name)

transformFnProbableCausePointer Indicates the full name of the probable cause transform function to be used in an alarm mapping.

type=Pointer
default=
Displayed(tab/group)=Transform Function (/Probable Cause)

transformFnSeverityPointer Indicates the full name of the severity transform function to be used in an alarm mapping.

type=Pointer
default=
Displayed(tab/group)=Transform Function (/Severity)

trapName The name of the trap to be mapped.

type=string
minimum=0
maximum=128
Displayed(tab/group)=Trap Name

trapOid An Object ID of the trap to be mapped. Should be of the form .1.3.6.1.4.1.6527.3.1...

type=string
access=read-create
minimum=2
maximum=128
Mandatory on create
Displayed(tab/group)=Trap OID

useTransformFnAlarmName Indicates whether an alarm name transform function should be used in an alarm mapping.

type=boolean
default=false
Displayed(tab/group)=Specify Transform Function (/Alarm Name)

useTransformFnProbableCause Indicates whether a probable cause transform function should be used in an alarm mapping.

type=boolean
default=false
Displayed(tab/group)=Specify Transform Function (/Probable Cause)

useTransformFnSeverity Indicates whether a severity transform function should be used in an alarm mapping.

type=boolean
default=false
Displayed(tab/group)=Specify Transform Function (/Severity)

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