VmDisplayDev
The VmDisplayDev class provides methods for remote capture of screen shots of a virtual machine desktop and for sending keyboard and mouse commands to it.

VmBaseDev
VmBaseDev is a base class that provides methods for managing virtual devices.

VmBaseDiskDev
VmBaseDiskDev is a base class that provides methods for managing virtual hard disks.

VmBasePortDev
Base class providing methods for managing virtual ports (serial, parallel).

VmFloppyDev
Provides methods for managing virtual floppy disk drives.

VmOpticalDev
Provides methods for managing virtual optical disk drives.

VmParallelPortDev
Provides methods for managing virtual parallel ports.

VmHddDev
Provides methods for managing virtual hard disk drives.

VmNetDev
Provides methods for managing virtual network adapters.

VmSerialDev
Provides methods for managing virtual serial ports.

VmSoundDev
Provides methods for managing virtual sound devices.

VmUsbDev
Provides methods for managing virtual USB devices.

VmBootDev
Provides methods for managing boot devices in a virtual machine.

VmScrRes
Contains a virtual machine screen resolution information.

VmShare
Provides methods for managing host shared folder accessibility in a virtual machine.

VmStat
Provides methods for obtaining performance statistics hosts and virtual machines.

VmCPUStat
Contains CPU statistics.

VmIFaceStat
Contains network interface statistics.

VmUserStat
Contains user session statistics.

VmDiskStat
Contains disk drive statistics.

VmDiskPartStat
Contains disk partition statistics.

VmProcStat
Contains system process statistics.

VmInfo
Contains a virtual machine state and access rights information.

VmToolsInfo
Provides methods for determining whether the Parallels Tools package is installed in the specified virtual machine and for obtaining its status and version information.

SrvCfgDev
SrvCfgDev is a base class that provides methods for getting information about physical devices on the host.

SrvCfgNet
Provides methods for getting information about a network adapter on the host.

SrvCfgHdd
Provides methods for getting information about a physical hard disk on the host.

SrvCfgHddPart
Contains information about a disk partition.

SrvInfo
Contains general information about a host computer.

LoginResponse
Contains information pertinent to a successful Parallels Service login operation.

RunningTask
The RunningTask class is used in recovering from the lost Parallels Service connection and attaching to an existing and running task.

UsrInfo
Contains information about a Parallels Service user.

Functions

[hide private]

bubble_single_char(x, y)

__prl_sdk_call(meth_name, object, *args)

prl_sdk_call_prefix(prefix, meth_name, object, *args)

prl_sdk_call(meth_name, object, *args)

__get_prop_doc__(get_func, set_func)

prl_property(prop_name, prefix=None, doc=None)

prl_to_date_time(dt_string)

prl_datetime_property(prop_name, prefix=None, doc=None)

prl_iter_property(count_methname, index_methodname, doc=None, arg1=None)

GetClientConfig()

get_handle_type(obj)

get_os_type_from_version(os_version)
Determine and return OS type based on the specified OS version.

prl_indirect_property(prop_name, prefix=None, doc=None)

__prl_sdk_register_objects__(obj_type_list)

Variables

[hide private]

__deinit_sdk__ = __DeinitSDK__()

handle_types = ['PHT_ACCESS_RIGHTS', 'PHT_BOOT_DEVICE', 'PHT_D...
constants for handle types

device_types = ['PDE_CLUSTERED_DEVICE', 'PDE_FLOPPY_DISK', 'PD...
constants for device types

key_codes = ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9',...
constants for scancodes

key_actions = ['PKE_CLICK', 'PKE_PRESS', 'PKE_RELEASE']
constants for key actions

__DATE_TIME_SELECTOR__ = re.compile(r'([0-9]{4}-[0-9]{2}-[0-9]...

__PRL_DATETIME_FMTS__ = ('%Y-%m-%d', '%H:%M:%S', '%Y-%m-%d %H:...

Function Details

[hide private]

get_os_type_from_version(os_version)

Determine and return OS type based on the specified OS version.

Parameters:

os_version - The version of the OS to get the type for. See consts.PVS_GUEST_VER_xxx for the list of OS versions.

Returns:

A Result object containing the OS type as a string. See consts.PVS_GUEST_TYPE_xxx for the list of OS types.

Variables Details

[hide private]

handle_types

constants for handle types

Value:

['PHT_ACCESS_RIGHTS', 'PHT_BOOT_DEVICE', 'PHT_DISP_CONFIG', 'PHT_DISP_
NET_ADAPTER', 'PHT_EVENT', 'PHT_EVENT_PARAMETER', 'PHT_FOUND_VM_INFO',
 'PHT_HANDLES_LIST', 'PHT_HW_GENERIC_DEVICE', 'PHT_HW_HARD_DISK', 'PHT
_HW_HARD_DISK_PARTITION', 'PHT_HW_NET_ADAPTER', 'PHT_JOB', 'PHT_LICENS
E', 'PHT_LOGIN_RESPONSE', 'PHT_NET_SERVICE_STATUS', 'PHT_REMOTEDEV_CMD
', 'PHT_REMOTE_FILESYSTEM_ENTRY', 'PHT_REMOTE_FILESYSTEM_INFO', 'PHT_R
ESULT', 'PHT_RUNNING_TASK', 'PHT_SCREEN_RESOLUTION', 'PHT_SERVER', 'PH
T_SERVER_CONFIG', 'PHT_SERVER_INFO', 'PHT_SHARE', 'PHT_STRINGS_LIST', 
...

device_types

constants for device types

Value:

['PDE_CLUSTERED_DEVICE', 'PDE_FLOPPY_DISK', 'PDE_GENERIC_DEVICE', 'PDE
_GENERIC_NETWORK_ADAPTER', 'PDE_GENERIC_PCI_DEVICE', 'PDE_GENERIC_PORT
', 'PDE_GENERIC_SCSI_DEVICE', 'PDE_HARD_DISK', 'PDE_MASSSTORAGE_DEVICE
', 'PDE_MAX', 'PDE_MIXER_DEVICE', 'PDE_OPTICAL_DISK', 'PDE_PARALLEL_PO
RT', 'PDE_PRINTER', 'PDE_SERIAL_PORT', 'PDE_SOUND_DEVICE', 'PDE_STORAG
E_DEVICE', 'PDE_USB_DEVICE']

key_codes

constants for scancodes

Value:

['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D',
 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R',
 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', 'ALT_LEFT', 'ALT_RIGHT', 'BAC
KSLASH', 'BACKSPACE', 'CAPS_LOCK', 'CBRACE_LEFT', 'CBRACE_RIGHT', 'CMD
_LEFT', 'CMD_RIGHT', 'COLON', 'CTRL_LEFT', 'CTRL_RIGHT', 'DELETE', 'DO
WN', 'ENTER', 'ESC', 'F1', 'F10', 'F11', 'F12', 'F2', 'F3', 'F4', 'F5'
, 'F6', 'F7', 'F8', 'F9', 'GREATER', 'INSERT', 'LEFT', 'LESS', 'MENU',
 'MINUS', 'NUM_0', 'NUM_1', 'NUM_2', 'NUM_3', 'NUM_4', 'NUM_5', 'NUM_6
...

__DATE_TIME_SELECTOR__

Value:

re.compile(r'([0-9]{4}-[0-9]{2}-[0-9]{2})?([T ])?([0-9]{2}:[0-9]{2}:[0
-9]{2})?')

__PRL_DATETIME_FMTS__

Value:

('%Y-%m-%d', '%H:%M:%S', '%Y-%m-%d %H:%M:%S', '%Y-%m-%dT%H:%M:%S')