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
105
Request parameter
Data Type
Description
soaInput
RequestInfoSOAwareType
Service Order Aware Type. Not used in request
processing, but mandatory in request data.
processing, but mandatory in request data.
requestedCompletionDate
dateTime
Not used. Initialize with current date.
Priority
Integer
Not used. Initialize with 0.
purchaseOrder
String
Not used. Initialize with “NONE”.
validFor
dateTime
Not used. Initialize with current date.
4.14.4.3.2
Terminate Response
Multiple responses to a request are possible, unless there is an exception. The expectation is to have one
instance of the initialResponse and beginProcessingEvent, and multiple instances of success and failure
responses. The header of the last response will indicate success or failure.
instance of the initialResponse and beginProcessingEvent, and multiple instances of success and failure
responses. The header of the last response will indicate success or failure.
4.14.4.3.3
Output
Response parameter
Data Type
Description
terminateResponse
terminateResponse
Details of the terminated service(s).
beginProcessingEvent
BeginProcessingEventType
Indicates that target OS has removed
the request from the queue and has
started to work on the request.
the request from the queue and has
started to work on the request.
cfsStateChange
CfsStateChangeEventType
Indicates that target OS has progressed
one or more CFSs from one state to
another state.
one or more CFSs from one state to
another state.
serviceStateTransitionFailu
reEvent
reEvent
ServiceStateTransitionFailureEve
ntType
ntType
Indicates partial failure scenario.
4.14.4.3.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.
invalidInput: Indicates that the input given to the operation is invalid.
4.14.4.4
activate
This API allows an OSS/NMS to set the adminState of a service to UP. Upon a successful update of the
adminState, the specified service will be re-deployed on the network.
Pre-condition(s): The CFS supporting the product instance must be in the Provisioned_Active state.
adminState, the specified service will be re-deployed on the network.
Pre-condition(s): The CFS supporting the product instance must be in the Provisioned_Active state.
The CFS should be created by the EPNM system and to be in discovered State.
The CFS should be having the adminStatus as DOWN
Post-condition(s): In case of success, the admin Status of the CFS associated with the product instance will be
in UP State. If the request fails, the CFS will be returned to their original state before the service request. The
user will receive a ServiceStateTransition failure in the response.
4.14.4.4.1
Input
Request parameter
Data Type
Description
activateRequest
activateRequst
Information about service activation.
basicInput
BasicInputType
VendorExtensions
AnyListType
Vendor extensions required for this request.
productName
NamingAttributeType
Name of product associated with terminate
request.
request.
soaInput
RequestInfoSOAwareType
Service Order Aware Type. Not used in
request processing, but mandatory in request
data.
request processing, but mandatory in request
data.
productSpecificationName
NamingAttributeType
Not used; Ignored.