Cisco Cisco Evolved Programmable Network Manager 1.2 Developer's Guide

Page of 594
[Type text] 
 
 
Cisco EPN Manager OSS  Integration  Guide for  MTOSI 
 
 
102 
4.13.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.13.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.13.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 product associated with terminate 
request. 
soaInput 
RequestInfoSOAwareType 
Service Order Aware Type. Not used in request 
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.13.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. 
4.13.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. 
cfsStateChange 
CfsStateChangeEventType 
Indicates that target OS has progressed 
one or more CFSs from one state to 
another state. 
serviceStateTransitionFailu
reEvent 
ServiceStateTransitionFailureEve
ntType 
Indicates partial failure scenario.