Zerto Virtual Replication APIs : VMs that are Protected API
  
VMs that are Protected API
/v1/vms returns information about all VMs protected on the site processing the API.
URI
All VMs
https://zvm_ip:port/v1/vms
Filtered VMs
https://zvm_ip:port/v1/vms?vpgName={VPGNAME}&vmName={VMNAME}&status={STATUS}&substatus={SUBSTATUS}&sourceType={SOURCETYPE}&targetType={TARGETTYPE}&sourceSite={SOURCESITE}&targetSite={TARGETSITE}&organizationName={ORGNAME}&priority={PRIORITY}
Single VM
https://zvm_ip:port/v1/vms/{vmId}
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.
vmId
The identifier of the virtual machine for which information is returned. The identifier comprises the server identifier and the virtual machine moref, with the format, serverid.moref.
Filters
Filters are optional and any combination of filters is valid. When no filter is specified, all virtual machines are returned. Filters are not case-sensitive.
 
Filter
Description
 
vpgName
The name of the VPG which protects the virtual machine.
 
vmName
The name of the virtual machine.
 
status
The status of the VPG. Possible values are:
0 or Initializing– The VPG is being initialized. This includes when a VPG is created, and during the initial sync between sites.
1 or MeetingSLA – The VPG is meeting the SLA specification.
2 or NotMeetingSLA – The VPG is not meeting the SLA specification for both the journal history and RPO SLA settings.
3 or HistoryNotMeetingSLA – The VPG is not meeting the SLA specification for the journal history.
4 or RpoNotMeetingSLA – The VPG is not meeting the SLA specification for the RPO SLA setting.
5 or FailingOver – The VPG is in a Failover operation.
6 or Moving – The VPG is in a Move operation.
7 or Deleting – The VPG is being deleted.
8 or Recovered – The VPG has been recovered.
 
substatus
The substatus of the VPG, for example the VPG is in a bitmap sync. For the description of substatuses, refer to the Zerto Virtual Manager Administration Guide. Possible values are:
0 or None
1 or InitialSync
2 or Creating
3 or VolumeInitialSync
4 or Sync
5 or RecoveryPossible
6 or DeltaSync
7 or NeedsConfiguration
8 or Error
9 or EmptyProtectionGroup
 
 
10 or DisconnectedFromPeerNoRecoveryPoints
11 or FullSync
12 or VolumeDeltaSync
13 or VolumeFullSync
14 or FailingOverCommitting
15 or FailingOverBeforeCommit
16 or FailingOverRollingBack
17 or Promoting
18 or MovingCommitting
19 or MovingBeforeCommit
 
 
20 or MovingRollingBack
21 or Deleting
22 or PendingRemove
23 or BitmapSync
24 or DisconnectedFromPeer
25 or ReplicationPausedUserInitiated
26 or ReplicationPausedSystemInitiated
27 or RecoveryStorageProfileError
28 or Backup
29 or RollingBack
 
30 or RecoveryStorageError
31 or JournalStorageError
32 or VmNotProtectedError
 
sourceType
The protected site environment. Possible values are:
0 or VCVpg – The VPG is protecting virtual machines in a VMware vCenter Server.
1 or VCvApp – The VPG is protecting a VMware vCenter Server vApp.
2 or VCDvApp – The VPG is protecting a VMware vCloud Director vApp.
3 or AWS – Not applicable.
4 or HyperV – The VPG is protecting virtual machines in Microsoft Hyper-V.
 
targetType
The recovery site environment. Possible values are:
0 or VCVpg – The VPG is recovering virtual machines in a VMware vCenter Server.
1 or VCvApp – The VPG is recovering a VMware vCenter Server vApp.
2 or VCDvApp – The VPG is recovering a VMware vCloud Director vApp.
3 or AWS – The VPG is recovering virtual machines in Amazon Web Services (AWS).
4 or HyperV – The VPG is recovering virtual machines in Microsoft Hyper-V.
 
sourceSite
The name of the source site where the VPG virtual machines are protected.
 
targetSite
The name of the target site where the VPG virtual machines are recovered.
 
organizationName
The ZORG for this VPG.
 
