getBackupProgress
Available since 9.1.1
The getBackupProgress method retrieves the progress of the current backup.
Request Parameters
None
Response Parameters (return element children)
remoteMessages
xsi:nil="true" - there are no remoteMessages
result
A result code such as internal.request.complete that describes the result. See Error Codes in the
Developer Guide for details.
Developer Guide for details.
backupProgressResult
stores the progress result for the current backup operation. The status element indicates the current status of the backup. For example:
If the backup is in progress, it will return "Status: Backup operation in progress for server <server>, please wait"
When the backup completes, it will return "Status: SUCCESS: Backup Completed"
If the backup is in progress, it will return "Status: Backup operation in progress for server <server>, please wait"
When the backup completes, it will return "Status: SUCCESS: Backup Completed"
startBackupResult
xsi:nil="true" - there are no startBackupResult messages, or backup result messages
updateScheduleResult
Message relating success or failure of update
Example Request and Response
Request
Response
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:ser="server_url">
<soap:Header/>
<soap:Body>
<ser:getBackupProgress xmlns:ns="server_url"/>
</soap:Body>
</soap:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header xmlns:wsa="http://www.w3.org/2005/08/addressing"> <wsa:Action>urn:getBackupProgressResponse</wsa:Action> <wsa:RelatesTo>uuid:db301556-ed57-436c-966e-f5b7562b1b7d</wsa:RelatesTo> </soapenv:Header> <soapenv:Body> <ns:getBackupProgressResponse xmlns:ns="http://services.api.platform.vos.cisco.com"> <ns:return xmlns:ax29="http://element.services.api.platform.vos.cisco.com/xsd" xmlns:ax210="http://api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax29:MaintenanceResponse"> <ax29:remoteMessages xsi:nil="true" /> <ax29:result>internal.request.complete</ax29:result> <ax29:backupProgressResult xsi:type="ax29:MaintenanceStatus"> <ax29:componentList>ELM BLDR-VCM86 ELM SUCCESS Wed Dec 12 14:46:06 MST 2012 activelog/platform/drf/log/2012-12-12-14-46-05_b_bldr-vcm86_elm_elm.log ELM BLDR-VCM87 ELM SUCCESS Wed Dec 12 14:46:08 MST 2012 activelog/platform/drf/log/2012-12-12-14-46-05_b_bldr-vcm87_elm_elm.log UCM BLDR-VCM86 CDPAGT SUCCESS Wed Dec 12 14:46:10 MST 2012 activelog/platform/drf/log/2012-12-12-14-46-05_b_bldr-vcm86_ucm_cdpagt.log UCM BLDR-VCM86 SYSLOGAGT SUCCESS Wed Dec 12 14:46:11 MST 2012 activelog/platform/drf/log/2012-12-12-14-46-05_b_bldr-vcm86_ucm_syslogagt.log UCM BLDR-VCM86 TCT SUCCESS Wed Dec 12 14:46:12 MST 2012 activelog/platform/drf/log/2012-12-12-14-46-05_b_bldr-vcm86_ucm_tct.log UCM BLDR-VCM86 CCMDB SUCCESS Wed Dec 12 14:46:13 MST 2012 activelog/platform/drf/log/2012-12-12-14-46-05_b_bldr-vcm86_ucm_ccmdb.log </ax29:componentList> <ax29:operation>Operation: BACKUP</ax29:operation> <ax29:percentage>Percentage Complete: 100</ax29:percentage> <ax29:status>Status: SUCCESS :Backup Completed...</ax29:status> <ax29:storageLoc>Storage Location: NETWORK</ax29:storageLoc> <ax29:tarFile>Tar Filename: 2012-12-12-14-46-05.tar</ax29:tarFile> </ax29:backupProgressResult> <ax29:startBackupResult xsi:nil="true" /> <ax29:updateScheduleResult xsi:nil="true" /> </ns:return> </ns:getBackupProgressResponse> </soapenv:Body> </soapenv:Envelope>
scheduleBackup
Available since 9.1.1
The scheduleBackup method updates an already scheduled DRS backup which is to be run some time in the future. In general, there should be a default scheduled backup named all-maint-activities. This method provides a way to override the default schedule by passing the schedule name and a time to run the backup..
Request Parameters
args0
the schedule name
args1
The time when this backup should be run in yyyy-mm-dd-Thh-mm-sss-offset format (Example:2012-12-28T15:50:00.000-05:00).
args2
Boolean, true indicates that the scheduled back up should be enabled and false indicates scheduled backup should be disabled. Default is true.
Response Parameters (return element children)
remoteMessages
xsi:nil="true" - there are no remoteMessages
result
A result code such as internal.request.complete that describes the result. See Error Codes in the
Developer Guide for details.
Developer Guide for details.
backupProgressResult
xsi:nil="true" - there are no backupProgressResult messages, or progress result messages
startBackupResult
xsi:nil="true" - there are no startBackupResult messsages, or backup result messsages
updateScheduleResult
Message relating successs or failure of scheduling backup. For example:
If the schedule is updated successfully, this will return-- "Update Successful"
If you try to update the schedule with time that has already past, this will return-- "Cannot save schedule as the time set has passed"
If the schedule is updated successfully, this will return-- "Update Successful"
If you try to update the schedule with time that has already past, this will return-- "Cannot save schedule as the time set has passed"
Example Request and Response
Request
Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.api.platform.vos.cisco.com">
<soapenv:Header/>
<soapenv:Body>
<ser:scheduleBackup>
<!--Optional:-->
<ser:args0>test-backup</ser:args0>
<!--Optional:-->
<ser:args1>2012-12-28T12:50:00.000-05:00</ser:args1>
<!--Optional:-->
<ser:args2>true</ser:args2>
</ser:scheduleBackup>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
<wsa:Action>urn:scheduleBackupResponse</wsa:Action>
<wsa:RelatesTo>uuid:8d45f065-d794-48b1-996d-788f28bd50af</wsa:RelatesTo>
</soapenv:Header>
<soapenv:Body>
<ns:scheduleBackupResponse xmlns:ns="http://services.api.platform.vos.cisco.com">
<ns:return xsi:type="ax29:MaintenanceResponse" xmlns:ax29="http://element.services.api.platform.vos.cisco.com/xsd" xmlns:ax210="http://api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax29:remoteMessages xsi:nil="true"/>
<ax29:result>internal.request.complete</ax29:result>
<ax29:backupProgressResult xsi:nil="true"/>
<ax29:startBackupResult xsi:nil="true"/>
<ax29:updateScheduleResult>Update successful</ax29:updateScheduleResult>
</ns:return>
</ns:scheduleBackupResponse>
</soapenv:Body>
</soapenv:Envelope>
startBackup
Available since 9.1.1
The startBackup method starts a previously scheduled backup immediately. It requires the schedule name of the previously scheduled backup as an input.
Request Parameters
args0
the schedule name
Response Parameters (return element children)
remoteMessages
xsi:nil="true" - there are no remoteMessages
result
A result code such as internal.request.complete that describes the result. See Error Codes in the
Developer Guide for details.
Developer Guide for details.
backupProgressResult
xsi:nil="true" - there are no backupProgressResult messages, or progress result messages
startBackupResult
Indicates if the backup could be started or not. If the backup gets started, the result is returned only after the backup is completed. For example:
If backup is successful, this will return "SUCCESS: Backup Completed..." For an example error case, suppose the Local agent is down, and the backup will not start. This will return "Failure: Unable to start backup because there are no local agents connected. This may be due to Master or Local Agent being down."
In the example below, the Master Agent service is be busy with processing any IO operations, so the service returns "Failure: Unable to process request, master agent is busy".
If backup is successful, this will return "SUCCESS: Backup Completed..." For an example error case, suppose the Local agent is down, and the backup will not start. This will return "Failure: Unable to start backup because there are no local agents connected. This may be due to Master or Local Agent being down."
In the example below, the Master Agent service is be busy with processing any IO operations, so the service returns "Failure: Unable to process request, master agent is busy".
updateScheduleResult
Message relating successs or failure of update schedule
Example Request and Response
Request
Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.api.platform.vos.cisco.com">
<soapenv:Header/>
<soapenv:Body>
<ser:startBackup>
<!--Optional:-->
<ser:args0>test-backup</ser:args0>
</ser:startBackup>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
<wsa:Action>urn:startBackupResponse</wsa:Action>
<wsa:RelatesTo>uuid:a5072dac-709c-486d-a0ad-9ab4ea79e2a5</wsa:RelatesTo>
</soapenv:Header>
<soapenv:Body>
<ns:startBackupResponse xmlns:ns="http://services.api.platform.vos.cisco.com">
<ns:return xsi:type="ax29:MaintenanceResponse" xmlns:ax29="http://element.services.api.platform.vos.cisco.com/xsd" xmlns:ax210="http://api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax29:remoteMessages xsi:nil="true"/>
<ax29:result>internal.request.complete</ax29:result>
<ax29:backupProgressResult xsi:nil="true"/>
<ax29:startBackupResult>Failure: Unable to process request, master agent is busy</ax29:startBackupResult>
<ax29:updateScheduleResult xsi:nil="true"/>
</ns:return>
</ns:startBackupResponse>
</soapenv:Body>
</soapenv:Envelope>