This operation modifies Disaster Recovery (DR) Backup options.
Request
Syntax
POST <webservice>/Commcell/DRBackup/Options HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
<update_disaster_recovery_backup_options_template.xml>
where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Headers
Name | Description |
---|---|
Host | The host name of the Web Server or Web Console used in the API request. |
Accept | The format of the response. Valid values are: application/xml or application/json. |
Authtoken | The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
Content-type | The media type contained in the request body. |
Request Body
Download the update_disaster_recovery_backup_options_template.xml file required for this request and fill in the necessary values. The following table displays the parameters in this .xml file.
Parameter | Description | Element |
---|---|---|
DRNumFulls | Number of DR backups to retain | properties |
DRDumpLocation | Destination path for DR metadata. | properties |
UseNetworkShare | Whether network share location is used to save DR metadata. Valid values are: 0, for enabled 1, for enabled | properties |
UseLocalDrive | Whether local drive is used to save DR metadata. Valid values are: 0, for enabled 1, for disabled | properties |
isUserAccountEnabled | Whether user account is needed to access the network share. Valid values are: 0, for enabled 1, for disabled | properties |
uploadBackupMetadataToCloud | Whether DR Backups should be uploaded to the Metallic Cloud. Valid values are: 0, for enabled 1, for disabled | properties |
cloudCredentials userName | Username that must be used to access the Commvault Cloud account. | properties |
password | The corresponding password for the Commvault Cloud username | properties |
pattern freq_type | Indicates how often the schedule is run. Valid value is 4. (Daily) | properties |
freq_interval | Valid value is 23. | properties |
freq_recurrence_factor | Valid value is 86. | properties |
active_start_time | The start time of the schedule specified in seconds. | properties |
Response
Response Parameters
Parameter | Description | Element |
---|---|---|
errorCode | 0, successful completion. 1, failure. | CVGui_GenericResp |
errorMessage | The description of the error code. Not all error codes have an error message. | CVGui_GenericResp |
Examples
Sample Request
POST <webservice>/Commcell/DRBackup/Options HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<Api_SetDRBackupPropertiesReq>
<properties DRNumFulls="5" DRDumpLocation="MyLocation" UseNetworkShare="0" UseLocalDrive="1" isUserAccountEnabled="0" uploadBackupMetadataToCloud="1">
<cloudCredentials userName="Admin" password="xxxx" />
<pattern freq_type="Daily" freq_interval="3" freq_recurrence_factor="3" active_start_time="1489611496" />
</ properties>
</Api_SetDRBackupPropertiesReq>
Sample Response
<?xml version="1.0" encoding="UTF-8" standalone="no" ?><EVGui_GenericResp errorCode="0" errorMessage=""/>