Package prlsdkapi :: Class DispConfig
[hide private]
[frames] | no frames]

Class DispConfig

object --+    
         |    
   _Handle --+
             |
            DispConfig

Provides methods for managing Parallels Service preferences.

Instance Methods [hide private]
 
get_default_vm_dir(self)
Obtain name and path of the directory in which new virtual machines are created by default.
 
get_reserved_mem_limit(self)
Determine the amount of physical memory reserved for Parallels Service operation.
 
set_reserved_mem_limit(self, nMemSize)
Set the amount of memory that will be allocated for Parallels Service operation.
 
get_min_vm_mem(self)
Determine the minimum required memory size that must be allocated to an individual virtual machine.
 
set_min_vm_mem(self, nMemSize)
Set the minimum required memory size that must be allocated to an individual virtual machine.
 
get_max_vm_mem(self)
Determine the maximum memory size that can be allocated to an individual virtual machine.
 
set_max_vm_mem(self, nMemSize)
Set the maximum memory size that can be allocated to an individual virtual machine.
 
get_recommend_max_vm_mem(self)
Determine the recommended memory size for an individual virtual machine.
 
set_recommend_max_vm_mem(self, nMemSize)
Set recommended memory size for an individual virtual machine.
 
get_max_reserv_mem_limit(self)
Return the maximum amount of memory that can be reserved for Parallels Service operation.
 
set_max_reserv_mem_limit(self, nMemSize)
Set the upper limit of the memory size that can be reserved for Parallels Service operation.
 
get_min_reserv_mem_limit(self)
Return the minimum amount of physical memory that must be reserved for Parallels Service operation.
 
set_min_reserv_mem_limit(self, nMemSize)
Set the lower limit of the memory size that must be reserved for Parallels Service operation.
 
is_adjust_mem_auto(self)
Determine whether memory allocation for Parallels Service is performed automatically or manually.
 
set_adjust_mem_auto(self, bAdjustMemAuto)
Set the Parallels Service memory allocation mode (automatic or manual).
 
is_send_statistic_report(self)
Determine whether the statistics reports (CEP) mechanism is activated.
 
set_send_statistic_report(self, bSendStatisticReport)
Turn on/off the mechanism of sending statistics reports (CEP).
 
get_default_vnchost_name(self)
Return the default VNC host name for the Parallels Service.
 
set_default_vnchost_name(self, sNewHostName)
Set the base VNC host name.
 
get_vncbase_port(self)
Obtain the currently set base VNC port number.
 
set_vncbase_port(self, nPort)
Set the base VNC port number.
 
can_change_default_settings(self)
Determine if new users have the right to modify Parallels Service preferences.
 
set_can_change_default_settings(self, bDefaultChangeSettings)
Grant or deny a permission to new users to modify Parallels Service preferences.
 
get_min_security_level(self)
Determine the lowest allowable security level that can be used to connect to the Parallels Service.
 
set_min_security_level(self, nMinSecurityLevel)
Set the lowest allowable security level that can be used to connect to the Parallels Service.
 
get_confirmations_list(self)
Obtain a list of operations that require administrator confirmation.
 
set_confirmations_list(self, hConfirmList)
Set the list of operations that require administrator confirmation.
 
get_password_protected_operations_list(self)
 
set_password_protected_operations_list(self, hList)
 
get_default_encryption_plugin_id(self)
 
set_default_encryption_plugin_id(self, sDefaultPluginId)
 
are_plugins_enabled(self)
 
enable_plugins(self, bEnablePluginsSupport)
 
is_verbose_log_enabled(self)
Determine whether the verbose log level is configured for dispatcher and virtual machines processes.
 
set_verbose_log_enabled(self, bEnabled)
Enable or disable the verbose log level for dispatcher and virtual machines processes.
 
is_allow_multiple_pmc(self)
 
set_allow_multiple_pmc(self, bEnabled)
 
is_allow_direct_mobile(self)
 
set_allow_direct_mobile(self, bEnabled)
 
is_allow_mobile_clients(self)
 
get_proxy_connection_status(self)
 
set_proxy_connection_creds(self, sAccountId, sPassword, nFlags)
 
get_proxy_connection_user(self)
 
is_log_rotation_enabled(self)
 
set_log_rotation_enabled(self, bEnabled)
 
is_allow_attach_screenshots_enabled(self)
 
set_allow_attach_screenshots_enabled(self, bEnabled)
 
get_usb_identity_count(self)
 
get_usb_identity(self, nUsbIdentIndex)
 
set_usb_ident_association(self, sSystemName, sVmUuid, nFlags)
 
get_mobile_advanced_auth_mode(self)
 
set_mobile_advanced_auth_mode(self, nMode)
 
get_usb_auto_connect_option(self)
 
set_usb_auto_connect_option(self, nOption)

Inherited from _Handle: __del__, __init__, add_ref, free, from_string, get_handle_type, get_package_id, get_type

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

get_default_vm_dir(self)

 

Obtain name and path of the directory in which new virtual machines are created by default.

