User guide

3-93
Cisco Transport Manager Release 9.2 GateWay/CORBA User Guide and Programmer Manual
OL-20937-01
Chapter 3 Using CTM GateWay/CORBA Interfaces
3.8.9 getContainedPotentialTPs
out terminationPoint::TerminationPointList_T tpList,
out terminationPoint::TerminationPointIterator_I tpIt)
raises(globaldefs::ProcessingFailureException);
Description
This interface enables an NMS to request all of the CTPs it can support in all possible mapping
configurations, at specified rates and TPs. This interface returns all potential contained CTPs for a
specific TP. The TP might be a PTP or a CTP. If the layerRateList is empty, contained CTPs at all flexible
and static LayerRates are returned.
For example, on an ONS 15454 SONET NE, the NMS invokes this method on an OC-3 PTP (assuming
that the NE does not have an XCVT card, so VT-level cross-connects are not possible) with an empty
layerRateList. Regardless of the number of SNCs, CTM returns four CTPs: three at the STS-1 layer rate
and one at the STS3c layer rate.
Parameters
For details about the TerminationPoint_T structure, see 3.6.3 getAllSupportedPTPs, page 3-63.
For a list of all supported layer rates, see 2.2.1 Layer Rate, page 2-23.
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
EXCPT_INVALID_INPUT - Raised when tpName does not reference a PTP or CTP object.
EXCPT_TP_INVALID_ENDPOINT - Raised when tpName refers to a PTP (and all contained
potential CTPs) that is part of a topological link.
EXCPT_ENTITY_NOT_FOUND - Raised when tpName references a PTP or CTP object that does not
exist.
EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.
EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.
Compliance
TMF-defined.
Name Type Input/Output Description
tpName globaldefs::NamingAttributes_T In Name of the PTP or CTP for which to retrieve contained
CTPs.
layerRateList transmissionParameters::LayerRa
teList_T
In List of rates of the contained CTPs to report. An empty
list tells the EMS to report all contained CTPs (of all
rates).
how_many unsigned long In Maximum number of contained CTPs to report in the
first batch.
tpList terminationPoint::TerminationPoi
ntList_T
Out First batch of contained in-use CTPs.
tpIt terminationPoint::TerminationPoi
ntIterator_I
Out Iterator to retrieve the remaining contained in-use CTPs.