Cisco Cisco Evolved Programmable Network Manager 1.2 Developer's Guide
MTOSI Interface Details
Cisco EPN Manager 1.2 Maintenance Pack 5 (V.1.2.500) MTOSI API Guide for OSS Integration
115
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.
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.
4.16.1.2
setIntendedRoute
This operation allows a user to set Perform an Upgrade and Restore 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 RESTORED or RESTORED & REVERTIBLE.
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 RESTORED or RESTORED & REVERTIBLE.
Request parameter
Data Type
Description
setIntendedRouteRequest SetIntendedRouteReques
tType
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.
CFS=<CFSID> of <CFSNAME> )
NOTE: This API takes the service ID as input hence
the CFS RDN should be provided.
4.16.1.2.1
Output
Post-Condition: On a successful setIntentedRoute (upgradeRestore) the current restoration path will be set
as the working path. Restoration Status will be set to NONE.
as the working path. Restoration Status will be set to NONE.
4.16.1.2.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 setIntendedRoute operation is provided to perform an Upgrade And Restore operation on a given
service (OCHTRAIL or OCHNC nnly). This is a deviation from the standard support provided by the
setIntendedRoute 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 setIntendedRoute operation is provided to perform an Upgrade And Restore operation on a given
service (OCHTRAIL or OCHNC nnly). This is a deviation from the standard support provided by the
setIntendedRoute API.
Switch Route Data
Data Type
Description
SetIntendedRouteRe
sponse
sponse
Holder Element that contains information about the
Upgrade Restore operation.
Upgrade Restore operation.
VendorExtensions
ciscoAlarmExtension
Contains Cisco specific Vendor Extensions
ciscoConnectionCon
trolUpgradeRestore
trolUpgradeRestore
CiscoConnectionCont
rolUpgradeRestoreTy
pe
rolUpgradeRestoreTy
pe
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.