Overview Package Class Deprecated Help

event
EventPolicy

The Event Policy class enables and controls the number of events collected for various event types.

public class EventPolicy

Properties
administrativeState

type=int
default=1
Displayed(tab/group)=Administrative State
enums=
    1: up - Up
    2: down - Down
eventName

type=string
access=read-create
Mandatory on create
Displayed(tab/group)=Event Type
max

type=int
access=read-create
units=hours
Mandatory on create
Displayed(tab/group)=Maximum Retention Time
min

type=int
access=read-create
units=hours
Mandatory on create
Displayed(tab/group)=Minimum Retention Time
persistence

type=boolean
access=read-create
Mandatory on create
retentionTime

type=int
default=24
units=hours
Displayed(tab/group)=Event Retention Time
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

purge

This method purges the specified events records from the NFM-P database.
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.
className : string - Class name of the records to be purged.
recordFilter : FilterHolder - Filter applied to records of the specified type and class. Records which satisfy the filter are deleted. If the filter is null or empty, then all records of the specified type and class are deleted.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false