Overview Package Class Deprecated Help

monpath
BidirMonitoredIpPath

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

public class BidirMonitoredIpPath

Properties
endpointA The address of endpoint A. Currently only IPv4 router IDs are supported. The format of the endpoint A is dependent on the endpointAType 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)=Endpoint A IP (/Route)
endpointALen The prefix length of the endpoint A address. Its valid values depend on the endpointAType 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)=Endpoint A Length (/Route)
endpointAType The address type. Currently only ipv4 is supported.

type=rtr.InetAddressType
access=read-create
default=ipv4
endpointB The address of endpoint B. Currently only IPv4 router IDs are supported. The format of the endpoint B is dependent on the endpointBType 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)=Endpoint B IP (/Route)
endpointBLen The prefix length of the endpoint B address. Its valid values depend on the endpointBType 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)=Endpoint B Length (/Route)
endpointBType The address type. Currently only ipv4 is supported.

type=rtr.InetAddressType
access=read-create
default=ipv4
fromNodeName The source node of the monitored IP path A.

type=string
access=read-only
maximum=252
Displayed(tab/group)=Source Node Name (/Route)
monitorMulticast Indicates if this IP Path should be monitored for Multicast on all segments.

type=boolean
default=false
Displayed(tab/group)=Monitor Multicast (/Route)
monitoredIpPathAPointer Pointer to the monitored path A.

type=Pointer
access=read-only
Displayed(tab/group)=IP Path Monitor A (/Paths)
monitoredIpPathBPointer Pointer to the monitored path B.

type=Pointer
access=read-only
Displayed(tab/group)=IP Path Monitor B (/Paths)
toNodeName The destination node of the monitored IP path A.

type=string
access=read-only
maximum=252
Displayed(tab/group)=Destination Node Name (/Route)
  
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 paths.
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
Methods inherited from monpath.MonitoredPath
validatePath, validatePaths