Overview Package Class Deprecated Help

sup
SummaryView

A SummaryView instance - i.e. a particular combo of supervision groups.

public class SummaryView

Properties
appType Specify what application this view belongs to.

type=sup.ApplicationType
access=read-create
default=dataCenter
Displayed(tab/group)=Application
baselineTime Baseline time for "*New*" counters.

type=Date
access=read-only
default=0
description A user provided summary view description.

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Description
displayedName The summary view name.

type=string
access=read-create
minimum=1
maximum=32
Mandatory on create
Displayed(tab/group)=Displayed Name
groupPointers The set of supervision groups pointers in this supervision view.

type=Set (Pointer)
sup.SupervisionGroupState-Set type=Children-Set
userGroupPointers The set of user groups pointers for this summary view.

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

addGroups

This method adds a set of supervision groups to this summary view.
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.
groups : Set (Pointer) - Set of supervision group FDNs to be added to this summary view. .
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 supervision group FDNs in this summary view.

getAlarms

This method returns alarms on all failed objects in the supervision group in this summary view.
Input Parameters:
instanceFullName : string - the full name of the object.
supervisionGroupName : string - Supervision Group 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 : List (fm.AlarmInfo) - Map of alarms. The alarm full name is the map key.

getAlarmsWithFilter

This method returns alarms on all failed objects in the supervision group in this summary view.
Input Parameters:
instanceFullName : string - the full name of the object.
supervisionGroupName : string - Supervision Group name.
filter : FilterHolder - A Filter to further limit the 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.

getCachedHistory

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 - Supervision Group name. If null, the history of all supervision groups in the summary view is returned.
startTime : Date - If not null, return history of monitored group(s) starting at or after that 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 : Map (string to List (sup.GroupState)) - A map keyed by group name of GroupState time ordered snapshots of supervision group state history.

getHistoryBuffer

DEPRECATED - 17.9 - OBSOLETE: Use {{sup.SummaryView.getCachedHistory}} instead.
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 - Supervision Group name. If null, the history of all supervision groups in the summary view is returned.
startTime : Date - If not null, return history of monitored group(s) starting at or after that 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.

getMonitoredObjectsByClasses

This method returns all objects of specified classes in the supervision group in this summary view.
Input Parameters:
instanceFullName : string - the full name of the object.
supervisionGroupName : string - Supervision Group name.
classes : Set (string) - Classes of objects in this group to fetch. If null or empty, get all monitored objects in the group.
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) - Info info structures of monitored objects in the group matching 'classes' parameter. class.

getMonitoredObjectsSummaries

This method returns states of all or failed objects in the supervision group in this summary view.
Input Parameters:
instanceFullName : string - the full name of the object.
supervisionGroupName : string - Supervision Group name.
getProblemObjectsOnly : boolean - If true, the method will return only objects with non-zero KPIs (e.g. alarms, failed etc.)
startTime : Date - Get counts of alarms and failed tests on the monitored objects since this 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 : Map (string to sup.ObjectStateSummary) - Set of all monitored object FDNs in this summary view.

getNeTraceStatusObjectsByGroup

DEPRECATED - 23.4 - No longer applicable to any supported nodes
This method returns all NeTraceStatus objects in the supervision group in this summary view.
Input Parameters:
instanceFullName : string - the full name of the object.
supervisionGroupName : string - Supervision Group 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 : List (generic.CommonManagedEntityInformation) - Info info structures of NeTraceStatus objects in the group. class.

getNumFailedCells

This method returns the number of failed cells returns -1 if not enodeB.
Input Parameters:
instanceFullName : string - the full name of the object.
supervisionParentFDN : string - Supervision Parent name.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : int - Info info structures of monitored objects in the group matching 'classes' parameter. class.

listGroups

This method returns the list of supervision groups in this summary view.
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 supervision group FDNs in this summary view.

removeGroups

This method removes a set of supervision groups from this summary view.
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.
groups : Set (Pointer) - Set of supervision group FDNs to be removed from this summary view.
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 supervision group FDNs in this summary view.

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.

setGroupBaseline

This method sets baseline (current moment in time) for the specified supervision group 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.
supervisionGroupName : string - Supervision Group name.
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.