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

Class Vm

  object --+            
           |            
 prlsdk.Base --+        
               |        
prlsdk.BaseAsync --+    
                   |    
       prlsdk.BaseVm --+
                       |
                      Vm

The Vm class provides methods for managing virtual machines. Whenever you want to get the information about, modify, or create a virtual machine, you have to obtain an instance of this class. The instance can be obtained using methods of verious classes. The two main methods that return an instance of Vm are Server.create_vm and the Server.get_vm_list.

Instance Methods [hide private]
 
__init__(self, *args)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
 
execution(self, operation, use_acpi=False)
Perform the specified operation on the virtual machine.
 
start(self)
Start the virtual machine.
 
stop(self, acpi=False)
Stop the virtual machine.
 
pause(self, acpi=False)
Pause the virtual machine.
 
reset(self)
Reset the virtual machine (stop then start; ACPI will not be used).
 
suspend(self)
Suspend the virtual machine.
 
resume(self)
Resume the virtual machine.
 
drop_suspended_state(self)
Drop suspended state; delete all temporary files from the hard drive.
 
clone(self, new_name, root_path, template=False)
Clone the virtual machine.
 
delete(self, dev_list=None)
Delete the virtual machine from the host.
 
set_default_config(self, srv_config, os_version, create_devices)
Automatically select and set a default configuration for the new virtual machine based on the operating system that the virtual machine will be running.
 
add_default_device(self, srv_config, type)
Adds a virtual device to the virtual machine.
 
subscribe_to_guest_statistics(self)
Subscribe to receive the virtual machine guest statistics on a periodic basis.
 
unsubscribe_from_guest_statistics(self)
Cancel subscriptions started by subscribe_to_guest_statistics method.
 
subscribe_to_perf_stats(self)
Subscribe to receive virtual machine perfomance statistics on a periodic basis.
 
unsubscribe_from_perf_stats(self)
Cancel subscriptions started by subscribe_to_perf_stats method.
 
reg(self, config_path, non_interactive_mode=False)
Create a new virtual machine and register it with the Parallels Service.
 
unreg(self)
Unregister the virtual machine from the Parallels Service.
 
__get_access_rights(self)
 
change_access_rights(self, others_right=None)
Modify the virtual machine security settings.
 
begin_edit(self)
Timestamp the beginning of the virtual machine editing operation.
 
commit(self)
Commit the virtual machine configuration changes to the Parallels Service.
 
refresh_config(self)
 
update_config(self)
This method is obsolete and is left for backward compatibility only.
 
create_device(self, device_type)
Create and return a new virtual device object based on the specified device type.
 
get_devices_count(self, device_type)
Determine the total number of devices of the specified type installed in the virtual machine.
 
get_device(self, device_type, index)
Return an object containing information about a device specified by device type.
 
get_floppy(self, index)
Return information about a floppy device specified by index.
 
get_hdd(self, index)
Return information about a hard disk specified by index.
 
get_optical(self, index)
Return information about an optical disk specified by index.
 
get_parallel_port(self, index)
Return information about a parallel port specified by index.
 
get_serial_port(self, index)
Return information about a serial port specified by index.
 
get_sound_dev(self, index)
Return information about a sound device specified by index.
 
get_usb_dev(self, index)
Return information about a USB device specified by index.
 
get_net_adapter(self, index)
Return information about a network adapter specified by index.
 
create_share(self)
Create a new instance of VmShare.
 
get_share(self, index)
Return information about a shared folder specified by index.
 
create_scr_res(self)
 
get_scr_res(self, index)
Return screen resolution by index.
 
reg_event_handler(self, data)
 
unreg_event_handler(self, data)
 
create_boot_dev(self)
Create a new instance of VmBootDev.
 
get_boot_dev(self, index)
Return information about a boot device specified by index.
 
create_event(self)
 
create_unattended_floppy(self, guest_distro_type, username, company_name, serial_key)
Create a floppy disk image in the virtual machine home directory for unattended Windows installation.
 
initiate_dev_state_notifications(self)
 
send_utility_command(self, cmd, flags, buffer)
 
set_clipboard(self, buffer)
 
get_weak_objects(self)
 
get_display_dev(self)
 
install_tools(self)
Launch the Parallels Tools installation program.
 
generate_device_filename(self, fn_prefix='', fn_suffix='', index_delim='')
Generate a unique name for a virtual device file that will be unique within the home directory of the virtual machine.
 
tools_send_shutdown(self, kind=0)
Gracefully shutdown the virtual machine.
 
validate_config(self, section)
Validate the specified section of the virtual machine configuration.

Inherited from prlsdk.BaseVm: __new__

Inherited from prlsdk.BaseAsync: __cmp__, __repr__, cancel, wait

Inherited from object: __delattr__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __setattr__, __str__

Static Methods [hide private]
 
