Cisco Cisco Evolved Programmable Network Manager 2.0 Developer's Guide

Page of 631
 
MTOSI Interface Details 
 
 
 
 
 
 
Cisco EPN Manager 2.0.1 MTOSI API Guide for OSS Integration  
 
 
79 
Technology 
Service 
Service Type 
ELAN 
EP-LAN 
EVP-LAN 
E-Tree 
EP-Tree 
EVP-Tree 
E-Access 
Access EPL 
Access EVPL 
 
4.14.2 Error Message Format with Error Codes 
In EPNM, all the MTOSI APIs return error messages as SOAP Faults. In case of Service Activation APIs 
(Provisioning API), SOAP fault message contains additional detail element to provide more details about the 
error.  This contains MTOSI specific error elements structure (internalError, NotImplementedError, etc) that 
contains EPNM specific error element to show the error details with error code and text message in the 
vendor extensions as shown below. 
 
<soap:Fault> 
      <faultcode>soap:Server</faultcode> 
      <faultstring>Invalid Port reference for Device ID - TerminationPoint not found with FDN 
[MD=CISCO_EPNM, ME=ASR903-165.68, 
FTP=name=GigabitEthernet0/4/3;LR=LR_ETHERNET]</faultstring> 
      <detail> 
        <ns3:provisionException> 
          <ns3:basicFailureEvent> 
            <ns16:internalError> 
              <ns16:vendorExtensions> 
                <ns27:error> 
                  <ns27:code>MTOSI_0000</ns27:code> 
                  <ns27:message>Invalid Port reference for Device ID - TerminationPoint not found with 
FDN [MD=CISCO_EPNM, ME=ASR903-165.68, 
FTP=name=GigabitEthernet0/4/3;LR=LR_ETHERNET]</ns27:message> 
                </ns27:error> 
              </ns16:vendorExtensions> 
            </ns16:internalError> 
          </ns3:basicFailureEvent> 
        </ns3:provisionException> 
      </detail> 
    </soap:Fault> 
 
Content of the error element in the vendor extensions  has the follow elements for error details. 
code - error code to identify the type of error - a programming interface to the API; can use this to further 
process the error based on the code according to the OSS integration requirement. 
message - error message that is a human readable text to describe the error. 
4.14.2.1 
Deploy Result Error or Info message 
In case of provisioning  configuration (CLI) deployment failures where the operation response is not a SOAP 
Fault,  the error code and message are returned in the  deployResult element of the response. 
 
In case of request timeout during the deployment in progress, the response message contains the 
deployResult element with info message with the deployResult’s actionResult attribute set to “running” as 
below.