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

The PHT_VM_CONFIGURATION handle is used to manage the virtual machine configuration. The handle is obtained by calling the PrlVm_GetConfig function.

Functions
 
Name 
Description 
 
The PrlVmCfg_AddDefaultDevice function automates the task of setting devices in a virtual machine. 
 
The PrlVmCfg_AddDefaultDeviceEx function automates the task of setting devices in a virtual machine. 
 
Specify the Configuration sample file 
 
Creates a new handle of type PHT_BOOT_DEVICE and adds it to the specified virtual machine boot device list. 
 
Creates a new handle of type PHT_SHARE and adds it to the specified virtual machine list of shares. 
 
Creates a new virtual device handle of the specified type. 
 
Gets 3D graphical acceleration technology mode for the specified virtual machine. 
 
Obtains a handle of type PHT_ACCESS_RIGHTS
 
%VM_ONLY%
Determines the on-crash action for the specified virtual machine 
 
Gets action on stop mode. 
 
Determines the action on Virtuozzo Application window close for the specified virtual machine. 
 
Obtains a handles list of all virtual devices in a virtual machine. 
 
Returns the list of application templates installed for the specified Container. 
 
Determines the interval at which compacting virtual disks are doing by Automatic HDD compress. 
 
Determines if the specified virtual machine is set to start automatically on Virtuozzo Service startup. 
 
Returns the time delay used during the virtual machine automatic startup. 
 
Determines the mode of the automatic shutdown for the specified virtual machine. 
 
Determines the specified virtual machine background process priority type. 
 
Obtains a handle of type PHT_BOOT_DEVICE containing information about a specified device from the virtual machine boot device priority list. 
 
Determines the number of devices in the virtual machine boot device priority list. 
 
Returns a capabilities mask specified inside the CT. 
 
The PrlVmCfg_GetConfigValidity function returns an error code. 
 
Obtains a handles list of operations with virtual machine which required administrator confirmation 
 
Determines the virtual machine CPU acceleration level. 
 
Determines the number of CPUs in the virtual machine. 
 
Determines the CPU usage limit of a virtual machine, in percent. 
 
Determines the specified virtual machine CPU limit. 
 
Returns the specified virtual machine CPU affinity mask 
 
Determines the specified virtual machine CPU mode (32 bit or 64 bit). 
 
Determines the number of CPU units allocated to a virtual machine. 
 
Returns the Container id of the specified virtual machine. 
 
Returns the virtual machine custom property information. 
 
The PrlVmCfg_GetDefaultHddSize function returns the default hard disk size for to the specified OS type and version. 
 
The PrlVmCfg_GetDefaultMemSize function returns the default RAM size for to the specified OS type and version. 
 
The PrlVmCfg_GetDefaultVideoRamSize function returns the default video RAM size for the specified OS type and version. 
 
Returns the specified virtual machine description. 
 
Obtains a handle to a virtual device in a virtual machine according to the specified device type and index. 
 
Determines the total number of devices of any type installed in the virtual machine. 
 
Obtains the number of virtual devices of the specified type available in the specified virtual machine. 
 
Obtains a handle of type PHT_VIRTUAL_DEV_DISPLAY containing information about a display device in a virtual machine. 
 
Determines the number of display devices in a virtual machine. 
 
Obtains the list of of globally defined DNS servers which is assigned to a Virtuozzo Container. 
 
Returns an external boot device system name. 
 
Returns a features mask specified inside the CT. 
 
Obtains a handle of type PHT_VIRTUAL_DEV_FLOPPY containing information about the specified floppy disk drive in a virtual machine. 
 
Determines the number of floppy disk drives in a virtual machine. 
 
Returns foreground processes priority for the specified virtual machine. 
 
Determines the free disk space ratio at which compacting virtual disks are doing by Automatic HDD compress. 
 
Obtains a handle of type PHT_VIRTUAL_DEV_GENERIC_PCI containing information about a generic PCI device in a virtual machine. 
 
Determines the number of generic PCI devices in a virtual machine. 
 
Obtains a handle of type PHT_VIRTUAL_DEV_GENERIC_SCSI containing information about a generic SCSI device in a virtual machine. 
 
