Zerto APIs : Protected VMs API : Format
  
Format
Json, XML
Request Body Using Json Format
The request body is empty.
Response In Json Format
The following is an example response Json body for https://zvm_ip:port/v1/vms and for https://zvm_ip:port/v1/vms/{vmIdentifier}.
[
{
  "ActualRPO": 4,
  "EnabledActions": {
    "IsFlrEnabled": true
  },
  "Entities": {
    "Protected": 0,
    "Recovery": 0,
    "Source": 0,
    "Target": 0
  },
  "HardwareVersion": "String content",
  "IOPs": 1,
  "IsVmExists": true,
  "JournalHardLimit": {
    "LimitType": 1,
    "LimitValue": 153600
  },
  "JournalUsedStorageMb": 0,
  "JournalWarningThreshold": {
    "LimitType": 1,
    "LimitValue": 115200
  },
  "LastTest": null,
  "Link": {
    "href": "String content",
    "identifier": "String content",
    "rel": null,
    "type": "VmApi"
  },
  "Link_{0}": {
    "href": "String content",
    "rel": "self",
    "type": "VmApi"
  },
  "OrganizationName": "String content",
  "OutgoingBandWidthInMbps": 4.48681640625,
  "Priority": 1,
  "ProtectedSite": {
    "href": "String content",
    "identifier": "String content",
    "rel": null,
    "type": "PeerSiteApi"
  },
  "ProvisionedStorageInMB": 11938,
  "RecoveryHostIdentifier": "String content",
  "RecoverySite": {
    "href": "String content",
    "identifier": "String content",
    "rel": null,
    "type": "LocalSiteApi"
  },
  "SourceSite": "String content",
  "Status": 1,
  "SubStatus": 0,
  "TargetSite": "String content",
  "ThroughputInMB": 9,
  "UsedStorageInMB": 0,
  "VmIdentifier": "String content",
  "VmName": "String content",
  "Volumes": [
    {
    "VmVolumeIdentifier": "String content"
    }
  ],
  "VpgIdentifier": "String content",
  "VpgName": "String content"
}
]
XML Response Format
For the XML response format, see “VMs API XML Response Format”, on page 370.
Response Values
Response values for https://zvm_ip:port/v1/vms and for https://zvm_ip:port/v1/vms/{vmIdentifier}
 
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: Deprecated. See VCDvApp.
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: Deprecated. See VCDvApp.
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
Deprecated. See Protected.
Target
Deprecated. See Recovery.
JournalHardLimit
The maximum size the Journal can grow to.
LimitType
The type of Journal size limit. Possible values are:
■ 0 or Unlimited
■ 1 or Megabytes
■ 2 or Percentage
LimitValue
The limit value according to the limit type.
JournalUsedStorageMb
The amount of used journal storage for the virtual machine, in Mb.
JournalWarningThreshold
The journal size that generates a warning that the journal is nearing its hard limit.
LimitType
The type of Journal size limit. Possible values are:
■ 0 or Unlimited
■ 1 or Megabytes
■ 2 or Percentage
LimitValue
The limit value according to the limit type.
HardwareVersion
The VMware hardware version.
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.
IsVmExists
True: The VM exists.
False: The VM does not exist.
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 Managing vCD APIs.
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.
OutgoingBandWidthInMbps
The bandwidth throttling defined for the virtual machines.
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.
ProtectedSite
The identifier of the protected site where the VPG virtual machines are protected.
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.
ProvisionedStorageInMB
The storage provisioned for the virtual machine in the recovery site.
RecoveryHostIdentifier
The identifier of the host that handles the replicated data. The identifier comprises the server identifier and the host moref, with the format, serverid.moref.
RecoverySite
The identifier of the recovery site where the VPG virtual machines are recovered.
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.
SourceSite
Deprecated. See ProtectedSite > identifier.
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
29/RollingBack
 
30/RecoveryStorageError
31/JournalStorageError
32/VmNotProtectedError
33/JournalOrRecoveryMissingError
34/AddedVmsInInitialSync
35/ReplicationPausedForMissingVolume
TargetSite
Deprecated. See RecoverySite > identifier.
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 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.
VmName
The virtual machine name.
Volumes
Information about the volumes of the virtual machine.
vmVolumeIdentifier
The identifier of the volume used by the virtual machine. The volume identifier uses the SCSI standard to describe controllers and units, for example: SCSI:0:0.
VpgName
The name of the VPG in which the virtual machine is protected.
EnabledActions
Actions that can be performed on the virtual machine.
IsFlrEnabled
Whether file level restore is enabled.
VpgIdentifier
The identifier of the VPG.
PowerShell Scripts
For complete PowerShell Scripts, see “Examples”, on page 23.