Collapse All
Virtuozzo Virtualization SDK C API Reference
ContentsIndex
PreviousUpNext
PHT_VIRTUAL_MACHINE
Functions  Functions by Handle  Legend

PHT_VIRTUAL_MACHINE is the main virtual machine management handle. A handle to an existing virtual machine is obtained from the PHT_JOB object returned by the PrlSrv_GetVmList function. To create a new handle, call the PrlSrv_CreateVm function.

Functions
 
Name 
Description 
 
Reinstall Container Recreates Container's root virtual disk, installs all applications previously installed from application templates, copies credentials from the old container (unless the REINSTALL_RESET_PWDB flag is specified), and renames the old root directory '/' to '/old' (unless the REINSTALL_SKIP_BACKUP flag is specified). 
 
Performs an attempt to authenticate the user through the guest OS security database. 
 
The PrlVm_BeginEdit function is used in modifying a virtual machine configuration. 
 
Finishes process of optimization of virtual hard disk. 
 
Finishes process of conversion of the virtual hard disk(s). 
 
%VM_ONLY%
Captures a screen area of a remote virtual machine desktop in PNG format, scales is down to the specified size, and puts it into a buffer which is then returned to the client. 
 
Generates and assigns a new Windows SID to the specified virtual machine running Windows guest OS. 
 
Clones an existing virtual machine. 
 
Clones an existing virtual machine. 
 
Clones an existing virtual machine. 
 
The PrlVm_Commit function is used in modifying a virtual machine configuration. 
 
The PrlVm_CommitEncryption function is used in modifying a virtual machine disk encryption configuration. 
 
The PrlVm_CommitEx function is the same as PrlVm_Commit function but with the flags 
 
Start process of optimization of virtual hard disk. 
 
Connect to remote desktop. 
 
Start process conversion of the virtual hard disk(s). 
 
Creates VM event that bint to current VM. 
 
Creates a virtual machine snapshot. 
 
Creates a virtual machine snapshot. 
 
Creates a floppy disk image in the virtual machine home directory for unattended Windows installation. 
 
Deletes the specified virtual machine from the host. 
 
Deleted the specified virtual machine snapshot. 
 
Disconnect from remote desktop. 
 
Resets a suspended virtual machine. 
 
Automatically generates a name for a virtual device which will be unique within a home directory of the specified virtual machine. 
 
Obtains a handle of type PHT_VM_CONFIGURATION
 
The PrlVm_GetPackedProblemReport function obtains a Packed problem report on abnormal virtual machine termination. 
 
Obtains a handle of type PHT_EVENT containing the virtual machine performance statistics. 
 
The PrlVm_GetProblemReport function obtains a problem report on abnormal virtual machine termination. 
 
The PrlVm_GetQuestions function allows to synchronously receive questions from a Virtuozzo Service. 
 
Retrieves snapshot information for the specified virtual machine. 
 
 
 
Obtains a handle of type PHT_VM_INFO containing the specified virtual machine state and access rights information. 
 
Obtains a handle of type PHT_SYSTEM_STATISTICS containing the virtual machine resource usage information, including CPU(s), memory, disk drives, processes, user session, system uptime, network packets, etc. 
 
The PrlVm_GetStatisticsEx function is the same as PrlVm_GetStatistics function but with the flags 
 
Retrieves the virtual machine screen state before it was suspending. 
 
Obtains a handle of type PHT_VM_TOOLS_INFO containing information about the state of the Virtuozzo Tools package in a virtual machine. 
 
This method lets to initiate sending notifications about devices states by VM. 
 
Begin the Virtuozzo Tools installation process. 
 
Lets to exclusively lock VM for current session. 
 
Creates a new console session or binds to an existing GUI session in a virtual machine. 
 
Migrates an existing virtual machine to another host. 
 
Cancels the migration operation that was started with PrlVm_Migrate or PrlVm_MigrateEx
 
Migrates an existing virtual machine to another host. 
 
Migrates an existing virtual machine to another host. 
 
Migrates an existing virtual machine to another host. 
 
Mount the specified virtual machine Virtual Disks. 
 
Move bundle of virtual machine or private area of container. 
 
Pauses the specified virtual machine. 
 
The PrlVm_RefreshConfig function updates the configuration information contained in the specified virtual machine object (handle). 
 
The PrlVm_RefreshConfigEx function updates the configuration information contained in the specified virtual machine object (handle). 
 
See also PrlVm_RegEx 
 
Registers an event handler (callback function) with the virtual machine. 
 
Creates a new virtual machine and registers it with the Virtuozzo Service. 
 
Resets the specified virtual machine. 
 
Resets the virtual machine uptime counter (start date and counter itself). 
 
Restarts the operating system of the specified virtual machine. 
 
Restores the registered virtual machine. 
 
Resumes a virtual machine that was previously suspended with the PrlVm_Suspend call. 
 
The PrlVm_SetConfig is reserved and does nothing. 
 
Allows to change the password of a guest operating system user. 
 
Start the specified virtual machine. 
 
Starts the specified virtual machine using the specified mode (see the PRL_VM_START_MODE enumeration). 
 
Starts a VNC server for the specified virtual machine. 
 
Stop the specified virtual machine. 
 
Stop the specified virtual machine. 
 
Stops the VNC server that was previously started for a virtual machine. 
 
Subscribes to receive the specified virtual machine performance statistics on a periodic basis. 
 
Allows to subscribe to periodicaly receive virtual machine perfomance statistics. 
 
Suspends the specified virtual machine. 
 
Reverts the specified virtual machine to the specified snapshot. 
 
Reverts the specified virtual machine to the specified snapshot. 
 
Unmount the specified virtual machine Virtual Disks. 
 
Lets to unlock previously locked with PrlVm_Lock call VM. 
 
Unregisters the specified virtual machine from the Virtuozzo Service. 
 
Unregisters an event handler (callback function) that was previously registered using the PrlVm_RegEventHandler function. 
 
Cancels the performance statistics subscription that was previously initiated using the PrlVm_SubscribeToGuestStatistics function. 
 
Cancels the Virtuozzo Service performance statistics subscription that was started using the PrlVm_SubscribeToPerfStats function. 
 
Updates access level for the specified virtual machine. 
 
Modifies the specified virtual machine snapshot name and description. 
 
Validates the specified section of a virtual machine configuration. 
 
Determines disable or enable high resolution video mode for the specified virtual machine. 
 
Determines disable or enable vertical synchronization video mode for the specified virtual machine. 
 
Disables or enables high resolution video mode for the specified virtual machine. 
 
Disables or enables vertical synchronization video mode for the specified virtual machine. 
Links
Copyright ©2016-2017 Parallels International GmbH. All rights reserved.