Overview Package Class Deprecated Help

monpath
MonitoredPath

Represents a path of some type through the network whose changes are being monitored and recorded.

public abstract class MonitoredPath

Properties
administrativeState Specifies whether the path should be monitored or not.

type=topology.State
default=down
Displayed(tab/group)=Monitor State
description The description (user configurable).

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

type=string
access=read-create
default=
minimum=0
maximum=64
Mandatory on create
Displayed(tab/group)=Name
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

validatePath

Used to trigger the execution of the OAM tests on this monitored path.
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:
numberOfPaths : int - Number of unidirectional paths which the OAM tests being executed on. It could return two for bidirectional monitored path if both paths have been assigned with STM policies. Return zero if there no paths assigned an STM policy.

validatePaths

Used to trigger the execution of the OAM tests on multiple monitored paths.
Input Parameters:
paths : Set (Pointer) - A set of monitored path pointers to validate.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
numberOfPaths : int - Number of unidirectional paths which the OAM tests being executed on. The value is the number of all the unidirectional monitored path if it has been assigned with STM policy. Return zero if there no paths assigned an STM policy.