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 Sample: Get Disk VIDs

curl

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)
`action`	string	`InventoryManagement`
`method`	string	`getNodes`
`data`	array	parameters
`type`	string	`rpc`
`tid`	integer	`1`

Request Sample: Export

curl

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)
`action`	string	`ExportBackupManagement`
`method`	string	`exportToCifs/exportToLocal/exportToNfs`
`data`	array	Parameters
`type`	string	`rpc`
`tid`	integer	`2`

data

Field	Type	Description
`exportSources`	array	Disk VIDs. See `exportSources` description below.
`format`	string	VMDK/OVA/VHD/VHDX
`location`	string	CIFS/Local/NFS
`path`	string	Path to a target location
`credential`	object	Credentials to your target location. See the `credential` description below.
`clientTimeOffsetToUtc`	number	Client’s time off

exportSources

Field	Type	Description
`boVid`	string	Backup Object VID
`spVid`	string	Savepoint VID
`spDiskVids`	array	Save Point Disk Vids

credential

Field	Type	Description
`type`	string	Type of credentials. Possible values PASSWORD or PRIVATE_KEY
`username`	string	Username
`password`	string	Password
`id`	null	Credentials ID
`name`	null	Name
`privateKey`	null	Private key
`privateKeyFileName`	null	Private key filename
`keyPassword`	null	Private key password
`description`	null	Description

Request Sample: Get Activities

curl

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)
`action`	string	`ActivityManagement`
`method`	string	`getActivities`
`data`	array	Parameters
`type`	string	`rpc`
`tid`	integer	`3`

data

Field	Type	Description
`startIndex`	number	Start index
`pageSize`	number	Size of page
`searchPhrase`	null	Search phrase

Response Sample: Get Disk VIDs

curl

{
	"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
`message`	string	Message if the request failed
`where`	string	Reference to the method where the problem occurred
`cause`	string	Cause of failure
`data`	Json	Disks summary info. See details below

data

Field	Value	Description
`children`	Json	Disks info. See details below
`totalCount`	number	Number of save points

children

Field	Value	Description
`extendedInfo`	object	Extended Disk Information. See details below
`identifier`	number	Savepoint number
`vid`	string	Savepoint VID
`type`	string	Savepoint type
`subType`	null	Savepoint subtype
`name`	string	Name
`description`	null	Description
`accessable`	boolean	true/false
`isDisabled`	boolean	false/true
`replicable`	boolean	false/true
`hvType`	string	HV type
`flags`	number	Number of flags
`children`	null	Children

extendedInfo

Field	Value	Description
`disks`	Json	Disks info. See details below
`nics`	Json	NICs info. See details below
`generation`	null	Generation
`CPU`	number	Number of CPU
`memorySize`	number	Memory Size
`size`	number	Size
`version`	number	Version
`hwUuid`	string	Hw UU ID
`storageVid`	null	Storage VID
`virtualizationType`	null	Virtualization type
`instanceType`	null	Instance Type
`vpcId`	null	VPC ID
`vpcCidrBlock`	null	VPC CIDR block
`subnetID`	null	Subnet ID
`subnetCidrBlock`	null	Subnet CIDR block
`availabilityZoneId`	null	Zone ID
`securityGroupIDs`	array	Security Group IDs
`hasRootDisk`	boolean	false/true

disks

Field	Value	Description
`diskIdentifier`	string	Disk ID
`allocated`	number	Amount of memory allocated
`capacity`	number	Capacity
`storageVid`	string	Storage Vid
`storagePath`	null	Path to the storage
`canBeProcessed`	boolean	true/false
`isRoot`	null
`identifier`	number	Identifier number
`vid`	string	Number of savepoint disk
`type`	string	Type of disk
`subType`	null	Subtype
`name`	string	Disk name
`description`	null	Description
`accessible`	boolean	true/false
`isDisable`	boolean	true/false
`replicable`	boolean	true/false
`hvType`	string	HV type
`flags`	number	Flags
`children`	null	Children

nics

Field	Value	Description
`nicIdentifier`	string	NIC ID
`networkVid`	null	Network Vid
`canBeProcessed`	boolean	true/false
`identifier`	number	Identifying number
`vid`	string	VID of savepoint NIC
`type`	string	Type of NIC
`subType`	null	Subtype
`name`	string	Name adapter name
`description`	null	Description
`accessible`	boolean	false/true
`isDisabled`	boolean	false/true
`replicable`	boolean	false/true
`hvType`	string	HV type
`flags`	number	Flags
`children`	null	Children

Response Sample: Run Export

curl

{
	"action": "ExportBackupManagement",
	"method": "exportToCifs",
	"tid": "2",
	"type": "rpc",
	"message": null,
	"where": null,
	"cause": null,
	"data": null
}

Response Fields

Field	Value	Description
`message`	string	Message if the request failed
`where`	string	Reference to the method where the problem occurred
`cause`	string	Cause of failure
`data`	null	Info summary

Response Sample: Get Activities

curl

{
	"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
`message`	string	Message if the request failed
`where`	string	Reference to the method where the problem occurred
`cause`	string	Cause of failure
`data`	Json	Parameters. See details below

data

Field	Value	Description
`totalCurrents`	number	Total current activities
`totalPasts`	number	Total past activities
`activities`	array	Activities info. See details below

activities

Field	Value	Description
`id`	number	Activity ID
`name`	string	Activity name
`type`	string	Activity type
`specificActivityRunType`	null	Activity run time
`status`	string	Activity status
`startDate`	string	Activity start date
`progress`	number	Activity progress
`specificType`	string	Activity specific type

Page tree

Export Backup to VMDK File

Endpoint

Request Sample: Get Disk VIDs

Request fields

Request Sample: Export

Request Fields

Request Sample: Get Activities

Request Fields

Response Sample: Get Disk VIDs

Response Fields

Response Sample: Run Export

Response Fields

Response Sample: Get Activities

Response Fields