Parallels Virtualization SDK Reference Manual

Parallels Virtualization SDK

Python API Reference

September 03, 2015

Copyright © 1999-2015 Parallels IP Holdings GmbH and its affiliates. All rights reserved.

Parallels IP Holdings GmbH
Vordergasse 59
8200 Schaffhausen
Switzerland
Tel: + 41 52 632 0411
Fax: + 41 52 672 2010
www.odin.com
Copyright © 1999-2015 Parallels IP Holdings GmbH and its affiliates. All rights reserved.
This product is protected by United States and international copyright laws. The product’s underlying technology,
patents, and trademarks are listed at http://www.odin.com/trademarks.
Microsoft, Windows, Windows Server, Windows NT, Windows Vista, and MS-DOS are registered trademarks of Microsoft
Corporation.
Apple, Mac, the Mac logo, Mac OS, iPad, iPhone, iPod touch, FaceTime HD camera and iSight are trademarks of Apple
Inc., registered in the US and other countries.
Linux is a registered trademark of Linus Torvalds.
All other marks and names mentioned herein may be trademarks of their respective owners.

Code Samples: Virtual Machine Management ......................................................... 7

C

HAPTER

1

Introduction

In This Chapter

About This Guide ................................................................................................... 3

Organization of This Guide ...................................................................................... 3

How to Use This Guide ........................................................................................... 4

Virtual Machines vs. Parallels Containers ................................................................. 4

Code Samples — Parallels Container Management ................................................. 5

About This Guide

This guide is a part of the Parallels Virtualization SDK. It contains the Parallels Python API Reference
documentation. Please note that this guide does not provide general information on how to use the
Parallels Virtualization SDK. To learn the SDK basics, please read the Parallels Virtualization SDK
Programmer's Guide, which is a companion book to this one.

Organization of This Guide

This guide is organized into the following chapters:

Getting Started. You are reading it now.

Parallels Python API Reference. The main chapter describing the Parallels Python package and

modules. The chapter has the following main sections:

• Package prlsdkapi. Contains the main reference information. Classes and methods are

described here.

• Module prlsdkapi.prlsdk. This section described an internal module. Do not use it in your

programs.

• Module prlsdkapi.prlsdk.consts. Describes the API constants. Most of the constants are

combined into groups which are used as pseudo enumerations. Constants that belong to the
same group have the same prefix in their names. For example, constants with a PDE_ prefix
identify device types: PDE_GENERIC_DEVICE, PDE_HARD_DISK,
PDE_GENERIC_NETWORK_ADAPTER, etc. Other constants are named in a similar manner.

Introduction

• Module prlsdkapi.prlsdk.errors. Describes error code constants. The API has a very large

number of error codes, but the majority of them are used internally. The error code constants
are named similarly to other constants (i.e. using prefixes for grouping).

How to Use This Guide

If you are just starting with the Parallels Virtualization SDK, your best source of information is
Parallels Virtualization SDK Programmer's Guide. It explain the Parallels Python API concepts
and provides descriptions and step-by-step instructions on how to use the API to perform the most
common tasks. Once you are familiar with the basics, you can use this guide as a reference where
you can find a particular function syntax or search for a function that provides a functionality that
you need.

Searching for Symbols in This Guide

Please note that when searching this guide for a symbol with an underscore in its name, the search
may not produce the desired results. If you are experiencing this problem, replace an underscore
with a whitespace character when typing a symbol name in the Search box. For example, to
search for the PDE_HARD_DISK symbol, type PDE HARD DISK (empty spaces between parts of
the symbol name).

Virtual Machines vs. Parallels Containers

With Parallels Cloud Server you have a choice of creating and running two types of virtual servers:
Parallels Virtual Machines and Parallels Containers. While the two server types use different
virtualization technologies (Hypervisor and Operating System Virtualization respectively), the
Parallels Python API can be used to manage both server types transparently. This means that the
same set of classes and methods (with some exceptions) is used to perform operations on both
Virtual Machines and Containers.

The following list provides an overview of the specifics and differences when using the API to
manage Virtual Machines or Containers:

• When obtaining the list of the available virtual servers with the Server.get_vm_list

method, the result set will contain the virtual servers of both types. When iterating through the
list and obtaining an individual server configuration data, you can determine the server type
using the VmConfig.get_vm_type method. The method returns the server type:
consts.PVT_VM (Virtual Machine) or consts.PVT_CT (Container). Once you know the server
type, you can perform the desired server management tasks accordingly.