Determines the number of generic SCSI devices in a virtual machine. 
 
Determines the specified virtual machine CPU limit type. 
 
Obtains a handle of type PHT_VIRTUAL_DEV_HARD_DISK containing the specified virtual hard disk information. 
 
Determines the number of virtual hard disks in a virtual machine. 
 
Determines the priority of the virtual machine in the High Availability Cluster. 
 
Returns the virtual machine home directory name and path. 
 
Obtains the hostname of the specified virtual machine. 
 
Returns the name of the icon file used by the specified virtual machine. 
 
Determines the specified virtual machine I/O limit. 
 
Determines the specified virtual machine I/O priority. 
 
Determines the specified virtual machine IOPS limit. 
 
Returns the date and time when the specified virtual machine was last modified. 
 
Returns the name of the user who last modified the specified virtual machine. 
 
Returns the UUID (universally unique ID) of the parent virtual machine which was used to create current linked cloned virtual machine (if last one is linked clone of some virtual machine - this value will be empty otherwise). 
 
Returns the virtual machine files location type. 
 
Returns the minimum memory limit which is guaranteed for the virtual machine, in percent of guest RAM. 
 
Returns the name of the specified virtual machine. 
 
Obtains a handle of type PHT_VIRTUAL_DEV_NET_ADAPTER containing information about a virtual network adapter in a virtual machine. 
 
Determines the number of network adapters in a virtual machine. 
 
Returns netfilter mode specified inside the CT. 
 
Obtains the list of shaping rated 
 
Returns the specified virtual machine node mask 
 
Obtains the list of services available in the virtual machine offline management. 
 
Obtains a handle of type PHT_VIRTUAL_DEV_OPTICAL_DISK containing information a virtual optical disk in a virtual machine. 
 
Determines the number of optical disks in the specified virtual machine. 
 
Gets optimize modifiers mode. 
 
%VM_ONLY%
Determines the on-crash options for the specified virtual machine 
 
Returns Operation System template name the Virtuozzo Virtuozzo Container were created on. 
 
Returns the type of the operating system that the specified virtual machine is running. 
 
Returns the version of the operating system that the specified virtual machine is running. 
 
Obtains a handle of type PHT_VIRTUAL_DEV_PARALLEL_PORT containing information about a virtual printer port in the specified virtual machine. 
 
Determines the number of virtual printer ports in the specified virtual machine. 
 
Get current VM profile. 
 
Returns the virtual machine memory (RAM) size, in megabytes. 
 
Returns beancounters barrier and limit for specified resource id. 
 
Obtains the list of globally defined search domains that will be assigned to a virtual machine on the guest operating system side. 
 
Obtains a handle of type PHT_VIRTUAL_DEV_SERIAL_PORT containing information about a serial port in a virtual machine. 
 
Determines the number of serial ports in a virtual machine. 
 
Returns the hostname of the machine hosting the specified virtual machine. 
 
Returns the UUID of the machine hosting the specified virtual machine. 
 
Obtains a handle of type PHT_SHARE containing information about a shared folder. 
 
Determines the number of shared folders in a virtual machine. 
 
Determines the interval at which snapshots are taken by SmartGuard. 
 
Determines the maximum snapshot count, a SmartGuard setting. 
 
Obtains a handle of type PHT_VIRTUAL_DEV_SOUND containing information about a sound device in a virtual machine. 
 
Determines the number of sound devices in a virtual machine. 
 
Returns the automatic startup login mode for the specified virtual machine. 
 
Returns the user name used during the specified virtual machine automatic startup. 
 
Returns the virtual machine system flags. 
 
Obtains the time synchronization interval between the host and a guest OS. 
 
Determines the current undo-disks mode for the specified virtual machine. 
 
Returns the virtual machine uptime in seconds since some datetime (see PrlVmCfg_GetUptimeStartDate). 
 
Returns the date and time when uptime counter calculation was started for the specified virtual machine. 
 
Obtains a handle of type PHT_VIRTUAL_DEV_USB_DEVICE containing information about a USB device in a virtual machine. 
 
Determines the number of USB devices in a virtual machine. 
 
