REST API - PUT DR Groups

This operation updates the properties associated with a Disaster Recovery (DR) group.

Request

Syntax

PUT <webservice>/DRGroups/{drGroupId} HTTP/1.1

Host: <host name>

Accept: {application/xml | application/json}

Authtoken: <authentication token>

Content-type: application/xml

<update_dr_groups.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 Parameters

Name	Description	Required
DRGroupId	The DR group ID for the DR group. If the DR group ID is not known, use the GET DR Group API to retrieve it from the vAppId parameter.	Yes

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_dr_groups.xml file required for this request. The following table displays the parameters for the request body.

Name	Description	Elements
Parameter	Description and Parameter Values	Element
action	Valid value is 1.	Api_VirtualAppReq
description	Description of the DR Group.	vApp
source	Valid values are: 0, for Backup 1, for Replication 2, for Templates	vApp
isClientGroup	Valid values are True/False.	vApp
operationType	Valid values are: 1, for LiveMount 2, for LiveSync 16, for Failover 32, for VirtualLab	vApp
instanceId	The system-generated ID assigned to the instance.	selectedEntities
clientId	The system-generated ID assigned to the client.	selectedEntities
entityName	The name of the entity.	selectedEntities
entityId	The ID of the entity.	selectedEntities
type	The type of workflow.	workflow
workflowId	The system-generated ID assigned to the workflow.	workflow
timeThresholdBeforeFailover	The time to wait in minutes before auto failover process is kicked-off.	autofailover
status	The status of auto failover. Valid values are: 0, for Monitoring Disabled. 1, for Monitoring Failed. 2, for Monitoring Enabled. 3, for Monitoring Paused. 4, for Offline. 5, for Online. 6, for Monitoring Starting. 7, for Not Configured	autofailover
vAppId	The ID of the vApp.	vAppEntity
vAppName	The name of the vApp.	vAppEntity
clientName	The name of the client.	clientList
backupsetId	The ID for the backupset.	clientList
clientId	The system-generated ID assigned to the client.	clientList
GUID	The globally unique identifier for the virtualization client.	clientList
backupsetName	The name of the backupset.	clientList
entityId	The ID of the entity.	clientList
delay	The time (in minutes) between detecting an outage and failing over.	vmGroups
groupId	The group ID for the VM..	vmGroups
continueOnFailure	The option to continue powering on VMs according to priority settings after VM fails to power on. Valid values are True/False.	vmGroups
copyPrecedence	The copy that takes precedence for failover. Valid values are 0/1.	vmSequence
replicationId	The ID for the replication set.	vmSequence
vmName	Name of the VM.	vmSequence
vmGUID	GUID of the VM.	vmInfo

Response

Parameter

Description

Element

errorCode

The possible error codes.

Valid values are:

0, successful completion.
a specific error code.

TMMsg_GenericResp

errorMessage

The description of the error code. Not all error codes have an error message.

TMMsg_GenericResp

Examples

Sample Request

PUT <webservice>//DRGroups/10 HTTP/1.1

 Host: client1.mydomain.com

 Accept: application/json

 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6

 0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f

 8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f

 40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7

 68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323

 3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

 Content-type: application/xml

 <Api_VirtualAppReq action="1">  

   <vApp description="" source="1" isClientGroup="0" operationType="16">  

     <selectedEntities instanceId="4" clientId="7" entityName="test.company.com" entityId="7" />  

     <workflow type="7">  

       <entity workflowId="49" />  

     </workflow>  

     <workflow type="1">  

       <entity workflowId="50" />  

     </workflow>  

     <autofailover timeThresholdBeforeFailover="2" status="7" />  

     <vAppEntity vAppId="14" vAppName="TestNotAfterBackup" />  

     <clientList clientName="FGVM2" backupsetId="59" clientId="262" GUID="50390ba9-721b-00ab-563d-93c28017c3gh" backupsetName="TestFailoverSarath" entityId="19" />  

     <clientList clientName="FGVM1" backupsetId="59" clientId="330" GUID="50394cfc-00b5-c98b-96a9-8cda9543af59" backupsetName="TestFailover" entityId="20" />  

     <config>  

       <vmGroups delay="10" groupId="1" continueOnFailure="1">  

         <vmSequence copyPrecedence="0" replicationId="19">  

           <vmInfo vmName="FGVM2" vmGUID="50390ba9-721b-00ab-563d-93c28017c3ij" />  

         </vmSequence>  

       </vmGroups>  

       <vmGroups delay="1" groupId="2" continueOnFailure="1">  

         <vmSequence copyPrecedence="0" replicationId="20">  

           <vmInfo vmName="FGVM1" vmGUID="50394cfc-00b5-c98b-96a9-8cda9543af69" />  

         </vmSequence>  

       </vmGroups>  

     </config>  

   </vApp>  

 </Api_VirtualAppReq>

Sample Response

JSON

{

 "resp":{

 "errorMessage":"","errorCode":0

 },"entity":{

 "vAppId":14,"vAppName":"TestNotAfterBackup"

 }

 }

XML

<Api_VirtualAppResp>

 <resp errorMessage="" errorCode="0" />

 <entity vAppId="14" vAppName="TestNotAfterBackup" />

 </Api_VirtualAppResp>