topology
Cpaa

This class represents the control plane assurance appliance (CPAA) that is managed by CPAM. It is created as a side-effect of discovering and managing a CPAA.



public class Cpaa

Properties
administrativeState Specifies the user configured state of the communication channels from the CPAM to the CPAA.

type=topology.State
default=down
Displayed(tab/group)=Administrative State

areaPointers Set of area FDNs for which this CPAA is responsible.

type=Set (Pointer)
access=read-only

asPointer The FDN of IGP administrative domain topology.AutonomousSystem. If the CPAA has both the IGP and BGP role, the IGP administrative domain must match the BGP AS admin domain's IGP admin domain.

type=Pointer
default=
Displayed(tab/group)=IGP Administrative Domain (Administrative Domains/IGP Administrative Domain)

bgpAsNumberMismatch Used indicate if the given CPAA's BGP AS (including confederation) matches with the BGP AS admin domain (topology.BgpAutonomousSystem).

type=boolean
access=read-only
default=false
Displayed(tab/group)=BGP AS Number Mismatch (/Faults)

bgpAsPathDataRetrieveTime The last time that the BGP AS Path was retrieved. The time indicates when the operation completed.

type=Date
access=read-only
Displayed(tab/group)=BGP AS Path Data Update Time (Update Times)

bgpAsPointer The FDN of BGP AS administrative domain topology.BgpAutonomousSystem. Only BGP AS with an asType of "as" or "subAs" are allowed to be assigned to the CPAA.

type=Pointer
default=
Displayed(tab/group)=BGP AS/Sub-AS (Administrative Domains/BGP Autonomous System)

bgpRibInfoLastRetrieveTime The last time that the BGP RIB information (BGP attributes) was retrieved. The time indicates when the operation is completed.

type=Date
access=read-only
Displayed(tab/group)=BGP RIB Info Update Time (Update Times)

bgpVpnv4RoutTargetLastRetrieveTime The last time that the BGP Route Targets for VPN IPv4 was retrieved. The time indicates when the operation is completed.

type=Date
access=read-only
Displayed(tab/group)=BGP VPN IPv4 Route Target Update Time (Update Times)

ipAddress The management IP address of the CPAA. This is the address that CPAM uses to open its communication channels to the CPAA.

type=InetAddress
access=read-create
Mandatory on create
Displayed(tab/group)=IP Address

ipAddressType

type=rtr.InetAddressType
access=read-create
default=ipv4

isisLastLsdbRetrieveTime The last time that the ISIS LSDB was retrieved. The time indicates when the operation completed.

type=Date
access=read-only
Displayed(tab/group)=ISIS LSDB Update Time (Update Times)

isisLevel1CpaaRedGroupPointer The pointer the ISIS level 1 CPAA redundancy group, if any.

type=Pointer
access=read-only

isisLevel2 Set to true if this CPAA is configured to use handle ISIS level 2.

type=boolean
access=read-only
default=false
Displayed(tab/group)=ISIS Backbone (Level 2) (/IGP Backbone)

isisLevel2CpaaRedGroupPointer The pointer the ISIS level 2 CPAA redundancy group, if any.

type=Pointer
access=read-only

operationalState Specifies the summary state of the communication channels from CPAM to the CPAA.

type=topology.OperationalState
access=read-only
default=notAvailable
Displayed(tab/group)=Operational State

ospfBackbone Set to true if this CPAA is responsible for listening to the OSPF backbone area 0.0.0.0.

type=boolean
access=read-only
default=false
Displayed(tab/group)=OSPF Backbone (/IGP Backbone)

ospfLastLsdbRetrieveTime The last time that the OSPF LSDB was retrieved. The time indicates when the operation completed.

type=Date
access=read-only
Displayed(tab/group)=OSPF LSDB Update Time (Update Times)

ospfv3Backbone Set to true if this CPAA is responsible for listening to the OSPFv3 backbone area 0.0.0.0.

type=boolean
access=read-only
default=false
Displayed(tab/group)=OSPFv3 Backbone (/IGP Backbone)

ospfv3LastLsdbRetrieveTime The last time that the OSPFv3 LSDB was retrieved. The time indicates when the operation completed.

type=Date
access=read-only
Displayed(tab/group)=OSPFv3 LSDB Update Time (Update Times)

protocolEventTypes Specifies the protocols for which this CPAA sends event notifications to the CPAM.

type=topology.ProtocolMask
Displayed(tab/group)=Event Types (/CPAM-CPAA Event Registration)

protocolRecord Specifies the protocols for which the CPAM keeps event records.

type=topology.ProtocolRecord
Displayed(tab/group)=Keep Event History (/CPAM-CPAA Event Registration)

redundancyMode

type=topology.CpaaRedundancyMode
access=read-only
default=standalone
Displayed(tab/group)=Redundancy Mode (/Redundancy)

redundancyState

type=topology.CpaaRedundancyState
access=read-only
default=notapplicable
Displayed(tab/group)=Redundancy State (/Redundancy)

role Specifies to CPAM how to use this CPAA.

type=topology.Role
Displayed(tab/group)=Role (Administrative Domains)

routerId The router ID the CPAA uses while participating in the routing protocols.

type=string
access=read-only
maximum=50
Displayed(tab/group)=Router ID

standbyCpaa

type=Pointer
default=
Displayed(tab/group)=Standby CPAA (/Redundancy)

supportedProtocols The set of protocols that this CPAA is currently configured to support.

type=topology.SupportedProtocol
access=read-only
Displayed(tab/group)=Active Protocols

tooManyCpaaForIsisLevel2 Used indicate if that there are too many CPAAs responsible for ISIS level 2 in the same administrative domain. This CPAA is not the one that originally was responsible for level 2.

type=boolean
access=read-only
default=false
Displayed(tab/group)=Too Many CPAAs (ISIS Level 2) (/Faults)

tooManyCpaaPerOspfArea Used indicate if that a given OSPF area is being learned by more than one CPAA in the same administrative domain. This CPAA is the one that did not originally learn the area.

type=boolean
access=read-only
default=false
Displayed(tab/group)=Too Many CPAAs (OSPF Area) (/Faults)

tooManyCpaaPerOspfv3Area Used indicate if that a given OSPFv3 area is being learned by more than one CPAA in the same administrative domain. This CPAA is the one that did not originally learn the area.

type=boolean
access=read-only
default=false
Displayed(tab/group)=Too Many CPAAs (OSPFv3 Area) (/Faults)

  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

switchover

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.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
topology.Cpaa.switchoverException
Supported Network Elements
7701 CPAA
Product Specifics
7701 CPAA (all versions)