Cisco Cisco Evolved Programmable Network Manager 2.0 Developer's Guide

Page of 642
 
MTOSI Interface Details 
 
 
 
 
 
 
Cisco EPN Manager 2.0.3 MTOSI API Guide for OSS Integration  
 
 
104 
4.14.4.2.2 
Modify 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. 
4.14.4.2.3 
Output 
Response parameter 
Data Type 
Description 
modifyResponse 
modifyResponse 
Details of the modified service(s). 
beginProcessingEvent 
BeginProcessingEventType 
Indication that the target OS has 
removed the request from the queue 
and has started to work on the request. 
cfsCreation 
CfsCreationEventType 
Indication that CFS modified/creation is 
successful. 
cfsAvcChange 
CfsAvcEventType 
Indication that the target OS has 
changed the attributes of one or more 
CFSs. It is also possible to add and 
delete attributes. 
serviceCreationFailureEve
nt 
ServiceCreationFailureEventType 
Indicates partial failure scenario. This 
event is an indication that the target OS 
could not create a CFS (in support of a 
given product instance). 
serviceStateTransitionFailu
reEvent 
ServiceStateTransitionFailureEve
ntType 
Indicates partial failure scenario. This 
event is an indication that the target OS 
is reporting a CFS state transition failure 
from the current state to the next one in 
the CFS activation lifecycle. 
 
4.14.4.2.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.  
4.14.4.3 
Terminate 
This API allows an OSS/NMS to terminate a previously-performed provision request. This operation 
terminates the CFSs in support of a product instance. When this request is complete, each CFS (associated 
with the product instance) should be in the terminated state. The RFSs (that once supported the CFSs) will be 
disassociated from the CFSs and made available for use in other situations.  
 
Pre-condition(s): The CFSs supporting the product instance must be in the Provisioned_Active state. 
 
Post-condition(s): In case of success, the CFS(s) associated with the product instance will be in the 
Terminated state. If an atomic request fails, all CFS(s) will be returned to their original state before the 
service request. The best effort is that the CFSs associated with the product instance remains in their current 
state; no rollback is attempted in this case. 
4.14.4.3.1 
Input 
Request parameter 
Data Type 
Description 
terminateRequest 
terminateRequest 
Information about service termination. 
rootRequest 
RootRequestType 
 
VendorExtensions 
AnyListType 
Vendor extensions required for this request. 
productName 
NamingAttributeType 
Name of the product associated with 
terminate request.