REST API - GET Disaster Recovery Backup Options

This operation returns the details for Disaster Recovery (DR) Backup options.

Syntax

GET <webservice>/Commcell/DRBackup/Options HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>

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.

Response

Response Parameters

Parameter	Description	Element
DRDumpLocation	Destination path for DR metadata.	properties
UseLocalDrive	Whether local drive is used to save DR metadata. Valid values are: 1, for enabled 0, for disabled	properties
isUserAccountEnabled	Whether user account is needed to access the network share. Valid values are: 1, for enabled 0, for disabled	properties
UseNetworkShare	Whether network share location is used to save DR metadata. Valid values are: 1, for enabled 0, for enabled	properties
DRNumFulls	Number of DR backups to retain.	properties
uploadBackupMetadataToCloud	Whether DR Backups should be uploaded to the Commvault Cloud. Valid values are: 0, for disabled 1, for enabled	properties
uploadBackupMetadataToCloudLib	Whether DR Backups should be uploaded to the cloud library . Valid values are: 0, for disabled 1, for enabled	properties
cloudCredentials userName	Username that must be used to access the Commvault Cloud account.	properties
libraryId	The unique identifier assigned to the cloud library.	properties
libraryName	The name of the cloud library.	properties
userPassword userName	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
active_start_time	The start time of the schedule specified in seconds.	properties
freq_interval	Valid value is 23.	properties
freq_recurrence_factor	Valid value is 86.	properties

Examples

Sample Request

GET <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

Sample Response

<Api_GetDRBackupPropertiesResp>
<properties DRDumpLocation="\\MyNetworkLocation\Share" UseLocalDrive="0" isUserAccountEnabled="1" UseNetworkShare="1" DRNumFulls="20" uploadBackupMetadataToCloud="1" uploadBackupMetadataToCloudLib="1">
<cloudCredentials userName="abcd" />
<cloudLibrary libraryName="Google Cloud Lib" libraryId="3"/>
<userPassword userName="MyName" /><pattern freq_type="4" active_start_time="55440000" freq_interval="23" freq_recurrence_factor="86" />
</properties>
</Api_GetDRBackupPropertiesResp>