User guide

3-73
Cisco Transport Manager Release 9.2 GateWay/CORBA User Guide and Programmer Manual
OL-20937-01
Chapter 3 Using CTM GateWay/CORBA Interfaces
3.6.7 getContainedEquipment
Parameters
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
EXCPT_INVALID_INPUT - Raised when ptpName does not reference a PTP object.
EXCPT_ENTITY_NOT_FOUND - Raised when ptpName 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.
3.6.7 getContainedEquipment
Synopsis
void getContainedEquipment(
in globaldefs::NamingAttributes_T equipmentHolderName,
out EquipmentOrHolderList_T equipmentOrHolderList)
raises(globaldefs::ProcessingFailureException);
Description
This interface returns the equipment and equipment holders that a specific equipment holder contains.
This interface differs from getAllEquipment in that it looks only at the next level of the containment
hierarchy.
Parameters
EquipmentOrHolderList_T is a list of EquipmentOrHolder_T, which is defined as a union of
Equipment_T and EquipmentHolder_T structures. For details about both structures, see
3.6.1 getAllEquipment, page 3-55.
Name Type Input/Output Description
ptpName globaldefs::NamingAttributes_T In Name of the PTP for which to retrieve the
supporting equipment.
nameList globaldefs::NamingAttributesList_T Out List of equipment names (not equipment holders)
directly implementing the PTP.
Name Type Input/Output Description
equipmentHolderName globaldefs::NamingAttributes_T In Name of the equipment holder for which to
retrieve the directly contained equipment and
equipment holders.
CTM also accepts the ME name as a value for
this parameter.
equipmentOrHolderList EquipmentOrHolderList_T Out Directly contained equipment and equipment
holders.