Recovery Report API
Important: This document is being phased out and does not contain up-to-date information. For updated API documentation for Zerto versions 9.5 and later, see ZVM REST API - Swagger.
You can also access Swagger from the ZVM: click the menu button (
) on the top right and select APIs or navigate to https://<ZVM IP>:9669/swagger/index.html in a Windows ZVM or https://<ZVM IP>/management/api/swagger/index.html in ZVM Appliance.
Use this API to retrieve information about recovery operations such as failover, failover tests and move. The information for each machine includes the steps taken during the operation, such as creating a machine and scratch volumes for testing, when each process began and ended, and whether the operation succeeded or not.
Recovery Reports are always kept, and never deleted.
Note: When failover test is still in progress, the end time in the Recovery Report appears as NA.
Generate a Recovery Report
Generate a recovery report and view information about recovery operations, such as failover, failover tests and moves.
The report displays information by VPG, and then by virtual machine within the VPG.
| Method | URL |
| GET | https://zvm_ip:port/v1/reports/recovery |
Where:
| zvm_ip | The IP address of the Zerto Virtual Manager where the API is run. |
| port | The port to access the Zerto Virtual Manager. The default port is 9669. |
| Filtering | https://zvm_ip:port/v1/reports/recovery?startTime={startTime}&endTime={endTime}&pageNumber={pageNumber}&pageSize={pageSize}&vpgIdentifier={vpgIdentifier}&vpgName={vpgName}&recoveryType={recoveryType}&state={state} |
Filters
Any combination of filters is valid. Filters are not case-sensitive.
Filtering
| Filter | Description | Mandatory | Default |
| startTime | Operations performed between the specified start Time and end Time (inclusive) are displayed. The time is set to UTC with the following possible formats: yyyy-MM-ddTHH:mm:ss.fffZ" yyyy-MM-ddTHH:mm:ssZ yyyy-MM-ddTHH:mmZ yyyy-MM-ddTHHZ yyyy-MM-dd yyyy-MM yyyy |
No | If none specified, generate the earliest time available. |
| endTime | No | If none specified, generate the latest time available. | |
| pageNumber | The page number the user wants to retrieve. Minimum value is 1. |
No | 1 |
| pageSize | The number of reports to display in a single page. The maximum number of reports per page is 1000. |
No | 1000 |
| vpgIdentifier | The internal identifier of the VPG. You can specify more than one VPG, separated by commas. |
No | All available VPGs that match the selected period of time. |
| vpgName | The name of the VPG. You can specify more than one VPG, separated by commas. |
No | |
| recoveryType | The type of recovery operations. Possible values are: Failover Failover Test Move |
No | All recovery operations. |
| state | Whether the recovery operation has completed. | No |
|
Response In Json Format
The following is an example response Json body for https://zvm_ip:port/v1/reports/recovery.
{
"General": {
"EndTime": "2018-11-06T14:17:59.637Z",
"InitiatedBy": "string content",
"Notes": "",
"PointInTime": "2018-11-06T14:18:01.000Z",
"ProtectedSiteName": "string content",
"RTOInSeconds": "78.5313997",
"RecoverySiteName": "string content",
"RecoveryType": "Move",
"StartTime": "2018-11-06T14:17:48.000Z",
"Status": "Success",
"VpgIdentifier": "string content",
"VpgName": "string content"
}
"RecoveryOperationIdentifier": "string content",
"RecoverySetting": {
"Steps": [
{
"Description": "Shutdown protected VMs",
"EndTime": "2018-11-06T14:17:59.637Z",
"ExecutionTime": "00:00:01.6250079",
"Result": "Success",
"StartTime": "2018-11-06T14:17:58.012Z"
},
{
"Description": "Recover VM 'deb(1)",
"EndTime": "2018-11-06T14:18:13.716Z",
"ExecutionTime": "00:00:04.3437576",
"Result": "Success",
"StartTime": "2018-11-06T14:18:09.372Z"
},
{
"Description": "disable DRS",
"EndTime": "2018-11-06T14:18:14.044Z",
"ExecutionTime": "00:00:00.2813752",
"Result": "Success",
"StartTime": "2018-11-06T14:18:13.762Z"
},
{
"Description": "Recover VMs' 'deb(1)' volumes",
"EndTime": "2018-11-06T14:19:01.466Z",
"ExecutionTime": "00:00:47.3595136",
"Result": "Success",
"StartTime": "2018-11-06T14:18:14.106Z"
},
{
"Description": "Start VMs",
"EndTime": "2018-11-06T14:19:06.919Z",
"ExecutionTime": "00:00:05.0156373",
"Result": "Success",
"StartTime": "2018-11-06T14:19:01.903Z"
}
],
"Vms": [
{
"DatastoreName": "string content",
"FolderName": "/",
"HostName": "string content",
"VmName": "string content",
"Volumes": [
{
"DatastoreName: "string content",
"VolumeName": "stringcontent"
}
]
}
],
"Vpg": {
"DefaultDatastoreName": "string content",
"DefaultHostName": "string content",
"DefaultNetworkName": "string content"
}
]
Response Values
Response values for https://zvm_ip:port/v1/reports/recovery.
| Parameter | Description | |||||||||
| General | ||||||||||
|
EndTime |
The time the recovery operation ended. The time is in the format yyyy-mm-ddThh:mm:ss.fffZ, set to UTC. |
|||||||||
|
InitiatedBy |
The name of the user who initiated the operation. | |||||||||
|
Notes |
Comments the user added regarding the operation. | |||||||||
|
PointInTime |
The Point in time value takes the checkpoint UTC time, which was created in the protected site, and converts it to the recovery site time zone. | |||||||||
|
ProtectedSiteName |
The name of the protected site where the virtual machines are protected. | |||||||||
|
RTOInSeconds |
The recovery time objective in seconds. | |||||||||
|
RecoverySiteName |
The name of the recovery site where the virtual machines are recovered. | |||||||||
|
RecoveryType |
The type of recovery operation. Possible values are:
|
|||||||||
|
StartTime |
The time the recovery operation started. The time is in the format yyyy-mm-ddThh:mm:ss.fffZ, set to UTC. |
|||||||||
|
Status |
Operation status. Possible values are: Unknown Succeed Failed PassedByUser FailedByUser |
|||||||||
|
VpgIdentifier |
The identifier of the VPG. | |||||||||
|
VpgName |
The name of the VPG. | |||||||||
| RecoveryOperationIdentifier | The identifier of the recovery operation. | |||||||||
| RecoverySettings | ||||||||||
|
Steps |
The tasks that a specific recovery operation runs. | |||||||||
|
Descriptions |
The description of the task. | |||||||||
|
EndTime |
The time the recovery operation task ends. | |||||||||
|
ExecutionTime |
The duration of the task. | |||||||||
|
Result |
The result of the task. Possible values are: Success Failure |
|||||||||
|
StartTime |
The time the recovery operation task starts. | |||||||||
| Vms | ||||||||||
|
DatastoreName |
The name of the datastore that is used for the recovered virtual machines. | |||||||||
|
FolderName |
The name of the folder that is used for the recovered virtual machines. | |||||||||
|
HostName |
The name of the cluster, resource pool or host in the recovery site that handles the replicated data. | |||||||||
|
NetworkName |
The name of the network used for failover or move by the virtual machines. | |||||||||
|
VmName |
The name of the virtual machine. | |||||||||
|
Volumes |
||||||||||
|
DatastoreName |
The name of the datastore where the disk is stored. | |||||||||
|
VolumeName |
The name of the volume. | |||||||||
| Vpg | ||||||||||
|
DefaultDatastoreName |
The name of the default datastore that is used for the recovered virtual machines. | |||||||||
|
DefaultHostName |
The name of the default cluster, resource pool or host in the recovery site that handles the replicated data. | |||||||||
|
DefaultNetworkName |
The name of the default network used for failover or move by the virtual machines. | |||||||||