• When creating a virtual server, you have to specify the type of the server you want to create.

This is done by using the Vm.set_vm_type method passing the consts.PVT_VM or the
consts.PVT_CT constant to it as a parameter.

4

Introduction

• The majority of classes and methods operate on both virtual server types. A method and its

input/output parameters don't change. Some classes and methods are Virtual Machine specific
or Container specific. In the Python API Reference documentation such classes and methods
have a Parallels Virtual Machines only or Parallels Containers only note at the beginning of the
description. If a class or a method description doesn't specify the server type, it means that it
can operate on both Virtual Machines and Containers.

• When working with a particular server type, the flow of a given programming task may be

slightly different. There aren't many tasks like that. The most common tasks that have these
differences are documented in this guide and the Parallels Virtualization SDk Programmer's
Guide.

Code Samples — Parallels Container Management

This section provides a collection of simplified sample code that demonstrates how to use the
Parallels Python API to perform the most common Parallels Container management tasks. For
simplicity, no error checking is implemented in the sample code below. When writing your own
program, the error checking should be properly performed. For more complete information and
code samples, please read the Parallels Virtualization SDK Programmer's Guide.

import os
import select
import prlsdkapi
from prlsdkapi import consts
# Initialize the SDK.
def init():
print 'init_server_sdk'
prlsdkapi.init_server_sdk()
# Deinitialize the SDK.
def deinit():
print 'deinit_sdk'
prlsdkapi.deinit_sdk()
# Create a Parallels Container.
def create(srv, name):
print 'create ct'
ct = srv.create_vm()
ct.set_vm_type(consts.PVT_CT)
ct.set_name(name)
ct.set_os_template('centos-6-x86_64')
ct.reg('', True).wait()
return ct
# Register a Container with
# Parallels Cloud Server
def register(srv, path):
print 'register ct'
ct = srv.register_vm(path).wait()
return ct
# Change a Container name.
def setName(ct, name):
print 'set_name'
ct.begin_edit().wait()
ct.set_name(name)

5

Introduction

ct.commit().wait()
# Set CPU limits for a Container.
def setCpuLimit(ct, limit):
print 'set_cpu_limit'
ct.begin_edit().wait()
ct.set_cpu_limit(limit)
ct.commit().wait()
# Set RAM size for a Container.
def setRamSize(ct, size):
print 'set_ram_size'
ct.begin_edit().wait()
ct.set_ram_size(size)
ct.commit().wait()
# Add a hard disk to a Container.
def addHdd(ct, image, size):
print 'add hdd'
ct.begin_edit().wait()
hdd = ct.create_vm_dev(consts.PDE_HARD_DISK)
hdd.set_emulated_type(consts.PDT_USE_IMAGE_FILE)
hdd.set_disk_type(consts.PHD_EXPANDING_HARD_DISK)
hdd.set_disk_size(size)
hdd.set_enabled(True)
hdd.create_image(bRecreateIsAllowed = True,
bNonInteractiveMode = True).wait()
ct.commit().wait()
# Execute a program in a Container.
def execute(ct, cmd, args):
print 'execute command'
io = prlsdkapi.VmIO()
io.connect_to_vm(ct, consts.PDCT_HIGH_QUALITY_WITHOUT_COMPRESSION).wait()
# open guest session
result = ct.login_in_guest('root', '').wait()
guest_session = result.get_param()
# format args and envs
sdkargs = prlsdkapi.StringList()
for arg in args:
sdkargs.add_item(arg)
sdkargs.add_item("")
sdkenvs = prlsdkapi.StringList()
sdkenvs.add_item("")
# execute
ifd, ofd = os.pipe()
flags = consts.PRPM_RUN_PROGRAM_ENTER|consts.PFD_STDOUT
job = guest_session.run_program(cmd, sdkargs, sdkenvs,
nFlags = flags, nStdout = ofd)
# read output
output = ''
while True:
rfds, _, _ = select.select([ifd], [], [], 5)
if not rfds:
break
buf = os.read(ifd, 256)
output += buf
print('output:\n%s--end of output' % output)
# cleanup
os.close(ifd)
job.wait()
guest_session.logout()
io.disconnect_from_vm(ct)
# MAIN PROGRAM
def sample1():

6

Introduction

