PrlSrv_CreateVmBackup Function

Backup an existing virtual machine to backup server.

Syntax

PRL_HANDLE PrlSrv_CreateVmBackup(
    PRL_HANDLE hSourceServer, 
    PRL_CONST_STR sVmUuid, 
    PRL_CONST_STR sTargetHost, 
    PRL_UINT32 nTargetPort, 
    PRL_CONST_STR sTargetSessionId, 
    PRL_CONST_STR strDescription, 
    PRL_UINT32 backup_flags, 
    PRL_UINT32 reserved_flags, 
    PRL_BOOL force_operation
);

File

PrlApiDeprecated.h

Parameters

hSourceServer

A handle of type PHT_SERVER identifying the source Parallels Service.

sVmUuid

A virtual machine uuid

sTargetHost

The name of the target host machine.

nTargetPort

The port number on the target host.

sTargetSessionId

The target Parallels Service session ID.

backup_flags

Flags that specify backup type and etc. Acceptable flags:

reserved_flags

Reserved flags.

force_operation

Specifies to process VM backup action without asking any additional questions from the Parallels Service side (non-interactive clients should use this option).

sDescription

The backup description.

PBT_FULL

full backup

PBT_INCREMENTAL

incremental backup

PBT_DIFFERENTIAL

differental backup

PBT_UNCOMPRESSED

uncompressed backup (by default fast zip compression used) PVMSL_LOW_SECURITY, PVMSL_NORMAL_SECURITY, PVMSL_HIGH_SECURITY

Returns

A handle of type PHT_JOB containing the results of this asynchronous operation or PRL_INVALID_HANDLE if there's not enough memory to instantiate the job object.

Remarks

To get the return code from the PHT_JOB object, use the PrlJob_GetRetCode function. Possible values are:

PRL_ERR_INVALID_ARG - invalid handle was passed.

PRL_ERR_SUCCESS - function completed successfully.

Notes

errors are the same as for VmMigrate activity

Links

PHT_SERVER