Virtualization Sites API

Zerto Virtual Replication APIs : Virtualization Sites API

/v1/virtualizationsites returns information about the hypervisor site where the API is run and all the sites paired with this site. The information returned can be tailored to specific information about the resources managed at a specified site.

URI

All sites	https://zvm_ip:port/v1/virtualizationsites
Single site	https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}
Storage clusters at site	https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/datastoreclusters
Storage at site	https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/datastores
Folders at site	https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/folders
Host clusters at site	https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/hostclusters
Hosts at site	https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/hosts
Single host at site	https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/hosts/{hostIdentifier}
Networks at site	https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/networks
Org vDCs at site	https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/orgvdcs
Resource pools at site	https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/resourcepools
Unprotected vApps at site	https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/vapps
Unprotected vCD vApps at site	https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/vcdvapps
Unprotected VMs at site	https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/vms

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.
siteIdentifier	The identifier of the site for which information is returned.
hostIdentifier	The identifier of the host for which information is returned.

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 the details of the peer sites – Peer Sites API

Return a list of protected virtual machines – VMs that are Protected API

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.

[{

"DatastoreClusterIdentifier":"String content",

"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"

}]

Org vDCs (vSphere only)

The following is an example response Json body for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/orgvdcs.

[{

"Identifier":"String content",

"OrgVdcName":"String content"

}]

Resource Pools (vSphere only)

The following is an example response Json body for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/resourcepools.

[{

"ResourcePoolIdentifier":"String content",

"ResourcepoolName":"String content"

}]

vCenter Server vApps (vSphere only)

The following is an example response Json body for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/vapps.

[{

"VappIdentifier":"String content",

"VappName":"String content"

}]

vCD vApps (vSphere only)

The following is an example response Json body for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/vcdvapps.

[{

"VCDName":"String content",

"VCDVappIdentifier":"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

For the XML response format, see Virtualization Sites API 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
DatastoreClusterIdentifier	The internal identifier of the storage cluster. The identifier comprises the server identifier and the storage cluster moref, with the format, serverid.moref.
DatastoreClusterName	The storage cluster name.

Note: Storage in Microsoft SCVMM is also returned using this API and the response labels are DatastoreClusterIdentifier and DatastoreClusterName.

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.

vSphere only – Response values for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/orgvdcs.

Parameter	Description
Identifier	The internal identifier of the Org vDC.
OrgVdcName	The Org vDC name.

vSphere 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.

vSphere only – Response values for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/vapps.

Parameter	Description
VappIdentifier	The internal identifier of the vApp that is not protected by Zerto Virtual Replication.
VappName	The vApp name that is not protected by Zerto Virtual Replication.

vSphere only – Response values for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/vcdvapps.

Parameter	Description
VCDName	The vCD vApp name that is not protected by Zerto Virtual Replication.
VCDVappIdentifier	The internal identifier of the vCD vApp that is not protected by Zerto Virtual Replication.

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.