This operation returns the properties associated with a Disaster Recovery (DR) group.
Request
Syntax
GET <webservice>/DRGroups/{DRGroupId} HTTP/1.1
Host: <host name>
Accept: {application/xml | application/json}
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 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. |
Response
Response Parameters
Name | Description | Elements |
description | The description of the DR group. | vApp |
source | Valid values are:
| vApp |
isClientGroup | Valid values are True/False | vApp |
operationType | Valid values are:
| vApp |
intanceId | 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 |
_type_ | The type of entity. XML valid values are:
| selectedEntities |
entityId | The ID of the entity. | selectedEntities |
type | The type of workflow that is being executed on the DR Group. | workflow |
workflowId | The system-generated ID assigned to the workflow. | entity |
timeThresholdBeforeFailover | Time to wait in minutes before auto failover process is kicked-off. | autofailover |
status | The status of auto failover. Valid values are:
| autofailover |
isMaster | Valid values are True/False. | machine |
isSource | Valid values are True/False. | machine |
locationType | The type of location. | machine |
status | The status of the machine. | machine |
portType | Type of port. | port |
clientId | The system-generated ID assigned to the client. | client |
clientName | The name of the client. | client |
_type_ | The type of entity. Valid value is 3, for client. | client |
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 backup set. | clientList |
_type_ | The type of entity. Valid value is 3, for client. | clientList |
entityId | The ID of the entity. | clientList |
delay | The time (in minutes) between detecting an outage and failing over. | vmGroups |
groupId | VM group ID | vmGroups |
continueOnFailure | 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 of the replication set. | vmSequence |
vmName | Name of the VM. | vmInfo |
vmGUID | GUID of the VM. | vmInfo |
Examples
Sample Request
GET <webservice>/DRGroups/3 HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8Sample Response
JSON
{
"vApp": [{
"description": "",
"source": 1,
"isClientGroup": false,
"operationType": 16,
"selectedEntities": [{
"instanceId": 4,
"clientId": 7,
"entityName": "test.company.com",
"_type_": 3,
"entityId": 7
}],
"workflow": [{
"type": 7,
"entity": {
"workflowId": 49
}
}, {
"type": 1,
"entity": {
"workflowId": 50
}
}],
"autofailover": {
"timeThresholdBeforeFailover": 2,
"status": 6,
"machine": [{
"isMaster": false,
"isSource": true,
"locationType": 0,
"status": 5,
"port": [{
"portType": 0,
"port": 2888
}, {
"portType": 1,
"port": 3888
}, {
"portType": 2,
"port": 2181
}],
"client": {
"clientId": 306,
"clientName": "autoproxy2sp9",
"_type_": 3
}
}, {
"isMaster": false,
"isSource": true,
"locationType": 0,
"status": 5,
"port": [{
"portType": 0,
"port": 2888
}, {
"portType": 1,
"port": 3888
}, {
"portType": 2,
"port": 2181
}],
"client": {
"clientId": 318,
"clientName": "autoproxy3sp9",
"_type_": 3
}
}, {
"isMaster": false,
"isSource": true,
"locationType": 0,
"status": 5,
"port": [{
"portType": 0,
"port": 2888
}, {
"portType": 1,
"port": 3888
}, {
"portType": 2,
"port": 2181
}],
"client": {
"clientId": 307,
"clientName": "autoproxy4sp9",
"_type_": 3
}
}, {
"isMaster": false,
"isSource": true,
"locationType": 0,
"status": 5,
"port": [{
"portType": 0,
"port": 2888
}, {
"portType": 1,
"port": 3888
}, {
"portType": 2,
"port": 2181
}],
"client": {
"clientId": 325,
"clientName": "autoproxy5sp9",
"_type_": 3
}
}, {
"isMaster": false,
"isSource": true,
"locationType": 0,
"status": 5,
"port": [{
"portType": 0,
"port": 2888
}, {
"portType": 1,
"port": 3888
}, {
"portType": 2,
"port": 2181
}],
"client": {
"clientId": 320,
"clientName": "autoproxy6sp9",
"_type_": 3
}
}]
},
"vAppEntity": {
"vAppId": 11,
"vAppName": "TestAuto"
},
"clientList": [{
"clientName": "HMLS1",
"backupsetId": 58,
"clientId": 16,
"GUID": "50395fb9-f7d8-8b40-a494-f19526c5b74a",
"backupsetName": "FailoverGroupsTest",
"_type_": 3,
"entityId": 12
}, {
"clientName": "HMLS2",
"backupsetId": 58,
"clientId": 17,
"GUID": "503917a4-1433-f116-5807-96a9dd87b01d",
"backupsetName": "FailoverGroupsTest",
"_type_": 3,
"entityId": 10
}, {
"clientName": "HMLS3",
"backupsetId": 58,
"clientId": 28,
"GUID": "5039b587-6435-16e5-064c-ca2f4e88efaf",
"backupsetName": "FailoverGroupsTest",
"_type_": 3,
"entityId": 13
}, {
"clientName": "HMLS4",
"backupsetId": 58,
"clientId": 329,
"GUID": "50395f36-a36e-c1cd-282b-6656818ad206",
"backupsetName": "FailoverGroupsTest",
"_type_": 3,
"entityId": 11
}],
"config": {
"vmGroups": [{
"delay": 2,
"groupId": 1,
"continueOnFailure": true,
"vmSequence": [{
"copyPrecedence": 0,
"replicationId": 10,
"vmInfo": {
"vmName": "HMLS2",
"vmGUID": "503917a4-1433-f116-5807-96a9dd87b01d"
}
}, {
"copyPrecedence": 0,
"replicationId": 12,
"vmInfo": {
"vmName": "HMLS1",
"vmGUID": "50395fb9-f7d8-8b40-a494-f19526c5b74a"
}
}, {
"copyPrecedence": 0,
"replicationId": 11,
"vmInfo": {
"vmName": "HMLS4",
"vmGUID": "50395f36-a36e-c1cd-282b-6656818ad206"
}
}, {
"copyPrecedence": 0,
"replicationId": 13,
"vmInfo": {
"vmName": "HMLS3",
"vmGUID": "5039b587-6435-16e5-064c-ca2f4e88efaf"
}
}]
}]
}
}]
}XML
<Api_GetVirtualAppResp>
<vApp description="" source="1" isClientGroup="0" operationType="16">
<selectedEntities instanceId="4" clientId="7" entityName="test.company.com" _type_="3" entityId="7" />
<workflow type="7">
<entity workflowId="49" />
</workflow>
<workflow type="1">
<entity workflowId="50" />
</workflow>
<autofailover timeThresholdBeforeFailover="2" status="6">
<machine isMaster="0" isSource="1" locationType="0" status="5">
<port portType="0" port="2888" />
<port portType="1" port="3888" />
<port portType="2" port="2181" />
<client clientId="306" clientName="autoproxy2sp9" _type_="3" />
</machine>
<machine isMaster="0" isSource="1" locationType="0" status="5">
<port portType="0" port="2888" />
<port portType="1" port="3888" />
<port portType="2" port="2181" />
<client clientId="318" clientName="autoproxy3sp9" _type_="3" />
</machine>
<machine isMaster="0" isSource="1" locationType="0" status="5">
<port portType="0" port="2888" />
<port portType="1" port="3888" />
<port portType="2" port="2181" />
<client clientId="307" clientName="autoproxy4sp9" _type_="3" />
</machine>
<machine isMaster="0" isSource="1" locationType="0" status="5">
<port portType="0" port="2888" />
<port portType="1" port="3888" />
<port portType="2" port="2181" />
<client clientId="325" clientName="autoproxy5sp9" _type_="3" />
</machine>
<machine isMaster="0" isSource="1" locationType="0" status="5">
<port portType="0" port="2888" />
<port portType="1" port="3888" />
<port portType="2" port="2181" />
<client clientId="320" clientName="autoproxy6sp9" _type_="3" />
</machine>
</autofailover>
<vAppEntity vAppId="11" vAppName="TestAuto" />
<clientList clientName="HMLS1" backupsetId="58" clientId="16" GUID="50395fb9-f7d8-8b40-a494-f19526c5b35a" backupsetName="FailoverGroupsTest" _type_="3" entityId="12" />
<clientList clientName="HMLS2" backupsetId="58" clientId="17" GUID="503917a4-1433-f116-5807-96a9dd87b02d" backupsetName="FailoverGroupsTest" _type_="3" entityId="10" />
<clientList clientName="HMLS3" backupsetId="58" clientId="28" GUID="5039b587-6435-16e5-064c-ca2f4e88ecac" backupsetName="FailoverGroupsTest" _type_="3" entityId="13" />
<clientList clientName="HMLS4" backupsetId="58" clientId="329" GUID="50395f36-a36e-c1cd-282b-6656818ad109" backupsetName="FailoverGroupsTest" _type_="3" entityId="11" />
<config>
<vmGroups delay="2" groupId="1" continueOnFailure="1">
<vmSequence copyPrecedence="0" replicationId="10">
<vmInfo vmName="HMLS2" vmGUID="503917a4-1433-f116-5807-96a9dd87b02d" />
</vmSequence>
<vmSequence copyPrecedence="0" replicationId="12">
<vmInfo vmName="HMLS1" vmGUID="50395fb9-f7d8-8b40-a494-f19526c5b35a" />
</vmSequence>
<vmSequence copyPrecedence="0" replicationId="11">
<vmInfo vmName="HMLS4" vmGUID="50395f36-a36e-c1cd-282b-6656818ad109" />
</vmSequence>
<vmSequence copyPrecedence="0" replicationId="13">
<vmInfo vmName="HMLS3" vmGUID="5039b587-6435-16e5-064c-ca2f4e88ecac" />
</vmSequence>
</vmGroups>
</config>
</vApp>
</Api_GetVirtualAppResp>