init()
srv = prlsdkapi.Server()
srv.login_local().wait()
# Create and start a Container.
ct = create(srv, '101')
ct.start().wait()
# Execute the '/bin/cat /proc/cpuinfo' command
# in a Container.
execute(ct, '/bin/cat', ['/proc/cpuinfo'])
ct.stop().wait()
# Set some parameters and add a hard disk
# to a Container.
setCpuLimit(ct, 50)
setRamSize(ct, 2048)
addHdd(ct, '/tmp/my_empty_hdd_image', 1024)
# Clone a Container.
ct2 = ct.clone('121', '').wait().get_param()
print('Clone name = %s' % ct2.get_name())
# Unregister and registers back a Container.
home_path = ct.get_home_path()
ct.unreg()
ct = srv.register_vm(home_path).wait().get_param()
# Delete a Container.
ct.delete()
ct2.delete()
srv.logoff().wait()
deinit()

Code Samples: Virtual Machine Management

This section provides a collection of simplified sample code that demonstrates how to use the
Parallels Python API to perform the most common Parallels Virtual Machine management tasks. For
simplicity, no error checking is done in the sample code below. When writing your own program,
the error checking should be properly implemented. For the complete information and code
samples, please read the Parallels Virtualization SDK Programmer's Guide.

# Create a Virtual Machine
def create(server):

# Get the ServerConfig object.
result = server.get_srv_config().wait()
srv_config = result.get_param()

# Create a Vm object and set the virtual server type
# to Virtual Machine (PVT_VM).
vm = server.create_vm()
vm.set_vm_type(consts.PVT_VM)

# Set a default configuration for the VM.
vm.set_default_config(srv_config, \
consts.PVS_GUEST_VER_WIN_WINDOWS8, True)

# Set the VM name.
vm.set_name("Windows8")

# Modify the default RAM and HDD size.
vm.set_ram_size(256)
dev_hdd = vm.get_hard_disk(0)

7

Introduction

dev_hdd.set_disk_size(3000)

# Register the VM with the Parallels Cloud Server.
vm.reg("", True).wait()
# Change VM name.
def setName(vm, name):
print 'set_name'
vm.begin_edit().wait()
vm.set_name(name)
vm.commit().wait()
# Set boot device priority
def vm_boot_priority(vm):

# Begin the virtual server editing operation.
vm.begin_edit().wait()

# Modify boot device priority using the following order:
# CD > HDD > Network > FDD.
# Remove all other devices from the boot priority list (if any).
count = vm.get_boot_dev_count()
for i in range(count):
boot_dev = vm.get_boot_dev(i)

# Enable the device.
boot_dev.set_in_use(True)

# Set the device sequence index.
dev_type = boot_dev.get_type()

if dev_type == consts.PDE_OPTICAL_DISK:
boot_dev.set_sequence_index(0)
elif dev_type == consts.PDE_HARD_DISK:
boot_dev.set_sequence_index(1)
elif dev_type == consts.PDE_GENERIC_NETWORK_ADAPTER:
boot_dev.set_sequence_index(2)
elif dev_type == consts.PDE_FLOPPY_DISK:
boot_dev.set_sequence_index(3)
else:
boot_dev.remove()

# Commit the changes.
vm.commit().wait()
# Execute a program in a VM.
def execute(vm):
# Log in.
g_login = "Administrator"
g_password = "12345"
# Create a StringList object to hold the
# program input parameters and populate it.
hArgsList = prlsdkapi.StringList()
hArgsList.add_item("cmd.exe")
hArgsList.add_item("/C")
hArgsList.add_item("C:\\123.bat")
# Create an empty StringList object.
# The object is passed to the VmGuest.run_program method and
# is used to specify the list of environment variables and
# their values to add to the program execution environment.
# In this sample, we are not adding any variables.
# If you wish to add a variable, add it in the var_name=var_value format.
hEnvsList = prlsdkapi.StringList()
hEnvsList.add_item("")

8

Introduction

# Establish a user session.
vm_guest = vm.login_in_guest(g_login, g_password).wait().get_param()
# Run the program.
vm_guest.run_program("cmd.exe", hArgsList, hEnvsList).wait()
# Log out.
vm_guest.logout().wait()

9

Parallels Python API Reference

API Documentation

September 3, 2015

Contents

Contents 1

1 Package prlsdkapi 7

1.1 Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