get_default_settings(os_version, ram_size=0)
Class Variables [hide private]
  __prefix__ = 'vm'
  __ht__ = 268435461
Properties [hide private]
  problem_report
Contains a problem report in the event of an abnormal virtual machine termination.
  state
An instance of VmInfo.
  statistics
An instance of VmStat.
  shares_count
The number of shared folders in a virtual machine.
  scr_res_count
vm.get_scr_res_count(Vm) -> int
  boot_dev_count
The number of devices in the virtual machine boot device priority list.
  name
The virtual machine name.
  uuid
The virtual machine universally unique ID.
  os_type
The type of the OS the virtual machine is running.
  os_version
The version of the OS that the virtual machine is running.
  ram_size
The amount of memory in the virtual machine.
  video_ram_size
The amount of video memory in the machine.
  cpu_count
The number of CPUs in the virtual machine.
  cpu_mode
CPU mode (32 bit or 64 bit).
  cpu_accel_level
CPU acceleration level.
  cpu_vtx_enabled
vm.get_cpu_vtx_enabled(Vm) -> bool
  server_uuid
Universally unique ID of the host machine.
  server_host
Host machine name (hostname).
  home_path
The virtual machine home directory name and path.
  icon
vm.set_icon(Vm, new_vm_icon)
  description
The virtual machine description.
  template
Determines whether the virtual machine is a template or a regular virtual machine.
  auto_start
Determines whether the virtual machine starts automatically on host machine boot.
  window_mode
vm.set_window_mode(Vm, vm_window_mode)
  last_modifier_name
The name of the user who modified the virtual machine the last time.
  guest_sharing_enabled
Determines whether guest sharing is enabled (the guest OS disk drives are visible in the host OS).
  guest_sharing_auto_mount
Determines whether the host shared folders are mounted automatically in the virtual machine.
  host_sharing_enabled
Determines whether host sharing is enabled (host shared folders are visible in the guest OS).
  show_task_bar
Determines whether the Windows task bar is displayed when the virtual machine runs in coherence mode.
  relocate_task_bar
Determines whether the Windows 'task bar relocation' feature is enabled in a virtual machine when it runs in the coherence mode.
  exclude_dock
Determines the guest OS window behavior in coherence mode.
  multi_display
vm.set_multi_display(Vm, vm_multi_display)
  scr_res_enabled
vm.set_scr_res_enabled(Vm, vm_scr_res_enabled)
  disk_cache_write_back
Determines if disk cache write-back is enabled for this virtual machine.
  os_res_in_full_scr_mode
Determines if the guest OS screen resolution in full-screen mode is enabled or disabled.
  close_app_on_shutdown
vm.set_close_app_on_shutdown(Vm, close_app_on_shutdown)
  system_flags
vm.set_system_flags(Vm, new_vm_system_flags)
  app_in_dock_mode
Determines the dock mode.
  foreground_priority
Determines foreground process priority.
  background_priority
Determines background process priority.
  dock_icon_type
Determines the virtual machine dock icon type.
  tools_info
vm.get_tools_info(Vm) -> VmToolsInfo
  auto_start_delay
Determines the time delay used during the virtual machine automatic startup, in seconds.
  start_login_mode
Determines the automatic startup login mode.
  start_user_login
Determines the name of the user which will be used during the virtual machine automatic startup.
  auto_stop
Determines the automatic shutdown mode for the virtual machine.
  questions
vm.get_questions(Vm) -> QuestionsList
  last_modified_date
Determines the date and time when the specified virtual machine was last modified.
  perf_stats
Returns virtual machine perfomance statistics in instance of Event.
  user_defined_shared_folders_enabled
Indicates whether user shared folders is enabled.
  access_rights
Returns an instance of VmAccessRights.
  floppy_devs
An iterator/sequence that allows to traverse through FDD device instances.
  hdd_devs
An iterator/sequence that allows to traverse through HDD device instances.
  optical_devs
An iterator/sequence that allows to traverse through optical disk device instances.
  parallel_ports
An iterator/sequence that allows to traverse through parallel port device instances.
  serial_ports
An iterator/sequence that allows to traverse through serial port device instances.
  sound_devs
An iterator/sequence that allows to traverse through sound device instances.
  usb_devs
An iterator/sequence that allows to traverse through USB device instances.
  net_adapters
An iterator/sequence that allows to traverse through net adapter device instances.
  floppy_count
The number of the available FDD devices.
  hdd_count
The number of the available HDD devices.
  optical_count
The number of the available optical disk devices.
  parallel_port_count
The number of the available parallel port devides.
  serial_port_count
The number of the available serial port devices.
  sound_dev_count
The number of the available sound devices.
  usb_dev_count
The number of the available USB devices.
  net_adapter_count
The number of the available net adapter devices.
  shares
An iterator/sequence that allows to traverse through shared folder instances.
  src_ress
An iterator that allows to traverse through VmScrRes instances.
  boot_devs
