This is an archive version of the document. To get the most up-to-date information, see the current version.

Schemas

The following JSON schemas and subschemas are used to represent resources in the /RecoveryLocations collection in the VAO REST API. Properties included in the schemas and subschemas represent VAO recovery location settings and can be used for query parameter values in GET requests.

RecoveryLocationInfo

Property	Type	Description
id	string	System ID assigned to a recovery location in the VAO REST API.
type	string	Type of the recovery location.
name	string	Name of the recovery location.
description	string	Description of the recovery location.
useReIp	boolean	Defines whether Re-IP rules are enabled for the recovery location.
useNetworkMapping	boolean	Defines whether network mapping is configured for the recovery location.
computeGroups	ResourceGroupDefinitionInfo	Information on resource groups added to the recovery location.
reIpRules	RecoveryReIpRuleInfo	Information on configured Re-IP rules.
networkMappingRules	NetworkMappingRuleInfo	Information on configured network mapping rules.
availability	string	Availability of the recovery location.

ResourceGroupDefinitionInfo

Property	Type	Description
id	string	System ID assigned to the resource group in the VAO REST API.
name	string	Name of the resource group.
resourceType	string	Type of the resource group.
availability	string	Availability of the resource group.
itemsCount	integer	Total number of items in the resource group.

RecoveryReIpRuleInfo

Property	Type	Description
id	string	System ID assigned to the Re-IP rule in the VAO REST API.
sourceIp	string	IP address adopted in the source location.
sourceMask	string	Subnet mask adopted in the source location.
targetIp	string	IP address adopted in the target location.
targetMask	string	Subnet mask adopted in the target location.
targetGateway	string	Default gateway used for recovered VMs.
preferredDns	string	IP adress of the preferred DNS server used for recovered VMs.
alternateDns	string	IP adress of the alternate DNS server used for recovered VMs.
preferredWins	string	IP adress of the preferred WINS server used for recovered VMs.
alternateWins	string	IP adress of the alternate WINS server used for recovered VMs.
description	string	Description of the Re-IP rule.

NetworkMappingRuleInfo

Property	Type	Description
id	string	System ID assigned to a network mapping rule in the VAO REST API.
sourceNetworkId	string	System ID assigned to a source network in the VAO REST API.
sourceNetworkName	string	Name of the source network.
sourceNetworkVcId	integer	System ID in the VAO REST API assigned to a vCenter Server that manages source VMs.
sourceNetworkVcName	string	Name of the vCenter Server that manages source VMs.
sourceNetworkDcId	integer	System ID in the VAO REST API assigned to a datacenter that contains a host running source VMs.
sourceNetworkIsRemoved	boolean	Defines whether the source network is removed.
targetNetworkId	string	System ID assigned to the target network in the VAO REST API.
targetNetworkName	string	Name of the target network.
targetNetworkVcId	integer	System ID in the VAO REST API assigned to a vCenter Server that will manage recovered VMs.
targetNetworkVcName	string	Name of the vCenter Server that will manage recovered VMs.
targetNetworkDcId	integer	System ID in the VAO REST API assigned to a datacenter that will be used to recover VMs.
targetNetworkIsRemoved	boolean	Defines whether the target network is removed.