Returns the UUID (universally unique ID) of the specified virtual machine. 
 
Returns the video memory size of the specified virtual machine. 
 
Obtains a handle of type PHT_VM_INFO containing the specified virtual machine state and access rights information. 
 
Get the Virtual Machine type. 
 
Returns the VNC hostname of the specified virtual machine. 
 
Returns the VNC mode of the specified virtual machine. 
 
Returns the VNC password for the specified virtual machine. 
 
Returns the VNC port number for the specified virtual machine. 
 
Returns the VNC WebSocket port number for the specified virtual machine. 
 
Returns the current window mode the specified virtual machine is in. 
 
Determines disable or enable adaptive hypervisor. 
 
Determines whether select boot device should be shown on virtual machine startup. 
 
Determines if the Guest configured to automatically apply IP addrs network settings inside guest. 
 
Determines whether the Automatic HDD compress feature is enabled or not in a virtual machine. 
 
Determines disable or enable battery status. 
 
Determines whether the Virtuozzo application (such as Virtuozzo Desktop) will be automatically closed on the virtual machine shutdown. 
 
The PrlVmCfg_IsConfigInvalid function is used to check the
  • error code of PrlVmCfg_GetConfigValidity function that
  • indicates the invalid status of the config:
  • config doesn't exist, parsing error, invalid server uuid,
  • invalid VM uuid.
  • Parameters
  • nErrCode : The nErrCode value from PrlVmCfg_GetConfigValidity()
  • pbInvalid : [out] validity sign.
 
 
Determines whether the CPU hotplug is available in the virtual machine. 
 
Determines whether the x86 virtualization (such as Vt-x) is available in the virtual machine CPU. 
 
Determines were settings modified after profile was applied or not. 
 
Determines whether the virtual machine requires a default device of the specified type if it's going to run an operating system of the specified type. 
 
Determines whether the APIC is enabled or disabled during the virtual machine runtime. 
 
Determines whether the speaker is enabled or disabled during the virtual machine runtime. 
 
Determines if disk cache write-back is enabled in the specified virtual machine. 
 
Determines whether EFI boot is switched on. 
 
Determines if host shared folders are mounted automatically in a given virtual machine. 
 
Determines if guest sharing is enabled (the guest OS disk drives are visible in the host OS). 
 
Determines if the virtual disks in a virtual machine will be added to Spotlight search subsystem (Mac OS X feature). 
 
Determines whether the High Availability feature is enabled or not for a virtual machine. 
 
Determines if host sharing is enabled (host shared folders are visible in the guest OS). 
 
Determines disable or enable isolated VM. 
 
Determines disable or enable lock guest on suspend. 
 
Determines whether the lock in screen mode sign is set or not in a virtual machine configuration. 
 
Determines disable or enable longer battery life. 
 
Determines whether host disks shared with the guest Windows OS will be mapped to drive letters. 
 
Determines disable or enable nested virtualization. 
 
Determines whether the offline management feature is enabled for a virtual machine. 
 
Determines wether the virtual machine OS resolution is in full screen mode. 
 
Determines disable or enable PMU virtualization. 
 
Determines whether the memory (RAM) hotplug is available in the virtual machine. 
 
Determines whether the ratebound is enabled or not. 
 
Determines if additional screen resolution support is enabled in a virtual machine. 
 
Determines whether all host disks will be present at guest OS as shares. 
 
Determines whether the clipboard sharing feature is enabled or disabled in a virtual machine. 
 
Determines whether the Shared Profile feature is enabled in a virtual machine. 
 
Determines whether the host user home directory will be available in the guest OS as a share. 
 
Determines whether the SmartGuard feature is enabled or not in a virtual machine. 
 
Determines whether the user will be notified on automatic snapshot creation, a SmartGaurd setting. 
 
Determines whether the SmartMount CD/DVD drives is enabled or not. 
 
Determines whether the SmartMount feature is enabled or not. 
 
Determines whether the SmartMount network shares is enabled or not. 
 
Determines whether the SmartMount removable drives is enabled or not. 
 
Determines disable or enable start in detached window. 
 
Determines disable or enable Windows logo. 
 
