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:

  1. Get the disk VIDs to export them from a recovery point.

  2. Run the export command to the location of your choice.

  3. Monitor the activities to find out if the export has been successfully completed.

Request Example

Request Fields

Field

Type

Value(s)

action

string

InventoryManagement

method

string

getNodes

data

array

parameters

type

string

rpc

tid

integer

1

Request Example

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 Example

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

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

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

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