Get an existing recovery target details
To get recovery target details by ID
Path Parameters
- recoveryTargetId int32 required
id of recovery target
- 200
- 404
- 503
OK
- application/json
- Schema
- Example (from schema)
Schema
RecoveryTarget object
Recovery target info
entity object
id int32Recovery Target Id
name stringRecovery Target name
policyType stringRecovery target policy type name
applicationType stringPossible values: [
REPLICATION
,REGULAR
,AUTO_SCALE_MANAGEMENT
]Recovery target application type
destinationHypervisor object
id int32name stringaccessNode object
id int32name stringtype stringvmDisplayName object
Prefix or Suffix appended to create display name for destination instance
prefix stringA prefix string that will be appended to the source VM to create a display name for each destination VM
suffix stringA suffix string that will be appended to the source VM to create a display name for each destination VM
vmStoragePolicyName stringName of Storage policy linked with the vm
securityOptions object
users object[]
Users that have access to the recovery target
id int32name stringfullName stringuserGroups object[]
User groups that have access to the recovery target
id int32name stringsecurityGroup stringName of security group that provides controlled access of the VM in cloud
testSecurityGroups string[]Name of security groups that provide controlled access of the VM in cloud for test failover
destinationOptions object
destinationHost stringDestination host for the VM to deploy
dataStore stringDatastore for the destination VM to store the disks and its config files. In-case of Microsoft Hyper-V, datastore refers to the destination folder for restore when default folder is not set.
resourcePoolPath stringResource pool for the destination VM
vmFolder stringFolder path where the destination VM will be located,
iamRole object
id int32name stringnetworkOptions object
networkCard object
networkDisplayName stringSelected network display name
network stringName of network switch
destinationNetworks string[]Destination network name
networkNames string[]Name of network to which the nic is connected
cloudNetwork object
label stringCloud network label
networkName stringCloud network name
subnetNames string[]Subnet names of cloud network
provisioningOptions object
maximumCPUCores int32Maximum cores for the VM
numberOfVMs int32Number of VMs that each user can create using this recovery target
maximumMemory stringMaximum memory of the VM in GBs
templates object[]
vmName stringVM name of template
vmGUID stringVM guid of template
cloudDestinationOptions object
region stringRegion of destination
keyPair stringName of key pair that associates with the VM for authentication
restoreAsManagedVM booleanIf true, restore creates the destination VM as a managed VM in Azure
machineType object
id int32name stringsoleTenancyNodes object[]
name stringvalue stringavailabilityZone stringAvailability zone name for the destination instance
vmInstanceType stringInstance type that provides the available cpu cores and memory to the machine
encryptionKeyName stringEncryption key name needed to configure the destination VM
volumeType stringVolume type of destination VM
testDiskType stringDisk / Volume type for test failover VM
instanceTypes string[]publicIP booleanIf true, public IP address are configured for destination VMs
isoInfo object[]
Info for the Windows/Unix ISO files
isoPath stringPath for the Windows/Unix ISO files
osType stringPossible values: [
UNIX
,WINDOWS
]OS Type name
zone object
primaryZoneName stringName of Primary Zone for the VM to deploy
secondaryZoneName stringName of Secondary Zone for the VM to deploy
associatedClientGroup object
id int32name stringliveMountOptions object
mediaAgent object
id int32name stringisLiveMountEnabled booleanIndiciates whether the Live mount is allowed from this recovery target
migrateVMs booleanWhether migrate VMs options is turned on for test failover
expirationTime object
minutesRetainUntil stringExpiration Time if in minutes
daysRetainUntil stringExpiration Time if in days
virtualLabOptions object
externalNetwork stringTo use virtual lab VM to connect to the existing network
gatewayTemplate stringGateway template provision VMs to communicate to VMs outside the virtual lab
gatewayNetwork stringPrimary network associated on the Provisioning Gateway VM that has production network access
configureIsolatedNetwork booleanTo use isolated network for the virtual lab VM
ipSettings object[]
networkName stringipAddressRange stringsubnetMask stringdefaultGatewayIP string
{
"RecoveryTarget": {
"entity": {
"id": 0,
"name": "string",
"policyType": "string",
"applicationType": "REPLICATION",
"destinationHypervisor": {
"id": 0,
"name": "string"
}
},
"accessNode": {
"id": 0,
"name": "string",
"type": "string"
},
"vmDisplayName": {
"prefix": "string",
"suffix": "string"
},
"vmStoragePolicyName": "string",
"securityOptions": {
"users": [
{
"id": 0,
"name": "string",
"fullName": "string"
}
],
"userGroups": [
{
"id": 0,
"name": "string"
}
],
"securityGroup": "string",
"testSecurityGroups": [
"string"
]
},
"destinationOptions": {
"destinationHost": "string",
"dataStore": "string",
"resourcePoolPath": "string",
"vmFolder": "string",
"iamRole": {
"id": 0,
"name": "string"
}
},
"networkOptions": {
"networkCard": {
"networkDisplayName": "string",
"network": "string",
"destinationNetworks": [
"string"
],
"networkNames": [
"string"
]
},
"cloudNetwork": {
"label": "string",
"networkName": "string",
"subnetNames": [
"string"
]
}
},
"provisioningOptions": {
"maximumCPUCores": 0,
"numberOfVMs": 0,
"maximumMemory": "string",
"templates": [
{
"vmName": "string",
"vmGUID": "string"
}
]
},
"cloudDestinationOptions": {
"region": "string",
"keyPair": "string",
"restoreAsManagedVM": true,
"machineType": {
"id": 0,
"name": "string"
},
"soleTenancyNodes": [
{
"name": "string",
"value": "string"
}
],
"availabilityZone": "string",
"vmInstanceType": "string",
"encryptionKeyName": "string",
"volumeType": "string",
"testDiskType": "string",
"instanceTypes": [
"string"
],
"publicIP": true
},
"isoInfo": [
{
"isoPath": "string",
"osType": "UNIX"
}
],
"zone": {
"primaryZoneName": "string",
"secondaryZoneName": "string"
},
"associatedClientGroup": {
"id": 0,
"name": "string"
},
"liveMountOptions": {
"mediaAgent": {
"id": 0,
"name": "string"
},
"isLiveMountEnabled": true,
"migrateVMs": true,
"expirationTime": {
"minutesRetainUntil": "string",
"daysRetainUntil": "string"
}
},
"virtualLabOptions": {
"externalNetwork": "string",
"gatewayTemplate": "string",
"gatewayNetwork": "string",
"configureIsolatedNetwork": true,
"ipSettings": [
{
"networkName": "string",
"ipAddressRange": "string",
"subnetMask": "string",
"defaultGatewayIP": "string"
}
]
}
}
}
Not found - Unable to fetch recovery target details
Service Unavailable