| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| alarmClassName |
Indicates the name of the specific policy
type=string Displayed(tab/group)=Alarm Policy |
| alarmDebouncingEnabled |
Indicates whether alarm debouncing is enabled. This property is only applicable
to self-clearing alarm policies.
With this flag enabled, alarm clearing events will be held in a cache for a fixed amount
of time corresponding to alarmDebouncingHoldPeriod. Any clear events occurring on the alarm
while debouncing is enabled will NOT be processed. Only one clear event will be processed
when alarmDebouncingHoldPeriod expires.
Alarm raise events will be treated as update events while a clear event is being debounced.
This is because since the alarm was not cleared (clear held in debouncing cache), the alarm
instance still exists, so the raise event is treated as an update.
type=boolean default=false Displayed(tab/group)=Enable Alarm Debouncing (/Alarm Debouncing) |
| alarmDebouncingHoldPeriod |
Indicates the interval of time in seconds after which an alarm clear event will be processed.
Used to debounce multiple rapid raise/clear events by only handling the last clear.
This property is only configurable on self-clearing alarm policies.
type=int default=0 minimum=10 maximum=600 Displayed(tab/group)=Hold Period (seconds) (/Alarm Debouncing) |
| autoAssignedSeverity |
Indicates the initial assigned severity of an alarm
type=fm.Severity default=indeterminate Displayed(tab/group)=Initial Severity Assignment |
| autoAssignedUrgency |
Indicates the initial assigned urgency of an alarm
type=fm.Urgency default=indeterminate Displayed(tab/group)=Automatically Assigned Urgency |
| autoDeletionRule |
Indicates the time after which the ADMC alarm will be deleted
type=fm.AdmcAlarmDeletionRuleType default=noDeletionTime Displayed(tab/group)=Auto Deletion Rule |
| deEscalationEnabled |
Indicates whether alarm severity de-escalation is enabled
type=boolean default=false Displayed(tab/group)=De-escalation (/De-Escalation Threshold) |
| escalationEnabled |
Indicates whether alarm severity escalation is enabled
type=boolean default=false Displayed(tab/group)=Escalation (/Escalation Threshold) |
| fm.DeEscalationThreshold-Set |
type=Children-Set |
| fm.EscalationThreshold-Set |
type=Children-Set |
| groupTag |
DEPRECATED: 9.0R5 - OBSOLETE: Attribute is never used. type=string default=Unspecified minimum=0 maximum=15 Displayed(tab/group)=Group Tag |
| historyEnabled |
DEPRECATED: 9.0R5 - OBSOLETE: Attribute was never used. type=boolean default=true Displayed(tab/group)=History Enabled |
| isSquelched |
Disables the creation of new alarms for the specified policy when true.
Enables the creation of new alarms for the specified policy when false.
type=boolean default=false Displayed(tab/group)=Squelch |
| specificAlarmInterval |
Indicates the time interval specified in the policy for the escalation worker (default: 24 hr)
type=fm.AlarmInterval default=24hours Displayed(tab/group)=Interval |
| userText |
Custom user text to attach to the policy
type=string default= minimum=0 maximum=256 Displayed(tab/group)=Custom Text |
| Properties inherited from ManagedObject |
|---|
| actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed |
| Methods |
|---|
deployer
: Deployer - the deployment state
synchronousDeploy
: boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure
: boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries
: int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval
: long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription
: string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName
: string - the full name of the object.
configInfo
: config(fm.SpecificPolicy) -
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
fm.SpecificPolicy.configureException
policyFilters
: FilterHolder -
resultFilter
: ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
foundPolicies
: List (summary(fm.SpecificPolicy)) -
fm.SpecificPolicy.findSpecificPoliciesException