Zerto Virtual Replication APIs : Tasks API : Format
  
Format
Json, XML
Request Format
The request body is empty.
Json Response Format
The following is an example response Json body for https://zvm_ip:port/v1/tasks and for https://zvm_ip:port/v1/tasks/{taskidentifier}
[{
  "CompleteReason": "String content",
  "Completed":"\/Date(928142400000+0300)\/",
  "InitiatedBy": "String content",
  "IsCancellable": Boolean,
  "Link": {
    "href": "String content",
    "identifier": "String content",
    "rel": "String content",
    "type": "String content"
  },
  "RelatedEntities": {
    "Hosts":[{
      "href": "String content",
      "identifier": "String content",
      "rel": "String content",
      "type": "String content"
    }],
    "Sites":[{
      "href": "String content",
      "identifier": "String content",
      "rel": "String content",
      "type": "String content"
    }],
    "Vpgs":[{
      "href": "String content",
      "identifier": "String content",
      "rel": "String content",
      "type": "String content"
    }]
    "FlrSessions":[{
      "href": "String content",
      "identifier": "String content",
      "rel": "String content",
      "type": "String content"
    }]
  },
  "Started":"\/Date(928142400000+0300)\/",
  "Status": {
    "Progress":2147483647,
    "State":0
  },
  "TaskIdentifier": "String content",
  "Type": "String content"
}]
XML Response Format
For the XML response format, see “Tasks API XML Response Format”, on page 233.
Response Values
Response values for https://zvm_ip:port/v1/tasks and for https://zvm_ip:port/v1/task/{taskidentifier}.
Parameter
Description
CompleteReason
The reason the task completed.
Completed
The date the task completed. The value can be converted to an understandable date using code similar to the following:
var date = new Date(jsonDate);
or code similar to the Perl code example, jsonDateToString($), in Perl Code Example: Retrieving the First 100 Records.
InitiatedBy
The name of the user who initiated the task.
IsCancellable
True: The task can be canceled via user intervention.
False: The task cannot be canceled via user intervention.
Link
The link details.
href
The URL used.
identifier
The unique identifier of the task.
rel
The next path level for the API relative to the current path.
type
The API interface service.
RelatedEntities
Entities possibly affected by the event.
Hosts
The hosts affected by the task.
href
The URL used to retrieve host information for each host affected by the event.
identifier
The unique internal identifier of the host where the API runs.
rel
The next path level for the API relative to the current path.
type
The API interface service.
Sites
The sites affected by the task.
href
The URL used to retrieve site information: peersites and localsite APIs.
identifier
The unique internal identifier of the site where the API runs.
rel
The next path level for the API relative to the current path.
type
The API interface service.
Vpgs
The VPGs affected by the task.
href
The URL used to retrieve VPG information for each VPG affected by the event.
identifier
The unique internal identifier of the VPG.
rel
The next path level for the API relative to the current path.
type
The API interface service.
FlrSessions
The file level restore sessions affected by the task.
href
The URL used to retrieve file level restore session information for each session affected by the event.
identifier
The unique internal identifier of the file level restore session.
rel
The next path level for the API relative to the current path.
type
The API interface service.
Started
The date the task started. The value can be converted to an understandable date using code similar to the following:
var date = new Date(jsonDate);
or code similar to the Perl code example, jsonDateToString($), in Perl Code Example: Retrieving the First 100 Records.
Status
The status of the task.
Progress
The progress of the task.
State
The state of the task. Possible values are (Json/XML):
0/FirstUnusedValue
1/InProgress
2/WaitingForUserInput
3/Paused
4/Failed
5/Stopped
6/Completed
7/Cancelling
TaskIdentifier
The unique identifier of the task.
Type
The type of task:
0/CreateProtectionGroup
1/RemoveProtectionGroup
2/FailOver
3/FailOverTest
4/StopFailOverTest
5/Move
6/GetCheckpointList
7/ProtectVM
8/UnprotectVM
9/AddVMToProtectionGroup
10/RemoveVMFromProtectionGroup
 
11/InstallVra
12/UninstallVra
13/GetVMSettings
14/UpdateProtectionGroup
15/InsertTaggedCP
16/WaitForCP
17/HandleMirrorPromotion
18/ActivateAllMirrors
19/LogCollection
20/ClearCheckpoints
21/ForceReconfigurationOfNewVM
22/ClearSite
23/ForceRemoveProtectionGroup
24/ForceUpdateProtectionGroup
25/ForceKillProtectionGroup
 
26/PrePostScript
27/InitFullSync
28/Pair
29/Unpair
30/AddPeerVraInfo
31/RemovePeerVraInfo
32/InstallCloudConnector
33/UninstallCloudConnector
34/HandleFirstSyncDone
 
35/Clone
36/MoveBeforeCommit
37/MoveRollback
38/MoveCommit
39/UpgradeVRA
40/MaintainHost
41/NotSupportedInThisVersion
42/MoveProtectionGroupToManualOperationNeeded
 
43/FailoverBeforeCommit
44/FailoverCommit
45/FailoverRollback
46/ChangeVraIpSettings
47/PauseProtectionGroup
48/ResumeProtectionGroup
49/BulkUpgradeVras
50/BulkUninstallVras
51/ChangeVraPassword
52/ChangeRecoveryHost
53/ChangeRecoveryHostForProtectionGroup
 
54/VpgBackup
55/RedeployCloudConnector
56/RestoreVpg
57/VpgDeleteBackup
58/SubmitSupportTicket
59/PreScript
60/PostScript
61/ChangeVraPasswordIpSettings
62/FlrJournalMount
63/FlrJournalUnmount
Response values for https://zvm_ip:port/v1/tasks/types.
Response: Description
Task types:
CreateProtectionGroup
RemoveProtectionGroup
FailOver
FailOverTest
StopFailOverTest
Move
GetCheckpointList
ProtectVM
UnprotectVM
AddVMToProtectionGroup
RemoveVMFromProtectionGroup
InstallVra
UninstallVra
GetVMSettings
UpdateProtectionGroup
InsertTaggedCP
WaitForCP
HandleMirrorPromotion
ActivateAllMirrors
LogCollection
ClearCheckpoints
ForceReconfigurationOfNewVM
ClearSite
ForceRemoveProtectionGroup
ForceUpdateProtectionGroup
ForceKillProtectionGroup
PrePostScript
InitFullSync
Pair
Unpair
AddPeerVraInfo
RemovePeerVraInfo
InstallCloudConnector
UninstallCloudConnector
HandleFirstSyncDone
Clone
MoveBeforeCommit
MoveRollback
MoveCommit
UpgradeVra
MaintainHost
NotSupportedInThisVersion
MoveProtectionGroupToManualOperationNeeded
FailoverBeforeCommit
FailoverCommit
FailoverRollback
ChangeVraIpSettings
PauseProtectionGroup
ResumeProtectionGroup
BulkUpgradeVras
BulkUninstallVras
ChangeVraPassword
ChangeRecoveryHost
ChangeRecoveryHostForProtectionGroup
VpgBackup
RedeployCloudConnector
RestoreVpg
VpgDeleteBackup
SubmitSupportTicket
PreScript
PostScript
ChangeVraPasswordIpSettings
FlrJournalMount
FlrJournalUnmount