scheduleBackup

Requirements

Minimum user privilege level: 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 passsing the schedule name and a time to run the backup..

Request Parameters
args0


The backup name.
args1


The time when this backup should be run in yyyymmddThhmmsss-offset format.
args2


Boolean - True enables scheduled backup and false disables scheduled backup
Response Parameters (return element children)
result


A result code such as internal.request.complete that describes the result. See Error Codes in the Developer's Guide for details.
remoteMessages


If xsi:nil="true" then there are no remote messages. Otherwise:

  • error - Boolean, true if an error occurred, false otherwise
  • info - Boolean
  • messageKey - A result code such as internal.request.denied.lock if such an error occurred
  • messageType - The type of error, such as internal.message.error
  • warning - Boolean, true if this is a warning, false if not
  • messageParams - Information about the message (there can be more than one messageParam)
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
Example Request and Response
Request Response 
<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="server_url">
	<soap:Header/>
	<soap:Body>
		<ser:scheduleBackup>
			<ser:args0>all-maint-activities</ser:args0>
			<ser:args1>2012-12-28T15:50:00.000-05:00</ser:args1>
			<ser:args2>true</ser:args2>
		</ser:scheduleBackup>
	</soap:Body>
</soap:Envelope>
									
								
<?xml version='1.0' encoding='UTF-8'?>
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
	<soapenv:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
		<wsa:Action>urn:scheduleBackupResponse</wsa:Action>
		<wsa:RelatesTo>uuid:cd65cd4f-8589-4126-ad88-833a71979fda</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:scheduleBackupResponse xmlns:ns="server_url">
			<ns:return xsi:type="ax213:MaintenanceResponse" xmlns:ax214="server_url/xsd" xmlns:ax213="server_url/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
				<ax213:remoteMessages xsi:nil="true"/>
				<ax213:result>internal.request.complete</ax213:result>
				<ax213:backupProgressResult xsi:nil="true"/>
				<ax213:startBackupResult xsi:nil="true"/>
				<ax213:updateScheduleResult>Update successful</ax213:updateScheduleResult>
			</ns:return>
		</ns:scheduleBackupResponse>
	</soapenv:Body>
</soapenv:Envelope>

startBackup

Requirements

Minimum user privilege level: 1

The startBackup method starts a previously scheduled backup immediately. It requires the scheduleID of the previously scheduled backup as an input.

Use APIVersionService to check which version of the API you have. Version 5.0.1.0 will cause large CPU spikes. Only use during scheduled maintenance windows.

Request Parameters
args0


Schedule name
args1


scheduleID
Response Parameters (return element children)
result


A result code such as internal.request.complete that describes the result. See Error Codes in the Developer's Guide for details.
remoteMessages


If xsi:nil="true" then there are no remote messages. Otherwise:

  • error - Boolean, true if an error occurred, false otherwise
  • info - Boolean
  • messageKey - A result code such as internal.request.denied.lock if such an error occurred
  • messageType - The type of error, such as internal.message.error
  • warning - Boolean, true if this is a warning, false if not
  • messageParams - Information about the message (there can be more than one messageParam)
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 messages
updateScheduleResult


Message relating successs or failure of update schedule
Example Request and Response
Request Response 
<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="server_url">
	<soap:Header/>
	<soap:Body>
		<ser:startBackup>
			<!--Optional:-->
			<ser:args0>test</ser:args0>
		</ser:startBackup>
	</soap:Body>
</soap:Envelope>

								
<?xml version='1.0' encoding='UTF-8'?>
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
	<soapenv:Body>
		<ns:startBackupResponse xmlns:ns="server_url">
			<ns:return xsi:type="ax213:MaintenanceResponse" xmlns:ax214="server_url/xsd" xmlns:ax213="server_url/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
				<ax213:remoteMessages xsi:nil="true"/>
				<ax213:result>internal.request.complete</ax213:result>
				<ax213:backupProgressResult xsi:nil="true"/>
				<ax213:startBackupResult xsi:nil="true"/>
				<ax213:updateScheduleResult>Update successful</ax213:updateScheduleResult>
			</ns:return>
		</ns:startBackupResponse>
	</soapenv:Body>
</soapenv:Envelope>

getBackupProgress

Requirements

Minimum user privilege level: 1

The getBackupProgress method retrieves the progress of the current backup.

Request Parameters
None
Response Parameters (return element children)
result