Determines if the specified virtual machine object contains a virtual machine or a template configuration information. 
 
Determines whether the time synchronization feature is enabled in a virtual machine. 
 
Determines whether the smart time synchronization is enabled in a virtual machine. 
 
Enables or disables the Virtuozzo Tools AutoUpdate feature for a virtual machine. 
 
Determines whether the use default answers mechanism active for the virtual machine. 
 
Determines whether the "use desktop in shared profile" feature is enabled or not. 
 
Determines whether "use documents in shared profile" feature is enabled or not. 
 
Determines whether the "used downloads in shared profile" feature is enabled or not. 
 
Determines whether the "used movies in shared profile" feature is enabled or not. 
 
Determines whether the "use music in shared profile" feature is enabled or not. 
 
Determines whether the "used pictures in shared profile" feature is enabled or not. 
 
Determines whether the user-defined shared folders are enabled or not. 
 
Determines if VNC is encrypted. 
 
Sets 3D graphical acceleration technology mode for the specified virtual machine. 
 
%VM_ONLY%
Allows to set the on-crash action for the specified virtual machine 
 
Sets action on stop mode. 
 
Allows to set the action on Virtuozzo Application window close for the specified virtual machine. 
 
Disables or enables adaptive hypervisor. 
 
Switches on/off select boot device dialog on virtual machine startup. 
 
Specify application templates list which will be used in the specified Virtuozzo Virtuozzo Container. 
 
Allows to specify whether a virtual machine should be automatically configured for IP addrs. 
 
Enables the Automatic HDD compress feature in a virtual machine. 
 
Sets the time interval at which compacting virtual disks are doing by Automatic HDD compress. 
 
Allows to sets the automatic startup option for the specified virtual machine. 
 
Sets the time delay that will be used during the virtual machine automatic startup. 
 
Allows to set the automatic shutdown mode for the specified virtual machine. 
 
Sets the virtual machine background processes priority. 
 
Disables or enables battery status. 
 
Sets a capabilities inside the CT. 
 
Allows to specify whether the Virtuozzo application (such Virtuozzo Desktop) will be closed on the virtual machine shutdown. 
 
Determines a list of operations with virtual machine which required administrator confirmation 
 
Sets CPU acceleration level for the specified virtual machine. 
 
Sets the number of CPUs for the specified virtual machine (the CPUs should be present in the machine). 
 
Sets CPU hotplug mode (enabled or disabled) for the specified virtual machine. 
 
Sets the CPU usage limit (in percent) for a virtual machine. 
 
Sets limit of CPU usage for the virtual machine in Mhz. 
 
Sets the CPU affinity for a virtual machine. 
 
Sets CPU mode (32 bit or 64 bit) for the specified virtual machine. 
 
Sets the number of CPU units that will be allocated to a virtual machine. 
 
Sets the virtual machine custom property information. 
 
The PrlVmCfg_SetDefaultConfig function selects a default configuration for a new virtual machine based on the operating system that the virtual machine will be running. 
 
Sets the virtual machine description. 
 
Allows to specify whether the virtual machine should be using APIC during runtime. 
 
Allows to specify whether the virtual machine should be using speaker during runtime. 
 
Sets the virtual machine disk cache write-back option. 
 
Allows to manually assign DNS servers a virtual machine. 
 
Sets EFI boot for the virtual machine. 
 
Sets an external boot device system name. 
 
Sets a features inside the CT. 
 
Sets the virtual machine foreground processes priority. 
 
Sets the time free disk space ratio at which compacting virtual disks are doing by Automatic HDD compress. 
 
Sets the guest OS sharing auto-mount option. 
 
Enables the guest sharing feature. 
 
Sets the VM virtual disks added to Spotlight search subsystem sign. 
 
Enables or disables the High Availability feature for a virtual machine. 
 
Sets the priority of the virtual machine in the High Availability Cluster. 
 
Sets the specified virtual machine hostname. 
 
Enables host sharing for the specified virtual machine. 
 
Sets the virtual machine icon. 
 
Sets limit of I/O usage for the virtual machine in Bytes/s. 
 