1.2 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

1.3 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

1.4 Class PrlSDKError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

1.4.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

1.4.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

1.5 Class ApiHelper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

1.5.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

1.6 Class Debug . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

1.6.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

1.7 Class StringList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

1.7.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

1.7.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

1.8 Class HandleList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

1.8.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

1.8.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

1.9 Class OpTypeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

1.9.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

1.9.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

1.10 Class Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

1.10.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

1.10.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

1.11 Class Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

1.11.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

1.11.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

1.12 Class EventParam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

1.12.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

1.12.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

1.13 Class Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

1.13.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

1.13.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

1.14 Class Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

1.14.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

1.14.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

1

CONTENTS CONTENTS

1.15 Class FsInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

1.15.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

1.15.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

1.16 Class FsEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

1.16.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

1.16.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

1.17 Class ServerConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

1.17.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

1.17.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

1.18 Class HostDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

1.18.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

1.18.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

1.19 Class HostHardDisk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

1.19.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

1.19.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

1.20 Class HdPartition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

1.20.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

1.20.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

1.21 Class HostNet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

1.21.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

1.21.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

1.22 Class HostPciDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

1.22.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

1.22.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

1.23 Class UserConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

1.23.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

1.23.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

1.24 Class UserInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

1.24.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

1.24.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

1.25 Class DispConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

1.25.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

1.25.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

1.26 Class VirtualNet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

1.26.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

1.26.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

1.27 Class PortForward . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

1.27.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

1.27.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

1.28 Class VmDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

1.28.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

1.28.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

1.29 Class VmHardDisk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

1.29.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

1.29.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

1.30 Class VmHdPartition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

1.30.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

1.30.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

1.31 Class VmNet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

1.31.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

1.31.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

2

CONTENTS CONTENTS

1.32 Class VmUsb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

1.32.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

1.32.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

1.33 Class VmSound . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

1.33.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

1.33.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

1.34 Class VmSerial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

1.34.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

1.34.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

1.35 Class VmConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

1.35.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

1.35.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

1.36 Class Vm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

1.36.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

1.36.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

1.37 Class VmGuest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

1.37.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

1.37.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

1.38 Class Share . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

1.38.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

1.38.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

1.39 Class ScreenRes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

1.39.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

1.39.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

1.40 Class BootDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

1.40.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

1.40.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

1.41 Class VmInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

1.41.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

1.41.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

1.42 Class FoundVmInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

1.42.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

1.42.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

1.43 Class AccessRights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

1.43.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

1.43.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

1.44 Class VmToolsInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

1.44.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

1.44.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

1.45 Class Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

1.45.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

1.45.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

1.46 Class StatCpu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

1.46.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

1.46.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

1.47 Class StatNetIface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

1.47.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

1.47.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

1.48 Class StatUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

1.48.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

1.48.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

3

CONTENTS CONTENTS

1.49 Class StatDisk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

1.49.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

1.49.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

1.50 Class StatDiskPart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

1.50.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

1.50.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

1.51 Class StatProcess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

1.51.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

1.51.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

1.52 Class VmDataStatistic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

1.52.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

1.52.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

1.53 Class License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

1.53.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

1.53.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

1.54 Class ServerInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

1.54.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

1.54.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

1.55 Class NetService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

1.55.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

1.55.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

1.56 Class LoginResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

1.56.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

1.56.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

1.57 Class RunningTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

1.57.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

1.57.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

1.58 Class TisRecord . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

1.58.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

1.58.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

1.59 Class OsesMatrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

1.59.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

1.59.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

1.60 Class ProblemReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

1.60.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

1.60.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

1.61 Class ApplianceConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

1.61.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

1.61.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

1.62 Class OfflineManageService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

1.62.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

1.62.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

1.63 Class NetworkShapingEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

1.63.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

1.63.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

1.64 Class NetworkShapingConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

1.64.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

1.64.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

1.65 Class NetworkClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

1.65.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

1.65.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

4

CONTENTS CONTENTS

1.66 Class NetworkRate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

1.66.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

1.66.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

1.67 Class CtTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

1.67.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

1.67.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

1.68 Class UIEmuInput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

1.68.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

1.68.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

1.69 Class UsbIdentity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

1.69.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

1.69.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

1.70 Class FirewallRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

1.70.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

1.70.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

1.71 Class IPPrivNet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

1.71.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

