Overview Package Class Deprecated Help

topology
BgpAutonomousSystem

An administrative domain for a BGP AS, a BGP confederation AS or a BGP sub-AS (confederation member). The configured BGP AS and sub-AS should mirror the actual setup of the network.

There are 3 types of BGP autonomous system: standard BGP AS, a confederation AS, and a sub-AS. A sub-AS must be contained within a confederation AS, and only confederation AS are allowed to have a sub-AS.

public class BgpAutonomousSystem

Stats:
statistics.SamCBgpAsEventStats

Properties
asNumber For a top-level AS, the AS number is the BGP AS. For a sub-AS, the AS number is the sub-AS number.

type=long
access=read-create
minimum=1
maximum=4294967295
Mandatory on create
Displayed(tab/group)=AS Number
asPathDepth Specifies the number of ASs that are retrieved by the CPAA for the AS path. When the CPAA provides AS path information to the CPAM, the number of ASs in the retrieved path is limited to the Depth Value for Retrieve AS Path configured value. The ASs shown for the path are those closest to the CPAA that retrieves the path.

type=int
default=2
minimum=1
maximum=65535
Displayed(tab/group)=Depth Value for Retrieve AS Path (/AS Path Depth)
asType Specifies if this BGP AS is a standard AS (as), a confederation AS (confederation) or a sub-AS (confederation member).

type=topology.AsType
default=as
Displayed(tab/group)=Type
igpAdminDomain The FDN of IGP administrative domain topology.AutonomousSystem. The igpAdminDomain must be specified if the asType is either as or subAs. A BPG AS with an asType of confederation must not have an igpAdminDomain, if specified, CPAM will clear the igpAdminDomain.

type=Pointer
default=
Displayed(tab/group)=IGP Administrative Domain (/IGP Administrative Domain)
parentAsNumber For a top-level AS (standard or confederation), the parentAsNumber is undefined. For a sub-AS, the parentAsNumber is the asNumber of the confederation BGP AS that this sub-AS is contained in.

type=long
access=read-only
minimum=0
maximum=4294967295
Displayed(tab/group)=Confederation AS Number (/Confederation AS)
topology.BgpAutonomousSystem-Set type=Children-Set
topology.BgpMonitoredPrefix-Set type=Children-Set
topology.BgpNetwork-Set type=Children-Set
topology.BgpOriginatedAs-Set type=Children-Set
topology.BgpRibInfo-Set type=Children-Set
topology.BgpRoutesRouteTarget-Set type=Children-Set
topology.DetectedBadBgpPacketRecord-Set type=Children-Set
topology.VpnIPv4RouteTargetTimeStamp-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

retrieveBgpEventTopNContributers

Input Parameters:
instanceFullName : string - the full name of the object.
numOfResults : int - The number of results to retrieve, from 1 to 100
contributerType : topology.BgpEventTopNContributerType - The type of contributer
changeType : topology.BgpPrefixEventChangeType - The event change type
addrType : topology.ImpactAnalysisBGPAddressType - The BGP Address type
startTime : long -
endTime : long -
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 : List (topology.AbstractBgpEventContributerResultStruct) -
Exceptions:
topology.BgpAutonomousSystem.retrieveBgpEventTopNContributersException

updateBgpAsTopology

Retrieve the BGP RIB view data for this BGP AS.
Input Parameters:
instanceFullName : string - the full name of the object.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

updateBgpRibInfo

Retrieve the BGP RIB info for this BGP AS.
Input Parameters:
instanceFullName : string - the full name of the object.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

updateBgpRouteTargets

Retrieve the BGP route targets for this BGP AS.
Input Parameters:
instanceFullName : string - the full name of the object.
vpnType : topology.VpnType - The the type of VPN for the Cpaa to retrieve. 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