Get the list of Recovery groups
Select
Get the list of Recovery groups
- 200
- 501
OK
- application/json
- Schema
- Example (from schema)
Schema
recoveryGroups object[]
id int32Id of the recovery group
name stringName of the recovery group
target object
id int32name stringpostRecoveryActions object[]
path stringThe path of the script to be executed. Can be local path on VM or UNC path accessible by access node
type stringPossible values: [
UNC
,LOCAL
]The type of path being used for DR operation script
scriptCredentials object
savedCredentials object
id int32name stringcredentials object
name stringusername to access the network path
password stringpassword to access the network path
guestCredentials object
savedCredentials object
id int32name stringcredentials object
name stringusername to access the network path
password stringpassword to access the network path
guid stringUnique script identifier string
scriptContent stringContent of the script to be executed
scriptName stringName of the script
reset booleanOn set to true, resets the script to empty
osType stringPossible values: [
WINDOWS
,UNIX
]OS types
delayBetweenPriorityMachines int32The delay between machines in different priorities in minutes
continueOnFailure booleanDefault value:
false
Set to true to continue to the next priority machines on failure
action RecoveryActionPossible values: [
CREATE
,UPDATE
,DELETE
]Recovery Action
recoveryPointDetails object
Contains the information regarding the recovery group level recoveryPoint selection
recoveryPoint int32Timestamp for group restore in case of disaster
recoveryPointCategory stringPossible values: [
LATEST
,POINT_IN_TIME
,AUTOMATIC
]Default value:
LATEST
Type of recovery point category
recoveryPoint int32Timestamp for group restore in case of disaster
recoveryExpirationOptions object
enableExpirationOption booleanDefault value:
true
If true, cleans up recovered VMs after the set daysToExpire value
daysToExpire int32Default value:
7
Number of days after which recovered VMs are automatically cleaned up
isRescuedCommServe booleanWhether the CommServe is rescued or not
expirationTime int32Timestamp when the clean up of all recovered VMs happens on the rescued CommServe. It happens 4 hours before the CommServe expiration time
{
"recoveryGroups": [
{
"id": 0,
"name": "string",
"target": {
"id": 0,
"name": "string"
},
"postRecoveryActions": [
{
"path": "string",
"type": "UNC",
"scriptCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"guestCredentials": {
"savedCredentials": {
"id": 0,
"name": "string"
},
"credentials": {
"name": "string",
"password": "string"
}
},
"guid": "string",
"scriptContent": "string",
"scriptName": "string",
"reset": true,
"osType": "WINDOWS"
}
],
"delayBetweenPriorityMachines": 0,
"continueOnFailure": false,
"recoveryPointDetails": {
"recoveryPoint": 0,
"recoveryPointCategory": "LATEST"
},
"recoveryPoint": 0,
"recoveryExpirationOptions": {
"enableExpirationOption": true,
"daysToExpire": 7,
"isRescuedCommServe": true,
"expirationTime": 0
}
}
]
}
Internal server error
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}