Overview Package Class Deprecated Help

fm
FaultManager

public class FaultManager

Properties
fm.AlarmHistoryObject-Set type=Children-Set
fm.AlarmName-Set type=Children-Set
fm.AlarmObject-Set type=Children-Set
fm.GlobalPolicy-Set type=Children-Set
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

acknowledgeFault

This method acknowledges the specified alarm.
Input Parameters:
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.
faultObjectFullName : string - Full name of the alarm to be acknowledged.
alteredSeverity : fm.Severity - New severity for the alarm. Unspecified severity leaves the severity unchanged.
urgency : fm.Urgency - New urgency for the alarm. Unspecified urgency leaves the urgency unchanged.
text : string - Text of the alarm note added as part of the acknowledgment.
doMarkAsAcknowledged : boolean - Indicates whether the alarm should be acknowledged or not.
doDelete : boolean - Indicates whether the alarm should be deleted or not.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
fm.FaultManager.acknowledgeFaultException

acknowledgeFaultList

This method acknowledges the specified alarms.
Input Parameters:
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.
faultObjectNameSet : Set (Pointer) - Set of alarm full names to be acknowledged.
alteredSeverity : fm.Severity - New severity, unspecified severity leaves the severity unchanged.
urgency : fm.Urgency - New urgency, unspecified urgency leaves the urgency unchanged.
text : string - Text of the alarm note added as part of the acknowledgment.
doMarkAsAcknowledged : boolean - Indicates whether to acknowledge the alarm or not.
doDelete : boolean - Indicates whether to delete the alarm or not.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
fm.FaultManager.acknowledgeFaultListException

acknowledgeFaultUsingDefaults

This method acknowledges the specified alarm.
Input Parameters:
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.
faultObjectFullName : string - Full name of the alarm to be acknowledged.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
fm.FaultManager.acknowledgeFaultUsingDefaultsException

acknowledgeFaults

This method acknowledges the faults raised against the base instance and each child object that matches the alarmableInstanceFilter criteria.
Input Parameters:
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 - Full name of the parent object for which alarms against it or the child objects are to be acknowledged.
alarmableInstanceFilter : FilterHolder - Filter applied to the parent and child objects.
faultFilter : FilterHolder - Filter applied to alarms before acknowledgement.
scopeType : int - Scope of the parent and child search: 0 = SINGLE_OBJECT 1 = SINGLE_LEVEL 2 = N_LEVELS 3 = WHOLE_SUBTREE
scopeDepth : int - Indicates the depth of the parent and child search, used when scopeType is 1 (SINGLE_LEVEL) or 2 (N_LEVELS).
alteredSeverity : fm.Severity - New severity, unspecified severity leaves the severity unchanged.
urgency : fm.Urgency - New urgency, unspecified urgency leaves the urgency unchanged.
text : string - Text of the alarm note added as part of the acknowledgment.
doMarkAsAcknowledged : boolean - Indicates whether to acknowledge the alarm or not.
doDelete : boolean - Indicates whether to delete the alarm or not.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
fm.FaultManager.acknowledgeFaultsException

alterOLCStateOfFaultList

This method updates the OLC state of the specified alarms.
Input Parameters:
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.
faultObjectNameSet : Set (Pointer) - Set of the alarm full names to have their OLC state updated.
olcState : int - New OLC state.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
fm.FaultManager.alterOLCStateOfFaultListException

alterSeverityOfFault

This method alters the severity of the specified alarm.
Input Parameters:
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.
faultObjectFullName : string - Full name of the alarm to have its severity updated.
severity : int - New severity.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
fm.FaultManager.alterSeverityOfFaultException

alterSeverityOfFaultList

This method alters the severity of the specified alarms.
Input Parameters:
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.
faultObjectNameSet : Set (Pointer) - Set of the alarm full names to have their severity updated.
severity : int - New severity.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
fm.FaultManager.alterSeverityOfFaultListException

alterSeverityOfFaultsOnObject

This method alters the severity of faults raised on the specified affected object.
Input Parameters:
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.
baseInstanceFullName : string - Full name of the affected object for which alarms against it should have their severity updated.
faultFilter : FilterHolder - Filter applied to alarms before altering severity.
severity : int - New severity.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
fm.FaultManager.alterSeverityOfFaultsOnObjectException

alterUrgencyOfFault

This method updates the urgency of the specified alarm.
Input Parameters:
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.
faultObjectFullName : string - Alarm full name for which the urgency is to be updated.
urgency : int - New urgency.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
fm.FaultManager.alterUrgencyOfFaultException

alterUrgencyOfFaultList

This method updates the urgency of the specified alarms.
Input Parameters:
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.
faultObjectNameSet : Set (Pointer) - Set of alarm full names for which the urgency is to be updated.
urgency : int - New urgency.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
fm.FaultManager.alterUrgencyOfFaultListException

