PHT_DISP_CONFIG

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:

Call PrlSrv_CommonPrefsBeginEdit to mark the beginning of the operation.
Call one or more of the memory management functions from the PHT_DISP_CONFIG group to modify the desired settings.
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:

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.
Populate or modify the necessary network adapter properties using functions from the PHT_DISP_NET_ADAPTER group.
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
	PrlDispCfg_ArePluginsEnabled	Determines whether the plugins enabled or not
	PrlDispCfg_CanChangeDefaultSettings	Determines if new users have the right to modify Parallels Service preferences.
	PrlDispCfg_CreateDispNet	Creates a new virtual network adapter object and adds it to the network adapters list.
	PrlDispCfg_EnablePlugins	Enable or disable the plugins support
	PrlDispCfg_FromString	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.
	PrlDispCfg_GetBackupTimeout	Get backup timeout in seconds.
	PrlDispCfg_GetBackupTmpDir	Returns the backup temporary directory.
	PrlDispCfg_GetBackupUserLogin	Returns the backup user login.
	PrlDispCfg_GetConfirmationsList	Obtains a handles list of operations which required administrator confirmation ( for all users and for all virtual machines( if operation is applicable to vm) )
	PrlDispCfg_GetCpuFeaturesMask	To get the CPU features masks from dispatcher config hDispConfig : A handle of type PHT_DISP_CONFIG.
	PrlDispCfg_GetDefaultBackupDirectory	Returns PATH to the default backup directory.
	PrlDispCfg_GetDefaultBackupServer	Returns the default backup server host name or IP address.
	PrlDispCfg_GetDefaultCtDir	Obtains path of the directory in which new Container are created by default.
	PrlDispCfg_GetDefaultEncryptionPluginId	Returns default encryption plugin Id.
	PrlDispCfg_GetDefaultVmDir	Obtains name and path of the directory in which new virtual machines are created by default.
	PrlDispCfg_GetDispNet	Obtains information about a virtual network adapter from the Parallels Service configuration.
	PrlDispCfg_GetDispNetCount	Determines the total number of the virtual network adapters in the Parallels Service configuration.
	PrlDispCfg_GetHostId	Get mobile host id.
	PrlDispCfg_GetLicenseRequestFlags	Get internal license request parameters.
	PrlDispCfg_GetMaxReservMemLimit	Determines the maximum amount of physical memory that can be reserved for Parallels Service operation.
	PrlDispCfg_GetMaxVmMem	Determines the maximum memory size that can be allocated to an individual virtual machine.
	PrlDispCfg_GetMinReservMemLimit	Determines the minimum amount of physical memory that must be reserved for Parallels Service operation.
	PrlDispCfg_GetMinSecurityLevel	Determines the lowest allowable security level that can be used to connect to the Parallels Service.
	PrlDispCfg_GetMinVmMem	Determines the minimum required memory size that must be allocated to an individual virtual machine.
	PrlDispCfg_GetMobileAdvancedAuthMode	Get the advanced authorization mode for Parallels Access clients.
	PrlDispCfg_GetPasswordProtectedOperationsList	Obtains a handles list of operations which require custom password ( for all users and for all virtual machines( if operation is applicable to vm) )
	PrlDispCfg_GetProxyConnectionStatus	Determines proxy connection status or error code of last proxy operation.
	PrlDispCfg_GetProxyConnectionUser	Returns the name of user associated with current proxy connection.
	PrlDispCfg_GetProxyManagerURL	Get proxy manager URL string.
	PrlDispCfg_GetRecommendMaxVmMem	Determines the recommended memory size for an individual virtual machine.
	PrlDispCfg_GetReservedMemLimit	Determines the amount of physical memory reserved for Parallels Service operation.
	PrlDispCfg_GetUsbAutoConnectOption	Gets USB autoconnect devices option.
	PrlDispCfg_GetUsbIdentity	Returns handle of type PHT_USB_IDENTITY storing information of USB device with specified index.
	PrlDispCfg_GetUsbIdentityCount	Determines number of USB devices known to the Parallels Service.
	PrlDispCfg_GetWebPortalDomain	Get web portal domain.
	PrlDispCfg_IsAdjustMemAuto	Determines whether memory allocation for Parallels Service is performed automatically or manually.
	PrlDispCfg_IsAllowAttachScreenshotsEnabled	Determines whether the allow attach screenshots is enabled for problem report.
	PrlDispCfg_IsAllowDirectMobile	Determines whether the Allow Direct Mobile Connections option is enabled.
	PrlDispCfg_IsAllowMobileClients	Determines whether the Allow Mobile Clients option is enabled.
	PrlDispCfg_IsAllowMultiplePMC	Determines whether the Allow Multiple PMC option is enabled.
	PrlDispCfg_IsBackupUserPasswordEnabled	Returns the backup user password enabling sign.
	PrlDispCfg_IsClusterMode	Determines whether Parallels product operates in cluster mode.
	PrlDispCfg_IsHeadlessModeEnabled	Determines whether the feature service headless mode is enabled.
	PrlDispCfg_IsLockedSign	Determines whether the settings is locked for editing
	PrlDispCfg_IsLogRotationEnabled	Determines whether the log rotation is enabled for dispatcher and virtual machine logs.
	PrlDispCfg_IsProxyEnabled	Determines whether dispatcher should connect to the mobile proxy server by default.
	PrlDispCfg_IsSendStatisticReport	Determines whether send statistics reports (CEP) mechanism activated.
	PrlDispCfg_IsVerboseLogEnabled	Determines whether the verbose log level is configured for dispatcher and virtual machines processes.
	PrlDispCfg_SetAdjustMemAuto	Allows to choose the Parallels Service memory allocation mode from automatic or manual.
	PrlDispCfg_SetAllowAttachScreenshotsEnabled	Enables or disables the allow attach screenshots for problem report.
	PrlDispCfg_SetAllowDirectMobile	Enables or disables the Allow Direct Mobile option.
	PrlDispCfg_SetAllowMultiplePMC	Enables or disables the Allow Multiple PMC option.
	PrlDispCfg_SetBackupTimeout	Set backup timeout in seconds.
	PrlDispCfg_SetBackupTmpDir	Sets the backup temporary directory.
	PrlDispCfg_SetBackupUserLogin	Sets the backup user login.
	PrlDispCfg_SetBackupUserPassword	Sets the backup user password.
	PrlDispCfg_SetBackupUserPasswordEnabled	Sets the backup user password.
	PrlDispCfg_SetCanChangeDefaultSettings	Allows to grant or deny a permission to new users to modify Parallels Service preferences.
	PrlDispCfg_SetClusterMode	Allows to activate/deactivate cluster mode.
	PrlDispCfg_SetConfirmationsList	Obtains a handles list of operations which required administrator confirmation ( for all users and for all virtual machines( if operation is applicable to vm) )
	PrlDispCfg_SetCpuFeaturesMask	Allows to set the CPU features masks.
	PrlDispCfg_SetCpuFeaturesMaskEx	Allows to set the CPU features masks.
	PrlDispCfg_SetDefaultBackupDirectory	Sets PATH to the default backup directory.
	PrlDispCfg_SetDefaultBackupServer	Sets the default backup server host name or IP address.
	PrlDispCfg_SetDefaultEncryptionPluginId	Sets default encryption plugin Id.
	PrlDispCfg_SetHeadlessModeEnabled	Enables or disables the feature service headless mode.
	PrlDispCfg_SetHostId	Set user-defined mobile host id.
	PrlDispCfg_SetLicenseRequestFlags	Setup internal license request parameters.
	PrlDispCfg_SetLogRotationEnabled	Enables or disables the log rotation for dispatcher and virtual machine logs.
	PrlDispCfg_SetMaxReservMemLimit	Allows to manually set the upper limit of the memory size that can be reserved for Parallels Service operation.
	PrlDispCfg_SetMaxVmMem	Allows to set the maximum memory size that can be allocated to an individual virtual machine.
	PrlDispCfg_SetMinReservMemLimit	Allows to manually set the lower limit of the memory size that must be reserved for Parallels Service operation.
	PrlDispCfg_SetMinSecurityLevel	Allows to set the lowest allowable security level that can be used to connect to the specified Parallels Service.
	PrlDispCfg_SetMinVmMem	Allows to set the minimum required memory size that must be allocated to an individual virtual machine.
	PrlDispCfg_SetMobileAdvancedAuthMode	Set the advanced authorization mode for Parallels Access clients.
	PrlDispCfg_SetPasswordProtectedOperationsList	Sets list of operations which require custom password ( for all users and for all virtual machines( if operation is applicable to vm) )
	PrlDispCfg_SetProxyConnectionCreds	Specifies credentials for establishing a proxy connection.
	PrlDispCfg_SetProxyManagerURL	Set proxy manager URL string.
	PrlDispCfg_SetRecommendMaxVmMem	Allows to manually set recommended memory size for an individual virtual machine.
	PrlDispCfg_SetReservedMemLimit	Allows to set the amount of memory that will be allocated for Parallels Service operation.
	PrlDispCfg_SetSendStatisticReport	Allows to switch on/off mechanism of sending statistics reports (CEP).
	PrlDispCfg_SetUsbAutoConnectOption	Sets USB autoconnect devices option.
	PrlDispCfg_SetUsbIdentAssociation	(Un)Associates USB device with given Vm.
	PrlDispCfg_SetUsbIdentAssociationWithAction	(Un)Associates USB device with given Action and possibly Vm.
	PrlDispCfg_SetVerboseLogEnabled	Enables or disables the verbose log level for dispatcher and virtual machines processes.
	PrlDispCfg_SetWebPortalDomain	Set web portal domain.
	PrlDispCfg_ToString	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

Functions, Functions by Handle, Legend