An iterator/sequence that allows to traverse through boot device instances.
  display_dev
  vnc_config
An instance of VmVNCConfig.
  __weak_objs

Inherited from prlsdk.BaseVm: __editing__, __unfin_op__, autostart_editing

Inherited from prlsdk.BaseAsync: __expected_h_type__, __job__, finished, handle_type

Inherited from prlsdk.Base: __handle__

Inherited from object: __class__

Method Details [hide private]

__init__(self, *args)
(Constructor)

 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)

execution(self, operation, use_acpi=False)

 

Perform the specified operation on the virtual machine. This is an asynchronous method

Parameters:
  • operation - 'u'(up); 'd'(down); 'p'(pause); 'r'(reset); 's'(suspend); 'e'(resume).
  • use_acpi - Specifies if ACPI should be used. Used only with down and pause operations. True - use ACPI; False - don't use ACPI.
Returns:
A Job object.

start(self)

 

Start the virtual machine. This is an asynchronous method.

Returns:
A Job object.

stop(self, acpi=False)

 

Stop the virtual machine. This is an asynchronous method

Returns:
A Job object.

pause(self, acpi=False)

 

Pause the virtual machine. This is an asynchronous method.

Returns:
A Job object.

reset(self)

 

Reset the virtual machine (stop then start; ACPI will not be used). This is an asynchronous method.

Returns:
A Job object.

suspend(self)

 

Suspend the virtual machine. This is an asynchronous method

Returns:
A Job object.

resume(self)

 

Resume the virtual machine. This is an asynchronous method

Returns:
A Job object.

drop_suspended_state(self)

 

Drop suspended state; delete all temporary files from the hard drive. This is an asynchronous method.

Returns:
A Job object.

clone(self, new_name, root_path, template=False)

 

Clone the virtual machine. If this is a template, create a regular virtual machine from it. This is an asynchronous method.

Parameters:
  • new_name - The name to use for the new virtual machine.
  • root_path - Name and path of the directory where the new virtual machine should be created. To create the machine in a default directory, pass an empty string.
  • template - Specifies whether the clone should be created as a virtual machine or as a template. True - create a template; False - create a regular virtual machine. When creating a virtual machine from a template, set the parameter value to False.
Returns:
A Job object.

delete(self, dev_list=None)

 

Delete the virtual machine from the host. This is an asynchronous method.

Parameters:
  • dev_list - Files and directories to be deleted from the virtual machine directory. If none specified, delete the entire directory.
Returns:
A Job object.

set_default_config(self, srv_config, os_version, create_devices)

 

Automatically select and set a default configuration for the new virtual machine based on the operating system that the virtual machine will be running.

Parameters:
  • srv_config - An instance of SrvConfig containing the host machine configuration information.
  • os_version - The version of the operating system that the virtual machine will be running. See PVS_GUEST_VER_xxx for available options.
  • create_devices - A flag indicating whether default virtual machine devices should be created or not. True - create devices; False - don't create.

add_default_device(self, srv_config, type)

 

Adds a virtual device to the virtual machine. The method provides an easy way of setting devices in a virtual machine by automatically setting all the necessary device properties.

Parameters:
  • srv_config - An instance of SrvConfig containing the host machine configuration information.
  • type - The type of the device to add. See {consts.PDE_xxx} for available options.

subscribe_to_guest_statistics(self)

 

Subscribe to receive the virtual machine guest statistics on a periodic basis. This is an asynchronous method.

Returns:
A Job object.

unsubscribe_from_guest_statistics(self)

 

Cancel subscriptions started by subscribe_to_guest_statistics method.

This is an asynchronous method.

Returns:
A Job object.

subscribe_to_perf_stats(self)

 

Subscribe to receive virtual machine perfomance statistics on a periodic basis. This is an asynchronous method.

Returns:
A Job object.

unsubscribe_from_perf_stats(self)

 

Cancel subscriptions started by subscribe_to_perf_stats method.

This is an asynchronous method.

Returns:
A Job object.

reg(self, config_path, non_interactive_mode=False)

 

Create a new virtual machine and register it with the Parallels Service. This is an asynchronous method.

Parameters:
  • config_path - Name and path of the parent directory where you would like to create the new virtual machine directory. Pass an empty string to create a directory in the default location for this Parallels Service.
  • non_interactive_mode - True - use interactive mode; False - use non-interactive mode.
Returns:
A {job} object.

unreg(self)

 

Unregister the virtual machine from the Parallels Service. The method removes the virtual machine from the Parallels Service registry, but does not delete the virtual machine files from the hard drive.

This is an asynchronous method.

Returns:
A Job object.

change_access_rights(self, others_right=None)

 

Modify the virtual machine security settings. This is an asynchronous method.

Parameters:
  • others_right - Specifies access rights that users of this Parallels Service will have to this virtual machine. The owner of the virtual machine has full access rights and is not affected by this functionality. See consts.PAO_VM_xxx for available options.