alterUrgencyOfFaultsOnObject

This method alters the urgency of the faults raised on the specified object.
Input Parameters:
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.
baseInstanceFullName : string - Full name of the affected object for which alarms against it are to have their urgency updated.
faultFilter : FilterHolder - Filter applied to alarms before altering urgency.
urgency : int - New urgency.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
fm.FaultManager.alterUrgencyOfFaultsOnObjectException

clearFault

This method clears the specified alarm.
Input Parameters:
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.
faultObjectFullName : string - Full name of the alarm to be cleared.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
fm.FaultManager.clearFaultException

clearFaultList

This method clears the specified alarms.
Input Parameters:
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.
faultObjectNameSet : Set (Pointer) - Set of the alarm full names to be cleared.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
fm.FaultManager.clearFaultListException

clearFaultsOnObject

This method clears the faults raised against the base instance that matches the faultFilter criteria.
Input Parameters:
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.
baseInstanceFullName : string - Full name of the affected object on which the alarms should be cleared.
faultFilter : FilterHolder - Filter applied to alarms.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
fm.FaultManager.clearFaultsOnObjectException

editNote

This method edits an alarm note.
Input Parameters:
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.
alarmNoteObjectPointer : string - Full name of the alarm note.
text : string - Edited text.
reasonForChange : int - Reason for change, please refer to fm.AlarmNoteRevisionObject.reasonForChange for details.
textualExplanation : string - Textual explanation for the change.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
fm.FaultManager.editNoteException

findAlarmsForOfn

This method returns a structure that contains every alarm in the self, affecting, aggregated and related categories for the specified object.
Input Parameters:
alarmedObjectOfn : Pointer - Affected object full name for which the alarms are to be retrieved.
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
Output Parameters:
alarmLists : fm.AlarmListsStruct - Alarm list structure.
Exceptions:
fm.FaultManager.findAlarmsForOfnException

findAlarmsForOfns

This method returns a map of the structures that contain every alarm self, affecting, aggregated and related categories for the specified object.
Input Parameters:
alarmedObjectOfns : List (Pointer) - List of affected object full names for which the alarms are to be retrieved.
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
Output Parameters:
alarmListsMap : Map (Pointer to fm.AlarmListsStruct) - Map of alarm structures. The map key is the affected object full name.
Exceptions:
fm.FaultManager.findAlarmsForOfnsException

findAlarmsStatusesForOfn

This method returns a structure that contains the alarm status and aggregated alarm status for the specified object.
Input Parameters:
alarmedObjectOfn : string - Full name of the object for which alarm statuses are to be retrieved.
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
Output Parameters:
alarmStatuses : fm.AlarmStatusesStruct - Alarm statuses for the specified object.
Exceptions:
fm.FaultManager.findAlarmsStatusesForOfnException

findAlarmsStatusesForOfns

This method returns a list of structures that contains the alarm status and aggregated alarm status for the specified objects.
Input Parameters:
alarmedObjectOfns : List (Pointer) - List of full name of the objects for which alarm statuses are to be found.
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
Output Parameters:
alarmStatusesMap : Map (Pointer to fm.AlarmStatusesStruct) - Map of the alarm statuses. The map key is the affected object full name.
Exceptions:
fm.FaultManager.findAlarmsStatusesForOfnsException

findFault

This method returns the specified alarm.
Input Parameters:
alarmInstanceFullName : string - Alarm full name.
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
Output Parameters:
result : fm.AlarmInfo - Alarm for the specified full name.
Exceptions:
fm.FaultManager.findFaultException

findFaultList

This method returns the specified alarms.
Input Parameters:
faultObjectNameSet : Set (Pointer) - Set of alarm full names for which the alarms are to be retrieved.
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
Output Parameters:
result : List (fm.AlarmInfo) - Map of alarms. The alarm full name is the map key.
Exceptions:
fm.FaultManager.findFaultListException

findFaults

This method retrieves all alarms in the network matching the faultFilter criteria and returns a map.
Input Parameters:
faultFilter : FilterHolder - Filter applied to alarms.
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
Output Parameters:
result : List (fm.AlarmInfo) - Map of alarms. The alarm full name is the map key.
Exceptions:
fm.FaultManager.findFaultsException

findFaultsOnObject

This method retrieves alarms on the specified affected object.
Input Parameters:
baseInstanceFullName : string - Full name of the affected object on which the alarms should be listed.
faultFilter : FilterHolder - Filter applied to alarms.
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
Output Parameters:
result : List (fm.AlarmInfo) - Map of alarms on the specified affected object. The alarm full name is the map key.
Exceptions:
fm.FaultManager.findFaultsOnObjectException

