User guide

3-91
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.7 getContainedInUseTPs
Description
This interface retrieves the in-use CTPs contained in a specific PTP, at specific layer rates. An in-use
CTP is a CTP used by an SNC in any state (including pending) or a CTP that is terminated and mapped.
Example for SONET: The NMS invokes this method on an OC3 PTP (and assumes that the NE does not
have an XCVT card, so VT-level cross-connects are not possible) with an empty layerRateList.
• If there are no SNCs created, CTM returns zero CTPs.
• If there is one SNC created at the STS-1 level, CTM returns one CTP at the STS-1 layer rate.
Example for SDH: The NMS invokes this method on an STM-1 PTP (and assumes that the NE does not
have an XC10G card, so VC12-level cross-connects are not possible) with an empty layerRateList.
• If there are no SNCs created, CTM returns zero CTPs.
• If there is one SNC created at the VC4 level, CTM returns one CTP at the VC4 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 object.
EXCPT_ENTITY_NOT_FOUND - Raised when tpName references a PTP 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.
layerRateList transmissionParameters::LayerRateLi
st_T
In List of rates of the contained actual CTPs to return.
An empty list tells the EMS to retrieve all contained
actual CTPs (of all rates).
how_many unsigned long In Maximum number of CTPs to return in the first batch.
tpList terminationPoint::TerminationPointL
ist_T
Out First batch of contained in-use CTPs.
tpIt terminationPoint::TerminationPointIt
erator_I
Out Iterator to retrieve the remaining contained in-use
CTPs.