Format
Json, XML
Request Format
The request body is empty.
Json Response Format
Virtualization sites
The following is an example response Json body for https://zvm_ip:port/v1/virtualizationsites and for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}.
[{ "SiteIdentifier": "String content", "VirtualizationSiteName": "String content" }] |
Datastore clusters
The following is an example response Json body for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/datastoreclusters.
[{ "DatastoreClusterName": "String content" }] |
Datastores
The following is an example response Json body for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/datastores.
[{ "DatastoreIdentifier": "String content", "DatastoreName": "String content" }] |
Folders
The following is an example response Json body for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/folders.
[{ "FolderIdentifier": "String content", "FolderName": "String content" }] |
Host clusters
The following is an example response Json body for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/hostclusters.
[{ "ClusterIdentifier": "String content", "VirtualizationClusterName": "String content" }] |
Hosts
The following is an example response Json body for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/hosts and for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/hosts/{hostIdentifier}.
[{ "HostIdentifier": "String content", "VirtualizationHostName": "String content" }] |
Networks
The following is an example response Json body for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/networks.
[{ "NetworkIdentifier": "String content", "VirtualizationNetworkName": "String content" }] |
VMware only: Resource Pools
The following is an example response Json body for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/resourcepools.
[{ "ResourcePoolIdentifier": "String content", "ResourcepoolName": "String content" }] |
Unprotected VMs
The following is an example response Json body for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/vms.
[{ "VmIdentifier": "String content", "VmName": "String content" }] |
XML Response Format
Response Values
Response values for https://zvm_ip:port/v1/virtualizationsites and for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}.
Parameter | Description |
SiteIdentifier | The identifier of the Zerto Virtual Manager site. |
VirtualizationSiteName | The hypervisor manager name. For example the VMware vCenter Server name or Microsoft SCVMM name. |
Response values for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/datastoreclusters.
Parameter | Description |
DatastoreClusterName | The storage cluster name. |
Note: Storage in Microsoft SCVMM is also returned using this API.
Response values for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/datastores.
Parameter | Description |
DatastoreIdentifier | The internal identifier of the storage. The identifier comprises the server identifier and the storage moref, with the format, serverid.moref. |
DatastoreName | The storage name. |
Note: Storage in Microsoft SCVMM is also returned using this API and the response labels are DatastoreIdentifier and DatastoreName.
Response values for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/folders.
Parameter | Description |
FolderIdentifier | The internal identifier of the folder. The identifier comprises the server identifier and the folder moref, with the format, serverid.moref. |
FolderName | The folder name. |
Response values for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/hostclusters.
Parameter | Description |
ClusterIdentifier | The unique identifier of the host cluster. The identifier comprises the server identifier and the host cluster moref, with the format, serverid.moref. |
VirtualizationClusterName | The name of the host cluster. |
Response values for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/hosts and for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/hosts/{hostIdentifier}.
Parameter | Description |
HostIdentifier | The unique identifier of the host. |
VirtualizationHostName | The name of the host. |
Response values for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/networks.
Parameter | Description |
NetworkIdentifier | The internal identifier of the network. |
VirtualizationNetworkName | The network name. |
VMware only: Response values for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/resourcepools.
Parameter | Description |
ResourcePoolIdentifier | The internal identifier of the resource pool. |
ResourcepoolName | The resource pool name. |
Response values for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/vms.
Parameter | Description |
VmIdentifier | The internal identifier of the virtual machine that is not protected by Zerto Virtual Replication. |
VmName | The virtual machine name that is not protected by Zerto Virtual Replication. |
Note: The response includes:
a) Virtual machines that are not protected in any VPG.
b) Virtual machines that are protected in VPGs but can be protected in additional VPGs. A virtual machine can be protected in a maximum number of three VPGs as long as:
■ The VPGs do not recover to the same site.
■ The protected and recovery sites, as well as the VRAs on each site, are of version 5.0 and higher.