This operation returns the schedules associated with a Disaster Recovery (DR) Orchestration group.
Request
Syntax
GET <webservice>/DRGroups/{DRGroupId}/Schedules?drType={DRTYPE} 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 orchestration group ID for the DR group. If the DR orchestration group ID is not known, use the GET DR Group API to retrieve it from the vAppId parameter. |
Yes |
|
drType |
The type of DR schedule. Valid values:
|
No |
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 |
|---|---|---|
|
GUID |
The globally unique identifier for the task. |
task |
|
alertId |
The system-generated ID assigned to the alert. |
task |
|
ownerId |
An internal reference number for the user who created the schedule. |
task |
|
ownerName |
The name of the user who created the schedule. |
task |
|
policyType |
task |
|
|
runUserId |
task |
|
|
taskId |
The system-generated ID assigned to the schedule. |
task |
|
taskType |
The type of task. Valid value is 2. |
task |
|
commCellId |
The CommCell ID of the CommServe. Valid value is 2. |
originalCC |
|
disabled |
The option to disable the schedule. Valid values are 1/0. |
taskFlags |
|
isEZOperation |
Valid values are 1/0. |
taskFlags |
|
isEdgeDrive |
taskFlags |
|
|
uninstalled |
Indicates whether the client associated with the schedule is uninstalled. Valid values are 1/0. |
taskFlags |
|
commCellId |
The CommCell ID of the CommServe. Valid value is 2. |
originalCC |
|
<pattern> attributes |
For information about the pattern attributes, see REST API - GET Schedule Properties. |
subTasks |
|
vAppId |
The ID of the vApp. |
vAppEntity |
|
vAppName |
The name of the vApp. |
vAppEntity |
|
initiatedfromMonitor |
Valid value is 0. |
drOrchestrationOption |
|
operationType |
The type of DR schedule. Valid values:
|
drOrchestrationOption |
|
val |
The Live Sync ID. |
replicationId |
|
vAppId |
The ID of the vApp. |
vApp |
|
vAppName |
The name of the vApp. |
vApp |
|
skipDisableNetworkAdapter |
Valid value is 0. |
advancedOptions |
Examples
Sample Request
GET <webservice>/DRGroups/3/Schedules?drType=1 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Sample Response
XML
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<TMMsg_GetTaskListResp> <taskDetail taskOperation="1"> <task GUID="fc7cba77-1f16-473a-942c-80314b8ab694" alertId="0" ownerId="1" ownerName="admin" policyType="0" runUserId="1" taskId="113" taskType="2"> <taskFlags disabled="0" isEZOperation="0" isEdgeDrive="0" uninstalled="0"/> <originalCC commCellId="2"/> <task taskId="113"/> </task> <appGroup/> <associations _type_="0" agentlessPolicyId="0" appName="Default Application Type Name" applicationId="0" backupsetId="0" clientGroupId="0" clientId="0" copyId="0" instanceId="0" mediaAgentId="0" sidbStoreId="0" sidbStoreName="N/A" srmReportSet="0" srmTemplateId="0" storagePolicyId="0" subclientId="0" workflowId="0"> <flags exclude="0"/> </associations> <subTasks relativeTime="37986" subTaskOperation="1"> <subTask flags="0" operationType="4046" subTaskId="115" subTaskName="8hr schedule AzureGroup Planned Failover" subTaskOrder="0" subTaskType="1"/> <pattern active_end_occurence="0" active_end_time="86340" active_start_date="1517788800" active_start_time="75600" description="Admin Console schedule pattern 2018-02-05 15.39.41.533" flags="0" freq_interval="1" freq_recurrence_factor="1" freq_relative_interval="0" freq_restart_interval="0" freq_subday_interval="28800" freq_type="4" name="8hr schedule AzureGroup Planned Failover" patternId="29" skipDayNumber="0" skipOccurence="0"> <timeZone TimeZoneID="1000"/> <calendar calendarId="1"/> </pattern> <options> <adminOpts> <vmProvisioningOption operationType="37"> <vAppEntity vAppId="5" vAppName="AzureGroup"/> </vmProvisioningOption> <drOrchestrationOption initiatedfromMonitor="0" operationType="1"> <replicationInfo> <replicationId val="7"/> <replicationId val="8"/> </replicationInfo> <vApp vAppId="5" vAppName="AzureGroup"/> <advancedOptions skipDisableNetworkAdapter="0"/> </drOrchestrationOption> </adminOpts> </options> </subTasks> </taskDetail>
</TMMsg_GetTaskListResp>
JSON
{ "taskDetail": { "taskOperation": "1", "task": { "GUID": "fc7cba77-1f16-473a-942c-80314b8ab694", "alertId": "0", "ownerId": "1", "ownerName": "admin", "policyType": "0", "runUserId": "1", "taskId": "113", "taskType": "2", "taskFlags": { "disabled": "0", "isEZOperation": "0", "isEdgeDrive": "0", "uninstalled": "0" }, "originalCC": { "commCellId": "2" }, "task": { "taskId": "113" } }, "appGroup": [], "associations": { "_type_": "0", "agentlessPolicyId": "0", "appName": "Default Application Type Name", "applicationId": "0", "backupsetId": "0", "clientGroupId": "0", "clientId": "0", "copyId": "0", "instanceId": "0", "mediaAgentId": "0", "sidbStoreId": "0", "sidbStoreName": "N/A", "srmReportSet": "0", "srmTemplateId": "0", "storagePolicyId": "0", "subclientId": "0", "workflowId": "0", "flags": { "exclude": "0" } }, "subTasks": { "relativeTime": "37986", "subTaskOperation": "1", "subTask": { "flags": "0", "operationType": "4046", "subTaskId": "115", "subTaskName": "8hr schedule AzureGroup Planned Failover", "subTaskOrder": "0", "subTaskType": "1" }, "pattern": { "active_end_occurence": "0", "active_end_time": "86340", "active_start_date": "1517788800", "active_start_time": "75600", "description": "Admin Console schedule pattern 2018-02-05 15.39.41.533", "flags": "0", "freq_interval": "1", "freq_recurrence_factor": "1", "freq_relative_interval": "0", "freq_restart_interval": "0", "freq_subday_interval": "28800", "freq_type": "4", "name": "8hr schedule AzureGroup Planned Failover", "patternId": "29", "skipDayNumber": "0", "skipOccurence": "0", "timeZone": { "TimeZoneID": "1000" }, "calendar": { "calendarId": "1" } }, "options": { "adminOpts": { "vmProvisioningOption": { "operationType": "37", "vAppEntity": { "vAppId": "5", "vAppName": "AzureGroup" } }, "drOrchestrationOption": { "initiatedfromMonitor": "0", "operationType": "1", "replicationInfo": [ { "val": "7" }, { "val": "8" } ], "vApp": { "vAppId": "5", "vAppName": "AzureGroup" }, "advancedOptions": { "skipDisableNetworkAdapter": "0" } } } } } }
}
