| Home | Trees | Indices | Help |
|
|---|
|
|
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.
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
Inherited from Inherited from Inherited from |
|||
|
|||
|
|||
|
|||
__prefix__ =
|
|||
__ht__ = 268435461
|
|||
|
|||
|
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 Inherited from Inherited from Inherited from |
|||
|
|||
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
|
Perform the specified operation on the virtual machine. This is an asynchronous method
|
Start the virtual machine. This is an asynchronous method.
|
Stop the virtual machine. This is an asynchronous method
|
Pause the virtual machine. This is an asynchronous method.
|
Reset the virtual machine (stop then start; ACPI will not be used). This is an asynchronous method.
|
Suspend the virtual machine. This is an asynchronous method
|
Resume the virtual machine. This is an asynchronous method
|
Drop suspended state; delete all temporary files from the hard drive. This is an asynchronous method.
|
Clone the virtual machine. If this is a template, create a regular virtual machine from it. This is an asynchronous method.
|
Delete the virtual machine from the host. This is an asynchronous method.
|
Automatically select and set a default configuration for the new virtual machine based on the operating system that the virtual machine will be running.
|
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.
|
Subscribe to receive the virtual machine guest statistics on a periodic basis. This is an asynchronous method.
|
Cancel subscriptions started by subscribe_to_guest_statistics method. This is an asynchronous method.
|
Subscribe to receive virtual machine perfomance statistics on a periodic basis. This is an asynchronous method.
|
Cancel subscriptions started by subscribe_to_perf_stats method. This is an asynchronous method.
|
Create a new virtual machine and register it with the Parallels Service. This is an asynchronous method.
|
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.
|
Modify the virtual machine security settings. This is an asynchronous method.
|
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.
|
Commit the virtual machine configuration changes to the Parallels Service. This is an asynchronous method.
|
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.
|
Determine the total number of devices of the specified type installed in the virtual machine.
|
Return an object containing information about a device specified by device type.
|
Return information about a floppy device specified by index.
|
Return information about a hard disk specified by index.
|
Return information about an optical disk specified by index.
|
Return information about a parallel port specified by index.
|
Return information about a serial port specified by index.
|
Return information about a sound device specified by index.
|
Return information about a USB device specified by index.
|
Return information about a network adapter specified by index.
|
Return information about a shared folder specified by index. |
Return screen resolution by index.
|
Return information about a boot device specified by index.
|
Create a floppy disk image in the virtual machine home directory for unattended Windows installation. This is an asynchronous method.
|
Launch the Parallels Tools installation program. This is an asynchronous function.
|
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.
|
Gracefully shutdown the virtual machine.
|
Validate the specified section of the virtual machine configuration. This is an asynchronous function.
|
|
|||
problem_reportContains a problem report in the event of an abnormal virtual machine termination.
|
stateAn instance of VmInfo.
|
statisticsAn instance of VmStat.
|
shares_countThe number of shared folders in a virtual machine.
|
scr_res_countvm.get_scr_res_count(Vm) -> int Returns VM screen resolutions count.
|
boot_dev_countThe number of devices in the virtual machine boot device priority list.
|
nameThe virtual machine name.
|
uuidThe virtual machine universally unique ID.
|
os_typeThe type of the OS the virtual machine is running.
|
os_versionThe version of the OS that the virtual machine is running.
|
ram_sizeThe amount of memory in the virtual machine.
|
video_ram_sizeThe amount of video memory in the machine.
|
cpu_countThe number of CPUs in the virtual machine.
|
cpu_modeCPU mode (32 bit or 64 bit). See
|
cpu_accel_levelCPU acceleration level. See
|
cpu_vtx_enabledvm.get_cpu_vtx_enabled(Vm) -> bool Returns Virtual Machine CPU VTx support enabling sign.
|
server_uuidUniversally unique ID of the host machine.
|
server_hostHost machine name (hostname).
|
home_pathThe virtual machine home directory name and path.
|
iconvm.set_icon(Vm, new_vm_icon) Sets Virtual Machine icon.
|
descriptionThe virtual machine description.
|
templateDetermines whether the virtual machine is a template or a regular virtual machine. True - template; False - regular virtual machine.
|
auto_startDetermines whether the virtual machine starts automatically on host machine boot. True - start automatically; False - don't start.
|
window_modevm.set_window_mode(Vm, vm_window_mode) Sets Virtual Machine window mode.
|
last_modifier_nameThe name of the user who modified the virtual machine the last time.
|
guest_sharing_enabledDetermines whether guest sharing is enabled (the guest OS disk drives are visible in the host OS). True - enabled; False - disabled.
|
guest_sharing_auto_mountDetermines whether the host shared folders are mounted automatically in the virtual machine. True - mount automatically; False - don't mount.
|
host_sharing_enabledDetermines whether host sharing is enabled (host shared folders are visible in the guest OS). True - enabled; False - disabled.
|
show_task_barDetermines 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.
|
relocate_task_barDetermines whether the Windows 'task bar relocation' feature is enabled in a virtual machine when it runs in the coherence mode. True - enabled; False - disabled.
|
exclude_dockDetermines 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.
|
multi_displayvm.set_multi_display(Vm, vm_multi_display) Sets Virtual Machine multi display sign coherence option.
|
scr_res_enabledvm.set_scr_res_enabled(Vm, vm_scr_res_enabled) Sets Virtual Machine additional screen resolutions support enabling sign.
|
disk_cache_write_backDetermines if disk cache write-back is enabled for this virtual machine. True - enabled; False - disabled.
|
os_res_in_full_scr_modeDetermines if the guest OS screen resolution in full-screen mode is enabled or disabled. True - enabled; False - disabled.
|
close_app_on_shutdownvm.set_close_app_on_shutdown(Vm, close_app_on_shutdown) Sets Virtual Machine close app on shutdown sign.
|
system_flagsvm.set_system_flags(Vm, new_vm_system_flags) Sets Virtual Machine system flags.
|
app_in_dock_modeDetermines the dock mode. See
|
foreground_priorityDetermines foreground process priority.
See
|
background_priorityDetermines background process priority.
See
|
dock_icon_typeDetermines the virtual machine dock icon type.
See
|
tools_infovm.get_tools_info(Vm) -> VmToolsInfo Extracts VM Tools descriptor
|
auto_start_delayDetermines the time delay used during the virtual machine automatic startup, in seconds.
|
start_login_modeDetermines the automatic startup login mode.
See
|
start_user_loginDetermines the name of the user which will be used during the virtual machine automatic startup.
|
auto_stopDetermines the automatic shutdown mode for the virtual machine.
See
|
questionsvm.get_questions(Vm) -> QuestionsList This method is an alternative for working with questions synchronically
|
last_modified_dateDetermines the date and time when the specified virtual machine was last modified.
|
perf_statsReturns virtual machine perfomance statistics in instance of Event.
|
user_defined_shared_folders_enabledIndicates whether user shared folders is enabled. True - enabled; False - disabled.
|
access_rightsReturns an instance of VmAccessRights.
|
floppy_devsAn iterator/sequence that allows to traverse through FDD device instances. See VmFloppyDev.
|
hdd_devsAn iterator/sequence that allows to traverse through HDD device instances. See VmHddDev.
|
optical_devsAn iterator/sequence that allows to traverse through optical disk device instances. See VmOpticalDev.
|
parallel_portsAn iterator/sequence that allows to traverse through parallel port device instances. See VmParallelPortDev.
|
serial_portsAn iterator/sequence that allows to traverse through serial port device instances. See VmSerialDev.
|
sound_devsAn iterator/sequence that allows to traverse through sound device instances. See VmSoundDev.
|
usb_devsAn iterator/sequence that allows to traverse through USB device instances. See VmUsbDev.
|
net_adaptersAn iterator/sequence that allows to traverse through net adapter device instances. See VmNetDev.
|
floppy_countThe number of the available FDD devices.
|
hdd_countThe number of the available HDD devices.
|
optical_countThe number of the available optical disk devices.
|
parallel_port_countThe number of the available parallel port devides.
|
serial_port_countThe number of the available serial port devices.
|
sound_dev_countThe number of the available sound devices.
|
usb_dev_countThe number of the available USB devices.
|
net_adapter_countThe number of the available net adapter devices.
|
sharesAn iterator/sequence that allows to traverse through shared folder instances. See VmShare.
|
src_ressAn iterator that allows to traverse through VmScrRes instances.
|
boot_devsAn iterator/sequence that allows to traverse through boot device instances. See VmBootDev.
|
display_dev
|
vnc_configAn instance of VmVNCConfig.
|
| Home | Trees | Indices | Help |
|
|---|
| Generated by Epydoc 3.0.1 on Mon Dec 15 21:33:41 2008 | http://epydoc.sourceforge.net |