User guide

3-296
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.2 getMEBackupStatus
Compliance
TMF-defined.
3.18.2 getMEBackupStatus
Synopsis
void getMEBackupStatus (
in globaldefs::NamingAttributes_T managedElementName,
out BackupStatus_T backupStatus)
raises(globaldefs::ProcessingFailureException);
Description
The NMS uses this method to obtain the current backup status of an individual ME.
Parameters
BackupStatus_T is defined as:
Current_OperationStatus_T opStatus
string failureReason
This data structure identifies the status of the backup operation for a managed element. The failure
reason is present if the operation status indicates a failure (in abort state).
• Current_OperationStatus_T opStatus—Indicates the current operational status of the backup. The
structure of Current_OperationStatus_T is defined as:
enum Current_OperationStatus_T { COS_Idle, COS_Pending, COS_InProgress, COS_Completed,
COS_Aborted };
where:
– COS_Idle—The backup operation is waiting.
– COS_Pending—The backup operation is queued.
– COS_InProgress—The backup operation is running.
– COS_Completed—The backup operation succeeded.
– COS_Aborted—The backup operation was canceled.
• string failureReason—A free-form text string provided if the opStatus value is COS_Aborted to
explain the reason for the abort. (For example, “Comms loss with NE.”)
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
EXCPT_NOT_IMPLEMENTED - Raised if the EMS does not support this service.
Name Type Input/Output Description
managedElementName NamingAttributes_T In Name of the ME for which the status of the backup
configuration data is required.
backupStatus BackupStatus_T Out Backup status of the ME.