Returns:
A Job object.

begin_edit(self)

 

Timestamp the beginning of the virtual machine editing operation. This method must be called before making any modifications to the virtual machine configuration. When the desired configuration properties are set, call Vm.commit to commit the changes to the Parallels Service. The two functions are used to detect collisions with other clients trying to modify the same virtual machine at the same time.

This is an asynchronous method.

Returns:
A Job object.

commit(self)

 

Commit the virtual machine configuration changes to the Parallels Service. This is an asynchronous method.

Returns:
A Job object.

create_device(self, device_type)

 

Create and return a new virtual device object based on the specified device type. Each virtual machine device type has a corresponding class in the Parallels Service Python API. You can search this documentation for available virtual device classes using the following rule: a class name begins with 'Vm' followed by the device type description followed by 'Dev'. For example: VmHddDev, VmNetDev, VmSoundDev, etc.

Parameters:
  • device_type - Device type. Based on the type specified here, an instance of the corresponding class will be created. See consts.PDE_xxx for available options.
Returns:
An instance of the requested class.

get_devices_count(self, device_type)

 

Determine the total number of devices of the specified type installed in the virtual machine.

Parameters:
  • device_type - Device type. See consts.PDE_xxx for the available types.

get_device(self, device_type, index)

 

Return an object containing information about a device specified by device type.

Parameters:
  • device_type - The type of the device to return the information for. See consts.PDE_xxx for the available types.
  • index - The index identifying the device instance (beginning with 0). To determine the number of the devices of the specified type available in the virtual machine, use Vm.get_devices_count.
Returns:
An instance of a class corresponding to the specified device type. You can search this documentation for available virtual device classes using the following rule: a class name begins with 'Vm' followed by the device type description followed by 'Dev'. For example: VmHddDev, VmNetDev, VmSoundDev, etc.

get_floppy(self, index)

 

Return information about a floppy device specified by index.

Parameters:
  • index - The index of the FDD device instance. Use Vm.floppy_devs to obtain the FDD device count.
Returns:
An instance of VmFloppyDev.

get_hdd(self, index)

 

Return information about a hard disk specified by index.

Parameters:
  • index - The index of the HDD device instance. Use Vm.hdd_devs to obtain the HDD device count.
Returns:
An instance of VmHddDev.

get_optical(self, index)

 

Return information about an optical disk specified by index.

Parameters:
  • index - The index of the optical disk device instance. Use Vm.optical_devs to obtain the optical disk device count.
Returns:
An instance of VmOpticalDev.

get_parallel_port(self, index)

 

Return information about a parallel port specified by index.

Parameters:
  • index - The index of the parallel port device instance. Use Vm.parallel_ports to obtain the device count.
Returns:
An instance of VmParallelPortDev.

get_serial_port(self, index)

 

Return information about a serial port specified by index.

Parameters:
  • index - The index of the serial port device instance. Use Vm.serial_ports to obtain the device count.
Returns:
An instance of VmSerialDev.

get_sound_dev(self, index)

 

Return information about a sound device specified by index.

Parameters:
  • index - The index of the sound device instance. Use Vm.sound_devs to obtain the sound device count.
Returns:
An instance of VmSoundDev.

get_usb_dev(self, index)

 

Return information about a USB device specified by index.

Parameters:
  • index - The index of the USB device instance. Use Vm.usb_devs to obtain the USB device count.
Returns:
An instance of VmUsbDev.

get_net_adapter(self, index)

 

Return information about a network adapter specified by index.

Parameters:
  • index - The index of the network adapter instance. Use Vm.net_adapters to obtain the net adapter device count.
Returns:
An instance of VmNetDev.

create_share(self)

 

Create a new instance of VmShare.

Returns:
A new instance of VmShare.

get_share(self, index)

 

Return information about a shared folder specified by index.

Parameters:
  • index - The index identifying the shared folder instance. Use Vm.shares to obtain the shared folder instance count.
Returns:
An instance of VmShare.

get_scr_res(self, index)

 

Return screen resolution by index.

Parameters:
  • index - A numeric index identifying the resolution.
Returns:
An instance of VmScrRes.

create_boot_dev(self)

 

Create a new instance of VmBootDev.

Returns:
A new instance of VmBootDev.

get_boot_dev(self, index)

 

Return information about a boot device specified by index.

Parameters:
  • index - The index of the boot device. Use Vm.boot_devs to obtain the boot device count.
Returns:
An instance of VmBootDev.

create_unattended_floppy(self, guest_distro_type, username, company_name, serial_key)

 

Create a floppy disk image in the virtual machine home directory for unattended Windows installation. This is an asynchronous method.

Parameters:
  • guest_distro_type - Windows version.
  • username - User name.
  • company_name - Company name.
  • serial_key - Serial number.
Returns:
A Job object.

install_tools(self)

 

