Overview Package Class Deprecated Help

topology
BgpImpactAnalysisTimeRange

Represents the time range in which Impact Analysis is done.

public class BgpImpactAnalysisTimeRange

Properties
addrType Specifies the type of IP address.

type=topology.ImpactAnalysisBGPAddressType
default=ipv
Displayed(tab/group)=Address Type (/Address Type )
bgpAsPointer The pointer to BgpAutonomousSystem object. It used to navigate to BgpAutonomousSystem object if the Autonomous System is managed.

type=Pointer
access=read-create
default=
Mandatory on create
Displayed(tab/group)=Domain (/BGP AS Domain)
bgpImpactAnalysisResult

type=List (topology.BgpHistoricalImpactAnalysisResult)
access=read-only
bgpNextHopResult

type=List (topology.BgpSummaryResult)
access=read-only
domainName The name of the selected domain group.

type=string
access=read-only
Displayed(tab/group)=Domain Name (/BGP AS Domain)
format The route target type, Type 0x00 and 0x02 (AS) or Type 0x01 (IP address).

type=topology.VrfTargetFormat
default=0
Displayed(tab/group)=Type (/Address Type )
id The unique identifier of the Static Route Policy

type=long
access=read-create
default=0
minimum=1
maximum=2147483647
Displayed(tab/group)=ID (/BGP Impact Analysis)
routeTarget Route Target (routeTarget): Specifies the route target identifier for the Per RT alarm threshold. Enter a string in the format a:b. The values for a and b depend on the option selected for the Type (format) parameter.

type=string
minimum=0
maximum=32
Displayed(tab/group)=Route Target (/Address Type )
throttledEventCount

type=boolean
access=read-only
default=false
Displayed(tab/group)=Throttled BGP Event Raised (/Throttled BGP Event Count)
  
Properties inherited from topology.AbstractImpactAnalysisTimeRange
dateLastRun, displayedName, endTime, ipPathResult, lspResult, startTime, timeInterval, timeIntervalType
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

bgpImpactAnalysis

Used to calculate the bgp historical impact analysis results.
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.
filter : FilterHolder -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
resultmap : Map (string to Any) -
Exceptions:
topology.BgpImpactAnalysisTimeRange.bgpImpactAnalysisTimeRangeException

bgpImpactAnalysisDetails

Details for Historical Impact Analysis results. Reason can be specified. Reason has the following int values: Unreachable at least once during this period =1, Advertised as a New route at least once =2, Added at least once =3, Flapped = 4, Redundancy Lost at least once = 5, Switched Next Hop, Same Originator = 6, Switched Next Hop, Different Originator = 7, Switched at least once to longer AS-Path = 8, MED change at least once = 9, Throttled BGP events count = 10
Input Parameters:
instanceFullName : string - the full name of the object.
reason : int -
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 -
Exceptions:
topology.BgpImpactAnalysisTimeRange.bgpImpactAnalysisDetailsTimeRangeException

bgpPerNextHopEventAnalysis

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:
bgpPerNextHopStatistic : List (topology.BgpSummaryResult) -
Exceptions:
topology.BgpImpactAnalysisTimeRange.bgpPerNextHopEventAnalysisTimeRangeException

bgpPerNextHopSummary

Input Parameters:
instanceFullName : string - the full name of the object.
nextHopAddr : string -
eventAdded : boolean -
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 -
Exceptions:
topology.BgpImpactAnalysisTimeRange.bgpPerNextHopSummaryTimeRangeException

bgpPrefixAnalysis

Input Parameters:
instanceFullName : string - the full name of the object.
filter : FilterHolder -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
bgpNextHopInterval : Map (string to Any) -
Exceptions:
topology.BgpImpactAnalysisTimeRange.bgpPrefixAnalysisTimeRangeException

bgpRetrieveEventForNextHop

Details for Historical Impact Analysis results.
Input Parameters:
instanceFullName : string - the full name of the object.
nextHopAddr : string -
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 -
Exceptions:
topology.BgpImpactAnalysisTimeRange.bgpRetrieveEventForNextHopTimeRangeException
Methods inherited from topology.AbstractImpactAnalysisTimeRange
impactAnalysis, impactAnalysisDetails