1.71.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

1.72 Class PluginInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

1.72.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

1.72.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

1.73 Class CapturedVideoSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

1.73.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

1.73.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

1.74 Class BackupResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

1.74.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

1.74.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

1.75 Class NetworkShapingBandwidthEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

1.75.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

1.75.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

1.76 Class CpuFeatures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

1.76.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

1.76.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

1.77 Class CPUPool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

1.77.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

1.77.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

1.78 Class VmBackup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

1.78.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

1.78.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

1.79 Class IoDisplayScreenSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

1.79.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

1.80 Class VmIO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

1.80.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

2 Module prlsdkapi.prlsdk 163

2.1 Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

2.2 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

2.3 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

3 Module prlsdkapi.prlsdk.consts 262

3.1 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

5

CONTENTS CONTENTS

4 Module prlsdkapi.prlsdk.errors 316

4.1 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316

Index 412

6

1 Package prlsdkapi

1.1 Modules

Package prlsdkapi

• prlsdk (Section
– consts (Section 3, p. 262)
– errors (Section

2, p. 163)

4, p. 316)

1.2 Functions

conv error(err)

sdk check result(result, err obj =None)

call sdk function(func name, *args)

set sdk library path(path)

get sdk library path()

is sdk initialized()

init desktop sdk()

init desktop wl sdk()

init workstation sdk()

init player sdk()

init server sdk()

conv handle arg(arg)

handle to object(handle )

1.3 Variables

Name Description

prlsdk module Value: os.environ [’PRLSDK’]
sdklib Value: os.environ [’SDKLIB’]
err Value: ’Cannot import module "prlsdk" !’
deinit sdk Value: DeinitSDK()

continued on next page

7

Class PrlSDKError Package prlsdkapi

Name Description

package Value: ’prlsdkapi’

1.4 Class PrlSDKError

object

exceptions.BaseException

exceptions.Exception

prlsdkapi.PrlSDKError

1.4.1 Methods

init (self, result, error code, err obj )

init (...) initializes x; see he lp (type(x)) for signature

x.

Overrides: object.

init extit(inherited documentation)

get result(self )

get details(self )

Inherited from exceptions.Exception

new ()

Inherited from exceptions.BaseException

delattr (), getattribute (), getitem (), getslice (), reduce (), repr (),

setattr (), setstate (), str (), unicode ()

Inherited from object

format (), hash (), redu ce ex (), sizeof (), subclasshook ()

1.4.2 Properties

Name Description

Inherited from exceptions.BaseException

args, message

Inherited from object

class

8

Class ApiHelper Package prlsdkapi

1.5 Class ApiHelper

Provides common Parallels Python API system methods.

1.5.1 Methods

init(self, version)

Initialize the Parallels API library.

init ex(self, nVersion, nAppMode, nFlags=0, nReserved=0)

Initialize the Parallels API library (extended version).

deinit(self )

De-initializes the library.

get version(self )

Return the Parallels API version number.

get app mode(self )

Return the Parallels API application mode.

get result description(self, nErrCode, bIsBriefM essage =True,
bFormated=False)

Evaluate a return code and return a description of the problem.

get message type(self, nErrCode)

Evaluate the specified error code and return its classificatio n (warning,
question, info, etc.).

msg can be ignored(self, nErrCode)

Evaluate an error code and determine if the error is critical.

get crash dumps path(self )

Return the name and path of the directory where Parallels crash dumps are
stored.

9

Class ApiHelper Package prlsdkapi

init crash handler(self, sCrashDumpFileSuffix)

Initiate the standard Parallels crash dump handler.

create strings list(self )

create handles list(self )

create op type list(self, nTypeSize)

get supported oses types(self, nHostOsType)

Determine the supported OS types for the current API mode.

get supported oses versions(self, nHostOsType, nGuestOsType)

get default os version(self, nGuestOsType)

Return the default guest OS version for the specified guest OS type.

send problem report(self, sProblemReport, bUseProxy, sProxyHost,
nProxyPort, sProxyUserLogin, sProxyUserPasswd, nProblemSendTimeout,
nReserved)

Send a problem report to the Parallels support server.

send packed problem report(self, hProblemReport, bUseProxy, sProxyHost,
nProxyPort, sProxyUserLogin, sProxyUserPasswd, nProblemSendTimeout,
nReserved)

unregister remote device(self, device type)

