All peer sites | https://zvm_ip:port/v1/peersites |
Filtered peer sites | https://zvm_ip:port/v1/peersites?peerName={PEERNAME}&pairingStatus={PAIRINGSTATUS}&location={LOCATION}&hostName={HOSTNAME}&port={PORT} |
Single peer site | https://zvm_ip:port/v1/peersites/{siteIdentifier} |
Valid pairing statuses | https://zvm_ip:port/v1/peersites/pairingstatuses |
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 peer site for which information is to be returned. | |
Filters | Filters are optional and any combination of filters is valid. When no filter is specified, all peer sites are returned. Filters are not case-sensitive. | |
Filter | Description | |
peerName | The name of a peer site for which information is to be returned. The name is case-sensitive. | |
pairingStatus | The pairing status for which information is to be returned. | |
location | The site location, as specified in the site information, for which information is to be returned. | |
hostName | The IP address of a Zerto Virtual Manager, paired with this site, for which information is to be returned. | |
port | The port used to access peer sites for which information is to be returned. The default port is 9081. | |
[{ "HostName": "String content", "IncomingThroughputInMb":1.26743233E+15, "Link": { "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" }, "Location": "String content", "OutgoingBandWidth":1.26743233E+15, "PairingStatus":0, "PeerSiteName": "String content", "Port":9081, "ProvisionedStorage":2147483647, "SiteIdentifier": "String content", "UsedStorage":2147483647, "Version": "String content" }] |
["String content"] |
Parameter | Description |
HostName | The address of a machine where a peer site Zerto Virtual Manager runs. |
IncomingThroughputInMb | The Mb/s for all the applications running on the virtual machines being recovered on the peer site. |
Link | The link details. |
href | The URL used. |
identifier | The internal site identifier. |
rel | The next path level for the API relative to the current path. |
type | The API interface service. |
Link__x007B_0_x007D_ | 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. |
Location | The site location of the peer site defined during the installation or in the Site Information dialog. |
OutgoingBandWidth | The bandwidth throttling defined for the site. |
PairingStatus | The connection status of the local site. Possible values are (Json/XML): Paired: The site is paired. Pairing: The site is in the process of being paired. Unpaired: The site is not paired. |
PeerSiteName | The name of the peer site defined during installation or in the Site Information dialog. |
Port | The port used for communication by the Zerto Virtual Managers. The default port is 9081. |
ProvisionedStorage | The storage provisioned for all of the virtual machines in all the VPGs recovered to this site. |
SiteIdentifier | The internal site identifier. |
UsedStorage | The storage used by all of the virtual machines in all the VPGs recovered to this site. |
Version | The Zerto Virtual Manager version. |
Response: Description |
Pairing statuses: Paired: The site is paired. Pairing: The site is in the process of being paired. Unpaired: The site is not paired. |