Collapse All
Parallels Virtualization SDK
ContentsIndex
PreviousUpNext
PHT_DISP_CONFIG
Functions  Functions by Handle  Legend

The PHT_DISP_CONFIG handle is used to manage Parallels Service preferences. The handle is obtained by calling the PrlSrv_GetCommonPrefs function.

Description

Parallels Service preferences include memory, network, default virtual machine folder, and some other settings. The following describes how to modify the memory and network settings as a demonstration of the handle usage. 

First, you have to obtain a handle of type PHT_DISP_CONFIG by making the PrlSrv_GetCommonPrefs function call. 

To make the memory modification:

  1. Call PrlSrv_CommonPrefsBeginEdit to mark the beginning of the operation.
  2. Call one or more of the memory management functions from the PHT_DISP_CONFIG group to modify the desired settings.
  3. Call PrlSrv_CommonPrefsCommit to save the changes to the Parallels Service configuration.

The network adapter changes are performed outside of the begin/commit block. To modify an existing or to create a new virtual network adapter, use the following steps:

  1. First, obtain a handle of type PHT_DISP_NET_ADAPTER by calling the PrlDispCfg_GetDispNet or the PrlDispCfg_CreateDispNet function. The first function obtains a handle to an existing adapter and is used when modifying an adapter. The second function creates and returns a new handle and is used when adding a new virtual adapter to the Parallels Service configuration.
  2. Populate or modify the necessary network adapter properties using functions from the PHT_DISP_NET_ADAPTER group.
  3. If you are creating a new adapter, call PrlSrv_AddNetAdapter to add the adapter to the Parallels Service configuration. If you are modifying an existing adapter, call PrlSrv_UpdateNetAdapter to save the changes. If you would like to delete an adapter from the Parallels Service configuration, call the PrlSrv_DeleteNetAdapter function.
Functions
 
Name 
Description 
 
Determines whether the plugins enabled or not 
 
Determines if new users have the right to modify Parallels Service preferences. 
 
Creates a new virtual network adapter object and adds it to the network adapters list. 
 
Enable or disable the plugins support 
 
Client can use this method to set dispatcher configuration to dispatcher config handle This method must be eliminated at Release stage
@param valid PRL_HANDLE @param XML configuration string @return PRL_RESULT
 
Get backup timeout in seconds. 
 
Returns the backup temporary directory. 
 
Returns the backup user login. 
 
Obtains a handles list of operations which required administrator confirmation ( for all users and for all virtual machines( if operation is applicable to vm) ) 
 
To get the CPU features masks from dispatcher config hDispConfig : A handle of type PHT_DISP_CONFIG. 
 
Returns PATH to the default backup directory. 
 
Returns the default backup server host name or IP address. 
 
Obtains path of the directory in which new Container are created by default. 
 
Returns default encryption plugin Id. 
 
Obtains name and path of the directory in which new virtual machines are created by default. 
 
Obtains information about a virtual network adapter from the Parallels Service configuration. 
 
Determines the total number of the virtual network adapters in the Parallels Service configuration. 
 
Get mobile host id. 
 
Get internal license request parameters. 
 
Determines the maximum amount of physical memory that can be reserved for Parallels Service operation. 
 
Determines the maximum memory size that can be allocated to an individual virtual machine. 
 
Determines the minimum amount of physical memory that must be reserved for Parallels Service operation. 
 
Determines the lowest allowable security level that can be used to connect to the Parallels Service. 
 
Determines the minimum required memory size that must be allocated to an individual virtual machine. 
 
Get the advanced authorization mode for Parallels Access clients. 
 
Obtains a handles list of operations which require custom password ( for all users and for all virtual machines( if operation is applicable to vm) ) 
 
Determines proxy connection status or error code of last proxy operation. 
 
Returns the name of user associated with current proxy connection. 
 
Get proxy manager URL string. 
 
Determines the recommended memory size for an individual virtual machine. 
 
Determines the amount of physical memory reserved for Parallels Service operation. 
 
Gets USB autoconnect devices option. 
 
Returns handle of type PHT_USB_IDENTITY storing information of USB device with specified index. 
 
Determines number of USB devices known to the Parallels Service. 
 
Get web portal domain. 
 
Determines whether memory allocation for Parallels Service is performed automatically or manually. 
 
Determines whether the allow attach screenshots is enabled for problem report. 
 
Determines whether the Allow Direct Mobile Connections option is enabled. 
 
Determines whether the Allow Mobile Clients option is enabled. 
 
Determines whether the Allow Multiple PMC option is enabled. 
 
Returns the backup user password enabling sign. 
 
Determines whether Parallels product operates in cluster mode. 
 
Determines whether the feature service headless mode is enabled. 
 
Determines whether the settings is locked for editing 
 
Determines whether the log rotation is enabled for dispatcher and virtual machine logs. 
 
Determines whether dispatcher should connect to the mobile proxy server by default. 
 
Determines whether send statistics reports (CEP) mechanism activated. 
 
Determines whether the verbose log level is configured for dispatcher and virtual machines processes. 
 
Allows to choose the Parallels Service memory allocation mode from automatic or manual. 
 
Enables or disables the allow attach screenshots for problem report. 
 
Enables or disables the Allow Direct Mobile option. 
 
Enables or disables the Allow Multiple PMC option. 
 
Set backup timeout in seconds. 
 
Sets the backup temporary directory. 
 
Sets the backup user login. 
 
Sets the backup user password. 
 
Sets the backup user password. 
 
Allows to grant or deny a permission to new users to modify Parallels Service preferences. 
 
Allows to activate/deactivate cluster mode. 
 
Obtains a handles list of operations which required administrator confirmation ( for all users and for all virtual machines( if operation is applicable to vm) ) 
 
Allows to set the CPU features masks. 
 
Allows to set the CPU features masks. 
 
Sets PATH to the default backup directory. 
 
Sets the default backup server host name or IP address. 
 
Sets default encryption plugin Id. 
 
Enables or disables the feature service headless mode. 
 
Set user-defined mobile host id. 
 
Setup internal license request parameters. 
 
Enables or disables the log rotation for dispatcher and virtual machine logs. 
 
Allows to manually set the upper limit of the memory size that can be reserved for Parallels Service operation. 
 
Allows to set the maximum memory size that can be allocated to an individual virtual machine. 
 
Allows to manually set the lower limit of the memory size that must be reserved for Parallels Service operation. 
 
Allows to set the lowest allowable security level that can be used to connect to the specified Parallels Service. 
 
Allows to set the minimum required memory size that must be allocated to an individual virtual machine. 
 
Set the advanced authorization mode for Parallels Access clients. 
 
Sets list of operations which require custom password ( for all users and for all virtual machines( if operation is applicable to vm) ) 
 
Specifies credentials for establishing a proxy connection. 
 
Set proxy manager URL string. 
 
Allows to manually set recommended memory size for an individual virtual machine. 
 
Allows to set the amount of memory that will be allocated for Parallels Service operation. 
 
Allows to switch on/off mechanism of sending statistics reports (CEP). 
 
Sets USB autoconnect devices option. 
 
(Un)Associates USB device with given Vm. 
 
(Un)Associates USB device with given Action and possibly Vm. 
 
Enables or disables the verbose log level for dispatcher and virtual machines processes. 
 
Set web portal domain. 
 
Client can use this method to get dispatcher configuration from disp config handle as XML string This method must be eliminated at Release stage
@param valid PRL_HANDLE @param XML configuration string @return PRL_RESULT
Links
© 2021 Parallels International GmbH. All rights reserved.