User guide

3-72
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.5 getAllSupportingEquipment
3.6.5 getAllSupportingEquipment
Synopsis
void getAllSupportingEquipment(
in globaldefs::NamingAttributes_T ptpName,
out EquipmentOrHolderList_T eqList)
raises(globaldefs::ProcessingFailureException);
Description
This interface enables an NMS to request the equipment that contains a given PTP.
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.
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.6 getAllSupportingEquipmentNames
Synopsis
void getAllSupportingEquipmentNames(
in globaldefs::NamingAttributes_T ptpName,
out globaldefs::NamingAttributesList_T nameList)
raises(globaldefs::ProcessingFailureException);
Description
This interface has the same behavior as the operation described in 3.6.5 getAllSupportingEquipment,
page 3-72, but returns the object name instead of returning the entire object.
Name Type Input/Output Description
ptpName globaldefs::NamingAttributes_T In Name of the PTP for which to retrieve supporting equipment.
eqList EquipmentOrHolderList_T Out List of equipment (not equipment holders) that directly
implements the PTP.