Cisco Cisco Evolved Programmable Network Manager 1.2 Developer's Guide

Page of 594
[Type text] 
 
 
Cisco EPN Manager OSS  Integration  Guide for  MTOSI 
 
 
113 
4.15.1.1.4 
Exceptions: 
internalError: Indicates that an internal error or exception has occurred as part of this call. 
invalidInput: Indicates that the input given to the operation is invalid.  
notImplemented: Indicates that the operation is not implemented by the management system. 
 
4.16 ConnectionControl 
The interface provides operations to control a Service Connections.  
 
4.16.1 Operations 
4.16.1.1 
 switchRoute 
This operation allows a user to set perform a manual Revert of a Service. This API is provided as an extension. 
The input should be a valid CFS ID. 
 
NOTE: This operation is supported for OCHTRAIL and OCHNC service types only. 
 
Pre-Condition: The restoration Status of the service should be in RESTORED & REVERTIBLE for the manual 
Revert Operation to succeed.   
 
Request parameter 
Data Type 
Description 
switchRouteRequest  SwitchRouteRequestType 
Details of SwitchRoute Request 
sncRef 
NamingAttributeListType 
FDN for the Service ( MD=CISCO_EPNM / CFS=<CFSID> 
of <CFSNAME> ) 
NOTE: This API takes the service ID as input hence the 
CFS RDN should be provided. 
 
4.16.1.1.1 
Output 
 
Post-Condition: On a successful completion of the switchRoute (manual Revert) the service will go back to its 
original Path. The restoration Status will change to NONE. 
4.16.1.1.2 
Exceptions 
internalError: Indicates that an internal error or exception has occurred as part of this call. 
invalidInput: Indicates that the input given to the operation is invalid.  
Switch Route Data 
Data Type 
Description 
SwitchRouteRespon
se 
 
Holder Element that contains information about the 
ManualRevert operation. 
modifiedTp 
TerminationPointDataTy
pe 
The complex element containing the Termination Point 
which was modified. 
VendorExtensions 
ciscoAlarmExtension 
Contains Cisco specific Vendor Extensions  
ciscoConnectionCon
trolManualRevert 
CiscoConnectionControl
ManualRevertType 
 
controlCommand 
String 
The Command issued.  
controlCommandMe
ssage 
String 
The message returned from the command execution. 
controlCommandRe
sult 
String 
True/False to indicate the success/failure status of the 
command. 
controlDevice 
String 
The device on which the action was performed.