User guide

3-271
Cisco Transport Manager Release 9.2 GateWay/CORBA User Guide and Programmer Manual
OL-20937-01
Chapter 3 Using CTM GateWay/CORBA Interfaces
3.13.8 getTPHistoryPMData
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
Compliance
CTM-defined.
3.13.8 getTPHistoryPMData
Synopsis
void getTPHistoryPMData(in PMTPSelectList_T pmTPSelectList,
in PMParameterNameList_T pmParameters,
in globaldefs::Time_T startTime,
in globaldefs::Time_T endTime,
in unsigned long how_many,
out PMDataList_T pmDataList,
out PMDataIterator_I pmIt)
raises(globaldefs::ProcessingFailureException);
Description
This interface enables the NMS to request a filtered set (scoped by the input parameter pmParameters)
of the historical PM data for a list of TP measurement points. Within the request for each measurement
point, granularity (15 min, 24 hr, NA) and location (nearEnd, farEnd, bidirectional) can be specified. The
operation mode is best effort. CTM only supports 24 buckets (6 hours) for 15 min PM. If the NMS
requests older historical data, CTM returns an EXCPT_NOT_IMPLEMENTED exception. CTM also
returns this exception if the NMS requests historical data for 24-hour PM.
This interface uses an iterator so that the NMS can handle a large number of objects.
For a list of supported layer rates and PM parameters, with the exception of ONS 15305 and ONS 15305
CTC, see 3.13.5 getCTMHistoryPMData, page 3-268. The list for ONS 15305 and ONS 15305 CTC is
shown in this section.
If the layer rate is L3_Optical_Channel (which requires a DWDM CTP), CTM uses the naming
convention defined in the TMF for the CTP.
The CTP format description differs depending on whether it is related to the DWDM.
L3_Optical_Channel is the only layer rate that requires it. If the list of requested layer rates is composed
of one element only equal to LR_Optical_Channel, the CTP is considered a DWDM CTP.
Parameters
Name Type Input/Output Description
pmTPSelectList PMTPSelectList_T In Specifies which historical PM data to return. This list cannot be
empty.
pmParameters PMParameterNameList_T In Specifies which PM parameters within the scope of the
pmTPSelectList are contained in the file. An empty list means
to store all supported parameters. The returned parameters are
best effort; that is, among the parameters specified, only the
subset of supported parameters is stored.
startTime globaldefs:Time_T In Specifies the start of the time window for collection (included).
endTime globaldefs:Time_T In Specifies the end of the time window for collection (excluded).