A result code such as internal.request.complete that describes the result. See Error Codes in the Developer's Guide for details.
remoteMessages


If xsi:nil="true" then there are no remote messages. Otherwise:

  • error - Boolean, true if an error occurred, false otherwise
  • info - Boolean
  • messageKey - A result code such as internal.request.denied.lock if such an error occurred
  • messageType - The type of error, such as internal.message.error
  • warning - Boolean, true if this is a warning, false if not
  • messageParams - Information about the message (there can be more than one messageParam)
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 messages
updateScheduleResult


Message relating successs or failure of update
Example Request and Response
Request Response 
<?xml version='1.0' encoding='UTF-8'?>
<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>
      
								
<?xml version='1.0' encoding='UTF-8'?>
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
        <wsa:Action>urn:getBackupProgressResponse</wsa:Action>
        <wsa:RelatesTo>uuid:bbe33389-675c-44ff-b7ba-43e85244fb8f</wsa:RelatesTo>
    </soapenv:Header>
    <soapenv:Body>
        <ns:getBackupProgressResponse xmlns:ns="server_url">
            <ns:return xsi:type="ax213:MaintenanceResponse" xmlns:ax214="server_url/xsd" xmlns:ax213="server_url/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax213:remoteMessages xsi:nil="true"/>
                <ax213:result>internal.request.complete</ax213:result>
                <ax213:backupProgressResult>Status: Backup operation in progress for server [CSEVDIR79], please wait... Tar Filename: 2012-01-17-10-11-23.tar Storage Location: NETWORK Operation: BACKUP Percentage Complete: 91 UCM CSEVDIR79 PLATFORM SUCCESS Tue Jan 17 10:11:24 IST 2012 activelog/platform/drf/log/2012-01-17-10-11-23_b_csevdir79_ucm_platform.log UCM CSEVDIR79 CLM SUCCESS Tue Jan 17 10:11:29 IST 2012 activelog/platform/drf/log/2012-01-17-10-11-23_b_csevdir79_ucm_clm.log UCM CSEVDIR79 CDPAGT SUCCESS Tue Jan 17 10:11:29 IST 2012 activelog/platform/drf/log/2012-01-17-10-11-23_b_csevdir79_ucm_cdpagt.log UCM CSEVDIR79 SYSLOGAGT SUCCESS Tue Jan 17 10:11:29 IST 2012 activelog/platform/drf/log/2012-01-17-10-11-23_b_csevdir79_ucm_syslogagt.log UCM CSEVDIR79 TCT SUCCESS Tue Jan 17 10:11:30 IST 2012 activelog/platform/drf/log/2012-01-17-10-11-23_b_csevdir79_ucm_tct.log UCM CSEVDIR79 CCMDB SUCCESS Tue Jan 17 10:11:30 IST 2012 activelog/platform/drf/log/2012-01-17-10-11-23_b_csevdir79_ucm_ccmdb.log UCM CSEVDIR79 CCMPREFS SUCCESS Tue Jan 17 10:11:50 IST 2012 activelog/platform/drf/log/2012-01-17-10-11-23_b_csevdir79_ucm_ccmprefs.log UCM CSEVDIR79 ANN SUCCESS Tue Jan 17 10:11:52 IST 2012 activelog/platform/drf/log/2012-01-17-10-11-23_b_csevdir79_ucm_ann.log UCM CSEVDIR79 CEF SUCCESS Tue Jan 17 10:11:52 IST 2012 activelog/platform/drf/log/2012-01-17-10-11-23_b_csevdir79_ucm_cef.log UCM CSEVDIR79 BAT SUCCESS Tue Jan 17 10:11:53 IST 2012 activelog/platform/drf/log/2012-01-17-10-11-23_b_csevdir79_ucm_bat.log UCM CSEVDIR79 MOH SUCCESS Tue Jan 17 10:11:54 IST 2012 activelog/platform/drf/log/2012-01-17-10-11-23_b_csevdir79_ucm_moh.log UCM CSEVDIR79 TFTP Active Tue Jan 17 10:11:58 IST 2012</ax213:backupProgressResult>
                <ax213:startBackupResult xsi:nil="true"/>
                <ax213:updateScheduleResult xsi:nil="true"/>
            </ns:return>
        </ns:getBackupProgressResponse>
    </soapenv:Body>
</soapenv:Envelope>