User guide

3-306
Cisco Transport Manager Release 9.2 GateWay/CORBA User Guide and Programmer Manual
OL-20937-01
Chapter 3 Using CTM GateWay/CORBA Interfaces
3.18.13 getSWDownloadStatus
3.18.13 getSWDownloadStatus
Synopsis
void getSWDownloadStatus (
in globaldefs::NamingAttributes_T managedElementName,
out BackupStatus_T backupStatus)
raises(globaldefs::ProcessingFailureException)
Description
The NMS uses this method to obtain the current software download status of an individual ME.
Parameters
struct BackupStatus_T
{
Current_OperationStatus_T opStatus;
string failureReason;
}
BackupStatus_T is defined as:
• Current_OperationStatus_T opStatus—Indicates the current operational status of the software
download.
• string failureReason—A free-form text string that is provided if the opStatus value is COS_Aborted
to explain the reason for the abort. (For example, “Comms loss with NE.”)
This data structure identifies the status of the software download operation for a managed element. The
failure reason is present if the operation status indicates a failure (in abort state).
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
EXCPT_ENTITY_NOT_FOUND - Raised when the ME does not exist.
Compliance
CTM-defined.
Name Type Input/Output Description
managedElementName globaldefs::NamingAttributes_T
managedElementName
In Name of the ME for which a software download
status is required.
backupStatus BackupStatus_T Out Status of the download.