Zerto Virtual Replication APIs : VRAs API : VRAs: GET
  
VRAs: GET
Returns information about VRAs.
URL
All VRAs
https://zvm_ip:port/v1/vras
Filtered VRAs
https://zvm_ip:port/v1/vras?vraName={VRANAME}&status={STATUS}&vraVersion={VRAVERSION}&hostVersion={HOSTVERSION}&ipAddress={IPADDRESS}&vraGroup={VRAGROUP}&datastoreName={DATASTORENAME}&datastoreClusterName={DATASTORECLUSTERNAME}&networkName={NETWORKNAME}
Single VRA
https://zvm_ip:port/v1/vras/{vraIdentifier}
Valid VRA IP configuration types Checkpoints
https://zvm_ip:port/v1/vras/ipconfigurationtypes
Valid VRA statuses
https://zvm_ip:port/v1/vras/statuses
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.
vraIdentifier
The identifier of the VRA for which information is returned.
Filters
Filters are optional and any combination of filters is valid. When no filter is specified, all VRAs are returned. Filters are not case-sensitive.
 
Filter
Description
 
vraName
The name of the VRA.
 
status
The status of the VRA.
 
vraVersion
The version of the VRA.
 
hostVersion
The version of the host where the VRA is installed.
 
ipAddress
The IP address of the VRA.
 
vraGroup
The group the VRA belongs to. VRAs can be grouped together when VRAs use different networks so they can be grouped by network, for example when the same hypervisor manager supports two datacenters with separate networks and you are replicating from one datacenter to the second datacenter.
 
datastoreName
The name of the datastore the VRA uses for recovery data.
 
datastoreClusterName
The name of the datastore cluster the VRA uses for recovery data.
 
networkName
The network the VRA belongs to.
Request Format
The request body is empty.
Json Response Format
The following is an example response Json body for https://zvm_ip:port/v1/vras and, without the array statement, for https://zvm_ip:port/v1/vras/{vraIdentifier}.
[{
  "DatastoreClusterName": "String content",
  "DatastoreIdentifier": "String content",
  "DatastoreName": "String content",
  "HostIdentifier": "String content",
  "HostVersion": "String content",
  "IpAddress": "String content",
  "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"
  },
  "MemoryInGB":2147483647,
  "NetworkIdentifier": "String content",
  "NetworkName": "String content",
  "Progress":2147483647,
  "ProtectedCounters": {
    "Vms":2147483647,
    "Volumes":2147483647,
    "Vpgs":2147483647
  },
  "RecoveryCounters": {
    "Vms":2147483647,
    "Volumes":2147483647,
    "Vpgs":2147483647
  },
  "SelfProtectedVpgs":2147483647,
  "Status":0,
  "VraGroup": "String content",
  "VraIdentifier":18446744073709551615,
  "VraName": "String content",
  "VraNetworkDataApi": {
    "DefaultGateway": "String content",
    "SubnetMask": "String content",
    "VraIPAddress": "String content",
    "VraIPConfigurationTypeApi": "String content"
  },
  "VraVersion": "String content"
}]
The following is an example response Json body for https://zvm_ip:port/v1/vras/ipconfigurationtypes and for https://zvm_ip:port/v1/vras/statuses.
["String content"]
XML Response Format
For the XML response format, see “VRAs API GET Method Response Formats”, on page 266.
Response Values
Response values for https://zvm_ip:port/v1/vras and for https://zvm_ip:port/v1/vras/{vraIdentifier}.
Parameter
Description
DatastoreClusterName
The name of the datastore cluster of the VRA virtual machine.
DatastoreIdentifier
The identifier of the vSphere datastore/Hyper-V storage of the VRA virtual machine. The identifier comprises the server identifier and the storage moref, with the format, serverid.moref.
DatastoreName
The name of the vSphere datastore/Hyper-V storage of the VRA virtual machine.
HostVersion
The version of the host on which the VRA is installed.
IpAddress
The IP address of the VRA.
Link
The link details.
href
The URL used.
identifier
The VRA identifier.
rel
The next path level of 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 of the API relative to the current path.
type
The API interface service.
MemoryInGB
The amount of reserved memory allocated to the VRA when it was installed.
NetworkIdentifier
The identifier of the network used to access the VRA.
NetworkName
The name of the network used to access the VRA.
Progress
The percentage progress when installing the VRA.
ProtectionCounters
Details for a VRA on the protection site.
Vms
The number of VMs protected on the host with the VRA installed.
Volumes
The volumes used by the VRA.
Vpgs
The number of VPGs using the VRA.
RecoveryCounters
Details for a VRA on the recovery site.
Vms
The number of VMs recovered to the host with the VRA installed.
Volumes
The volumes used by the VRA.
Vpgs
The number of VPGs using the VRA.
SelfProtectedVpgs
The number of VPGs being protected and recovered on the same site.
Status
The status of the VRA. Possible values are (Json/XML):
Installed: The VRA is installed.
UnsupportedEsxVersion: The VRA cannot be installed on the ESX/ESXi host as the host version is not supported.
NotInstalled: A VRA is not installed.
Installing: The VRA is being installed.
Removing: The VRA is being removed.
InstallationError: The installation of the VRA failed.
HostPasswordChanged: The password used to access the host has changed.
UpdatingIpSettings: The IP settings of the VRA are updated.
DuringChangeHost: The host of the VRA disks is being changed.
VraGroup
The group the VRA belongs to, used when VRAs use different networks so they can be grouped by network, for example when the same vCenter Server supports two datacenters with separate networks and you are replicating from one datacenter to the second datacenter.
VraIdentifier
The internal VRA identifier.
VraName
The name used to identify the VRA in the UI.
VraNetworkDataApi
The VRA network details.
DefaultGateway
The default gateway for the VRA network.
SubnetMask
The subnet mask for the VRA network. The default value is 255.255.255.0.
VraIPAddress
The IP address for the VRA.
VraIPConfigurationTypeApi
The IP configuration used for the VRA. Possible values are:
Dhcp: The VRA IP address is allocated via a DHCP server.
Static: The VRA is installed with a static IP that was assigned when the VRA was installed.
VraVersion
The storage provisioned for the virtual machine in the recovery site.
Response values for https://zvm_ip:port/v1/vras/statuses.
Response: Description
Possible statuses for a VRA
Installed: The VRA is installed.
UnsupportedEsxVersion: The VRA cannot be installed on the ESX/ESXi host as the host version is not supported.
NotInstalled: A VRA is not installed.
Installing: The VRA is being installed.
Removing: The VRA is being removed.
InstallationError: The installation of the VRA failed.
HostPasswordChanged: The password used to access the host has changed.
UpdatingIpSettings: The IP settings of the VRA are updated.
DuringChangeHost: The host of the VRA disks is being changed.
Response values for https://zvm_ip:port/v1/vras/ipconfigurationtypes.
Response: Description
Possible IP configurations for the VRA:
Dhcp: The VRA IP address is allocated via a DHCP server.
Static: The VRA is installed with a static IP that was assigned when the VRA was installed.