findNoteForAlarmInstance

This method retrieves alarm notes for the specified alarm.
Input Parameters:
alarmInstancePointer : string - Full name of the alarm.
filter : FilterHolder - Filter applied to the alarm notes.
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
Output Parameters:
filter : List (summary(fm.AlarmNoteObject)) - List of alarm notes.
Exceptions:
fm.FaultManager.findNoteForAlarmInstanceException

findObjectsAffectingOfn

This method returns a list of the affecting objects full names for the specified object.
Input Parameters:
alarmedObjectOfn : string - Full name of the object for which affecting object full names are to be found.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
affectingObjectsOfns : List (Pointer) - List of full names of the affecting objects.
Exceptions:
fm.FaultManager.findObjectsAffectingOfnException

findObjectsRelatedToOfn

This method returns a list of the related objects full names for the specified object.
Input Parameters:
alarmedObjectOfn : string - Full name of the object for which related object full names are to be found.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
relatedObjectsOfns : List (Pointer) - List of full names of the related objects.
Exceptions:
fm.FaultManager.findObjectsRelatedToOfnException

getAlarms

This method returns all the alarms in the system without relationships (affecting/related objects).
Input Parameters:
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
Output Parameters:
alarms : Map (Pointer to fm.AlarmInfo) - Map of alarms. The alarm full name is the map key.
Exceptions:
fm.FaultManager.getAlarmsException

getCorrelatedAlarmsForOfn

This method returns the correlated alarms for the specified alarm name.
Input Parameters:
alarmInstancePointer : string - Full name of the alarm for which the map of correlated alarms is to be retrieved.
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
Output Parameters:
correlatedAlarms : Map (Pointer to fm.AlarmInfo) - Map of correlated alarms. The correlated alarm full name is the map key.
Exceptions:
fm.FaultManager.getCorrelatedAlarmsForOfnException

reload

This method makes the server reload all the alarms and the appropriate relationships. This method will disable the alarm functionality for the duration of the reload. Fault manager operations will fail for the duration of the reload.
Input Parameters:
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.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
fm.FaultManager.reloadException

removeFault

This method deletes the specified alarm.
Input Parameters:
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.
faultObjectFullName : string - Full name of the alarm to be deleted.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
fm.FaultManager.removeFaultException

removeFaultList

This method deletes the specified alarms.
Input Parameters:
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.
faultObjectNameSet : Set (Pointer) - Set of alarm full names to be deleted.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
fm.FaultManager.removeFaultListException

removeFaultsOnObject

This method deletes alarms on the specified affected object.
Input Parameters:
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.
baseInstanceFullName : string - Full name of the affected object on which the alarms should be deleted.
faultFilter : FilterHolder - Filter applied to alarms before deletion.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
fm.FaultManager.removeFaultsOnObjectException

squelchFaults

DEPRECATED - 7.0R1
OBSOLETE: Functionality is not supported. Use fm.SpecificPolicy.isSquelched instead.
Input Parameters:
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 -
affectSubtree : boolean -
removeExisting : boolean -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
fm.FaultManager.squelchFaultsException

testAlarm

This method generates arbitrary test alarms on any managed object. This method should be used in a development environment only. This method does not perform validation to ensure that alarms with the correct parameters are being raised against the correct object class.
Input Parameters:
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.
objectInstanceName : string - Full name of the managed object on which to create the test alarm.
alarmNameId : int - Alarm name of the test alarm. please refer to fm.AlarmObject.alarmName for details.
alarmTypeId : int - Alarm type of the test alarm. please refer to fm.AlarmObject.type for details.
probableCauseId : int - Probable cause of the test alarm. please refer to fm.AlarmObject.probableCause for details.
severity : fm.Severity - Severity of the test alarm. please refer to fm.AlarmObject.severity for details.
alarmClassTag : string - Alarm class tag of the test alarm. please refer to fm.AlarmObject.alarmClassTag for details.
namingComponent : string - Naming component of the test alarm. Used to distinguish two alarms with the same name, type and probable cause on the same affected object.
additionalText : string - Additional text of the test alarm.
nodeTimeOffset : long - Node time offset indicating the time zone.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
fm.FaultManager.testAlarmException

unsquelchFaults

DEPRECATED - R1
OBSOLETE: Functionality is not supported. Use fm.SpecificPolicy.isSquelched instead.
Input Parameters:
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 -
affectSubtree : boolean -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
fm.FaultManager.unsquelchFaultsException

verifyAlarmStatus

This method verifies the alarm status (loading state and count). A JMS message with the result of the count verification will be sent. Possible results are; loading, max alarm count exceeded, alarm count OK.
Input Parameters:
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false