PrlVmDevHd_SetStorageURL Function

Set custom storage URL.

Syntax

PRL_RESULT PrlVmDevHd_SetStorageURL(
    PRL_HANDLE hVmDev, 
    PRL_CONST_STR sURL
);

File

PrlApiDeprecated.h

Parameters

hVmDev

A valid handle of type PHT_VIRTUAL_DEV_HARD_DISK identifying the virtual hard disk.

sURL

[in] Storage URL - an UTF-8 encoded string with null '0' symbol at the end. The following URL types are supported: "backup://backup_server/backup_UUID/disk_number" - use disk backup, identified by "backup_UUID/disk_number" from server "backup_server".

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

A storage URL is required when actual data of a virtual hard disk is accessed using some external tool or protocol. For example, a VM disk backup, which resides on a remote server, could be attached as a data source using the following storage URL: "backup://backup_server/backup_UUID/disk_number". Here, instead of reading data from the locally stored disk image, a VM will connect to the "backup_server" and read data from the "backup_UUID/disk_number" backup.