Export Backup to VMDK File
Exports a backup from a recovery point to the VMDK file.
Endpoint
https://<Director_IP_address>:4443/c/router
Tenant Endpoint
For tenants of the multi-tenant product the endpoint must be:
https://<Director_IP_address>:4443/t/<tenant_UUID>/c/router
To export a backup to a VMDK file, you need to take the following steps:
-
Get the disk VIDs to export them from a recovery point.
-
Run the export command to the location of your choice.
-
Monitor the activities to find out if the export has been successfully completed.
Request Example
curl --request POST \
--url https://<Director_IP_address>:4443/c/router \
--header "content-type: application/json" \
--cookie @cookies.txt \
--data "{
"action": "InventoryManagement",
"method": "getNodes",
"data": [true, ["SAVEPOINT-110"]],
"type": "rpc",
"tid": 1"}
Request Fields
Field |
Type |
Value(s) |
|
string |
|
|
string |
|
|
array |
parameters |
|
string |
|
|
integer |
|
Request Example
curl --request POST \
--url https://<Director_IP_address>:4443/c/router \
--header "content-type: application/json" \
--cookie @cookies.txt \
--data "{
"action": "ExportBackupManagement",
"method": "exportToCifs",
"data": [{
"exportSources": [{
"boVid": "BACKUP_OBJECT-4",
"spVid": "SAVEPOINT-110",
"spDiskVids": ["SAVEPOINT_DISK-148", "SAVEPOINT_DISK-149", "SAVEPOINT_DISK-150", "SAVEPOINT_DISK-151"]
}
],
"format": "VMDK",
"location": "CIFS",
"path": "\\\\server\\path",
"credential": {
"type": "PASSWORD",
"username": "test",
"password": "test",
"id": null,
"name": null,
"privateKey": null,
"privateKeyFileName": null,
"keyPassword": null,
"description": null
},
"clientTimeOffsetToUtc": 0
}
],
"type": "rpc",
"tid": 2"}
Request Fields
Field |
Type |
Value(s) |
|
string |
|
|
string |
|
|
array |
Parameters |
|
string |
|
|
integer |
|
data
Field |
Type |
Description |
|
array |
Disk VIDs. See |
|
string |
VMDK/OVA/VHD/VHDX |
|
string |
CIFS/Local/NFS |
|
string |
Path to a target location |
|
object |
Credentials to your target location. See the |
|
number |
Client’s time off |
exportSources
Field |
Type |
Description |
|
string |
Backup Object VID |
|
string |
Savepoint VID |
|
array |
Save Point Disk Vids |
credential
Field |
Type |
Description |
|
string |
Type of credentials. Possible values PASSWORD or PRIVATE_KEY |
|
string |
Username |
|
string |
Password |
|
null |
Credentials ID |
|
null |
Name |
|
null |
Private key |
|
null |
Private key filename |
|
null |
Private key password |
|
null |
Description |
Request Example
curl --request POST \
--url https://<Director_IP_address>:4443/c/router \
--header "content-type: application/json" \
--cookie @cookies.txt \
--data "{
"action": "ActivityManagement",
"method": "getActivities",
"data": [{
"startIndex": 0,
"pageSize": 100,
"searchPhrase": null
}
],
"type": "rpc",
"tid": 3"}
Request Fields
Field |
Type |
Value(s) |
|
string |
|
|
string |
|
|
array |
Parameters |
|
string |
|
|
integer |
|
data
Field |
Type |
Description |
|
number |
Start index |
|
number |
Size of page |
|
null |
Search phrase |
Response Sample
{
"action": "InventoryManagement",
"method": "getNodes",
"tid": "1",
"type": "rpc",
"message": null,
"where": null,
"cause": null,
"data": {
"children": [{
"extendedInfo": {
"disks": [{
"diskIdentifier": "Hard disk 1",
"allocated": 20971520,
"capacity": 0,
"storageVid": "BACKUP_REPOSITORY-1",
"storagePath": null,
"canBeProcessed": true,
"isRoot": null,
"identifier": 148,
"vid": "SAVEPOINT_DISK-148",
"type": "SAVEPOINT_DISK",
"subType": null,
"name": "Hard disk 1",
"description": null,
"accessible": false,
"isDisabled": false,
"replicable": true,
"hvType": "NONE",
"flags": 0,
"children": null
}, {
"diskIdentifier": "Hard disk 2",
"allocated": 1048576,
"capacity": 0,
"storageVid": "BACKUP_REPOSITORY-1",
"storagePath": null,
"canBeProcessed": true,
"isRoot": null,
"identifier": 149,
"vid": "SAVEPOINT_DISK-149",
"type": "SAVEPOINT_DISK",
"subType": null,
"name": "Hard disk 2",
"description": null,
"accessible": false,
"isDisabled": false,
"replicable": true,
"hvType": "NONE",
"flags": 0,
"children": null
}, {
"diskIdentifier": "Hard disk 3",
"allocated": 2097152,
"capacity": 0,
"storageVid": "BACKUP_REPOSITORY-1",
"storagePath": null,
"canBeProcessed": true,
"isRoot": null,
"identifier": 150,
"vid": "SAVEPOINT_DISK-150",
"type": "SAVEPOINT_DISK",
"subType": null,
"name": "Hard disk 3",
"description": null,
"accessible": false,
"isDisabled": false,
"replicable": true,
"hvType": "NONE",
"flags": 0,
"children": null
}, {
"diskIdentifier": "Hard disk 4",
"allocated": 614400,
"capacity": 0,
"storageVid": "BACKUP_REPOSITORY-1",
"storagePath": null,
"canBeProcessed": true,
"isRoot": null,
"identifier": 151,
"vid": "SAVEPOINT_DISK-151",
"type": "SAVEPOINT_DISK",
"subType": null,
"name": "Hard disk 4",
"description": null,
"accessible": false,
"isDisabled": false,
"replicable": true,
"hvType": "NONE",
"flags": 0,
"children": null
}
],
"nics": [{
"nicIdentifier": "00:50:56:b9:5b:78",
"networkVid": null,
"canBeProcessed": true,
"identifier": 115,
"vid": "SAVEPOINT_NIC-115",
"type": "SAVEPOINT_NIC",
"subType": null,
"name": "Network adapter 1",
"description": null,
"accessible": false,
"isDisabled": false,
"replicable": false,
"hvType": "NONE",
"flags": 0,
"children": null
}
],
"generation": null,
"cpu": 2,
"memorySize": 2048,
"size": 24731648,
"version": 7,
"hwUuid": "4239906e-a592-54e9-d547-71eb7237aa15",
"storageVid": null,
"virtualizationType": null,
"instanceType": null,
"vpcId": null,
"vpcCidrBlock": null,
"subnetId": null,
"subnetCidrBlock": null,
"availabilityZoneId": null,
"securityGroupIds": [],
"hasRootDisk": false
},
"identifier": 110,
"vid": "SAVEPOINT-110",
"type": "SAVEPOINT",
"subType": null,
"name": "00-cleanVM-SY",
"description": null,
"accessible": true,
"isDisabled": false,
"replicable": false,
"hvType": "NONE",
"flags": 0,
"children": null
}
],
"totalCount": 1
}
}
Response Fields
Field |
Value |
Description |
|
string |
Message if the request failed |
|
string |
Reference to the method where the problem occurred |
|
string |
Cause of failure |
|
Json |
Disks summary info. See details below |
data
Field |
Value |
Description |
|
Json |
Disks info. See details below |
|
number |
Number of save points |
children
Field |
Value |
Description |
|
object |
Extended Disk Information. See details below |
|
number |
Savepoint number |
|
string |
Savepoint VID |
|
string |
Savepoint type |
|
null |
Savepoint subtype |
|
string |
Name |
|
null |
Description |
|
boolean |
true/false |
|
boolean |
false/true |
|
boolean |
false/true |
|
string |
HV type |
|
number |
Number of flags |
|
null |
Children |
extendedInfo
Field |
Value |
Description |
|
Json |
Disks info. See details below |
|
Json |
NICs info. See details below |
|
null |
Generation |
|
number |
Number of CPU |
|
number |
Memory Size |
|
number |
Size |
|
number |
Version |
|
string |
Hw UU ID |
|
null |
Storage VID |
|
null |
Virtualization type |
|
null |
Instance Type |
|
null |
VPC ID |
|
null |
VPC CIDR block |
|
null |
Subnet ID |
|
null |
Subnet CIDR block |
|
null |
Zone ID |
|
array |
Security Group IDs |
|
boolean |
false/true |
disks
Field |
Value |
Description |
|
string |
Disk ID |
|
number |
Amount of memory allocated |
|
number |
Capacity |
|
string |
Storage Vid |
|
null |
Path to the storage |
|
boolean |
true/false |
|
null |
|
|
number |
Identifier number |
|
string |
Number of savepoint disk |
|
string |
Type of disk |
|
null |
Subtype |
|
string |
Disk name |
|
null |
Description |
|
boolean |
true/false |
|
boolean |
true/false |
|
boolean |
true/false |
|
string |
HV type |
|
number |
Flags |
|
null |
Children |
nics
Field |
Value |
Description |
|
string |
NIC ID |
|
null |
Network Vid |
|
boolean |
true/false |
|
number |
Identifying number |
|
string |
VID of savepoint NIC |
|
string |
Type of NIC |
|
null |
Subtype |
|
string |
Name adapter name |
|
null |
Description |
|
boolean |
false/true |
|
boolean |
false/true |
|
boolean |
false/true |
|
string |
HV type |
|
number |
Flags |
|
null |
Children |
Response Sample
{
"action": "ExportBackupManagement",
"method": "exportToCifs",
"tid": "2",
"type": "rpc",
"message": null,
"where": null,
"cause": null,
"data": null
}
Response Fields
Field |
Value |
Description |
|
string |
Message if the request failed |
|
string |
Reference to the method where the problem occurred |
|
string |
Cause of failure |
|
null |
Info summary |
Response Sample
{
"action": "ActivityManagement",
"method": "getActivities",
"tid": "3",
"type": "rpc",
"message": null,
"where": null,
"cause": null,
"data": {
"totalCurrents": 0,
"totalPasts": 1,
"activities": [{
"id": 7,
"name": "Backup export to VMDK at \"\\\\server\\test\" share",
"type": "EXPORT_BACKUP",
"specificActivityRunType": null,
"status": "COMPLETED",
"startDate": "2019-12-23T17:54:05.180+02:00",
"progress": -1,
"specificType": "EXPORT_BACKUP" }
]
}
}
Response Fields
Field |
Value |
Description |
|
string |
Message if the request failed |
|
string |
Reference to the method where the problem occurred |
|
string |
Cause of failure |
|
Json |
Parameters. See details below |
data
Field |
Value |
Description |
|
number |
Total current activities |
|
number |
Total past activities |
|
array |
Activities info. See details below |
activities
Field |
Value |
Description |
|
number |
Activity ID |
|
string |
Activity name |
|
string |
Activity type |
|
null |
Activity run time |
|
string |
Activity status |
|
string |
Activity start date |
|
number |
Activity progress |
|
string |
Activity specific type |