PrlSrv_RemoveVmBackup Function

Remove backup of the virtual machine from backup server.

Syntax

PRL_HANDLE PrlSrv_RemoveVmBackup(
    PRL_HANDLE hSourceServer, 
    PRL_CONST_STR sVmUuid, 
    PRL_CONST_STR sBackupUuid, 
    PRL_CONST_STR sTargetHost, 
    PRL_UINT32 nTargetPort, 
    PRL_CONST_STR sTargetSessionId, 
    PRL_UINT32 remove_flags, 
    PRL_UINT32 reserved_flags, 
    PRL_BOOL force_operation
);

File

PrlApiVm.h

Parameters

hSourceServer

A handle of type PHT_SERVER identifying the source Virtuozzo Service.

sVmUuid

A virtual machine uuid

sBackupUuid

A backup uuid

sTargetHost

The name of the target host machine.

nTargetPort

The port number on the target host.

sTargetSessionId

The target Virtuozzo Service session ID.

remove_flags

Flags that specify remove type and etc. Acceptable flags: PVMSL_LOW_SECURITY, PVMSL_NORMAL_SECURITY, PVMSL_HIGH_SECURITY

reserved_flags

Reserved flags.

force_operation

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

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