Unregister a remote device.

send remote command(self, hVm, hCommand)

get remote command target(self, hCommand)

get remote command index(self, hCommand)

get remote command code(self, hCommand )

10

Class Debug Package prlsdkapi

get recommend min vm mem(self, nOsVersion)

Return recommended minimal memory size for guest OS defined in the OS
version parameter.

create problem report(self, nReportScheme)

1.6 Class Debug

Provides common Parallels Python API debug methods.

1.6.1 Methods

get handles num(self, type)

Determine how many handles were instantiated in the API library.

prl result to string(self, value)

Return a readable string representation of the Result value.

handle type to string(self, handle type)

Return a readable string representation of the specified handle type.

event type to string(self, event type)

Return a readable string representation of the specified event type.

1.7 Class StringList

ob ject

prlsdkapi. Handle

prlsdkapi.StringList

The StringList class is a generic string container.

11

Class StringList Package prlsdkapi

1.7.1 Methods

init (self, handle=0)

init (...) initiali zes x; see help(type(x)) for signature

x.

Overrides: object. init extit(inherited documentation)

get items count(self )

add item(self, sItem)

get item(self, nItemIndex )

remove item(self, nItemIndex )

len (self )

getitem (self, index )

iter (self )

Inherited from prlsdkapi. Handle

del (), add ref(), free(), get handle type(), get package id(), get type()

Inherited from object

delattr (), format (), getattribute (), hash (), new (), reduce (), reduce ex (),

repr (), setattr (), sizeof (), str (), subclasshook ()

1.7.2 Properties

Name Description

Inherited from object

class

12

Class HandleList Package prlsdkapi

1.8 Class HandleList

ob ject

prlsdkapi. Handle

prlsdkapi.HandleList

A generic container containing a list of handl es (objects).

1.8.1 Methods

init (self, handle=0)

init (...) initiali zes x; see help(type(x)) for signature

x.

Overrides: object. init extit(inherited documentation)

get items count(self )

add item(self, hItem)

get item(self, nItemIndex )

remove item(self, nItemIndex )

len (self )

getitem (self, index )

iter (self )

Inherited from prlsdkapi. Handle

del (), add ref(), free(), get handle type(), get package id(), get type()

Inherited from object

delattr (), format (), getattribute (), hash (), new (), reduce (), reduce ex (),

repr (), setattr (), sizeof (), str (), subclasshook ()

1.8.2 Properties

13

Class OpTypeList Package prlsdkapi

Name Description

Inherited from object

class

1.9 Class OpTypeList

ob ject

prlsdkapi. Handle

prlsdkapi.OpTypeList

1.9.1 Methods

init (self, handle=0)

init (...) initiali zes x; see help(type(x)) for signature

x.

Overrides: object. init extit(inherited documentation)

get items count(self )

get item(self, nItemIndex )

remove item(self, nItemIndex )

get type size(self )

signed(self, nItemIndex )

unsigned(self, nItemIndex )

double(self, nItemIndex )

len (self )

getitem (self, index )

iter (self )

14

Class Result Package prlsdkapi

Inherited from prlsdkapi. Handle

del (), add ref(), free(), get handle type(), get package id(), get type()

Inherited from object

delattr (), format (), getattribute (), hash (), new (), reduce (), reduce ex (),

repr (), setattr (), sizeof (), str (), subclasshook ()

1.9.2 Properties

Name Description

Inherited from object

class

1.10 Class Result

ob ject

prlsdkapi. Handle

prlsdkapi.Result

Contains the results of an asynchronous operation.

1.10.1 Methods

get params count(self )

Determine the number of items (strings, objects) in the Result object.

get param by index(self, nIndex)

Obtain an object containing the results identified by index.

get param(self )

Obtain an object containing the results of the corresponding asynchronous
operation.

get param by index as string(self, nIndex )

Obtain a string result from the Result object identified by index.

15

Class Event Package prlsdkapi

get param as string(self )

Obtain a string result from the Result object.

len (self )

getitem (self, index )

iter (self )

Inherited from prlsdkapi. Handle

del (), init (), add ref(), free(), get handle type(), get package id(), get type()

Inherited from object

delattr (), format (), getattribute (), hash (), new (), reduce (), reduce ex (),

repr (), setattr (), sizeof (), str (), subclasshook ()

1.10.2 Properties

Name Description

Inherited from object

class

