Overview Package Class Deprecated Help

topology
Area

The routing protocol area. This area may represent an OSPF or an ISIS area.

public class Area

Properties
areaId The area ID. Its interpretation depends on the protocol.

For OSPF, the area ID is in the IP address format (eg. 0.0.0.0).

For ISIS, the area ID is conforms to the following format:

  1. simple 8 byte Area ID/System ID format, where area ID is a single byte -- eg: 07
  2. OSI NSAP format -- (7 bytes total) 5 byte domain followed by 2 byte area ID; eg: 47.0004.30ac.0007
  3. GOSIP NSAP format -- (13 bytes total) 1 byte AFI, 2 byte ICD, 1 byte DFI, 3 byte AAI, 2 bytes reserved, 2 byte RDI, followed by 2 byte area ID; eg: 47.0005.80.0000a7.0000.ffdd.0007
  4. default (none of the above formats) -- xx([.xx][xx])*

type=string
access=read-create
maximum=60
Mandatory on create
Displayed(tab/group)=Area ID
checkpointDetail Specific details copied topology.Checkpoint to help further identify the checkpoint. For example, for an OSPF checkpoint, this would contain the area ID.

This field is only meaningful if isCheckpointObject is true.

type=string
access=read-only
default=
minimum=0
maximum=32
Displayed(tab/group)=Checkpoint Detail (Checkpoint Details/Checkpoint)
checkpointId The ID of the checkpoint (topology.Checkpoint or its subclasses).

This field is only meaningful if isCheckpointObject is true.

type=long
access=read-only
default=0
Displayed(tab/group)=Checkpoint ID (Checkpoint Details/Checkpoint)
checkpointProtocol The protocol of the checkpoint (topology.Checkpoint or its subclasses).

This field is only meaningful if isCheckpointObject is true.

type=topology.Protocol
access=read-only
Displayed(tab/group)=Checkpoint Protocol (Checkpoint Details/Checkpoint)
checkpointTime The time that this checkpoint object was created.

This field is only meaningful if isCheckpointObject is true.

type=Date
access=read-only
Displayed(tab/group)=Checkpoint Time (Checkpoint Details/Checkpoint)
cpaaInstanceId Specifies the ISIS instance from which the CPAM retrieves the prefix list.

type=int
access=read-only
default=-1
Displayed(tab/group)=CPAA Instance ID
cpaaRedGroupPointers The CPAA Redundancy Group FDNs that are responsible for this area.

type=Set (Pointer)
access=read-only
description The description.

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

type=string
minimum=0
maximum=32
Displayed(tab/group)=Name
hasProblem

DEPRECATED: 12.0 - OBSOLETE: no longer used
type=boolean
access=read-only
default=false
isCheckpointObject Represents that this instance of the area object is in fact contained in a checkpoint.

The real topology object always has a value of "false" for isCheckpointObject.

type=boolean
access=read-only
default=false
Displayed(tab/group)=Is Checkpoint Object (/Checkpoint)
isReference Specifies which protocols have been referenced on this object.

type=topology.CheckPoint
access=read-only
Displayed(tab/group)=Has Reference (Reference)
lastAuditTime

DEPRECATED: :12.0 - OBSOLETE: no longer used
type=Date
access=read-only
lastChangeTime The last time Area was changed.

type=Date
access=read-only
default=0
Displayed(tab/group)=Last Change Time
protocol The protocol that this area was defined in.

type=topology.Protocol
access=read-create
Mandatory on create
Displayed(tab/group)=Protocol
referenceTime The time the last reference was created

type=Date
access=read-only
Displayed(tab/group)=Reference Time (Reference)
routerPointers The set of router pointers that belong to this area.

type=Set (Pointer)
access=read-only
topology.OspfSubnet-Set type=Children-Set
  
Properties inherited from topology.ASContainedObject
asName, asNumber
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

cleanUpReference

cleans all down links and Routers subnets from reference for the given protocols.
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.
protocol : topology.CheckPoint -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

clearReference

DEPRECATED - 8.0 - OBSOLETE: no longer used
Reference is set/cleared automatically for topology objects.
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.
protocol : topology.CheckPoint -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

findAllCheckpoints

Find all the checkpoints that exist for this checkpointable object.
Input Parameters:
instanceFullName : string - the full name of the object.
filter : FilterHolder -
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:
checkpoints : List (generic.CommonManagedEntityInformation) -

setReference

DEPRECATED - 8.0 - OBSOLETE: no longer used
Reference is set/cleared automatically for topology objects.
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.
protocol : topology.CheckPoint -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false