Launch the Parallels Tools installation program. This is an asynchronous function.

Returns:
A Job object.

generate_device_filename(self, fn_prefix='', fn_suffix='', index_delim='')

 

Generate a unique name for a virtual device file that will be unique within the home directory of the virtual machine. This is an asynchronous function.

Parameters:
  • fn_prefix - A prefix to add to the name. Pass an empty string to use the default value: "tmpfile". The name will be generated by adding a numeric index to the prefix (e.g. tmpfile1, tmpfile2, tmpfile3, etc.)
  • fn_suffix - A suffix to add to the name. Pass an empty string for no suffix.
  • index_delim - A substring that will be inserted between the prefix and the numeric index. For example, if you specify an underscore character '_' and use the default values for other parameters, the names will look like this: tmpfile_1, tmpfile_2, tmpfile_3, etc. Specify an empty string if you don't want to insert any extra characters.
Returns:
A Job object.

tools_send_shutdown(self, kind=0)

 

Gracefully shutdown the virtual machine.

Parameters:
  • kind - Shutdown option. See consts.PST_VM_xxx for available options.

validate_config(self, section)

 

Validate the specified section of the virtual machine configuration. This is an asynchronous function.

Parameters:
  • section - The name of the section of the virtual machine configuration. See consts.PVC_xxx for available options.
Returns:
A Job object.

Property Details [hide private]

problem_report

Contains a problem report in the event of an abnormal virtual machine termination.

Get Method:
unreachable.vm__get_problem_report(SDK, Vm) - Lets to delete virtual machine from the server.

state

An instance of VmInfo.

Get Method:
unreachable.vm__get_state(SDK, Vm) - Lets to get virtual machine current state.

statistics

An instance of VmStat.

Get Method:
unreachable.vm__get_statistics(SDK, Vm) - This method lets to request VM guest system resources usage.

shares_count

The number of shared folders in a virtual machine.

Get Method:
unreachable.vm__get_shares_count(vm, Vm) - Returns VM shared folders count.

scr_res_count

vm.get_scr_res_count(Vm) -> int

Returns VM screen resolutions count.

Get Method:
unreachable.vm__get_scr_res_count(vm, Vm) - Returns VM screen resolutions count.

boot_dev_count

The number of devices in the virtual machine boot device priority list.

Get Method:
unreachable.vm__get_boot_dev_count(vm, Vm) - Returns VM boot devices count.

name

The virtual machine name.

Get Method:
unreachable.vm__get_name(vm, Vm) - Returns Virtual Machine name.
Set Method:
unreachable.vm__set_name(vm, Vm, new_vm_name) - Sets Virtual Machine name.

uuid

The virtual machine universally unique ID.

Get Method:
unreachable.vm__get_uuid(vm, Vm) - Returns Virtual Machine UUID.

os_type

The type of the OS the virtual machine is running.

Get Method:
unreachable.vm__get_os_type(vm, Vm) - Returns Virtual Machine guest OS type see prlsdk.consts.PVS_GUEST_TYPE_xxx.

os_version

The version of the OS that the virtual machine is running.

Get Method:
unreachable.vm__get_os_version(vm, Vm) - Returns Virtual Machine guest OS version see prlsdk.consts.PVS_GUEST_VER_xxx.
Set Method:
unreachable.vm__set_os_version(vm, Vm, vm_os_version) - Sets Virtual Machine guest OS version.

ram_size

The amount of memory in the virtual machine.

Get Method:
unreachable.vm__get_ram_size(vm, Vm) - Returns Virtual Machine RAM memory size in megabytes.
Set Method:
unreachable.vm__set_ram_size(vm, Vm, vm_ram_size) - Sets Virtual Machine RAM memory size.

video_ram_size

The amount of video memory in the machine.

Get Method:
unreachable.vm__get_video_ram_size(vm, Vm) - Returns Virtual Machine video memory size in megabytes.
Set Method:
unreachable.vm__set_video_ram_size(vm, Vm, vm_video_ram_size) - Sets Virtual Machine video memory size.

cpu_count

The number of CPUs in the virtual machine.

Get Method:
unreachable.vm__get_cpu_count(vm, Vm) - Returns Virtual Machine CPU count.
Set Method:
unreachable.vm__set_cpu_count(vm, Vm, vm_cpu_count) - Sets Virtual Machine CPU count.

cpu_mode

CPU mode (32 bit or 64 bit). See consts.PCM_CPU_xxx.

Get Method:
unreachable.vm__get_cpu_mode(vm, Vm) - Returns Virtual Machine CPU mode (32 or 64 bit).
Set Method:
unreachable.vm__set_cpu_mode(vm, Vm, vm_cpu_mode) - Sets Virtual Machine CPU mode (32 or 64 bit).

cpu_accel_level

CPU acceleration level. See consts.PVA_xxx.