priority
The priority specified for the VPG. Possible values are:
0 or Low – The VPG has a low priority for transferring data.
1 or Medium – The VPG has a medium priority for transferring data.
2 or High – The VPG has a high priority for transferring data.
HTTP Method
GET
Security
The API is exposed over HTTPS. Client code must use the x-zerto-session HTTP authorization header.
See Also
Starting a session: https://zvm_ip:port/v1/session – POST Method
Return a list of unprotected virtual machines – Virtualization Sites API – https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/vms
vSphere only – Return a list of unprotected vApps – Virtualization Sites API – https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/vapps
vSphere only – Return a list of unprotected vCD vApps – Virtualization Sites API – https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/vcdvapps
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/vms and for https://zvm_ip:port/v1/vms/{vmId}.
[{
  "ActualRPO": 2147483647,
  "Entities": {
    "Protected":0,
    "Recovery":0,
    "Source": 0,
    "Target": 0
  },
  "IOPS": 2147483647,
  "LastTest": "/Date(928142400000+0300)/",
  "Link_{n}": {
    "href": "String content",
    "identifier":"String content",
    "rel": "String content",
    "type": "String content"
  },
  "Link__x007B_0_x007D_":{
    "href":"String content",
    "rel":"String content",
    "type":"String content"
  },
  "OrganizationName": "String content",
  "Priority": 0,
  "ProvisionedStorageInMB": 2147483647,
  "SourceSite": "String content",
  "Status": 0,
  "SubStatus": 0,
  "TargetSite": "String content",
  "ThroughputInMB": 1.26743233E+15,
  "UsedStorageInMB": 2147483647,
  "VmIdentifier": "String content"
  "VmName":"String content",
  "VpgName":"String content"
}]
XML Response Format
For the XML response format, see VMs API XML Response Format.
Response Values
Response values for https://zvm_ip:port/v1/vms and for https://zvm_ip:port/v1/vms/{vmId}
Parameter
Description
ActualRPO
The time since the last checkpoint was written to the journal in seconds. This should be less than the Target RPO Alert value specified for the VPG. A value of -1 means that the RPO has not been calculated.
Entities
The source type and target types, vCenter Server of vCloud Director, where the virtual machine is protected and recovered.
Protected
The type of virtual machines being protected. Possible values are (Json/XML):
0/VCVpg – The VPG is protecting virtual machines in a VMware vCenter Server.
1/VCvApp – The VPG is protecting a VMware vCenter Server vApp.
2/VCDvApp – The VPG is protecting a VMware vCloud Director vApp.
3/AWS – Not applicable.
4/HyperV – The VPG is protecting virtual machines in Microsoft Hyper-V.
Recovery
The type of virtual machines being recovered. Possible values are (Json/XML):
0/VCVpg – The VPG is recovering virtual machines in a VMware vCenter Server.
1/VCvApp – The VPG is recovering a VMware vCenter Server vApp.
2/VCDvApp – The VPG is recovering a VMware vCloud Director vApp.
3/AWS – The VPG is recovering virtual machines in Amazon Web Services (AWS).
4/HyperV – The VPG is recovering virtual machines in Microsoft Hyper-V.
Source
The source type of virtual machines being protected. Possible values are (Json/XML):
0/VCVpg – The VPG is protecting virtual machines in a VMware vCenter Server.
1/VCvApp – The VPG is protecting a VMware vCenter Server vApp.
2/VCDvApp – The VPG is protecting a VMware vCloud Director vApp.
3/AWS – Not applicable.
4/HyperV – The VPG is protecting virtual machines in Microsoft Hyper-V.
Target
The target type of virtual machines being recovered. Possible values are (Json/XML):
0/VCVpg – The VPG is recovering virtual machines in a VMware vCenter Server.
1/VCvApp – The VPG is recovering a VMware vCenter Server vApp.
2/VCDvApp – The VPG is recovering a VMware vCloud Director vApp.
3/AWS – The VPG is recovering virtual machines in Amazon Web Services (AWS).
4/HyperV – The VPG is recovering virtual machines in Microsoft Hyper-V.
IOPS
The IO per second between all the applications running on the virtual machine in the VPG and the VRA that sends a copy to the remote site for replication.
LastTest
The date the last failover test occurred. 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.
Link
The link details.
href
The URL used.
identifier
The unique identifier of the virtual machine.
rel
The next path level for the API relative to the current path.
type
The API interface service.
Link
The link details.
href
The URL used.
rel
The next path level for the API relative to the current path.
type
The API interface service.
OrganizationName
The name of the organization set up in the Zerto Cloud Manager, the ZORG, that uses a cloud service provider for recovery.
Priority
The priority specified for the VPG. Possible values are (Json/XML):
0/Low – The VPG has a low priority for transferring data.
1/Medium – The VPG has a medium priority for transferring data.
2/High – The VPG has a high priority for transferring data.
ProvisionedStorageInMB
The storage provisioned for the virtual machine in the recovery site.
SourceSite
The name of the site where the virtual machine is protected.
Status
The status of the VPG that contains the virtual machine. Possible values are (Json/XML):
0/Initializing– The VPG is being initialized. This includes when a VPG is created, and during the initial sync between sites.
1/MeetingSLA – The VPG is meeting the SLA specification.
2/NotMeetingSLA – The VPG is not meeting the SLA specification for both the journal history and RPO SLA settings, for example during a delta sync or when there is an error.
3/RpoNotMeetingSLA – The VPG is not meeting the SLA specification for the RPO SLA setting.
4/HistoryNotMeetingSLA – The VPG is not meeting the SLA specification for the journal history.
5/FailingOver – The VPG is in a Failover operation.
6/Moving – The VPG is in a Move operation.
7/Deleting – The VPG is being deleted.
8/Recovered – The VPG is recovered.
SubStatus
The substatus of the VPG that contains the virtual machine, for example the VPG is in a bitmap sync. For the description of substatuses, refer to the Zerto Virtual Manager Administration Guide. Possible values are (Json/XML):
0/None
1/InitialSync
2/Creating
3/VolumeInitialSync
4/Sync
5/RecoveryPossible
6/DeltaSync
7/NeedsConfiguration
8/Error
9/EmptyProtectionGroup
 
10/DisconnectedFromPeerNoRecoveryPoints
11/FullSync
12/VolumeDeltaSync
13/VolumeFullSync
14/FailingOverCommitting
15/FailingOverBeforeCommit
16/FailingOverRollingBack
17/Promoting
18/MovingCommitting
19/MovingBeforeCommit
 
20/MovingRollingBack
21/Deleting
22/PendingRemove
23/BitmapSync
24/DisconnectedFromPeer
25/ReplicationPausedUserInitiated
26/ReplicationPausedSystemInitiated
27/RecoveryStorageProfileError
28/Backup
29/RollingBack
 
30/RecoveryStorageError
31/JournalStorageError
32/VmNotProtectedError
TargetSite
The name of the site where the virtual machine is recovered.
ThroughputInMb
The MBs for all the applications running on the virtual machine being protected.
UsedStorageInMB
The storage used by the virtual machine at the recovery site.
VmIdentifier
The virtual machine identifier. The identifier comprises the server identifier and the virtual machine moref, with the format, serverid.moref.
VmName
The virtual machine name.
VpgName
The VPG name of the VPG in which the virtual machine is protected.