topology
AutonomousSystem

An IGP administrative domain. For historical reasons, this class is called topology.AutonomousSystem.

An IGP administrative domain is assumed to have at most a single OSPF routing domain and a single ISIS routing domain, and it may have both.



public class AutonomousSystem

Properties
asNumber The IGP domain number.

type=long
access=read-create
minimum=0
maximum=2147483647
Mandatory on create
Displayed(tab/group)=IGP Admin Domain Number

bgpTopologyEnabled Specifies if BGP topology is enabled for this administrative domain.

type=boolean
default=false
Displayed(tab/group)=BGP Topology Enabled

isis.LinkStatePdu-Set type=Children-Set
isisReferenceTime The time the last ISIS reference was created

type=Date
access=read-only

menuControl Specifies the enabled menus for this administrative domain.

type=topology.MenuControlType
default=63
Displayed(tab/group)=Enabled Menus (/Menu Control)

nonRoutedReferenceTime The time the last Non-Routed reference was created

type=Date
access=read-only

ospf.Lsa-Set type=Children-Set
ospfReferenceTime The time the last OSPF reference was created

type=Date
access=read-only

ospfv3ReferenceTime The time the last OSPFv3 reference was created

type=Date
access=read-only

topology.Area-Set type=Children-Set
topology.BroadcastSubnet-Set type=Children-Set
topology.ColorISIS-Set type=Children-Set
topology.ColorOSPFv2-Set type=Children-Set
topology.ColorOSPFv3-Set type=Children-Set
topology.CpSchedulePolicy-Set type=Children-Set
topology.IgpShortcutLink-Set type=Children-Set
topology.IsisCheckpoint-Set type=Children-Set
topology.IsisCpSchedulePolicy-Set type=Children-Set
topology.IsisCpaaRedundancyGroup-Set type=Children-Set
topology.IsisSubnet-Set type=Children-Set
topology.Link-Set type=Children-Set
topology.NREdgeDiscoveryPolicy-Set type=Children-Set
topology.NonRoutedSubnet-Set type=Children-Set
topology.OspfCheckpoint-Set type=Children-Set
topology.OspfCpSchedulePolicy-Set type=Children-Set
topology.OspfCpaaRedundancyGroup-Set type=Children-Set
topology.Ospfv3CpaaRedundancyGroup-Set type=Children-Set
topology.Router-Set type=Children-Set
  
Properties inherited from topology.AdminDomain
cpaaPointers, description, displayedName
 
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

findActivePrimaryStaticRoutes

finds all static routes on this admin domain that have the lowest metric for that destination AND are active
Input Parameters:
instanceFullName : string - the full name of the object.
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 -

findActiveSecondaryStaticRoutes

finds all static routes on this admin domain that do not have the lowest metric for that destination AND are active
Input Parameters:
instanceFullName : string - the full name of the object.
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 -

findAllStaticRoutes

finds all static routes on this admin domain
Input Parameters:
instanceFullName : string - the full name of the object.
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 -

findInactivePrimaryStaticRoutes

finds all static routes on this admin domain that have the lowest metric for that destination AND are inactive
Input Parameters:
instanceFullName : string - the full name of the object.
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 -

findInactiveSecondaryStaticRoutes

finds all static routes on this admin domain that do not have the lowest metric for that destination AND are inactive
Input Parameters:
instanceFullName : string - the full name of the object.
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 -

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