Collapse All
Parallels C API Reference Guide
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.
Enable or disable the plugins support
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) )
Returns PATH to the default backup directory.
Returns the default backup server host name or IP address.
Returns default encryption plugin Id.
Obtains name and path of the directory in which new virtual machines are created by default.
Returns the default VNC host name for the Parallels Service.
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.
Determines the recommended memory size for an individual virtual machine.
Determines the amount of physical memory reserved for Parallels Service operation.
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.
Obtains the currently set base VNC port number.
Determines whether memory allocation for Parallels Service is performed automatically or manually.
Returns the backup user password enabling sign.
Determines whether Parallels product operates in cluster mode.
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.
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) )
Sets PATH to the default backup directory.
Sets the default backup server host name or IP address.
Sets default encryption plugin Id.
Sets the base VNC host name.
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.
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).
(Un)Associates USB device with given Vm.
Enables or disables the verbose log level for dispatcher and virtual machines processes.
Sets the base VNC port number.
Links
Copyright © 1999-2011 Parallels Holdings, Ltd. and its affiliates. All rights reserved.
What do you think about this topic? Send feedback!