Returns:
A string containing name and path of the default virtual machine directory.

get_reserved_mem_limit(self)

 

Determine the amount of physical memory reserved for Parallels Service operation.

Returns:
Integer. The memory size in megabytes.

set_reserved_mem_limit(self, nMemSize)

 

Set the amount of memory that will be allocated for Parallels Service operation.

Parameters:
  • nMemSize - Integer. The memory size in megabytes.

get_min_vm_mem(self)

 

Determine the minimum required memory size that must be allocated to an individual virtual machine.

Returns:
Integer. The memory size in megabytes.

set_min_vm_mem(self, nMemSize)

 

Set the minimum required memory size that must be allocated to an individual virtual machine.

Parameters:
  • nMemSize - Integer. The memory size in megabytes.

get_max_vm_mem(self)

 

Determine the maximum memory size that can be allocated to an individual virtual machine.

Returns:
Integer. The memory size in megabytes.

set_max_vm_mem(self, nMemSize)

 

Set the maximum memory size that can be allocated to an individual virtual machine.

Parameters:
  • nMemSize - Integer. The memory size in megabytes.

get_recommend_max_vm_mem(self)

 

Determine the recommended memory size for an individual virtual machine.

Returns:
Integer. The memory size in megabytes.

set_recommend_max_vm_mem(self, nMemSize)

 

Set recommended memory size for an individual virtual machine.

Parameters:
  • nMemSize - Integer. The memory size in megabytes.

get_max_reserv_mem_limit(self)

 

Return the maximum amount of memory that can be reserved for Parallels Service operation.

Returns:
Integer. The memory size, in megabytes.

set_max_reserv_mem_limit(self, nMemSize)

 

Set the upper limit of the memory size that can be reserved for Parallels Service operation.

Parameters:
  • nMemSize - Integer. The memory size in megabytes.

get_min_reserv_mem_limit(self)

 

Return the minimum amount of physical memory that must be reserved for Parallels Service operation.

Returns:
Integer. The memory size in megabytes.

set_min_reserv_mem_limit(self, nMemSize)

 

Set the lower limit of the memory size that must be reserved for Parallels Service operation.

Parameters:
  • nMemSize - Integer. The memory size in megabytes.

is_adjust_mem_auto(self)

 

Determine whether memory allocation for Parallels Service is performed automatically or manually.

Returns:
Boolean. True -- automatic memory allocation. False -- manual allocation.

set_adjust_mem_auto(self, bAdjustMemAuto)

 

Set the Parallels Service memory allocation mode (automatic or manual).

Parameters:
  • bAdjustMemAuto - Boolean. Set to True for automatic mode. Set to False for manual mode.

is_send_statistic_report(self)

 

Determine whether the statistics reports (CEP) mechanism is activated.

Returns:
A Boolean value. True - CEP is activated. False - deactivated.

set_send_statistic_report(self, bSendStatisticReport)

 

Turn on/off the mechanism of sending statistics reports (CEP).

Parameters:
  • bSendStatisticReport - Boolean. Set to True to turn the CEP on. Set to False to turn it off.

get_default_vnchost_name(self)

 

Return the default VNC host name for the Parallels Service.

Returns:
A string containing the VNC host name.

set_default_vnchost_name(self, sNewHostName)

 

Set the base VNC host name.

Parameters:
  • sNewHostName - String. The VNC host name to set.

get_vncbase_port(self)

 

Obtain the currently set base VNC port number.

Returns:
Integer. The port number.

set_vncbase_port(self, nPort)

 

Set the base VNC port number.

Parameters:
  • nPort - Integer. Port number.

can_change_default_settings(self)

 

Determine if new users have the right to modify Parallels Service preferences.

Returns:
Boolean. True indicates that new users can modify preferences. False indicates otherwise.

set_can_change_default_settings(self, bDefaultChangeSettings)

 

Grant or deny a permission to new users to modify Parallels Service preferences.

Parameters:
  • bDefaultChangeSettings - Boolean. Set to True to grant the permission. Set to False to deny it.

get_min_security_level(self)

 

Determine the lowest allowable security level that can be used to connect to the Parallels Service.

Returns:
One of the following constants: PSL_LOW_SECURITY -- Plain TCP/IP (no encryption). PSL_NORMAL_SECURITY -- important data is sent and received using SSL. PSL_HIGH_SECURITY -- all data is sent and received using SSL.

set_min_security_level(self, nMinSecurityLevel)

 

Set the lowest allowable security level that can be used to connect to the Parallels Service.

Parameters:
  • nMinSecurityLevel - Security level to set. Can be one of the following constants: PSL_LOW_SECURITY -- Plain TCP/IP (no encryption). PSL_NORMAL_SECURITY -- important data is sent and received using SSL. PSL_HIGH_SECURITY -- all data is sent and received using SSL.

is_verbose_log_enabled(self)

 

Determine whether the verbose log level is configured for dispatcher and virtual machines processes.

Returns:
A Boolean value. True - log level is configured. False - log level is not configured.