Overview Package Class Deprecated Help

topology
TopologyManager

The ultimate parent of all topology related objects.

public class TopologyManager

Properties
topology.AutonomousSystem-Set type=Children-Set
topology.BgpAutonomousSystem-Set type=Children-Set
topology.BgpPrefixList-Set type=Children-Set
topology.BgpPrefixListFilter-Set type=Children-Set
topology.CpamAuditResult-Set type=Children-Set
topology.IgpPrefixList-Set type=Children-Set
topology.IgpPrefixListFilter-Set type=Children-Set
topology.IsisSystemIdMapping-Set type=Children-Set
topology.RouteManager-Set type=Children-Set
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

bgpRetrievalEventFilter

DEPRECATED - 11.0R1 - OBSOLETE: Should not be used. Returns a deprcated result class. Use {{TopologyManager.retrieveBgpEventsFilter}} instead.
Details for Historical Impact Analysis results.
Input Parameters:
filter : FilterHolder -
fields : Set (string) - Sorting fields
sortFields : List (string) - Sorting fields
filterInfo : Any - BGP AS information
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 -

constrainedShortestPathFirstGraphExt

Performs a constrained shortest path (CSPF) calculation from the given source to the given destination, using the given constraints, as known by the specified IGP protocol.
Input Parameters:
igpAdminDomain : Pointer - The IGP Admin Domain (topology.AutonomousSystem) to perform the CSPF in.
protocol : topology.Protocol - The protocol to run CSPF on. Only OSPF and ISIS are supported.
source : string - The source address. The format of the source is based on the sourceType property.
destType : topology.AddressType - The address type of the destination. Currently only ipv4 is supported.
dest : string - The destination address. The format of the destination is based on the destType property.
destLen : int - The length of the destination address. Its valid values depend on the destType.
constraints : topology.Constraints - The CSPF constraints.
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:
path : topology.ShortestPathGraph - The constrained shortest path graph.

highlightLFANextHops

Performs a LFA calculation from the given source to the given destination, using both OSPF and ISIS protocols (or both) as necessary
Input Parameters:
igpAdminDomain : Pointer - The IGP Admin Domain (topology.AutonomousSystem) to perform the LFA in.
protocol : topology.Protocol - The protocol to run LFA on. Currently OSPF, OSPFv3 and ISIS are supported.
sourceType : topology.AddressType - The address type of the source. Currently only ipv4 is supported.
source : string - The source address. The format of the source is based on the sourceType property.
sourceLen : int - The length of the source address. Its valid values depend on the sourceType.
destType : topology.AddressType - The address type of the destination. Currently ipv4 and ipv6 are supported.
dest : string - The destination address. The format of the destination is based on the destType property.
destLen : int - The length of the destination address. Its valid values depend on the destType.
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:
path : topology.ShortestPathGraph - The shortest path graph.

igpShortestPathFirstGraphExt

Performs a shortest path calculation from the given source to the given destination, using both OSPF and ISIS protocols (or both) as necessary.
Input Parameters:
igpAdminDomain : Pointer - The IGP Admin Domain (topology.AutonomousSystem) to perform the SPF in.
sourceType : topology.AddressType - The address type of the source. Currently only ipv4 is supported.
source : string - The source address of the managed route. The format of the source is based on the sourceType property.
sourceLen : int - The length of the source address. Its valid values depend on the sourceType.
destType : topology.AddressType - The address type of the destination. Currently only ipv4 is supported.
dest : string - The destination address of the managed route. The format of the destination is based on the destType property.
destLen : int - The length of the destination address. Its valid values depend on the destType.
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:
path : topology.ShortestPathGraph - The shortest path graph.

igpShortestPathFirstGraphSet

Performs a shortest path calculation from the given source (routerId, ipv4 or ipv6 prefix) to the given destination (routerId, ipv4 or ipv6 prefix), using both OSPF and ISIS protocols (or both) as necessary.
Input Parameters:
igpAdminDomain : Pointer - The IGP Admin Domain (topology.AutonomousSystem) to perform the SPF in.
sourceType : topology.AddressType - The address type of the source. Currently ipv4 and ipv6 are supported.
source : string - The source address of the managed route. The format of the source is based on the sourceType property.
sourceLen : int - The length of the source address. Its valid values depend on the sourceType.
destType : topology.AddressType - The address type of the destination. Currently only ipv4 is supported.
dest : string - The destination address of the managed route. The format of the destination is based on the destType property.
destLen : int - The length of the destination address. Its valid values depend on the destType.
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:
path : Set (topology.ShortestPathGraph) - The set of shortest path graph.

nextHopExt

Calculates the next hop from all routers in the source set to the given destination FEC.
Input Parameters:
igpAdminDomain : Pointer - The IGP Admin Domain (topology.AutonomousSystem) to perform the next hop query in.
protocols : topology.ProtocolMask - The set of protocols to consider.
sources : Set (topology.SourceParam) - The set of source routers from which to calculate the next hop.
destType : topology.AddressType - The address type of the destination. Currently only ipv4 is supported.
dest : string - The destination address of the managed route. The format of the destination is based on the destType property.
destLen : int - The length of the destination address. Its valid values depend on the destType.
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:
nextHops : Set (topology.ShortestPathGraph) - The next hops, in the form of shortest path graphs, one for each source.

