Virtual Disk API Programming Guide - Documentation - VMware

Change the Parent for a Disk
Virtual Disk API Functions
VixDiskLib_Reparent() changes the parent for the disk path to the given string value. The VMDK file name
must be an absolute path. The parentHint could be the file name of the parent disk. If the function succeeds,
the function returns VIX_OK. Otherwise, the appropriate VIX error code is returned. This function is available
only for hosted disk in new releases.
vixError =
VixDiskLib_Reparent(VixDiskLibConnection connection, const char *path, const char *parentHint);
Shut Down
All Virtual Disk API applications should call these functions at end of program.
Disconnect from Server
VixDiskLib_Disconnect() breaks an existing connection.
VixDiskLib_Disconnect(srcConnection);
Clean Up and Exit
VixDiskLib_Exit() cleans up the library before exit.
VixDiskLib_Exit();
Advanced Transport APIs
For managed disk, the first release of VDDK required network access ESX/ESXi host (LAN or NBD transport).
With VDDK 1.1 programs can access virtual disks directly on a storage device, LAN‐free. Direct SAN access
increases I/O performance. To select the most efficient transport method, a set of APIs is available, including:
VixDiskLib_InitEx() – Initializes the advanced transport library. You must specify the library location.
Replaces VixDiskLib_Init() in your application.
VixDiskLib_ListTransportModes() – Lists transport modes that the virtual disk library supports.
VixDiskLib_ConnectEx() – Establishes a connection using the best transport mode available, or one you
select, to access a given machine’s virtual disk. Currently it does not check validity of transport type.
Replaces VixDiskLib_Connect() in your application.
Initialize Virtual Disk API
Replacing VixDiskLib_Init(), VixDiskLib_InitEx() initializes new releases of the library, Parameters are
similar, except you should specify an actual libDir, and the new configFile parameter. For multithreaded
programming, you should write your own logFunc, because the default logging function is not thread‐safe.
On Windows, *libDir could be C:\Program Files\VMware\VMware Virtual Disk Development Kit.
On Linux, *libDir is probably /usr/lib/vmware-vix-disklib.
VixError vixErr = VixDiskLib_InitEx(majorVersion, minorVersion, &logFunc, &warnFunc, &panicFunc,
*libDir, *configFile);
Logged messages appear by default in a temporary folder or log directory, for VDDK and for many other
VMware products. See “Location of Log Files” on page 37.
The currently supported entries in the configFile are listed below. The correct way to specify a configuration
is name=value. See Example 4‐1 for a sample configuration file.
tmpDirectory = ""
vixDiskLib.transport.LogLevel – Overrides the default logging for vixDiskLib transport functions
(not including NFC). The default value is 6. The range is 0 to 6, where 6 is most verbose and 0 is quiet.
The following NFC related options override the default numbers provided to the various NFC functions.
Timeout values are stored in a 32‐bit field, so the maximum timeout you may specify is 2G (2,147,483,648).
VMware, Inc. 35