Cisco Cisco Evolved Programmable Network Manager 2.0 Developer's Guide
MTOSI Interface Details
Cisco EPN Manager 2.0.3 MTOSI API Guide for OSS Integration
116
4.17 ConnectionControl
The interface provides operations to control a service connection.
4.17.1 Operations
4.17.1.1
switchRoute
This operation allows a user to 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.
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.
of <CFSNAME> )
NOTE: This API takes the service ID as input hence the
CFS RDN should be provided.
4.17.1.1.1
Output
Post-Condition: On successful completion of the switchRoute (manual Revert), the service will go back to its
original path. The restoration status will change to NONE.
original path. The restoration status will change to NONE.
4.17.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.
notImplemented: Indicates that the operation is not implemented by the management system.
Note: The SwitchRoute operation is provided to perform a manual revert operation on a given service. This is
a deviation from the standard support provided by the switchRoute API.
invalidInput: Indicates that the input given to the operation is invalid.
notImplemented: Indicates that the operation is not implemented by the management system.
Note: The SwitchRoute operation is provided to perform a manual revert operation on a given service. This is
a deviation from the standard support provided by the switchRoute API.
Switch Route Data
Data Type
Description
SwitchRouteRespon
se
se
Holder element that contains information about the
ManualRevert operation.
ManualRevert operation.
modifiedTp
TerminationPointDataTy
pe
pe
The complex element containing the Termination Point
which was modified.
which was modified.
VendorExtensions
ciscoAlarmExtension
Contains Cisco specific Vendor Extensions
ciscoConnectionCon
trolManualRevert
trolManualRevert
CiscoConnectionControl
ManualRevertType
ManualRevertType
controlCommand
String
The command issued.
controlCommandMe
ssage
ssage
String
The message returned from the command execution.
controlCommandRe
sult
sult
String
True/False to indicate the success/failure status of the
command.
command.
controlDevice
String
The device on which the action was performed.