m2DataExportStatus
The m2DataExportStatus method shows the status of a request made by the m2DataExport method.
Request Parameters
None
Response Parameters (return element children)
result
A result code such as data.export.succeeded that describes the result. See Error Codes in the Developer's Guide for details.
m2DataExportStatus
A status code such as data.export.status.none if there is no status to report.
A status code such as data.export.status.inprogress if there is a service already inprogress.
A status code such as error.undetermined.result if there is undetermined result.
A status code such as error.invalid.cmd.args if invalid command line args detected..
A status code such as error.multiple.instance.notallowed if multiple concurrent instance of this program is forbidden.
A status code such as error.create.pid if failed to create PID file.
A status code such as error.remove.pid if failed to remove the PID file.
A status code such as error.acquireLock if failed to acquire the LOCK file.
A status code such as error.releaseLock if failed to remove the LOCK file.
A status code such as error.require.abosulte.sftpPath if SFTP directory path is not an absolute path.
A status code such as error.sftp.not.reachable if server failed validation or is unreachable.
A status code such as error.invalid.sftp.password if SFTP password provided is null.
A status code such as error.createClusterInfo if failed to create the cluster info xml file.
A status code such as error.setPermissions.ClusterInfo if failed to set permissions of cluster info xml file.
A status code such as error.create.nodedirectory if failed to create node directory..
A status code such as error.currNode.auth.failed if the current node is not authenticated.
A status code such as error.export.util.failed if export util failed.
A status code such as error.component.install.failed if component install failed..
A status code such as error.copy.ucplatform.failed if copying uc platform post failed.
A status code such as error.delete.oldexportdata if failed to delete the data of the previous data export operation in the SFTP server.
A status code such as error.create.rootdir if failed to create root directory.
A status code such as error.get.activeVer if failed to fetch the active version.
A status code such as error.copy.remoteserver if failed to copy the export data to remote server.
A status code such as error.dataExport.start if user selected not to start the data export.
A status code such as error.incorrect.format if not in correct format.
A status code such as error.delete.sftp if failed to delete the existing cluster folder in the given sftp location.
A status code such as error.publisher.export.notfound if publisher's export did not run.
A status code such as error.create.exportDirectory if failed to create dataexport directory..
A status code such as error.dynamic.export.failed if dynamic data export failed.
A status code such as data.export.status.inprogress if there is a service already inprogress.
A status code such as error.undetermined.result if there is undetermined result.
A status code such as error.invalid.cmd.args if invalid command line args detected..
A status code such as error.multiple.instance.notallowed if multiple concurrent instance of this program is forbidden.
A status code such as error.create.pid if failed to create PID file.
A status code such as error.remove.pid if failed to remove the PID file.
A status code such as error.acquireLock if failed to acquire the LOCK file.
A status code such as error.releaseLock if failed to remove the LOCK file.
A status code such as error.require.abosulte.sftpPath if SFTP directory path is not an absolute path.
A status code such as error.sftp.not.reachable if server failed validation or is unreachable.
A status code such as error.invalid.sftp.password if SFTP password provided is null.
A status code such as error.createClusterInfo if failed to create the cluster info xml file.
A status code such as error.setPermissions.ClusterInfo if failed to set permissions of cluster info xml file.
A status code such as error.create.nodedirectory if failed to create node directory..
A status code such as error.currNode.auth.failed if the current node is not authenticated.
A status code such as error.export.util.failed if export util failed.
A status code such as error.component.install.failed if component install failed..
A status code such as error.copy.ucplatform.failed if copying uc platform post failed.
A status code such as error.delete.oldexportdata if failed to delete the data of the previous data export operation in the SFTP server.
A status code such as error.create.rootdir if failed to create root directory.
A status code such as error.get.activeVer if failed to fetch the active version.
A status code such as error.copy.remoteserver if failed to copy the export data to remote server.
A status code such as error.dataExport.start if user selected not to start the data export.
A status code such as error.incorrect.format if not in correct format.
A status code such as error.delete.sftp if failed to delete the existing cluster folder in the given sftp location.
A status code such as error.publisher.export.notfound if publisher's export did not run.
A status code such as error.create.exportDirectory if failed to create dataexport directory..
A status code such as error.dynamic.export.failed if dynamic data export failed.
Example Request and Response
Request
Response
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
<wsa:Action>urn: m2DataExportStatus</wsa:Action>
<wsa:MessageID>uuid:63e5d8ca-dcac-40af-916b-d32ec3382d0f</wsa:MessageID>
<wsa:ReplyTo>
<wsa:Address>http://www.w3.org/2005/08/addressing/anonymous</wsa:Address>
</wsa:ReplyTo>
<wsa:To></wsa:To>
</soapenv:Header>
<soapenv:Body>
<m2DataExportStatus xmlns="http://services.api.platform.vos.cisco.com"/>
</soapenv:Body>
</soapenv:Envelope>
<?xml version='1.0' encoding='UTF-8'?> <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"> <wsa:To>http://www.w3.org/2005/08/addressing/anonymous</wsa:To> <wsa:MessageID>urn:uuid:0a144548-81c9-42f0-a302-19c7c37a09e6</wsa:MessageID> <wsa:Action>urn:m2DataExportStatusResponse</wsa:Action> <wsa:RelatesTo>uuid:63e5d8ca-dcac-40af-916b-d32ec3382d0f</wsa:RelatesTo> </soapenv:Header> <soapenv:Body> <ns:m2DataExportStatusResponse xmlns:ns="http://services.api.platform.vos.cisco.com"> <ns:return xmlns:ax2109="http://element.services.api.platform.vos.cisco.com/xsd" xmlns:ax2110="http://api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax2109:M2DataExportStatusResponse"> <ax2109:result>internal.request.complete</ax2109:result> <ax2109:m2DataExportStatus>m2.data.export.status.none</ax2109:m2DataExportStatus> </ns:return> </ns:m2DataExportStatusResponse> </soapenv:Body> </soapenv:Envelope>