Overview Package Class Deprecated Help

topology
Checkpoint

A snapshot of some part of the network (specified by rules in the subclass) at some specific time. All checkpoints exist within an IGP admin domain.

public abstract class Checkpoint

Properties
checkpointTime The time that the this checkpoint was set for this IGP admin domain.

type=Date
access=read-only
Displayed(tab/group)=Checkpoint Time
description The description (user configurable).

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

type=string
minimum=1
maximum=32
Displayed(tab/group)=Name
id The unique identifier of this checkpoint.

type=long
access=read-create
default=0
minimum=1
Displayed(tab/group)=Checkpoint ID
isValid When Checkpoint cleanup delete at least one underlying object referenced by a Checkpoint the Checkpoint become invalid for compare and user should never see it.

type=boolean
access=read-only
default=true
Displayed(tab/group)=Valid
objectPointers The set of object (area, routers, subnets, links) pointers referenced from the checkpoint.

type=Set (Pointer)
access=read-only
protocol The protocol (OSPF or ISIS).

type=topology.Protocol
access=read-only
Displayed(tab/group)=Protocol
type

type=topology.CheckpointType
access=read-create
default=manual
userName The user who created this checkpoint.

type=string
access=read-only
minimum=1
maximum=40
Displayed(tab/group)=User
  
Properties inherited from topology.ASContainedObject
asName, asNumber
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

autoCreateCheckpoints

Creates checkpoints for all routing domains for the given protocols within the given IGP admin domain.

This method can never be executed synchronously.

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.
igpAdminDomainPointer : Pointer - The pointer to the IGP admin domain that is being checkpointed.
protocolMask : topology.CheckPoint - The protocols to create the checkpoints for.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

forceCleanupCheckpoints

Cleanup all checkpoints on the system

This method can never be executed synchronously.

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.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

getCpTopology

Input Parameters:
checkpointId : long - Checkpoint ID.
asNumber : long - The IGP administrative domain number of the CP.
asName : string - The IGP administrative domain name of the CP.
protocol : topology.Protocol - The protocol that the CP belongs to. Only OSPF and ISIS are supported.
fullClassName : string - Package qualified class name in dot separated format EXAMPLE: topology.Router, topology.OspfLink.
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:
resultList : List (generic.CommonManagedEntityInformation) -