retrieveBgpEventsFilter

Retrieve Historical BGP Event data from database
Input Parameters:
filter : FilterHolder -
fields : Set (string) - Sorting fields
sortFields : List (string) - Sorting fields
filterInfo : Any - Filter info can be any of the following: BgpEventRetrievalFilter - To search specifically for BGP prefix events VprnBgpEventRetrievalFilter - To search for DC/Prefix VPRN service related events
pageNumber : int - Page number
pageSize : int - The number of entries to return
fullClassName : string - The full class name to search for: topology.AbstractBgpEventStruct | topology.BgpPrefixEventStruct | topology.BgpDcEventStruct topology.AbstractBgpEventStruct will return all sub classes but only common properties
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 -

retrieveBgpPrefixList

Retrieves the BGP Prefix List
Input Parameters:
bgpAs : Pointer - The BGP AS (topology.BgpAutonomousSystem) to retrieve the prefixes.
bgpPrefixFilter : Pointer - The Filter (topology.BgpPrefixListFilter) to be applied for the retrieval.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
topology.TopologyManager.retrieveBgpPrefixListException

retrieveIgpPrefixList

Retrieves the IGP Prefix List
Input Parameters:
igpAdminDomain : Pointer - The IGP Admin Domain (topology.AutonomousSystem) to retrieve the prefixes.
igpPrefixFilter : Pointer - The Filter (topology.IgpPrefixListFilter) to be applied for the retrieval.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
topology.TopologyManager.retrieveIgpPrefixListException

retrieveProfiledBgpEventsFilter

Retrieve Historical BGP Event data from database
Input Parameters:
filterInfo : Any - Pass in type topology.BgpProfileEventRetrievalFilter - To search specifically for BGP prefix events mapping to the profile
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 -

retrieveProfiledBgpPrefixList

Retrieves Profiled BGP Prefix List
Input Parameters:
bgpProfile : Pointer - The BGP router profile (topology.AbstractBgpRouteProfile) to be applied for the retrieval.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
topology.TopologyManager.retrieveProfiledBgpPrefixListException

retrieveServiceBgpInfo

This method will retrieve BGP related information for a provided service FDN
Input Parameters:
serviceFullName : string - FullName of the service
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 : topology.ServiceBgpInfo -

shortestPathFirstGraphExt

Performs a shortest path calculation from the given source to the given destination, as known by the specified IGP protocol.
Input Parameters:
igpAdminDomain : Pointer - The IGP Admin Domain (topology.AutonomousSystem) to perform the SPF in.
protocol : topology.Protocol - The protocol to run SPF on. Currently OSPF, OSPFv3 and ISIS are supported.
sourceType : topology.AddressType - The address type of the source. Currently only ipv4 is supported.
source : string - The source address. The format of the source is based on the sourceType property.
sourceLen : int - The length of the source address. Its valid values depend on the sourceType.
destType : topology.AddressType - The address type of the destination. Currently ipv4 and ipv6 are supported.
dest : string - The destination address. The format of the destination is based on the destType property.
destLen : int - The length of the destination address. Its valid values depend on the destType.
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:
path : topology.ShortestPathGraph - The shortest path graph.

shortestPathFirstGraphSet

Performs a shortest path calculation from a given source (routerId, Ipv4 prefix, or Ipv6 prefix) to a given destination(routerId, Ipv4 prefix, or Ipv6 prefix), as known by the specified IGP protocol.
Input Parameters:
igpAdminDomain : Pointer - The IGP Admin Domain (topology.AutonomousSystem) to perform the SPF in.
protocol : topology.Protocol - The protocol to run SPF on. Currently OSPF, OSPFv3 and ISIS are supported.
sourceType : topology.AddressType - The address type of the source. Currently ipv4 and ipv6 are supported.
source : string - The source address. The format of the source is based on the sourceType property.
sourceLen : int - The length of the source address. Its valid values depend on the sourceType.
destType : topology.AddressType - The address type of the destination. Currently ipv4 and ipv6 are supported.
dest : string - The destination address. The format of the destination is based on the destType property.
destLen : int - The length of the destination address. Its valid values depend on the destType.
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:
path : Set (topology.ShortestPathGraph) - The set of shortest path graph.

updateBgpAsTopology

Retrieves the BGP AS topology from the point-of-view of the specified CPAA.
Input Parameters:
cpaa : string - The management IP address of the CPAA.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
topology.TopologyManager.updateBgpAsTopologyException

updateBgpRibInfo

Retrieves the BGP RIB information from the specified CPAA.
Input Parameters:
cpaa : string - The management IP address of the CPAA.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
topology.TopologyManager.updateBgpRibInfoException

updateBgpRouteTargets

Retrieves the BGP router target information from the specified CPAA.
Input Parameters:
cpaa : string - The management IP address of the CPAA.
vpnType : topology.VpnType - The the type of VPN for the Cpaa to retieve. Right now, IPv4 and L2 VPN only.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
topology.TopologyManager.updateBgpRouteTargetsException

updateTopology

Retrieves the specified protocol data from the given CPAA.
Input Parameters:
protocol : topology.Protocol - The protocol to retrieve
cpaa : string - The management IP address of the CPAA.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
topology.TopologyManager.updateTopologyException