Cisco Cisco Evolved Programmable Network Manager 1.2 Developer's Guide

Page of 594
[Type text] 
 
 
Cisco EPN Manager OSS  Integration  Guide for  MTOSI 
 
 
105 
4.13.4.5.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.  
 
NOTE: The API is generally used to deactivate a Service. In this case the API is specifically used to turn the 
AdminStatus of the CFS to DOWN. In the process the CFS will be re-deployed. 
 
4.13.4.6 
retrieveServiceStates 
 
The API allows an OSS/NMS to retrieve the state of the previously-performed provision request. This 
operation returns the name and state for each CFS associated with a given product instance. (This is typically 
done instead of CFS events for creation, state change, and deletion.) 
 
Pre-condition(s): The product instance (identified by productName) must already exist. 
 
Post-condition(s): In case of success, the CFS(s) associated with the product instance will be unchanged, and 
the requesting OS will have the information that it requested. In case of failure, the CFS(s) associated with 
the product instance are unchanged but the requesting OS will not have the information that it requested. 
4.13.4.6.1 
Input 
Request parameter 
Data Type 
Description 
retrieveServiceStateRequest 
retrieveServiceStateRequest  Details of the service states requested. 
rootRequest 
RootRequestType 
 
VendorExtensions 
AnyListType 
Vendor extensions required for this 
request. 
productName 
NamingAttributeType 
Name of product associated with the 
terminate request. 
4.13.4.6.2 
Output 
Response parameter 
Data Type 
Description 
retrieveServiceStatesResp
onse 
retrieveServiceStatesResponse 
Details of the service states retrieved. 
cfsName 
NamingAttributeType 
Names of the CFS. 
cfsState 
String 
State of the CFS. 
4.13.4.6.3 
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 Alarm Retrieval 
The Alarm Retrieval operations retrieve alarm details. 
 
4.14.1 Operations 
4.14.1.1 
 getActiveAlarms 
 
This operation retrieves the active alarms.