Cisco Cisco Prime Optical 9.6 Developer's Guide

Cisco Prime Optical 9.6.3 GateWay/CORBA Programmer Reference Guide 

OL-28047-01

 

 

225

 

Compliance 
TMF-defined. 

 

This API is not supported for MSTP OCHCC and OCHTrail layers. 

Synopsis 

void getContainedInUseTPNames( 

        in globaldefs::NamingAttributes_T tpName, 

        in transmissionParameters::LayerRateList_T layerRateList, 

        in unsigned long how_many, 

        out globaldefs::NamingAttributesList_T nameList, 

        out globaldefs::NamingAttributesIterator_I nameIt) 

     raises(globaldefs::ProcessingFailureException); 

Description 
This interface has the same behavior as the operation described in 

, 

but instead of returning entire object structures, this operation returns their names. 
Parameters 

tpName

 

globaldefs::NamingAttributes_T

 

In

 

Name of the PTP.

 

layerRateList

 

transmissionParameters::LayerRateList_T

 

In

 

List of rates of the contained 

actual CTPs to return. An empty 

list indicates to the EMS to get all 

contained actual CTPs (for all 

rates).

 

how_many

 

unsigned long

 

In

 

Maximum number of CTPs to 

return in the first batch.

 

nameList

 

globaldefs::NamingAttributesList_T

 

Out

 

First batch of contained in-use 

CTP names.

 

nameIt

 

globaldefs::NamingAttributesIterator_I

 

Out

 

Iterator to retrieve the remaining 

contained in-use CTP names.

 

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.