Sets the specified virtual machine I/O priority. 
 
Sets the specified virtual machine IOPS limit. 
 
Disables or enables shared camera isolated VM. 
 
Disables or enables shared camera lock guest on suspend. 
 
Enables or disables the lock in screen mode feature in a virtual machine configuration. 
 
Disables or enables longer battery life. 
 
Enables mapping of shared host disks on drive letters for the specified virtual machine. 
 
Sets the minimum memory limit which is guaranteed for the virtual machine, in percent of guest RAM. 
 
Sets the specified virtual machine name. 
 
Disables or enables nested virtualization. 
 
Allows to set netfilter mode inside the CT. 
 
Add the specified rates list to the Vm configuration. 
 
Sets the NUMA node mask for a virtual machine. 
 
Enables or disables the offline management feature for a virtual machine. 
 
Allows to manually set offline services that will be available in the virtual machine offline management. 
 
Sets optimize modifiers mode. 
 
%VM_ONLY%
Allows to set the on-crash options for the specified virtual machine 
 
Sets the virtual machine OS resolution in full screen mode option. 
 
Specify the Virtual Machine Operation System template name which will be used to create new Virtuozzo Virtuozzo Container. 
 
Sets the virtual machine guest OS version. 
 
Disables or enables PMU virtualization. 
 
Set one of predefined VM profiles. 
 
Sets the virtual machine memory (RAM) hotplug mode (enabled or disabled). 
 
Sets the virtual machine memory (RAM) size. 
 
Sets the ratebound flag. 
 
Sets barrier and limit for various user beancounters. 
 
Enables or disables the additional screen resolution support in a virtual machine. 
 
Allows to manually set the global search domain list that will be assigned to the Virtuozzo Container. 
 
Enables sharing of all host disks for the specified virtual machine. 
 
Enables or disables the clipboard sharing feature. 
 
Enables or disables the Shared Profile feature in a virtual machine. 
 
Enables or disables sharing of the host user home directory in the specified virtual machine. 
 
Enables the SmartGuard feature in a virtual machine. 
 
Sets the time interval at which snapshots are taken by SmartGuard. 
 
Sets the maximum snapshot count, a SmartGuard feature. 
 
Enables or disables notification of automatic snapshot creation, a SmartGuard feature. 
 
Enables or disables the SmartMount CD/DVD drives. 
 
Enables or disables the SmartMount feature. 
 
Enables or disables the SmartMount network shares. 
 
Enables or disables the SmartMount removable drives. 
 
Disables or enables start in detached window. 
 
Allows to set the automatic startup login mode for the specified virtual machine. 
 
Allows to set the automatic startup user login and password for the specified virtual machine. 
 
Disables or enables Windows logo. 
 
Sets the virtual machine system flags. 
 
Allows to modify a regular virtual machine to become a template, and vise versa. 
 
Enables or disables the time synchronization feature in a virtual machine. 
 
Allows to set the time interval at which the time in the virtual machine will be synchronized with the time in the host OS. 
 
Enables or disables the smart time-synchronization mode in a virtual machine. 
 
Enables or disables the Virtuozzo Tools AutoUpdate feature for a virtual machine. 
 
Sets the undo-disks mode for the virtual machine. 
 
Enables the use default answers mechanism in a virtual machine. 
 
Enables or disables the "undo-desktop" feature in the shared profile. 
 
Lets to set use documents in shared profile enabling sign. 
 
Lets to set use downloads in shared profile enabling sign. 
 
Lets to set use movies in shared profile enabling sign. 
 
Lets to set use music in shared profile enabling sign. 
 
Lets to set use pictures in shared profile enabling sign. 
 
Enables or disables user-defined shared folders. 
 
Sets the virtual machine UUID (universally unique ID). 
 
Sets the virtual machine video memory size. 
 
Specify the Virtual Machine type on create action. 
 
Sets the virtual machine VNC host name. 
 
Sets the virtual machine VNC mode. 
 
Sets the virtual machine VNC password. 
 
Sets the virtual machine VNC port number. 
 
Sets the virtual machine window mode. 
Links
Copyright ©2016-2017 Parallels International GmbH. All rights reserved.