Get Method:
unreachable.vm__get_cpu_accel_level(vm, Vm) - Returns Virtual Machine CPU acceleration level.
Set Method:
unreachable.vm__set_cpu_accel_level(vm, Vm, vm_cpu_accel_level) - Sets Virtual Machine CPU acceleration level.

cpu_vtx_enabled

vm.get_cpu_vtx_enabled(Vm) -> bool

Returns Virtual Machine CPU VTx support enabling sign.

Get Method:
unreachable.vm__get_cpu_vtx_enabled(vm, Vm) - Returns Virtual Machine CPU VTx support enabling sign.

server_uuid

Universally unique ID of the host machine.

Get Method:
unreachable.vm__get_server_uuid(vm, Vm) - Returns server UUID where VM registered.

server_host

Host machine name (hostname).

Get Method:
unreachable.vm__get_server_host(vm, Vm) - Returns server hostname where VM registered.

home_path

The virtual machine home directory name and path.

Get Method:
unreachable.vm__get_home_path(vm, Vm) - Returns VM home path (where VM's files placed).

icon

vm.set_icon(Vm, new_vm_icon)

Sets Virtual Machine icon.

Get Method:
unreachable.vm__get_icon(vm, Vm) - Returns Virtual Machine icon.
Set Method:
unreachable.vm__set_icon(vm, Vm, new_vm_icon) - Sets Virtual Machine icon.

description

The virtual machine description.

Get Method:
unreachable.vm__get_description(vm, Vm) - Returns Virtual Machine description.
Set Method:
unreachable.vm__set_description(vm, Vm, new_vm_description) - Sets Virtual Machine description.

template

Determines whether the virtual machine is a template or a regular virtual machine. True - template; False - regular virtual machine.

Get Method:
unreachable.vm__get_template(vm, Vm) - Returns whether Virtual Machine configuration is a template.
Set Method:
unreachable.vm__set_template(vm, Vm, is_template) - Sets Virtual Machine configuration template sign.

auto_start

Determines whether the virtual machine starts automatically on host machine boot. True - start automatically; False - don't start.

Get Method:
unreachable.vm__get_auto_start(vm, Vm) - Returns Virtual Machine auto start mode.
Set Method:
unreachable.vm__set_auto_start(vm, Vm, vm_auto_start) - Sets Virtual Machine auto start mode.

window_mode

vm.set_window_mode(Vm, vm_window_mode)

Sets Virtual Machine window mode.

Get Method:
unreachable.vm__get_window_mode(vm, Vm) - Returns Virtual Machine window mode.
Set Method:
unreachable.vm__set_window_mode(vm, Vm, vm_window_mode) - Sets Virtual Machine window mode.

last_modifier_name

The name of the user who modified the virtual machine the last time.

Get Method:
unreachable.vm__get_last_modifier_name(vm, Vm) - Returns user name that last modified Virtual Machine.

guest_sharing_enabled

Determines whether guest sharing is enabled (the guest OS disk drives are visible in the host OS). True - enabled; False - disabled.

Get Method:
unreachable.vm__get_guest_sharing_enabled(vm, Vm) - Returns Virtual Machine guest OS sharing enabling sign.
Set Method:
unreachable.vm__set_guest_sharing_enabled(vm, Vm, vm_guest_sharing_enabled) - Sets Virtual Machine guest OS sharing enabling sign.

guest_sharing_auto_mount

Determines whether the host shared folders are mounted automatically in the virtual machine. True - mount automatically; False - don't mount.

Get Method:
unreachable.vm__get_guest_sharing_auto_mount(vm, Vm) - Returns Virtual Machine guest OS sharing automount sign.
Set Method:
unreachable.vm__set_guest_sharing_auto_mount(vm, Vm, vm_guest_sharing_auto_mount) - Sets Virtual Machine guest OS sharing automount sign.

host_sharing_enabled

Determines whether host sharing is enabled (host shared folders are visible in the guest OS). True - enabled; False - disabled.

Get Method:
unreachable.vm__get_host_sharing_enabled(vm, Vm) - Returns Virtual Machine host OS sharing enabling sign.
Set Method:
unreachable.vm__set_host_sharing_enabled(vm, Vm, vm_host_sharing_enabled) - Sets Virtual Machine host OS sharing enabling sign.

show_task_bar

Determines whether the Windows task bar is displayed when the virtual machine runs in coherence mode. True - task bar is enabled; False - task bar is disabled.

Get Method:
unreachable.vm__get_show_task_bar(vm, Vm) - Returns Virtual Machine show task bar sign coherence option.
Set Method:
unreachable.vm__set_show_task_bar(vm, Vm, vm_show_task_bar) - Sets Virtual Machine show task bar sign coherence option.

relocate_task_bar

Determines whether the Windows 'task bar relocation' feature is enabled in a virtual machine when it runs in the coherence mode. True - enabled; False - disabled.

Get Method:
unreachable.vm__get_relocate_task_bar(vm, Vm) - Returns Virtual Machine relocate task bar sign coherence option.
Set Method:
unreachable.vm__set_relocate_task_bar(vm, Vm, vm_relocate_task_bar) - Sets Virtual Machine relocate task bar sign coherence option.

exclude_dock

Determines the guest OS window behavior in coherence mode. True - don't redraw the portion of the window that moved below the dock; False - redraw the entire window.

Get Method:
unreachable.vm__get_exclude_dock(vm, Vm) - Returns Virtual Machine exclude dock sign coherence option.
Set Method:
unreachable.vm__set_exclude_dock(vm, Vm, vm_exclude_dock) - Sets Virtual Machine exclude dock sign coherence option.

multi_display

vm.set_multi_display(Vm, vm_multi_display)

Sets Virtual Machine multi display sign coherence option.

Get Method:
unreachable.vm__get_multi_display(vm, Vm) - Returns Virtual Machine multi display sign coherence option.
Set Method:
unreachable.vm__set_multi_display(vm, Vm, vm_multi_display) - Sets Virtual Machine multi display sign coherence option.

scr_res_enabled

vm.set_scr_res_enabled(Vm, vm_scr_res_enabled)

Sets Virtual Machine additional screen resolutions support enabling sign.

Get Method:
unreachable.vm__get_scr_res_enabled(vm, Vm) - Returns Virtual Machine additional screen resolutions support enabling sign.
Set Method:
unreachable.vm__set_scr_res_enabled(vm, Vm, vm_scr_res_enabled) - Sets Virtual Machine additional screen resolutions support enabling sign.

disk_cache_write_back

Determines if disk cache write-back is enabled for this virtual machine. True - enabled; False - disabled.

Get Method:
unreachable.vm__get_disk_cache_write_back(vm, Vm) - Returns Virtual Machine disk cache writeback option.
Set Method:
unreachable.vm__set_disk_cache_write_back(vm, Vm, vm_disk_cache_write_back) - Sets Virtual Machine disk cache writeback option.

os_res_in_full_scr_mode

Determines if the guest OS screen resolution in full-screen mode is enabled or disabled. True - enabled; False - disabled.

Get Method:
unreachable.vm__get_os_res_in_full_scr_mode(vm, Vm) - Returns Virtual Machine OS resolution in full screen mode support option.
Set Method:
unreachable.vm__set_os_res_in_full_scr_mode(vm, Vm, vm_os_res_in_full_scr_mode) - Sets Virtual Machine OS resolution in full screen mode support option.

close_app_on_shutdown

vm.set_close_app_on_shutdown(Vm, close_app_on_shutdown)

Sets Virtual Machine close app on shutdown sign.

Get Method:
unreachable.vm__get_close_app_on_shutdown(vm, Vm) - Returns Virtual Machine close app on shutdown sign.
Set Method:
unreachable.vm__set_close_app_on_shutdown(vm, Vm, close_app_on_shutdown) - Sets Virtual Machine close app on shutdown sign.

system_flags

vm.set_system_flags(Vm, new_vm_system_flags)

Sets Virtual Machine system flags.

Get Method:
unreachable.vm__get_system_flags(vm, Vm) - Returns Virtual Machine system flags.
Set Method:
unreachable.vm__set_system_flags(vm, Vm, new_vm_system_flags) - Sets Virtual Machine system flags.

app_in_dock_mode

Determines the dock mode. See consts.PDM_APP_IN_xxx for available options.

Get Method:
unreachable.vm__get_app_in_dock_mode(vm, Vm) - Returns Virtual Machine application in dock mode coherence option.
Set Method:
unreachable.vm__set_app_in_dock_mode(vm, Vm, vm_app_in_dock_mode) - Sets Virtual Machine application in dock mode coherence option.

foreground_priority

Determines foreground process priority. See consts.PVR_PRIORITY_xxx for available options.

Get Method:
unreachable.vm__get_foreground_priority(vm, Vm) - Returns Virtual Machine foreground processes priority.
Set Method:
unreachable.vm__set_foreground_priority(vm, Vm, vm_foreground_priority) - Sets Virtual Machine foreground processes priority.

background_priority

Determines background process priority. See PVR_PRIORITY_xxx for available options.

Get Method:
unreachable.vm__get_background_priority(vm, Vm) - Returns Virtual Machine background processes priority.
Set Method:
unreachable.vm__set_background_priority(vm, Vm, vm_background_priority) - Sets Virtual Machine background processes priority.

dock_icon_type

Determines the virtual machine dock icon type. See consts.PIT_DOCK_ICON_xxx for available options.

Get Method:
unreachable.vm__get_dock_icon_type(vm, Vm) - Returns Virtual Machine dock icon type.
Set Method:
unreachable.vm__set_dock_icon_type(vm, Vm, vm_dock_icon_type) - Sets Virtual Machine dock icon type.

tools_info

vm.get_tools_info(Vm) -> VmToolsInfo

Extracts VM Tools descriptor

Get Method:
unreachable.vm__get_tools_info(vm, Vm) - Extracts VM Tools descriptor

auto_start_delay

Determines the time delay used during the virtual machine automatic startup, in seconds.

Get Method:
unreachable.vm__get_auto_start_delay(vm, Vm) - Returns Virtual Machine auto start delay in seconds
Set Method:
unreachable.vm__set_auto_start_delay(vm, Vm, vm_auto_start_delay) - Sets Virtual Machine auto start delay in seconds

start_login_mode

Determines the automatic startup login mode. See PLM_xxx for available options.

Get Method:
unreachable.vm__get_start_login_mode(vm, Vm) - Returns Virtual Machine start login mode, see PLM_xxx
Set Method:
unreachable.vm__set_start_login_mode(vm, Vm, login_mode) - Sets Virtual Machine start login mode, see PLM_xxx

start_user_login

Determines the name of the user which will be used during the virtual machine automatic startup.

Get Method:
unreachable.vm__get_start_user_login(vm, Vm) - Returns Virtual Machine start user login

auto_stop

Determines the automatic shutdown mode for the virtual machine. See consts.PAO_VM_xxx for available options.

Get Method:
unreachable.vm__get_auto_stop(vm, Vm) - Returns Virtual Machine auto stop mode, see PAO_xxx
Set Method:
unreachable.vm__set_auto_stop(vm, Vm, auto_stop) - Sets Virtual Machine auto stop mode, see PAO_xxx

questions

vm.get_questions(Vm) -> QuestionsList

This method is an alternative for working with questions synchronically

Get Method:
unreachable.vm__get_questions(vm, Vm) - This method is an alternative for working with questions synchronically

last_modified_date

Determines the date and time when the specified virtual machine was last modified.

Get Method:
unreachable(o)

perf_stats

Returns virtual machine perfomance statistics in instance of Event.

Get Method:
unreachable.vm__get_perf_stats(SDK, Vm, filter='') - filter - String representing statistics filter, use char '*' at the end to get subset of statistic.

user_defined_shared_folders_enabled

Indicates whether user shared folders is enabled. True - enabled; False - disabled.

Get Method:
unreachable.vm__get_user_defined_shared_folders_enabled(vm, Vm) - Returns VM user defined shared folders enabling sign.
Set Method:
unreachable.vm__set_user_defined_shared_folders_enabled(vm, Vm, enabled) - Sets VM user defined shared folders enabling sign.

access_rights

Returns an instance of VmAccessRights.

Get Method:
__get_access_rights(self)

floppy_devs

An iterator/sequence that allows to traverse through FDD device instances. See VmFloppyDev.

Get Method:
unreachable(s)

hdd_devs

An iterator/sequence that allows to traverse through HDD device instances. See VmHddDev.

Get Method:
unreachable(s)

optical_devs

An iterator/sequence that allows to traverse through optical disk device instances. See VmOpticalDev.

Get Method:
unreachable(s)

parallel_ports

An iterator/sequence that allows to traverse through parallel port device instances. See VmParallelPortDev.

Get Method:
unreachable(s)

serial_ports

An iterator/sequence that allows to traverse through serial port device instances. See VmSerialDev.

Get Method:
unreachable(s)

sound_devs

An iterator/sequence that allows to traverse through sound device instances. See VmSoundDev.

Get Method:
unreachable(s)

usb_devs

An iterator/sequence that allows to traverse through USB device instances. See VmUsbDev.

Get Method:
unreachable(s)

net_adapters

An iterator/sequence that allows to traverse through net adapter device instances. See VmNetDev.

Get Method:
unreachable(s)

floppy_count

The number of the available FDD devices.

Get Method:
unreachable(s)

hdd_count

The number of the available HDD devices.

Get Method:
unreachable(s)

optical_count

The number of the available optical disk devices.

Get Method:
unreachable(s)

parallel_port_count

The number of the available parallel port devides.

Get Method:
unreachable(s)

serial_port_count

The number of the available serial port devices.

Get Method:
unreachable(s)

sound_dev_count

The number of the available sound devices.

Get Method:
unreachable(s)

usb_dev_count

The number of the available USB devices.

Get Method:
unreachable(s)

net_adapter_count

The number of the available net adapter devices.

Get Method:
unreachable(s)

shares

An iterator/sequence that allows to traverse through shared folder instances. See VmShare.

Get Method:
unreachable(s)

src_ress

An iterator that allows to traverse through VmScrRes instances.

Get Method:
unreachable(s)

boot_devs

An iterator/sequence that allows to traverse through boot device instances. See VmBootDev.

Get Method:
unreachable(s)

display_dev

Get Method:
unreachable(s)

vnc_config

An instance of VmVNCConfig.

Get Method:
unreachable(s)