Overview Package Class Deprecated Help

monpath
MonitoredIpPath

Represents an IP path through the network whose changes are being monitored and recorded.

public class MonitoredIpPath

Properties
bidirMonitoredIpPathPointer Pointer to the bidirectional monitored path, if applicable.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Bidirectional IP Path Monitor (/Bidirectional Path)
dest The destination address of the managed route which specifies the IP address of the destination router or link in a CSPF calculation. Currently only IPv4 router IDs are supported. The format of the destination is dependent on the destType property which can be found in class rtr.InetAddressType and only ipv4 is supported currently.

type=InetAddress
access=read-create
Mandatory on create
Displayed(tab/group)=Destination IP (/Route)
destLen The length of the destination address. Its valid values depend on the destType. Currently must be 32.

type=int
access=read-create
default=32
minimum=32
maximum=32
Displayed(tab/group)=Destination Length (/Route)
destType The prefix length of the destination address. Its valid values depend on the destType property which can be found in class rtr. InetAddressType and only ipv4 is supported currently. Currently only the prefix length of 32 for IPv4 router IDs is valid

type=rtr.InetAddressType
access=read-create
default=ipv4
monitorMulticast Indicates if this IP Path should be monitored for Multicast protocol on all segments.

type=boolean
default=false
Displayed(tab/group)=Monitor Multicast (/Route)
recentPathRecordPointer Points to latest path record.

type=long
access=read-only
default=0
sasEntityName Attribute used for OAM. Defined in interface sas.TestedEntityIf.

type=string
access=read-only
minimum=0
maximum=252
sasTestSuiteCount

type=int
access=read-only
default=0
minimum=0
Displayed(tab/group)=Test Suite Count (Auto OAM.General)
source The source address of the managed route. The format of the source is based on the sourceType property. Currently only IPv4 router IDs are supported.The format of the source is dependent on the sourceType property which can be found in class rtr. InetAddressType and only ipv4 is supported currently.

type=InetAddress
access=read-create
Mandatory on create
Displayed(tab/group)=Source IP (/Route)
sourceLen The prefix length of the source address.Its valid values depend on the sourceType property which can be found in class rtr. InetAddressType and only ipv4 is supported currently. Currently only the prefix length of 32 for IPv4 router IDs is valid.

type=int
access=read-create
default=32
minimum=32
maximum=32
Displayed(tab/group)=Source Length (/Route)
sourceType The address type of the source. Currently only ipv4 is supported.

type=rtr.InetAddressType
access=read-create
default=ipv4
  
Properties inherited from monpath.UnidirMonitoredPath
fromNodeName, manualCapturePath, oamExecutionPolicy, stmNmUser, stmNmUserName, stmPolicyPointer, testSuitePointer, toNodeName
 
Properties inherited from monpath.MonitoredPath
administrativeState, description, displayedName
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

captureCurrentPath

Used to capture and create an IP path record for this monitored path's current path.
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

findServices

Find all the associated Services with an IP path monitor.
Input Parameters:
instanceFullName : string - the full name of the object.
objectType : int -
filter : FilterHolder -
fields : Set (string) - Sorting fields
sortFields : List (string) - Sorting fields
pageNumber : int - Page number
pageSize : int - The number of entries to return
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.PagingResult -
Methods inherited from monpath.MonitoredPath
validatePath, validatePaths