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
107
Request parameter
Data Type
Description
productBundleName
NamingAttributeType
Not used; Ignored.
productSpecCharacteristicRef NamingAttributeType
Not used; Ignored.
productCharacteristicValue
String
Not used; Ignored.
subscriberRefList
NamingAttributeType
Not used; Ignored.
userRefList
NamingAttributeType
Not used; Ignored.
sapRefList
NamingAttributeType
Not used; Ignored.
4.14.4.5.2
Activate Response
Upon success, a CFS creation will be sent as part of the response. A CFS State Transition event will be
generated as part of a successful response. Upon a failure, A CFS State Transition Failure event will be
generated as part of an un-successful response.
generated as part of a successful response. Upon a failure, A CFS State Transition Failure event will be
generated as part of an un-successful response.
4.14.4.5.3
Output
Response parameter
Data Type
Description
terminateResponse
terminateResponse
Details of the terminated service(s).
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.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.
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.14.4.6
retrieveServiceStates
This 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.
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.14.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.
request.
productName
NamingAttributeType
Name of product associated with the
terminate request.
terminate request.