Overview Package Class Deprecated Help

sup
SupervisionGroup

A supervision/monitored group configuration.

public class SupervisionGroup

Properties
autoCreationType Creation criteria for automatic supervision group creation. This can be used for supervision groups that allow multiple methods for automatic group creation, to distinguish between different methods of creation. In that case the default_method should be used for most commonly used creation criteria. If automatic creation for a given supervision group category can be done only based on one criteria, then this property should be set to default_method, i.e. the only possible automatic creation method

type=sup.AutoCreationMethodType
access=read-create
default=defaultMethod
baselineTime Baseline time for "*New*" counters.

type=Date
access=read-only
default=0
category Category supervised objects belong.

type=sup.SupervisionGroupCategory
access=read-create
default=transport
Displayed(tab/group)=Category
description A user provided supervision group description.

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Description
displayedName Unique supervision group name.

type=string
access=read-create
minimum=1
maximum=128
Mandatory on create
Displayed(tab/group)=Displayed Name
filtersAndSpans If "filtersAndSpans", objects in the group must both belong to the assigned spans AND pass at least one of inclusion filters. If "filtersOrSpans", objects in the group must either belong to one of the assigned spans OR pass through at least one inclusion filter.

type=sup.SupervisionGroupObjectMembership
default=filtersAndSpans
Displayed(tab/group)=Supervise Objects Belonging To
grpId

type=long
default=0
minimum=1
maximum=65535
inclusionFilters Only objects passing through one of these filter.SavedFilter objects are included in the SupervisionGroup. At most one filter per class inheritance hierarchy is allowed.

type=Set (Pointer)
monitoredObjectsPointers Transient (not persisted) set of monitored/supervised objects in this supervision group.

type=Set (Pointer)
access=read-only
spans Only objects belonging to one of these security.Span objects are included in the SupervisionGroup. Either spans or inclusionFilters must be set/non-empty. If both are non-empty, supervision group includes only object present in one of the spans AND matching one of the filters. If only spans are set (i.e. inclusionFilters are empty), all span objects are included in the group. If only inclusionFilters are set, all objects matching any of them are included in the supervision group.

type=Set (Pointer)
summaryViewPointers The set of summary views using this supervision group.

type=Set (Pointer)
access=read-only
sup.SupervisionGroupState-Set type=Children-Set
supervisedAlarmsSeverities Severities of alarms reported/aggregated on supervised objects.

type=sup.SupervisedAlarmsSeverities
access=read-create
default=criticalMajorMinor
Displayed(tab/group)=Supervised Alarms Severities
triggerFilters A potentially empty set of trigger object filters (at most one filter.SavedFilter per class inheritance tree). A trigger object will be evaluated (for potential effects on SupervisionGroup state) if either there is no filter for its class or the object passes through the filter for its class. Filters can be used to specify for instance types of alarms or tests to be monitored.

type=Set (Pointer)
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

addInclusionFilter

This method adds a filter for monitored objects to this supervision group. Filtered objects' class can't be the class of subclass used by any other inclusion filter in this group.
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 - the full name of the object.
inclusionFilter : Pointer - Inclusion filter FDN to be added to this supervision group.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : Set (Pointer) - New value of the "inclusionFilters" property - FDNs of all inclusion filters in this group.

addTriggerFilter

This method adds a filter for monitoring trigger objects to this supervision group.
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 - the full name of the object.
triggerFilter : Pointer - Trigger filter FDN to be added to this supervision group.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : Set (Pointer) - Set of all trigger filter FDNS in this supervision group. Filtered objects' class can't be the class of subclass used by any other trigger filter in this group.

getHistoryBuffer

This method returns the accumulated history of one or all supervision groups for this summary view.
Input Parameters:
instanceFullName : string - the full name of the object.
supervisionGroupName : string - If null, the history of all supervision groups in the summary view is returned.
startTime : Date - If not null, return history of all monitored groups starting in the specified time.
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 (generic.CommonManagedEntityInformation) - Time ordered snapshots of supervision group states.

getInfoWithMonitoredObjects

This method returns the info structure for this group with the set of monitored objects filled in.
Input Parameters:
instanceFullName : string - the full name of the object.
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 : generic.CommonManagedEntityInformation - Time ordered snapshots of supervision group states.

listSummaryViews

This method returns the set of summary views that include this supervision group.
Input Parameters:
instanceFullName : string - the full name of the object.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : Set (Pointer) - Set of all summary view FDNs that include this supervision group.

removeInclusionFilter

This method removes a filter for monitored objects from this supervision group.
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 - the full name of the object.
inclusionFilter : Pointer - Inclusion filter FDN to be removed from this supervision group.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : Set (Pointer) - New value of the "inclusionFilters" property - FDNs of all inclusion filters in this group.

removeTriggerFilter

This method removes a filter for monitoring trigger objects from this supervision group.
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 - the full name of the object.
triggerFilter : Pointer - Trigger filter FDN to be removed from this supervision group.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : Set (Pointer) - Set of all trigger filter FDNS in this supervision group.

setBaseline

This method sets baseline (current moment in time) for all future monitored "*New*" KPI events - e.g. new alarms raised, new tests failures etc..
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 - the full name of the object.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
baselineTime : Date - The time of setting the baseline.