1.11 Class Event

ob ject

prlsdkapi. Handle

prlsdkapi.Event

Contains information about a system event or an extended error informati on in an asyn­chronous method invocation.

1.11.1 Methods

get type(self )

Overrides: prlsdkapi. Handle.get type

get server(self )

16

Class Event Package prlsdkapi

get vm(self )

get job(self )

get params count(self )

get param(self, nIndex )

get param by name(self, sParamName)

get err code(self )

get err string(self, bIsBriefMessage, bFormated)

can be ignored(self )

is answer required( self )

get issuer type(self )

get issuer id(self )

create answer event(self, nAnswer)

len (self )

getitem (self, index )

iter (self )

Inherited from prlsdkapi. Handle

del (), init (), add ref(), free(), get handle type(), get package id()

Inherited from object

delattr (), format (), getattribute (), hash (), new (), reduce (), reduce ex (),

repr (), setattr (), sizeof (), str (), subclasshook ()

1.11.2 Properties

17

Class EventParam Package prlsdkapi

Name Description

Inherited from object

class

1.12 Class EventParam

ob ject

prlsdkapi. Handle

prlsdkapi.EventParam

Contains the system event parameter data.

1.12.1 Methods

get name(self )

get type(self )

Overrides: prlsdkapi. Handle.get type

to string(self )

to cdata(self )

to uint32(self )

to int32(self )

to uint64(self )

to int64(self )

to boolean(self )

to handle(self )

Inherited from prlsdkapi. Handle

del (), init (), add ref(), free(), get handle type(), get package id()

18

Class Job Package prlsdkapi

Inherited from object

delattr (), format (), getattribute (), hash (), new (), reduce (), reduce ex (),

repr (), setattr (), sizeof (), str (), subclasshook ()

1.12.2 Properties

Name Description

Inherited from object

class

1.13 Class Job

ob ject

prlsdkapi. Handle

prlsdkapi.Job

Provides methods for managing asynchronous operations (jobs).

1.13.1 Methods

wait(self, msecs=2147483647)

Suspend the main thread and wait for the job to finish.

cancel(self )

Cancel the specified job.

get status(self )

Obtain the current job status.

get progress(self )

Obtain the job progress info.

get ret code(self )

Obtain the return code from the job object.

19

Class Server Package prlsdkapi

get result(self )

Obtain the Result object containing the results returned by the job.

get error(self )

Provide additional job error information.

get op code(self )

Return the job operation code.

is request was sent(self )

Inherited from prlsdkapi. Handle

del (), init (), add ref(), free(), get handle type(), get package id(), get type()

Inherited from object

delattr (), format (), getattribute (), hash (), new (), reduce (), reduce ex (),

repr (), setattr (), sizeof (), str (), subclasshook ()

1.13.2 Properties

Name Description

Inherited from object

class

1.14 Class Server

ob ject

prlsdkapi. Handle

prlsdkapi.Server

The main class pr oviding methods for accessing Parallels Service. Most of the operations in
the Parallels Python API begin with obtaining an instance of this class. The class is used to
establish a connection with the Parallels Service. Its other methods can be used to perform
various tasks related to th e Parallels Service itself, higher level virtual machine tasks, such
as obtaining the virtual machine list or creating a virtual machine, and many others.

20

Class Server Package prlsdkapi

1.14.1 Methods

init (self, handle=0)

init (...) initiali zes x; see help(type(x)) for signature

x.

Overrides: object. init extit(inherited documentation)

check parallels server alive(self, timeout, sServerHostname)

Determine if the Parallels Service on the specified host is running.

Parameters

timeout: The desired operation timeout (in milliseconds).

sServerHostname: The name of the host machine for which to get

the Parallels Service status. To get the status
for the local Parallels Service, the parameter can
be null or empty.

create(self )

Create a new instance of the Server class.

Return Value

A new instance of Server.

login(self, host, user, passwd, sPrevSessionUuid=’’, port cmd =0, timeout=0,
security level=2)

Login to a remote Parallels Service.

login local(self, sPrevSessionUuid=’’, port=0, security level=2)

Login to the local Parallels Service.

logoff(self )

Log off the Parallels Service.

get questions(self )

Allows to synchronously receive questions from Parallels Service.

set non interactive session(self, bNonInteractive, nFlags=0)

Set the session in noninteractive or interactive mode.

is non interactive session(self )

21