Parallels Python API...

305
Parallels Python API Reference API Documentation September 16, 2009 Contents Contents 1 1 Package prlsdkapi 2 1.1 Modules ................................................ 2 1.2 Functions ............................................... 2 1.3 Variables ............................................... 2 1.4 Class PrlSDKError .......................................... 3 1.4.1 Methods ............................................ 3 1.4.2 Properties ........................................... 3 1.5 Class ApiHelper ........................................... 3 1.5.1 Methods ............................................ 4 1.6 Class Debug .............................................. 5 1.6.1 Methods ............................................ 5 1.7 Class StringList ............................................ 5 1.7.1 Methods ............................................ 5 1.7.2 Properties ........................................... 6 1.8 Class HandleList ........................................... 6 1.8.1 Methods ............................................ 7 1.8.2 Properties ........................................... 7 1.9 Class Result .............................................. 8 1.9.1 Methods ............................................ 8 1.9.2 Properties ........................................... 9 1.10 Class Event .............................................. 9 1.10.1 Methods ............................................ 9 1.10.2 Properties ........................................... 10 1.11 Class EventParam .......................................... 11 1.11.1 Methods ............................................ 11 1.11.2 Properties ........................................... 12 1.12 Class Job ............................................... 12 1.12.1 Methods ............................................ 12 1.12.2 Properties ........................................... 13 1.13 Class Server .............................................. 13 1.13.1 Methods ............................................ 14 1.13.2 Properties ........................................... 20 1.14 Class FsInfo .............................................. 20 1.14.1 Methods ............................................ 20 1.14.2 Properties ........................................... 20 1

Transcript of Parallels Python API...

Page 1: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Parallels Python API Reference

API Documentation

September 16, 2009

Contents

Contents 1

1 Package prlsdkapi 2

1.1 Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.2 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.3 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.4 Class PrlSDKError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1.4.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.4.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1.5 Class ApiHelper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.5.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

1.6 Class Debug . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51.6.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

1.7 Class StringList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51.7.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51.7.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

1.8 Class HandleList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61.8.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71.8.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

1.9 Class Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81.9.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81.9.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

1.10 Class Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91.10.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91.10.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

1.11 Class EventParam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111.11.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111.11.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

1.12 Class Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121.12.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121.12.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

1.13 Class Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131.13.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141.13.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

1.14 Class FsInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201.14.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201.14.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

1

Page 2: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

CONTENTS CONTENTS

1.15 Class FsEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211.15.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211.15.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

1.16 Class ServerConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221.16.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221.16.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

1.17 Class HostDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261.17.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261.17.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

1.18 Class HostHardDisk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271.18.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281.18.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

1.19 Class HdPartition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291.19.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291.19.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

1.20 Class HostNet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301.20.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301.20.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

1.21 Class HostPciDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321.21.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321.21.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

1.22 Class UserConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331.22.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331.22.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

1.23 Class UserInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341.23.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341.23.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

1.24 Class DispConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351.24.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351.24.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

1.25 Class VirtualNet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401.25.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401.25.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

1.26 Class PortForward . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441.26.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441.26.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

1.27 Class VmDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451.27.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451.27.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

1.28 Class VmHardDisk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491.28.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491.28.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

1.29 Class VmHdPartition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511.29.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511.29.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

1.30 Class VmNet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521.30.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521.30.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

1.31 Class VmUsb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541.31.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551.31.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

2

Page 3: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

CONTENTS CONTENTS

1.32 Class VmSound . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551.32.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561.32.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

1.33 Class VmSerial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571.33.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571.33.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

1.34 Class VmConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581.34.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581.34.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

1.35 Class Vm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761.35.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761.35.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

1.36 Class VmGuest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 831.36.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 831.36.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

1.37 Class Share . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 841.37.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 841.37.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

1.38 Class ScreenRes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 851.38.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 851.38.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

1.39 Class BootDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861.39.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861.39.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

1.40 Class VmInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 881.40.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 881.40.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

1.41 Class FoundVmInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891.41.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 901.41.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

1.42 Class AccessRights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 911.42.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 911.42.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

1.43 Class VmToolsInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931.43.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931.43.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

1.44 Class Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 941.44.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 941.44.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

1.45 Class StatCpu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951.45.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951.45.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

1.46 Class StatNetIface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961.46.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961.46.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

1.47 Class StatUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 971.47.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 971.47.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

1.48 Class StatDisk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 981.48.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 981.48.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

3

Page 4: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

CONTENTS CONTENTS

1.49 Class StatDiskPart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 991.49.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 991.49.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

1.50 Class StatProcess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 991.50.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1001.50.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

1.51 Class License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1011.51.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1011.51.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

1.52 Class ServerInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1021.52.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1021.52.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

1.53 Class NetService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1031.53.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1031.53.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

1.54 Class LoginResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1041.54.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1041.54.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

1.55 Class RunningTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1051.55.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1051.55.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

1.56 Class TisRecord . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1061.56.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1061.56.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

1.57 Class VmIO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1071.57.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

2 Module prlsdkapi.prlsdk 108

2.1 Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1082.2 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

3 Module prlsdkapi.prlsdk.consts 172

3.1 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

4 Module prlsdkapi.prlsdk.errors 198

4.1 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

4

Page 5: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Package prlsdkapi

1 Package prlsdkapi

1.1 Modules

• prlsdk (Section 2, p. 108)– consts (Section 3, p. 172)– errors (Section 4, p. 198)

1.2 Functions

conv error(err)

sdk check result(result)

call sdk function(func name, *args)

set sdk library path(path)

get sdk library path()

is sdk initialized()

init desktop sdk()

init workstation sdk()

init server sdk()

conv handle arg(arg)

handle to object(handle)

1.3 Variables

Name Description

err Value: ’Cannot import module "prlsdk" !’

deinit sdk Value: DeinitSDK()

5

Page 6: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class ApiHelper Package prlsdkapi

1.4 Class PrlSDKError

object

exceptions.BaseException

exceptions.Exception

prlsdkapi.PrlSDKError

1.4.1 Methods

init (self, error code)

x. init (...) initializes x; see x. class . doc for signature

Overrides: object. init extit(inherited documentation)

get details(self )

Inherited from exceptions.Exception

new ()

Inherited from exceptions.BaseException

delattr (), getattribute (), getitem (), getslice (), reduce (), repr (),setattr (), setstate (), str ()

Inherited from object

hash (), reduce ex ()

1.4.2 Properties

Name Description

Inherited from exceptions.BaseExceptionargs, messageInherited from object

class

1.5 Class ApiHelper

Provides common Parallels Python API system methods.

6

Page 7: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class ApiHelper Package prlsdkapi

1.5.1 Methods

init(self, version)

init ex(self, nVersion, nAppMode, nReserved1=0, nReserved2=0)

deinit(self )

get version(self )

get app mode(self )

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

get message type(self, nErrCode)

msg can be ignored(self, nErrCode)

get crash dumps path(self )

init crash handler(self, sCrashDumpFileSuffix )

create strings list(self )

create handles list(self )

Create a new handle of type PRL HANDLES LIST.

create op type list(self, nTypeSize)

get supported oses types(self, nHostOsType)

get supported oses versions(self, nHostOsType, nGuestOsType)

get default os version(self, nGuestOsType)

unregister remote device(self, device type)

send remote command(self, hVm, hCommand)

7

Page 8: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class Debug Package prlsdkapi

get remote command target(self, hCommand)

get remote command index(self, hCommand)

get remote command code(self, hCommand)

get recommend min vm mem(self, nOsVersion)

1.6 Class Debug

Provides common Parallels Python API debug methods.

1.6.1 Methods

get handles num(self, type)

prl result to string(self, value)

handle type to string(self, handle type)

event type to string(self, event type)

1.7 Class StringList

object

prlsdkapi. Handle

prlsdkapi.StringList

The StringList class is a generic string container.

1.7.1 Methods

init (self, handle=0)

x. init (...) initializes x; see x. class . doc for signature

Overrides: object. init extit(inherited documentation)

8

Page 9: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class HandleList Package prlsdkapi

get items count(self )

add item(self, sItem)

get item(self, nItemIndex )

remove item(self, nItemIndex )

len (self )

getitem (self, index )

iter (self )

next(self )

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.7.2 Properties

Name Description

Inherited from objectclass

1.8 Class HandleList

object

prlsdkapi. Handle

prlsdkapi.HandleList

A generic container containing a list of handles (objects).

9

Page 10: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class HandleList Package prlsdkapi

1.8.1 Methods

init (self, handle=0)

x. init (...) initializes x; see x. class . doc for signature

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 )

next(self )

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.8.2 Properties

Name Description

Inherited from objectclass

10

Page 11: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class Result Package prlsdkapi

1.9 Class Result

object

prlsdkapi. Handle

prlsdkapi.Result

Contains the results of an asynchronous operation.

1.9.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 asynchronousoperation.

get param by index as string(self, nIndex )

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

get param as string(self )

Obtain a string result from the Result object.

len (self )

getitem (self, index )

iter (self )

next(self )

Inherited from prlsdkapi. Handle

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

11

Page 12: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class Event Package prlsdkapi

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.9.2 Properties

Name Description

Inherited from objectclass

1.10 Class Event

object

prlsdkapi. Handle

prlsdkapi.Event

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

1.10.1 Methods

get type(self )

Overrides: prlsdkapi. Handle.get type

get server(self )

get vm(self )

get job(self )

get params count(self )

get param(self, nIndex )

get param by name(self, sParamName)

12

Page 13: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class Event Package prlsdkapi

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 )

next(self )

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.10.2 Properties

Name Description

Inherited from objectclass

13

Page 14: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class EventParam Package prlsdkapi

1.11 Class EventParam

object

prlsdkapi. Handle

prlsdkapi.EventParam

Contains the system event parameter data.

1.11.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()

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

14

Page 15: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class Job Package prlsdkapi

1.11.2 Properties

Name Description

Inherited from objectclass

1.12 Class Job

object

prlsdkapi. Handle

prlsdkapi.Job

Provides methods for managing asynchronous operations (jobs).

1.12.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.

get result(self )

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

15

Page 16: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class Server Package prlsdkapi

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 type()

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.12.2 Properties

Name Description

Inherited from objectclass

1.13 Class Server

object

prlsdkapi. Handle

prlsdkapi.Server

The main class providing methods for accessing Parallels Service. Most of the operations inthe Parallels Python API begin with obtaining an instance of this class. The class is used toestablish a connection with the Parallels Service. Its other methods can be used to performvarious tasks related to the Parallels Service itself, higher level virtual machine tasks, suchas obtaining the virtual machine list or creating a virtual machine, and many others.

16

Page 17: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class Server Package prlsdkapi

1.13.1 Methods

init (self, handle=0)

x. init (...) initializes x; see x. class . doc for signature

Overrides: object. init extit(inherited documentation)

check parallels server alive(self, timeout, sServerHostname)

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

create(self )

Create a new instance of the Server class.

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 )

get srv config(self )

Obtain the ServerConfig object containing the host configurationinformation.

get common prefs(self )

Obtain the DispConfig object containing the specified Parallels Servicepreferences info.

17

Page 18: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class Server Package prlsdkapi

common prefs begin edit(self )

Mark the beginning of the Parallels Service preferences modification operation.This method must be called before making any changes to the ParallelsService common preferences (see DispConfig). When you are done makingthe changes, call Server.common prefs commit to commit the changes.

common prefs commit(self, hDispCfg)

Commit the Parallels Server preferences changes.

get user profile(self )

Obtain the UserConfig object containing profile data of the currently loggedin user.

get user info list(self )

Obtain a list of UserInfo objects containing information about all knownusers.

get user info(self, sUserId)

Obtain the UserInfo object containing information about the specified user.

get virtual network list(self, nFlags=0)

Obtain the VirtualNet object containing information about all existingvirtual networks.

add virtual network(self, hVirtNet, nFlags=0)

Add a new virtual network to the Parallels Service configuration.

update virtual network(self, hVirtNet, nFlags=0)

Update parameters of an existing virtual network.

delete virtual network(self, hVirtNet, nFlags=0)

Remove an existing virtual network from the Parallels Service configuration.

configure generic pci(self, hDevList, nFlags=0)

Configure the PCI device assignment.

18

Page 19: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class Server Package prlsdkapi

get statistics(self )

Obtain the Statistics object containing the host resource usage statistics.

user profile begin edit(self )

user profile commit(self, hUserProfile)

Saves (commits) user profile changes to the Parallels Service.

is connected(self )

Determine if the connection to the specified Parallels Service is active.

get server info(self )

Obtain the ServerInfo object containing the host computer information.

register vm(self, strVmDirPath, bNonInteractiveMode=False)

Register an existing virtual machine with the Parallels Service. This is anasynchronous method.

Parameters

vm path: Name and path of the virtual machinedirectory.

non interactive mode: Set to True to use non-interactive mode.Set to False to use interactive mode.

Return Value

An instance of the Vm class containing information about the virtualmachine that was registered.

register vm ex(self, strVmDirPath, nFlags)

Register an existing virtual machine with Parallels Service (extended version).

create vm(self )

Create a new instaince of the Vm class.

Return Value

A new instance of Vm.

19

Page 20: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class Server Package prlsdkapi

get vm list(self )

Obtain a list of virtual machines from the host.

Return Value

A prlsdk.Result object containing a list of Vm instances. IndividualVm objects can be extracted using the prlsdk.Result.get param

method.

create vm backup(self, sVmUuid, sTargetHost, nTargetPort,sTargetSessionId, strDescription=’’, backup flags=2048, reserved flags=0,force operation=True)

Backup an existing virtual machine to a backup server.

restore vm backup(self, sVmUuid, sBackupUuid, sTargetHost, nTargetPort,sTargetSessionId, sTargetVmHomePath=’’, sTargetVmName=’’,restore flags=0, reserved flags=0, force operation=True)

Restore a virtual machine from a backup server.

get backup tree(self, sVmUuid, sTargetHost, nTargetPort, sTargetSessionId,backup flags=2048, reserved flags=0, force operation=True)

Get backups tree from backup server.

remove vm backup(self, sVmUuid, sBackupUuid, sTargetHost, nTargetPort,sTargetSessionId, remove flags, reserved flags, force operation)

Remove backup of the virtual machine from the backup server.

subscribe to host statistics(self )

Subscribe to receive host statistics. This is an asynchronous method.

Return Value

A Job object.

unsubscribe from host statistics(self )

Cancel the host statistics subscription. Cancel the host statistics subscriptionthat was started using the subscribe from host statistics method. This isan asynchronous method.

Return Value

A Job object.

20

Page 21: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class Server Package prlsdkapi

shutdown(self, bForceShutdown=False)

Shut down the Parallels Service.

fs get disk list(self )

Returns a list of root directories on the host computer.

fs get dir entries(self, path)

Retrieve information about a file system entry on the host.

fs create dir(self, path)

Create a directory in the specified location on the host.

fs remove entry(self, path)

Remove a file system entry from the host computer.

fs can create file(self, path)

Determine if the current user has rights to create a file on the host.

fs rename entry(self, oldPath, newPath)

Rename a file system entry on the host.

update license(self, sKey, sUser, sCompany)

Installs Parallels license on the specified Parallels Service.

get license info(self )

Obtain the License object containing the Parallels license information.

send answer(self, hAnswer)

Send an answer to the Parallels Service in response to a question.

start search vms(self, hStringsList=0)

Searche for unregistered virtual machines at the specified location(s).

net service start(self )

Start the Parallels network service.

21

Page 22: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class Server Package prlsdkapi

net service stop(self )

Stop the Parallels network service.

net service restart(self )

Restarts the Parallels network service.

net service restore defaults(self )

Restores the default settings of the Parallels network service.

get net service status(self )

Obtain the NetService object containing the Parallels network service statusinformation.

get problem report(self )

Obtain a problem report in the event of a virtual machine operation failure.

attach to lost task(self, sTaskId)

Obtain a handle to a running task after the connection to the Parallels Servicewas lost.

fs generate entry name(self, sDirPath, sFilenamePrefix=’’,sFilenameSuffix=’’, sIndexDelimiter=’’)

Automatically generate a unique name for a new directory.

subscribe to perf stats(self, sFilter)

Subscribe to receive perfomance statistics.

unsubscribe from perf stats(self )

Cancels the performance statistics subscription.

get perf stats(self, sFilter)

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

22

Page 23: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class FsInfo Package prlsdkapi

1.13.2 Properties

Name Description

Inherited from objectclass

1.14 Class FsInfo

object

prlsdkapi. Handle

prlsdkapi.FsInfo

Contains information about a file system entry and its immediate child elements (files anddirectories) on the host computer.

1.14.1 Methods

get type(self )

Overrides: prlsdkapi. Handle.get type

get fs type(self )

get child entries count(self )

get child entry(self, nIndex )

get parent entry(self )

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.14.2 Properties

23

Page 24: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class FsEntry Package prlsdkapi

Name Description

Inherited from objectclass

1.15 Class FsEntry

object

prlsdkapi. Handle

prlsdkapi.FsEntry

Contains information about a file system entry (disk, directory, file) on the host computer.

1.15.1 Methods

get absolute path(self )

get relative name(self )

get last modified date(self )

get size(self )

get permissions(self )

get type(self )

Overrides: prlsdkapi. Handle.get type

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.15.2 Properties

24

Page 25: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class ServerConfig Package prlsdkapi

Name Description

Inherited from objectclass

1.16 Class ServerConfig

object

prlsdkapi. Handle

prlsdkapi.ServerConfig

Provides methods for obtaining the host computer configuration information.

1.16.1 Methods

get host ram size(self )

Determine the amount of memory (RAM) available on the host.

get cpu model(self )

Determine the model of CPU of the host machine.

get cpu count(self )

Determine the number of CPUs in the host machine.

get cpu speed(self )

Determine the host machine CPU speed.

get cpu mode(self )

Determine the CPU mode (32 bit or 64 bit) of the host machine.

get cpu hvt(self )

Determine the hardware virtualization type of the host CPU.

get host os type(self )

Return the host operating system type.

25

Page 26: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class ServerConfig Package prlsdkapi

get host os major(self )

Return the major version number of the host operating system.

get host os minor(self )

Return the minor version number of the host operating system.

get host os sub minor(self )

Return the sub-minor version number of the host operating system.

get host os str presentation(self )

Return the full host operating system information as a single string.

is sound default enabled(self )

Determine whether a sound device on the host is enabled or disabled.

is usb supported(self )

Determine if USB is supported on the host.

is vtd supported(self )

Determine whether VT-d is supported on the host.

get hostname(self )

Return the hostname of the specified host or guest.

get default gateway(self )

Obtain the global default gateway address of the specified host or guest.

get dns servers(self )

Obtain the list of IP addresses of DNS servers for the host or guest.

get search domains(self )

Obtain the list of search domains for the specified host or guest.

get floppy disks count(self )

Determine the number of floppy disk drives on the host.

26

Page 27: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class ServerConfig Package prlsdkapi

get floppy disk(self, nIndex )

Obtain the HostDevice object containing information about a floppy diskdrive on the host.

get optical disks count(self )

Determine the number of optical disk drives on the host.

get optical disk(self, nIndex )

Obtain the HostDevice object containing information about an optical diskdrive on the host.

get serial ports count(self )

Determine the number of serial ports available on the host.

get serial port(self, nIndex )

Obtain the HostDevice object containing information about a serial port onthe host.

get parallel ports count(self )

Determine the number of parallel ports on the host.

get parallel port(self, nIndex )

Obtain the HostDevice object containing information about a parallel port onthe host.

get sound output devs count(self )

Determine the number of sound devices available on the host.

get sound output dev(self, nIndex )

Obtain the HostDevice object containing information about a sound device onthe host.

get sound mixer devs count(self )

Determine the number of sound mixer devices available on the host.

get sound mixer dev(self, nIndex )

Obtain the HostDevice object containing information about a sound mixerdevice on the host.

27

Page 28: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class ServerConfig Package prlsdkapi

get printers count(self )

Determine the number of printers installed on the host.

get printer(self, nIndex )

Obtain the HostDevice object containing information about a printerinstalled on the host.

get generic pci devices count(self )

Determine the number of PCI devices installed on the host.

get generic pci device(self, nIndex )

Obtain the HostDevice object containing information about a PCI deviceinstalled on the host.

get generic scsi devices count(self )

Determine the number of generic SCSI devices installed on the host.

get generic scsi device(self, nIndex )

Obtain the HostDevice object containing information about a generic SCSIdevice.

get usb devs count(self )

Determine the number of USB devices on the host.

get usb dev(self, nIndex )

Obtain the HostDevice object containing information about a USB device onthe host.

get hard disks count(self )

Determine the number of hard disk drives on the host.

get hard disk(self, nIndex )

Obtain the HostHardDisk object containing information about a hard disksdrive on the host.

get net adapters count(self )

Determine the number of network adapters available on the server.

28

Page 29: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class HostDevice Package prlsdkapi

get net adapter(self, nIndex )

Obtain the HostNet object containing information about a network adapter inthe host or guest.

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.16.2 Properties

Name Description

Inherited from objectclass

1.17 Class HostDevice

object

prlsdkapi. Handle

prlsdkapi.HostDevice

Known Subclasses: prlsdkapi.HostHardDisk, prlsdkapi.HostNet, prlsdkapi.HostPciDevice

A base class providing methods for obtaining information about physical devices on the hostcomputer. The descendants of this class provide additional methods specific to a particulardevice type.

1.17.1 Methods

get name(self )

Obtain the device name.

get id(self )

Obtain the device ID.

29

Page 30: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class HostHardDisk Package prlsdkapi

get type(self )

Obtain the device type.

Overrides: prlsdkapi. Handle.get type

is connected to vm(self )

Determine whether the device is connected to a virtual machine.

get device state(self )

Determine whether a virtual machine can directly use a PCI device throughIOMMU technology.

set device state(self, nDeviceState)

Set whether a virtual machine can directly use a PCI device through IOMMUtechnology.

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.17.2 Properties

Name Description

Inherited from objectclass

1.18 Class HostHardDisk

object

prlsdkapi. Handle

prlsdkapi.HostDevice

prlsdkapi.HostHardDisk

Provides methods for obtaining information about a physical hard disk on the host computer.

30

Page 31: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class HostHardDisk Package prlsdkapi

1.18.1 Methods

get dev name(self )

Return the hard disk device name.

get dev id(self )

Return the hard disk device id.

get dev size(self )

Return the size of the hard disk device.

get disk index(self )

Return the index of a hard disk device.

get parts count(self )

Determine the number of partitions available on a hard drive.

get part(self, nIndex )

Obtain the HdPartition object identifying the specified hard disk partition.

Inherited from prlsdkapi.HostDevice(Section 1.17)

get device state(), get id(), get name(), get type(), is connected to vm(), set device state()

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.18.2 Properties

Name Description

Inherited from objectclass

31

Page 32: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class HdPartition Package prlsdkapi

1.19 Class HdPartition

object

prlsdkapi. Handle

prlsdkapi.HdPartition

Provides methods for obtaining information about a physical hard disk partition on the hostcomputer.

1.19.1 Methods

get name(self )

Return the hard disk partition name.

get sys name(self )

Return the hard disk partition system name.

get size(self )

Return the hard disk partition size.

get index(self )

Return the index of the hard disk partition.

get type(self )

Return a numerical code identifying the type of the partition.

Overrides: prlsdkapi. Handle.get type

is in use(self )

Determines whether the partition is in use ( contains valid file system, beingused for swap, etc.).

is logical(self )

Determine whether the specified partition is a logical partition.

is active(self )

Determine whether the disk partition is active or inactive.

32

Page 33: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class HostNet Package prlsdkapi

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.19.2 Properties

Name Description

Inherited from objectclass

1.20 Class HostNet

object

prlsdkapi. Handle

prlsdkapi.HostDevice

prlsdkapi.HostNet

Provides methods for obtaining information about a physical network adapter on the hostcomputer.

1.20.1 Methods

get net adapter type(self )

Return the network adapter type.

get sys index(self )

Return the network adapter system index.

is enabled(self )

Determine whether the adapter is enabled or disabled.

33

Page 34: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class HostNet Package prlsdkapi

is configure with dhcp(self )

Determine whether the adapter network settings are configured throughDHCP.

get default gateway(self )

Obtain the default gateway address for the specified network adapter.

get mac address(self )

Return the MAC address of the specified network adapter.

get vlan tag(self )

Return the VLAN tag of the network adapter.

get net addresses(self )

Obtain the list of network addresses (IP address/Subnet mask pairs) assignedto the network adapter.

get dns servers(self )

Obtain the list of addresses of DNS servers assigned to the specified networkadapter.

get search domains(self )

Obtain a list of search domains assigned to the specified network adapter.

Inherited from prlsdkapi.HostDevice(Section 1.17)

get device state(), get id(), get name(), get type(), is connected to vm(), set device state()

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.20.2 Properties

Name Description

Inherited from objectcontinued on next page

34

Page 35: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class HostPciDevice Package prlsdkapi

Name Description

class

1.21 Class HostPciDevice

object

prlsdkapi. Handle

prlsdkapi.HostDevice

prlsdkapi.HostPciDevice

Provides methods for obtaining information about a PCI device on the host computer.

1.21.1 Methods

get device class(self )

Inherited from prlsdkapi.HostDevice(Section 1.17)

get device state(), get id(), get name(), get type(), is connected to vm(), set device state()

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.21.2 Properties

Name Description

Inherited from objectclass

35

Page 36: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class UserConfig Package prlsdkapi

1.22 Class UserConfig

object

prlsdkapi. Handle

prlsdkapi.UserConfig

Provides methods for obtaining information about the currently logged in user and for settingthe user preferences.

1.22.1 Methods

get vm dir uuid(self )

Return name and path of the default virtual machine folder for the ParallelsService.

set vm dir uuid(self, sNewVmDirUuid)

Set the default virtual machine directory name and path for the ParallelsService.

get default vm folder(self )

Return name and path of the default virtual machine directory for the user.

set default vm folder(self, sNewDefaultVmFolder)

Set the default virtual machine folder for the user.

can use mng console(self )

Determine if the user is allowed to use the Parallels Service ManagementConsole.

can change srv sets(self )

Determine if the current user can modify Parallels Service preferences.

is local administrator(self )

Determine if the user is a local administrator on the host where ParallelsService is running.

Inherited from prlsdkapi. Handle

36

Page 37: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class UserInfo Package prlsdkapi

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.22.2 Properties

Name Description

Inherited from objectclass

1.23 Class UserInfo

object

prlsdkapi. Handle

prlsdkapi.UserInfo

Provides methods for obtaining information about the specified Parallels Service user.

1.23.1 Methods

get name(self )

Return the user name.

get uuid(self )

Returns the user Universally Unique Identifier (UUID).

get session count(self )

Return the user active session count.

get default vm folder(self )

Return name and path of the default virtual machine directory for the user.

37

Page 38: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class DispConfig Package prlsdkapi

can change srv sets(self )

Determine whether the specified user is allowed to modify Parallels Servicepreferences.

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.23.2 Properties

Name Description

Inherited from objectclass

1.24 Class DispConfig

object

prlsdkapi. Handle

prlsdkapi.DispConfig

Provides methods for managing Parallels Service preferences.

1.24.1 Methods

get default vm dir(self )

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

Return Value

A string containing name and path of the default virtual machinedirectory.

38

Page 39: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class DispConfig Package prlsdkapi

get reserved mem limit(self )

Determine the amount of physical memory reserved for Parallels Serviceoperation.

Return Value

Integer. The memory size in megabytes.

set reserved mem limit(self, nMemSize)

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

Parameters

nMemSize: Integer. The memory size in megabytes.

get min vm mem(self )

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

Return Value

Integer. The memory size in megabytes.

set min vm mem(self, nMemSize)

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

Parameters

nMemSize: Integer. The memory size in megabytes.

get max vm mem(self )

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

Return Value

Integer. The memory size in megabytes.

set max vm mem(self, nMemSize)

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

Parameters

nMemSize: Integer. The memory size in megabytes.

39

Page 40: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class DispConfig Package prlsdkapi

get recommend max vm mem(self )

Determine the recommended memory size for an individual virtual machine.

Return Value

Integer. The memory size in megabytes.

set recommend max vm mem(self, nMemSize)

Set recommended memory size for an individual virtual machine.

Parameters

nMemSize: Integer. The memory size in megabytes.

get max reserv mem limit(self )

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

set max reserv mem limit(self, nMemSize)

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

Parameters

nMemSize: Integer. The memory size in megabytes.

get min reserv mem limit(self )

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

Return Value

Integer. The memory size in megabytes.

set min reserv mem limit(self, nMemSize)

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

Parameters

nMemSize: Integer. The memory size in megabytes.

40

Page 41: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class DispConfig Package prlsdkapi

is adjust mem auto(self )

Determine whether memory allocation for Parallels Service is performedautomatically or manually.

Return Value

Boolean. True – automatic memory allocation. False – manualallocation.

set adjust mem auto(self, bAdjustMemAuto)

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

Parameters

bAdjustMemAuto: Boolean. Set to True for automatic mode. Set toFalse for manual mode.

is send statistic report(self )

set send statistic report(self, bSendStatisticReport)

get default vnchost name(self )

Return the default VNC host name for the Parallels Service.

Return Value

A string containing the VNC host name.

set default vnchost name(self, sNewHostName)

Set the base VNC host name.

Parameters

sNewHostName: String. The VNC host name to set.

get vncbase port(self )

Obtain the currently set base VNC port number.

Return Value

Integer. The port number.

set vncbase port(self, nPort)

Set the base VNC port number.

Parameters

nPort: Integer. Port number.

41

Page 42: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class DispConfig Package prlsdkapi

can change default settings(self )

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

Return Value

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

set can change default settings(self, bDefaultChangeSettings)

Grant or deny a permission to new users to modify Parallels Servicepreferences.

get min security level(self )

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

Return Value

One of the following constants: PSL LOW SECURITY – PlainTCP/IP (no encryption). PSL NORMAL SECURITY – importantdata is sent and received using SSL. PSL HIGH SECURITY – alldata is sent and received using SSL.

set min security level(self, nMinSecurityLevel)

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

Parameters

nMinSecurityLevel: Security level to set. Can be one of thefollowing constants: PSL LOW SECURITY –Plain TCP/IP (no encryption).PSL NORMAL SECURITY – important datais sent and received using SSL.PSL HIGH SECURITY – all data is sent andreceived using SSL.

get default backup server(self )

set default backup server(self, sBackupServer)

get backup user login(self )

set backup user login(self, sUserLogin)

42

Page 43: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VirtualNet Package prlsdkapi

set backup user password(self, sUserPassword)

is backup user password enabled(self )

set backup user password enabled(self, bUserPasswordEnabled)

get default backup directory(self )

set default backup directory(self, sBackupDirectory)

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.24.2 Properties

Name Description

Inherited from objectclass

1.25 Class VirtualNet

object

prlsdkapi. Handle

prlsdkapi.VirtualNet

Provides methods for managing Parallels virtual networks.

1.25.1 Methods

init (self, handle=0)

x. init (...) initializes x; see x. class . doc for signature

Overrides: object. init extit(inherited documentation)

43

Page 44: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VirtualNet Package prlsdkapi

create(self )

Creates a new instance of VirtualNet.

get network id(self )

Return the ID of the specified virtual network.

set network id(self, sNetworkId)

Set the virtual network ID.

get description(self )

Return the description of the specified virtual network.

set description(self, sDescription)

Sets the virtual network description.

get network type(self )

Return the virtual network type.

set network type(self, nNetworkType)

Set the virtual network type.

get bound card mac(self )

Return the bound card MAC address of the specified virtual network.

set bound card mac(self, sBoundCardMac)

Sets the specified virtual network bound card MAC address.

get adapter name(self )

Return the name of the network adapter in the specified virtual network.

set adapter name(self, sAdapterName)

Sets the specified virtual network adapter name.

get adapter index(self )

Return a numeric index assigned to the network adapter in the specifiedvirtual network.

44

Page 45: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VirtualNet Package prlsdkapi

set adapter index(self, nAdapterIndex )

Sets the specified adapter index.

get host ipaddress(self )

Return the host IP address of the specified virtual network.

set host ipaddress(self, sHostIPAddress)

Set the virtual network host IP address.

get dhcp ipaddress(self )

Return the DHCP IP address of the specified virtual network.

set dhcp ipaddress(self, sDhcpIPAddress)

Set the virtual network DHCP IP address.

get ipnet mask(self )

Return the IP net mask of the specified virtual network.

set ipnet mask(self, sIPNetMask)

Set the virtual network IP net mask.

get vlan tag(self )

Return the VLAN tag of the specified virtual network.

set vlan tag(self, nVlanTag)

Set the VLAN tag for the virtual network.

get ipscope start(self )

Returns the DHCP starting IP address of the specified virtual network.

set ipscope start(self, sIPScopeStart)

Set the virtual network DHCP starting IP address.

get ipscope end(self )

Return the DHCP ending IP address of the specified virtual network.

45

Page 46: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VirtualNet Package prlsdkapi

set ipscope end(self, sIPScopeEnd)

Set the virtual network DHCP ending IP address

is enabled(self )

Determine whether the virtual network is enabled or disabled.

set enabled(self, bEnabled)

Enable or disable the virtual network.

is adapter enabled(self )

Determine whether the virtual network adapter is enabled or disabled.

set adapter enabled(self, bEnabled)

Enable or disable a virtual network adapter.

is dhcpserver enabled(self )

Determine whether the virtual network DHCP server is enabled or disabled.

set dhcpserver enabled(self, bEnabled)

Enable or disable the virtual network DHCP server.

is natserver enabled(self )

Determine whether the specified virtual network NAT server is enabled ordisabled.

set natserver enabled(self, bEnabled)

Enable or disable the virtual network NAT server.

get port forward list(self, nPortFwdType)

Return the port forward entries list.

set port forward list(self, nPortFwdType, hPortFwdList)

Set the port forward entries list.

get bound adapter info(self, hSrvConfig)

Obtain info about a physical adapter, which is bound to the virtual networkobject.

46

Page 47: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class PortForward Package prlsdkapi

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.25.2 Properties

Name Description

Inherited from objectclass

1.26 Class PortForward

object

prlsdkapi. Handle

prlsdkapi.PortForward

Provides access to the Port Forwarding functionality. Using this functionality, you canredirect all incoming data from a specific TCP port on the host computer to a specified portin a specified virtual machine.

1.26.1 Methods

init (self, handle=0)

x. init (...) initializes x; see x. class . doc for signature

Overrides: object. init extit(inherited documentation)

create(self )

get incoming port(self )

set incoming port(self, nIncomingPort)

get redirect ipaddress(self )

47

Page 48: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmDevice Package prlsdkapi

set redirect ipaddress(self, sRedirectIPAddress)

get redirect port(self )

set redirect port(self, nRedirectPort)

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.26.2 Properties

Name Description

Inherited from objectclass

1.27 Class VmDevice

object

prlsdkapi. Handle

prlsdkapi.VmDevice

Known Subclasses: prlsdkapi.VmHardDisk, prlsdkapi.VmNet, prlsdkapi.VmSerial, prlsd-kapi.VmSound, prlsdkapi.VmUsb

A base class providing methods for virtual device management.

1.27.1 Methods

create(self, nDeviceType)

Create a new virtual device object not bound to any virtual machine.

connect(self )

Connect a virtual device to a running virtual machine.

48

Page 49: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmDevice Package prlsdkapi

disconnect(self )

Disconnect a device from a running virtual machine.

create image(self, bRecreateIsAllowed=False, bNonInteractiveMode=True)

Physically create a virtual device image on the host.

resize image(self, nNewSize, nFlags)

Resize the virtual device image.

get index(self )

Return the index identifying the virtual device.

set index(self, nIndex )

Set theindex identifying the virtual device.

remove(self )

Remove the virtual device object from the parent virtual machine list.

get type(self )

Return the virtual device type.

Overrides: prlsdkapi. Handle.get type

is connected(self )

Determine if the virtual device is connected.

set connected(self, bConnected)

Connect the virtual device.

is enabled(self )

Determine if the device is enabled.

set enabled(self, bEnabled)

Enable the specified virtual device.

is remote(self )

Determine if the virtual device is a remote device.

49

Page 50: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmDevice Package prlsdkapi

set remote(self, bRemote)

Change the ’remote’ flag for the specified device.

get emulated type(self )

Return the virtual device emulation type.

set emulated type(self, nEmulatedType)

Sets the virtual device emulation type.

get image path(self )

Return virtual device image path.

set image path(self, sNewImagePath)

Set the virtual device image path.

get sys name(self )

Return the virtual device system name.

set sys name(self, sNewSysName)

Set the virtual device system name.

get friendly name(self )

Return the virtual device user-friendly name.

set friendly name(self, sNewFriendlyName)

Set the virtual device user-friendly name.

get description(self )

Return the description of a virtual device.

set description(self, sNewDescription)

Set the device description.

get iface type(self )

Return the virtual device interface type (IDE or SCSI).

50

Page 51: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmDevice Package prlsdkapi

set iface type(self, nIfaceType)

Set the virtual device interface type (IDE or SCSI).

get stack index(self )

Return the virtual device stack index (position at the IDE/SCSI controllerbus).

set stack index(self, nStackIndex )

Set the virtual device stack index (position at the IDE or SCSI controller bus).

set default stack index(self )

Generates a stack index for the device (the device interface, IDE or SCSI,must be set in advance).

get output file(self )

Return the virtual device output file.

set output file(self, sNewOutputFile)

Set the virtual device output file.

is passthrough(self )

Determine if the passthrough mode is enabled for the mass storage device.

set passthrough(self, bPassthrough)

Enable the passthrough mode for the mass storage device (optical or harddisk).

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.27.2 Properties

51

Page 52: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmHardDisk Package prlsdkapi

Name Description

Inherited from objectclass

1.28 Class VmHardDisk

object

prlsdkapi. Handle

prlsdkapi.VmDevice

prlsdkapi.VmHardDisk

Provides methods for managing virtual hard disks in a virtual machine.

1.28.1 Methods

get disk type(self )

Return the hard disk type.

set disk type(self, nDiskType)

Set the type of the virtual hard disk.

is splitted(self )

Determine if the virtual hard disk is split into multiple files.

set splitted(self, bSplitted)

Sety whether the hard disk should be split into multiple files.

get disk size(self )

Return the hard disk size.

set disk size(self, nDiskSize)

Set the size of the virtual hard disk.

52

Page 53: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmHardDisk Package prlsdkapi

get size on disk(self )

Return the size of the occupied space on the hard disk.

add partition(self )

Assign a boot camp partition to the virtual hard disk.

get partitions count(self )

Determine the number of partitions on the virtual hard disk.

get partition(self, nIndex )

Obtain the VmHdPartition object containing a hard disk partition info.

Inherited from prlsdkapi.VmDevice(Section 1.27)

connect(), create(), create image(), disconnect(), get description(), get emulated type(),get friendly name(), get iface type(), get image path(), get index(), get output file(),get stack index(), get sys name(), get type(), is connected(), is enabled(), is passthrough(),is remote(), remove(), resize image(), set connected(), set default stack index(),set description(), set emulated type(), set enabled(), set friendly name(), set iface type(),set image path(), set index(), set output file(), set passthrough(), set remote(),set stack index(), set sys name()

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.28.2 Properties

Name Description

Inherited from objectclass

53

Page 54: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmHdPartition Package prlsdkapi

1.29 Class VmHdPartition

object

prlsdkapi. Handle

prlsdkapi.VmHdPartition

Provides methods for managing partitions of a virtual hard disk in a virtual machine.

1.29.1 Methods

remove(self )

Remove the specified partition object from the virtual hard disk list.

get sys name(self )

Return the hard disk partition system name.

set sys name(self, sSysName)

Set system name for the disk partition.

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.29.2 Properties

Name Description

Inherited from objectclass

54

Page 55: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmNet Package prlsdkapi

1.30 Class VmNet

object

prlsdkapi. Handle

prlsdkapi.VmDevice

prlsdkapi.VmNet

Provides methods for managing network adapters in a virtual machine.

1.30.1 Methods

get bound adapter index(self )

Return the index of the adapter to which this virtual adapter is bound.

set bound adapter index(self, nIndex )

Set the index of the adapter to which this virtual adapter should be bound.

get bound adapter name(self )

Return the name of the adapter to which this virtual adapter is bound.

set bound adapter name(self, sNewBoundAdapterName)

Set the name of the network adapter to which this virtual adapter will bind.

get mac address(self )

Return the MAC address of the virtual network adapter.

set mac address(self, sNewMacAddress)

Set MAC address to the network adapter.

generate mac addr(self )

Generate a unique MAC address for the virtual network adapter.

is auto apply(self )

Determine if the network adapter is configured to automatically apply networksettings inside guest.

55

Page 56: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmNet Package prlsdkapi

set auto apply(self, bAutoApply)

Set whether the network adapter should be automatically configured.

get net addresses(self )

Obtain the list of IP address/subnet mask pairs which are assigned to thevirtual network adapter.

set net addresses(self, hNetAddressesList)

Set IP addresses/subnet masks to the network adapter.

get dns servers(self )

Obtain the list of DNS servers which are assigned to the virtual networkadapter.

set dns servers(self, hDnsServersList)

Assign DNS servers to the network adapter.

get search domains(self )

Obtain the lists of search domains assigned to the virtual network adapter.

set search domains(self, hSearchDomainsList)

Assign search domains to the network adapter.

is configure with dhcp(self )

Determine if the network adapter is configured through DHCP on the guestOS side.

set configure with dhcp(self, bConfigureWithDhcp)

Set whether the network adapter should be configured through DHCP ormanually.

get default gateway(self )

Obtain the default gateway assigned to the virtual network adapter.

set default gateway(self, sNewDefaultGateway)

Set the default gateway address for the network adapter.

56

Page 57: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmUsb Package prlsdkapi

get virtual network id(self )

Obtain the virtual network ID assigned to the virtual network adapter.

set virtual network id(self, sNewVirtualNetworkId)

Set the virtual network ID for the network adapter.

Inherited from prlsdkapi.VmDevice(Section 1.27)

connect(), create(), create image(), disconnect(), get description(), get emulated type(),get friendly name(), get iface type(), get image path(), get index(), get output file(),get stack index(), get sys name(), get type(), is connected(), is enabled(), is passthrough(),is remote(), remove(), resize image(), set connected(), set default stack index(),set description(), set emulated type(), set enabled(), set friendly name(), set iface type(),set image path(), set index(), set output file(), set passthrough(), set remote(),set stack index(), set sys name()

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.30.2 Properties

Name Description

Inherited from objectclass

1.31 Class VmUsb

object

prlsdkapi. Handle

prlsdkapi.VmDevice

prlsdkapi.VmUsb

Provides methods for managing USB devices in a virtual machine.

57

Page 58: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmSound Package prlsdkapi

1.31.1 Methods

get autoconnect option(self )

Obtain the USB controller autoconnect device option.

set autoconnect option(self, nAutoconnectOption)

Set the USB controller autoconnect device option.

Inherited from prlsdkapi.VmDevice(Section 1.27)

connect(), create(), create image(), disconnect(), get description(), get emulated type(),get friendly name(), get iface type(), get image path(), get index(), get output file(),get stack index(), get sys name(), get type(), is connected(), is enabled(), is passthrough(),is remote(), remove(), resize image(), set connected(), set default stack index(),set description(), set emulated type(), set enabled(), set friendly name(), set iface type(),set image path(), set index(), set output file(), set passthrough(), set remote(),set stack index(), set sys name()

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.31.2 Properties

Name Description

Inherited from objectclass

1.32 Class VmSound

object

prlsdkapi. Handle

prlsdkapi.VmDevice

prlsdkapi.VmSound

58

Page 59: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmSound Package prlsdkapi

Provides methods for managing sound devices in a virtual machine.

1.32.1 Methods

get output dev(self )

Return the output device string for the sound device.

set output dev(self, sNewOutputDev)

Set the output device string for the sound device.

get mixer dev(self )

Return the mixer device string for the sound device.

set mixer dev(self, sNewMixerDev)

Set the mixer device string for the sound device.

Inherited from prlsdkapi.VmDevice(Section 1.27)

connect(), create(), create image(), disconnect(), get description(), get emulated type(),get friendly name(), get iface type(), get image path(), get index(), get output file(),get stack index(), get sys name(), get type(), is connected(), is enabled(), is passthrough(),is remote(), remove(), resize image(), set connected(), set default stack index(),set description(), set emulated type(), set enabled(), set friendly name(), set iface type(),set image path(), set index(), set output file(), set passthrough(), set remote(),set stack index(), set sys name()

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.32.2 Properties

Name Description

Inherited from objectclass

59

Page 60: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmSerial Package prlsdkapi

1.33 Class VmSerial

object

prlsdkapi. Handle

prlsdkapi.VmDevice

prlsdkapi.VmSerial

Provides methods for managing serial ports in a virtual machine.

1.33.1 Methods

get socket mode(self )

Return the socket mode of the virtual serial port.

set socket mode(self, nSocketMode)

Set the socket mode for the virtual serial port.

Inherited from prlsdkapi.VmDevice(Section 1.27)

connect(), create(), create image(), disconnect(), get description(), get emulated type(),get friendly name(), get iface type(), get image path(), get index(), get output file(),get stack index(), get sys name(), get type(), is connected(), is enabled(), is passthrough(),is remote(), remove(), resize image(), set connected(), set default stack index(),set description(), set emulated type(), set enabled(), set friendly name(), set iface type(),set image path(), set index(), set output file(), set passthrough(), set remote(),set stack index(), set sys name()

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.33.2 Properties

Name Description

Inherited from objectclass

60

Page 61: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmConfig Package prlsdkapi

1.34 Class VmConfig

object

prlsdkapi. Handle

prlsdkapi.VmConfig

Known Subclasses: prlsdkapi.Vm

Provides methods for managing the configuration of a virtual machine.

1.34.1 Methods

set default config(self, hSrvConfig, guestOsVersion, needCreateDevices)

Set the default configuration for a new virtual machine based on the guest OStype.

get config validity(self )

Return a constant indicating the virtual machine configuration validity.

add default device(self, hSrvConfig, deviceType)

Automates the task of setting devices in a virtual machine.

is default device needed(self, guestOsVersion, deviceType)

Determine whether a default virtual device is needed for running the OS of thespecified type.

get default mem size(self, guestOsVersion, hostRam)

Return the default RAM size for to the specified OS type and version.

get default hdd size(self, guestOsVersion)

Return the default hard disk size for to the specified OS type and version.

get default video ram size(self, guestOsVersion, hSrvConfig,bIs3DSupportEnabled)

Return the default video RAM size for the specified OS type and version.

61

Page 62: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmConfig Package prlsdkapi

create vm dev(self, nDeviceType)

Create a new virtual device handle of the specified type.

get access rights(self )

Obtain the AccessRights object.

get devs count(self )

Determine the total number of devices of all types installed in the virtualmachine.

get all devices(self )

Obtains objects for all virtual devices in a virtual machine.

get devs count by type(self, vmDeviceType)

Obtain the number of virtual devices of the specified type.

get dev by type(self, vmDeviceType, nIndex )

Obtains a virtual device object according to the specified device type andindex.

get floppy disks count(self )

Determine the number of floppy disk drives in a virtual machine.

get floppy disk(self, nIndex )

Obtain the VmDevice object containing information about a floppy disk drivein a vrtiual machine.

get hard disks count(self )

Determines the number of virtual hard disks in a virtual machine.

get hard disk(self, nIndex )

Obtain the VmHardDisk object containing the specified virtual hard diskinformation.

get optical disks count(self )

Determine the number of optical disks in the specified virtual machine.

62

Page 63: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmConfig Package prlsdkapi

get optical disk(self, nIndex )

Obtain the VmDevice object containing information about a virtual opticaldisk.

get parallel ports count(self )

Determine the number of virtual parallel ports in the virtual machine.

get parallel port(self, nIndex )

Obtains the VmDevice object containing information about a virtual parallelport.

get serial ports count(self )

Determine the number of serial ports in a virtual machine.

get serial port(self, nIndex )

Obtain the VmSerial object containing information about a serial port in avirtual machine.

get sound devs count(self )

Determine the number of sound devices in a virtual machine.

get sound dev(self, nIndex )

Obtain the VmSound object containing information about a sound device in avirtual machine.

get usb devices count(self )

Determine the number of USB devices in a virtual machine.

get usb device(self, nIndex )

Obtain the VmUsb object containing information about a USB device in thevirtual machine.

get net adapters count(self )

Determine the number of network adapters in a virtual machine.

get net adapter(self, nIndex )

Obtain the VmNet object containing information about a virtual networkadapter.

63

Page 64: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmConfig Package prlsdkapi

get generic pci devs count(self )

Determines the number of generic PCI devices in a virtual machine.

get generic pci dev(self, nIndex )

Obtain the VmDevice object containing information about a generic PCIdevice.

get generic scsi devs count(self )

Determines the number of generic SCSI devices in a virtual machine.

get generic scsi dev(self, nIndex )

Obtain the VmDevice object containing information about a SCSI device in avirtual machine.

get display devs count(self )

Determine the number of display devices in a virtual machine.

get display dev(self, nIndex )

Obtains the VmDevice containing information about a display device in avirtual machine.

create share(self )

Create a new instance of Share and add it to the virtual machine list of shares.

get shares count(self )

Determine the number of shared folders in a virtual machine.

get share(self, nShareIndex )

Obtain the Share object containing information about a shared folder.

is smart guard enabled(self )

Determine whether the SmartGuard feature is enabled in the virtual machine.

set smart guard enabled(self, bEnabled)

Enable the SmartGuard feature in the virtual machine.

64

Page 65: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmConfig Package prlsdkapi

is smart guard notify before creation(self )

Determine whether the user will be notified on automatic snapshot creation bySmartGaurd.

set smart guard notify before creation(self, bNotifyBeforeCreation)

Enable or disable notification of automatic snapshot creation, a SmartGuardfeature.

get smart guard interval(self )

Determines the interval at which snapshots are taken by SmartGuard.

set smart guard interval(self, nInterval)

Set the time interval at which snapshots are taken by SmartGuard.

get smart guard max snapshots count(self )

Determines the maximum snapshot count, a SmartGuard setting.

set smart guard max snapshots count(self, nMaxSnapshotsCount)

Set the maximum snapshot count, a SmartGuard feature.

is user defined shared folders enabled(self )

Determine whether the user-defined shared folders are enabled or not.

set user defined shared folders enabled(self, bEnabled)

Enables or disables user-defined shared folders.

is shared profile enabled(self )

Determine whether the Shared Profile feature is enabled in the virtualmachine.

set shared profile enabled(self, bEnabled)

Enable or disable the Shared Profile feature in the virtual machine.

is use desktop(self )

Determine whether the ’use desktop in share profile’ feature is enabled or not.

65

Page 66: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmConfig Package prlsdkapi

set use desktop(self, bEnabled)

Enable or disable the ’undo-desktop’ feature in the shared profile.

is use documents(self )

Determine whether ’use documents in shared profile’ feature is enabled or not.

set use documents(self, bEnabled)

Enable or disable the ’use documents in shared profile’ feature.

is use pictures(self )

Determine whether the ’used pictures in shared profile’ feature is enabled ornot.

set use pictures(self, bEnabled)

Enables or disables the ’use pictures in shared profile’ feature.

is use music(self )

Determine whether the ’use music in shared profile’ feature is enabled or not.

set use music(self, bEnabled)

Enables or disables the ’use music in shared profile’ feature.

is auto capture release mouse(self )

Determine whether the automatic capture and release of the mouse pointer isenabled.

set auto capture release mouse(self, bEnabled)

Enable or disables the automatic capture and release of the mouse pointer in avirtual machine.

is share clipboard(self )

Determine whether the clipboard sharing feature is enabled in the virtualmachine.

set share clipboard(self, bEnabled)

Enable or disable the clipboard sharing feature.

66

Page 67: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmConfig Package prlsdkapi

is offline management enabled(self )

Determine whether the offline management feature is enabled for the virtualmachine.

set offline management enabled(self, bEnabled)

Enables or disables the offline management feature for the virtual machine.

is tools auto update enabled(self )

Enables or disables the Parallels Tools AutoUpdate feature for the virtualmachine.

set tools auto update enabled(self, bEnabled)

Enable or disable the Parallels Tools AutoUpdate feature for the virtualmachine.

is time synchronization enabled(self )

Determine whether the time synchronization feature is enabled in the virtualmachine.

set time synchronization enabled(self, bEnabled)

Enable or disable the time synchronization feature in a virtual machine.

is time sync smart mode enabled(self )

Determine whether the smart time synchronization is enabled in a virtualmachine.

set time sync smart mode enabled(self, bEnabled)

Enable or disable the smart time-synchronization mode in the virtual machine.

get time sync interval(self )

Obtain the time synchronization interval between the host and the guest OS.

set time sync interval(self, nTimeSyncInterval)

Set the time interval at which time in the virtual machine will be synchronizedwith the host OS.

67

Page 68: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmConfig Package prlsdkapi

is allow select boot device(self )

Determine whether the ’select boot device’ option is shown on virtual machinestartup.

set allow select boot device(self, bAllowed)

Switch on/off the ’select boot device’ dialog on virtual machine startup.

create scr res(self )

Create a new instance of ScreenRes and add it to the virtual machineresolution list.

get scr res count(self )

Determine the total number of screen resolutions available in a virtualmachine.

get scr res(self, nScrResIndex )

Obtain the ScreenRes object identifying the specified virtual machine screenresolution.

create boot dev(self )

Create a new instance of BootDevice and add it to the virtual machine bootdevice list.

get boot dev count(self )

Determine the number of devices in the virtual machine boot device prioritylist.

get boot dev(self, nBootDevIndex )

Obtain the BootDevice object containing information about a specified bootdevice.

get name(self )

Return the virtual machine name.

set name(self, sNewVmName)

Set the virtual machine name.

68

Page 69: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmConfig Package prlsdkapi

get hostname(self )

Obtain the hostname of the specified virtual machine.

set hostname(self, sNewVmHostname)

Set the virtual machine hostname.

get default gateway(self )

Return the default gateway of the specified virtual machine.

set default gateway(self, sNewVmDefaultGateway)

Set the virtual machine default gateway.

get uuid(self )

Return the UUID (universally unique ID) of the virtual machine.

set uuid(self, sNewVmUuid)

Set the virtual machine UUID (universally unique ID).

get os type(self )

Return the type of the operating system that the specified virtual machine isrunning.

get os version(self )

Return the version of the operating system that the specified virtual machineis running.

set os version(self, nVmOsVersion)

Set the virtual machine guest OS version.

get ram size(self )

Return the virtual machine memory (RAM) size, in megabytes.

set ram size(self, nVmRamSize)

Sets the virtual machine memory (RAM) size.

69

Page 70: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmConfig Package prlsdkapi

get video ram size(self )

Return the video memory size of the virtual machine.

set video ram size(self, nVmVideoRamSize)

Set the virtual machine video memory size.

get cpu count(self )

Determine the number of CPUs in the virtual machine.

set cpu count(self, nVmCpuCount)

Set the number of CPUs for the virtual machine (the CPUs should be presentin the machine).

get cpu mode(self )

Determine the specified virtual machine CPU mode (32 bit or 64 bit).

set cpu mode(self, nVmCpuMode)

Set CPU mode (32 bit or 64 bit) for the virtual machine.

get cpu accel level(self )

Determine the virtual machine CPU acceleration level.

set cpu accel level(self, nVmCpuAccelLevel)

Set CPU acceleration level for the virtual machine.

is cpu vtx enabled(self )

Determine whether the x86 virtualization (such as Vt-x) is available in thevirtual machine CPU.

set cpu units(self, nVmCpuUnits)

Set the number of CPU units that will be allocated to a virtual machine.

get cpu units(self )

Determine the number of CPU units allocated to a virtual machine.

set cpu limit(self, nVmCpuLimit)

Set the CPU usage limit (in percent) for a virtual machine.

70

Page 71: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmConfig Package prlsdkapi

get cpu limit(self )

Determine the CPU usage limit of a virtual machine, in percent.

get io priority(self )

Determines the specified virtual machine I/O priority.

set io priority(self, nVmIoPriority)

Set the virtual machine I/O priority.

get server uuid(self )

Returns the UUID of the machine hosting the specified virtual machine.

get server host(self )

Return the hostname of the machine hosting the specified virtual machine.

get home path(self )

Return the virtual machine home directory name and path.

get icon(self )

Return the name of the icon file used by the specified virtual machine.

set icon(self, sNewVmIcon)

Set the virtual machine icon.

get description(self )

Return the virtual machine description.

set description(self, sNewVmDescription)

Set the virtual machine description.

is template(self )

Determine whether the virtual machine is a real machine or a template.

set template sign(self, bVmIsTemplate)

Modify a regular virtual machine to become a template, and vise versa.

71

Page 72: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmConfig Package prlsdkapi

get custom property(self )

Return the virtual machine custom property information.

set custom property(self, sNewVmCustomProperty)

Set the virtual machine custom property information.

get auto start(self )

Determine if the specified virtual machine is set to start automatically onParallels Service start.

set auto start(self, nVmAutoStart)

Set the automatic startup option for the virtual machine.

get auto start delay(self )

Returns the time delay used during the virtual machine automatic startup.

set auto start delay(self, nVmAutoStartDelay)

Set the time delay that will be used during the virtual machine automaticstartup.

get start login mode(self )

Return the automatic startup login mode for the virtual machine.

set start login mode(self, nVmStartLoginMode)

Set the automatic startup login mode for the specified virtual machine.

get start user login(self )

Return the user name used during the virtual machine automatic startup.

set start user creds(self, sStartUserLogin, sPassword)

Sset the automatic startup user login and password for the virtual machine.

get auto stop(self )

Determine the mode of the automatic shutdown for the specified virtualmachine.

72

Page 73: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmConfig Package prlsdkapi

set auto stop(self, nVmAutoStop)

Set the automatic shutdown mode for the virtual machine.

get window mode(self )

Return the current window mode the virtual machine is in.

set window mode(self, nVmWindowMode)

Sets the virtual machine window mode.

get last modified date(self )

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

get last modifier name(self )

Return the name of the user who last modified the specified virtual machine.

is guest sharing enabled(self )

Determine if guest sharing is enabled (the guest OS disk drives are visible inthe host OS).

set guest sharing enabled(self, bVmGuestSharingEnabled)

Enables the guest sharing feature.

is guest sharing auto mount(self )

Determine if host shared folders are mounted automatically in the virtualmachine.

set guest sharing auto mount(self, bVmGuestSharingAutoMount)

Set the guest OS sharing auto-mount option.

is guest sharing enable spotlight(self )

Determine if the virtual disks will be added to Spotlight search subsystem(Mac OS X feature).

set guest sharing enable spotlight(self, bVmGuestSharingEnableSpotlight)

Set whether the virtual disks are added to Spotlight search subsystem.

73

Page 74: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmConfig Package prlsdkapi

is host sharing enabled(self )

Determine if host sharing is enabled (host shared folders are visible in theguest OS).

set host sharing enabled(self, bVmHostSharingEnabled)

Enable host sharing for the virtual machine.

is share all host disks(self )

Determine whether all host disks will be present in the guest OS as shares.

set share all host disks(self, bShareAllHostDisks)

Enable sharing of all host disks for the virtual machine.

is share user home dir(self )

Determine whether the host user home directory will be available in the guestOS as a share.

set share user home dir(self, bShareUserHomeDir)

Enable or disable sharing of the host user home directory in the specifiedvirtual machine.

is map shared folders on letters(self )

Determine whether host disks shared with the guest Windows OS will bemapped to drive letters.

set map shared folders on letters(self, bMapSharedFoldersOnLetters)

Enable mapping of shared host disks to drive letters for the virtual machine.

is show task bar(self )

Determine if Windows task bar is displayed in Coherence mode.

set show task bar(self, bVmShowTaskBar)

Show or hide the Windows task bar when the virtual machine is running inCoherence mode.

is relocate task bar(self )

Determine if the task bar relocation feature is enabled in Coherence mode.

74

Page 75: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmConfig Package prlsdkapi

set relocate task bar(self, bVmRelocateTaskBar)

Enable or disable the Windows task bar relocation feature.

is exclude dock(self )

Determine the guest OS window behavior in coherence mode.

set exclude dock(self, bVmExcludeDock)

Set the exclude dock option.

is multi display(self )

Determine if the specified virtual machine uses a multi-display mode.

set multi display(self, bVmMultiDisplay)

Set the virtual machine multi-display option.

get vncmode(self )

Return the VNC mode of the virtual machine.

set vncmode(self, nVmRemoteDisplayMode)

Set the virtual machine VNC mode.

get vncpassword(self )

Return the VNC password for the virtual machine.

set vncpassword(self, sNewVmRemoteDisplayPassword)

Set the virtual machine VNC password.

get vnchost name(self )

Return the VNC hostname of the virtual machine.

set vnchost name(self, sNewVmRemoteDisplayHostName)

Set the virtual machine VNC host name.

get vncport(self )

Return the VNC port number for the virtual machine

75

Page 76: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmConfig Package prlsdkapi

set vncport(self, nVmRemoteDisplayPort)

Set the virtual machine VNC port number.

is scr res enabled(self )

Determine if additional screen resolution support is enabled in the virtualmachine.

set scr res enabled(self, bVmScrResEnabled)

Enable or disable the additional screen resolution support in the virtualmachine.

is disk cache write back(self )

Determine if disk cache write-back is enabled in the virtual machine.

set disk cache write back(self, bVmDiskCacheWriteBack)

Set the virtual machine disk cache write-back option.

is os res in full scr mode(self )

Determines wether the virtual machine OS resolution is in full screen mode.

set os res in full scr mode(self, bVmOsResInFullScrMode)

Turn on/off the virtual machine OS resolution in full screen mode option.

is close app on shutdown(self )

Determine whether the Parallels console app is automatically closed on thevirtual machine shutdown.

set close app on shutdown(self, bVmCloseAppOnShutdown)

Set whether the Parallels console app will be closed on the virtual machineshutdown.

get system flags(self )

Return the virtual machine system flags.

set system flags(self, sNewVmSystemFlags)

Set the virtual machine system flags.

76

Page 77: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmConfig Package prlsdkapi

is disable apic(self )

Determine whether the APIC is enabled during the virtual machine runtime.

set disable apicsign(self, bDisableAPIC )

Set whether the virtual machine should be using APIC during runtime.

get undo disks mode(self )

Determine the current undo-disks mode for the virtual machine.

set undo disks mode(self, nUndoDisksMode)

Set the undo-disks mode for the virtual machine.

get app in dock mode(self )

Determine the current dock mode for the virtual machine.

set app in dock mode(self, nVmAppInDockMode)

Set the dock mode for applications.

get foreground priority(self )

Return foreground processes priority for the specified virtual machine.

set foreground priority(self, nVmForegroundPriority)

Set the virtual machine foreground processes priority.

get background priority(self )

Determine the specified virtual machine background process priority type.

set background priority(self, nVmBackgroundPriority)

Set the virtual machine background processes priority.

is use default answers(self )

Determine whether the use default answers mechanism is active in the virtualmachine.

set use default answers(self, bUseDefaultAnswers)

Enable the use default answers mechanism in a virtual machine.

77

Page 78: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmConfig Package prlsdkapi

get dock icon type(self )

Return the virtual machine dock icon type.

set dock icon type(self, nVmDockIconType)

Sets the virtual machine dock icon type.

get search domains(self )

Obtain the list of search domains that will be assigned to the guest OS.

set search domains(self, hSearchDomainsList)

Set the global search domain list that will be assigned to the guest OS.

get offline services(self )

Obtain the list of services available in the virtual machine offline management.

set offline services(self, hOfflineServicesList)

Set offline services that will be available in the virtual machine offlinemanagement.

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.34.2 Properties

Name Description

Inherited from objectclass

78

Page 79: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class Vm Package prlsdkapi

1.35 Class Vm

object

prlsdkapi. Handle

prlsdkapi.VmConfig

prlsdkapi.Vm

The Vm class provides methods for managing virtual machines. When you want to get theinformation about, modify, or create a virtual machine, you have to obtain an instance ofthis class. The instance is obtained using methods of other classes. The most commonlyused methods are Server.create vm and the Server.get vm list.

1.35.1 Methods

start(self )

Start the virtual machine.

start ex(self, nStartMode=2048, nReserved=0)

Start the virtual machine using the specified mode.

restart(self )

Restart the virtual machine.

stop(self, bGraceful=False)

Stop the virtual machine.

pause(self, bAcpi=False)

Pause the virtual machine.

reset(self )

Reset the virtual machine.

suspend(self )

Suspend the virtual machine.

79

Page 80: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class Vm Package prlsdkapi

get suspended screen(self )

Obtain the virtual machine screen state before it was suspending.

resume(self )

Resume a suspended virtual machine.

drop suspended state(self )

Resets a suspended virtual machine.

create snapshot(self, sName, sDescription=’’)

Create a snapshot of a virtual machine.

switch to snapshot(self, sSnapshotUuid)

Revert the specified virtual machine to the specified snapshot.

delete snapshot(self, sSnapshotUuid, bChild=False)

Delete the specified virtual machine snapshot.

get snapshots tree(self )

Obtain snapshot information for the specified virtual machine.

lock(self, nReserved)

Exclusively locks the virtual machine for current session.

unlock(self, nReserved)

Unlocks a previously locked virtual machine.

update snapshot data(self, sSnapshotUuid, sNewName,sNewDescription=’’)

Modify the virtual machine snapshot name and description.

clone(self, new vm name, new vm root path, bCreateTemplate=False)

Clone an existing virtual machine.

clone ex(self, new vm name, new vm root path, nFlags)

Clone an existing virtual machine (extended version).

80

Page 81: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class Vm Package prlsdkapi

migrate(self, hTargetServer, target home path=’’, migration flags=0,reserved flags=0, force operation=True)

Migrate an existing virtual machine to another host.

migrate ex(self, target host, target port, target session id,target home path=’’, migration flags=0, reserved flags=0,force operation=True)

Migrate an existing virtual machine to another host (extended version).

migrate cancel(self )

Cancel the virtual machine migration operation.

generate vm dev filename(self, sFilenamePrefix=’’, sFilenameSuffix=’’,sIndexDelimiter=’’)

Generate a unique name for a virtual device.

delete(self, hDevicesList=0)

Delete the specified virtual machine from the host.

get problem report(self )

Obtain a problem report on abnormal virtual machine termination.

get state(self )

Obtain the VmInfo object containing the specified virtual machine information.

refresh config(self )

Refresh the virtual machine configuration information.

login in guest(self, sUserName, sUserPassword, nFlags=0)

Create a new console session or binds to an existing GUI session in a virtualmachine.

start vnc server(self, nReserved=0)

Start a VNC server for the specified virtual machine.

stop vnc server(self, nReserved=0)

Stops the VNC server in a virtual machine

81

Page 82: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class Vm Package prlsdkapi

set config(self, hVmCfg)

This is a reserved method.

get config(self )

Obtain a handle of type VmConfig

get statistics(self )

Obtain the Statistics object containing the virtual machine resource usagestatistics.

subscribe to guest statistics(self )

Subscribe to receive the virtual machine performance statistics.

unsubscribe from guest statistics(self )

Cancels the performance statistics subscription.

reg(self, sVmParentPath, bNonInteractiveMode=False)

Create a new virtual machine and register it with the Parallels Service.

unreg(self )

Unregisters the virtual machine from the Parallels Service.

restore(self )

Restores the registered virtual machine.

begin edit(self )

Mark the beginning of the virtual machine configuration changes operation.

commit(self )

Commit the virtual machine configuration changes.

get questions(self )

Synchronously receive questions from the Parallels Service.

create event(self )

Creates an event bound to the virtual machine.

82

Page 83: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class Vm Package prlsdkapi

create unattended floppy(self, nGuestDistroType, sUsername,sCompanyName, sSerialKey)

Create a floppy disk image for unattended Windows installation.

initiate dev state notifications(self )

Initiate the device states notification service.

validate config(self, nSection=1)

Validate the specified section of a virtual machine configuration.

update security(self, hAccessRights)

Updates the security access level for the virtual machine.

install tools(self )

Install Parallels Tools in the virtual machine.

get tools state(self )

Determine whether Parallels Tools is installed in the virtual machine.

run compressor(self )

Initiates the Compressor process.

cancel compressor(self )

Cancels the running Compressor operation.

install utility(self, strId)

Install a specified utility in a virtual machine.

tools send shutdown(self, kind=0)

Initiates graceful shutdown of the virtual machine.

tools get shutdown capabilities(self )

Obtain the available capabilities of a graceful virtual machine shutdown usingParallels Tools.

tis get identifiers(self )

Retrieve a list of identifiers from the Tools Information Service database.

83

Page 84: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class Vm Package prlsdkapi

tis get record(self, sUid)

Obtain the TisRecord object containing a record from the Tools Servicedatabase.

subscribe to perf stats(self, sFilter)

unsubscribe from perf stats(self )

Cancels the Parallels Service performance statistics subscription .

get perf stats(self, sFilter)

auth with guest security db(self, sUserName, sUserPassword, nFlags=0)

Authenticate the user through the guest OS security database.

Inherited from prlsdkapi.VmConfig(Section 1.34)

add default device(), create boot dev(), create scr res(), create share(), create vm dev(),get access rights(), get all devices(), get app in dock mode(), get auto start(), get auto start delay(),get auto stop(), get background priority(), get boot dev(), get boot dev count(),get config validity(), get cpu accel level(), get cpu count(), get cpu limit(), get cpu mode(),get cpu units(), get custom property(), get default gateway(), get default hdd size(),get default mem size(), get default video ram size(), get description(), get dev by type(),get devs count(), get devs count by type(), get display dev(), get display devs count(),get dock icon type(), get floppy disk(), get floppy disks count(), get foreground priority(),get generic pci dev(), get generic pci devs count(), get generic scsi dev(), get generic scsi devs count(),get hard disk(), get hard disks count(), get home path(), get hostname(), get icon(),get io priority(), get last modified date(), get last modifier name(), get name(), get net adapter(),get net adapters count(), get offline services(), get optical disk(), get optical disks count(),get os type(), get os version(), get parallel port(), get parallel ports count(), get ram size(),get scr res(), get scr res count(), get search domains(), get serial port(), get serial ports count(),get server host(), get server uuid(), get share(), get shares count(), get smart guard interval(),get smart guard max snapshots count(), get sound dev(), get sound devs count(),get start login mode(), get start user login(), get system flags(), get time sync interval(),get undo disks mode(), get usb device(), get usb devices count(), get uuid(), get video ram size(),get vnchost name(), get vncmode(), get vncpassword(), get vncport(), get window mode(),is allow select boot device(), is auto capture release mouse(), is close app on shutdown(),is cpu vtx enabled(), is default device needed(), is disable apic(), is disk cache write back(),is exclude dock(), is guest sharing auto mount(), is guest sharing enable spotlight(),is guest sharing enabled(), is host sharing enabled(), is map shared folders on letters(),is multi display(), is offline management enabled(), is os res in full scr mode(), is relocate task bar(),is scr res enabled(), is share all host disks(), is share clipboard(), is share user home dir(),is shared profile enabled(), is show task bar(), is smart guard enabled(), is smart guard notify before

84

Page 85: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class Vm Package prlsdkapi

is template(), is time sync smart mode enabled(), is time synchronization enabled(),is tools auto update enabled(), is use default answers(), is use desktop(), is use documents(),is use music(), is use pictures(), is user defined shared folders enabled(), set allow select boot device(),set app in dock mode(), set auto capture release mouse(), set auto start(), set auto start delay(),set auto stop(), set background priority(), set close app on shutdown(), set cpu accel level(),set cpu count(), set cpu limit(), set cpu mode(), set cpu units(), set custom property(),set default config(), set default gateway(), set description(), set disable apicsign(),set disk cache write back(), set dock icon type(), set exclude dock(), set foreground priority(),set guest sharing auto mount(), set guest sharing enable spotlight(), set guest sharing enabled(),set host sharing enabled(), set hostname(), set icon(), set io priority(), set map shared folders on letters(),set multi display(), set name(), set offline management enabled(), set offline services(),set os res in full scr mode(), set os version(), set ram size(), set relocate task bar(),set scr res enabled(), set search domains(), set share all host disks(), set share clipboard(),set share user home dir(), set shared profile enabled(), set show task bar(), set smart guard enabled(),set smart guard interval(), set smart guard max snapshots count(), set smart guard notify before creation(),set start login mode(), set start user creds(), set system flags(), set template sign(),set time sync interval(), set time sync smart mode enabled(), set time synchronization enabled(),set tools auto update enabled(), set undo disks mode(), set use default answers(),set use desktop(), set use documents(), set use music(), set use pictures(), set user defined shared foldersset uuid(), set video ram size(), set vnchost name(), set vncmode(), set vncpassword(),set vncport(), set window mode()

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.35.2 Properties

Name Description

Inherited from objectclass

85

Page 86: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmGuest Package prlsdkapi

1.36 Class VmGuest

object

prlsdkapi. Handle

prlsdkapi.VmGuest

The VmGuest class is used to run programs and execute administrative tasks in a virtualmachine.

1.36.1 Methods

logout(self, nReserved=0)

Closes a session (or unbinds from a pre-existing session) in a virtual machine.

run program(self, sAppName, hArgsList, hEnvsList, nFlags=16384,nStdin=0, nStdout=0, nStderr=0)

Execute a program in a virtual machine.

get network settings(self, nReserved=0)

Obtain network settings of the guest operating system running in a virtualmachine.

set user passwd(self, sUserName, sUserPasswd, nReserved=0)

Change the password of a guest operating system user.

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.36.2 Properties

Name Description

Inherited from objectclass

86

Page 87: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class Share Package prlsdkapi

1.37 Class Share

object

prlsdkapi. Handle

prlsdkapi.Share

Provides methods for managing host shares. Using this class, you can make a host OSdirectory visible and accessible in a virtual machine.

1.37.1 Methods

remove(self )

get name(self )

set name(self, sNewShareName)

get path(self )

set path(self, sNewSharePath)

get description(self )

set description(self, sNewShareDescription)

is enabled(self )

set enabled(self, bEnabled)

is read only(self )

set read only(self, bReadOnly)

Inherited from prlsdkapi. Handle

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

Inherited from object

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

87

Page 88: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class ScreenRes Package prlsdkapi

repr (), setattr (), str ()

1.37.2 Properties

Name Description

Inherited from objectclass

1.38 Class ScreenRes

object

prlsdkapi. Handle

prlsdkapi.ScreenRes

The class provides methods for modify the list of screen resolutions available in a virtualmachine. By default, only the most common resolutions are supported in a virtual machine.Using methods of this class, you can add additional resolutions and modify the existing onesif needed.

1.38.1 Methods

remove(self )

is enabled(self )

set enabled(self, bEnabled)

get width(self )

set width(self, nWidth)

get height(self )

set height(self, nHeight)

Inherited from prlsdkapi. Handle

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

88

Page 89: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class BootDevice Package prlsdkapi

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.38.2 Properties

Name Description

Inherited from objectclass

1.39 Class BootDevice

object

prlsdkapi. Handle

prlsdkapi.BootDevice

Provides methods for managing boot device in a virtual machine. An object contains infor-mation about an individual boot device.

1.39.1 Methods

remove(self )

Remove the boot device from the boot priority list.

get type(self )

Return the boot device type. Device type is a property that, together withdevice index, is used to uniquely identify a device in the virtual machine bootpriority list.

Return Value

The device type - one of the constants with the PDE prefix, such as:PDE FLOPPY DISK, PDE OPTICAL DISK, PDE HARD DISK.

Overrides: prlsdkapi. Handle.get type

89

Page 90: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class BootDevice Package prlsdkapi

set type(self, nDevType)

Set the boot device type. Use this function when adding a device to the bootdevice priority list. Device type is a property that, together with device index,is used to uniquely identify a device in a virtual machine

Parameters

nDevType: The device type to set. Can be one of the constants withthe PDE prefix, such as: PDE FLOPPY DISK,PDE OPTICAL DISK, PDE HARD DISK.

get index(self )

Obtain the boot device index.

Return Value

Integer. The boot device index.

set index(self, nDevIndex )

Set the boot device index. Device index is a property that, together withdevice type, is used to uniquely identify a device in the virtual machine bootpriority list. The index must be the same index the device has in the mainvirtual machine configuration or it will not be recognized during boot.

Parameters

nDevIndex: Integer. The device index to set.

get sequence index(self )

Obtain the sequence index of the boot device in the boot priority list.

Return Value

Integer. The boot device sequence index.

set sequence index(self, nSequenceIndex )

Assign a sequence index to a boot device in the boot priority list.

Parameters

nSequenceIndex: Integer. The sequence index to set (begins with0).

is in use(self )

Determine whether the boot device is enabled or disabled.

Return Value

Boolean. True indicates that the device is enabled. False indicatesotherwise.

90

Page 91: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmInfo Package prlsdkapi

set in use(self, bInUse)

Enable or disable the boot device in the boot priority list.

Parameters

bInUse: Boolean. Set to True to enable the device. Set to False todisable it.

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.39.2 Properties

Name Description

Inherited from objectclass

1.40 Class VmInfo

object

prlsdkapi. Handle

prlsdkapi.VmInfo

Contains the virtual machine state, access rights, and some other information.

1.40.1 Methods

get state(self )

Return the virtual machine state information.

get access rights(self )

Obtains the AccessRights object containing information about the virtualmachine access rights.

91

Page 92: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class FoundVmInfo Package prlsdkapi

is invalid(self )

Determine if the specified virtual machine is invalid.

is vm waiting for answer(self )

Determine if the specified virtual machine is waiting for an answer to aquestion that it asked.

is vnc server started(self )

Determine whether a VNC server is running for the specified virtual machine.

get addition state(self )

Return the virtual machine addition state information.

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.40.2 Properties

Name Description

Inherited from objectclass

1.41 Class FoundVmInfo

object

prlsdkapi. Handle

prlsdkapi.FoundVmInfo

Contains summary information about a virtual machine that was found as a result of avirtual machine search operation.

92

Page 93: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class FoundVmInfo Package prlsdkapi

1.41.1 Methods

get name(self )

Obtains the virtual machine name.

Return Value

A string containing the virtual machine name.

is old config(self )

Determines whether the vitrual machine configuration is an older version.This method allows to determine whether the virtual machine was createdwith an older or the current version of the Parallels virtualization product thatyou are using.

Return Value

Boolean. True indicates that the virtual machine was created withan older version of the product. False indicates that the virtualmachine was created with the version that you are running.

get osversion(self )

Obtains the guest OS version information.

Return Value

A string containing the guest OS version.

get config path(self )

Obtains the name and path of the directory containing the virtual machinefiles.

Return Value

A string containing the name and path of the virtual machinedirectory.

is template(self )

Determines if the virtual machine is a template. A virtual machine can be aregular virtual machine that you can run or it can be a template used tocreate new virtual machines.

Return Value

Boolean. True indicates that the virtual machine is a template.False indicates that it is a regular virtual machine.

Inherited from prlsdkapi. Handle

93

Page 94: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class AccessRights Package prlsdkapi

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.41.2 Properties

Name Description

Inherited from objectclass

1.42 Class AccessRights

object

prlsdkapi. Handle

prlsdkapi.AccessRights

Contains info about access rights that the users other than the owner have in respect to thevirtual machine.

1.42.1 Methods

is allowed(self, nPermission)

Determine if the current user is authorized to perform a specified task on avirtual machine.

Parameters

nPermission: The task type. Can be one of constants with thePAR prefix, such as: PAR VM START ACCESS,PAR VM STOP ACCESS,PAR VM PAUSE ACCESS,PAR VM RESET ACCESS,PAR VM SUSPEND ACCESS,PAR VM RESUME ACCESS,PAR VM DELETE ACCESS, and others.

Return Value

A Boolean value indicating whether the user is authorized toperform the task. True - authorized; False - not authorized.

94

Page 95: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class AccessRights Package prlsdkapi

get access for others(self )

Obtain the virtual machine access rights information.

Return Value

One of the following access rights constants:PAO VM NOT SHARED - only the owner of the virtual machinehas access to it. PAO VM SHARED ON VIEW - other users canview but not run the virtual machine.PAO VM SHARED ON VIEW AND RUN - other useres can viewand run the vitual machine.PAO VM SHARED ON FULL ACCESS - all users have full accessto a virtual machine.

set access for others(self, nAccessForOthers)

Set access rights on a virtual machine.

Parameters

nAccessForOthers: The access rights level to set. Can be one of thefollowing constants: PAO VM NOT SHARED- only the owner of the virtual machine hasaccess to it. PAO VM SHARED ON VIEW -other users can view the virtual machine.PAO VM SHARED ON VIEW AND RUN -other users can view and run the virtualmachine.PAO VM SHARED ON FULL ACCESS - allusers have full access to the virtual machine.

get owner name(self )

Determine the virtual machine owner name.

Return Value

A string containing the owner name.

is current session owner(self )

Determine if the current user is the owner of the virtual machine.

Return Value

A Boolean value. True - the current user is the owner. False - theuser is not the owner.

Inherited from prlsdkapi. Handle

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

Inherited from object

95

Page 96: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmToolsInfo Package prlsdkapi

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.42.2 Properties

Name Description

Inherited from objectclass

1.43 Class VmToolsInfo

object

prlsdkapi. Handle

prlsdkapi.VmToolsInfo

Provides methods for determining whether the Parallels Tools package is installed in a virtualmachine and for obtaining its status and version information.

1.43.1 Methods

get state(self )

get version(self )

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.43.2 Properties

Name Description

Inherited from objectclass

96

Page 97: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class Statistics Package prlsdkapi

1.44 Class Statistics

object

prlsdkapi. Handle

prlsdkapi.Statistics

Provides methods for obtaining performance statistics from the host computer or an indi-vidual virtual machine.

1.44.1 Methods

get total ram size(self )

get usage ram size(self )

get free ram size(self )

get total swap size(self )

get usage swap size(self )

get free swap size(self )

get os uptime(self )

get disp uptime(self )

get cpus stats count(self )

get cpu stat(self, nIndex )

get ifaces stats count(self )

get iface stat(self, nIndex )

get users stats count(self )

get user stat(self, nIndex )

97

Page 98: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class StatCpu Package prlsdkapi

get disks stats count(self )

get disk stat(self, nIndex )

get procs stats count(self )

get proc stat(self, nIndex )

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.44.2 Properties

Name Description

Inherited from objectclass

1.45 Class StatCpu

object

prlsdkapi. Handle

prlsdkapi.StatCpu

Provides methods for obtaining CPU statistics from the host or a virtual machine.

1.45.1 Methods

get cpu usage(self )

get total time(self )

get user time(self )

98

Page 99: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class StatNetIface Package prlsdkapi

get system time(self )

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.45.2 Properties

Name Description

Inherited from objectclass

1.46 Class StatNetIface

object

prlsdkapi. Handle

prlsdkapi.StatNetIface

Provides methods for obtaining network interface statistics from the host or a virtual ma-chine.

1.46.1 Methods

get system name(self )

get in data size(self )

get out data size(self )

get in pkgs count(self )

get out pkgs count(self )

Inherited from prlsdkapi. Handle

99

Page 100: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class StatUser Package prlsdkapi

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.46.2 Properties

Name Description

Inherited from objectclass

1.47 Class StatUser

object

prlsdkapi. Handle

prlsdkapi.StatUser

Provides methods for obtaining user session statistics.

1.47.1 Methods

get user name(self )

get service name(self )

get host name(self )

get session time(self )

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

100

Page 101: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class StatDisk Package prlsdkapi

1.47.2 Properties

Name Description

Inherited from objectclass

1.48 Class StatDisk

object

prlsdkapi. Handle

prlsdkapi.StatDisk

Provides methods for obtaining disk statistics from the host or a virtual machine.

1.48.1 Methods

get system name(self )

get usage disk space(self )

get free disk space(self )

get parts stats count(self )

get part stat(self, nIndex )

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.48.2 Properties

Name Description

Inherited from objectclass

101

Page 102: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class StatProcess Package prlsdkapi

1.49 Class StatDiskPart

object

prlsdkapi. Handle

prlsdkapi.StatDiskPart

Provides methods for obtaining disk partition statistics from the host or a virtual machine.

1.49.1 Methods

get system name(self )

get usage disk space(self )

get free disk space(self )

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.49.2 Properties

Name Description

Inherited from objectclass

1.50 Class StatProcess

object

prlsdkapi. Handle

prlsdkapi.StatProcess

Provides methods for obtaining system processes statistics.

102

Page 103: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class StatProcess Package prlsdkapi

1.50.1 Methods

get command name(self )

get id(self )

get owner user name(self )

get total mem usage(self )

get real mem usage(self )

get virt mem usage(self )

get start time(self )

get total time(self )

get user time(self )

get system time(self )

get state(self )

get cpu usage(self )

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.50.2 Properties

Name Description

Inherited from objectclass

103

Page 104: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class License Package prlsdkapi

1.51 Class License

object

prlsdkapi. Handle

prlsdkapi.License

1.51.1 Methods

is valid(self )

Determines whether the license if valid or not.

Return Value

Boolean. True indicates that the license if valid. False indicatesotherwise.

get status(self )

Determines the license status.

Return Value

A integer containing the license status code.

get license key(self )

Obtains the liecense key.

Return Value

A sting containing the license key.

get user name(self )

Obtains the name of the user on the license.

Return Value

A string containing the name of the user.

get company name(self )

Obtains the name of the company on the license.

Return Value

A string containing the company name.

Inherited from prlsdkapi. Handle

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

104

Page 105: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class ServerInfo Package prlsdkapi

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.51.2 Properties

Name Description

Inherited from objectclass

1.52 Class ServerInfo

object

prlsdkapi. Handle

prlsdkapi.ServerInfo

Provides methods for obtaining the Parallels Service information.

1.52.1 Methods

get host name(self )

Return the name of the machine hosting the specified Parallels Service.

get os version(self )

Returns the version of the host operating system.

get product version(self )

Return the Parallels product version number.

get cmd port(self )

Return the port number at which the Parallels Service is listening for requests.

get server uuid(self )

Return the host machine UUID (universally unique ID).

Inherited from prlsdkapi. Handle

105

Page 106: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class NetService Package prlsdkapi

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.52.2 Properties

Name Description

Inherited from objectclass

1.53 Class NetService

object

prlsdkapi. Handle

prlsdkapi.NetService

Provides methods for obtaining the Parallels Service network status information.

1.53.1 Methods

get status(self )

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.53.2 Properties

Name Description

Inherited from objectclass

106

Page 107: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class LoginResponse Package prlsdkapi

1.54 Class LoginResponse

object

prlsdkapi. Handle

prlsdkapi.LoginResponse

Contains information returned as a result of a successful Parallels Service login operation.

1.54.1 Methods

get session uuid(self )

Returns the session UUID string (used to restore a session).

get running task count(self )

Return the total number of running tasks.

get running task by index(self, nIndex )

Obtain the RunningTask object containing information about a running task.

get server uuid(self )

Return the host machine UUID.

get host os version(self )

Return the host OS version.

get product version(self )

Return the Parallels product version number.

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.54.2 Properties

107

Page 108: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class RunningTask Package prlsdkapi

Name Description

Inherited from objectclass

1.55 Class RunningTask

object

prlsdkapi. Handle

prlsdkapi.RunningTask

The RunningTask class is used to recover from a lost Parallels Service connection. It allowsto attach to an existing task that was started in the previous session and is still runninginside the Parallels Service.

1.55.1 Methods

get task uuid(self )

get task type(self )

get task parameters as string(self )

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.55.2 Properties

Name Description

Inherited from objectclass

108

Page 109: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class TisRecord Package prlsdkapi

1.56 Class TisRecord

object

prlsdkapi. Handle

prlsdkapi.TisRecord

Provides methods for retrieving information from the Tools Information Service database.

1.56.1 Methods

get uid(self )

get name(self )

get text(self )

get time(self )

get state(self )

Inherited from prlsdkapi. Handle

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

Inherited from object

delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), str ()

1.56.2 Properties

Name Description

Inherited from objectclass

109

Page 110: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Class VmIO Package prlsdkapi

1.57 Class VmIO

prlsdkapi. VmIOMouse

prlsdkapi. VmIOKeyboard

prlsdkapi. VmIODisplay

prlsdkapi.VmIO

1.57.1 Methods

send key event(self, hVm, key list, ev=255, delay=250)

Send a keyboard key event to a virtual machine.

Overrides: prlsdkapi. VmIOKeyboard.send key event extit(inheriteddocumentation)

Inherited from prlsdkapi. VmIOMouse

init (), move(), set pos()

Inherited from prlsdkapi. VmIODisplay

async capture scaled screen region to buffer(), async capture scaled screen region to file(),async capture screen region to file(), connect to vm(), disconnect from vm(), get dyn res tool status(),is sliding mouse enabled(), lock for read(), need cursor data(), set screen surface(),sync capture scaled screen region to file(), sync capture screen region to file(), un-lock()

110

Page 111: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Module prlsdkapi.prlsdk

2 Module prlsdkapi.prlsdk

2.1 Modules

• consts (Section 3, p. 172)• errors (Section 4, p. 198)

2.2 Functions

DeinitializeSDK(...)

DeinitializeSDK

GetSDKLibraryPath(...)

GetSDKLibraryPath

InitializeSDK(...)

InitializeSDK

IsSDKInitialized(...)

IsSDKInitialized

PrlAcl GetAccessForOthers(...)

Obtain the virtual machine access rights information.

PrlAcl GetOwnerName(...)

Determine the virtual machine owner name.

PrlAcl IsAllowed(...)

Determine if the current user is authorized to perform a specified task on avirtual machine.

PrlAcl IsCurrentSessionOwner(...)

Determine if the current user is the owner of the virtual machine.

PrlAcl SetAccessForOthers(...)

Set access rights on a virtual machine.

111

Page 112: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlApi CreateHandlesList(...)

Create a new handle of type PRL HANDLES LIST.

PrlApi CreateOpTypeList(...)

PrlApi CreateOpTypeList

PrlApi CreateStringsList(...)

PrlApi Deinit(...)

PrlApi GetAppMode(...)

PrlApi GetCrashDumpsPath(...)

PrlApi GetCrashDumpsPath

PrlApi GetDefaultOsVersion(...)

PrlApi GetDefaultOsVersion

PrlApi GetMessageType(...)

PrlApi GetRecommendMinVmMem(...)

PrlApi GetRemoteCommandCode(...)

PrlApi GetRemoteCommandIndex(...)

PrlApi GetRemoteCommandTarget(...)

PrlApi GetResultDescription(...)

PrlApi GetSupportedOsesTypes(...)

PrlApi GetSupportedOsesTypes

PrlApi GetSupportedOsesVersions(...)

PrlApi GetSupportedOsesVersions

PrlApi GetVersion(...)

112

Page 113: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlApi Init(...)

PrlApi InitCrashHandler(...)

PrlApi InitCrashHandler

PrlApi InitEx(...)

PrlApi MsgCanBeIgnored(...)

PrlApi SendRemoteCommand(...)

PrlApi UnregisterRemoteDevice(...)

PrlBootDev GetIndex(...)

Obtain the boot device index.

PrlBootDev GetSequenceIndex(...)

Obtain the sequence index of the boot device in the boot priority list.

PrlBootDev GetType(...)

Return the boot device type.

PrlBootDev IsInUse(...)

Determine whether the boot device is enabled or disabled.

PrlBootDev Remove(...)

Remove the boot device from the boot priority list.

PrlBootDev SetInUse(...)

Enable or disable the boot device in the boot priority list.

PrlBootDev SetIndex(...)

Set the boot device index.

PrlBootDev SetSequenceIndex(...)

Assign a sequence index to a boot device in the boot priority list.

113

Page 114: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlBootDev SetType(...)

Set the boot device type.

PrlDbg EventTypeToString(...)

PrlDbg GetHandlesNum(...)

PrlDbg HandleTypeToString(...)

PrlDbg PrlResultToString(...)

PrlDevDisplay AsyncCaptureScaledScreenRegionToBuffer(...)

PrlDevDisplay AsyncCaptureScaledScreenRegionToBuffer

PrlDevDisplay AsyncCaptureScaledScreenRegionToFile(...)

PrlDevDisplay AsyncCaptureScreenRegionToFile(...)

PrlDevDisplay ConnectToVm(...)

PrlDevDisplay DisconnectFromVm(...)

PrlDevDisplay GetDynResToolStatus(...)

PrlDevDisplay IsSlidingMouseEnabled(...)

PrlDevDisplay LockForRead(...)

PrlDevDisplay NeedCursorData(...)

PrlDevDisplay SetScreenSurface(...)

PrlDevDisplay SetScreenSurface

PrlDevDisplay SyncCaptureScaledScreenRegionToFile(...)

PrlDevDisplay SyncCaptureScreenRegionToFile(...)

PrlDevDisplay Unlock(...)

114

Page 115: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlDevKeyboard SendKeyEvent(...)

Send a keyboard key event to a virtual machine.

PrlDevMouse Move(...)

Move a mouse pointer to a relative position and press or releas the specifiedbutton.

PrlDevMouse SetPos(...)

Move a mouse pointer to the specified absolute position and press or releasethe specified button.

PrlDisk ConvertToCurrent(...)

PrlDisk ConvertToCurrent

PrlDisk ConvertToCurrent Local(...)

PrlDisk ConvertToCurrent Local

PrlDisk FlushCache(...)

PrlDisk FlushCache

PrlDisk Free(...)

PrlDisk Free

PrlDisk GetSnapshotsCount(...)

PrlDisk GetSnapshotsCount

PrlDisk GetUserParameter(...)

PrlDisk GetUserParameter

PrlDisk IsCompactable(...)

PrlDisk IsCompactable

PrlDisk SetCachingPolicy(...)

PrlDisk SetCachingPolicy

PrlDisk SetSharedDirectory(...)

PrlDisk SetSharedDirectory

115

Page 116: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlDisk SetSharedDirectory Local(...)

PrlDisk SetSharedDirectory Local

PrlDisk SetUserParameter(...)

PrlDisk SetUserParameter

PrlDisk WaitForCompletion(...)

PrlDisk WaitForCompletion

PrlDispCfg CanChangeDefaultSettings(...)

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

PrlDispCfg GetBackupUserLogin(...)

PrlDispCfg GetBackupUserLogin

PrlDispCfg GetDefaultBackupDirectory(...)

PrlDispCfg GetDefaultBackupDirectory

PrlDispCfg GetDefaultBackupServer(...)

PrlDispCfg GetDefaultBackupServer

PrlDispCfg GetDefaultVNCHostName(...)

Return the default VNC host name for the Parallels Service.

PrlDispCfg GetDefaultVmDir(...)

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

PrlDispCfg GetMaxReservMemLimit(...)

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

PrlDispCfg GetMaxVmMem(...)

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

116

Page 117: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlDispCfg GetMinReservMemLimit(...)

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

PrlDispCfg GetMinSecurityLevel(...)

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

PrlDispCfg GetMinVmMem(...)

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

PrlDispCfg GetRecommendMaxVmMem(...)

Determine the recommended memory size for an individual virtual machine.

PrlDispCfg GetReservedMemLimit(...)

Determine the amount of physical memory reserved for Parallels Serviceoperation.

PrlDispCfg GetVNCBasePort(...)

Obtain the currently set base VNC port number.

PrlDispCfg IsAdjustMemAuto(...)

Determine whether memory allocation for Parallels Service is performedautomatically or manually.

PrlDispCfg IsBackupUserPasswordEnabled(...)

PrlDispCfg IsBackupUserPasswordEnabled

PrlDispCfg IsSendStatisticReport(...)

PrlDispCfg IsSendStatisticReport

PrlDispCfg SetAdjustMemAuto(...)

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

PrlDispCfg SetBackupUserLogin(...)

PrlDispCfg SetBackupUserLogin

117

Page 118: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlDispCfg SetBackupUserPassword(...)

PrlDispCfg SetBackupUserPassword

PrlDispCfg SetBackupUserPasswordEnabled(...)

PrlDispCfg SetBackupUserPasswordEnabled

PrlDispCfg SetCanChangeDefaultSettings(...)

Grant or deny a permission to new users to modify Parallels Servicepreferences.

PrlDispCfg SetDefaultBackupDirectory(...)

PrlDispCfg SetDefaultBackupDirectory

PrlDispCfg SetDefaultBackupServer(...)

PrlDispCfg SetDefaultBackupServer

PrlDispCfg SetDefaultVNCHostName(...)

Set the base VNC host name.

PrlDispCfg SetMaxReservMemLimit(...)

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

PrlDispCfg SetMaxVmMem(...)

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

PrlDispCfg SetMinReservMemLimit(...)

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

PrlDispCfg SetMinSecurityLevel(...)

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

118

Page 119: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlDispCfg SetMinVmMem(...)

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

PrlDispCfg SetRecommendMaxVmMem(...)

Set recommended memory size for an individual virtual machine.

PrlDispCfg SetReservedMemLimit(...)

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

PrlDispCfg SetSendStatisticReport(...)

PrlDispCfg SetSendStatisticReport

PrlDispCfg SetVNCBasePort(...)

Set the base VNC port number.

PrlEvent CanBeIgnored(...)

PrlEvent CreateAnswerEvent(...)

PrlEvent GetErrCode(...)

PrlEvent GetErrString(...)

PrlEvent GetIssuerId(...)

PrlEvent GetIssuerType(...)

PrlEvent GetJob(...)

PrlEvent GetParam(...)

PrlEvent GetParamByName(...)

PrlEvent GetParamsCount(...)

PrlEvent GetServer(...)

119

Page 120: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlEvent GetType(...)

PrlEvent GetVm(...)

PrlEvent IsAnswerRequired(...)

PrlEvtPrm GetName(...)

PrlEvtPrm GetType(...)

PrlEvtPrm ToBoolean(...)

PrlEvtPrm ToCData(...)

PrlEvtPrm ToHandle(...)

PrlEvtPrm ToInt32(...)

PrlEvtPrm ToInt64(...)

PrlEvtPrm ToInt64

PrlEvtPrm ToString(...)

PrlEvtPrm ToUint32(...)

PrlEvtPrm ToUint64(...)

PrlEvtPrm ToUint64

PrlFoundVmInfo GetConfigPath(...)

Obtains the name and path of the directory containing the virtual machinefiles.

PrlFoundVmInfo GetName(...)

Obtains the virtual machine name.

PrlFoundVmInfo GetOSVersion(...)

Obtains the guest OS version information.

120

Page 121: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlFoundVmInfo IsOldConfig(...)

Determines whether the vitrual machine configuration is an older version.

PrlFoundVmInfo IsTemplate(...)

Determines if the virtual machine is a template.

PrlFsEntry GetAbsolutePath(...)

PrlFsEntry GetLastModifiedDate(...)

PrlFsEntry GetPermissions(...)

PrlFsEntry GetRelativeName(...)

PrlFsEntry GetSize(...)

PrlFsEntry GetType(...)

PrlFsInfo GetChildEntriesCount(...)

PrlFsInfo GetChildEntry(...)

PrlFsInfo GetFsType(...)

PrlFsInfo GetParentEntry(...)

PrlFsInfo GetType(...)

PrlHandle AddRef(...)

PrlHandle Free(...)

PrlHandle GetType(...)

PrlHndlList AddItem(...)

PrlHndlList GetItem(...)

121

Page 122: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlHndlList GetItemsCount(...)

PrlHndlList RemoveItem(...)

PrlJob Cancel(...)

Cancel the specified job.

PrlJob GetError(...)

Provide additional job error information.

PrlJob GetOpCode(...)

Return the job operation code.

PrlJob GetProgress(...)

Obtain the job progress info.

PrlJob GetResult(...)

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

PrlJob GetRetCode(...)

Obtain the return code from the job object.

PrlJob GetStatus(...)

Obtain the current job status.

PrlJob IsRequestWasSent(...)

PrlJob IsRequestWasSent

PrlJob Wait(...)

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

PrlLic GetCompanyName(...)

Obtains the name of the company on the license.

PrlLic GetLicenseKey(...)

Obtains the liecense key.

122

Page 123: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlLic GetStatus(...)

Determines the license status.

PrlLic GetUserName(...)

Obtains the name of the user on the license.

PrlLic IsValid(...)

Determines whether the license if valid or not.

PrlLoginResponse GetHostOsVersion(...)

Return the host OS version.

PrlLoginResponse GetProductVersion(...)

Return the Parallels product version number.

PrlLoginResponse GetRunningTaskByIndex(...)

Obtain the RunningTask object containing information about a running task.

PrlLoginResponse GetRunningTaskCount(...)

Return the total number of running tasks.

PrlLoginResponse GetServerUuid(...)

Return the host machine UUID.

PrlLoginResponse GetSessionUuid(...)

Returns the session UUID string (used to restore a session).

PrlNetSvc GetStatus(...)

PrlOpTypeList GetItemsCount(...)

PrlOpTypeList GetItemsCount

PrlOpTypeList GetTypeSize(...)

PrlOpTypeList GetTypeSize

123

Page 124: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlOpTypeList RemoveItem(...)

PrlOpTypeList RemoveItem

PrlPortFwd Create(...)

PrlPortFwd GetIncomingPort(...)

PrlPortFwd GetRedirectIPAddress(...)

PrlPortFwd GetRedirectPort(...)

PrlPortFwd SetIncomingPort(...)

PrlPortFwd SetRedirectIPAddress(...)

PrlPortFwd SetRedirectPort(...)

PrlResult GetParam(...)

Obtain an object containing the results of the corresponding asynchronousoperation.

PrlResult GetParamAsString(...)

Obtain a string result from the Result object.

PrlResult GetParamByIndex(...)

Obtain an object containing the results identified by index.

PrlResult GetParamByIndexAsString(...)

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

PrlResult GetParamsCount(...)

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

PrlRunningTask GetTaskParametersAsString(...)

PrlRunningTask GetTaskType(...)

124

Page 125: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlRunningTask GetTaskUuid(...)

PrlScrRes GetHeight(...)

PrlScrRes GetWidth(...)

PrlScrRes IsEnabled(...)

PrlScrRes Remove(...)

PrlScrRes SetEnabled(...)

PrlScrRes SetHeight(...)

PrlScrRes SetWidth(...)

PrlShare GetDescription(...)

PrlShare GetName(...)

PrlShare GetPath(...)

PrlShare IsEnabled(...)

PrlShare IsReadOnly(...)

PrlShare Remove(...)

PrlShare SetDescription(...)

PrlShare SetEnabled(...)

PrlShare SetName(...)

PrlShare SetPath(...)

PrlShare SetReadOnly(...)

125

Page 126: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlSrvCfgDev GetDeviceState(...)

Determine whether a virtual machine can directly use a PCI device throughIOMMU technology.

PrlSrvCfgDev GetId(...)

Obtain the device ID.

PrlSrvCfgDev GetName(...)

Obtain the device name.

PrlSrvCfgDev GetType(...)

Obtain the device type.

PrlSrvCfgDev IsConnectedToVm(...)

Determine whether the device is connected to a virtual machine.

PrlSrvCfgDev SetDeviceState(...)

Set whether a virtual machine can directly use a PCI device through IOMMUtechnology.

PrlSrvCfgHddPart GetIndex(...)

Return the index of the hard disk partition.

PrlSrvCfgHddPart GetName(...)

Return the hard disk partition name.

PrlSrvCfgHddPart GetSize(...)

Return the hard disk partition size.

PrlSrvCfgHddPart GetSysName(...)

Return the hard disk partition system name.

PrlSrvCfgHddPart GetType(...)

Return a numerical code identifying the type of the partition.

PrlSrvCfgHddPart IsActive(...)

Determine whether the disk partition is active or inactive.

126

Page 127: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlSrvCfgHddPart IsInUse(...)

Determines whether the partition is in use ( contains valid file system, beingused for swap, etc.).

PrlSrvCfgHddPart IsLogical(...)

Determine whether the specified partition is a logical partition.

PrlSrvCfgHdd GetDevId(...)

Return the hard disk device id.

PrlSrvCfgHdd GetDevName(...)

Return the hard disk device name.

PrlSrvCfgHdd GetDevSize(...)

Return the size of the hard disk device.

PrlSrvCfgHdd GetDiskIndex(...)

Return the index of a hard disk device.

PrlSrvCfgHdd GetPart(...)

Obtain the HdPartition object identifying the specified hard disk partition.

PrlSrvCfgHdd GetPartsCount(...)

Determine the number of partitions available on a hard drive.

PrlSrvCfgNet GetDefaultGateway(...)

Obtain the default gateway address for the specified network adapter.

PrlSrvCfgNet GetDnsServers(...)

Obtain the list of addresses of DNS servers assigned to the specified networkadapter.

PrlSrvCfgNet GetMacAddress(...)

Return the MAC address of the specified network adapter.

PrlSrvCfgNet GetNetAdapterType(...)

Return the network adapter type.

127

Page 128: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlSrvCfgNet GetNetAddresses(...)

Obtain the list of network addresses (IP address/Subnet mask pairs) assignedto the network adapter.

PrlSrvCfgNet GetSearchDomains(...)

Obtain a list of search domains assigned to the specified network adapter.

PrlSrvCfgNet GetSysIndex(...)

Return the network adapter system index.

PrlSrvCfgNet GetVlanTag(...)

Return the VLAN tag of the network adapter.

PrlSrvCfgNet IsConfigureWithDhcp(...)

Determine whether the adapter network settings are configured throughDHCP.

PrlSrvCfgNet IsEnabled(...)

Determine whether the adapter is enabled or disabled.

PrlSrvCfgPci GetDeviceClass(...)

PrlSrvCfg GetCpuCount(...)

Determine the number of CPUs in the host machine.

PrlSrvCfg GetCpuHvt(...)

Determine the hardware virtualization type of the host CPU.

PrlSrvCfg GetCpuMode(...)

Determine the CPU mode (32 bit or 64 bit) of the host machine.

PrlSrvCfg GetCpuModel(...)

Determine the model of CPU of the host machine.

PrlSrvCfg GetCpuSpeed(...)

Determine the host machine CPU speed.

128

Page 129: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlSrvCfg GetDefaultGateway(...)

Obtain the global default gateway address of the specified host or guest.

PrlSrvCfg GetDnsServers(...)

Obtain the list of IP addresses of DNS servers for the host or guest.

PrlSrvCfg GetFloppyDisk(...)

Obtain the HostDevice object containing information about a floppy diskdrive on the host.

PrlSrvCfg GetFloppyDisksCount(...)

Determine the number of floppy disk drives on the host.

PrlSrvCfg GetGenericPciDevice(...)

Obtain the HostDevice object containing information about a PCI deviceinstalled on the host.

PrlSrvCfg GetGenericPciDevicesCount(...)

Determine the number of PCI devices installed on the host.

PrlSrvCfg GetGenericScsiDevice(...)

Obtain the HostDevice object containing information about a generic SCSIdevice.

PrlSrvCfg GetGenericScsiDevicesCount(...)

Determine the number of generic SCSI devices installed on the host.

PrlSrvCfg GetHardDisk(...)

Obtain the HostHardDisk object containing information about a hard disksdrive on the host.

PrlSrvCfg GetHardDisksCount(...)

Determine the number of hard disk drives on the host.

PrlSrvCfg GetHostOsMajor(...)

Return the major version number of the host operating system.

129

Page 130: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlSrvCfg GetHostOsMinor(...)

Return the minor version number of the host operating system.

PrlSrvCfg GetHostOsStrPresentation(...)

Return the full host operating system information as a single string.

PrlSrvCfg GetHostOsSubMinor(...)

Return the sub-minor version number of the host operating system.

PrlSrvCfg GetHostOsType(...)

Return the host operating system type.

PrlSrvCfg GetHostRamSize(...)

Determine the amount of memory (RAM) available on the host.

PrlSrvCfg GetHostname(...)

Return the hostname of the specified host or guest.

PrlSrvCfg GetNetAdapter(...)

Obtain the HostNet object containing information about a network adapter inthe host or guest.

PrlSrvCfg GetNetAdaptersCount(...)

Determine the number of network adapters available on the server.

PrlSrvCfg GetOpticalDisk(...)

Obtain the HostDevice object containing information about an optical diskdrive on the host.

PrlSrvCfg GetOpticalDisksCount(...)

Determine the number of optical disk drives on the host.

PrlSrvCfg GetParallelPort(...)

Obtain the HostDevice object containing information about a parallel port onthe host.

130

Page 131: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlSrvCfg GetParallelPortsCount(...)

Determine the number of parallel ports on the host.

PrlSrvCfg GetPrinter(...)

Obtain the HostDevice object containing information about a printerinstalled on the host.

PrlSrvCfg GetPrintersCount(...)

Determine the number of printers installed on the host.

PrlSrvCfg GetSearchDomains(...)

Obtain the list of search domains for the specified host or guest.

PrlSrvCfg GetSerialPort(...)

Obtain the HostDevice object containing information about a serial port onthe host.

PrlSrvCfg GetSerialPortsCount(...)

Determine the number of serial ports available on the host.

PrlSrvCfg GetSoundMixerDev(...)

Obtain the HostDevice object containing information about a sound mixerdevice on the host.

PrlSrvCfg GetSoundMixerDevsCount(...)

Determine the number of sound mixer devices available on the host.

PrlSrvCfg GetSoundOutputDev(...)

Obtain the HostDevice object containing information about a sound device onthe host.

PrlSrvCfg GetSoundOutputDevsCount(...)

Determine the number of sound devices available on the host.

PrlSrvCfg GetUsbDev(...)

Obtain the HostDevice object containing information about a USB device onthe host.

131

Page 132: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlSrvCfg GetUsbDevsCount(...)

Determine the number of USB devices on the host.

PrlSrvCfg IsSoundDefaultEnabled(...)

Determine whether a sound device on the host is enabled or disabled.

PrlSrvCfg IsUsbSupported(...)

Determine if USB is supported on the host.

PrlSrvCfg IsVtdSupported(...)

Determine whether VT-d is supported on the host.

PrlSrvInfo GetCmdPort(...)

Return the port number at which the Parallels Service is listening for requests.

PrlSrvInfo GetHostName(...)

Return the name of the machine hosting the specified Parallels Service.

PrlSrvInfo GetOsVersion(...)

Returns the version of the host operating system.

PrlSrvInfo GetProductVersion(...)

Return the Parallels product version number.

PrlSrvInfo GetServerUuid(...)

Return the host machine UUID (universally unique ID).

PrlSrv AddVirtualNetwork(...)

Add a new virtual network to the Parallels Service configuration.

PrlSrv AttachToLostTask(...)

Obtain a handle to a running task after the connection to the Parallels Servicewas lost.

PrlSrv CheckParallelsServerAlive(...)

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

132

Page 133: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlSrv CommonPrefsBeginEdit(...)

Mark the beginning of the Parallels Service preferences modification operation.

PrlSrv CommonPrefsCommit(...)

Commit the Parallels Server preferences changes.

PrlSrv ConfigureGenericPci(...)

Configure the PCI device assignment.

PrlSrv Create(...)

Create a new instance of the Server class.

PrlSrv CreateVm(...)

Create a new instaince of the Vm class.

PrlSrv CreateVmBackup(...)

Backup an existing virtual machine to a backup server.

PrlSrv DeleteVirtualNetwork(...)

Remove an existing virtual network from the Parallels Service configuration.

PrlSrv FsCanCreateFile(...)

Determine if the current user has rights to create a file on the host.

PrlSrv FsCreateDir(...)

Create a directory in the specified location on the host.

PrlSrv FsGenerateEntryName(...)

Automatically generate a unique name for a new directory.

PrlSrv FsGetDirEntries(...)

Retrieve information about a file system entry on the host.

PrlSrv FsGetDiskList(...)

Returns a list of root directories on the host computer.

133

Page 134: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlSrv FsRemoveEntry(...)

Remove a file system entry from the host computer.

PrlSrv FsRenameEntry(...)

Rename a file system entry on the host.

PrlSrv GetBackupTree(...)

Get backups tree from backup server.

PrlSrv GetCommonPrefs(...)

Obtain the DispConfig object containing the specified Parallels Servicepreferences info.

PrlSrv GetLicenseInfo(...)

Obtain the License object containing the Parallels license information.

PrlSrv GetNetServiceStatus(...)

Obtain the NetService object containing the Parallels network service statusinformation.

PrlSrv GetPerfStats(...)

PrlSrv GetPerfStats

PrlSrv GetProblemReport(...)

Obtain a problem report in the event of a virtual machine operation failure.

PrlSrv GetQuestions(...)

Allows to synchronously receive questions from Parallels Service.

PrlSrv GetServerInfo(...)

Obtain the ServerInfo object containing the host computer information.

PrlSrv GetSrvConfig(...)

Obtain the ServerConfig object containing the host configurationinformation.

134

Page 135: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlSrv GetStatistics(...)

Obtain the Statistics object containing the host resource usage statistics.

PrlSrv GetUserInfo(...)

Obtain the UserInfo object containing information about the specified user.

PrlSrv GetUserInfoList(...)

Obtain a list of UserInfo objects containing information about all knownusers.

PrlSrv GetUserProfile(...)

Obtain the UserConfig object containing profile data of the currently loggedin user.

PrlSrv GetVirtualNetworkList(...)

Obtain the VirtualNet object containing information about all existingvirtual networks.

PrlSrv GetVmList(...)

Obtain a list of virtual machines from the host.

PrlSrv IsConnected(...)

Determine if the connection to the specified Parallels Service is active.

PrlSrv IsNonInteractiveSession(...)

PrlSrv IsNonInteractiveSession

PrlSrv Login(...)

Login to a remote Parallels Service.

PrlSrv LoginLocal(...)

Login to the local Parallels Service.

PrlSrv Logoff(...)

Log off the Parallels Service.

135

Page 136: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlSrv NetServiceRestart(...)

Restarts the Parallels network service.

PrlSrv NetServiceRestoreDefaults(...)

Restores the default settings of the Parallels network service.

PrlSrv NetServiceStart(...)

Start the Parallels network service.

PrlSrv NetServiceStop(...)

Stop the Parallels network service.

PrlSrv RegisterVm(...)

Register an existing virtual machine with the Parallels Service.

PrlSrv RegisterVmEx(...)

Register an existing virtual machine with Parallels Service (extended version).

PrlSrv RemoveVmBackup(...)

Remove backup of the virtual machine from the backup server.

PrlSrv RestoreVmBackup(...)

Restore a virtual machine from a backup server.

PrlSrv SendAnswer(...)

Send an answer to the Parallels Service in response to a question.

PrlSrv SetNonInteractiveSession(...)

Set the session in noninteractive or interactive mode.

PrlSrv Shutdown(...)

Shut down the Parallels Service.

PrlSrv StartSearchVms(...)

Searche for unregistered virtual machines at the specified location(s).

136

Page 137: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlSrv SubscribeToHostStatistics(...)

Subscribe to receive host statistics.

PrlSrv SubscribeToPerfStats(...)

Subscribe to receive perfomance statistics.

PrlSrv UnsubscribeFromHostStatistics(...)

Cancel the host statistics subscription.

PrlSrv UnsubscribeFromPerfStats(...)

Cancels the performance statistics subscription.

PrlSrv UpdateLicense(...)

Installs Parallels license on the specified Parallels Service.

PrlSrv UpdateVirtualNetwork(...)

Update parameters of an existing virtual network.

PrlSrv UserProfileBeginEdit(...)

PrlSrv UserProfileBeginEdit

PrlSrv UserProfileCommit(...)

Saves (commits) user profile changes to the Parallels Service.

PrlStatCpu GetCpuUsage(...)

PrlStatCpu GetSystemTime(...)

PrlStatCpu GetTotalTime(...)

PrlStatCpu GetUserTime(...)

PrlStatDiskPart GetFreeDiskSpace(...)

PrlStatDiskPart GetSystemName(...)

PrlStatDiskPart GetUsageDiskSpace(...)

137

Page 138: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlStatDisk GetFreeDiskSpace(...)

PrlStatDisk GetPartStat(...)

PrlStatDisk GetPartsStatsCount(...)

PrlStatDisk GetSystemName(...)

PrlStatDisk GetUsageDiskSpace(...)

PrlStatIface GetInDataSize(...)

PrlStatIface GetInPkgsCount(...)

PrlStatIface GetOutDataSize(...)

PrlStatIface GetOutPkgsCount(...)

PrlStatIface GetSystemName(...)

PrlStatProc GetCommandName(...)

PrlStatProc GetCpuUsage(...)

PrlStatProc GetId(...)

PrlStatProc GetOwnerUserName(...)

PrlStatProc GetRealMemUsage(...)

PrlStatProc GetStartTime(...)

PrlStatProc GetState(...)

PrlStatProc GetSystemTime(...)

PrlStatProc GetTotalMemUsage(...)

PrlStatProc GetTotalTime(...)

138

Page 139: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlStatProc GetUserTime(...)

PrlStatProc GetVirtMemUsage(...)

PrlStatUser GetHostName(...)

PrlStatUser GetServiceName(...)

PrlStatUser GetSessionTime(...)

PrlStatUser GetUserName(...)

PrlStat GetCpuStat(...)

PrlStat GetCpusStatsCount(...)

PrlStat GetDiskStat(...)

PrlStat GetDisksStatsCount(...)

PrlStat GetDispUptime(...)

PrlStat GetFreeRamSize(...)

PrlStat GetFreeSwapSize(...)

PrlStat GetIfaceStat(...)

PrlStat GetIfacesStatsCount(...)

PrlStat GetOsUptime(...)

PrlStat GetProcStat(...)

PrlStat GetProcsStatsCount(...)

PrlStat GetTotalRamSize(...)

PrlStat GetTotalSwapSize(...)

139

Page 140: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlStat GetUsageRamSize(...)

PrlStat GetUsageSwapSize(...)

PrlStat GetUserStat(...)

PrlStat GetUsersStatsCount(...)

PrlStrList AddItem(...)

PrlStrList GetItem(...)

PrlStrList GetItemsCount(...)

PrlStrList RemoveItem(...)

PrlTisRecord GetName(...)

PrlTisRecord GetName

PrlTisRecord GetState(...)

PrlTisRecord GetState

PrlTisRecord GetText(...)

PrlTisRecord GetText

PrlTisRecord GetTime(...)

PrlTisRecord GetTime

PrlTisRecord GetUid(...)

PrlTisRecord GetUid

PrlUsrCfg CanChangeSrvSets(...)

Determine if the current user can modify Parallels Service preferences.

PrlUsrCfg CanUseMngConsole(...)

Determine if the user is allowed to use the Parallels Service ManagementConsole.

140

Page 141: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlUsrCfg GetDefaultVmFolder(...)

Return name and path of the default virtual machine directory for the user.

PrlUsrCfg GetVmDirUuid(...)

Return name and path of the default virtual machine folder for the ParallelsService.

PrlUsrCfg IsLocalAdministrator(...)

Determine if the user is a local administrator on the host where ParallelsService is running.

PrlUsrCfg SetDefaultVmFolder(...)

Set the default virtual machine folder for the user.

PrlUsrCfg SetVmDirUuid(...)

Set the default virtual machine directory name and path for the ParallelsService.

PrlUsrInfo CanChangeSrvSets(...)

Determine whether the specified user is allowed to modify Parallels Servicepreferences.

PrlUsrInfo GetDefaultVmFolder(...)

Return name and path of the default virtual machine directory for the user.

PrlUsrInfo GetName(...)

Return the user name.

PrlUsrInfo GetSessionCount(...)

Return the user active session count.

PrlUsrInfo GetUuid(...)

Returns the user Universally Unique Identifier (UUID).

PrlVirtNet Create(...)

Creates a new instance of VirtualNet.

141

Page 142: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVirtNet GetAdapterIndex(...)

Return a numeric index assigned to the network adapter in the specifiedvirtual network.

PrlVirtNet GetAdapterName(...)

Return the name of the network adapter in the specified virtual network.

PrlVirtNet GetBoundAdapterInfo(...)

Obtain info about a physical adapter, which is bound to the virtual networkobject.

PrlVirtNet GetBoundCardMac(...)

Return the bound card MAC address of the specified virtual network.

PrlVirtNet GetDescription(...)

Return the description of the specified virtual network.

PrlVirtNet GetDhcpIPAddress(...)

Return the DHCP IP address of the specified virtual network.

PrlVirtNet GetHostIPAddress(...)

Return the host IP address of the specified virtual network.

PrlVirtNet GetIPNetMask(...)

Return the IP net mask of the specified virtual network.

PrlVirtNet GetIPScopeEnd(...)

Return the DHCP ending IP address of the specified virtual network.

PrlVirtNet GetIPScopeStart(...)

Returns the DHCP starting IP address of the specified virtual network.

PrlVirtNet GetNetworkId(...)

Return the ID of the specified virtual network.

142

Page 143: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVirtNet GetNetworkType(...)

Return the virtual network type.

PrlVirtNet GetPortForwardList(...)

Return the port forward entries list.

PrlVirtNet GetVlanTag(...)

Return the VLAN tag of the specified virtual network.

PrlVirtNet IsAdapterEnabled(...)

Determine whether the virtual network adapter is enabled or disabled.

PrlVirtNet IsDHCPServerEnabled(...)

Determine whether the virtual network DHCP server is enabled or disabled.

PrlVirtNet IsEnabled(...)

Determine whether the virtual network is enabled or disabled.

PrlVirtNet IsNATServerEnabled(...)

Determine whether the specified virtual network NAT server is enabled ordisabled.

PrlVirtNet SetAdapterEnabled(...)

Enable or disable a virtual network adapter.

PrlVirtNet SetAdapterIndex(...)

Sets the specified adapter index.

PrlVirtNet SetAdapterName(...)

Sets the specified virtual network adapter name.

PrlVirtNet SetBoundCardMac(...)

Sets the specified virtual network bound card MAC address.

PrlVirtNet SetDHCPServerEnabled(...)

Enable or disable the virtual network DHCP server.

143

Page 144: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVirtNet SetDescription(...)

Sets the virtual network description.

PrlVirtNet SetDhcpIPAddress(...)

Set the virtual network DHCP IP address.

PrlVirtNet SetEnabled(...)

Enable or disable the virtual network.

PrlVirtNet SetHostIPAddress(...)

Set the virtual network host IP address.

PrlVirtNet SetIPNetMask(...)

Set the virtual network IP net mask.

PrlVirtNet SetIPScopeEnd(...)

Set the virtual network DHCP ending IP address

PrlVirtNet SetIPScopeStart(...)

Set the virtual network DHCP starting IP address.

PrlVirtNet SetNATServerEnabled(...)

Enable or disable the virtual network NAT server.

PrlVirtNet SetNetworkId(...)

Set the virtual network ID.

PrlVirtNet SetNetworkType(...)

Set the virtual network type.

PrlVirtNet SetPortForwardList(...)

Set the port forward entries list.

PrlVirtNet SetVlanTag(...)

Set the VLAN tag for the virtual network.

144

Page 145: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVmCfg AddDefaultDevice(...)

Automates the task of setting devices in a virtual machine.

PrlVmCfg CreateBootDev(...)

Create a new instance of BootDevice and add it to the virtual machine bootdevice list.

PrlVmCfg CreateScrRes(...)

Create a new instance of ScreenRes and add it to the virtual machineresolution list.

PrlVmCfg CreateShare(...)

Create a new instance of Share and add it to the virtual machine list of shares.

PrlVmCfg CreateVmDev(...)

Create a new virtual device handle of the specified type.

PrlVmCfg GetAccessRights(...)

Obtain the AccessRights object.

PrlVmCfg GetAllDevices(...)

Obtains objects for all virtual devices in a virtual machine.

PrlVmCfg GetAppInDockMode(...)

Determine the current dock mode for the virtual machine.

PrlVmCfg GetAutoStart(...)

Determine if the specified virtual machine is set to start automatically onParallels Service start.

PrlVmCfg GetAutoStartDelay(...)

Returns the time delay used during the virtual machine automatic startup.

PrlVmCfg GetAutoStop(...)

Determine the mode of the automatic shutdown for the specified virtualmachine.

145

Page 146: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVmCfg GetBackgroundPriority(...)

Determine the specified virtual machine background process priority type.

PrlVmCfg GetBootDev(...)

Obtain the BootDevice object containing information about a specified bootdevice.

PrlVmCfg GetBootDevCount(...)

Determine the number of devices in the virtual machine boot device prioritylist.

PrlVmCfg GetConfigValidity(...)

Return a constant indicating the virtual machine configuration validity.

PrlVmCfg GetCpuAccelLevel(...)

Determine the virtual machine CPU acceleration level.

PrlVmCfg GetCpuCount(...)

Determine the number of CPUs in the virtual machine.

PrlVmCfg GetCpuLimit(...)

Determine the CPU usage limit of a virtual machine, in percent.

PrlVmCfg GetCpuMode(...)

Determine the specified virtual machine CPU mode (32 bit or 64 bit).

PrlVmCfg GetCpuUnits(...)

Determine the number of CPU units allocated to a virtual machine.

PrlVmCfg GetCustomProperty(...)

Return the virtual machine custom property information.

PrlVmCfg GetDefaultGateway(...)

Return the default gateway of the specified virtual machine.

PrlVmCfg GetDefaultHddSize(...)

Return the default hard disk size for to the specified OS type and version.

146

Page 147: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVmCfg GetDefaultMemSize(...)

Return the default RAM size for to the specified OS type and version.

PrlVmCfg GetDefaultVideoRamSize(...)

Return the default video RAM size for the specified OS type and version.

PrlVmCfg GetDescription(...)

Return the virtual machine description.

PrlVmCfg GetDevByType(...)

Obtains a virtual device object according to the specified device type andindex.

PrlVmCfg GetDevsCount(...)

Determine the total number of devices of all types installed in the virtualmachine.

PrlVmCfg GetDevsCountByType(...)

Obtain the number of virtual devices of the specified type.

PrlVmCfg GetDisplayDev(...)

Obtains the VmDevice containing information about a display device in avirtual machine.

PrlVmCfg GetDisplayDevsCount(...)

Determine the number of display devices in a virtual machine.

PrlVmCfg GetDockIconType(...)

Return the virtual machine dock icon type.

PrlVmCfg GetFloppyDisk(...)

Obtain the VmDevice object containing information about a floppy disk drivein a vrtiual machine.

PrlVmCfg GetFloppyDisksCount(...)

Determine the number of floppy disk drives in a virtual machine.

147

Page 148: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVmCfg GetForegroundPriority(...)

Return foreground processes priority for the specified virtual machine.

PrlVmCfg GetGenericPciDev(...)

Obtain the VmDevice object containing information about a generic PCIdevice.

PrlVmCfg GetGenericPciDevsCount(...)

Determines the number of generic PCI devices in a virtual machine.

PrlVmCfg GetGenericScsiDev(...)

Obtain the VmDevice object containing information about a SCSI device in avirtual machine.

PrlVmCfg GetGenericScsiDevsCount(...)

Determines the number of generic SCSI devices in a virtual machine.

PrlVmCfg GetHardDisk(...)

Obtain the VmHardDisk object containing the specified virtual hard diskinformation.

PrlVmCfg GetHardDisksCount(...)

Determines the number of virtual hard disks in a virtual machine.

PrlVmCfg GetHomePath(...)

Return the virtual machine home directory name and path.

PrlVmCfg GetHostname(...)

Obtain the hostname of the specified virtual machine.

PrlVmCfg GetIcon(...)

Return the name of the icon file used by the specified virtual machine.

PrlVmCfg GetIoPriority(...)

Determines the specified virtual machine I/O priority.

148

Page 149: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVmCfg GetLastModifiedDate(...)

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

PrlVmCfg GetLastModifierName(...)

Return the name of the user who last modified the specified virtual machine.

PrlVmCfg GetName(...)

Return the virtual machine name.

PrlVmCfg GetNetAdapter(...)

Obtain the VmNet object containing information about a virtual networkadapter.

PrlVmCfg GetNetAdaptersCount(...)

Determine the number of network adapters in a virtual machine.

PrlVmCfg GetOfflineServices(...)

Obtain the list of services available in the virtual machine offline management.

PrlVmCfg GetOpticalDisk(...)

Obtain the VmDevice object containing information about a virtual opticaldisk.

PrlVmCfg GetOpticalDisksCount(...)

Determine the number of optical disks in the specified virtual machine.

PrlVmCfg GetOsType(...)

Return the type of the operating system that the specified virtual machine isrunning.

PrlVmCfg GetOsVersion(...)

Return the version of the operating system that the specified virtual machineis running.

PrlVmCfg GetParallelPort(...)

Obtains the VmDevice object containing information about a virtual parallelport.

149

Page 150: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVmCfg GetParallelPortsCount(...)

Determine the number of virtual parallel ports in the virtual machine.

PrlVmCfg GetRamSize(...)

Return the virtual machine memory (RAM) size, in megabytes.

PrlVmCfg GetScrRes(...)

Obtain the ScreenRes object identifying the specified virtual machine screenresolution.

PrlVmCfg GetScrResCount(...)

Determine the total number of screen resolutions available in a virtualmachine.

PrlVmCfg GetSearchDomains(...)

Obtain the list of search domains that will be assigned to the guest OS.

PrlVmCfg GetSerialPort(...)

Obtain the VmSerial object containing information about a serial port in avirtual machine.

PrlVmCfg GetSerialPortsCount(...)

Determine the number of serial ports in a virtual machine.

PrlVmCfg GetServerHost(...)

Return the hostname of the machine hosting the specified virtual machine.

PrlVmCfg GetServerUuid(...)

Returns the UUID of the machine hosting the specified virtual machine.

PrlVmCfg GetShare(...)

Obtain the Share object containing information about a shared folder.

PrlVmCfg GetSharesCount(...)

Determine the number of shared folders in a virtual machine.

150

Page 151: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVmCfg GetSmartGuardInterval(...)

Determines the interval at which snapshots are taken by SmartGuard.

PrlVmCfg GetSmartGuardMaxSnapshotsCount(...)

Determines the maximum snapshot count, a SmartGuard setting.

PrlVmCfg GetSoundDev(...)

Obtain the VmSound object containing information about a sound device in avirtual machine.

PrlVmCfg GetSoundDevsCount(...)

Determine the number of sound devices in a virtual machine.

PrlVmCfg GetStartLoginMode(...)

Return the automatic startup login mode for the virtual machine.

PrlVmCfg GetStartUserLogin(...)

Return the user name used during the virtual machine automatic startup.

PrlVmCfg GetSystemFlags(...)

Return the virtual machine system flags.

PrlVmCfg GetTimeSyncInterval(...)

Obtain the time synchronization interval between the host and the guest OS.

PrlVmCfg GetUndoDisksMode(...)

Determine the current undo-disks mode for the virtual machine.

PrlVmCfg GetUsbDevice(...)

Obtain the VmUsb object containing information about a USB device in thevirtual machine.

PrlVmCfg GetUsbDevicesCount(...)

Determine the number of USB devices in a virtual machine.

PrlVmCfg GetUuid(...)

Return the UUID (universally unique ID) of the virtual machine.

151

Page 152: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVmCfg GetVNCHostName(...)

Return the VNC hostname of the virtual machine.

PrlVmCfg GetVNCMode(...)

Return the VNC mode of the virtual machine.

PrlVmCfg GetVNCPassword(...)

Return the VNC password for the virtual machine.

PrlVmCfg GetVNCPort(...)

Return the VNC port number for the virtual machine

PrlVmCfg GetVideoRamSize(...)

Return the video memory size of the virtual machine.

PrlVmCfg GetWindowMode(...)

Return the current window mode the virtual machine is in.

PrlVmCfg IsAllowSelectBootDevice(...)

Determine whether the ’select boot device’ option is shown on virtual machinestartup.

PrlVmCfg IsAutoCaptureReleaseMouse(...)

Determine whether the automatic capture and release of the mouse pointer isenabled.

PrlVmCfg IsCloseAppOnShutdown(...)

Determine whether the Parallels console app is automatically closed on thevirtual machine shutdown.

PrlVmCfg IsCpuVtxEnabled(...)

Determine whether the x86 virtualization (such as Vt-x) is available in thevirtual machine CPU.

PrlVmCfg IsDefaultDeviceNeeded(...)

Determine whether a default virtual device is needed for running the OS of thespecified type.

152

Page 153: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVmCfg IsDisableAPIC(...)

Determine whether the APIC is enabled during the virtual machine runtime.

PrlVmCfg IsDiskCacheWriteBack(...)

Determine if disk cache write-back is enabled in the virtual machine.

PrlVmCfg IsExcludeDock(...)

Determine the guest OS window behavior in coherence mode.

PrlVmCfg IsGuestSharingAutoMount(...)

Determine if host shared folders are mounted automatically in the virtualmachine.

PrlVmCfg IsGuestSharingEnableSpotlight(...)

Determine if the virtual disks will be added to Spotlight search subsystem(Mac OS X feature).

PrlVmCfg IsGuestSharingEnabled(...)

Determine if guest sharing is enabled (the guest OS disk drives are visible inthe host OS).

PrlVmCfg IsHostSharingEnabled(...)

Determine if host sharing is enabled (host shared folders are visible in theguest OS).

PrlVmCfg IsMapSharedFoldersOnLetters(...)

Determine whether host disks shared with the guest Windows OS will bemapped to drive letters.

PrlVmCfg IsMultiDisplay(...)

Determine if the specified virtual machine uses a multi-display mode.

PrlVmCfg IsOfflineManagementEnabled(...)

Determine whether the offline management feature is enabled for the virtualmachine.

153

Page 154: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVmCfg IsOsResInFullScrMode(...)

Determines wether the virtual machine OS resolution is in full screen mode.

PrlVmCfg IsRelocateTaskBar(...)

Determine if the task bar relocation feature is enabled in Coherence mode.

PrlVmCfg IsScrResEnabled(...)

Determine if additional screen resolution support is enabled in the virtualmachine.

PrlVmCfg IsShareAllHostDisks(...)

Determine whether all host disks will be present in the guest OS as shares.

PrlVmCfg IsShareClipboard(...)

Determine whether the clipboard sharing feature is enabled in the virtualmachine.

PrlVmCfg IsShareUserHomeDir(...)

Determine whether the host user home directory will be available in the guestOS as a share.

PrlVmCfg IsSharedProfileEnabled(...)

Determine whether the Shared Profile feature is enabled in the virtualmachine.

PrlVmCfg IsShowTaskBar(...)

Determine if Windows task bar is displayed in Coherence mode.

PrlVmCfg IsSmartGuardEnabled(...)

Determine whether the SmartGuard feature is enabled in the virtual machine.

PrlVmCfg IsSmartGuardNotifyBeforeCreation(...)

Determine whether the user will be notified on automatic snapshot creation bySmartGaurd.

PrlVmCfg IsTemplate(...)

Determine whether the virtual machine is a real machine or a template.

154

Page 155: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVmCfg IsTimeSyncSmartModeEnabled(...)

Determine whether the smart time synchronization is enabled in a virtualmachine.

PrlVmCfg IsTimeSynchronizationEnabled(...)

Determine whether the time synchronization feature is enabled in the virtualmachine.

PrlVmCfg IsToolsAutoUpdateEnabled(...)

Enables or disables the Parallels Tools AutoUpdate feature for the virtualmachine.

PrlVmCfg IsUseDefaultAnswers(...)

Determine whether the use default answers mechanism is active in the virtualmachine.

PrlVmCfg IsUseDesktop(...)

Determine whether the ’use desktop in share profile’ feature is enabled or not.

PrlVmCfg IsUseDocuments(...)

Determine whether ’use documents in shared profile’ feature is enabled or not.

PrlVmCfg IsUseMusic(...)

Determine whether the ’use music in shared profile’ feature is enabled or not.

PrlVmCfg IsUsePictures(...)

Determine whether the ’used pictures in shared profile’ feature is enabled ornot.

PrlVmCfg IsUserDefinedSharedFoldersEnabled(...)

Determine whether the user-defined shared folders are enabled or not.

PrlVmCfg SetAllowSelectBootDevice(...)

Switch on/off the ’select boot device’ dialog on virtual machine startup.

PrlVmCfg SetAppInDockMode(...)

Set the dock mode for applications.

155

Page 156: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVmCfg SetAutoCaptureReleaseMouse(...)

Enable or disables the automatic capture and release of the mouse pointer in avirtual machine.

PrlVmCfg SetAutoStart(...)

Set the automatic startup option for the virtual machine.

PrlVmCfg SetAutoStartDelay(...)

Set the time delay that will be used during the virtual machine automaticstartup.

PrlVmCfg SetAutoStop(...)

Set the automatic shutdown mode for the virtual machine.

PrlVmCfg SetBackgroundPriority(...)

Set the virtual machine background processes priority.

PrlVmCfg SetCloseAppOnShutdown(...)

Set whether the Parallels console app will be closed on the virtual machineshutdown.

PrlVmCfg SetCpuAccelLevel(...)

Set CPU acceleration level for the virtual machine.

PrlVmCfg SetCpuCount(...)

Set the number of CPUs for the virtual machine (the CPUs should be presentin the machine).

PrlVmCfg SetCpuLimit(...)

Set the CPU usage limit (in percent) for a virtual machine.

PrlVmCfg SetCpuMode(...)

Set CPU mode (32 bit or 64 bit) for the virtual machine.

PrlVmCfg SetCpuUnits(...)

Set the number of CPU units that will be allocated to a virtual machine.

156

Page 157: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVmCfg SetCustomProperty(...)

Set the virtual machine custom property information.

PrlVmCfg SetDefaultConfig(...)

Set the default configuration for a new virtual machine based on the guest OStype.

PrlVmCfg SetDefaultGateway(...)

Set the virtual machine default gateway.

PrlVmCfg SetDescription(...)

Set the virtual machine description.

PrlVmCfg SetDisableAPICSign(...)

Set whether the virtual machine should be using APIC during runtime.

PrlVmCfg SetDiskCacheWriteBack(...)

Set the virtual machine disk cache write-back option.

PrlVmCfg SetDockIconType(...)

Sets the virtual machine dock icon type.

PrlVmCfg SetExcludeDock(...)

Set the exclude dock option.

PrlVmCfg SetForegroundPriority(...)

Set the virtual machine foreground processes priority.

PrlVmCfg SetGuestSharingAutoMount(...)

Set the guest OS sharing auto-mount option.

PrlVmCfg SetGuestSharingEnableSpotlight(...)

Set whether the virtual disks are added to Spotlight search subsystem.

PrlVmCfg SetGuestSharingEnabled(...)

Enables the guest sharing feature.

157

Page 158: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVmCfg SetHostSharingEnabled(...)

Enable host sharing for the virtual machine.

PrlVmCfg SetHostname(...)

Set the virtual machine hostname.

PrlVmCfg SetIcon(...)

Set the virtual machine icon.

PrlVmCfg SetIoPriority(...)

Set the virtual machine I/O priority.

PrlVmCfg SetMapSharedFoldersOnLetters(...)

Enable mapping of shared host disks to drive letters for the virtual machine.

PrlVmCfg SetMultiDisplay(...)

Set the virtual machine multi-display option.

PrlVmCfg SetName(...)

Set the virtual machine name.

PrlVmCfg SetOfflineManagementEnabled(...)

Enables or disables the offline management feature for the virtual machine.

PrlVmCfg SetOfflineServices(...)

Set offline services that will be available in the virtual machine offlinemanagement.

PrlVmCfg SetOsResInFullScrMode(...)

Turn on/off the virtual machine OS resolution in full screen mode option.

PrlVmCfg SetOsVersion(...)

Set the virtual machine guest OS version.

PrlVmCfg SetRamSize(...)

Sets the virtual machine memory (RAM) size.

158

Page 159: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVmCfg SetRelocateTaskBar(...)

Enable or disable the Windows task bar relocation feature.

PrlVmCfg SetScrResEnabled(...)

Enable or disable the additional screen resolution support in the virtualmachine.

PrlVmCfg SetSearchDomains(...)

Set the global search domain list that will be assigned to the guest OS.

PrlVmCfg SetShareAllHostDisks(...)

Enable sharing of all host disks for the virtual machine.

PrlVmCfg SetShareClipboard(...)

Enable or disable the clipboard sharing feature.

PrlVmCfg SetShareUserHomeDir(...)

Enable or disable sharing of the host user home directory in the specifiedvirtual machine.

PrlVmCfg SetSharedProfileEnabled(...)

Enable or disable the Shared Profile feature in the virtual machine.

PrlVmCfg SetShowTaskBar(...)

Show or hide the Windows task bar when the virtual machine is running inCoherence mode.

PrlVmCfg SetSmartGuardEnabled(...)

Enable the SmartGuard feature in the virtual machine.

PrlVmCfg SetSmartGuardInterval(...)

Set the time interval at which snapshots are taken by SmartGuard.

PrlVmCfg SetSmartGuardMaxSnapshotsCount(...)

Set the maximum snapshot count, a SmartGuard feature.

159

Page 160: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVmCfg SetSmartGuardNotifyBeforeCreation(...)

Enable or disable notification of automatic snapshot creation, a SmartGuardfeature.

PrlVmCfg SetStartLoginMode(...)

Set the automatic startup login mode for the specified virtual machine.

PrlVmCfg SetStartUserCreds(...)

Sset the automatic startup user login and password for the virtual machine.

PrlVmCfg SetSystemFlags(...)

Set the virtual machine system flags.

PrlVmCfg SetTemplateSign(...)

Modify a regular virtual machine to become a template, and vise versa.

PrlVmCfg SetTimeSyncInterval(...)

Set the time interval at which time in the virtual machine will be synchronizedwith the host OS.

PrlVmCfg SetTimeSyncSmartModeEnabled(...)

Enable or disable the smart time-synchronization mode in the virtual machine.

PrlVmCfg SetTimeSynchronizationEnabled(...)

Enable or disable the time synchronization feature in a virtual machine.

PrlVmCfg SetToolsAutoUpdateEnabled(...)

Enable or disable the Parallels Tools AutoUpdate feature for the virtualmachine.

PrlVmCfg SetUndoDisksMode(...)

Set the undo-disks mode for the virtual machine.

PrlVmCfg SetUseDefaultAnswers(...)

Enable the use default answers mechanism in a virtual machine.

160

Page 161: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVmCfg SetUseDesktop(...)

Enable or disable the ’undo-desktop’ feature in the shared profile.

PrlVmCfg SetUseDocuments(...)

Enable or disable the ’use documents in shared profile’ feature.

PrlVmCfg SetUseMusic(...)

Enables or disables the ’use music in shared profile’ feature.

PrlVmCfg SetUsePictures(...)

Enables or disables the ’use pictures in shared profile’ feature.

PrlVmCfg SetUserDefinedSharedFoldersEnabled(...)

Enables or disables user-defined shared folders.

PrlVmCfg SetUuid(...)

Set the virtual machine UUID (universally unique ID).

PrlVmCfg SetVNCHostName(...)

Set the virtual machine VNC host name.

PrlVmCfg SetVNCMode(...)

Set the virtual machine VNC mode.

PrlVmCfg SetVNCPassword(...)

Set the virtual machine VNC password.

PrlVmCfg SetVNCPort(...)

Set the virtual machine VNC port number.

PrlVmCfg SetVideoRamSize(...)

Set the virtual machine video memory size.

PrlVmCfg SetWindowMode(...)

Sets the virtual machine window mode.

161

Page 162: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVmDevHdPart GetSysName(...)

Return the hard disk partition system name.

PrlVmDevHdPart Remove(...)

Remove the specified partition object from the virtual hard disk list.

PrlVmDevHdPart SetSysName(...)

Set system name for the disk partition.

PrlVmDevHd AddPartition(...)

Assign a boot camp partition to the virtual hard disk.

PrlVmDevHd GetDiskSize(...)

Return the hard disk size.

PrlVmDevHd GetDiskType(...)

Return the hard disk type.

PrlVmDevHd GetPartition(...)

Obtain the VmHdPartition object containing a hard disk partition info.

PrlVmDevHd GetPartitionsCount(...)

Determine the number of partitions on the virtual hard disk.

PrlVmDevHd GetSizeOnDisk(...)

Return the size of the occupied space on the hard disk.

PrlVmDevHd IsSplitted(...)

Determine if the virtual hard disk is split into multiple files.

PrlVmDevHd SetDiskSize(...)

Set the size of the virtual hard disk.

PrlVmDevHd SetDiskType(...)

Set the type of the virtual hard disk.

162

Page 163: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVmDevHd SetSplitted(...)

Sety whether the hard disk should be split into multiple files.

PrlVmDevNet GenerateMacAddr(...)

Generate a unique MAC address for the virtual network adapter.

PrlVmDevNet GetBoundAdapterIndex(...)

Return the index of the adapter to which this virtual adapter is bound.

PrlVmDevNet GetBoundAdapterName(...)

Return the name of the adapter to which this virtual adapter is bound.

PrlVmDevNet GetDefaultGateway(...)

Obtain the default gateway assigned to the virtual network adapter.

PrlVmDevNet GetDnsServers(...)

Obtain the list of DNS servers which are assigned to the virtual networkadapter.

PrlVmDevNet GetMacAddress(...)

Return the MAC address of the virtual network adapter.

PrlVmDevNet GetNetAddresses(...)

Obtain the list of IP address/subnet mask pairs which are assigned to thevirtual network adapter.

PrlVmDevNet GetSearchDomains(...)

Obtain the lists of search domains assigned to the virtual network adapter.

PrlVmDevNet GetVirtualNetworkId(...)

Obtain the virtual network ID assigned to the virtual network adapter.

PrlVmDevNet IsAutoApply(...)

Determine if the network adapter is configured to automatically apply networksettings inside guest.

163

Page 164: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVmDevNet IsConfigureWithDhcp(...)

Determine if the network adapter is configured through DHCP on the guestOS side.

PrlVmDevNet SetAutoApply(...)

Set whether the network adapter should be automatically configured.

PrlVmDevNet SetBoundAdapterIndex(...)

Set the index of the adapter to which this virtual adapter should be bound.

PrlVmDevNet SetBoundAdapterName(...)

Set the name of the network adapter to which this virtual adapter will bind.

PrlVmDevNet SetConfigureWithDhcp(...)

Set whether the network adapter should be configured through DHCP ormanually.

PrlVmDevNet SetDefaultGateway(...)

Set the default gateway address for the network adapter.

PrlVmDevNet SetDnsServers(...)

Assign DNS servers to the network adapter.

PrlVmDevNet SetMacAddress(...)

Set MAC address to the network adapter.

PrlVmDevNet SetNetAddresses(...)

Set IP addresses/subnet masks to the network adapter.

PrlVmDevNet SetSearchDomains(...)

Assign search domains to the network adapter.

PrlVmDevNet SetVirtualNetworkId(...)

Set the virtual network ID for the network adapter.

164

Page 165: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVmDevSerial GetSocketMode(...)

Return the socket mode of the virtual serial port.

PrlVmDevSerial SetSocketMode(...)

Set the socket mode for the virtual serial port.

PrlVmDevSound GetMixerDev(...)

Return the mixer device string for the sound device.

PrlVmDevSound GetOutputDev(...)

Return the output device string for the sound device.

PrlVmDevSound SetMixerDev(...)

Set the mixer device string for the sound device.

PrlVmDevSound SetOutputDev(...)

Set the output device string for the sound device.

PrlVmDevUsb GetAutoconnectOption(...)

Obtain the USB controller autoconnect device option.

PrlVmDevUsb SetAutoconnectOption(...)

Set the USB controller autoconnect device option.

PrlVmDev Connect(...)

Connect a virtual device to a running virtual machine.

PrlVmDev Create(...)

Create a new virtual device object not bound to any virtual machine.

PrlVmDev CreateImage(...)

Physically create a virtual device image on the host.

PrlVmDev Disconnect(...)

Disconnect a device from a running virtual machine.

165

Page 166: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVmDev GetDescription(...)

Return the description of a virtual device.

PrlVmDev GetEmulatedType(...)

Return the virtual device emulation type.

PrlVmDev GetFriendlyName(...)

Return the virtual device user-friendly name.

PrlVmDev GetIfaceType(...)

Return the virtual device interface type (IDE or SCSI).

PrlVmDev GetImagePath(...)

Return virtual device image path.

PrlVmDev GetIndex(...)

Return the index identifying the virtual device.

PrlVmDev GetOutputFile(...)

Return the virtual device output file.

PrlVmDev GetStackIndex(...)

Return the virtual device stack index (position at the IDE/SCSI controllerbus).

PrlVmDev GetSysName(...)

Return the virtual device system name.

PrlVmDev GetType(...)

Return the virtual device type.

PrlVmDev IsConnected(...)

Determine if the virtual device is connected.

PrlVmDev IsEnabled(...)

Determine if the device is enabled.

166

Page 167: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVmDev IsPassthrough(...)

Determine if the passthrough mode is enabled for the mass storage device.

PrlVmDev IsRemote(...)

Determine if the virtual device is a remote device.

PrlVmDev Remove(...)

Remove the virtual device object from the parent virtual machine list.

PrlVmDev ResizeImage(...)

Resize the virtual device image.

PrlVmDev SetConnected(...)

Connect the virtual device.

PrlVmDev SetDefaultStackIndex(...)

Generates a stack index for the device (the device interface, IDE or SCSI,must be set in advance).

PrlVmDev SetDescription(...)

Set the device description.

PrlVmDev SetEmulatedType(...)

Sets the virtual device emulation type.

PrlVmDev SetEnabled(...)

Enable the specified virtual device.

PrlVmDev SetFriendlyName(...)

Set the virtual device user-friendly name.

PrlVmDev SetIfaceType(...)

Set the virtual device interface type (IDE or SCSI).

PrlVmDev SetImagePath(...)

Set the virtual device image path.

167

Page 168: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVmDev SetIndex(...)

Set theindex identifying the virtual device.

PrlVmDev SetOutputFile(...)

Set the virtual device output file.

PrlVmDev SetPassthrough(...)

Enable the passthrough mode for the mass storage device (optical or harddisk).

PrlVmDev SetRemote(...)

Change the ’remote’ flag for the specified device.

PrlVmDev SetStackIndex(...)

Set the virtual device stack index (position at the IDE or SCSI controller bus).

PrlVmDev SetSysName(...)

Set the virtual device system name.

PrlVmGuest GetNetworkSettings(...)

Obtain network settings of the guest operating system running in a virtualmachine.

PrlVmGuest Logout(...)

Closes a session (or unbinds from a pre-existing session) in a virtual machine.

PrlVmGuest RunProgram(...)

Execute a program in a virtual machine.

PrlVmGuest SetUserPasswd(...)

Change the password of a guest operating system user.

PrlVmInfo GetAccessRights(...)

Obtains the AccessRights object containing information about the virtualmachine access rights.

168

Page 169: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVmInfo GetAdditionState(...)

Return the virtual machine addition state information.

PrlVmInfo GetState(...)

Return the virtual machine state information.

PrlVmInfo IsInvalid(...)

Determine if the specified virtual machine is invalid.

PrlVmInfo IsVmWaitingForAnswer(...)

Determine if the specified virtual machine is waiting for an answer to aquestion that it asked.

PrlVmInfo IsVncServerStarted(...)

Determine whether a VNC server is running for the specified virtual machine.

PrlVmToolsInfo GetState(...)

PrlVmToolsInfo GetVersion(...)

PrlVm AuthWithGuestSecurityDb(...)

Authenticate the user through the guest OS security database.

PrlVm BeginEdit(...)

Mark the beginning of the virtual machine configuration changes operation.

PrlVm CancelCompressor(...)

Cancels the running Compressor operation.

PrlVm Clone(...)

Clone an existing virtual machine.

PrlVm CloneEx(...)

Clone an existing virtual machine (extended version).

169

Page 170: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVm Commit(...)

Commit the virtual machine configuration changes.

PrlVm CreateEvent(...)

Creates an event bound to the virtual machine.

PrlVm CreateSnapshot(...)

Create a snapshot of a virtual machine.

PrlVm CreateUnattendedFloppy(...)

Create a floppy disk image for unattended Windows installation.

PrlVm Delete(...)

Delete the specified virtual machine from the host.

PrlVm DeleteSnapshot(...)

Delete the specified virtual machine snapshot.

PrlVm DropSuspendedState(...)

Resets a suspended virtual machine.

PrlVm GenerateVmDevFilename(...)

Generate a unique name for a virtual device.

PrlVm GetConfig(...)

Obtain a handle of type VmConfig

PrlVm GetPerfStats(...)

PrlVm GetPerfStats

PrlVm GetProblemReport(...)

Obtain a problem report on abnormal virtual machine termination.

PrlVm GetQuestions(...)

Synchronously receive questions from the Parallels Service.

170

Page 171: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVm GetSnapshotsTree(...)

Obtain snapshot information for the specified virtual machine.

PrlVm GetState(...)

Obtain the VmInfo object containing the specified virtual machine information.

PrlVm GetStatistics(...)

Obtain the Statistics object containing the virtual machine resource usagestatistics.

PrlVm GetSuspendedScreen(...)

Obtain the virtual machine screen state before it was suspending.

PrlVm GetToolsState(...)

Determine whether Parallels Tools is installed in the virtual machine.

PrlVm InitiateDevStateNotifications(...)

Initiate the device states notification service.

PrlVm InstallTools(...)

Install Parallels Tools in the virtual machine.

PrlVm InstallUtility(...)

Install a specified utility in a virtual machine.

PrlVm Lock(...)

Exclusively locks the virtual machine for current session.

PrlVm LoginInGuest(...)

Create a new console session or binds to an existing GUI session in a virtualmachine.

PrlVm Migrate(...)

Migrate an existing virtual machine to another host.

PrlVm MigrateCancel(...)

Cancel the virtual machine migration operation.

171

Page 172: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVm MigrateEx(...)

Migrate an existing virtual machine to another host (extended version).

PrlVm Pause(...)

Pause the virtual machine.

PrlVm RefreshConfig(...)

Refresh the virtual machine configuration information.

PrlVm Reg(...)

Create a new virtual machine and register it with the Parallels Service.

PrlVm Reset(...)

Reset the virtual machine.

PrlVm Restart(...)

Restart the virtual machine.

PrlVm Restore(...)

Restores the registered virtual machine.

PrlVm Resume(...)

Resume a suspended virtual machine.

PrlVm RunCompressor(...)

Initiates the Compressor process.

PrlVm SetConfig(...)

This is a reserved method.

PrlVm Start(...)

Start the virtual machine.

PrlVm StartEx(...)

Start the virtual machine using the specified mode.

172

Page 173: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVm StartVncServer(...)

Start a VNC server for the specified virtual machine.

PrlVm Stop(...)

Stop the virtual machine.

PrlVm StopVncServer(...)

Stops the VNC server in a virtual machine

PrlVm SubscribeToGuestStatistics(...)

Subscribe to receive the virtual machine performance statistics.

PrlVm SubscribeToPerfStats(...)

PrlVm SubscribeToPerfStats

PrlVm Suspend(...)

Suspend the virtual machine.

PrlVm SwitchToSnapshot(...)

Revert the specified virtual machine to the specified snapshot.

PrlVm TisGetIdentifiers(...)

Retrieve a list of identifiers from the Tools Information Service database.

PrlVm TisGetRecord(...)

Obtain the TisRecord object containing a record from the Tools Servicedatabase.

PrlVm ToolsGetShutdownCapabilities(...)

Obtain the available capabilities of a graceful virtual machine shutdown usingParallels Tools.

PrlVm ToolsSendShutdown(...)

Initiates graceful shutdown of the virtual machine.

PrlVm Unlock(...)

Unlocks a previously locked virtual machine.

173

Page 174: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Functions Module prlsdkapi.prlsdk

PrlVm Unreg(...)

Unregisters the virtual machine from the Parallels Service.

PrlVm UnsubscribeFromGuestStatistics(...)

Cancels the performance statistics subscription.

PrlVm UnsubscribeFromPerfStats(...)

Cancels the Parallels Service performance statistics subscription .

PrlVm UpdateSecurity(...)

Updates the security access level for the virtual machine.

PrlVm UpdateSnapshotData(...)

Modify the virtual machine snapshot name and description.

PrlVm ValidateConfig(...)

Validate the specified section of a virtual machine configuration.

SetSDKLibraryPath(...)

SetSDKLibraryPath

174

Page 175: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Module prlsdkapi.prlsdk.consts

3 Module prlsdkapi.prlsdk.consts

3.1 Variables

Name Description

IOS AUTH FAILED Value: 5

IOS CONNECTION TIM-EOUT

Value: 4

IOS DISABLED Value: 0

IOS STARTED Value: 1

IOS STOPPED Value: 2

IOS UNKNOWN VM UU-ID

Value: 3

PACF HIGH SECURITY Value: 2

PACF LAST Value: 1024

PACF MAX Value: 10

PACF NON INTERACTI-VE MODE

Value: 4

PACF NORMAL SECUR-ITY

Value: 1

PAI GENERATE INDEX Value: -2

PAI INVALID ADAPTE-R

Value: -1

PAM DESKTOP Value: 1

PAM PLAYER Value: 3

PAM SERVER Value: 0

PAM STM Value: 4

PAM UNKNOWN Value: 65535

PAM WORKSTATION Value: 2

PAO VM NOT SHARED Value: 0

PAO VM SHARED ON -FULL ACCESS

Value: 3

PAO VM SHARED ON -VIEW

Value: 1

PAO VM SHARED ON -VIEW AND RUN

Value: 2

PAO VM SHUTDOWN Value: 2

PAO VM START MANU-AL

Value: 0

PAO VM START ON L-OAD

Value: 1

PAO VM START ON R-ELOAD

Value: 2

PAO VM STOP Value: 0

continued on next page

175

Page 176: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.consts

Name Description

PAO VM SUSPEND Value: 1

PARALLELS API VER Value: 131072

PAR MAX Value: 52

PAR VMDEV CONNEC-T ACCESS

Value: 15

PAR VMDEV CREATEI-MAGE ACCESS

Value: 17

PAR VMDEV DISCONN-ECT ACCESS

Value: 16

PAR VM BEGINEDIT A-CCESS

Value: 50

PAR VM CANCEL COM-PACT ACCESS

Value: 23

PAR VM CANCEL COM-PRESSOR ACCESS

Value: 32

PAR VM CLONE ACCE-SS

Value: 7

PAR VM COMMIT ACC-ESS

Value: 14

PAR VM CREATE BAC-KUP ACCESS

Value: 42

PAR VM CREATE SNA-PSHOT ACCESS

Value: 33

PAR VM DELETE ACC-ESS

Value: 8

PAR VM DELETE SNA-PSHOT ACCESS

Value: 35

PAR VM DROPSUSPEN-DEDSTATE ACCESS

Value: 6

PAR VM EDITING ACC-ESS

Value: 14

PAR VM GETCONFIG -ACCESS

Value: 10

PAR VM GETPROBLE-MREPORT ACCESS

Value: 9

PAR VM GETSTATISTI-CS ACCESS

Value: 11

PAR VM GET SUSPEN-DED SCREEN ACCESS

Value: 27

PAR VM GET VMINFO-ACCESS

Value: 19

continued on next page

176

Page 177: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.consts

Name Description

PAR VM INITIATE DE-V STATE NOTIFICATI-ONS ACCESS

Value: 21

PAR VM INSTALL TOO-LS ACCESS

Value: 20

PAR VM INSTALL UTI-LITY ACCESS

Value: 39

PAR VM LOCK ACCES-S

Value: 29

PAR VM MIGRATE AC-CESS

Value: 25

PAR VM MIGRATE CA-NCEL ACCESS

Value: 25

PAR VM PAUSE ACCE-SS

Value: 2

PAR VM PERFSTAT A-CCESS

Value: 28

PAR VM REGISTER AC-CESS

Value: 24

PAR VM RESET ACCE-SS

Value: 3

PAR VM RESIZE DISK -ACCESS

Value: 43

PAR VM RESTART GU-EST ACCESS

Value: 38

PAR VM RESTORE AC-CESS

Value: 41

PAR VM RESTORE BA-CKUP ACCESS

Value: 51

PAR VM RESUME ACC-ESS

Value: 5

PAR VM RUN COMPRE-SSOR ACCESS

Value: 31

PAR VM SEND ANSWE-R ACCESS

Value: 18

PAR VM START ACCE-SS

Value: 0

PAR VM START EX AC-CESS

Value: 36

PAR VM START STOP -VNC SERVER

Value: 26

PAR VM STATISTICS S-UBSCRIPTION ACCESS

Value: 12

continued on next page

177

Page 178: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.consts

Name Description

PAR VM STOP ACCESS Value: 1

PAR VM SUBSCRIBET-OGUESTSTATISTICS A-CCESS

Value: 12

PAR VM SUSPEND AC-CESS

Value: 4

PAR VM SWITCH TO S-NAPSHOT ACCESS

Value: 34

PAR VM UNLOCK ACC-ESS

Value: 37

PAR VM UNREG ACCE-SS

Value: 13

PAR VM UNSUBSCRIB-EFROMGUESTSTATIST-ICS ACCESS

Value: 12

PAR VM UPDATE SEC-URITY ACCESS

Value: 22

PAR VM UPDATE TOO-LS SECTION

Value: 40

PBO CD HDD FLOPPY Value: 2

PBO FLOPPY HDD CD Value: 1

PBO HDD CD FLOPPY Value: 0

PBSL HIGH SECURITY Value: 2

PBSL LOW SECURITY Value: 0

PBSL NORMAL SECURI-TY

Value: 1

PBT DIFFERENTIAL Value: 8192

PBT FULL Value: 2048

PBT IGNORE NOT EXI-STS

Value: 32768

PBT INCREMENTAL Value: 4096

PBT RESTORE TO CO-PY

Value: 16384

PCM CPU AMD V Value: 2

PCM CPU INTEL VT X Value: 1

PCM CPU MODE 32 Value: 0

PCM CPU MODE 64 Value: 1

PCM CPU NONE HV Value: 0

PCVF CHANGE SID Value: 4096

PCVF CLONE TO TEM-PLATE

Value: 2048

PDA DEVICE IDLE Value: 0

continued on next page

178

Page 179: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.consts

Name Description

PDA DEVICE READ Value: 1

PDA DEVICE WRITE Value: 2

PDCC HIGH COMPRES-SION

Value: 32768

PDCC LOW COMPRES-SION

Value: 131072

PDCC MEDIUM COMP-RESSION

Value: 65536

PDCC NO COMPRESSI-ON

Value: 262144

PDCQ HIGH QUALITY Value: 1

PDCQ LOW QUALITY Value: 4

PDCQ MEDIUM QUALI-TY

Value: 2

PDCT HIGH QUALITY -WITHOUT COMPRESSI-ON

Value: 262145

PDCT HIGH QUALITY -WITH COMPRESSION

Value: 65537

PDCT LOW QUALITY -WITHOUT COMPRESSI-ON

Value: 262148

PDCT LOW QUALITY -WITH COMPRESSION

Value: 65540

PDCT MEDIUM QUALI-TY WITHOUT COMPR-ESSION

Value: 262146

PDCT MEDIUM QUALI-TY WITH COMPRESSI-ON

Value: 65538

PDE CLUSTERED DEVI-CE

Value: 1

PDE FLOPPY DISK Value: 3

PDE GENERIC DEVICE Value: 0

PDE GENERIC NETWO-RK ADAPTER

Value: 8

PDE GENERIC PCI DE-VICE

Value: 17

PDE GENERIC PORT Value: 9

PDE GENERIC SCSI DE-VICE

Value: 18

PDE HARD DISK Value: 6

continued on next page

179

Page 180: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.consts

Name Description

PDE MASSSTORAGE D-EVICE

Value: 4

PDE MAX Value: 21

PDE MIXER DEVICE Value: 13

PDE OPTICAL DISK Value: 5

PDE PARALLEL PORT Value: 11

PDE PCI VIDEO ADAP-TER

Value: 20

PDE PRINTER Value: 16

PDE SERIAL PORT Value: 10

PDE SOUND DEVICE Value: 12

PDE STORAGE DEVIC-E

Value: 2

PDE USB DEVICE Value: 15

PDE VIRTUAL SNAPSH-OT DEVICE

Value: 19

PDM APP IN DOCK AL-WAYS

Value: 2

PDM APP IN DOCK CO-HERENCE ONLY

Value: 1

PDM APP IN DOCK NE-VER

Value: 0

PDT ANY TYPE Value: 65535

PDT USE AC97 SOUND Value: 0

PDT USE BOOTCAMP Value: 3

PDT USE BRIDGE ETH-ERNET

Value: 2

PDT USE CREATIVE S-B16 SOUND

Value: 1

PDT USE DIRECT ASSI-GN

Value: 4

PDT USE HOST ONLY -NETWORK

Value: 0

PDT USE IMAGE FILE Value: 1

PDT USE OTHER Value: 3

PDT USE OUTPUT FIL-E

Value: 2

PDT USE PARALLEL P-ORT PRINTER MODE

Value: 3

PDT USE REAL CDDV-D

Value: 0

PDT USE REAL DEVIC-E

Value: 0

continued on next page

180

Page 181: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.consts

Name Description

PDT USE REAL FLOPP-Y

Value: 0

PDT USE REAL HDD Value: 0

PDT USE REAL PARAL-LEL PORT

Value: 0

PDT USE REAL SERIA-L PORT

Value: 0

PDT USE REAL USB C-ONTROLLER

Value: 0

PDT USE SERIAL POR-T SOCKET MODE

Value: 3

PDT USE SHARED NET-WORK

Value: 1

PFD ALL Value: 14336

PFD BINARY Value: 9

PFD BOOLEAN Value: 4

PFD CDATA Value: 3

PFD ENTITY Value: 5

PFD ENUMERATION Value: 6

PFD INT32 Value: 2

PFD INT64 Value: 7

PFD STDERR Value: 4096

PFD STDIN Value: 8192

PFD STDOUT Value: 2048

PFD STRING Value: 1

PFD UINT32 Value: 0

PFD UINT64 Value: 8

PFD UNKNOWN Value: 255

PFS UNIX LIKE FS Value: 1

PFS WINDOWS LIKE F-S

Value: 0

PGD PCI DISPLAY Value: 1

PGD PCI NETWORK Value: 0

PGD PCI OTHER Value: 3

PGD PCI SOUND Value: 2

PGD UNKNOWN Value: 0

PGD WINDOWS VISTA Value: 1

PGD WINDOWS VISTA-32

Value: 1

PGD WINDOWS VISTA-64

Value: 4

PGD WINDOWS XP Value: 2

continued on next page

181

Page 182: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.consts

Name Description

PGD WINDOWS XP 32 Value: 2

PGD WINDOWS XP 64 Value: 3

PGST CAPABILITY HI-BERNATE

Value: 8

PGST CAPABILITY RE-BOOT

Value: 2

PGST CAPABILITY SH-UTDOWN

Value: 1

PGST CAPABILITY SU-SPEND

Value: 4

PGS CONNECTED TO -HOST

Value: 0

PGS CONNECTED TO -VM

Value: 1

PGS NON CONTROLLE-D USB

Value: 2

PGS RESERVED Value: 2

PHD EXPANDING HAR-D DISK

Value: 1

PHD PLAIN HARD DIS-K

Value: 0

PHI REAL NET ADAPT-ER

Value: 0

PHI VIRTUAL NET AD-APTER

Value: 1

PHO LIN Value: 1

PHO MAC Value: 0

PHO UNKNOWN Value: 255

PHO WIN Value: 2

PHT ACCESS RIGHTS Value: 268435504

PHT BOOT DEVICE Value: 268435497

PHT DISP CONFIG Value: 268435478

PHT DISP NET ADAPT-ER

Value: 268435481

PHT ERROR Value: 0

PHT EVENT Value: 268435474

PHT EVENT PARAME-TER

Value: 268435486

PHT FOUND VM INFO Value: 268435506

PHT HANDLES LIST Value: 268435502

PHT HW GENERIC DE-VICE

Value: 268435482

continued on next page

182

Page 183: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.consts

Name Description

PHT HW GENERIC PCI-DEVICE

Value: 268435518

PHT HW HARD DISK Value: 268435483

PHT HW HARD DISK P-ARTITION

Value: 268435484

PHT HW NET ADAPTE-R

Value: 268435485

PHT JOB Value: 268435473

PHT LAST Value: 268435519

PHT LICENSE Value: 268435495

PHT LOGIN RESPONSE Value: 268435499

PHT NET SERVICE ST-ATUS

Value: 268435501

PHT OPAQUE TYPE LI-ST

Value: 268435519

PHT PORT FORWARDI-NG

Value: 268435517

PHT REMOTEDEV CM-D

Value: 268435487

PHT REMOTE FILESYS-TEM ENTRY

Value: 268435460

PHT REMOTE FILESYS-TEM INFO

Value: 268435459

PHT RESULT Value: 268435475

PHT RUNNING TASK Value: 268435500

PHT SCREEN RESOLU-TION

Value: 268435480

PHT SERVER Value: 268435457

PHT SERVER CONFIG Value: 268435458

PHT SERVER INFO Value: 268435496

PHT SHARE Value: 268435479

PHT STRINGS LIST Value: 268435498

PHT SYSTEM STATIST-ICS

Value: 268435488

PHT SYSTEM STATIST-ICS CPU

Value: 268435489

PHT SYSTEM STATIST-ICS DISK

Value: 268435492

PHT SYSTEM STATIST-ICS DISK PARTITION

Value: 268435493

PHT SYSTEM STATIST-ICS IFACE

Value: 268435490

continued on next page

183

Page 184: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.consts

Name Description

PHT SYSTEM STATIST-ICS PROCESS

Value: 268435494

PHT SYSTEM STATIST-ICS USER SESSION

Value: 268435491

PHT TIS EMITTER Value: 268435510

PHT TIS RECORD Value: 268435507

PHT TOOL Value: 268435511

PHT USER INFO Value: 268435508

PHT USER PROFILE Value: 268435477

PHT VIRTUAL DEV DI-SPLAY

Value: 268435462

PHT VIRTUAL DEV FL-OPPY

Value: 268435465

PHT VIRTUAL DEV GE-NERIC PCI

Value: 268435513

PHT VIRTUAL DEV GE-NERIC SCSI

Value: 268435514

PHT VIRTUAL DEV HA-RD DISK

Value: 268435466

PHT VIRTUAL DEV HD-PARTITION

Value: 268435512

PHT VIRTUAL DEV KE-YBOARD

Value: 268435463

PHT VIRTUAL DEV M-OUSE

Value: 268435464

PHT VIRTUAL DEV NE-T ADAPTER

Value: 268435467

PHT VIRTUAL DEV OP-TICAL DISK

Value: 268435470

PHT VIRTUAL DEV PA-RALLEL PORT

Value: 268435468

PHT VIRTUAL DEV SE-RIAL PORT

Value: 268435469

PHT VIRTUAL DEV SO-UND

Value: 268435472

PHT VIRTUAL DEV US-B DEVICE

Value: 268435471

PHT VIRTUAL DISK Value: 268435503

PHT VIRTUAL MACHI-NE

Value: 268435461

PHT VIRTUAL NETWO-RK

Value: 268435516

continued on next page

184

Page 185: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.consts

Name Description

PHT VM CONFIGURAT-ION

Value: 268435461

PHT VM GUEST SESSI-ON

Value: 268435515

PHT VM INFO Value: 268435476

PHT VM TOOLS INFO Value: 268435505

PHY WIFI REAL NET -ADAPTER

Value: 2

PIE DISPATCHER Value: 1

PIE IO SERVICE Value: 2

PIE UNKNOWN Value: 255

PIE VIRTUAL MACHIN-E

Value: 0

PIE WEB SERVICE Value: 3

PIF BMP Value: 1342177289

PIF JPG Value: 1342177290

PIF PNG Value: 1342177291

PIF RAW Value: 1342177288

PIT DOCK ICON LIVE -SCREEN SHOT

Value: 1

PIT DOCK ICON STAR-T MENU

Value: 2

PIT DOCK ICON SYST-EM

Value: 0

PJOC API SEND PROB-LEM REPORT

Value: 117

PJOC JOB CANCEL Value: 1

PJOC SRV ADD NET A-DAPTER

Value: 35

PJOC SRV ADD VIRTU-AL NETWORK

Value: 108

PJOC SRV AFTER HOS-T RESUME

Value: 113

PJOC SRV ATTACH T-O LOST TASK

Value: 39

PJOC SRV COMMON P-REFS BEGIN EDIT

Value: 8

PJOC SRV COMMON P-REFS COMMIT

Value: 9

PJOC SRV CONFIGUR-E GENERIC PCI

Value: 111

PJOC SRV CREATE V-M BACKUP

Value: 115

continued on next page

185

Page 186: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.consts

Name Description

PJOC SRV DELETE NE-T ADAPTER

Value: 36

PJOC SRV DELETE VI-RTUAL NETWORK

Value: 110

PJOC SRV FS CAN CR-EATE FILE

Value: 23

PJOC SRV FS CREATE-DIR

Value: 21

PJOC SRV FS GENERA-TE ENTRY NAME

Value: 25

PJOC SRV FS GET DIR-ENTRIES

Value: 20

PJOC SRV FS GET DIS-K LIST

Value: 19

PJOC SRV FS REMOVE-ENTRY

Value: 22

PJOC SRV FS RENAME-ENTRY

Value: 24

PJOC SRV GET ALL H-OST USERS

Value: 100

PJOC SRV GET BACK-UP TREE

Value: 114

PJOC SRV GET COMM-ON PREFS

Value: 7

PJOC SRV GET LICEN-SE INFO

Value: 27

PJOC SRV GET NET S-ERVICE STATUS

Value: 34

PJOC SRV GET PERFS-TATS

Value: 82

PJOC SRV GET PROBL-EM REPORT

Value: 38

PJOC SRV GET SRV C-ONFIG

Value: 6

PJOC SRV GET STATI-STICS

Value: 11

PJOC SRV GET USER I-NFO

Value: 41

PJOC SRV GET USER I-NFO LIST

Value: 40

PJOC SRV GET USER -PROFILE

Value: 10

continued on next page

186

Page 187: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.consts

Name Description

PJOC SRV GET VIRTU-AL NETWORK LIST

Value: 105

PJOC SRV GET VM LIS-T

Value: 15

PJOC SRV LOGIN Value: 3

PJOC SRV LOGIN LOC-AL

Value: 4

PJOC SRV LOGOFF Value: 5

PJOC SRV LOOKUP PA-RALLELS SERVERS

Value: 2

PJOC SRV NET SERVI-CE RESTART

Value: 32

PJOC SRV NET SERVI-CE RESTORE DEFAUL-TS

Value: 33

PJOC SRV NET SERVI-CE START

Value: 30

PJOC SRV NET SERVI-CE STOP

Value: 31

PJOC SRV PREPARE F-OR HIBERNATE

Value: 112

PJOC SRV REGISTER -VM

Value: 14

PJOC SRV REGISTER -VM EX

Value: 14

PJOC SRV REMOVE V-M BACKUP

Value: 122

PJOC SRV RESTORE V-M BACKUP

Value: 116

PJOC SRV SEND ANSW-ER

Value: 28

PJOC SRV SET NON IN-TERACTIVE SESSION

Value: 120

PJOC SRV SHUTDOWN Value: 18

PJOC SRV START SEA-RCH VMS

Value: 29

PJOC SRV SUBSCRIBE -PERFSTATS

Value: 80

PJOC SRV SUBSCRIBE -TO HOST STATISTICS

Value: 16

PJOC SRV UNSUBSCRI-BE FROM HOST STATI-STICS

Value: 17

continued on next page

187

Page 188: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.consts

Name Description

PJOC SRV UNSUBSCRI-BE PERFSTATS

Value: 81

PJOC SRV UPDATE LI-CENSE

Value: 26

PJOC SRV UPDATE NE-T ADAPTER

Value: 37

PJOC SRV UPDATE VI-RTUAL NETWORK

Value: 109

PJOC SRV USER PROF-ILE BEGIN EDIT

Value: 12

PJOC SRV USER PROF-ILE COMMIT

Value: 13

PJOC UNKNOWN Value: 0

PJOC VM AUTH WITH -GUEST SECURITY DB

Value: 106

PJOC VM BEGIN EDIT Value: 62

PJOC VM CANCEL CO-MPRESSOR

Value: 89

PJOC VM CLONE Value: 50

PJOC VM COMMIT Value: 63

PJOC VM CONNECT T-O VM

Value: 74

PJOC VM CREATE SN-APSHOT

Value: 90

PJOC VM CREATE UN-ATTENDED FLOPPY

Value: 64

PJOC VM DELETE Value: 51

PJOC VM DELETE SNA-PSHOT

Value: 92

PJOC VM DEV CONNE-CT

Value: 68

PJOC VM DEV CREAT-E IMAGE

Value: 70

PJOC VM DEV DISCON-NECT

Value: 69

PJOC VM DEV DISPLA-Y CAPTURE SCREEN

Value: 75

PJOC VM DROP SUSPE-NDED STATE

Value: 49

PJOC VM GENERATE -VM DEV FILENAME

Value: 54

continued on next page

188

Page 189: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.consts

Name Description

PJOC VM GET PERFST-ATS

Value: 85

PJOC VM GET PROBL-EM REPORT

Value: 52

PJOC VM GET SNAPS-HOTS TREE

Value: 93

PJOC VM GET STATE Value: 53

PJOC VM GET STATIS-TICS

Value: 57

PJOC VM GET SUSPEN-DED SCREEN

Value: 86

PJOC VM GET TOOLS -STATE

Value: 55

PJOC VM GUEST GET -NETWORK SETTINGS

Value: 104

PJOC VM GUEST LOG-OUT

Value: 79

PJOC VM GUEST RUN -PROGRAM

Value: 78

PJOC VM GUEST SET -USER PASSWD

Value: 107

PJOC VM INITIATE DE-V STATE NOTIFICATI-ONS

Value: 65

PJOC VM INSTALL TO-OLS

Value: 71

PJOC VM INSTALL UTI-LITY

Value: 98

PJOC VM LOCK Value: 118

PJOC VM LOGIN IN G-UEST

Value: 95

PJOC VM MIGRATE Value: 76

PJOC VM MIGRATE C-ANCEL

Value: 87

PJOC VM PAUSE Value: 44

PJOC VM REFRESH C-ONFIG

Value: 56

PJOC VM REG Value: 60

PJOC VM RESET Value: 45

PJOC VM RESIZE DISK-IMAGE

Value: 123

PJOC VM RESTART Value: 97

continued on next page

189

Page 190: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.consts

Name Description

PJOC VM RESTORE Value: 101

PJOC VM RESUME Value: 42

PJOC VM RUN COMPR-ESSOR

Value: 88

PJOC VM SEND CLIPB-OARD REQUEST

Value: 73

PJOC VM SEND DRAG-DROP COMMAND

Value: 77

PJOC VM SEND SHUT-DOWN COMMAND

Value: 72

PJOC VM START Value: 42

PJOC VM START EX Value: 94

PJOC VM START VNC -SERVER

Value: 102

PJOC VM STOP Value: 43

PJOC VM STOP VNC S-ERVER

Value: 103

PJOC VM SUBSCRIBE -PERFSTATS

Value: 83

PJOC VM SUBSCRIBE -TO GUEST STATISTIC-S

Value: 58

PJOC VM SUSPEND Value: 46

PJOC VM SWITCH TO -SNAPSHOT

Value: 91

PJOC VM UNLOCK Value: 119

PJOC VM UNREG Value: 61

PJOC VM UNSUBSCRI-BE FROM GUEST STA-TISTICS

Value: 59

PJOC VM UNSUBSCRI-BE PERFSTATS

Value: 84

PJOC VM UPDATE SE-CURITY

Value: 66

PJOC VM UPDATE SN-APSHOT DATA

Value: 96

PJOC VM UPDATE TO-OLS SECTION

Value: 99

PJOC VM VALIDATE C-ONFIG

Value: 67

PJS FINISHED Value: -805306366

PJS RUNNING Value: -805306367

continued on next page

190

Page 191: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.consts

Name Description

PJS UNKNOWN Value: 0

PKE CLICK Value: 255

PKE PRESS Value: 0

PKE RELEASE Value: 128

PLM ROOT ACOUNT Value: 1

PLM START ACOUNT Value: 0

PLM USER ACOUNT Value: 2

PMB LEFT BUTTON Value: 1

PMB MIDDLE BUTTON Value: 4

PMB NOBUTTON Value: 0

PMB RIGHT BUTTON Value: 2

PMS IDE DEVICE Value: 0

PMS SCSI DEVICE Value: 1

PMT ANSWER Value: 4

PMT CRITICAL Value: 2

PMT INFORMATION Value: 1

PMT QUESTION Value: 3

PMT WARNING Value: 0

PNA BRIDGED ETHER-NET

Value: 2

PNA DIRECT ASSIGN Value: 4

PNA HOST ONLY Value: 0

PNA SHARED Value: 1

PPF TCP Value: 0

PPF UDP Value: 1

PPS PROC IDLE Value: 4

PPS PROC RUN Value: 1

PPS PROC SLEEP Value: 0

PPS PROC STOP Value: 2

PPS PROC ZOMBIE Value: 3

PRD AUTO Value: 1

PRD DISABLED Value: 0

PRD MANUAL Value: 2

PRIF DISK INFO Value: 4096

PRIF RESIZE LAST PA-RTITION

Value: 2048

PRL CPUUNITS DEFAU-LT

Value: 1000

PRL CPUUNITS MAX Value: 500000

PRL CPUUNITS MIN Value: 10

PRL FS ADFS Value: 5

PRL FS AFFS Value: 6

continued on next page

191

Page 192: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.consts

Name Description

PRL FS AFS Value: 7

PRL FS AUTOFS Value: 8

PRL FS CODA Value: 9

PRL FS EFS Value: 10

PRL FS EXTFS Value: 11

PRL FS FAT Value: 1

PRL FS FAT32 Value: 2

PRL FS HFS Value: 4

PRL FS HPFS Value: 12

PRL FS INVALID Value: 0

PRL FS ISOFS Value: 13

PRL FS JFFS2 Value: 14

PRL FS NFS Value: 15

PRL FS NTFS Value: 3

PRL FS QNX4 Value: 16

PRL FS REISERFS Value: 17

PRL FS SMBFS Value: 18

PRL FS UNSPECIFIED Value: 255

PRL INVALID FILE DE-SCRIPTOR

Value: 0

PRL INVALID HANDLE Value: 0

PRL IOPRIO DEFAULT Value: 4

PRL IOPRIO MAX Value: 7

PRL IOPRIO MIN Value: 0

PRL PRODUCT ANY Value: 0

PRL PRODUCT DESKT-OP

Value: 1

PRL PRODUCT SERVE-R

Value: 2

PRL PRODUCT STM Value: 4

PRL PRODUCT WORK-STATION

Value: 3

PRL VERSION 3X Value: 1

PRL VERSION 4X Value: 2

PRL VERSION ANY Value: 0

PRPM RUN PROGRAM-AND RETURN IMMEDI-ATELY

Value: 16384

PRPM RUN PROGRAM-ENTER

Value: 65536

PRPM RUN PROGRAM-IN SHELL

Value: 32768

continued on next page

192

Page 193: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.consts

Name Description

PRVF REGENERATE V-M UUID

Value: 2048

PSE DIRECTORY Value: 1

PSE DRIVE Value: 0

PSE FILE Value: 2

PSIA OPEN DEFAULT Value: 0

PSIA OPEN IN GUEST Value: 1

PSIA OPEN IN HOST Value: 2

PSL HIGH SECURITY Value: 2

PSL LOW SECURITY Value: 0

PSL NORMAL SECURI-TY

Value: 1

PSM VM SAFE START Value: 4096

PSM VM START Value: 2048

PSM VM START LAST -ITEM

Value: 4096

PSNAP DISK ONLY Value: 1

PSP SERIAL SOCKET -CLIENT

Value: 1

PSP SERIAL SOCKET S-ERVER

Value: 0

PSS NOT INSTALLED Value: 2

PSS STARTED Value: 0

PSS STOPPED Value: 1

PSS UNKNOWN Value: 3

PST VM HIBERNATE Value: 2

PST VM REBOOT Value: 1

PST VM SHUTDOWN Value: 0

PST VM SUSPEND Value: 3

PTIS RECORD ACTIVE Value: 1

PTIS RECORD CANCE-LED

Value: 2

PTIS RECORD CHANG-ED

Value: 1

PTIS RECORD EMPTY Value: 0

PTIS RECORD REMOV-ED

Value: 2

PTS INSTALLED Value: 2

PTS NOT INSTALLED Value: 1

PTS OUTDATED Value: 3

PTS POSSIBLY INSTAL-LED

Value: 0

continued on next page

193

Page 194: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.consts

Name Description

PTS UNKNOWN Value: 0

PTU CMD INVALID Value: 0

PTU CMD PTU ALIVE Value: 1

PTU FLG ZERO Value: 1

PUD ASK USER WHAT-TODO

Value: 2

PUD COMMIT CHANG-ES

Value: 2

PUD CONNECTED AU-TOMATICALLY

Value: 1

PUD CONNECTED MA-NUALLY

Value: 0

PUD CONNECT TO GU-EST OS

Value: 1

PUD CONNECT TO PR-IMARY OS

Value: 0

PUD DISABLE UNDO D-ISKS

Value: 0

PUD PROMPT BEHAVI-OUR

Value: 3

PUD REVERSE CHANG-ES

Value: 1

PVA ACCELERATION -DISABLED

Value: 0

PVA ACCELERATION -HIGH

Value: 2

PVA ACCELERATION -NORMAL

Value: 1

PVC ALL Value: 1

PVC BOOT OPTION Value: 3

PVC CD DVD ROM Value: 10

PVC CPU Value: 6

PVC FLOPPY DISK Value: 9

PVC GENERAL PARA-METERS

Value: 2

PVC GENERIC PCI Value: 18

PVC HARD DISK Value: 11

PVC IDE DEVICES Value: 16

PVC LAST SECTION Value: 19

PVC MAIN MEMORY Value: 7

PVC NETWORK ADAP-TER

Value: 12

continued on next page

194

Page 195: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.consts

Name Description

PVC OFFLINE MANAG-EMENT SETTINGS

Value: 19

PVC PARALLEL PORT Value: 15

PVC REMOTE DISPLA-Y

Value: 4

PVC SCSI DEVICES Value: 17

PVC SERIAL PORT Value: 14

PVC SHARED FOLDER-S

Value: 5

PVC SOUND Value: 13

PVC VIDEO MEMORY Value: 8

PVMSL HIGH SECURIT-Y

Value: 2

PVMSL LOW SECURIT-Y

Value: 0

PVMSL NORMAL SECU-RITY

Value: 1

PVMT COLD MIGRATI-ON

Value: 2048

PVMT HOT MIGRATIO-N

Value: 8192

PVMT WARM MIGRAT-ION

Value: 4096

PVM DONT RESUME V-M

Value: 16384

PVN BRIDGED ETHER-NET

Value: 0

PVN HOST ONLY Value: 1

PVR PRIORITY HIGH Value: 2

PVR PRIORITY LOW Value: 0

PVR PRIORITY NORM-AL

Value: 1

PVS GUEST TYPE FRE-EBSD

Value: 10

PVS GUEST TYPE LIN-UX

Value: 9

PVS GUEST TYPE MA-COS

Value: 7

PVS GUEST TYPE MSD-OS

Value: 12

PVS GUEST TYPE NET-WARE

Value: 13

continued on next page

195

Page 196: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.consts

Name Description

PVS GUEST TYPE OS2 Value: 11

PVS GUEST TYPE OTH-ER

Value: 255

PVS GUEST TYPE SOL-ARIS

Value: 14

PVS GUEST TYPE WIN-DOWS

Value: 8

PVS GUEST VER BSD 4-X

Value: 2561

PVS GUEST VER BSD 5-X

Value: 2562

PVS GUEST VER BSD 6-X

Value: 2563

PVS GUEST VER BSD 7-X

Value: 2564

PVS GUEST VER BSD -LAST

Value: 2564

PVS GUEST VER BSD -OTHER

Value: 2815

PVS GUEST VER DOS -LAST

Value: 3073

PVS GUEST VER DOS -MS622

Value: 3073

PVS GUEST VER DOS -OTHER

Value: 3327

PVS GUEST VER LIN C-ENTOS

Value: 2317

PVS GUEST VER LIN D-EBIAN

Value: 2310

PVS GUEST VER LIN F-EDORA

Value: 2311

PVS GUEST VER LIN F-EDORA 5

Value: 2312

PVS GUEST VER LIN K-RNL 24

Value: 2308

PVS GUEST VER LIN K-RNL 26

Value: 2309

PVS GUEST VER LIN L-AST

Value: 2319

PVS GUEST VER LIN -MANDRAKE

Value: 2307

PVS GUEST VER LIN O-PENSUSE

Value: 2319

continued on next page

196

Page 197: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.consts

Name Description

PVS GUEST VER LIN O-THER

Value: 2559

PVS GUEST VER LIN R-EDHAT

Value: 2305

PVS GUEST VER LIN R-HLES3

Value: 2316

PVS GUEST VER LIN R-H LEGACY

Value: 2318

PVS GUEST VER LIN S-LES9

Value: 2315

PVS GUEST VER LIN S-USE

Value: 2306

PVS GUEST VER LIN U-BUNTU

Value: 2314

PVS GUEST VER LIN X-ANDROS

Value: 2313

PVS GUEST VER MAC-OS LAST

Value: 1795

PVS GUEST VER MAC-OS LEOPARD

Value: 1794

PVS GUEST VER MAC-OS SNOW LEOPARD

Value: 1795

PVS GUEST VER MAC-OS TIGER

Value: 1793

PVS GUEST VER NET -4X

Value: 3329

PVS GUEST VER NET -5X

Value: 3330

PVS GUEST VER NET -6X

Value: 3331

PVS GUEST VER NET -LAST

Value: 3331

PVS GUEST VER NET -OTHER

Value: 3583

PVS GUEST VER OS2 E-CS11

Value: 2820

PVS GUEST VER OS2 E-CS12

Value: 2821

PVS GUEST VER OS2 L-AST

Value: 2821

PVS GUEST VER OS2 -OTHER

Value: 3071

continued on next page

197

Page 198: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.consts

Name Description

PVS GUEST VER OS2 -WARP3

Value: 2817

PVS GUEST VER OS2 -WARP4

Value: 2818

PVS GUEST VER OS2 -WARP45

Value: 2819

PVS GUEST VER OTH -LAST

Value: 65282

PVS GUEST VER OTH -OPENSTEP

Value: 65282

PVS GUEST VER OTH -OTHER

Value: 65535

PVS GUEST VER OTH -QNX

Value: 65281

PVS GUEST VER SOL 1-0

Value: 3586

PVS GUEST VER SOL 1-1

Value: 3587

PVS GUEST VER SOL 9 Value: 3585

PVS GUEST VER SOL -LAST

Value: 3587

PVS GUEST VER SOL -OTHER

Value: 3839

PVS GUEST VER WIN -2003

Value: 2056

PVS GUEST VER WIN -2008

Value: 2058

PVS GUEST VER WIN -2K

Value: 2054

PVS GUEST VER WIN -311

Value: 2049

PVS GUEST VER WIN -95

Value: 2050

PVS GUEST VER WIN -98

Value: 2051

PVS GUEST VER WIN -LAST

Value: 2059

PVS GUEST VER WIN -ME

Value: 2052

PVS GUEST VER WIN -NT

Value: 2053

PVS GUEST VER WIN -OTHER

Value: 2303

continued on next page

198

Page 199: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.consts

Name Description

PVS GUEST VER WIN -VISTA

Value: 2057

PVS GUEST VER WIN -WINDOWS7

Value: 2059

PVS GUEST VER WIN -XP

Value: 2055

PWC VM ASK USER Value: 2

PWC VM DO NOTHING Value: 5

PWC VM PAUSE Value: 3

PWC VM SHUTDOWN Value: 4

PWC VM STOP Value: 0

PWC VM SUSPEND Value: 1

PWM COHERENCE WI-NDOW MODE

Value: 3

PWM DEFAULT WIND-OW MODE

Value: 0

PWM FULL SCREEN W-INDOW MODE

Value: 2

PWM MODALITY WIN-DOW MODE

Value: 4

PWM WINDOWED WIN-DOW MODE

Value: 1

RTT RUNNING TASK -CLONE VM

Value: 3

RTT RUNNING TASK -CREATE IMAGE

Value: 6

RTT RUNNING TASK -CREATE VM

Value: 1

RTT RUNNING TASK -DELETE VM

Value: 4

RTT RUNNING TASK -MIGRATE VM

Value: 8

RTT RUNNING TASK -REGISTER VM

Value: 2

RTT RUNNING TASK -RESTORE VM

Value: 7

RTT RUNNING TASK -UNKNOWN

Value: 0

RTT RUNNING TASK -UNREG VM

Value: 5

ScanCodesList Value: {’0’: (11), ’1’: (2), ’2’:

(3), ’3’: (4), ’4’: (5), ’5’: ...

continued on next page

199

Page 200: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.consts

Name Description

VMAS BACKUPING Value: 2

VMAS MAX Value: -2147483648

VMAS NOSTATE Value: 1

VMAS RESTORING FR-OM BACKUP

Value: 4

VMS COMPACTING Value: 805306376

VMS CONTINUING Value: 805306381

VMS DELETING STAT-E

Value: 805306383

VMS MIGRATING Value: 805306382

VMS PAUSED Value: 805306373

VMS PAUSING Value: 805306380

VMS RESETTING Value: 805306379

VMS RESTORING Value: 805306371

VMS RESUMING Value: 805306384

VMS RUNNING Value: 805306372

VMS SNAPSHOTING Value: 805306378

VMS STARTING Value: 805306370

VMS STOPPED Value: 805306369

VMS STOPPING Value: 805306375

VMS SUSPENDED Value: 805306377

VMS SUSPENDING Value: 805306374

VMS UNKNOWN Value: 0

WINDOW ALL EDGE M-ASK

Value: 15

WINDOW BOTTOM ED-GE MASK

Value: 8

WINDOW LEFT EDGE -MASK

Value: 1

WINDOW RIGHT EDG-E MASK

Value: 4

WINDOW TOP EDGE -MASK

Value: 2

200

Page 201: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Module prlsdkapi.prlsdk.errors

4 Module prlsdkapi.prlsdk.errors

4.1 Variables

Name Description

GUI ERR BACKUP FAI-LED GENERAL MSG

Value: 15104

GUI ERR BACKUP FAI-LED NOT ENOUGH SP-ACE

Value: 15103

GUI ERR BACKUP FAI-LED TOO LARGE FOR -FAT

Value: 15102

GUI ERR CANNOT RU-N SNAPSHOT OPERAT-ION ON VM BACKUP

Value: 15117

GUI ERR CANNOT RU-N SNAPSHOT OPERAT-ION ON VM RESTORE

Value: 15118

GUI ERR CANT ADD P-CI INSTANTLY

Value: 15000

GUI ERR CANT ADD S-CSI INSTANTLY

Value: 15001

GUI ERR CANT ADD V-IDEO ADAPTER INSTA-NTLY

Value: 15106

GUI ERR CANT CHAN-GE CDROM CONNECT -OPTION

Value: 15032

GUI ERR CANT CHAN-GE CLIENT CDROM C-ONNECT OPTION

Value: 15038

GUI ERR CANT CHAN-GE SHARED FOLDER

Value: 15036

GUI ERR CANT CLONE-SUSPENDED VM

Value: 15033

GUI ERR CANT ENABL-E MISSING DEVICE

Value: 15008

GUI ERR CANT SAVE -CONFIG AS VM WAS D-ELETED

Value: -2147397566

GUI ERR COMPRESSO-R UNSUPPORTED GUE-ST

Value: 15068

continued on next page

201

Page 202: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

GUI ERR DHCP INCOR-RECT END IP

Value: 15048

GUI ERR DHCP INCOR-RECT MASK IP

Value: 15049

GUI ERR DHCP INCOR-RECT START IP

Value: 15047

GUI ERR DHCP SCOPE-END OUT OF SUBNET

Value: 15056

GUI ERR DHCP START-IP IS LESS THAN END -IP

Value: 15055

GUI ERR DHCP ZERO -FIRST OCTET IN END -IP

Value: 15051

GUI ERR DHCP ZERO -FIRST OCTET IN MAS-K IP

Value: 15052

GUI ERR DHCP ZERO -FIRST OCTET IN STAR-T IP

Value: 15050

GUI ERR DHCP ZERO -LAST OCTET IN END I-P

Value: 15054

GUI ERR DHCP ZERO -LAST OCTET IN STAR-T IP

Value: 15053

GUI ERR IMAGE PATH-NOT SPECIFIED

Value: 15028

GUI ERR INCORRECT -SHARED FOLDER NAM-E

Value: 15044

GUI ERR INCORRECT -SHARED FOLDER PAT-H

Value: 15064

GUI ERR INVALID IMA-GE PATH

Value: 15009

GUI ERR INVALID MA-C ADDRESS

Value: 15060

GUI ERR INVALID OU-TPUT PATH

Value: 15026

GUI ERR INVALID SHA-RED FOLDER PATH

Value: 15035

continued on next page

202

Page 203: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

GUI ERR INVALID VM -NAME SPECIFIED

Value: 15045

GUI ERR LEGACY HD-D NOT SUPPORTED

Value: 15112

GUI ERR NEED TO RE-SET DISK PRM ON FA-T FS

Value: 15039

GUI ERR NEED TO RE-SET DISK PRM ON FA-T FS ON CUSTOM BRA-NCH

Value: 15040

GUI ERR NEED TO SE-T SPLIT ON FAT FS W-ITH RECREATE

Value: 15041

GUI ERR NO PVS FILE-SPECIFIED IN PLAYE-R MODE

Value: 15116

GUI ERR NO TEMPLA-TE SUPPORT IN PLAY-ER MODE

Value: 15115

GUI ERR OLD VERSIO-N LICENSE NOT VALI-D

Value: 15091

GUI ERR OLD VERSIO-N LICENSE WRONG DI-STRIBUTOR

Value: 15090

GUI ERR OLD VERSIO-N LICENSE WRONG LA-NGUAGE

Value: 15089

GUI ERR OUTPUT PA-TH NOT SPECIFIED

Value: 15030

GUI ERR PARALLELS I-MAGE INTERNET LOC-ATION

Value: 15110

GUI ERR PARALLELS -OUTPUT FILE INTERN-ET LOCATION

Value: 15111

GUI ERR REGISTERED-VM PATH NOT AVAIL-ABLE

Value: 15097

GUI ERR REPORT POS-T ID REGISTER FAILE-D

Value: 15012

continued on next page

203

Page 204: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

GUI ERR SERVER ALR-EADY REGISTERED

Value: 15010

GUI ERR SERVER CUS-TOM NAME EMPTY

Value: 15031

GUI ERR SERVER CUS-TOM NAME EXISTS

Value: 15027

GUI ERR SERVER WR-ONG CUSTOM NAME

Value: 15037

GUI ERR SHARED FOL-DER NAME EXISTS

Value: 15017

GUI ERR SHARED FOL-DER NAME IS NOT SP-ECIFIED

Value: 15062

GUI ERR SHARED FOL-DER NAME IS RESERV-ED BY SYSTEM

Value: 15046

GUI ERR SHARED FOL-DER PATH EXISTS

Value: 15018

GUI ERR SHARED FOL-DER PATH IS NOT SPE-CIFIED

Value: 15063

GUI ERR SHORTCUT E-XISTS

Value: 15013

GUI ERR SHORTCUT H-AS EMPTY MODIFIERS

Value: 15024

GUI ERR SNAPSHOT V-M WITH BOOTCAMP

Value: 15073

GUI ERR SNAPSHOT V-M WITH VTD

Value: 15094

GUI ERR SOCKET NOT-SPECIFIED

Value: 15029

GUI ERR SUSPEND VM-VTD WITH UNSUPPO-RTED GUEST

Value: 15095

GUI ERR SUSPEND VM-VTD WITH UNSUPPO-RTED SHUTDOWN TO-OL

Value: 15096

GUI ERR SUSPEND VM-WITH VTD

Value: 15107

GUI ERR VM DIR NOT -SPECIFIED

Value: 15015

continued on next page

204

Page 205: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

GUI ERR VM HW UPG-RADE INIT TIMEOUT

Value: 15082

GUI ERR VM HW UPG-RADE UNKNOWN ERR-OR

Value: 15081

GUI ERR VM HW UPG-RADE VMXPHY INIT T-IMEOUT

Value: 15086

GUI ERR VM HW UPG-RADE VMXPHY UNKN-OWN ERROR

Value: 15085

GUI ERR VM INVALID -EXTENSION

Value: 15007

GUI ERR VM NAME N-OT SPECIFIED

Value: 15014

GUI ERR VTD HOOK D-EVICE CURRENTLY IN-USE

Value: 15114

GUI ERR VTD INSTAL-LATION FAILED FOR -DEVICES

Value: 15108

GUI ERR VTD REVER-T FAILED FOR DEVIC-ES

Value: 15109

GUI ERR WRONG CDD-IMAGE PATH SPECIFI-ED

Value: 15016

GUI ERR WRONG NUM-BER OF CPU

Value: -2147397600

GUI INFO APPS FOLER-ADDED TO DOCK

Value: 15125

GUI INFO APPS FOLER-REMOVED FROM DO-CK

Value: 15126

GUI INFO CANT DISPL-AY HELP FILE

Value: 15006

GUI INFO CANT DISPL-AY HELP TOPIC

Value: 15043

GUI INFO CANT INSTA-LL TOOLS WITHOUT C-D

Value: 15019

continued on next page

205

Page 206: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

GUI INFO CANT RUN -COMPRESSOR WITHO-UT CD

Value: 15066

GUI INFO CONFIGURI-NG THE DOCK

Value: 15120

GUI INFO IDE NODE A-LREADY TAKEN

Value: 15004

GUI INFO INSTALL PR-L TOOLS BETA

Value: 15002

GUI INFO INSTALL TO-OLS LIN

Value: 15023

GUI INFO INSTALL TO-OLS MAC

Value: 15022

GUI INFO INSTALL TO-OLS WIN

Value: 15021

GUI INFO IN SEAMLES-S NOTIFICATION

Value: 15124

GUI INFO LICENSE AC-TIVATION SUCCESSFU-L

Value: 15003

GUI INFO NETWORK -MISCONFIGURATION -REPAIRED

Value: 15092

GUI INFO PROBLEM R-EPORT POST SUCCESS

Value: 15011

GUI INFO PRODUCT A-CTIVATED SUCCESSF-ULLY

Value: 15105

GUI INFO RUNNING U-NDER UNSUPPORTED -WM

Value: 15113

GUI INFO RUN COMPR-ESSOR WIN

Value: 15067

GUI INFO SCSI NODE -ALREADY TAKEN

Value: 15005

GUI INFO SERVER RES-TART IS NEEDED

Value: 15034

GUI INFO SHARE WIN -APPLICATIONS DISAB-LED

Value: 15123

GUI INFO SWITCH TO -FULLSCREEN

Value: 15065

continued on next page

206

Page 207: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

GUI INFO TOOLS INST-ALL OTHER

Value: 15075

GUI INFO VM HW UPG-RADE COMPLETED

Value: 15080

GUI INFO VM HW UPG-RADE VMXPHY COMP-LETED

Value: 15084

GUI INFO VM IN ISOL-ATION MAC

Value: 15122

GUI INFO VM IN ISOL-ATION WIN

Value: 15121

GUI INFO VM SHUTDO-WN CONDITIONS

Value: 15025

GUI QUESTION CANCE-L CLONE OPERATION

Value: 14000

GUI QUESTION CANCE-L CLONE TO TEMPLA-TE OPERATION

Value: 15057

GUI QUESTION CANCE-L DEPLOY OPERATIO-N

Value: 14010

GUI QUESTION CANT -USE DEVICE CLIENT O-PTION ON HOST

Value: 15061

GUI QUESTION COHER-ENCE NOTIFICATION

Value: 15077

GUI QUESTION COMP-RESSED DISK IN EXPR-ESS MODE

Value: 14011

GUI QUESTION DELET-E NET ADAPTER

Value: 14006

GUI QUESTION DISAB-LING SHARED FOLDE-RS RUNTIME

Value: 14020

GUI QUESTION DROP -SUSPEND FOR HDD Q-UEST CFG EDITOR

Value: 15058

GUI QUESTION DROP -SUSPEND FOR HDD Q-UEST WIZARDS

Value: 15059

GUI QUESTION EDIT S-USPENDED VM

Value: 15093

continued on next page

207

Page 208: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

GUI QUESTION ENABL-E GLOBAL HOST SHAR-ING

Value: 14013

GUI QUESTION ENABL-E LOCAL HOST SHARI-NG

Value: 14014

GUI QUESTION ENABL-E MOUNT ON DESKTO-P

Value: 14017

GUI QUESTION FDD I-MAGE ALREADY EXIS-T

Value: 14003

GUI QUESTION LEAVE-AUTO HW UPGRADIN-G

Value: 15078

GUI QUESTION LEAVE-AUTO HW UPGRADIN-G VMXPHY

Value: 15087

GUI QUESTION LOST -TASK CONTINUE

Value: 14012

GUI QUESTION NEED -TO DISABLE SHARED -PROFILE

Value: 14018

GUI QUESTION NEED -TO SHARE HOME FOL-DER

Value: 14019

GUI QUESTION OVER-WRITE HDD IMAGE

Value: 14008

GUI QUESTION QUIT -APPLICATION

Value: 14004

GUI QUESTION RECON-NECT USB TO ANOTH-ER VM

Value: 14022

GUI QUESTION RECRE-ATE HDD

Value: 14007

GUI QUESTION REMO-VE BACKUP

Value: 14024

GUI QUESTION REMO-VE SERVER FROM LIS-T

Value: 14009

GUI QUESTION RESTO-RE DEFAULT SETTING-S

Value: 14002

continued on next page

208

Page 209: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

GUI QUESTION RESTO-RE FROM BACKUP

Value: 14025

GUI QUESTION REVER-T TO LAST SNAPSHOT

Value: 14016

GUI QUESTION REVER-T TO SPECIFIED SNAP-SHOT

Value: 14015

GUI QUESTION SAME -FUNCTION NET ASSIG-N

Value: 14021

GUI QUESTION SWAP -SLOTS

Value: 14001

GUI QUESTION WARN -ALLOCATE MEM

Value: 14005

GUI TRY DISCONNECT-CONNECTING USB

Value: 14023

GUI WNG ADD HID US-B DEVICE TO UDP LIS-T

Value: 15071

GUI WNG AUTOCONN-ECT HID USB DEVICE

Value: 15070

GUI WNG CONNECT H-ID USB DEVICE

Value: 15069

GUI WNG NO FREE NE-TWORK ADAPTERS F-OR HOST

Value: 14026

GUI WNG STOP VM W-ITH BOOTCAMP

Value: 15072

GUI WRN CANT CLOS-E CONVERSION IN PR-OGRESS

Value: -2147397480

GUI WRN CANT CLOS-E DELETING STATE I-N PROGRESS

Value: -2147397375

GUI WRN CANT CLOS-E REVERTING IN PRO-GRESS

Value: -2147397376

GUI WRN CANT CLOS-E SNAPSHOTING IN P-ROGRESS

Value: -2147397479

GUI WRN MAIN MEMO-RY IS NOT OPTIMAL

Value: 15119

continued on next page

209

Page 210: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

GUI WRN SNAPSHOT -NAME IS EMPTY

Value: 15083

GUI WRN VIDEO MEM-ORY IS TOO LOW

Value: 15074

GUI WRN VM HW UPG-RADING IN PROGRESS

Value: -2147397511

GUI WRN VM HW UPG-RADING VMXPHY IN P-ROGRESS

Value: -2147397496

PET ANSWER APPEND Value: 16011

PET ANSWER BREAK Value: 16004

PET ANSWER CANCEL Value: 16001

PET ANSWER COMMI-T

Value: 16016

PET ANSWER COMPA-CT

Value: 16024

PET ANSWER CONTIN-UE

Value: 16008

PET ANSWER COPIED Value: 16013

PET ANSWER CREATE Value: 16019

PET ANSWER CREATE-NEW

Value: 16009

PET ANSWER DISCON-NECT ANYWAY

Value: 16018

PET ANSWER LATER Value: 16023

PET ANSWER MOVED Value: 16014

PET ANSWER NO Value: 16003

PET ANSWER OK Value: 16000

PET ANSWER OVERID-E

Value: 16005

PET ANSWER REPLAC-E

Value: 16012

PET ANSWER RESTAR-T NOW

Value: 16022

PET ANSWER REVERT Value: 16017

PET ANSWER SHUTDO-WN

Value: 16006

PET ANSWER SKIP Value: 16020

PET ANSWER STARTV-M

Value: 16015

PET ANSWER STOP Value: 16007

PET ANSWER SUSPEN-D ANYWAY

Value: 16021

continued on next page

210

Page 211: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PET ANSWER USE CU-RRENT

Value: 16010

PET ANSWER YES Value: 16002

PET ERR WARN REAC-H OVERCOMMIT STAT-E ON SETMEM

Value: 441

PET QUESTION ALLO-W TO SUSPEND VM W-ITH BOOTCAMP DISK

Value: 13022

PET QUESTION APPL-Y WHEN HYP CANNO-T ALLOC VMS MEM

Value: 13021

PET QUESTION BOOT-CAMP HELPER INIT F-AILURE

Value: 13015

PET QUESTION BOOT-CAMP HELPER OS UN-SUPPORTED

Value: 13016

PET QUESTION CANC-EL CLONE OPERATIO-N

Value: 13024

PET QUESTION CANC-EL CLONE TO TEMPL-ATE OPERATION

Value: 13025

PET QUESTION CANC-EL DEPLOY OPERATI-ON

Value: 13026

PET QUESTION CHAN-GE VM MIGRATION T-YPE

Value: 13012

PET QUESTION COMP-ACT VM DISKS

Value: 13030

PET QUESTION CONTI-NUE IF HVT DISABLE-D

Value: 13031

PET QUESTION CREA-TE NEW MAC ADDRES-S

Value: 13011

PET QUESTION CREA-TE OS2 GUEST WITHO-UT FDD IMAGE

Value: 13020

continued on next page

211

Page 212: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PET QUESTION DELA-YED COMPACT VM DI-SKS

Value: 13032

PET QUESTION DELET-E FILES OUT OF VM D-IR

Value: 13006

PET QUESTION DELET-E PARALLELS FILES I-N VM DIR

Value: 13007

PET QUESTION DELET-E VM WITH CORRUPT-ED CONFIG

Value: 13009

PET QUESTION DO YO-U WANT TO OVERWRI-TE FILE

Value: 13002

PET QUESTION FREE -SIZE FOR COMPRESSE-D DISK

Value: 13005

PET QUESTION MAC P-HYSICAL MEMORY M-AP BUG

Value: 13019

PET QUESTION OLD C-ONFIG CONVERTION

Value: 13004

PET QUESTION REAC-H OVERCOMMIT STAT-E

Value: 13014

PET QUESTION REAC-H OVERCOMMIT STAT-E ON SETMEM

Value: 13017

PET QUESTION REBO-OT HOST ON PCI DRIV-ER INSTALL OR REVE-RT

Value: 13027

PET QUESTION REGIS-TER USED VM

Value: 13010

PET QUESTION REGIS-TER VM TEMPLATE

Value: 13008

PET QUESTION RESTA-RT VM GUEST TO CO-MPACT

Value: 13029

PET QUESTION RESTO-RE VM CONFIG FROM -BACKUP

Value: 13023

continued on next page

212

Page 213: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PET QUESTION SAMP-LE 1

Value: 13000

PET QUESTION SAMP-LE 2

Value: 13001

PET QUESTION SWITC-H OFF AUTO COMPRE-SS

Value: 13033

PET QUESTION TXT E-RROR

Value: 13003

PET QUESTION UNDO -DISKS MODE

Value: 13018

PET QUESTION VM C-OPY OR MOVE

Value: 13013

PET QUESTION VM R-OOT DIRECTORY NOT-EXISTS

Value: 13028

PRL CHECKED DISK I-NVALID

Value: 25002

PRL CHECKED DISK O-LD VERSION

Value: 25001

PRL CHECKED DISK V-ALID

Value: 25000

PRL ERR ACCESS DEN-IED

Value: -2147483643

PRL ERR ACCESS DEN-IED TO CHANGE PER-MISSIONS

Value: -2147482751

PRL ERR ACCESS DEN-IED TO DISK IMAGE

Value: -2147483528

PRL ERR ACCESS DEN-INED TO RUN WIZARD

Value: -2147482784

PRL ERR ACCESS TOK-EN INVALID

Value: -2147483552

PRL ERR ACCESS TO -VM DENIED

Value: -2147483079

PRL ERR ACCES DENI-ED FILE TO PARENT -PARENT DIR

Value: -2147483392

PRL ERR ADD HW FL-OPPY IMAGE NOT SPE-CIFYED

Value: -2147482857

continued on next page

213

Page 214: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR ADD VM OP-ERATION WAS CANCE-LED

Value: -2147482855

PRL ERR ADMIN CON-FIRMATION IS REQUI-RED FOR OPERATION

Value: -2147217149

PRL ERR ADMIN CON-FIRMATION IS REQUI-RED FOR VM OPERAT-ION

Value: -2147217148

PRL ERR ALIGN ON 4 Value: -2147483133

PRL ERR ALREADY C-ONNECTED TO DISPA-TCHER

Value: -2147483054

PRL ERR ANOTHER U-SER SESSIONS PRESEN-T

Value: -2147482783

PRL ERR API INCOMP-ATIBLE

Value: -2147482590

PRL ERR API WASNT I-NITIALIZED

Value: -2147483001

PRL ERR ATTACH TO -TASK BAD SESSION

Value: -2147482807

PRL ERR AUTHENTIC-ATION FAILED

Value: -2147482832

PRL ERR BACKUP AC-CESS TO VM DENIED

Value: -2147258365

PRL ERR BACKUP AC-RONIS ERR

Value: -2147258346

PRL ERR BACKUP BA-CKUP CMD FAILED

Value: -2147258344

PRL ERR BACKUP BA-CKUP NOT FOUND

Value: -2147258351

PRL ERR BACKUP BA-CKUP UUID NOT FOU-ND

Value: -2147258364

PRL ERR BACKUP CA-NNOT CREATE DIREC-TORY

Value: -2147258359

PRL ERR BACKUP CA-NNOT REMOVE DIREC-TORY

Value: -2147258350

continued on next page

214

Page 215: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR BACKUP CA-NNOT SET PERMISSIO-NS

Value: -2147258332

PRL ERR BACKUP CR-EATE SNAPSHOT FAIL-ED

Value: -2147258363

PRL ERR BACKUP DIR-ECTORY ALREADY EX-IST

Value: -2147258360

PRL ERR BACKUP INT-ERNAL ERROR

Value: -2147258367

PRL ERR BACKUP INT-ERNAL PROTO ERROR

Value: -2147258368

PRL ERR BACKUP LO-CKED FOR READING

Value: -2147258349

PRL ERR BACKUP LO-CKED FOR WRITING

Value: -2147258348

PRL ERR BACKUP RE-GISTER VM FAILED

Value: -2147258361

PRL ERR BACKUP RE-QUIRE LOGIN PASSW-ORD

Value: -2147258347

PRL ERR BACKUP RES-TORE CMD FAILED

Value: -2147258343

PRL ERR BACKUP RES-TORE VM RUNNING

Value: -2147258352

PRL ERR BACKUP SN-APSHOT OF PAUSED -VM

Value: -2147258335

PRL ERR BACKUP SWI-TCH TO SNAPSHOT F-AILED

Value: -2147258362

PRL ERR BACKUP TIM-EOUT EXCEEDED

Value: -2147258366

PRL ERR BAD DISP C-ONFIG FILE SPECIFIE-D

Value: -2147483616

PRL ERR BAD PARAM-ETERS

Value: -2147483517

PRL ERR BAD VM CO-NFIG FILE SPECIFIED

Value: -2147483598

continued on next page

215

Page 216: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR BAD VM DIR-CONFIG FILE SPECIFI-ED

Value: -2147483609

PRL ERR BUFFER OVE-RRUN

Value: -2147483642

PRL ERR CANNOT PR-OCESSING SAFE MOD-E FOR INVALID VM

Value: -2147482555

PRL ERR CANNOT PR-OCESSING UNDO DISK-S FOR INVALID VM

Value: -2147482556

PRL ERR CANNOT SA-VE REMOTE DEVICE S-TATE

Value: -2147482503

PRL ERR CANTS CRE-ATE DISK IMAGE ON -FAT

Value: -2147482746

PRL ERR CANTS CRE-ATE DISK IMAGE ON -FAT32

Value: -2147482745

PRL ERR CANT ALOC-A MEM FILE COPY

Value: -2147483383

PRL ERR CANT CHAN-GE FILE PERMISSIONS

Value: -2147482823

PRL ERR CANT CHAN-GE OWNER OF DISK I-MAGE FILE

Value: -2147482732

PRL ERR CANT CHAN-GE OWNER OF FILE

Value: -2147483007

PRL ERR CANT CHAN-GE OWNER OF VM FIL-E

Value: -2147482733

PRL ERR CANT CONFI-GURE PARTITION HD-D

Value: -2147482599

PRL ERR CANT CONFI-GURE PHYSICAL HDD

Value: -2147482824

PRL ERR CANT CONN-ECT TO DISPATCHER

Value: -2147483063

PRL ERR CANT CONV-ERT HDD IMAGE FILE

Value: -2147482864

continued on next page

216

Page 217: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR CANT CONV-ERT OLD VM WITH IN-STALLED TOOLS

Value: -2147482747

PRL ERR CANT CONV-ERT VM CONFIG DUE -UNDO DISKS PRESENT

Value: -2147482872

PRL ERR CANT CONV-ERT VM CONFIG DUE -UNDO SNAPSHOTS PR-ESENT

Value: -2147482871

PRL ERR CANT CREA-TE FLOPPY IMAGE

Value: -2147483495

PRL ERR CANT CREA-TE HDD IMAGE

Value: -2147483496

PRL ERR CANT CREA-TE HDD IMAGE NO SP-ACE

Value: -2147482743

PRL ERR CANT CREA-TE PARALLEL PORT I-MAGE

Value: -2147483391

PRL ERR CANT CREA-TE SERIAL PORT IMA-GE

Value: -2147482624

PRL ERR CANT DELE-TE FILE

Value: -2147483006

PRL ERR CANT EDIT S-USPENDED VM

Value: -2147483388

PRL ERR CANT GET F-ILE PERMISSIONS

Value: -2147482750

PRL ERR CANT INIT R-EAL CPUS INFO

Value: -2147483022

PRL ERR CANT PARSE-DISP EVENT

Value: -2147483068

PRL ERR CANT PARSE-VM CONFIG

Value: -2147483095

PRL ERR CANT RECR-EATE HDD

Value: -2147482839

PRL ERR CANT REMO-VE DIR ENTRY

Value: -2147482616

PRL ERR CANT REMO-VE ENTRY

Value: -2147483518

continued on next page

217

Page 218: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR CANT REMO-VE INVALID VM AS N-ON ADMIN

Value: -2147482749

PRL ERR CANT RENA-ME DIR ENTRY

Value: -2147482615

PRL ERR CANT RENA-ME ENTRY

Value: -2147483519

PRL ERR CANT REPL-ACE FLOPPY IMAGE

Value: -2147482829

PRL ERR CANT RESIZ-E HDD

Value: -2147482492

PRL ERR CANT REVE-RT VM SINCE VTD DE-VICE ALREADY USED

Value: -2147482519

PRL ERR CANT STAR-T VM SINCE NO VTD -DRIVER

Value: -2147482527

PRL ERR CANT STAR-T VM SINCE VTD DEV-ICE ALREADY USED

Value: -2147482525

PRL ERR CANT SUSPE-ND VM WITH BOOTCA-MP

Value: -2147352560

PRL ERR CANT TO CH-ANGE PERMISSIONS O-N REMOTE LOCATION

Value: -2147482601

PRL ERR CANT TO ST-ART VM TEMPLATE

Value: -2147482776

PRL ERR CANT UPDA-TE DEVICE INFO

Value: -2147482830

PRL ERR CAN NOT GE-T DISK FREE SPACE

Value: -2147482874

PRL ERR CDD IMAGE -NOT SPECIFIED

Value: -2147483128

PRL ERR CHANEGSID -GUEST TOOLS NOT A-VAILABLE

Value: -2147216895

PRL ERR CHANEGSID -VM START FAILED

Value: -2147216894

PRL ERR CHANGESID -FAILED

Value: -2147216896

PRL ERR CLONE OPE-RATION CANCELED

Value: -2147483385

continued on next page

218

Page 219: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR COMMAND S-UPPORTED ONLY AT -SERVER MODE

Value: -2147482591

PRL ERR COMMON SE-RVER PREFS BLOCKE-D TO CHANGE

Value: -2147483023

PRL ERR COMMON SE-RVER PREFS WERE C-HANGED

Value: -2147483358

PRL ERR COMPACT A-LREADY SWITCHED O-N

Value: 494

PRL ERR COM DEVICE-ALREADY EXIST

Value: -2147483052

PRL ERR COM OUTPU-T FILE IS NOT SPECIFI-ED

Value: -2147483115

PRL ERR COM OUTPU-T FILE NOT EXIST

Value: -2147483113

PRL ERR CONCURREN-T COMMAND EXECUT-ING

Value: -2147483070

PRL ERR CONFIGURE -GENERIC PCI TASK A-LREADY RUN

Value: -2147482535

PRL ERR CONFIG BEG-IN EDIT NOT FOUND -OBJECT UUID

Value: -2147482810

PRL ERR CONFIG BEG-IN EDIT NOT FOUND -USER UUID

Value: -2147482809

PRL ERR CONFIG EDI-T COLLISION

Value: -2147482845

PRL ERR CONFIG FILE-NOT SET

Value: -2147483592

PRL ERR CONFIRMAT-ION MODE ALREADY -DISABLED

Value: -2147217150

PRL ERR CONFIRMAT-ION MODE ALREADY -ENABLED

Value: -2147217151

continued on next page

219

Page 220: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR CONFIRMAT-ION MODE UNABLE C-HANGE BY NOT ADMI-N

Value: -2147217152

PRL ERR CORE STATE-CHANGE VM CONFIG

Value: -2147352572

PRL ERR CORE STATE-CORRUPT MEM FILE

Value: -2147352573

PRL ERR CORE STATE-CORRUPT SAV FILE

Value: -2147352574

PRL ERR CORE STATE-ERROR COMMON

Value: -2147352576

PRL ERR CORE STATE-INV SAV VERSION

Value: -2147352575

PRL ERR COULDNT C-REATE AUTHORIZATI-ON FILE

Value: -2147482987

PRL ERR COULDNT SE-T PERMISSIONS TO A-UTHORIZATION FILE

Value: -2147482986

PRL ERR CPU RESTAR-T

Value: -2147482752

PRL ERR CPU SHUTD-OWN

Value: -2147482759

PRL ERR CREATE BO-OTABLE ISO

Value: -2147221504

PRL ERR CREATE PRI-VELEGED PROCESS

Value: -2147389438

PRL ERR CREATE SNA-PSHOT VM VTD BY G-UEST SLEEP TIMEOUT

Value: -2147262459

PRL ERR CREATE SNA-PSHOT VM VTD PAUS-ED

Value: -2147262461

PRL ERR CREATE SNA-PSHOT VM VTD WITH-OUTDATED SHUTDO-WN TOOL

Value: -2147262455

PRL ERR CREATE SNA-PSHOT VM VTD WITH-UNLOADED SHUTDO-WN TOOL

Value: -2147262456

continued on next page

220

Page 221: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR CREATE SNA-PSHOT VM VTD WITH-UNSUPPORTED CAPS

Value: -2147262426

PRL ERR CREATE SNA-PSHOT VM VTD WITH-UNSUPPORTED SHUT-DOWN TOOL

Value: -2147262460

PRL ERR DELETING V-M FROM CATALOGUE

Value: -2147483053

PRL ERR DEV ALREA-DY CONNECTED

Value: -2147446784

PRL ERR DEV ALREA-DY DISCONNECTED

Value: -2147446783

PRL ERR DEV DISABL-E AFTER LOST

Value: -2147482813

PRL ERR DEV FLOPPY-CONNECT FAILED

Value: -2147479552

PRL ERR DEV MAX C-D EXCEEDED WITH DI-SABLED CLIENT SCSII

Value: -2147418092

PRL ERR DEV MAX C-D HDD EXCEEDED

Value: -2147418111

PRL ERR DEV MAX N-UMBER EXCEEDED

Value: -2147418112

PRL ERR DEV PARALL-EL PORT FILE CONNE-CT FAILED

Value: -2147454974

PRL ERR DEV PARALL-EL PORT PHYSICAL C-ONNECT FAILED

Value: -2147454976

PRL ERR DEV PARALL-EL PORT PRINTER CO-NNECT FAILED

Value: -2147454975

PRL ERR DEV PARALL-EL PORT REMOTE CO-NNECT FAILED

Value: -2147454973

PRL ERR DEV SERIAL -PORT FILE CONNECT -FAILED

Value: -2147459070

PRL ERR DEV SERIAL -PORT PHYSICAL CON-NECT FAILED

Value: -2147459072

continued on next page

221

Page 222: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR DEV SERIAL -PORT PIPE CONNECT -FAILED

Value: -2147459071

PRL ERR DEV SERIAL -PORT REMOTE CONN-ECT FAILED

Value: -2147459069

PRL ERR DEV USB BU-SY

Value: -2147450875

PRL ERR DEV USB CH-ANGEPID

Value: -2147450873

PRL ERR DEV USB HA-RD DEVICE INSERTED

Value: -2147450877

PRL ERR DEV USB HA-RD DEVICE INSERTED-2

Value: -2147450876

PRL ERR DEV USB INS-TALL DRIVER FAILED

Value: -2147450879

PRL ERR DEV USB NO-FREE PORTS

Value: -2147450878

PRL ERR DEV USB OP-EN MANAGER FAILED

Value: -2147450880

PRL ERR DEV USB RE-USE

Value: -2147450874

PRL ERR DIRECTORY -DOES NOT EXIST

Value: -2147483531

PRL ERR DISK BLOCK-CREATED

Value: -2147348411

PRL ERR DISK BLOCK-PARTIALLY PROCESS-ED

Value: -2147348455

PRL ERR DISK BLOCK-SEARCH FAILED

Value: -2147344381

PRL ERR DISK BLOCK-SKIPPED

Value: -2147348456

PRL ERR DISK BOOTC-AMP WRITE MBR

Value: -2147348391

PRL ERR DISK CANT I-NITIALIZE IMAGE

Value: -2147348407

PRL ERR DISK COMPR-ESSED FILE EMPTY

Value: -2147344383

PRL ERR DISK CREAT-E IMAGE ERROR

Value: -2147348458

continued on next page

222

Page 223: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR DISK DATA -NOT FOUND

Value: -2147340288

PRL ERR DISK DIR CR-EATE ERROR

Value: -2147348459

PRL ERR DISK DISK N-OT OPENED

Value: -2147348447

PRL ERR DISK ENLAR-GE FAILED

Value: -2147348393

PRL ERR DISK FAT32 -SIZE EXCEEDED

Value: -2147348445

PRL ERR DISK FILE C-REATE ERROR

Value: -2147348461

PRL ERR DISK FILE E-XISTS

Value: -2147348462

PRL ERR DISK FILE O-PEN ERROR

Value: -2147348460

PRL ERR DISK FSYNC -FAILED

Value: -2147348431

PRL ERR DISK FULLFS-YNC FAILED

Value: -2147348430

PRL ERR DISK GENER-IC ERROR

Value: -2147348480

PRL ERR DISK GET M-OUNTPATH FAILED

Value: -2147336192

PRL ERR DISK GET P-ARAMS FAILED

Value: -2147336189

PRL ERR DISK GROUP-INTERSECT

Value: -2147348410

PRL ERR DISK IDENTI-FY FAILED

Value: -2147336188

PRL ERR DISK IMAGE-S CORRUPTED

Value: -2147348472

PRL ERR DISK IMAGE -BUSY

Value: -2147348412

PRL ERR DISK IMPERS-ONATE FAILED

Value: -2147348384

PRL ERR DISK INCOR-RECTLY CLOSED

Value: -2147348409

PRL ERR DISK INSUFF-ICIENT SPACE

Value: -2147348446

PRL ERR DISK INTER-NAL CLASS ERROR

Value: -2147348443

continued on next page

223

Page 224: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR DISK INVALI-D BLOCKSIZE

Value: -2147348471

PRL ERR DISK INVALI-D FORMAT

Value: -2147348429

PRL ERR DISK INVALI-D PARAMETERS

Value: -2147348463

PRL ERR DISK MEMO-RY ERROR

Value: -2147348448

PRL ERR DISK MOUNT-FAILED

Value: -2147336191

PRL ERR DISK NOT IM-PLEMENTED

Value: -2147348414

PRL ERR DISK NOT P-ERMITTED

Value: -2147348444

PRL ERR DISK NOT V-ALID OFFSET

Value: -2147348394

PRL ERR DISK NULL P-ART SIZE

Value: -2147348399

PRL ERR DISK OFFSE-TS FIXED

Value: -2147348408

PRL ERR DISK OPERA-TION ABORTED

Value: -2147348426

PRL ERR DISK OPERA-TION IN PROGRESS

Value: -2147348457

PRL ERR DISK OPERA-TION NOT ALLOWED

Value: -2147348427

PRL ERR DISK PARTI-TIONS TABLE CYCLE

Value: -2147348413

PRL ERR DISK PARTI-TION INVALID NAME

Value: -2147348396

PRL ERR DISK PARTI-TION NOT FOUND

Value: -2147348397

PRL ERR DISK POINT-ERS MIXED UP

Value: -2147344380

PRL ERR DISK POSSIB-LE OVERRUN

Value: -2147348392

PRL ERR DISK READ -FAILED

Value: -2147348439

PRL ERR DISK READ -OUT DISK

Value: -2147348440

PRL ERR DISK RENAM-E ERROR

Value: -2147348428

continued on next page

224

Page 225: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR DISK RESER-VED WORD

Value: -2147340287

PRL ERR DISK RESIZE-R NOT FOUND

Value: -2147217408

PRL ERR DISK RESIZE-FAILED

Value: -2147217405

PRL ERR DISK RESIZE-SIZE TOO LOW

Value: -2147217406

PRL ERR DISK RESIZE-WITH SNAPSHOTS NO-T ALLOWED

Value: -2147217407

PRL ERR DISK SET CA-CHING FAILED

Value: -2147348432

PRL ERR DISK SET FI-LE SIZE FAILED

Value: -2147344379

PRL ERR DISK SHARE-D BLOCK

Value: -2147344384

PRL ERR DISK SHARIN-G VIOLATION

Value: -2147348425

PRL ERR DISK SMALL -IMAGE SIZE

Value: -2147348400

PRL ERR DISK SNAPS-HOTS CORRUPTED

Value: -2147348474

PRL ERR DISK STATE-S ERROR

Value: -2147348464

PRL ERR DISK STORA-GE CORRUPTED

Value: -2147348473

PRL ERR DISK TOOL -NOT FOUND

Value: -2147482478

PRL ERR DISK TOOL -PROCESS ERROR

Value: -2147482479

PRL ERR DISK TRUNC-ATE FAILED

Value: -2147344382

PRL ERR DISK UNALI-GNED

Value: -2147348395

PRL ERR DISK UNCOM-MITED OPERATION

Value: -2147348382

PRL ERR DISK UNMO-UNT FAILED

Value: -2147336190

PRL ERR DISK USER I-NTERRUPTED

Value: -2147348424

PRL ERR DISK WRITE -FAILED

Value: -2147348441

continued on next page

225

Page 226: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR DISK WRITE -OUT DISK

Value: -2147348442

PRL ERR DISK WRITE -REAL FAILED

Value: -2147348415

PRL ERR DISK XML IN-VALID

Value: -2147348478

PRL ERR DISK XML IN-VALID VERSION

Value: -2147348477

PRL ERR DISK XML L-ARGE FILE

Value: -2147348475

PRL ERR DISK XML L-OCKED

Value: -2147348398

PRL ERR DISK XML MI-SSING

Value: -2147348383

PRL ERR DISK XML O-PEN FAILED

Value: -2147348479

PRL ERR DISK XML S-AVE ERROR

Value: -2147348476

PRL ERR DISK XML S-AVE REMOVE ERROR

Value: -2147348423

PRL ERR DISK XML S-AVE RENAME ERROR

Value: -2147348416

PRL ERR DISP2DISP S-ESSION ALREADY AU-THORIZED

Value: -2147287040

PRL ERR DISP2DISP W-RONG USER SESSION -UUID

Value: -2147287039

PRL ERR DISPATCHER-SERVICE MODE

Value: -2147482780

PRL ERR DISP AUTO -COMPRESS PERIOD O-UT OF RANGE

Value: -2147482488

PRL ERR DISP CANNO-T COMPACT VM HAR-D DISK

Value: -2147482477

PRL ERR DISP CONFI-G ALREADY EXISTS

Value: -2147483611

PRL ERR DISP CONFI-G FILE NOT SET

Value: -2147483584

PRL ERR DISP CONFI-G WRITE ERR

Value: -2147483546

continued on next page

226

Page 227: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR DISP LOGON-ACTIONS REACHED U-P LIMIT

Value: -2147482603

PRL ERR DISP SHUTD-OWN IN PROCESS

Value: -2147482620

PRL ERR DISP START -VM FOR COMPACT FA-ILED

Value: -2147482490

PRL ERR DISP VM CO-MMAND CANT BE EXE-CUTED

Value: -2147482602

PRL ERR DISP VM IS -NOT STARTED

Value: -2147482761

PRL ERR DOUBLE INI-T

Value: -2147483631

PRL ERR DROP SUSPE-ND FOR HDD QUEST

Value: -2147482619

PRL ERR ENTRY ALR-EADY EXISTS

Value: -2147483520

PRL ERR ENTRY DIR -ALREADY EXISTS

Value: -2147482608

PRL ERR ENTRY DIR -DOES NOT EXIST

Value: -2147482607

PRL ERR ENTRY DOE-S NOT EXIST

Value: -2147483527

PRL ERR EXCEED LIM-IT MAX RUNNING VM-S

Value: -2147482744

PRL ERR EXCEED ME-MORY LIMIT

Value: -2147483131

PRL ERR FAILED TO -AUTH ON BACKUP SE-RVER

Value: -2147258333

PRL ERR FAILED TO -CONNECT TO BACKU-P SERVER

Value: -2147258334

PRL ERR FAILED TO S-TART VNC SERVER

Value: -2147266557

PRL ERR FAILED TO S-TOP VNC SERVER

Value: -2147266556

PRL ERR FAILURE Value: -2147483639

PRL ERR FAILURE ON-VM DESTROYED

Value: -2147482526

continued on next page

227

Page 228: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR FDD IMAGE -CLONE TO SELF

Value: -2147482859

PRL ERR FDD IMAGE -COPY

Value: -2147482860

PRL ERR FDD IMAGE -NOT SPECIFIED

Value: -2147483127

PRL ERR FILECOPY C-ANT CREATE DIR

Value: -2147282911

PRL ERR FILECOPY C-ANT OPEN FILE

Value: -2147282910

PRL ERR FILECOPY C-ANT WRITE

Value: -2147282909

PRL ERR FILECOPY DI-R EXIST

Value: -2147282919

PRL ERR FILECOPY FI-LE EXIST

Value: -2147282912

PRL ERR FILECOPY IN-TERNAL

Value: -2147282908

PRL ERR FILECOPY P-ROTOCOL

Value: -2147282920

PRL ERR FILE DISK SP-ACE ERROR

Value: -2147482765

PRL ERR FILE NOT EX-IST

Value: -2147482846

PRL ERR FILE NOT FO-UND

Value: -2147483632

PRL ERR FILE OR DIR-ALREADY EXISTS

Value: -2147482795

PRL ERR FILE READ E-RROR

Value: -2147483376

PRL ERR FILE TRANS-FER CANT CREATE D-ST FILE

Value: -2147327996

PRL ERR FILE TRANS-FER CANT LOCATE S-RC FILE

Value: -2147327999

PRL ERR FILE TRANS-FER CANT READ SRC -FILE

Value: -2147327998

PRL ERR FILE TRANS-FER CANT WRITE DA-TA TO DST FILE

Value: -2147327995

continued on next page

228

Page 229: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR FILE TRANS-FER CLIENT NOT CON-NECTED

Value: -2147328000

PRL ERR FILE TRANS-FER DST FILE ALREA-DY EXIST

Value: -2147327994

PRL ERR FILE TRANS-FER INVALID ARGUM-ENTS

Value: -2147327991

PRL ERR FILE TRANS-FER INVALID CREDEN-TIALS

Value: -2147327997

PRL ERR FILE TRANS-FER OPERATION NOT -SUPPORTED

Value: -2147327993

PRL ERR FILE TRANS-FER UPLOAD CANCEL-ED BY USER

Value: -2147327992

PRL ERR FILE WRITE -ERROR

Value: -2147482766

PRL ERR FIXME Value: -2147483097

PRL ERR FLOPPY DRI-VE INVALID

Value: -2147483098

PRL ERR FLOPPY IMA-GE ALREADY EXIST

Value: -2147483050

PRL ERR FLOPPY IMA-GE NOT EXIST

Value: -2147483499

PRL ERR FREE DISC S-PACE FOR CLONE

Value: -2147482767

PRL ERR FREE DISK S-PACE FOR CREATE S-NAPSHOT

Value: -2147482558

PRL ERR FREE DISK S-PACE FOR REVERT T-O SNAPSHOT

Value: -2147482557

PRL ERR GET LICENS-E INVALID ARG

Value: -2147483337

PRL ERR GET MON ST-ATE INVALID ARG

Value: -2147483352

PRL ERR GET MON ST-ATE VM NOT CONFIG-URED

Value: -2147483351

continued on next page

229

Page 230: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR GET MON ST-ATE VM NOT CREATE-D

Value: -2147483353

PRL ERR GET NET SE-RVICE STATUS FAILE-D

Value: -2147482797

PRL ERR GET RESOLU-TION TOOL INVALID -ARG

Value: -2147483274

PRL ERR GET RESOLU-TION TOOL VMNOTCR-EATED

Value: -2147483275

PRL ERR GET USER H-OME DIR

Value: -2147483069

PRL ERR GUEST MAC -INVALID VERSION

Value: -2147482791

PRL ERR GUEST MAC -NOT ENOUGH MEMOR-Y

Value: -2147482792

PRL ERR GUEST MAC -NOT MACSERVER HOS-T

Value: -2147482729

PRL ERR GUEST PRO-GRAM EXECUTION FA-ILED

Value: -2147270652

PRL ERR GUEST TOO-LS NOT INSTALLED

Value: -2147482589

PRL ERR HANDSHAKE-FAILED

Value: -2147482606

PRL ERR HARD DISK I-MAGE CORRUPTED

Value: -2147475454

PRL ERR HDD IMAGE -CLONE TO SELF

Value: -2147483500

PRL ERR HDD IMAGE -COPY

Value: -2147483081

PRL ERR HDD IMAGE -IS ALREADY EXIST

Value: -2147483000

PRL ERR HDD IMAGE -NOT EXIST

Value: -2147483501

PRL ERR HDD IMAGE -NOT SPECIFIED

Value: -2147483130

PRL ERR HOST AMD G-UEST MAC

Value: -2147482808

continued on next page

230

Page 231: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR HTTP AUTH -REQUIRED

Value: -2147254266

PRL ERR HTTP CONN-ECTION REFUSED

Value: -2147254271

PRL ERR HTTP HOST -NOT FOUND

Value: -2147254272

PRL ERR HTTP INVAL-ID RESPONSE HEADER

Value: -2147254269

PRL ERR HTTP PROB-LEM REPORT SEND F-AILURE

Value: -2147254265

PRL ERR HTTP PROX-Y AUTH REQUIRED

Value: -2147254267

PRL ERR HTTP UNEX-PECTED CLOSE

Value: -2147254270

PRL ERR HTTP WRON-G CONTENT LENGTH

Value: -2147254268

PRL ERR HVT DISABL-ED

Value: -2147482815

PRL ERR HVT NOT AV-AILABLE WARNING

Value: -2147482493

PRL ERR HVT NOT PR-ESENT

Value: -2147482826

PRL ERR HVT TURNE-D OFF IN CONFIG

Value: -2147482777

PRL ERR HYP ALLOC -VMS MEMORY

Value: -2147482575

PRL ERR IMAGE NEED-TO CONVERT

Value: -2147475455

PRL ERR IMPERSONA-TE FAILED

Value: -2147482800

PRL ERR INCONSISTE-NCY VM CONFIG

Value: -2147483386

PRL ERR INCORRECT -CDROM PATH

Value: -2147479551

PRL ERR INCORRECT -FDD PATH

Value: -2147482827

PRL ERR INCORRECT -PATH

Value: -2147482844

PRL ERR INSERTING -VM TO CATALOGUE

Value: -2147483080

continued on next page

231

Page 232: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR INSTALLATI-ON PROBLEM

Value: -2147483004

PRL ERR INVALID AC-CESS TOKEN RECEIVE-D

Value: -2147483067

PRL ERR INVALID AR-G

Value: -2147483645

PRL ERR INVALID CO-NFIGURATION

Value: -2147482779

PRL ERR INVALID HA-NDLE

Value: -2147483644

PRL ERR INVALID HD-D GEOMETRY

Value: -2147483129

PRL ERR INVALID KE-XT REBOOT REQUIRE-D

Value: -2147482576

PRL ERR INVALID ME-MORY SIZE

Value: -2147483132

PRL ERR INVALID PA-RALLELS DISK

Value: -2147475456

PRL ERR INVALID PA-RAM

Value: -2147483624

PRL ERR IO AUTHENT-ICATION FAILED

Value: -2147482876

PRL ERR IO CONNECT-ION TIMEOUT

Value: -2147482877

PRL ERR IO DISABLED Value: -2147482816

PRL ERR IO INVALID -POINTER ACCESS

Value: -2147482542

PRL ERR IO NO CONN-ECTION

Value: -2147482623

PRL ERR IO SEND QU-EUE IS FULL

Value: -2147482880

PRL ERR IO STOPPED Value: -2147482879

PRL ERR IO UNKNOW-N VM ID

Value: -2147482878

PRL ERR IPC ATTACH-FAILED

Value: -2147315696

PRL ERR IPC CREATE-MAP FAILED

Value: -2147315703

PRL ERR IPC FTOK F-AILED

Value: -2147315695

continued on next page

232

Page 233: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR IPFO INVALI-D MODE

Value: -2147315706

PRL ERR IPFO RECEI-VE FAILED

Value: -2147315704

PRL ERR IPFO SEND F-AILED

Value: -2147315705

PRL ERR IPFO SOCKE-T ACCEPT FAILED

Value: -2147315709

PRL ERR IPFO SOCKE-T BIND FAILED

Value: -2147315711

PRL ERR IPFO SOCKE-T CONNECT FAILED

Value: -2147315708

PRL ERR IPFO SOCKE-T CREATE FAILED

Value: -2147315712

PRL ERR IPFO SOCKE-T LISTEN FAILED

Value: -2147315710

PRL ERR IPFO SOCKE-T NOT OPENED

Value: -2147315707

PRL ERR IPHONE PRO-XY ALREADY STARTE-D

Value: -2147278846

PRL ERR IPHONE PRO-XY CANNOT START

Value: -2147278848

PRL ERR IPHONE PRO-XY CANNOT STOP

Value: -2147278847

PRL ERR LICENSE AU-TH FAILED

Value: -2147414009

PRL ERR LICENSE BE-TA KEY RELEASE PRO-DUCT

Value: -2147413999

PRL ERR LICENSE BL-ACKLISTED

Value: -2147413995

PRL ERR LICENSE EX-PIRED

Value: -2147414015

PRL ERR LICENSE FIL-E WRITE FAILED

Value: -2147414000

PRL ERR LICENSE NO-T STARTED

Value: -2147413996

PRL ERR LICENSE NO-T VALID

Value: -2147414016

PRL ERR LICENSE RE-LEASE KEY BETA PRO-DUCT

Value: -2147413997

continued on next page

233

Page 234: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR LICENSE TO-O MANY MEMORY

Value: -2147413994

PRL ERR LICENSE TO-O MANY VCPUS

Value: -2147413998

PRL ERR LICENSE UP-GRADE NO ACCEPTA-BLE LICENSE

Value: -2147414007

PRL ERR LICENSE UP-GRADE NO PERMANE-NT LICENSE

Value: -2147414007

PRL ERR LICENSE VA-LID

Value: 0

PRL ERR LICENSE VM-HAS VTD DEVICES

Value: -2147413993

PRL ERR LICENSE WR-ONG ADVANCED FIEL-D

Value: -2147414008

PRL ERR LICENSE WR-ONG DISTRIBUTOR

Value: -2147414010

PRL ERR LICENSE WR-ONG LANGUAGE

Value: -2147414011

PRL ERR LICENSE WR-ONG PLATFORM

Value: -2147414012

PRL ERR LICENSE WR-ONG PRODUCT

Value: -2147414013

PRL ERR LICENSE WR-ONG VERSION

Value: -2147414014

PRL ERR LOCAL AUT-HENTICATION FAILED

Value: -2147482831

PRL ERR LOGIN BY M-ISMATCH CLIENT MO-DE

Value: -2147482507

PRL ERR LPT DEVICE -ALREADY EXIST

Value: -2147483051

PRL ERR LPT OUTPU-T FILE IS NOT SPECIFI-ED

Value: -2147483114

PRL ERR LPT OUTPU-T FILE NOT EXIST

Value: -2147483112

PRL ERR MAC ADDRE-SS INCORRECT

Value: -2147482840

continued on next page

234

Page 235: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR MAC ADDRE-SS IN CORRECT LENG-TH

Value: -2147483119

PRL ERR MAC ADDRE-SS IS EMPTY

Value: -2147483120

PRL ERR MAC ADDRE-SS WITHIN CORRECT -SYMBOLS

Value: -2147483116

PRL ERR MAC ADDRE-SS WITH 2 ZERO STAR-T

Value: -2147483118

PRL ERR MAC ADDRE-SS WITH ALL ZEROS

Value: -2147483117

PRL ERR MAKE DIREC-TORY

Value: -2147483086

PRL ERR MEMORY AL-LOC ERROR

Value: -2147418093

PRL ERR NEED KILL P-REV SETTING

Value: 426

PRL ERR NETWORK A-DAPTER NOT FOUND

Value: -2147482491

PRL ERR NETWORK R-OLLBACK FAILED

Value: -2147483024

PRL ERR NOT ALL FIL-ES WAS DELETED

Value: -2147483390

PRL ERR NOT CONNE-CTED TO DISPATCHE-R

Value: -2147483055

PRL ERR NOT ENOUG-H DISK FREE SPACE

Value: -2147482873

PRL ERR NOT ENOUG-H DISK SPACE TO STA-RT VM

Value: -2147482538

PRL ERR NOT ENOUG-H DISK SPACE TO XM-L SAVE

Value: -2147482541

PRL ERR NOT ENOUG-H PERMS TO OPEN AU-THORIZATION FILE

Value: -2147482984

PRL ERR NOT LOCK O-WNER SESSION TRIES -TO UNLOCK

Value: -2147482504

continued on next page

235

Page 236: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR NOT SENTIL-LION CLIENT

Value: -2147250176

PRL ERR NO BOOTIN-G DEVICE SELECTED

Value: -2147482828

PRL ERR NO CD DRIV-E AVAILABLE

Value: -2147482600

PRL ERR NO DATA Value: -2147483628

PRL ERR NO DISP CO-NFIG FOUND

Value: -2147483623

PRL ERR NO MORE FR-EE INTERFACE SLOTS

Value: -2147482775

PRL ERR NO ONE HAR-D DISK TO COMPRESS

Value: 490

PRL ERR NO PROBLE-M REPORT FOUND

Value: -2147483515

PRL ERR NO TARGET -DIR PATH SPECIFIED

Value: -2147482617

PRL ERR NO TARGET -PATH SPECIFIED

Value: -2147483532

PRL ERR NO VM DIR -CONFIG FOUND

Value: -2147483610

PRL ERR NVRAM FILE-COPY

Value: -2147482570

PRL ERR OBJECT WA-S REMOVED

Value: -2147482618

PRL ERR ONLY ADMI-N CAN SET PARAMET-ER STARTLOGINMOD-E ROOT

Value: -2147482731

PRL ERR ONLY ADMI-N OR VM OWNER CAN-OPEN THIS SESSION

Value: -2147270656

PRL ERR OPEN DISP C-ONFIG READ

Value: -2147483615

PRL ERR OPEN DISP C-ONFIG WRITE

Value: -2147483614

PRL ERR OPEN PROB-LEM REPORT READ

Value: -2147483514

PRL ERR OPEN VM C-ONFIG READ

Value: -2147483597

PRL ERR OPEN VM C-ONFIG WRITE

Value: -2147483596

continued on next page

236

Page 237: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR OPEN VM DI-R CONFIG READ

Value: -2147483608

PRL ERR OPEN VM DI-R CONFIG WRITE

Value: -2147483607

PRL ERR OPERATION -FAILED

Value: -2147483626

PRL ERR OPERATION -PENDING

Value: -2147483629

PRL ERR OPERATION -WAS CANCELED

Value: -2147483019

PRL ERR OUT OF DIS-K SPACE

Value: -2147482985

PRL ERR OUT OF ME-MORY

Value: -2147483646

PRL ERR PARALLEL P-ORT IMAGE NOT EXIS-T

Value: -2147483497

PRL ERR PARALLEL P-ORT IMG COPY

Value: -2147483082

PRL ERR PARAM NOT-FOUND

Value: -2147483625

PRL ERR PARSE CLIE-NT PREFS

Value: -2147483369

PRL ERR PARSE COM-MON SERVER PREFS

Value: -2147483359

PRL ERR PARSE DISP -CONFIG

Value: -2147483613

PRL ERR PARSE FILES-YSTEM INFO

Value: -2147483534

PRL ERR PARSE HAR-D DISK HW INFO

Value: -2147483535

PRL ERR PARSE HOST-HW INFO

Value: -2147483536

PRL ERR PARSE PROB-LEM REPORT

Value: -2147483516

PRL ERR PARSE STAT-ISTICS

Value: -2147483018

PRL ERR PARSE USER-PROFILE

Value: -2147483533

PRL ERR PARSE VM C-ONFIG

Value: -2147483594

PRL ERR PARSE VM D-IR CONFIG

Value: -2147483600

continued on next page

237

Page 238: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR PARSING EV-ENT

Value: -2147483612

PRL ERR PLAYER CA-NT SUSPEND IN PAUS-E

Value: -2147482495

PRL ERR PREPARE FO-R HIBERNATE TASK A-LREADY RUN

Value: -2147482524

PRL ERR PREPARE FO-R HIBERNATE VM CA-NNOT STAND BY

Value: -2147482521

PRL ERR PREPARE FO-R HIBERNATE VM WI-THOUT TOOLS

Value: -2147482522

PRL ERR PREPARE FO-R HIBERNATE VM WR-ONG STATE

Value: -2147482523

PRL ERR PREV SESSIO-N IS ACTIVE

Value: -2147483548

PRL ERR PROBLEM R-EPORT ALREADY EXI-STS

Value: -2147483512

PRL ERR PROBLEM R-EPORT FILE NOTSET

Value: -2147483513

PRL ERR PROBLEM R-EPORT WRITE

Value: -2147483511

PRL ERR READONLY -FILESYSTEM

Value: -2147482794

PRL ERR READ XML C-ONTENT

Value: -2147483595

PRL ERR REBOOT HO-ST

Value: -2147482798

PRL ERR REMOTE DE-VICE EXIST

Value: -2147483015

PRL ERR REMOTE DE-VICE NOT EXIST

Value: -2147483008

PRL ERR REMOTE DE-VICE NOT REGISTERE-D

Value: -2147483016

PRL ERR REMOTE DIS-PLAY EMPTY PASSWO-RD

Value: -2147482489

continued on next page

238

Page 239: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR REMOTE DIS-PLAY HOST NOT SPEC-IFIED

Value: -2147482812

PRL ERR REMOTE DIS-PLAY WRONG PORT N-UMBER

Value: -2147482811

PRL ERR RETRIEVE V-M CONFIG

Value: -2147483072

PRL ERR RETURN CO-DE RANG EEND

Value: -2147483373

PRL ERR REVERT IMP-ERSONATE FAILED

Value: -2147482799

PRL ERR REVERT SNA-PSHOT VM VTD BY G-UEST SLEEP TIMEOUT

Value: -2147262447

PRL ERR REVERT SNA-PSHOT VM VTD PAUS-ED

Value: -2147262448

PRL ERR REVERT SNA-PSHOT VM VTD WITH-OUTDATED SHUTDO-WN TOOL

Value: -2147262444

PRL ERR REVERT SNA-PSHOT VM VTD WITH-UNLOADED SHUTDO-WN TOOL

Value: -2147262445

PRL ERR REVERT SNA-PSHOT VM VTD WITH-UNSUPPORTED CAPS

Value: -2147262425

PRL ERR REVERT SNA-PSHOT VM VTD WITH-UNSUPPORTED SHUT-DOWN TOOL

Value: -2147262446

PRL ERR SAFE MODE -START DURING SUSPE-NDING SYNC

Value: -2147352559

PRL ERR SAVE VM CA-TALOG

Value: -2147483504

PRL ERR SAVE VM CO-NFIG

Value: -2147483084

PRL ERR SEARCH CO-NFIG OPERATION CA-NCELED

Value: -2147483384

continued on next page

239

Page 240: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR SEND COMM-AND TOWS FAILED

Value: -2147483056

PRL ERR SERIAL IMG -COPY

Value: -2147483083

PRL ERR SERIAL IMG -NOT FOUND

Value: -2147483085

PRL ERR SERIAL POR-T IMAGE NOT EXIST

Value: -2147483498

PRL ERR SERVER GOE-S DOWN

Value: -2147483064

PRL ERR SERVER PRE-FS EDIT COLLISION

Value: -2147482842

PRL ERR SET LICENSE-INVALID ARG

Value: -2147483336

PRL ERR SET LICENSE-INVALID KEY

Value: -2147483335

PRL ERR SET NETWO-RK SETTINGS FAILED

Value: -2147270651

PRL ERR SHUT DOWN-NOT IFICATION SERV-ICE

Value: -2147483065

PRL ERR SMC ERROR Value: -2147483375

PRL ERR SNAPSHOTS -COPY

Value: -2147482569

PRL ERR SOME TASKS-PRESENT

Value: -2147482781

PRL ERR SOME VMS R-UNNING

Value: -2147482782

PRL ERR SOUND DEVI-CE WRITE FAILED

Value: -2147463168

PRL ERR SOUND IN D-EVICE OPEN FAILED

Value: -2147463166

PRL ERR SOUND OUT -DEVICE OPEN FAILED

Value: -2147463167

PRL ERR SSL HANDSH-AKE FAILED

Value: -2147482604

PRL ERR STAND BY V-M BY GUEST SLEEP TI-MEOUT

Value: -2147262439

PRL ERR STAND BY V-M PAUSED

Value: -2147262443

continued on next page

240

Page 241: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR STAND BY V-M WITH OUTDATED S-HUTDOWN TOOL

Value: -2147262441

PRL ERR STAND BY V-M WITH UNLOADED S-HUTDOWN TOOL

Value: -2147262442

PRL ERR STAND BY V-M WITH UNSUPPORTE-D SHUTDOWN TOOL

Value: -2147262440

PRL ERR STATE ALRE-ADY EXISTS

Value: -2147381227

PRL ERR STATE CANT-LOAD SPECIFIED CFG

Value: -2147381212

PRL ERR STATE CANT-OPEN FOR WRITE

Value: -2147381232

PRL ERR STATE CANT-OPEN IMAGE

Value: -2147381239

PRL ERR STATE CANT-OPEN LOCKED

Value: -2147381231

PRL ERR STATE CANT-SAVE LOCKED

Value: -2147381230

PRL ERR STATE DELE-TE NONCLOSED

Value: -2147381213

PRL ERR STATE ERRO-R CREATE IMAGE

Value: -2147381241

PRL ERR STATE ERRO-R RENAMING IMAGE

Value: -2147381240

PRL ERR STATE FULL-DELETE FAILED

Value: -2147381224

PRL ERR STATE GETF-REESPACE FAILED

Value: -2147381211

PRL ERR STATE INT C-ORRUPTED

Value: -2147381229

PRL ERR STATE INVA-LID IMAGE TYPE

Value: -2147381214

PRL ERR STATE INVA-LID PARAMETERS

Value: -2147381242

PRL ERR STATE MEM-ORY ERROR

Value: -2147381215

PRL ERR STATE MER-GE FAILED

Value: -2147381223

PRL ERR STATE MER-GE NO SPACE

Value: -2147381216

continued on next page

241

Page 242: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR STATE NOT -OPENED

Value: -2147381226

PRL ERR STATE NOT -PERMITTED

Value: -2147381225

PRL ERR STATE NOT -RELEASED

Value: -2147381209

PRL ERR STATE NO D-ISKS

Value: -2147381247

PRL ERR STATE NO S-TATE

Value: -2147381228

PRL ERR STATE PROC-ESS RUNNING

Value: -2147381246

PRL ERR STATE ROLL-BACK ERROR

Value: -2147381243

PRL ERR STATE ROLL-BACK IN PROGRESS

Value: -2147381244

PRL ERR STATE STAT-FS FAILED

Value: -2147381210

PRL ERR STATE STOP-PING STATE

Value: -2147381245

PRL ERR STATE UNEX-PECTED ERROR

Value: -2147381248

PRL ERR SUCCESS Value: 0

PRL ERR SUSPEND RE-JECTED BY GUEST

Value: -2147482496

PRL ERR SUSPEND V-M VTD BY GUEST SLE-EP TIMEOUT

Value: -2147262462

PRL ERR SUSPEND V-M VTD PAUSED

Value: -2147262464

PRL ERR SUSPEND V-M VTD WITH OUTDAT-ED SHUTDOWN TOOL

Value: -2147262457

PRL ERR SUSPEND V-M VTD WITH UNLOAD-ED SHUTDOWN TOOL

Value: -2147262458

PRL ERR SUSPEND V-M VTD WITH UNSUPP-ORTED CAPS

Value: -2147262427

continued on next page

242

Page 243: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR SUSPEND V-M VTD WITH UNSUPP-ORTED SHUTDOWN T-OOL

Value: -2147262463

PRL ERR SYMBOL NO-T FOUND

Value: -2147483630

PRL ERR TARGET NA-ME ALREADY OCCUPI-ED

Value: -2147483529

PRL ERR TARGET PA-TH IS NOT DIRECTOR-Y

Value: -2147483530

PRL ERR TASK NOT F-OUND

Value: -2147483502

PRL ERR TIMEOUT Value: -2147483627

PRL ERR TIS INVALID -UID

Value: -2147321856

PRL ERR TOOLS UNSU-PPORTED GUEST

Value: -2147482768

PRL ERR TOO LOW H-DD SIZE

Value: -2147483040

PRL ERR TRY AGAIN Value: -2147482544

PRL ERR UNABLE DR-OP SUSPENDED STAT-E

Value: -2147483389

PRL ERR UNABLE SEN-D REQUEST

Value: -2147483278

PRL ERR UNATTENDE-D UNSUPPORTED GUE-ST

Value: -2147221503

PRL ERR UNDER OLD -HYPERVISOR

Value: -2147483048

PRL ERR UNEXPECTE-D

Value: -2147483647

PRL ERR UNIMPLEME-NTED

Value: -2147483640

PRL ERR UNINITIALIZ-ED

Value: -2147483641

PRL ERR UNRECOGNI-ZED REQUEST

Value: -2147483503

PRL ERR UNSUPPORT-ED DEVICE TYPE

Value: -2147479550

continued on next page

243

Page 244: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR UNSUPPORT-ED FILE SYSTEM

Value: -2147482727

PRL ERR UNSUPPORT-ED NETWORK FILE SY-STEM

Value: -2147482727

PRL ERR UPDATE ME-M VM NOT CREATED

Value: -2147483279

PRL ERR UPD TOOLS -VER VM NOT CONFIG-URED

Value: -2147483276

PRL ERR UPD TOOLS -VER VM NOT CREATE-D

Value: -2147483277

PRL ERR UPD UPDAT-ER CONFIG

Value: -2147389440

PRL ERR UPD UPDAT-ES

Value: -2147389439

PRL ERR USER CANT -CHANGE ACCESS PRO-FILE

Value: -2147483367

PRL ERR USER CANT -CHANGE PROFILE AC-CESS PART

Value: -2147483047

PRL ERR USER CANT -CHANGE READ ONLY -VALUE

Value: -2147483360

PRL ERR USER DIREC-TORY NOT SET

Value: -2147483545

PRL ERR USER IS ALR-EADY LOGGED

Value: -2147483551

PRL ERR USER NOT F-OUND

Value: -2147482736

PRL ERR USER NO AU-TH TO CREATE ROOT-VM DIR

Value: -2147482520

PRL ERR USER NO AU-TH TO CREATE VM IN-DIR

Value: -2147482858

PRL ERR USER NO AU-TH TO EDIT SERVER S-ETTINGS

Value: -2147483049

PRL ERR USER NO AU-TH TO EDIT VM

Value: -2147482847

continued on next page

244

Page 245: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR USER NO AU-TH TO SAVE FILES

Value: -2147482861

PRL ERR USER OPERA-TION NOT AUTHORIS-ED

Value: -2147483559

PRL ERR USER PROFI-LE WAS CHANGED

Value: -2147483368

PRL ERR VA CONFIG Value: -2147385344

PRL ERR VMCONF AU-TOSTART FROM CUR-RENT USER FORBIDD-EN

Value: -2147323821

PRL ERR VMCONF BO-OTCAMP HARD DISK S-MART GUARD NOT AL-LOW

Value: -2147323882

PRL ERR VMCONF BO-OTCAMP HARD SNAPS-HOTS NOT ALLOW

Value: -2147323888

PRL ERR VMCONF BO-OTCAMP HARD UNDO-DISKS NOT ALLOW

Value: -2147323896

PRL ERR VMCONF BO-OTCAMP SAFE MODE -NOT ALLOW

Value: -2147323886

PRL ERR VMCONF BO-OT OPTION DEVICE N-OT EXISTS

Value: -2147323822

PRL ERR VMCONF BO-OT OPTION DUPLICA-TE DEVICE

Value: -2147323823

PRL ERR VMCONF BO-OT OPTION INVALID -DEVICE TYPE

Value: -2147323824

PRL ERR VMCONF CD-DVD ROM DUPLICAT-E SYS NAME

Value: -2147322879

PRL ERR VMCONF CD-DVD ROM IMAGE IS N-OT EXIST

Value: -2147322878

continued on next page

245

Page 246: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR VMCONF CD-DVD ROM SYS NAME -IS EMPTY

Value: -2147322880

PRL ERR VMCONF CD-DVD ROM URL FORM-AT SYS NAME

Value: -2147322877

PRL ERR VMCONF CP-U COUNT MORE HOST-CPU COUNT

Value: -2147323390

PRL ERR VMCONF CP-U COUNT MORE MAX -CPU COUNT

Value: -2147323391

PRL ERR VMCONF CP-U ZERO COUNT

Value: -2147323392

PRL ERR VMCONF DE-SKTOP MODE REMOT-E DEVICES

Value: -2147323898

PRL ERR VMCONF DU-PLICATE IP ADDRESS

Value: -2147322617

PRL ERR VMCONF FL-OPPY DISK IMAGE IS -NOT EXIST

Value: -2147323055

PRL ERR VMCONF FL-OPPY DISK IMAGE IS -NOT VALID

Value: -2147323053

PRL ERR VMCONF FL-OPPY DISK IS NOT AC-CESSIBLE

Value: -2147323054

PRL ERR VMCONF FL-OPPY DISK SYS NAME-HAS INVALID SYMBO-L

Value: -2147323052

PRL ERR VMCONF FL-OPPY DISK SYS NAME-IS EMPTY

Value: -2147323056

PRL ERR VMCONF FL-OPPY DISK URL FORM-AT SYS NAME

Value: -2147323051

PRL ERR VMCONF GE-NERIC PCI DEVICE CA-NNOT BE ADDED

Value: -2147322016

continued on next page

246

Page 247: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR VMCONF GE-NERIC PCI DEVICE DU-PLICATE IN ANOTHER-VM

Value: -2147322012

PRL ERR VMCONF GE-NERIC PCI DEVICE NO-T CONNECTED

Value: -2147322014

PRL ERR VMCONF GE-NERIC PCI DEVICE NO-T FOUND

Value: -2147322015

PRL ERR VMCONF GE-NERIC PCI DUPLICAT-E SYS NAME

Value: -2147322010

PRL ERR VMCONF GE-NERIC PCI VIDEO DEV-ICE IS ONE

Value: -2147322013

PRL ERR VMCONF GE-NERIC PCI VIDEO NO-T SINGLE

Value: -2147322009

PRL ERR VMCONF GE-NERIC PCI WRONG DE-VICE

Value: -2147322011

PRL ERR VMCONF HA-RD DISK DUPLICATE S-YS NAME

Value: -2147322797

PRL ERR VMCONF HA-RD DISK IMAGE IS NO-T EXIST

Value: -2147322799

PRL ERR VMCONF HA-RD DISK IMAGE IS NO-T VALID

Value: -2147322798

PRL ERR VMCONF HA-RD DISK SYS NAME H-AS INVALID SYMBOL

Value: -2147322796

PRL ERR VMCONF HA-RD DISK SYS NAME IS -EMPTY

Value: -2147322800

PRL ERR VMCONF HA-RD DISK URL FORMA-T SYS NAME

Value: -2147322795

PRL ERR VMCONF IDE-DEVICES COUNT OUT-OF RANGE

Value: -2147322112

continued on next page

247

Page 248: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR VMCONF IDE-DEVICES DUPLICATE -STACK INDEX

Value: -2147322111

PRL ERR VMCONF IN-COMPAT HARD DISK S-MART GUARD NOT AL-LOW

Value: -2147323881

PRL ERR VMCONF IN-COMPAT HARD UNDO-DISKS NOT ALLOW

Value: -2147323895

PRL ERR VMCONF IN-COMPAT SAFE MODE -NOT ALLOW

Value: -2147323885

PRL ERR VMCONF IN-VALID DEVICE MAIN I-NDEX

Value: -2147323899

PRL ERR VMCONF MA-IN MEMORY NOT 4 RA-TIO SIZE

Value: -2147323310

PRL ERR VMCONF MA-IN MEMORY OUT OF -RANGE

Value: -2147323311

PRL ERR VMCONF MA-IN MEMORY SIZE NOT-EAQUAL RECOMMEN-DED

Value: 27253

PRL ERR VMCONF MA-IN MEMORY ZERO SIZ-E

Value: -2147323312

PRL ERR VMCONF NE-TWORK ADAPTER DU-PLICATE IP ADDRESS

Value: -2147322621

PRL ERR VMCONF NE-TWORK ADAPTER DU-PLICATE MAC ADDRE-SS

Value: -2147322622

PRL ERR VMCONF NE-TWORK ADAPTER ET-HLIST CREATE ERRO-R

Value: -2147322620

continued on next page

248

Page 249: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR VMCONF NE-TWORK ADAPTER GU-EST TOOLS NOT AVAI-LABLE

Value: -2147322618

PRL ERR VMCONF NE-TWORK ADAPTER IN-VALID BOUND INDEX

Value: -2147322624

PRL ERR VMCONF NE-TWORK ADAPTER IN-VALID IP ADDRESS

Value: -2147322619

PRL ERR VMCONF NE-TWORK ADAPTER IN-VALID MAC ADDRESS

Value: -2147322623

PRL ERR VMCONF NO-AUTO COMPRESS WI-TH SMART GUARD

Value: -2147323872

PRL ERR VMCONF NO-AUTO COMPRESS WI-TH UNDO DISKS

Value: -2147323879

PRL ERR VMCONF NO-HD IMAGES IN SAFE -MODE

Value: -2147323883

PRL ERR VMCONF NO-HD IMAGES IN UNDO -DISKS MODE

Value: -2147323884

PRL ERR VMCONF NO-IP ADDRESSES SPECI-FIED FOR OFFLINE M-ANAGEMENT

Value: -2147322000

PRL ERR VMCONF PA-RALLEL PORT IMAGE -IS NOT EXIST

Value: -2147322287

PRL ERR VMCONF PA-RALLEL PORT SYS NA-ME HAS INVALID SYM-BOL

Value: -2147322286

PRL ERR VMCONF PA-RALLEL PORT SYS NA-ME IS EMPTY

Value: -2147322288

PRL ERR VMCONF PA-RALLEL PORT URL FO-RMAT SYS NAME

Value: -2147322285

continued on next page

249

Page 250: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR VMCONF RE-AL HARD SAFE MODE -NOT ALLOW

Value: -2147323887

PRL ERR VMCONF RE-AL HARD UNDO DISKS-NOT ALLOW

Value: -2147323897

PRL ERR VMCONF RE-MOTE DISPLAY HOST -IP ADDRESS IS ZERO

Value: -2147323647

PRL ERR VMCONF RE-MOTE DISPLAY INVAL-ID HOST IP ADDRESS

Value: -2147323646

PRL ERR VMCONF RE-MOTE DISPLAY PORT -NUMBER IS ZERO

Value: -2147323648

PRL ERR VMCONF SC-SI DEVICES COUNT O-UT OF RANGE

Value: -2147322032

PRL ERR VMCONF SC-SI DEVICES DUPLICAT-E STACK INDEX

Value: -2147322031

PRL ERR VMCONF SE-RIAL PORT IMAGE IS -NOT EXIST

Value: -2147322367

PRL ERR VMCONF SE-RIAL PORT SYS NAME-HAS INVALID SYMBO-L

Value: -2147322366

PRL ERR VMCONF SE-RIAL PORT SYS NAME-IS EMPTY

Value: -2147322368

PRL ERR VMCONF SE-RIAL PORT URL FORM-AT SYS NAME

Value: -2147322365

PRL ERR VMCONF SH-ARED FOLDERS DUPLI-CATE FOLDER NAME

Value: -2147323567

PRL ERR VMCONF SH-ARED FOLDERS DUPLI-CATE FOLDER PATH

Value: -2147323565

PRL ERR VMCONF SH-ARED FOLDERS EMPT-Y FOLDER NAME

Value: -2147323568

continued on next page

250

Page 251: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR VMCONF SH-ARED FOLDERS INVA-LID FOLDER PATH

Value: -2147323566

PRL ERR VMCONF SO-UND MIXER IS EMPTY

Value: -2147322544

PRL ERR VMCONF SO-UND OUTPUT IS EMPT-Y

Value: -2147322543

PRL ERR VMCONF UN-KNOWN OS TYPE

Value: -2147323902

PRL ERR VMCONF UN-KNOWN OS VERSION

Value: -2147323901

PRL ERR VMCONF VA-LIDATION FAILED

Value: -2147323904

PRL ERR VMCONF VI-DEO MEMORY OUT O-F RANGE

Value: -2147323136

PRL ERR VMCONF VI-DEO NOT ENABLED

Value: -2147323880

PRL ERR VMCONF VM-NAME HAS INVALID S-YMBOL

Value: -2147323900

PRL ERR VMCONF VM-NAME IS EMPTY

Value: -2147323903

PRL ERR VMDIR INVA-LID PATH

Value: -2147483003

PRL ERR VMDIR PAT-H IS NOT ABSOLUTE

Value: -2147483002

PRL ERR VM ABORT Value: -2147482843

PRL ERR VM ALLOC -MEM DRV NOT START-ED

Value: -2147483260

PRL ERR VM ALLOC V-M MEMORY

Value: -2147483259

PRL ERR VM ALREAD-Y CONNECTED

Value: -2147482735

PRL ERR VM ALREAD-Y CREATED

Value: -2147483356

PRL ERR VM ALREAD-Y REGISTERED

Value: -2147482553

continued on next page

251

Page 252: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR VM ALREAD-Y REGISTERED UNIQU-E PARAMS

Value: -2147483372

PRL ERR VM ALREAD-Y REGISTERED VM N-AME

Value: -2147483371

PRL ERR VM ALREAD-Y REGISTERED VM PA-TH

Value: -2147483549

PRL ERR VM ALREAD-Y REGISTERED VM U-UID

Value: -2147483550

PRL ERR VM ALREAD-Y RESUMED

Value: -2147483566

PRL ERR VM ALREAD-Y RUNNING

Value: -2147482622

PRL ERR VM ALREAD-Y SUSPENDED

Value: -2147483568

PRL ERR VM ANOTHE-R TOOLS IN USE

Value: -2147482587

PRL ERR VM APPLY C-HANGES PENDING

Value: -2147482778

PRL ERR VM APPLY C-ONFIG FAILED

Value: -2147482992

PRL ERR VM APPLY C-ONFIG NEEDS REBOO-T

Value: -2147482991

PRL ERR VM ASYNC C-D CONSTRUCTOR

Value: -2147483264

PRL ERR VM BAD OS -TYPE

Value: -2147483134

PRL ERR VM CANT CL-ONE HDD MISSING

Value: -2147482848

PRL ERR VM CANT CL-ONE RUNNING

Value: -2147482990

PRL ERR VM CANT D-ELETE RUNNING

Value: -2147482989

PRL ERR VM CANT U-NREG RUNNING

Value: -2147482988

PRL ERR VM COMPAC-T PROCESSING

Value: -2147319808

PRL ERR VM CONFIG -ALREADY EXISTS

Value: -2147483593

continued on next page

252

Page 253: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR VM CONFIG -CAN BE RESTORED

Value: -2147482540

PRL ERR VM CONFIG -DOESNT EXIST

Value: -2147483005

PRL ERR VM CONFIG -INVALID SERVER UUI-D

Value: -2147482763

PRL ERR VM CONFIG -INVALID VM UUID

Value: -2147482764

PRL ERR VM CONFIG -IS ALREADY VALID

Value: -2147482539

PRL ERR VM CONFIG -WAS CHANGED

Value: -2147483374

PRL ERR VM CONF C-HANGED INVALID AR-G

Value: -2147483340

PRL ERR VM CONF C-HANGED NOT CREAT-ED

Value: -2147483341

PRL ERR VM CONF C-HANGED NOT STARTE-D

Value: -2147483339

PRL ERR VM CONF C-HANGED UNSUPPORT-ED DEV

Value: -2147483338

PRL ERR VM COULDN-T BE STARTED UNDE-R SPECIFIED USER

Value: -2147482728

PRL ERR VM CREATE -HDD IMG INVALID AR-G

Value: -2147483289

PRL ERR VM CREATE -HDD IMG INVALID CR-EATE

Value: -2147483288

PRL ERR VM CREATE -INVALID ARG

Value: -2147483357

PRL ERR VM CREATE -SNAPSHOT FAILED

Value: -2147483565

PRL ERR VM DELETE -STATE FAILED

Value: -2147482585

continued on next page

253

Page 254: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR VM DEVICES-INITIALIZATION FAIL-ED

Value: -2147483021

PRL ERR VM DEVICES-TERMINATION FAILE-D

Value: -2147483020

PRL ERR VM DEV CH-ANGE MEDIA FAILED

Value: -2147483561

PRL ERR VM DEV CO-NNECT FAILED

Value: -2147483563

PRL ERR VM DEV DIS-CONNECT FAILED

Value: -2147483562

PRL ERR VM DIRECT-ORY FOLDER DOESNT-EXIST

Value: -2147482551

PRL ERR VM DIRECT-ORY NOT EXIST

Value: -2147482841

PRL ERR VM DIRECT-ORY NOT INITIALIZED

Value: -2147483547

PRL ERR VM DIR CON-FIG ALREADY EXISTS

Value: -2147483599

PRL ERR VM DIR FILE-NOT SET

Value: -2147483591

PRL ERR VM DOES NO-T STOPPED

Value: -2147483071

PRL ERR VM DVD DIS-CONNECT FAILED LO-CKED

Value: -2147482572

PRL ERR VM EDIT UN-ABLE CHANGE IP ADD-RESS

Value: -2147482537

PRL ERR VM EDIT UN-ABLE SWITCH OFF UN-DO DISKS MODE

Value: -2147482543

PRL ERR VM EDIT UN-ABLE SWITCH ON UN-DO DISKS MODE

Value: -2147482571

PRL ERR VM EMPTY -NAME OF CLONE

Value: -2147483087

PRL ERR VM EXEC G-UEST TOOL NOT AVAI-LABLE

Value: -2147270655

continued on next page

254

Page 255: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR VM EXEC PR-OGRAM NOT FOUND

Value: -2147270653

PRL ERR VM FILES AL-READY REMOVED

Value: -2147482875

PRL ERR VM FREE V-M MEMORY

Value: -2147483258

PRL ERR VM GET CO-NFIG FAILED

Value: -2147483575

PRL ERR VM GET CO-NFIG INVALID ARG

Value: -2147483344

PRL ERR VM GET CO-NFIG NOT CONFIGUR-ED

Value: -2147483343

PRL ERR VM GET DE-VICE STATE FAILED

Value: -2147483560

PRL ERR VM GET HD-D IMG INVALID ARG

Value: -2147483287

PRL ERR VM GET HD-D IMG NOT OPEN

Value: -2147483280

PRL ERR VM GET IND-ICATORS INVALID AR-G

Value: -2147483291

PRL ERR VM GET IND-ICATORS NOT CREAT-ED

Value: -2147483292

PRL ERR VM GET IND-ICATORS NOT RUNNI-NG

Value: -2147483290

PRL ERR VM GET PR-OBLEM REPORT FAIL-ED

Value: -2147483576

PRL ERR VM GET SCR-SIZE NOT CREATED

Value: -2147483320

PRL ERR VM GET SCR-UPDATED NOT CREA-TED

Value: -2147483319

PRL ERR VM GET SCR-UPDATED NOT RUNN-ING

Value: -2147483312

PRL ERR VM GET STA-TUS FAILED

Value: -2147483577

PRL ERR VM GET STA-TUS INVALID ARG

Value: -2147483354

continued on next page

255

Page 256: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR VM GUESTM-EM FAIL

Value: -2147482734

PRL ERR VM GUEST S-ESSION EXPIRED

Value: -2147270654

PRL ERR VM HDD SIZ-E

Value: -2147483273

PRL ERR VM HOME P-ATH IS NOT EMPTY

Value: -2147483096

PRL ERR VM HYPERVI-ZOR COMM

Value: -2147483240

PRL ERR VM INIT MO-NITOR

Value: -2147483248

PRL ERR VM INIT VCP-U

Value: -2147483247

PRL ERR VM INTERAC-T PRLS DRIVER

Value: -2147483257

PRL ERR VM INTERN-AL OS ERROR

Value: -2147483031

PRL ERR VM INVALID -SWAP REGION

Value: -2147482760

PRL ERR VM IN HDD -CONSTRUCTOR

Value: -2147483272

PRL ERR VM IS EXCL-USIVELY LOCKED

Value: -2147482506

PRL ERR VM IS NOT L-OCKED

Value: -2147482505

PRL ERR VM IS NOT S-USPENDED

Value: -2147482592

PRL ERR VM LOAD BI-NARY FAILED

Value: -2147482621

PRL ERR VM LOAD M-ONITOR

Value: -2147483243

PRL ERR VM LOCKED -CTL FOR BACKUP

Value: -2147253995

PRL ERR VM LOCKED -FOR BACKUP

Value: -2147253997

PRL ERR VM LOCKED -FOR CLONE

Value: -2147254016

PRL ERR VM LOCKED -FOR CREATE SNAPSH-OT

Value: -2147254000

continued on next page

256

Page 257: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR VM LOCKED -FOR DELETE

Value: -2147254015

PRL ERR VM LOCKED -FOR DELETE TO SNAP-SHOT

Value: -2147253998

PRL ERR VM LOCKED -FOR DISK RESIZE

Value: -2147253994

PRL ERR VM LOCKED -FOR EDIT COMMIT

Value: -2147254013

PRL ERR VM LOCKED -FOR EDIT COMMIT WI-TH RENAME

Value: -2147254009

PRL ERR VM LOCKED -FOR EXECUTE

Value: -2147254012

PRL ERR VM LOCKED -FOR EXECUTE EX

Value: -2147254011

PRL ERR VM LOCKED -FOR INTERNAL REAS-ON

Value: -2147254010

PRL ERR VM LOCKED -FOR MIGRATE

Value: -2147254007

PRL ERR VM LOCKED -FOR RESTORE FROM -BACKUP

Value: -2147253996

PRL ERR VM LOCKED -FOR SWITCH TO SNAP-SHOT

Value: -2147253999

PRL ERR VM LOCKED -FOR UNREGISTER

Value: -2147254014

PRL ERR VM LOCKED -FOR UPDATE SECURI-TY

Value: -2147254008

PRL ERR VM MAP VM-MEM0

Value: -2147483255

PRL ERR VM MEMOR-Y SWAPPING IN PROG-RESS

Value: -2147352567

PRL ERR VM MIGRAT-E CHECKING PRECON-DITIONS FAILED

Value: -2147282944

continued on next page

257

Page 258: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR VM MIGRAT-E COULDNT DETACH -TARGET CONNECTIO-N

Value: -2147282922

PRL ERR VM MIGRAT-E FLOPPY DISK IS AB-SENT ON TARGET

Value: -2147282937

PRL ERR VM MIGRAT-E NETWORK ADAPTE-R IS ABSENT ON TAR-GET

Value: -2147282927

PRL ERR VM MIGRAT-E NETWORK SHARE IS-ABSENT ON TARGET

Value: -2147282938

PRL ERR VM MIGRAT-E NON COMPATIBLE -CPU ON TARGET

Value: -2147282939

PRL ERR VM MIGRAT-E NOT ENOUGH CPUS -ON TARGET

Value: -2147282940

PRL ERR VM MIGRAT-E NOT ENOUGH DISK -SPACE ON SOURCE

Value: -2147282943

PRL ERR VM MIGRAT-E NOT ENOUGH DISK -SPACE ON TARGET

Value: -2147282923

PRL ERR VM MIGRAT-E OPTICAL DISK IS AB-SENT ON TARGET

Value: -2147282936

PRL ERR VM MIGRAT-E OUT OF MEMORY O-N TARGET

Value: -2147282942

PRL ERR VM MIGRAT-E PARALLEL PORT IS -ABSENT ON TARGET

Value: -2147282928

PRL ERR VM MIGRAT-E REMOTE DEVICE IS -ATTACHED

Value: -2147282905

PRL ERR VM MIGRAT-E SERIAL PORT IS AB-SENT ON TARGET

Value: -2147282935

continued on next page

258

Page 259: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR VM MIGRAT-E SOUND DEVICE IS A-BSENT ON TARGET

Value: -2147282925

PRL ERR VM MIGRAT-E TARGET VM HOME -PATH NOT EXISTS

Value: -2147282941

PRL ERR VM MIGRAT-E UNSUITABLE VM ST-ATE

Value: -2147282921

PRL ERR VM MIGRAT-E USB CONTROLLER I-S ABSENT ON TARGE-T

Value: -2147282926

PRL ERR VM MIGRAT-E VM ALREADY EXIST-S ON TARGET

Value: -2147282924

PRL ERR VM MIGRAT-E VM HOME ALREADY-EXISTS ON TARGET

Value: -2147282906

PRL ERR VM MIGRAT-E VM UUID ALREADY -EXISTS ON TARGET

Value: -2147282907

PRL ERR VM MONITO-R

Value: -2147483136

PRL ERR VM MUST BE-STOPPED BEFORE RE-NAMING

Value: -2147482762

PRL ERR VM MUST BE-STOPPED FOR CHAN-GE DEVICES

Value: -2147482748

PRL ERR VM NAME IS-EMPTY

Value: -2147483370

PRL ERR VM NOT CR-EATED

Value: -2147483355

PRL ERR VM OPERATI-ON FAILED

Value: -2147483543

PRL ERR VM PAUSE A-LREADY PAUSED

Value: -2147483321

PRL ERR VM PAUSE F-AILED

Value: -2147483567

PRL ERR VM PAUSE N-OT CREATED

Value: -2147483323

continued on next page

259

Page 260: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR VM PAUSE N-OT STARTED

Value: -2147483322

PRL ERR VM POWER -OFF FAILED

Value: -2147483579

PRL ERR VM POWER -ON FAILED

Value: -2147483580

PRL ERR VM PRLS DE-SCTOP ALLOC PHYS -MEM

Value: -2147483239

PRL ERR VM PROCESS-IS NOT STARTED

Value: -2147483544

PRL ERR VM REQUES-T NOT SUPPORTED

Value: -2147483135

PRL ERR VM RESET F-AILED

Value: -2147483578

PRL ERR VM RESTAR-T GUEST FAILED

Value: -2147482568

PRL ERR VM RESTAR-T NOT CREATED

Value: -2147483325

PRL ERR VM RESTAR-T NOT STARTED

Value: -2147483324

PRL ERR VM RESTOR-E STATE FAILED

Value: -2147483564

PRL ERR VM RESUME -FAILED

Value: -2147352570

PRL ERR VM RESUME -INV SAV VERSION CA-NCEL RESUME

Value: 20007

PRL ERR VM SAVE ST-ATE FAILED

Value: -2147483565

PRL ERR VM SEND AB-S MOUSE NOT CREAT-ED

Value: -2147483304

PRL ERR VM SEND AB-S MOUSE NOT RUNNIN-G

Value: -2147483303

PRL ERR VM SEND AB-S MOUSE PAUSED

Value: -2147483296

PRL ERR VM SEND KE-YBOARD NOT CREAT-ED

Value: -2147483295

continued on next page

260

Page 261: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR VM SEND KE-YBOARD NOT RUNNIN-G

Value: -2147483294

PRL ERR VM SEND KE-YBOARD PAUSED

Value: -2147483293

PRL ERR VM SEND RE-L MOUSE NOT CREAT-ED

Value: -2147483307

PRL ERR VM SEND RE-L MOUSE NOT RUNNI-NG

Value: -2147483306

PRL ERR VM SEND RE-L MOUSE PAUSED

Value: -2147483305

PRL ERR VM SET CON-FIG FAILED

Value: -2147483581

PRL ERR VM SET CON-FIG INVALID ARG

Value: -2147483342

PRL ERR VM SET LICE-NSE FAILED

Value: -2147483582

PRL ERR VM SET VISI-BLE NOT CREATED

Value: -2147483311

PRL ERR VM SHUTDO-WN FAILED

Value: -2147262432

PRL ERR VM SHUTDO-WN HIBERNATE FAIL-ED

Value: -2147262428

PRL ERR VM SHUTDO-WN HIBERNATE NOT -SUPPORTED

Value: -2147262430

PRL ERR VM SHUTDO-WN MACHINE LOCKE-D

Value: -2147262431

PRL ERR VM SHUTDO-WN SUSPEND NOT SU-PPORTED

Value: -2147262429

PRL ERR VM SNAPSH-OTS CONFIG NOT FOU-ND

Value: -2147482509

PRL ERR VM SNAPSH-OT CHANGED VM CO-NFIG

Value: -2147482584

PRL ERR VM SNAPSH-OT IN SAFE MODE

Value: -2147482560

continued on next page

261

Page 262: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR VM SNAPSH-OT IN UNDO DISKS M-ODE

Value: -2147482583

PRL ERR VM SNAPSH-OT NOT FOUND

Value: -2147482510

PRL ERR VM SPECIFY-GUEST INSTALL FILE-S

Value: -2147482983

PRL ERR VM START F-AILED

Value: -2147483583

PRL ERR VM START N-OT CONFIGURED

Value: -2147483327

PRL ERR VM START N-OT CREATED

Value: -2147483328

PRL ERR VM STOP NO-T CREATED

Value: -2147483326

PRL ERR VM SUSPEN-D CHANGED VM CONF-IG

Value: -2147352568

PRL ERR VM SUSPEN-D FAILED

Value: -2147352571

PRL ERR VM TOOLS C-ANT PARSE UPDATE -PARAMETERS

Value: -2147274752

PRL ERR VM TOOLS C-ANT UPDATE WITHO-UT RESTART

Value: -2147274751

PRL ERR VM TO REGI-STER IS NOT SPECIFIE-D

Value: -2147482825

PRL ERR VM UNABLE -ALLOC MEM

Value: -2147483256

PRL ERR VM UNABLE -ALLOC MEM MONITO-R

Value: -2147483242

PRL ERR VM UNABLE -CREATE TIMER

Value: -2147483241

PRL ERR VM UNABLE -GET GUEST CPU

Value: -2147483246

PRL ERR VM UNABLE -OPEN DISK IMAGE

Value: -2147483263

continued on next page

262

Page 263: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR VM UNABLE -SEND REQUEST

Value: -2147483261

PRL ERR VM UNABLE -TO OPEN VIRTUAL BR-IDGE

Value: -2147483271

PRL ERR VM UNDEFIN-ED API CALL

Value: -2147483262

PRL ERR VM UPDATE -SNAPSHOT DATA FAIL-ED

Value: -2147482574

PRL ERR VM USER AU-THENTICATION FAILE-D

Value: -2147482730

PRL ERR VM UUID EM-PTY

Value: -2147483088

PRL ERR VM UUID NO-T FOUND

Value: -2147483387

PRL ERR VM VALLOC -MON BODY

Value: -2147483245

PRL ERR VM VALLOC -PE IMG

Value: -2147483244

PRL ERR VM VIEW SC-R INVALID ARG

Value: -2147483309

PRL ERR VM VIEW SC-R NOT CREATED

Value: -2147483310

PRL ERR VM VIEW SC-R NOT RUNNING

Value: -2147483308

PRL ERR VNC SERVER-ALREADY STARTED

Value: -2147266560

PRL ERR VNC SERVER-AUTOSET PORT FAIL-ED

Value: -2147266558

PRL ERR VNC SERVER-DISABLED

Value: -2147266559

PRL ERR VNC SERVER-NOT STARTED

Value: -2147266555

PRL ERR VTD ALREA-DY HOOKED FAILED

Value: -2147418109

PRL ERR VTD DEVICE-DOES NOT EXIST

Value: -2147482528

PRL ERR VTD DEVICE-NOT MAPPED

Value: -2147409920

continued on next page

263

Page 264: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR VTD HOOK -AFTER INSTALL NEED-REBOOT

Value: -2147418105

PRL ERR VTD HOOK -AFTER REVERT NEED-REBOOT

Value: -2147418104

PRL ERR VTD HOOK -DEVICE CURRENTLY I-N USE

Value: -2147418094

PRL ERR VTD HOOK F-AILED

Value: -2147418108

PRL ERR VTD HOOK I-NSTALLATION FAILED

Value: -2147418103

PRL ERR VTD HOOK I-NVALID CONFIG

Value: -2147418095

PRL ERR VTD HOOK -NEED REBOOT FAILE-D

Value: -2147418107

PRL ERR VTD HOOK -REVERT FAILED

Value: -2147418096

PRL ERR VTD INITIAL-IZATION FAILED

Value: -2147418110

PRL ERR VTD WAIT A-SR

Value: -2147418106

PRL ERR VTX ENABL-ED ONLY IN SMX

Value: -2147482814

PRL ERR VZLICENSE -ACTIVATION KEY

Value: -2147413961

PRL ERR VZLICENSE -CANCEL

Value: -2147413991

PRL ERR VZLICENSE -EACCES

Value: -2147413976

PRL ERR VZLICENSE -ERR KA

Value: -2147413978

PRL ERR VZLICENSE -EXIST

Value: -2147413967

PRL ERR VZLICENSE F-ATAL

Value: -2147413963

PRL ERR VZLICENSE I-NVAL

Value: -2147413965

PRL ERR VZLICENSE I-NVALID HWID

Value: -2147413962

continued on next page

264

Page 265: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR VZLICENSE I-O

Value: -2147413966

PRL ERR VZLICENSE L-OCK

Value: -2147413977

PRL ERR VZLICENSE -NETWORK

Value: -2147413982

PRL ERR VZLICENSE -NODATA

Value: -2147413979

PRL ERR VZLICENSE -NOENT

Value: -2147413975

PRL ERR VZLICENSE -NOINIT

Value: -2147413968

PRL ERR VZLICENSE -NOMEM

Value: -2147413964

PRL ERR VZLICENSE -NOTSUP

Value: -2147413981

PRL ERR VZLICENSE -PROXY

Value: -2147413983

PRL ERR VZLICENSE -PROXY AUTH

Value: -2147413984

PRL ERR VZLICENSE -TASK ALREADY RUN

Value: -2147413952

PRL ERR VZLICENSE -TIMEOUT

Value: -2147413992

PRL ERR VZLICENSE -UNSUPPORTED MODE

Value: -2147413959

PRL ERR VZLICENSE -VMS LIMIT EXCEEDED

Value: -2147413960

PRL ERR VZLICENSE -WRONG

Value: -2147413980

PRL ERR WINDOWS E-XPRESS INSTALL USE-R NAME EMPTY

Value: -2147482856

PRL ERR WIN AERO D-ISABLED

Value: -2147418090

PRL ERR WRONG CON-NECTION SECURITY L-EVEL

Value: -2147483017

PRL ERR WRONG PRO-TOCOL VERSION

Value: -2147482605

PRL ERR WRONG VM -STATE

Value: -2147482487

continued on next page

265

Page 266: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL ERR WS DISP CO-NNECTION CLOSED

Value: -2147483066

PRL ERR X64GUEST O-N X32HOST

Value: -2147482796

PRL ERR X64GUEST O-N X64VM HVT DISABL-ED

Value: -2147482793

PRL ERR XML WRITE -FILE

Value: -2147482588

PRL INFO VM MIGRAT-E STORAGE IS SHARE-D

Value: 31028

PRL NET ADAPTER A-LREADY USED

Value: -2147467225

PRL NET ADAPTER N-OT EXIST

Value: -2147467260

PRL NET BIND FAILE-D

Value: -2147467255

PRL NET CABLE DISC-ONNECTED

Value: -2147467248

PRL NET CONNECTIO-N SHARING CONFLICT

Value: -2147467243

PRL NET DUPLICATE -VIRTUAL NETWORK I-D

Value: -2147467228

PRL NET ERR ADAPT-ER CONFIG

Value: -2147467259

PRL NET ERR ETH NO-BINDABLE ADAPTER

Value: -2147467258

PRL NET ERR PRL NO-BINDABLE ADAPTER

Value: -2147467257

PRL NET ETHLIST CR-EATE ERROR

Value: -2147467264

PRL NET INSTALL FAI-LED

Value: -2147467245

PRL NET INSTALL TIM-EOUT

Value: -2147467246

PRL NET IPADDRESS -MODIFY FAILED WAR-NING

Value: 4022

PRL NET PKTFILTER -ERROR

Value: -2147467229

continued on next page

266

Page 267: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL NET PRLNET OPE-N FAILED

Value: -2147467256

PRL NET RENAME FAI-LED

Value: -2147467247

PRL NET RESTORE DE-FAULTS PARTITIAL S-UCCESS

Value: -2147467242

PRL NET SRV NOTIFY-ERROR

Value: -2147467261

PRL NET SYSTEM ERR-OR

Value: -2147467263

PRL NET UNINSTALL -FAILED

Value: -2147467244

PRL NET VIRTUAL NE-TWORK ID NOT EXIST-S

Value: -2147467227

PRL NET VIRTUAL NE-TWORK NOT FOUND

Value: -2147467226

PRL NET VLAN UNSUP-PORTED IN THIS VERS-ION

Value: -2147467241

PRL NET VMDEVICE V-IRTUAL NETWORK CO-NFIG ERROR

Value: -2147467232

PRL NET VMDEVICE V-IRTUAL NETWORK DI-SABLED

Value: -2147467231

PRL NET VMDEVICE V-IRTUAL NETWORK N-OT EXIST

Value: -2147467240

PRL NET VMDEVICE V-IRTUAL NETWORK N-O ADAPTER

Value: -2147467239

PRL NET WINSCM OP-EN ERROR

Value: -2147467262

PRL QUEST CDD IMA-GE NOT EXIST

Value: -2147483104

PRL QUEST CD DRIVE-NOT EXIST

Value: -2147483103

PRL QUEST EXCEED R-ECOMMENDED MEMO-RY

Value: -2147483111

continued on next page

267

Page 268: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL QUEST FDD DRIV-E NOT EXIST

Value: -2147483099

PRL QUEST FDD IMAG-E NOT EXIST

Value: -2147483100

PRL QUEST HDD IMA-GE NOT EXIST

Value: -2147483101

PRL QUEST HDD SAM-E IMAGE

Value: -2147483102

PRL QUEST POWER O-FF

Value: -2147482863

PRL QUEST RESET Value: -2147482862

PRL QUEST RESTART Value: 15076

PRL WARN BACKUP G-UEST SYNCHRONIZAT-ION FAILED

Value: 37020

PRL WARN BACKUP H-AS NOT FULL BACKU-P

Value: 37017

PRL WARN CANT CON-NECT VOLUME

Value: -2147482536

PRL WARN COMPACT-DESTRUCTIVE

Value: -2147319806

PRL WARN COMPACT-THROUGH COPY

Value: -2147319807

PRL WARN DEV USB -CONNECT FAILED

Value: -2147482511

PRL WARN DEV USB -OPEN FAILED

Value: -2147482508

PRL WARN FAILED T-O START VNC SERVE-R

Value: 35006

PRL WARN FAT32 FIL-E OVERRUN

Value: -2147483033

PRL WARN GOING TO-TAKE SMART GUARD-SNAPSHOT

Value: -2147482554

PRL WARN HDD ERRO-R

Value: -2147483032

PRL WARN IMAGE IS -STOLEN

Value: -2147483036

PRL WARN LAN NOT -CONNECTED

Value: -2147483039

continued on next page

268

Page 269: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Variables Module prlsdkapi.prlsdk.errors

Name Description

PRL WARN NOT SYM-METRIC CPU

Value: -2147482512

PRL WARN PREPARE -FOR HIBERNATE UNA-BLE SUSPEND DO STO-P

Value: 482

PRL WARN TARGET H-OST DISK IS FULL

Value: -2147483035

PRL WARN TOO LOW -HDD SIZE

Value: -2147482999

PRL WARN UNABLE O-PEN DEVICE

Value: -2147483037

PRL WARN UNABLE O-PEN DEVICE NAME

Value: -2147483038

PRL WARN UNKNOWN-HDD REQUEST TYPE

Value: -2147483034

PRL WARN VERBOSE -LOGGING

Value: 495

PRL WARN VM BOOT-CAMP MODE

Value: -2147479548

PRL WARN VM DVD D-ISCONNECTED BY GU-EST

Value: -2147482552

PRL WARN VM DVD D-ISCONNECT LOCKED -DEV

Value: -2147482573

PRL WARN VM PD3 C-OMPAT MODE

Value: -2147479549

PRL WARN VM PD3 C-OMPAT NO MOUSE

Value: -2147479547

PRL WNG NO OPERAT-ION SYSTEM INSTALL-ED

Value: -2147418091

PRL WNG START VM -ON MOUNTED DISK

Value: 439

269

Page 270: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

Index

prlsdkapi (package), 2–107prlsdkapi.AccessRights (class), 91–93

prlsdkapi.AccessRights.get access for others(method), 91

prlsdkapi.AccessRights.get owner name(method), 92

prlsdkapi.AccessRights.is allowed (method),91

prlsdkapi.AccessRights.is current session owner(method), 92

prlsdkapi.AccessRights.set access for others(method), 92

prlsdkapi.ApiHelper (class), 3–5prlsdkapi.ApiHelper.create handles list (method),

4prlsdkapi.ApiHelper.create op type list (method),

4prlsdkapi.ApiHelper.create strings list (method),

4prlsdkapi.ApiHelper.deinit (method), 4prlsdkapi.ApiHelper.get app mode (method),

4prlsdkapi.ApiHelper.get crash dumps path

(method), 4prlsdkapi.ApiHelper.get default os version

(method), 4prlsdkapi.ApiHelper.get message type (method),

4prlsdkapi.ApiHelper.get recommend min vm mem

(method), 5prlsdkapi.ApiHelper.get remote command code

(method), 5prlsdkapi.ApiHelper.get remote command index

(method), 5prlsdkapi.ApiHelper.get remote command target

(method), 4prlsdkapi.ApiHelper.get result description

(method), 4prlsdkapi.ApiHelper.get supported oses types

(method), 4prlsdkapi.ApiHelper.get supported oses versions

(method), 4

prlsdkapi.ApiHelper.get version (method),4

prlsdkapi.ApiHelper.init (method), 4prlsdkapi.ApiHelper.init crash handler (method),

4prlsdkapi.ApiHelper.init ex (method), 4prlsdkapi.ApiHelper.msg can be ignored

(method), 4prlsdkapi.ApiHelper.send remote command

(method), 4prlsdkapi.ApiHelper.unregister remote device

(method), 4prlsdkapi.BootDevice (class), 86–88

prlsdkapi.BootDevice.get index (method),87

prlsdkapi.BootDevice.get sequence index(method), 87

prlsdkapi.BootDevice.is in use (method),87

prlsdkapi.BootDevice.remove (method),86

prlsdkapi.BootDevice.set in use (method),87

prlsdkapi.BootDevice.set index (method),87

prlsdkapi.BootDevice.set sequence index(method), 87

prlsdkapi.BootDevice.set type (method),86

prlsdkapi.call sdk function (function), 2prlsdkapi.conv error (function), 2prlsdkapi.conv handle arg (function), 2prlsdkapi.Debug (class), 5

prlsdkapi.Debug.event type to string (method),5

prlsdkapi.Debug.get handles num (method),5

prlsdkapi.Debug.handle type to string (method),5

prlsdkapi.Debug.prl result to string (method),5

prlsdkapi.DispConfig (class), 35–40

270

Page 271: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

prlsdkapi.DispConfig.can change default settings(method), 38

prlsdkapi.DispConfig.get backup user login(method), 39

prlsdkapi.DispConfig.get default backup directory(method), 40

prlsdkapi.DispConfig.get default backup server(method), 39

prlsdkapi.DispConfig.get default vm dir(method), 35

prlsdkapi.DispConfig.get default vnchost name(method), 38

prlsdkapi.DispConfig.get max reserv mem limit(method), 37

prlsdkapi.DispConfig.get max vm mem(method), 36

prlsdkapi.DispConfig.get min reserv mem limit(method), 37

prlsdkapi.DispConfig.get min security level(method), 39

prlsdkapi.DispConfig.get min vm mem (method),36

prlsdkapi.DispConfig.get recommend max vm mem(method), 36

prlsdkapi.DispConfig.get reserved mem limit(method), 35

prlsdkapi.DispConfig.get vncbase port (method),38

prlsdkapi.DispConfig.is adjust mem auto(method), 37

prlsdkapi.DispConfig.is backup user password enabled(method), 40

prlsdkapi.DispConfig.is send statistic report(method), 38

prlsdkapi.DispConfig.set adjust mem auto(method), 38

prlsdkapi.DispConfig.set backup user login(method), 39

prlsdkapi.DispConfig.set backup user password(method), 39

prlsdkapi.DispConfig.set backup user password enabled(method), 40

prlsdkapi.DispConfig.set can change default settings(method), 39

prlsdkapi.DispConfig.set default backup directory(method), 40

prlsdkapi.DispConfig.set default backup server(method), 39

prlsdkapi.DispConfig.set default vnchost name(method), 38

prlsdkapi.DispConfig.set max reserv mem limit(method), 37

prlsdkapi.DispConfig.set max vm mem (method),36

prlsdkapi.DispConfig.set min reserv mem limit(method), 37

prlsdkapi.DispConfig.set min security level(method), 39

prlsdkapi.DispConfig.set min vm mem (method),36

prlsdkapi.DispConfig.set recommend max vm mem(method), 37

prlsdkapi.DispConfig.set reserved mem limit(method), 36

prlsdkapi.DispConfig.set send statistic report(method), 38

prlsdkapi.DispConfig.set vncbase port (method),38

prlsdkapi.Event (class), 9–10prlsdkapi.Event. getitem (method), 10prlsdkapi.Event. iter (method), 10prlsdkapi.Event. len (method), 10prlsdkapi.Event.can be ignored (method),

10prlsdkapi.Event.create answer event (method),

10prlsdkapi.Event.get err code (method),

9prlsdkapi.Event.get err string (method),

10prlsdkapi.Event.get issuer id (method),

10prlsdkapi.Event.get issuer type (method),

10prlsdkapi.Event.get job (method), 9prlsdkapi.Event.get param (method), 9prlsdkapi.Event.get param by name (method),

9

271

Page 272: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

prlsdkapi.Event.get params count (method),9

prlsdkapi.Event.get server (method), 9prlsdkapi.Event.get vm (method), 9prlsdkapi.Event.is answer required (method),

10prlsdkapi.Event.next (method), 10

prlsdkapi.EventParam (class), 10–12prlsdkapi.EventParam.get name (method),

11prlsdkapi.EventParam.to boolean (method),

11prlsdkapi.EventParam.to cdata (method),

11prlsdkapi.EventParam.to handle (method),

11prlsdkapi.EventParam.to int32 (method),

11prlsdkapi.EventParam.to int64 (method),

11prlsdkapi.EventParam.to string (method),

11prlsdkapi.EventParam.to uint32 (method),

11prlsdkapi.EventParam.to uint64 (method),

11prlsdkapi.FoundVmInfo (class), 89–91

prlsdkapi.FoundVmInfo.get config path(method), 90

prlsdkapi.FoundVmInfo.get name (method),90

prlsdkapi.FoundVmInfo.get osversion (method),90

prlsdkapi.FoundVmInfo.is old config (method),90

prlsdkapi.FoundVmInfo.is template (method),90

prlsdkapi.FsEntry (class), 21–22prlsdkapi.FsEntry.get absolute path (method),

21prlsdkapi.FsEntry.get last modified date

(method), 21prlsdkapi.FsEntry.get permissions (method),

21

prlsdkapi.FsEntry.get relative name (method),21

prlsdkapi.FsEntry.get size (method), 21prlsdkapi.FsInfo (class), 20–21

prlsdkapi.FsInfo.get child entries count(method), 20

prlsdkapi.FsInfo.get child entry (method),20

prlsdkapi.FsInfo.get fs type (method), 20prlsdkapi.FsInfo.get parent entry (method),

20prlsdkapi.get sdk library path (function),

2prlsdkapi.handle to object (function), 2prlsdkapi.HandleList (class), 6–7

prlsdkapi.HandleList. getitem (method),7

prlsdkapi.HandleList. iter (method), 7prlsdkapi.HandleList. len (method), 7prlsdkapi.HandleList.add item (method),

7prlsdkapi.HandleList.get item (method),

7prlsdkapi.HandleList.get items count (method),

7prlsdkapi.HandleList.next (method), 7prlsdkapi.HandleList.remove item (method),

7prlsdkapi.HdPartition (class), 28–30

prlsdkapi.HdPartition.get index (method),29

prlsdkapi.HdPartition.get name (method),29

prlsdkapi.HdPartition.get size (method),29

prlsdkapi.HdPartition.get sys name (method),29

prlsdkapi.HdPartition.is active (method),29

prlsdkapi.HdPartition.is in use (method),29

prlsdkapi.HdPartition.is logical (method),29

prlsdkapi.HostDevice (class), 26–27

272

Page 273: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

prlsdkapi.HostDevice.get device state (method),27

prlsdkapi.HostDevice.get id (method), 26prlsdkapi.HostDevice.get name (method),

26prlsdkapi.HostDevice.is connected to vm

(method), 27prlsdkapi.HostDevice.set device state (method),

27prlsdkapi.HostHardDisk (class), 27–28

prlsdkapi.HostHardDisk.get dev id (method),28

prlsdkapi.HostHardDisk.get dev name (method),28

prlsdkapi.HostHardDisk.get dev size (method),28

prlsdkapi.HostHardDisk.get disk index (method),28

prlsdkapi.HostHardDisk.get part (method),28

prlsdkapi.HostHardDisk.get parts count(method), 28

prlsdkapi.HostNet (class), 30–32prlsdkapi.HostNet.get default gateway (method),

31prlsdkapi.HostNet.get dns servers (method),

31prlsdkapi.HostNet.get mac address (method),

31prlsdkapi.HostNet.get net adapter type

(method), 30prlsdkapi.HostNet.get net addresses (method),

31prlsdkapi.HostNet.get search domains (method),

31prlsdkapi.HostNet.get sys index (method),

30prlsdkapi.HostNet.get vlan tag (method),

31prlsdkapi.HostNet.is configure with dhcp

(method), 30prlsdkapi.HostNet.is enabled (method),

30prlsdkapi.HostPciDevice (class), 32

prlsdkapi.HostPciDevice.get device class(method), 32

prlsdkapi.init desktop sdk (function), 2prlsdkapi.init server sdk (function), 2prlsdkapi.init workstation sdk (function),

2prlsdkapi.is sdk initialized (function), 2prlsdkapi.Job (class), 12–13

prlsdkapi.Job.cancel (method), 12prlsdkapi.Job.get error (method), 12prlsdkapi.Job.get op code (method), 13prlsdkapi.Job.get progress (method), 12prlsdkapi.Job.get result (method), 12prlsdkapi.Job.get ret code (method), 12prlsdkapi.Job.get status (method), 12prlsdkapi.Job.is request was sent (method),

13prlsdkapi.Job.wait (method), 12

prlsdkapi.License (class), 100–102prlsdkapi.License.get company name (method),

101prlsdkapi.License.get license key (method),

101prlsdkapi.License.get status (method), 101prlsdkapi.License.get user name (method),

101prlsdkapi.License.is valid (method), 101

prlsdkapi.LoginResponse (class), 103–105prlsdkapi.LoginResponse.get host os version

(method), 104prlsdkapi.LoginResponse.get product version

(method), 104prlsdkapi.LoginResponse.get running task by index

(method), 104prlsdkapi.LoginResponse.get running task count

(method), 104prlsdkapi.LoginResponse.get server uuid

(method), 104prlsdkapi.LoginResponse.get session uuid

(method), 104prlsdkapi.NetService (class), 103

prlsdkapi.NetService.get status (method),103

prlsdkapi.PortForward (class), 44–45

273

Page 274: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

prlsdkapi.PortForward.create (method),44

prlsdkapi.PortForward.get incoming port(method), 44

prlsdkapi.PortForward.get redirect ipaddress(method), 44

prlsdkapi.PortForward.get redirect port(method), 45

prlsdkapi.PortForward.set incoming port(method), 44

prlsdkapi.PortForward.set redirect ipaddress(method), 44

prlsdkapi.PortForward.set redirect port(method), 45

prlsdkapi.prlsdk (module), 108–171prlsdkapi.prlsdk.consts (module), 172–

197prlsdkapi.prlsdk.DeinitializeSDK (func-

tion), 108prlsdkapi.prlsdk.errors (module), 198–

266prlsdkapi.prlsdk.GetSDKLibraryPath (func-

tion), 108prlsdkapi.prlsdk.InitializeSDK (function),

108prlsdkapi.prlsdk.IsSDKInitialized (func-

tion), 108prlsdkapi.prlsdk.PrlAcl GetAccessForOthers

(function), 108prlsdkapi.prlsdk.PrlAcl GetOwnerName

(function), 108prlsdkapi.prlsdk.PrlAcl IsAllowed (func-

tion), 108prlsdkapi.prlsdk.PrlAcl IsCurrentSessionOwner

(function), 108prlsdkapi.prlsdk.PrlAcl SetAccessForOthers

(function), 108prlsdkapi.prlsdk.PrlApi CreateHandlesList

(function), 108prlsdkapi.prlsdk.PrlApi CreateOpTypeList

(function), 109prlsdkapi.prlsdk.PrlApi CreateStringsList

(function), 109prlsdkapi.prlsdk.PrlApi Deinit (function),

109prlsdkapi.prlsdk.PrlApi GetAppMode (func-

tion), 109prlsdkapi.prlsdk.PrlApi GetCrashDumpsPath

(function), 109prlsdkapi.prlsdk.PrlApi GetDefaultOsVersion

(function), 109prlsdkapi.prlsdk.PrlApi GetMessageType

(function), 109prlsdkapi.prlsdk.PrlApi GetRecommendMinVmMem

(function), 109prlsdkapi.prlsdk.PrlApi GetRemoteCommandCode

(function), 109prlsdkapi.prlsdk.PrlApi GetRemoteCommandIndex

(function), 109prlsdkapi.prlsdk.PrlApi GetRemoteCommandTarget

(function), 109prlsdkapi.prlsdk.PrlApi GetResultDescription

(function), 109prlsdkapi.prlsdk.PrlApi GetSupportedOsesTypes

(function), 109prlsdkapi.prlsdk.PrlApi GetSupportedOsesVersions

(function), 109prlsdkapi.prlsdk.PrlApi GetVersion (func-

tion), 109prlsdkapi.prlsdk.PrlApi Init (function),

109prlsdkapi.prlsdk.PrlApi InitCrashHandler

(function), 110prlsdkapi.prlsdk.PrlApi InitEx (function),

110prlsdkapi.prlsdk.PrlApi MsgCanBeIgnored

(function), 110prlsdkapi.prlsdk.PrlApi SendRemoteCommand

(function), 110prlsdkapi.prlsdk.PrlApi UnregisterRemoteDevice

(function), 110prlsdkapi.prlsdk.PrlBootDev GetIndex (func-

tion), 110prlsdkapi.prlsdk.PrlBootDev GetSequenceIndex

(function), 110prlsdkapi.prlsdk.PrlBootDev GetType (func-

tion), 110prlsdkapi.prlsdk.PrlBootDev IsInUse (func-

274

Page 275: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

tion), 110prlsdkapi.prlsdk.PrlBootDev Remove (func-

tion), 110prlsdkapi.prlsdk.PrlBootDev SetIndex (func-

tion), 110prlsdkapi.prlsdk.PrlBootDev SetInUse (func-

tion), 110prlsdkapi.prlsdk.PrlBootDev SetSequenceIndex

(function), 110prlsdkapi.prlsdk.PrlBootDev SetType (func-

tion), 110prlsdkapi.prlsdk.PrlDbg EventTypeToString

(function), 111prlsdkapi.prlsdk.PrlDbg GetHandlesNum

(function), 111prlsdkapi.prlsdk.PrlDbg HandleTypeToString

(function), 111prlsdkapi.prlsdk.PrlDbg PrlResultToString

(function), 111prlsdkapi.prlsdk.PrlDevDisplay AsyncCaptureScaledScreenRegionToBuffer

(function), 111prlsdkapi.prlsdk.PrlDevDisplay AsyncCaptureScaledScreenRegionToFile

(function), 111prlsdkapi.prlsdk.PrlDevDisplay AsyncCaptureScreenRegionToFile

(function), 111prlsdkapi.prlsdk.PrlDevDisplay ConnectToVm

(function), 111prlsdkapi.prlsdk.PrlDevDisplay DisconnectFromVm

(function), 111prlsdkapi.prlsdk.PrlDevDisplay GetDynResToolStatus

(function), 111prlsdkapi.prlsdk.PrlDevDisplay IsSlidingMouseEnabled

(function), 111prlsdkapi.prlsdk.PrlDevDisplay LockForRead

(function), 111prlsdkapi.prlsdk.PrlDevDisplay NeedCursorData

(function), 111prlsdkapi.prlsdk.PrlDevDisplay SetScreenSurface

(function), 111prlsdkapi.prlsdk.PrlDevDisplay SyncCaptureScaledScreenRegionToFile

(function), 111prlsdkapi.prlsdk.PrlDevDisplay SyncCaptureScreenRegionToFile

(function), 111prlsdkapi.prlsdk.PrlDevDisplay Unlock (func-

tion), 111prlsdkapi.prlsdk.PrlDevKeyboard SendKeyEvent

(function), 111prlsdkapi.prlsdk.PrlDevMouse Move (func-

tion), 112prlsdkapi.prlsdk.PrlDevMouse SetPos (func-

tion), 112prlsdkapi.prlsdk.PrlDisk ConvertToCurrent

(function), 112prlsdkapi.prlsdk.PrlDisk ConvertToCurrent Local

(function), 112prlsdkapi.prlsdk.PrlDisk FlushCache (func-

tion), 112prlsdkapi.prlsdk.PrlDisk Free (function),

112prlsdkapi.prlsdk.PrlDisk GetSnapshotsCount

(function), 112prlsdkapi.prlsdk.PrlDisk GetUserParameter

(function), 112prlsdkapi.prlsdk.PrlDisk IsCompactable

(function), 112prlsdkapi.prlsdk.PrlDisk SetCachingPolicy

(function), 112prlsdkapi.prlsdk.PrlDisk SetSharedDirectory

(function), 112prlsdkapi.prlsdk.PrlDisk SetSharedDirectory Local

(function), 112prlsdkapi.prlsdk.PrlDisk SetUserParameter

(function), 113prlsdkapi.prlsdk.PrlDisk WaitForCompletion

(function), 113prlsdkapi.prlsdk.PrlDispCfg CanChangeDefaultSettings

(function), 113prlsdkapi.prlsdk.PrlDispCfg GetBackupUserLogin

(function), 113prlsdkapi.prlsdk.PrlDispCfg GetDefaultBackupDirectory

(function), 113prlsdkapi.prlsdk.PrlDispCfg GetDefaultBackupServer

(function), 113prlsdkapi.prlsdk.PrlDispCfg GetDefaultVmDir

(function), 113prlsdkapi.prlsdk.PrlDispCfg GetDefaultVNCHostName

(function), 113prlsdkapi.prlsdk.PrlDispCfg GetMaxReservMemLimit

275

Page 276: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

(function), 113prlsdkapi.prlsdk.PrlDispCfg GetMaxVmMem

(function), 113prlsdkapi.prlsdk.PrlDispCfg GetMinReservMemLimit

(function), 113prlsdkapi.prlsdk.PrlDispCfg GetMinSecurityLevel

(function), 114prlsdkapi.prlsdk.PrlDispCfg GetMinVmMem

(function), 114prlsdkapi.prlsdk.PrlDispCfg GetRecommendMaxVmMem

(function), 114prlsdkapi.prlsdk.PrlDispCfg GetReservedMemLimit

(function), 114prlsdkapi.prlsdk.PrlDispCfg GetVNCBasePort

(function), 114prlsdkapi.prlsdk.PrlDispCfg IsAdjustMemAuto

(function), 114prlsdkapi.prlsdk.PrlDispCfg IsBackupUserPasswordEnabled

(function), 114prlsdkapi.prlsdk.PrlDispCfg IsSendStatisticReport

(function), 114prlsdkapi.prlsdk.PrlDispCfg SetAdjustMemAuto

(function), 114prlsdkapi.prlsdk.PrlDispCfg SetBackupUserLogin

(function), 114prlsdkapi.prlsdk.PrlDispCfg SetBackupUserPassword

(function), 114prlsdkapi.prlsdk.PrlDispCfg SetBackupUserPasswordEnabled

(function), 115prlsdkapi.prlsdk.PrlDispCfg SetCanChangeDefaultSettings

(function), 115prlsdkapi.prlsdk.PrlDispCfg SetDefaultBackupDirectory

(function), 115prlsdkapi.prlsdk.PrlDispCfg SetDefaultBackupServer

(function), 115prlsdkapi.prlsdk.PrlDispCfg SetDefaultVNCHostName

(function), 115prlsdkapi.prlsdk.PrlDispCfg SetMaxReservMemLimit

(function), 115prlsdkapi.prlsdk.PrlDispCfg SetMaxVmMem

(function), 115prlsdkapi.prlsdk.PrlDispCfg SetMinReservMemLimit

(function), 115prlsdkapi.prlsdk.PrlDispCfg SetMinSecurityLevel

(function), 115prlsdkapi.prlsdk.PrlDispCfg SetMinVmMem

(function), 115prlsdkapi.prlsdk.PrlDispCfg SetRecommendMaxVmMem

(function), 116prlsdkapi.prlsdk.PrlDispCfg SetReservedMemLimit

(function), 116prlsdkapi.prlsdk.PrlDispCfg SetSendStatisticReport

(function), 116prlsdkapi.prlsdk.PrlDispCfg SetVNCBasePort

(function), 116prlsdkapi.prlsdk.PrlEvent CanBeIgnored

(function), 116prlsdkapi.prlsdk.PrlEvent CreateAnswerEvent

(function), 116prlsdkapi.prlsdk.PrlEvent GetErrCode (func-

tion), 116prlsdkapi.prlsdk.PrlEvent GetErrString

(function), 116prlsdkapi.prlsdk.PrlEvent GetIssuerId (func-

tion), 116prlsdkapi.prlsdk.PrlEvent GetIssuerType

(function), 116prlsdkapi.prlsdk.PrlEvent GetJob (func-

tion), 116prlsdkapi.prlsdk.PrlEvent GetParam (func-

tion), 116prlsdkapi.prlsdk.PrlEvent GetParamByName

(function), 116prlsdkapi.prlsdk.PrlEvent GetParamsCount

(function), 116prlsdkapi.prlsdk.PrlEvent GetServer (func-

tion), 116prlsdkapi.prlsdk.PrlEvent GetType (func-

tion), 116prlsdkapi.prlsdk.PrlEvent GetVm (func-

tion), 117prlsdkapi.prlsdk.PrlEvent IsAnswerRequired

(function), 117prlsdkapi.prlsdk.PrlEvtPrm GetName (func-

tion), 117prlsdkapi.prlsdk.PrlEvtPrm GetType (func-

tion), 117prlsdkapi.prlsdk.PrlEvtPrm ToBoolean

276

Page 277: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

(function), 117prlsdkapi.prlsdk.PrlEvtPrm ToCData (func-

tion), 117prlsdkapi.prlsdk.PrlEvtPrm ToHandle (func-

tion), 117prlsdkapi.prlsdk.PrlEvtPrm ToInt32 (func-

tion), 117prlsdkapi.prlsdk.PrlEvtPrm ToInt64 (func-

tion), 117prlsdkapi.prlsdk.PrlEvtPrm ToString (func-

tion), 117prlsdkapi.prlsdk.PrlEvtPrm ToUint32 (func-

tion), 117prlsdkapi.prlsdk.PrlEvtPrm ToUint64 (func-

tion), 117prlsdkapi.prlsdk.PrlFoundVmInfo GetConfigPath

(function), 117prlsdkapi.prlsdk.PrlFoundVmInfo GetName

(function), 117prlsdkapi.prlsdk.PrlFoundVmInfo GetOSVersion

(function), 117prlsdkapi.prlsdk.PrlFoundVmInfo IsOldConfig

(function), 117prlsdkapi.prlsdk.PrlFoundVmInfo IsTemplate

(function), 118prlsdkapi.prlsdk.PrlFsEntry GetAbsolutePath

(function), 118prlsdkapi.prlsdk.PrlFsEntry GetLastModifiedDate

(function), 118prlsdkapi.prlsdk.PrlFsEntry GetPermissions

(function), 118prlsdkapi.prlsdk.PrlFsEntry GetRelativeName

(function), 118prlsdkapi.prlsdk.PrlFsEntry GetSize (func-

tion), 118prlsdkapi.prlsdk.PrlFsEntry GetType (func-

tion), 118prlsdkapi.prlsdk.PrlFsInfo GetChildEntriesCount

(function), 118prlsdkapi.prlsdk.PrlFsInfo GetChildEntry

(function), 118prlsdkapi.prlsdk.PrlFsInfo GetFsType (func-

tion), 118prlsdkapi.prlsdk.PrlFsInfo GetParentEntry

(function), 118prlsdkapi.prlsdk.PrlFsInfo GetType (func-

tion), 118prlsdkapi.prlsdk.PrlHandle AddRef (func-

tion), 118prlsdkapi.prlsdk.PrlHandle Free (func-

tion), 118prlsdkapi.prlsdk.PrlHandle GetType (func-

tion), 118prlsdkapi.prlsdk.PrlHndlList AddItem (func-

tion), 118prlsdkapi.prlsdk.PrlHndlList GetItem (func-

tion), 118prlsdkapi.prlsdk.PrlHndlList GetItemsCount

(function), 118prlsdkapi.prlsdk.PrlHndlList RemoveItem

(function), 119prlsdkapi.prlsdk.PrlJob Cancel (function),

119prlsdkapi.prlsdk.PrlJob GetError (func-

tion), 119prlsdkapi.prlsdk.PrlJob GetOpCode (func-

tion), 119prlsdkapi.prlsdk.PrlJob GetProgress (func-

tion), 119prlsdkapi.prlsdk.PrlJob GetResult (func-

tion), 119prlsdkapi.prlsdk.PrlJob GetRetCode (func-

tion), 119prlsdkapi.prlsdk.PrlJob GetStatus (func-

tion), 119prlsdkapi.prlsdk.PrlJob IsRequestWasSent

(function), 119prlsdkapi.prlsdk.PrlJob Wait (function),

119prlsdkapi.prlsdk.PrlLic GetCompanyName

(function), 119prlsdkapi.prlsdk.PrlLic GetLicenseKey (func-

tion), 119prlsdkapi.prlsdk.PrlLic GetStatus (func-

tion), 119prlsdkapi.prlsdk.PrlLic GetUserName (func-

tion), 120prlsdkapi.prlsdk.PrlLic IsValid (function),

277

Page 278: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

120prlsdkapi.prlsdk.PrlLoginResponse GetHostOsVersion

(function), 120prlsdkapi.prlsdk.PrlLoginResponse GetProductVersion

(function), 120prlsdkapi.prlsdk.PrlLoginResponse GetRunningTaskByIndex

(function), 120prlsdkapi.prlsdk.PrlLoginResponse GetRunningTaskCount

(function), 120prlsdkapi.prlsdk.PrlLoginResponse GetServerUuid

(function), 120prlsdkapi.prlsdk.PrlLoginResponse GetSessionUuid

(function), 120prlsdkapi.prlsdk.PrlNetSvc GetStatus (func-

tion), 120prlsdkapi.prlsdk.PrlOpTypeList GetItemsCount

(function), 120prlsdkapi.prlsdk.PrlOpTypeList GetTypeSize

(function), 120prlsdkapi.prlsdk.PrlOpTypeList RemoveItem

(function), 120prlsdkapi.prlsdk.PrlPortFwd Create (func-

tion), 121prlsdkapi.prlsdk.PrlPortFwd GetIncomingPort

(function), 121prlsdkapi.prlsdk.PrlPortFwd GetRedirectIPAddress

(function), 121prlsdkapi.prlsdk.PrlPortFwd GetRedirectPort

(function), 121prlsdkapi.prlsdk.PrlPortFwd SetIncomingPort

(function), 121prlsdkapi.prlsdk.PrlPortFwd SetRedirectIPAddress

(function), 121prlsdkapi.prlsdk.PrlPortFwd SetRedirectPort

(function), 121prlsdkapi.prlsdk.PrlResult GetParam (func-

tion), 121prlsdkapi.prlsdk.PrlResult GetParamAsString

(function), 121prlsdkapi.prlsdk.PrlResult GetParamByIndex

(function), 121prlsdkapi.prlsdk.PrlResult GetParamByIndexAsString

(function), 121prlsdkapi.prlsdk.PrlResult GetParamsCount

(function), 121prlsdkapi.prlsdk.PrlRunningTask GetTaskParametersAsString

(function), 121prlsdkapi.prlsdk.PrlRunningTask GetTaskType

(function), 121prlsdkapi.prlsdk.PrlRunningTask GetTaskUuid

(function), 121prlsdkapi.prlsdk.PrlScrRes GetHeight (func-

tion), 122prlsdkapi.prlsdk.PrlScrRes GetWidth (func-

tion), 122prlsdkapi.prlsdk.PrlScrRes IsEnabled (func-

tion), 122prlsdkapi.prlsdk.PrlScrRes Remove (func-

tion), 122prlsdkapi.prlsdk.PrlScrRes SetEnabled (func-

tion), 122prlsdkapi.prlsdk.PrlScrRes SetHeight (func-

tion), 122prlsdkapi.prlsdk.PrlScrRes SetWidth (func-

tion), 122prlsdkapi.prlsdk.PrlShare GetDescription

(function), 122prlsdkapi.prlsdk.PrlShare GetName (func-

tion), 122prlsdkapi.prlsdk.PrlShare GetPath (func-

tion), 122prlsdkapi.prlsdk.PrlShare IsEnabled (func-

tion), 122prlsdkapi.prlsdk.PrlShare IsReadOnly (func-

tion), 122prlsdkapi.prlsdk.PrlShare Remove (func-

tion), 122prlsdkapi.prlsdk.PrlShare SetDescription

(function), 122prlsdkapi.prlsdk.PrlShare SetEnabled (func-

tion), 122prlsdkapi.prlsdk.PrlShare SetName (func-

tion), 122prlsdkapi.prlsdk.PrlShare SetPath (func-

tion), 122prlsdkapi.prlsdk.PrlShare SetReadOnly

(function), 122prlsdkapi.prlsdk.PrlSrv AddVirtualNetwork

278

Page 279: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

(function), 129prlsdkapi.prlsdk.PrlSrv AttachToLostTask

(function), 129prlsdkapi.prlsdk.PrlSrv CheckParallelsServerAlive

(function), 129prlsdkapi.prlsdk.PrlSrv CommonPrefsBeginEdit

(function), 129prlsdkapi.prlsdk.PrlSrv CommonPrefsCommit

(function), 130prlsdkapi.prlsdk.PrlSrv ConfigureGenericPci

(function), 130prlsdkapi.prlsdk.PrlSrv Create (function),

130prlsdkapi.prlsdk.PrlSrv CreateVm (func-

tion), 130prlsdkapi.prlsdk.PrlSrv CreateVmBackup

(function), 130prlsdkapi.prlsdk.PrlSrv DeleteVirtualNetwork

(function), 130prlsdkapi.prlsdk.PrlSrv FsCanCreateFile

(function), 130prlsdkapi.prlsdk.PrlSrv FsCreateDir (func-

tion), 130prlsdkapi.prlsdk.PrlSrv FsGenerateEntryName

(function), 130prlsdkapi.prlsdk.PrlSrv FsGetDirEntries

(function), 130prlsdkapi.prlsdk.PrlSrv FsGetDiskList (func-

tion), 130prlsdkapi.prlsdk.PrlSrv FsRemoveEntry

(function), 130prlsdkapi.prlsdk.PrlSrv FsRenameEntry

(function), 131prlsdkapi.prlsdk.PrlSrv GetBackupTree

(function), 131prlsdkapi.prlsdk.PrlSrv GetCommonPrefs

(function), 131prlsdkapi.prlsdk.PrlSrv GetLicenseInfo (func-

tion), 131prlsdkapi.prlsdk.PrlSrv GetNetServiceStatus

(function), 131prlsdkapi.prlsdk.PrlSrv GetPerfStats (func-

tion), 131prlsdkapi.prlsdk.PrlSrv GetProblemReport

(function), 131prlsdkapi.prlsdk.PrlSrv GetQuestions (func-

tion), 131prlsdkapi.prlsdk.PrlSrv GetServerInfo (func-

tion), 131prlsdkapi.prlsdk.PrlSrv GetSrvConfig (func-

tion), 131prlsdkapi.prlsdk.PrlSrv GetStatistics (func-

tion), 131prlsdkapi.prlsdk.PrlSrv GetUserInfo (func-

tion), 132prlsdkapi.prlsdk.PrlSrv GetUserInfoList

(function), 132prlsdkapi.prlsdk.PrlSrv GetUserProfile (func-

tion), 132prlsdkapi.prlsdk.PrlSrv GetVirtualNetworkList

(function), 132prlsdkapi.prlsdk.PrlSrv GetVmList (func-

tion), 132prlsdkapi.prlsdk.PrlSrv IsConnected (func-

tion), 132prlsdkapi.prlsdk.PrlSrv IsNonInteractiveSession

(function), 132prlsdkapi.prlsdk.PrlSrv Login (function),

132prlsdkapi.prlsdk.PrlSrv LoginLocal (func-

tion), 132prlsdkapi.prlsdk.PrlSrv Logoff (function),

132prlsdkapi.prlsdk.PrlSrv NetServiceRestart

(function), 132prlsdkapi.prlsdk.PrlSrv NetServiceRestoreDefaults

(function), 133prlsdkapi.prlsdk.PrlSrv NetServiceStart

(function), 133prlsdkapi.prlsdk.PrlSrv NetServiceStop

(function), 133prlsdkapi.prlsdk.PrlSrv RegisterVm (func-

tion), 133prlsdkapi.prlsdk.PrlSrv RegisterVmEx (func-

tion), 133prlsdkapi.prlsdk.PrlSrv RemoveVmBackup

(function), 133prlsdkapi.prlsdk.PrlSrv RestoreVmBackup

279

Page 280: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

(function), 133prlsdkapi.prlsdk.PrlSrv SendAnswer (func-

tion), 133prlsdkapi.prlsdk.PrlSrv SetNonInteractiveSession

(function), 133prlsdkapi.prlsdk.PrlSrv Shutdown (func-

tion), 133prlsdkapi.prlsdk.PrlSrv StartSearchVms

(function), 133prlsdkapi.prlsdk.PrlSrv SubscribeToHostStatistics

(function), 133prlsdkapi.prlsdk.PrlSrv SubscribeToPerfStats

(function), 134prlsdkapi.prlsdk.PrlSrv UnsubscribeFromHostStatistics

(function), 134prlsdkapi.prlsdk.PrlSrv UnsubscribeFromPerfStats

(function), 134prlsdkapi.prlsdk.PrlSrv UpdateLicense (func-

tion), 134prlsdkapi.prlsdk.PrlSrv UpdateVirtualNetwork

(function), 134prlsdkapi.prlsdk.PrlSrv UserProfileBeginEdit

(function), 134prlsdkapi.prlsdk.PrlSrv UserProfileCommit

(function), 134prlsdkapi.prlsdk.PrlSrvCfg GetCpuCount

(function), 125prlsdkapi.prlsdk.PrlSrvCfg GetCpuHvt

(function), 125prlsdkapi.prlsdk.PrlSrvCfg GetCpuMode

(function), 125prlsdkapi.prlsdk.PrlSrvCfg GetCpuModel

(function), 125prlsdkapi.prlsdk.PrlSrvCfg GetCpuSpeed

(function), 125prlsdkapi.prlsdk.PrlSrvCfg GetDefaultGateway

(function), 125prlsdkapi.prlsdk.PrlSrvCfg GetDnsServers

(function), 126prlsdkapi.prlsdk.PrlSrvCfg GetFloppyDisk

(function), 126prlsdkapi.prlsdk.PrlSrvCfg GetFloppyDisksCount

(function), 126prlsdkapi.prlsdk.PrlSrvCfg GetGenericPciDevice

(function), 126prlsdkapi.prlsdk.PrlSrvCfg GetGenericPciDevicesCoun

(function), 126prlsdkapi.prlsdk.PrlSrvCfg GetGenericScsiDevice

(function), 126prlsdkapi.prlsdk.PrlSrvCfg GetGenericScsiDevicesCoun

(function), 126prlsdkapi.prlsdk.PrlSrvCfg GetHardDisk

(function), 126prlsdkapi.prlsdk.PrlSrvCfg GetHardDisksCount

(function), 126prlsdkapi.prlsdk.PrlSrvCfg GetHostname

(function), 127prlsdkapi.prlsdk.PrlSrvCfg GetHostOsMajor

(function), 126prlsdkapi.prlsdk.PrlSrvCfg GetHostOsMinor

(function), 126prlsdkapi.prlsdk.PrlSrvCfg GetHostOsStrPresentation

(function), 127prlsdkapi.prlsdk.PrlSrvCfg GetHostOsSubMinor

(function), 127prlsdkapi.prlsdk.PrlSrvCfg GetHostOsType

(function), 127prlsdkapi.prlsdk.PrlSrvCfg GetHostRamSize

(function), 127prlsdkapi.prlsdk.PrlSrvCfg GetNetAdapter

(function), 127prlsdkapi.prlsdk.PrlSrvCfg GetNetAdaptersCount

(function), 127prlsdkapi.prlsdk.PrlSrvCfg GetOpticalDisk

(function), 127prlsdkapi.prlsdk.PrlSrvCfg GetOpticalDisksCount

(function), 127prlsdkapi.prlsdk.PrlSrvCfg GetParallelPort

(function), 127prlsdkapi.prlsdk.PrlSrvCfg GetParallelPortsCount

(function), 127prlsdkapi.prlsdk.PrlSrvCfg GetPrinter (func-

tion), 128prlsdkapi.prlsdk.PrlSrvCfg GetPrintersCount

(function), 128prlsdkapi.prlsdk.PrlSrvCfg GetSearchDomains

(function), 128prlsdkapi.prlsdk.PrlSrvCfg GetSerialPort

280

Page 281: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

(function), 128prlsdkapi.prlsdk.PrlSrvCfg GetSerialPortsCount

(function), 128prlsdkapi.prlsdk.PrlSrvCfg GetSoundMixerDev

(function), 128prlsdkapi.prlsdk.PrlSrvCfg GetSoundMixerDevsCount

(function), 128prlsdkapi.prlsdk.PrlSrvCfg GetSoundOutputDev

(function), 128prlsdkapi.prlsdk.PrlSrvCfg GetSoundOutputDevsCount

(function), 128prlsdkapi.prlsdk.PrlSrvCfg GetUsbDev (func-

tion), 128prlsdkapi.prlsdk.PrlSrvCfg GetUsbDevsCount

(function), 128prlsdkapi.prlsdk.PrlSrvCfg IsSoundDefaultEnabled

(function), 129prlsdkapi.prlsdk.PrlSrvCfg IsUsbSupported

(function), 129prlsdkapi.prlsdk.PrlSrvCfg IsVtdSupported

(function), 129prlsdkapi.prlsdk.PrlSrvCfgDev GetDeviceState

(function), 122prlsdkapi.prlsdk.PrlSrvCfgDev GetId (func-

tion), 123prlsdkapi.prlsdk.PrlSrvCfgDev GetName

(function), 123prlsdkapi.prlsdk.PrlSrvCfgDev GetType

(function), 123prlsdkapi.prlsdk.PrlSrvCfgDev IsConnectedToVm

(function), 123prlsdkapi.prlsdk.PrlSrvCfgDev SetDeviceState

(function), 123prlsdkapi.prlsdk.PrlSrvCfgHdd GetDevId

(function), 124prlsdkapi.prlsdk.PrlSrvCfgHdd GetDevName

(function), 124prlsdkapi.prlsdk.PrlSrvCfgHdd GetDevSize

(function), 124prlsdkapi.prlsdk.PrlSrvCfgHdd GetDiskIndex

(function), 124prlsdkapi.prlsdk.PrlSrvCfgHdd GetPart

(function), 124prlsdkapi.prlsdk.PrlSrvCfgHdd GetPartsCount

(function), 124prlsdkapi.prlsdk.PrlSrvCfgHddPart GetIndex

(function), 123prlsdkapi.prlsdk.PrlSrvCfgHddPart GetName

(function), 123prlsdkapi.prlsdk.PrlSrvCfgHddPart GetSize

(function), 123prlsdkapi.prlsdk.PrlSrvCfgHddPart GetSysName

(function), 123prlsdkapi.prlsdk.PrlSrvCfgHddPart GetType

(function), 123prlsdkapi.prlsdk.PrlSrvCfgHddPart IsActive

(function), 123prlsdkapi.prlsdk.PrlSrvCfgHddPart IsInUse

(function), 123prlsdkapi.prlsdk.PrlSrvCfgHddPart IsLogical

(function), 124prlsdkapi.prlsdk.PrlSrvCfgNet GetDefaultGateway

(function), 124prlsdkapi.prlsdk.PrlSrvCfgNet GetDnsServers

(function), 124prlsdkapi.prlsdk.PrlSrvCfgNet GetMacAddress

(function), 124prlsdkapi.prlsdk.PrlSrvCfgNet GetNetAdapterType

(function), 124prlsdkapi.prlsdk.PrlSrvCfgNet GetNetAddresses

(function), 124prlsdkapi.prlsdk.PrlSrvCfgNet GetSearchDomains

(function), 125prlsdkapi.prlsdk.PrlSrvCfgNet GetSysIndex

(function), 125prlsdkapi.prlsdk.PrlSrvCfgNet GetVlanTag

(function), 125prlsdkapi.prlsdk.PrlSrvCfgNet IsConfigureWithDhcp

(function), 125prlsdkapi.prlsdk.PrlSrvCfgNet IsEnabled

(function), 125prlsdkapi.prlsdk.PrlSrvCfgPci GetDeviceClass

(function), 125prlsdkapi.prlsdk.PrlSrvInfo GetCmdPort

(function), 129prlsdkapi.prlsdk.PrlSrvInfo GetHostName

(function), 129prlsdkapi.prlsdk.PrlSrvInfo GetOsVersion

281

Page 282: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

(function), 129prlsdkapi.prlsdk.PrlSrvInfo GetProductVersion

(function), 129prlsdkapi.prlsdk.PrlSrvInfo GetServerUuid

(function), 129prlsdkapi.prlsdk.PrlStat GetCpusStatsCount

(function), 136prlsdkapi.prlsdk.PrlStat GetCpuStat (func-

tion), 136prlsdkapi.prlsdk.PrlStat GetDisksStatsCount

(function), 136prlsdkapi.prlsdk.PrlStat GetDiskStat (func-

tion), 136prlsdkapi.prlsdk.PrlStat GetDispUptime

(function), 136prlsdkapi.prlsdk.PrlStat GetFreeRamSize

(function), 136prlsdkapi.prlsdk.PrlStat GetFreeSwapSize

(function), 136prlsdkapi.prlsdk.PrlStat GetIfacesStatsCount

(function), 136prlsdkapi.prlsdk.PrlStat GetIfaceStat (func-

tion), 136prlsdkapi.prlsdk.PrlStat GetOsUptime (func-

tion), 136prlsdkapi.prlsdk.PrlStat GetProcsStatsCount

(function), 136prlsdkapi.prlsdk.PrlStat GetProcStat (func-

tion), 136prlsdkapi.prlsdk.PrlStat GetTotalRamSize

(function), 136prlsdkapi.prlsdk.PrlStat GetTotalSwapSize

(function), 136prlsdkapi.prlsdk.PrlStat GetUsageRamSize

(function), 136prlsdkapi.prlsdk.PrlStat GetUsageSwapSize

(function), 137prlsdkapi.prlsdk.PrlStat GetUsersStatsCount

(function), 137prlsdkapi.prlsdk.PrlStat GetUserStat (func-

tion), 137prlsdkapi.prlsdk.PrlStatCpu GetCpuUsage

(function), 134prlsdkapi.prlsdk.PrlStatCpu GetSystemTime

(function), 134prlsdkapi.prlsdk.PrlStatCpu GetTotalTime

(function), 134prlsdkapi.prlsdk.PrlStatCpu GetUserTime

(function), 134prlsdkapi.prlsdk.PrlStatDisk GetFreeDiskSpace

(function), 134prlsdkapi.prlsdk.PrlStatDisk GetPartsStatsCount

(function), 135prlsdkapi.prlsdk.PrlStatDisk GetPartStat

(function), 135prlsdkapi.prlsdk.PrlStatDisk GetSystemName

(function), 135prlsdkapi.prlsdk.PrlStatDisk GetUsageDiskSpace

(function), 135prlsdkapi.prlsdk.PrlStatDiskPart GetFreeDiskSpace

(function), 134prlsdkapi.prlsdk.PrlStatDiskPart GetSystemName

(function), 134prlsdkapi.prlsdk.PrlStatDiskPart GetUsageDiskSpace

(function), 134prlsdkapi.prlsdk.PrlStatIface GetInDataSize

(function), 135prlsdkapi.prlsdk.PrlStatIface GetInPkgsCount

(function), 135prlsdkapi.prlsdk.PrlStatIface GetOutDataSize

(function), 135prlsdkapi.prlsdk.PrlStatIface GetOutPkgsCount

(function), 135prlsdkapi.prlsdk.PrlStatIface GetSystemName

(function), 135prlsdkapi.prlsdk.PrlStatProc GetCommandName

(function), 135prlsdkapi.prlsdk.PrlStatProc GetCpuUsage

(function), 135prlsdkapi.prlsdk.PrlStatProc GetId (func-

tion), 135prlsdkapi.prlsdk.PrlStatProc GetOwnerUserName

(function), 135prlsdkapi.prlsdk.PrlStatProc GetRealMemUsage

(function), 135prlsdkapi.prlsdk.PrlStatProc GetStartTime

(function), 135prlsdkapi.prlsdk.PrlStatProc GetState (func-

282

Page 283: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

tion), 135prlsdkapi.prlsdk.PrlStatProc GetSystemTime

(function), 135prlsdkapi.prlsdk.PrlStatProc GetTotalMemUsage

(function), 135prlsdkapi.prlsdk.PrlStatProc GetTotalTime

(function), 135prlsdkapi.prlsdk.PrlStatProc GetUserTime

(function), 135prlsdkapi.prlsdk.PrlStatProc GetVirtMemUsage

(function), 136prlsdkapi.prlsdk.PrlStatUser GetHostName

(function), 136prlsdkapi.prlsdk.PrlStatUser GetServiceName

(function), 136prlsdkapi.prlsdk.PrlStatUser GetSessionTime

(function), 136prlsdkapi.prlsdk.PrlStatUser GetUserName

(function), 136prlsdkapi.prlsdk.PrlStrList AddItem (func-

tion), 137prlsdkapi.prlsdk.PrlStrList GetItem (func-

tion), 137prlsdkapi.prlsdk.PrlStrList GetItemsCount

(function), 137prlsdkapi.prlsdk.PrlStrList RemoveItem

(function), 137prlsdkapi.prlsdk.PrlTisRecord GetName

(function), 137prlsdkapi.prlsdk.PrlTisRecord GetState

(function), 137prlsdkapi.prlsdk.PrlTisRecord GetText

(function), 137prlsdkapi.prlsdk.PrlTisRecord GetTime

(function), 137prlsdkapi.prlsdk.PrlTisRecord GetUid (func-

tion), 137prlsdkapi.prlsdk.PrlUsrCfg CanChangeSrvSets

(function), 137prlsdkapi.prlsdk.PrlUsrCfg CanUseMngConsole

(function), 137prlsdkapi.prlsdk.PrlUsrCfg GetDefaultVmFolder

(function), 137prlsdkapi.prlsdk.PrlUsrCfg GetVmDirUuid

(function), 138prlsdkapi.prlsdk.PrlUsrCfg IsLocalAdministrator

(function), 138prlsdkapi.prlsdk.PrlUsrCfg SetDefaultVmFolder

(function), 138prlsdkapi.prlsdk.PrlUsrCfg SetVmDirUuid

(function), 138prlsdkapi.prlsdk.PrlUsrInfo CanChangeSrvSets

(function), 138prlsdkapi.prlsdk.PrlUsrInfo GetDefaultVmFolder

(function), 138prlsdkapi.prlsdk.PrlUsrInfo GetName (func-

tion), 138prlsdkapi.prlsdk.PrlUsrInfo GetSessionCount

(function), 138prlsdkapi.prlsdk.PrlUsrInfo GetUuid (func-

tion), 138prlsdkapi.prlsdk.PrlVirtNet Create (func-

tion), 138prlsdkapi.prlsdk.PrlVirtNet GetAdapterIndex

(function), 138prlsdkapi.prlsdk.PrlVirtNet GetAdapterName

(function), 139prlsdkapi.prlsdk.PrlVirtNet GetBoundAdapterInfo

(function), 139prlsdkapi.prlsdk.PrlVirtNet GetBoundCardMac

(function), 139prlsdkapi.prlsdk.PrlVirtNet GetDescription

(function), 139prlsdkapi.prlsdk.PrlVirtNet GetDhcpIPAddress

(function), 139prlsdkapi.prlsdk.PrlVirtNet GetHostIPAddress

(function), 139prlsdkapi.prlsdk.PrlVirtNet GetIPNetMask

(function), 139prlsdkapi.prlsdk.PrlVirtNet GetIPScopeEnd

(function), 139prlsdkapi.prlsdk.PrlVirtNet GetIPScopeStart

(function), 139prlsdkapi.prlsdk.PrlVirtNet GetNetworkId

(function), 139prlsdkapi.prlsdk.PrlVirtNet GetNetworkType

(function), 139prlsdkapi.prlsdk.PrlVirtNet GetPortForwardList

283

Page 284: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

(function), 140prlsdkapi.prlsdk.PrlVirtNet GetVlanTag

(function), 140prlsdkapi.prlsdk.PrlVirtNet IsAdapterEnabled

(function), 140prlsdkapi.prlsdk.PrlVirtNet IsDHCPServerEnabled

(function), 140prlsdkapi.prlsdk.PrlVirtNet IsEnabled (func-

tion), 140prlsdkapi.prlsdk.PrlVirtNet IsNATServerEnabled

(function), 140prlsdkapi.prlsdk.PrlVirtNet SetAdapterEnabled

(function), 140prlsdkapi.prlsdk.PrlVirtNet SetAdapterIndex

(function), 140prlsdkapi.prlsdk.PrlVirtNet SetAdapterName

(function), 140prlsdkapi.prlsdk.PrlVirtNet SetBoundCardMac

(function), 140prlsdkapi.prlsdk.PrlVirtNet SetDescription

(function), 140prlsdkapi.prlsdk.PrlVirtNet SetDhcpIPAddress

(function), 141prlsdkapi.prlsdk.PrlVirtNet SetDHCPServerEnabled

(function), 140prlsdkapi.prlsdk.PrlVirtNet SetEnabled

(function), 141prlsdkapi.prlsdk.PrlVirtNet SetHostIPAddress

(function), 141prlsdkapi.prlsdk.PrlVirtNet SetIPNetMask

(function), 141prlsdkapi.prlsdk.PrlVirtNet SetIPScopeEnd

(function), 141prlsdkapi.prlsdk.PrlVirtNet SetIPScopeStart

(function), 141prlsdkapi.prlsdk.PrlVirtNet SetNATServerEnabled

(function), 141prlsdkapi.prlsdk.PrlVirtNet SetNetworkId

(function), 141prlsdkapi.prlsdk.PrlVirtNet SetNetworkType

(function), 141prlsdkapi.prlsdk.PrlVirtNet SetPortForwardList

(function), 141prlsdkapi.prlsdk.PrlVirtNet SetVlanTag

(function), 141prlsdkapi.prlsdk.PrlVm AuthWithGuestSecurityDb

(function), 166prlsdkapi.prlsdk.PrlVm BeginEdit (func-

tion), 166prlsdkapi.prlsdk.PrlVm CancelCompressor

(function), 166prlsdkapi.prlsdk.PrlVm Clone (function),

166prlsdkapi.prlsdk.PrlVm CloneEx (func-

tion), 166prlsdkapi.prlsdk.PrlVm Commit (func-

tion), 166prlsdkapi.prlsdk.PrlVm CreateEvent (func-

tion), 167prlsdkapi.prlsdk.PrlVm CreateSnapshot

(function), 167prlsdkapi.prlsdk.PrlVm CreateUnattendedFloppy

(function), 167prlsdkapi.prlsdk.PrlVm Delete (function),

167prlsdkapi.prlsdk.PrlVm DeleteSnapshot

(function), 167prlsdkapi.prlsdk.PrlVm DropSuspendedState

(function), 167prlsdkapi.prlsdk.PrlVm GenerateVmDevFilename

(function), 167prlsdkapi.prlsdk.PrlVm GetConfig (func-

tion), 167prlsdkapi.prlsdk.PrlVm GetPerfStats (func-

tion), 167prlsdkapi.prlsdk.PrlVm GetProblemReport

(function), 167prlsdkapi.prlsdk.PrlVm GetQuestions (func-

tion), 167prlsdkapi.prlsdk.PrlVm GetSnapshotsTree

(function), 167prlsdkapi.prlsdk.PrlVm GetState (func-

tion), 168prlsdkapi.prlsdk.PrlVm GetStatistics (func-

tion), 168prlsdkapi.prlsdk.PrlVm GetSuspendedScreen

(function), 168prlsdkapi.prlsdk.PrlVm GetToolsState (func-

284

Page 285: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

tion), 168prlsdkapi.prlsdk.PrlVm InitiateDevStateNotifications

(function), 168prlsdkapi.prlsdk.PrlVm InstallTools (func-

tion), 168prlsdkapi.prlsdk.PrlVm InstallUtility (func-

tion), 168prlsdkapi.prlsdk.PrlVm Lock (function),

168prlsdkapi.prlsdk.PrlVm LoginInGuest (func-

tion), 168prlsdkapi.prlsdk.PrlVm Migrate (func-

tion), 168prlsdkapi.prlsdk.PrlVm MigrateCancel (func-

tion), 168prlsdkapi.prlsdk.PrlVm MigrateEx (func-

tion), 168prlsdkapi.prlsdk.PrlVm Pause (function),

169prlsdkapi.prlsdk.PrlVm RefreshConfig (func-

tion), 169prlsdkapi.prlsdk.PrlVm Reg (function),

169prlsdkapi.prlsdk.PrlVm Reset (function),

169prlsdkapi.prlsdk.PrlVm Restart (function),

169prlsdkapi.prlsdk.PrlVm Restore (function),

169prlsdkapi.prlsdk.PrlVm Resume (func-

tion), 169prlsdkapi.prlsdk.PrlVm RunCompressor

(function), 169prlsdkapi.prlsdk.PrlVm SetConfig (func-

tion), 169prlsdkapi.prlsdk.PrlVm Start (function),

169prlsdkapi.prlsdk.PrlVm StartEx (func-

tion), 169prlsdkapi.prlsdk.PrlVm StartVncServer

(function), 169prlsdkapi.prlsdk.PrlVm Stop (function),

170prlsdkapi.prlsdk.PrlVm StopVncServer (func-

tion), 170prlsdkapi.prlsdk.PrlVm SubscribeToGuestStatistics

(function), 170prlsdkapi.prlsdk.PrlVm SubscribeToPerfStats

(function), 170prlsdkapi.prlsdk.PrlVm Suspend (func-

tion), 170prlsdkapi.prlsdk.PrlVm SwitchToSnapshot

(function), 170prlsdkapi.prlsdk.PrlVm TisGetIdentifiers

(function), 170prlsdkapi.prlsdk.PrlVm TisGetRecord (func-

tion), 170prlsdkapi.prlsdk.PrlVm ToolsGetShutdownCapabilities

(function), 170prlsdkapi.prlsdk.PrlVm ToolsSendShutdown

(function), 170prlsdkapi.prlsdk.PrlVm Unlock (function),

170prlsdkapi.prlsdk.PrlVm Unreg (function),

170prlsdkapi.prlsdk.PrlVm UnsubscribeFromGuestStatistics

(function), 171prlsdkapi.prlsdk.PrlVm UnsubscribeFromPerfStats

(function), 171prlsdkapi.prlsdk.PrlVm UpdateSecurity

(function), 171prlsdkapi.prlsdk.PrlVm UpdateSnapshotData

(function), 171prlsdkapi.prlsdk.PrlVm ValidateConfig (func-

tion), 171prlsdkapi.prlsdk.PrlVmCfg AddDefaultDevice

(function), 141prlsdkapi.prlsdk.PrlVmCfg CreateBootDev

(function), 142prlsdkapi.prlsdk.PrlVmCfg CreateScrRes

(function), 142prlsdkapi.prlsdk.PrlVmCfg CreateShare

(function), 142prlsdkapi.prlsdk.PrlVmCfg CreateVmDev

(function), 142prlsdkapi.prlsdk.PrlVmCfg GetAccessRights

(function), 142prlsdkapi.prlsdk.PrlVmCfg GetAllDevices

285

Page 286: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

(function), 142prlsdkapi.prlsdk.PrlVmCfg GetAppInDockMode

(function), 142prlsdkapi.prlsdk.PrlVmCfg GetAutoStart

(function), 142prlsdkapi.prlsdk.PrlVmCfg GetAutoStartDelay

(function), 142prlsdkapi.prlsdk.PrlVmCfg GetAutoStop

(function), 142prlsdkapi.prlsdk.PrlVmCfg GetBackgroundPriority

(function), 142prlsdkapi.prlsdk.PrlVmCfg GetBootDev

(function), 143prlsdkapi.prlsdk.PrlVmCfg GetBootDevCount

(function), 143prlsdkapi.prlsdk.PrlVmCfg GetConfigValidity

(function), 143prlsdkapi.prlsdk.PrlVmCfg GetCpuAccelLevel

(function), 143prlsdkapi.prlsdk.PrlVmCfg GetCpuCount

(function), 143prlsdkapi.prlsdk.PrlVmCfg GetCpuLimit

(function), 143prlsdkapi.prlsdk.PrlVmCfg GetCpuMode

(function), 143prlsdkapi.prlsdk.PrlVmCfg GetCpuUnits

(function), 143prlsdkapi.prlsdk.PrlVmCfg GetCustomProperty

(function), 143prlsdkapi.prlsdk.PrlVmCfg GetDefaultGateway

(function), 143prlsdkapi.prlsdk.PrlVmCfg GetDefaultHddSize

(function), 143prlsdkapi.prlsdk.PrlVmCfg GetDefaultMemSize

(function), 143prlsdkapi.prlsdk.PrlVmCfg GetDefaultVideoRamSize

(function), 144prlsdkapi.prlsdk.PrlVmCfg GetDescription

(function), 144prlsdkapi.prlsdk.PrlVmCfg GetDevByType

(function), 144prlsdkapi.prlsdk.PrlVmCfg GetDevsCount

(function), 144prlsdkapi.prlsdk.PrlVmCfg GetDevsCountByType

(function), 144prlsdkapi.prlsdk.PrlVmCfg GetDisplayDev

(function), 144prlsdkapi.prlsdk.PrlVmCfg GetDisplayDevsCount

(function), 144prlsdkapi.prlsdk.PrlVmCfg GetDockIconType

(function), 144prlsdkapi.prlsdk.PrlVmCfg GetFloppyDisk

(function), 144prlsdkapi.prlsdk.PrlVmCfg GetFloppyDisksCount

(function), 144prlsdkapi.prlsdk.PrlVmCfg GetForegroundPriority

(function), 144prlsdkapi.prlsdk.PrlVmCfg GetGenericPciDev

(function), 145prlsdkapi.prlsdk.PrlVmCfg GetGenericPciDevsCount

(function), 145prlsdkapi.prlsdk.PrlVmCfg GetGenericScsiDev

(function), 145prlsdkapi.prlsdk.PrlVmCfg GetGenericScsiDevsCount

(function), 145prlsdkapi.prlsdk.PrlVmCfg GetHardDisk

(function), 145prlsdkapi.prlsdk.PrlVmCfg GetHardDisksCount

(function), 145prlsdkapi.prlsdk.PrlVmCfg GetHomePath

(function), 145prlsdkapi.prlsdk.PrlVmCfg GetHostname

(function), 145prlsdkapi.prlsdk.PrlVmCfg GetIcon (func-

tion), 145prlsdkapi.prlsdk.PrlVmCfg GetIoPriority

(function), 145prlsdkapi.prlsdk.PrlVmCfg GetLastModifiedDate

(function), 145prlsdkapi.prlsdk.PrlVmCfg GetLastModifierName

(function), 146prlsdkapi.prlsdk.PrlVmCfg GetName (func-

tion), 146prlsdkapi.prlsdk.PrlVmCfg GetNetAdapter

(function), 146prlsdkapi.prlsdk.PrlVmCfg GetNetAdaptersCount

(function), 146prlsdkapi.prlsdk.PrlVmCfg GetOfflineServices

286

Page 287: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

(function), 146prlsdkapi.prlsdk.PrlVmCfg GetOpticalDisk

(function), 146prlsdkapi.prlsdk.PrlVmCfg GetOpticalDisksCount

(function), 146prlsdkapi.prlsdk.PrlVmCfg GetOsType

(function), 146prlsdkapi.prlsdk.PrlVmCfg GetOsVersion

(function), 146prlsdkapi.prlsdk.PrlVmCfg GetParallelPort

(function), 146prlsdkapi.prlsdk.PrlVmCfg GetParallelPortsCount

(function), 146prlsdkapi.prlsdk.PrlVmCfg GetRamSize

(function), 147prlsdkapi.prlsdk.PrlVmCfg GetScrRes (func-

tion), 147prlsdkapi.prlsdk.PrlVmCfg GetScrResCount

(function), 147prlsdkapi.prlsdk.PrlVmCfg GetSearchDomains

(function), 147prlsdkapi.prlsdk.PrlVmCfg GetSerialPort

(function), 147prlsdkapi.prlsdk.PrlVmCfg GetSerialPortsCount

(function), 147prlsdkapi.prlsdk.PrlVmCfg GetServerHost

(function), 147prlsdkapi.prlsdk.PrlVmCfg GetServerUuid

(function), 147prlsdkapi.prlsdk.PrlVmCfg GetShare (func-

tion), 147prlsdkapi.prlsdk.PrlVmCfg GetSharesCount

(function), 147prlsdkapi.prlsdk.PrlVmCfg GetSmartGuardInterval

(function), 147prlsdkapi.prlsdk.PrlVmCfg GetSmartGuardMaxSnapshotsCount

(function), 148prlsdkapi.prlsdk.PrlVmCfg GetSoundDev

(function), 148prlsdkapi.prlsdk.PrlVmCfg GetSoundDevsCount

(function), 148prlsdkapi.prlsdk.PrlVmCfg GetStartLoginMode

(function), 148prlsdkapi.prlsdk.PrlVmCfg GetStartUserLogin

(function), 148prlsdkapi.prlsdk.PrlVmCfg GetSystemFlags

(function), 148prlsdkapi.prlsdk.PrlVmCfg GetTimeSyncInterval

(function), 148prlsdkapi.prlsdk.PrlVmCfg GetUndoDisksMode

(function), 148prlsdkapi.prlsdk.PrlVmCfg GetUsbDevice

(function), 148prlsdkapi.prlsdk.PrlVmCfg GetUsbDevicesCount

(function), 148prlsdkapi.prlsdk.PrlVmCfg GetUuid (func-

tion), 148prlsdkapi.prlsdk.PrlVmCfg GetVideoRamSize

(function), 149prlsdkapi.prlsdk.PrlVmCfg GetVNCHostName

(function), 148prlsdkapi.prlsdk.PrlVmCfg GetVNCMode

(function), 149prlsdkapi.prlsdk.PrlVmCfg GetVNCPassword

(function), 149prlsdkapi.prlsdk.PrlVmCfg GetVNCPort

(function), 149prlsdkapi.prlsdk.PrlVmCfg GetWindowMode

(function), 149prlsdkapi.prlsdk.PrlVmCfg IsAllowSelectBootDevice

(function), 149prlsdkapi.prlsdk.PrlVmCfg IsAutoCaptureReleaseMouse

(function), 149prlsdkapi.prlsdk.PrlVmCfg IsCloseAppOnShutdown

(function), 149prlsdkapi.prlsdk.PrlVmCfg IsCpuVtxEnabled

(function), 149prlsdkapi.prlsdk.PrlVmCfg IsDefaultDeviceNeeded

(function), 149prlsdkapi.prlsdk.PrlVmCfg IsDisableAPIC

(function), 149prlsdkapi.prlsdk.PrlVmCfg IsDiskCacheWriteBack

(function), 150prlsdkapi.prlsdk.PrlVmCfg IsExcludeDock

(function), 150prlsdkapi.prlsdk.PrlVmCfg IsGuestSharingAutoMoun

(function), 150prlsdkapi.prlsdk.PrlVmCfg IsGuestSharingEnabled

287

Page 288: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

(function), 150prlsdkapi.prlsdk.PrlVmCfg IsGuestSharingEnableSpotlight

(function), 150prlsdkapi.prlsdk.PrlVmCfg IsHostSharingEnabled

(function), 150prlsdkapi.prlsdk.PrlVmCfg IsMapSharedFoldersOnLetters

(function), 150prlsdkapi.prlsdk.PrlVmCfg IsMultiDisplay

(function), 150prlsdkapi.prlsdk.PrlVmCfg IsOfflineManagementEnabled

(function), 150prlsdkapi.prlsdk.PrlVmCfg IsOsResInFullScrMode

(function), 150prlsdkapi.prlsdk.PrlVmCfg IsRelocateTaskBar

(function), 151prlsdkapi.prlsdk.PrlVmCfg IsScrResEnabled

(function), 151prlsdkapi.prlsdk.PrlVmCfg IsShareAllHostDisks

(function), 151prlsdkapi.prlsdk.PrlVmCfg IsShareClipboard

(function), 151prlsdkapi.prlsdk.PrlVmCfg IsSharedProfileEnabled

(function), 151prlsdkapi.prlsdk.PrlVmCfg IsShareUserHomeDir

(function), 151prlsdkapi.prlsdk.PrlVmCfg IsShowTaskBar

(function), 151prlsdkapi.prlsdk.PrlVmCfg IsSmartGuardEnabled

(function), 151prlsdkapi.prlsdk.PrlVmCfg IsSmartGuardNotifyBeforeCreation

(function), 151prlsdkapi.prlsdk.PrlVmCfg IsTemplate (func-

tion), 151prlsdkapi.prlsdk.PrlVmCfg IsTimeSynchronizationEnabled

(function), 152prlsdkapi.prlsdk.PrlVmCfg IsTimeSyncSmartModeEnabled

(function), 151prlsdkapi.prlsdk.PrlVmCfg IsToolsAutoUpdateEnabled

(function), 152prlsdkapi.prlsdk.PrlVmCfg IsUseDefaultAnswers

(function), 152prlsdkapi.prlsdk.PrlVmCfg IsUseDesktop

(function), 152prlsdkapi.prlsdk.PrlVmCfg IsUseDocuments

(function), 152prlsdkapi.prlsdk.PrlVmCfg IsUseMusic (func-

tion), 152prlsdkapi.prlsdk.PrlVmCfg IsUsePictures

(function), 152prlsdkapi.prlsdk.PrlVmCfg IsUserDefinedSharedFoldersEnabled

(function), 152prlsdkapi.prlsdk.PrlVmCfg SetAllowSelectBootDevice

(function), 152prlsdkapi.prlsdk.PrlVmCfg SetAppInDockMode

(function), 152prlsdkapi.prlsdk.PrlVmCfg SetAutoCaptureReleaseMouse

(function), 152prlsdkapi.prlsdk.PrlVmCfg SetAutoStart

(function), 153prlsdkapi.prlsdk.PrlVmCfg SetAutoStartDelay

(function), 153prlsdkapi.prlsdk.PrlVmCfg SetAutoStop

(function), 153prlsdkapi.prlsdk.PrlVmCfg SetBackgroundPriority

(function), 153prlsdkapi.prlsdk.PrlVmCfg SetCloseAppOnShutdown

(function), 153prlsdkapi.prlsdk.PrlVmCfg SetCpuAccelLevel

(function), 153prlsdkapi.prlsdk.PrlVmCfg SetCpuCount

(function), 153prlsdkapi.prlsdk.PrlVmCfg SetCpuLimit

(function), 153prlsdkapi.prlsdk.PrlVmCfg SetCpuMode

(function), 153prlsdkapi.prlsdk.PrlVmCfg SetCpuUnits

(function), 153prlsdkapi.prlsdk.PrlVmCfg SetCustomProperty

(function), 153prlsdkapi.prlsdk.PrlVmCfg SetDefaultConfig

(function), 154prlsdkapi.prlsdk.PrlVmCfg SetDefaultGateway

(function), 154prlsdkapi.prlsdk.PrlVmCfg SetDescription

(function), 154prlsdkapi.prlsdk.PrlVmCfg SetDisableAPICSign

(function), 154prlsdkapi.prlsdk.PrlVmCfg SetDiskCacheWriteBack

288

Page 289: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

(function), 154prlsdkapi.prlsdk.PrlVmCfg SetDockIconType

(function), 154prlsdkapi.prlsdk.PrlVmCfg SetExcludeDock

(function), 154prlsdkapi.prlsdk.PrlVmCfg SetForegroundPriority

(function), 154prlsdkapi.prlsdk.PrlVmCfg SetGuestSharingAutoMount

(function), 154prlsdkapi.prlsdk.PrlVmCfg SetGuestSharingEnabled

(function), 154prlsdkapi.prlsdk.PrlVmCfg SetGuestSharingEnableSpotlight

(function), 154prlsdkapi.prlsdk.PrlVmCfg SetHostname

(function), 155prlsdkapi.prlsdk.PrlVmCfg SetHostSharingEnabled

(function), 154prlsdkapi.prlsdk.PrlVmCfg SetIcon (func-

tion), 155prlsdkapi.prlsdk.PrlVmCfg SetIoPriority

(function), 155prlsdkapi.prlsdk.PrlVmCfg SetMapSharedFoldersOnLetters

(function), 155prlsdkapi.prlsdk.PrlVmCfg SetMultiDisplay

(function), 155prlsdkapi.prlsdk.PrlVmCfg SetName (func-

tion), 155prlsdkapi.prlsdk.PrlVmCfg SetOfflineManagementEnabled

(function), 155prlsdkapi.prlsdk.PrlVmCfg SetOfflineServices

(function), 155prlsdkapi.prlsdk.PrlVmCfg SetOsResInFullScrMode

(function), 155prlsdkapi.prlsdk.PrlVmCfg SetOsVersion

(function), 155prlsdkapi.prlsdk.PrlVmCfg SetRamSize

(function), 155prlsdkapi.prlsdk.PrlVmCfg SetRelocateTaskBar

(function), 155prlsdkapi.prlsdk.PrlVmCfg SetScrResEnabled

(function), 156prlsdkapi.prlsdk.PrlVmCfg SetSearchDomains

(function), 156prlsdkapi.prlsdk.PrlVmCfg SetShareAllHostDisks

(function), 156prlsdkapi.prlsdk.PrlVmCfg SetShareClipboard

(function), 156prlsdkapi.prlsdk.PrlVmCfg SetSharedProfileEnabled

(function), 156prlsdkapi.prlsdk.PrlVmCfg SetShareUserHomeDir

(function), 156prlsdkapi.prlsdk.PrlVmCfg SetShowTaskBar

(function), 156prlsdkapi.prlsdk.PrlVmCfg SetSmartGuardEnabled

(function), 156prlsdkapi.prlsdk.PrlVmCfg SetSmartGuardInterval

(function), 156prlsdkapi.prlsdk.PrlVmCfg SetSmartGuardMaxSnapshotsCoun

(function), 156prlsdkapi.prlsdk.PrlVmCfg SetSmartGuardNotifyBeforeCreation

(function), 156prlsdkapi.prlsdk.PrlVmCfg SetStartLoginMode

(function), 157prlsdkapi.prlsdk.PrlVmCfg SetStartUserCreds

(function), 157prlsdkapi.prlsdk.PrlVmCfg SetSystemFlags

(function), 157prlsdkapi.prlsdk.PrlVmCfg SetTemplateSign

(function), 157prlsdkapi.prlsdk.PrlVmCfg SetTimeSynchronizationEnabled

(function), 157prlsdkapi.prlsdk.PrlVmCfg SetTimeSyncInterval

(function), 157prlsdkapi.prlsdk.PrlVmCfg SetTimeSyncSmartModeEnabled

(function), 157prlsdkapi.prlsdk.PrlVmCfg SetToolsAutoUpdateEnabled

(function), 157prlsdkapi.prlsdk.PrlVmCfg SetUndoDisksMode

(function), 157prlsdkapi.prlsdk.PrlVmCfg SetUseDefaultAnswers

(function), 157prlsdkapi.prlsdk.PrlVmCfg SetUseDesktop

(function), 157prlsdkapi.prlsdk.PrlVmCfg SetUseDocuments

(function), 158prlsdkapi.prlsdk.PrlVmCfg SetUseMusic

(function), 158prlsdkapi.prlsdk.PrlVmCfg SetUsePictures

289

Page 290: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

(function), 158prlsdkapi.prlsdk.PrlVmCfg SetUserDefinedSharedFoldersEnabled

(function), 158prlsdkapi.prlsdk.PrlVmCfg SetUuid (func-

tion), 158prlsdkapi.prlsdk.PrlVmCfg SetVideoRamSize

(function), 158prlsdkapi.prlsdk.PrlVmCfg SetVNCHostName

(function), 158prlsdkapi.prlsdk.PrlVmCfg SetVNCMode

(function), 158prlsdkapi.prlsdk.PrlVmCfg SetVNCPassword

(function), 158prlsdkapi.prlsdk.PrlVmCfg SetVNCPort

(function), 158prlsdkapi.prlsdk.PrlVmCfg SetWindowMode

(function), 158prlsdkapi.prlsdk.PrlVmDev Connect (func-

tion), 162prlsdkapi.prlsdk.PrlVmDev Create (func-

tion), 162prlsdkapi.prlsdk.PrlVmDev CreateImage

(function), 162prlsdkapi.prlsdk.PrlVmDev Disconnect

(function), 162prlsdkapi.prlsdk.PrlVmDev GetDescription

(function), 162prlsdkapi.prlsdk.PrlVmDev GetEmulatedType

(function), 163prlsdkapi.prlsdk.PrlVmDev GetFriendlyName

(function), 163prlsdkapi.prlsdk.PrlVmDev GetIfaceType

(function), 163prlsdkapi.prlsdk.PrlVmDev GetImagePath

(function), 163prlsdkapi.prlsdk.PrlVmDev GetIndex (func-

tion), 163prlsdkapi.prlsdk.PrlVmDev GetOutputFile

(function), 163prlsdkapi.prlsdk.PrlVmDev GetStackIndex

(function), 163prlsdkapi.prlsdk.PrlVmDev GetSysName

(function), 163prlsdkapi.prlsdk.PrlVmDev GetType (func-

tion), 163prlsdkapi.prlsdk.PrlVmDev IsConnected

(function), 163prlsdkapi.prlsdk.PrlVmDev IsEnabled (func-

tion), 163prlsdkapi.prlsdk.PrlVmDev IsPassthrough

(function), 163prlsdkapi.prlsdk.PrlVmDev IsRemote (func-

tion), 164prlsdkapi.prlsdk.PrlVmDev Remove (func-

tion), 164prlsdkapi.prlsdk.PrlVmDev ResizeImage

(function), 164prlsdkapi.prlsdk.PrlVmDev SetConnected

(function), 164prlsdkapi.prlsdk.PrlVmDev SetDefaultStackIndex

(function), 164prlsdkapi.prlsdk.PrlVmDev SetDescription

(function), 164prlsdkapi.prlsdk.PrlVmDev SetEmulatedType

(function), 164prlsdkapi.prlsdk.PrlVmDev SetEnabled

(function), 164prlsdkapi.prlsdk.PrlVmDev SetFriendlyName

(function), 164prlsdkapi.prlsdk.PrlVmDev SetIfaceType

(function), 164prlsdkapi.prlsdk.PrlVmDev SetImagePath

(function), 164prlsdkapi.prlsdk.PrlVmDev SetIndex (func-

tion), 164prlsdkapi.prlsdk.PrlVmDev SetOutputFile

(function), 165prlsdkapi.prlsdk.PrlVmDev SetPassthrough

(function), 165prlsdkapi.prlsdk.PrlVmDev SetRemote (func-

tion), 165prlsdkapi.prlsdk.PrlVmDev SetStackIndex

(function), 165prlsdkapi.prlsdk.PrlVmDev SetSysName

(function), 165prlsdkapi.prlsdk.PrlVmDevHd AddPartition

(function), 159prlsdkapi.prlsdk.PrlVmDevHd GetDiskSize

290

Page 291: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

(function), 159prlsdkapi.prlsdk.PrlVmDevHd GetDiskType

(function), 159prlsdkapi.prlsdk.PrlVmDevHd GetPartition

(function), 159prlsdkapi.prlsdk.PrlVmDevHd GetPartitionsCount

(function), 159prlsdkapi.prlsdk.PrlVmDevHd GetSizeOnDisk

(function), 159prlsdkapi.prlsdk.PrlVmDevHd IsSplitted

(function), 159prlsdkapi.prlsdk.PrlVmDevHd SetDiskSize

(function), 159prlsdkapi.prlsdk.PrlVmDevHd SetDiskType

(function), 159prlsdkapi.prlsdk.PrlVmDevHd SetSplitted

(function), 159prlsdkapi.prlsdk.PrlVmDevHdPart GetSysName

(function), 158prlsdkapi.prlsdk.PrlVmDevHdPart Remove

(function), 159prlsdkapi.prlsdk.PrlVmDevHdPart SetSysName

(function), 159prlsdkapi.prlsdk.PrlVmDevNet GenerateMacAddr

(function), 160prlsdkapi.prlsdk.PrlVmDevNet GetBoundAdapterIndex

(function), 160prlsdkapi.prlsdk.PrlVmDevNet GetBoundAdapterName

(function), 160prlsdkapi.prlsdk.PrlVmDevNet GetDefaultGateway

(function), 160prlsdkapi.prlsdk.PrlVmDevNet GetDnsServers

(function), 160prlsdkapi.prlsdk.PrlVmDevNet GetMacAddress

(function), 160prlsdkapi.prlsdk.PrlVmDevNet GetNetAddresses

(function), 160prlsdkapi.prlsdk.PrlVmDevNet GetSearchDomains

(function), 160prlsdkapi.prlsdk.PrlVmDevNet GetVirtualNetworkId

(function), 160prlsdkapi.prlsdk.PrlVmDevNet IsAutoApply

(function), 160prlsdkapi.prlsdk.PrlVmDevNet IsConfigureWithDhcp

(function), 160prlsdkapi.prlsdk.PrlVmDevNet SetAutoApply

(function), 161prlsdkapi.prlsdk.PrlVmDevNet SetBoundAdapterIndex

(function), 161prlsdkapi.prlsdk.PrlVmDevNet SetBoundAdapterName

(function), 161prlsdkapi.prlsdk.PrlVmDevNet SetConfigureWithDhcp

(function), 161prlsdkapi.prlsdk.PrlVmDevNet SetDefaultGateway

(function), 161prlsdkapi.prlsdk.PrlVmDevNet SetDnsServers

(function), 161prlsdkapi.prlsdk.PrlVmDevNet SetMacAddress

(function), 161prlsdkapi.prlsdk.PrlVmDevNet SetNetAddresses

(function), 161prlsdkapi.prlsdk.PrlVmDevNet SetSearchDomains

(function), 161prlsdkapi.prlsdk.PrlVmDevNet SetVirtualNetworkId

(function), 161prlsdkapi.prlsdk.PrlVmDevSerial GetSocketMode

(function), 161prlsdkapi.prlsdk.PrlVmDevSerial SetSocketMode

(function), 162prlsdkapi.prlsdk.PrlVmDevSound GetMixerDev

(function), 162prlsdkapi.prlsdk.PrlVmDevSound GetOutputDev

(function), 162prlsdkapi.prlsdk.PrlVmDevSound SetMixerDev

(function), 162prlsdkapi.prlsdk.PrlVmDevSound SetOutputDev

(function), 162prlsdkapi.prlsdk.PrlVmDevUsb GetAutoconnectOption

(function), 162prlsdkapi.prlsdk.PrlVmDevUsb SetAutoconnectOption

(function), 162prlsdkapi.prlsdk.PrlVmGuest GetNetworkSettings

(function), 165prlsdkapi.prlsdk.PrlVmGuest Logout (func-

tion), 165prlsdkapi.prlsdk.PrlVmGuest RunProgram

(function), 165prlsdkapi.prlsdk.PrlVmGuest SetUserPasswd

291

Page 292: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

(function), 165prlsdkapi.prlsdk.PrlVmInfo GetAccessRights

(function), 165prlsdkapi.prlsdk.PrlVmInfo GetAdditionState

(function), 165prlsdkapi.prlsdk.PrlVmInfo GetState (func-

tion), 166prlsdkapi.prlsdk.PrlVmInfo IsInvalid (func-

tion), 166prlsdkapi.prlsdk.PrlVmInfo IsVmWaitingForAnswer

(function), 166prlsdkapi.prlsdk.PrlVmInfo IsVncServerStarted

(function), 166prlsdkapi.prlsdk.PrlVmToolsInfo GetState

(function), 166prlsdkapi.prlsdk.PrlVmToolsInfo GetVersion

(function), 166prlsdkapi.prlsdk.SetSDKLibraryPath (func-

tion), 171prlsdkapi.PrlSDKError (class), 2–3

prlsdkapi.PrlSDKError.get details (method),3

prlsdkapi.Result (class), 7–9prlsdkapi.Result. getitem (method), 8prlsdkapi.Result. iter (method), 8prlsdkapi.Result. len (method), 8prlsdkapi.Result.get param (method), 8prlsdkapi.Result.get param as string (method),

8prlsdkapi.Result.get param by index (method),

8prlsdkapi.Result.get param by index as string

(method), 8prlsdkapi.Result.get params count (method),

8prlsdkapi.Result.next (method), 8

prlsdkapi.RunningTask (class), 105prlsdkapi.RunningTask.get task parameters as string

(method), 105prlsdkapi.RunningTask.get task type (method),

105prlsdkapi.RunningTask.get task uuid (method),

105prlsdkapi.ScreenRes (class), 85–86

prlsdkapi.ScreenRes.get height (method),85

prlsdkapi.ScreenRes.get width (method),85

prlsdkapi.ScreenRes.is enabled (method),85

prlsdkapi.ScreenRes.remove (method), 85prlsdkapi.ScreenRes.set enabled (method),

85prlsdkapi.ScreenRes.set height (method),

85prlsdkapi.ScreenRes.set width (method),

85prlsdkapi.sdk check result (function), 2prlsdkapi.Server (class), 13–20

prlsdkapi.Server.add virtual network (method),15

prlsdkapi.Server.attach to lost task (method),19

prlsdkapi.Server.check parallels server alive(method), 14

prlsdkapi.Server.common prefs begin edit(method), 14

prlsdkapi.Server.common prefs commit (method),15

prlsdkapi.Server.configure generic pci (method),15

prlsdkapi.Server.create (method), 14prlsdkapi.Server.create vm (method), 16prlsdkapi.Server.create vm backup (method),

17prlsdkapi.Server.delete virtual network (method),

15prlsdkapi.Server.fs can create file (method),

18prlsdkapi.Server.fs create dir (method),

18prlsdkapi.Server.fs generate entry name

(method), 19prlsdkapi.Server.fs get dir entries (method),

18prlsdkapi.Server.fs get disk list (method),

18prlsdkapi.Server.fs remove entry (method),

292

Page 293: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

18prlsdkapi.Server.fs rename entry (method),

18prlsdkapi.Server.get backup tree (method),

17prlsdkapi.Server.get common prefs (method),

14prlsdkapi.Server.get license info (method),

18prlsdkapi.Server.get net service status (method),

19prlsdkapi.Server.get perf stats (method),

19prlsdkapi.Server.get problem report (method),

19prlsdkapi.Server.get questions (method),

14prlsdkapi.Server.get server info (method),

16prlsdkapi.Server.get srv config (method),

14prlsdkapi.Server.get statistics (method),

15prlsdkapi.Server.get user info (method),

15prlsdkapi.Server.get user info list (method),

15prlsdkapi.Server.get user profile (method),

15prlsdkapi.Server.get virtual network list

(method), 15prlsdkapi.Server.get vm list (method), 16prlsdkapi.Server.is connected (method),

16prlsdkapi.Server.is non interactive session

(method), 14prlsdkapi.Server.login (method), 14prlsdkapi.Server.login local (method), 14prlsdkapi.Server.logoff (method), 14prlsdkapi.Server.net service restart (method),

19prlsdkapi.Server.net service restore defaults

(method), 19prlsdkapi.Server.net service start (method),

18prlsdkapi.Server.net service stop (method),

18prlsdkapi.Server.register vm (method), 16prlsdkapi.Server.register vm ex (method),

16prlsdkapi.Server.remove vm backup (method),

17prlsdkapi.Server.restore vm backup (method),

17prlsdkapi.Server.send answer (method),

18prlsdkapi.Server.set non interactive session

(method), 14prlsdkapi.Server.shutdown (method), 17prlsdkapi.Server.start search vms (method),

18prlsdkapi.Server.subscribe to host statistics

(method), 17prlsdkapi.Server.subscribe to perf stats

(method), 19prlsdkapi.Server.unsubscribe from host statistics

(method), 17prlsdkapi.Server.unsubscribe from perf stats

(method), 19prlsdkapi.Server.update license (method),

18prlsdkapi.Server.update virtual network

(method), 15prlsdkapi.Server.user profile begin edit (method),

16prlsdkapi.Server.user profile commit (method),

16prlsdkapi.ServerConfig (class), 22–26

prlsdkapi.ServerConfig.get cpu count (method),22

prlsdkapi.ServerConfig.get cpu hvt (method),22

prlsdkapi.ServerConfig.get cpu mode (method),22

prlsdkapi.ServerConfig.get cpu model (method),22

prlsdkapi.ServerConfig.get cpu speed (method),22

293

Page 294: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

prlsdkapi.ServerConfig.get default gateway(method), 23

prlsdkapi.ServerConfig.get dns servers (method),23

prlsdkapi.ServerConfig.get floppy disk (method),23

prlsdkapi.ServerConfig.get floppy disks count(method), 23

prlsdkapi.ServerConfig.get generic pci device(method), 25

prlsdkapi.ServerConfig.get generic pci devices count(method), 25

prlsdkapi.ServerConfig.get generic scsi device(method), 25

prlsdkapi.ServerConfig.get generic scsi devices count(method), 25

prlsdkapi.ServerConfig.get hard disk (method),25

prlsdkapi.ServerConfig.get hard disks count(method), 25

prlsdkapi.ServerConfig.get host os major(method), 22

prlsdkapi.ServerConfig.get host os minor(method), 23

prlsdkapi.ServerConfig.get host os str presentation(method), 23

prlsdkapi.ServerConfig.get host os sub minor(method), 23

prlsdkapi.ServerConfig.get host os type(method), 22

prlsdkapi.ServerConfig.get host ram size(method), 22

prlsdkapi.ServerConfig.get hostname (method),23

prlsdkapi.ServerConfig.get net adapter (method),25

prlsdkapi.ServerConfig.get net adapters count(method), 25

prlsdkapi.ServerConfig.get optical disk (method),24

prlsdkapi.ServerConfig.get optical disks count(method), 24

prlsdkapi.ServerConfig.get parallel port(method), 24

prlsdkapi.ServerConfig.get parallel ports count(method), 24

prlsdkapi.ServerConfig.get printer (method),25

prlsdkapi.ServerConfig.get printers count(method), 24

prlsdkapi.ServerConfig.get search domains(method), 23

prlsdkapi.ServerConfig.get serial port (method),24

prlsdkapi.ServerConfig.get serial ports count(method), 24

prlsdkapi.ServerConfig.get sound mixer dev(method), 24

prlsdkapi.ServerConfig.get sound mixer devs count(method), 24

prlsdkapi.ServerConfig.get sound output dev(method), 24

prlsdkapi.ServerConfig.get sound output devs count(method), 24

prlsdkapi.ServerConfig.get usb dev (method),25

prlsdkapi.ServerConfig.get usb devs count(method), 25

prlsdkapi.ServerConfig.is sound default enabled(method), 23

prlsdkapi.ServerConfig.is usb supported(method), 23

prlsdkapi.ServerConfig.is vtd supported(method), 23

prlsdkapi.ServerInfo (class), 102–103prlsdkapi.ServerInfo.get cmd port (method),

102prlsdkapi.ServerInfo.get host name (method),

102prlsdkapi.ServerInfo.get os version (method),

102prlsdkapi.ServerInfo.get product version

(method), 102prlsdkapi.ServerInfo.get server uuid (method),

102prlsdkapi.set sdk library path (function),

2prlsdkapi.Share (class), 83–85

294

Page 295: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

prlsdkapi.Share.get description (method),84

prlsdkapi.Share.get name (method), 84prlsdkapi.Share.get path (method), 84prlsdkapi.Share.is enabled (method), 84prlsdkapi.Share.is read only (method), 84prlsdkapi.Share.remove (method), 84prlsdkapi.Share.set description (method),

84prlsdkapi.Share.set enabled (method), 84prlsdkapi.Share.set name (method), 84prlsdkapi.Share.set path (method), 84prlsdkapi.Share.set read only (method),

84prlsdkapi.StatCpu (class), 95–96

prlsdkapi.StatCpu.get cpu usage (method),95

prlsdkapi.StatCpu.get system time (method),95

prlsdkapi.StatCpu.get total time (method),95

prlsdkapi.StatCpu.get user time (method),95

prlsdkapi.StatDisk (class), 98–99prlsdkapi.StatDisk.get free disk space (method),

98prlsdkapi.StatDisk.get part stat (method),

98prlsdkapi.StatDisk.get parts stats count

(method), 98prlsdkapi.StatDisk.get system name (method),

98prlsdkapi.StatDisk.get usage disk space

(method), 98prlsdkapi.StatDiskPart (class), 99

prlsdkapi.StatDiskPart.get free disk space(method), 99

prlsdkapi.StatDiskPart.get system name(method), 99

prlsdkapi.StatDiskPart.get usage disk space(method), 99

prlsdkapi.Statistics (class), 93–95prlsdkapi.Statistics.get cpu stat (method),

94

prlsdkapi.Statistics.get cpus stats count(method), 94

prlsdkapi.Statistics.get disk stat (method),95

prlsdkapi.Statistics.get disks stats count(method), 94

prlsdkapi.Statistics.get disp uptime (method),94

prlsdkapi.Statistics.get free ram size (method),94

prlsdkapi.Statistics.get free swap size (method),94

prlsdkapi.Statistics.get iface stat (method),94

prlsdkapi.Statistics.get ifaces stats count(method), 94

prlsdkapi.Statistics.get os uptime (method),94

prlsdkapi.Statistics.get proc stat (method),95

prlsdkapi.Statistics.get procs stats count(method), 95

prlsdkapi.Statistics.get total ram size (method),94

prlsdkapi.Statistics.get total swap size (method),94

prlsdkapi.Statistics.get usage ram size (method),94

prlsdkapi.Statistics.get usage swap size(method), 94

prlsdkapi.Statistics.get user stat (method),94

prlsdkapi.Statistics.get users stats count(method), 94

prlsdkapi.StatNetIface (class), 96–97prlsdkapi.StatNetIface.get in data size (method),

96prlsdkapi.StatNetIface.get in pkgs count

(method), 96prlsdkapi.StatNetIface.get out data size

(method), 96prlsdkapi.StatNetIface.get out pkgs count

(method), 96prlsdkapi.StatNetIface.get system name

295

Page 296: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

(method), 96prlsdkapi.StatProcess (class), 99–100

prlsdkapi.StatProcess.get command name(method), 100

prlsdkapi.StatProcess.get cpu usage (method),100

prlsdkapi.StatProcess.get id (method), 100prlsdkapi.StatProcess.get owner user name

(method), 100prlsdkapi.StatProcess.get real mem usage

(method), 100prlsdkapi.StatProcess.get start time (method),

100prlsdkapi.StatProcess.get state (method),

100prlsdkapi.StatProcess.get system time (method),

100prlsdkapi.StatProcess.get total mem usage

(method), 100prlsdkapi.StatProcess.get total time (method),

100prlsdkapi.StatProcess.get user time (method),

100prlsdkapi.StatProcess.get virt mem usage

(method), 100prlsdkapi.StatUser (class), 97–98

prlsdkapi.StatUser.get host name (method),97

prlsdkapi.StatUser.get service name (method),97

prlsdkapi.StatUser.get session time (method),97

prlsdkapi.StatUser.get user name (method),97

prlsdkapi.StringList (class), 5–6prlsdkapi.StringList. getitem (method),

6prlsdkapi.StringList. iter (method), 6prlsdkapi.StringList. len (method), 6prlsdkapi.StringList.add item (method),

6prlsdkapi.StringList.get item (method),

6prlsdkapi.StringList.get items count (method),

5prlsdkapi.StringList.next (method), 6prlsdkapi.StringList.remove item (method),

6prlsdkapi.TisRecord (class), 105–106

prlsdkapi.TisRecord.get name (method),106

prlsdkapi.TisRecord.get state (method),106

prlsdkapi.TisRecord.get text (method),106

prlsdkapi.TisRecord.get time (method),106

prlsdkapi.TisRecord.get uid (method), 106prlsdkapi.UserConfig (class), 32–34

prlsdkapi.UserConfig.can change srv sets(method), 33

prlsdkapi.UserConfig.can use mng console(method), 33

prlsdkapi.UserConfig.get default vm folder(method), 33

prlsdkapi.UserConfig.get vm dir uuid (method),33

prlsdkapi.UserConfig.is local administrator(method), 33

prlsdkapi.UserConfig.set default vm folder(method), 33

prlsdkapi.UserConfig.set vm dir uuid (method),33

prlsdkapi.UserInfo (class), 34–35prlsdkapi.UserInfo.can change srv sets (method),

34prlsdkapi.UserInfo.get default vm folder

(method), 34prlsdkapi.UserInfo.get name (method), 34prlsdkapi.UserInfo.get session count (method),

34prlsdkapi.UserInfo.get uuid (method), 34

prlsdkapi.VirtualNet (class), 40–44prlsdkapi.VirtualNet.create (method), 40prlsdkapi.VirtualNet.get adapter index (method),

41prlsdkapi.VirtualNet.get adapter name (method),

41

296

Page 297: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

prlsdkapi.VirtualNet.get bound adapter info(method), 43

prlsdkapi.VirtualNet.get bound card mac(method), 41

prlsdkapi.VirtualNet.get description (method),41

prlsdkapi.VirtualNet.get dhcp ipaddress(method), 42

prlsdkapi.VirtualNet.get host ipaddress(method), 42

prlsdkapi.VirtualNet.get ipnet mask (method),42

prlsdkapi.VirtualNet.get ipscope end (method),42

prlsdkapi.VirtualNet.get ipscope start (method),42

prlsdkapi.VirtualNet.get network id (method),41

prlsdkapi.VirtualNet.get network type (method),41

prlsdkapi.VirtualNet.get port forward list(method), 43

prlsdkapi.VirtualNet.get vlan tag (method),42

prlsdkapi.VirtualNet.is adapter enabled(method), 43

prlsdkapi.VirtualNet.is dhcpserver enabled(method), 43

prlsdkapi.VirtualNet.is enabled (method),43

prlsdkapi.VirtualNet.is natserver enabled(method), 43

prlsdkapi.VirtualNet.set adapter enabled(method), 43

prlsdkapi.VirtualNet.set adapter index (method),41

prlsdkapi.VirtualNet.set adapter name (method),41

prlsdkapi.VirtualNet.set bound card mac(method), 41

prlsdkapi.VirtualNet.set description (method),41

prlsdkapi.VirtualNet.set dhcp ipaddress(method), 42

prlsdkapi.VirtualNet.set dhcpserver enabled(method), 43

prlsdkapi.VirtualNet.set enabled (method),43

prlsdkapi.VirtualNet.set host ipaddress(method), 42

prlsdkapi.VirtualNet.set ipnet mask (method),42

prlsdkapi.VirtualNet.set ipscope end (method),42

prlsdkapi.VirtualNet.set ipscope start (method),42

prlsdkapi.VirtualNet.set natserver enabled(method), 43

prlsdkapi.VirtualNet.set network id (method),41

prlsdkapi.VirtualNet.set network type (method),41

prlsdkapi.VirtualNet.set port forward list(method), 43

prlsdkapi.VirtualNet.set vlan tag (method),42

prlsdkapi.Vm (class), 75–82prlsdkapi.Vm.auth with guest security db

(method), 81prlsdkapi.Vm.begin edit (method), 79prlsdkapi.Vm.cancel compressor (method),

80prlsdkapi.Vm.clone (method), 77prlsdkapi.Vm.clone ex (method), 77prlsdkapi.Vm.commit (method), 79prlsdkapi.Vm.create event (method), 79prlsdkapi.Vm.create snapshot (method),

77prlsdkapi.Vm.create unattended floppy

(method), 79prlsdkapi.Vm.delete (method), 78prlsdkapi.Vm.delete snapshot (method),

77prlsdkapi.Vm.drop suspended state (method),

77prlsdkapi.Vm.generate vm dev filename

(method), 78prlsdkapi.Vm.get config (method), 79

297

Page 298: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

prlsdkapi.Vm.get perf stats (method), 81prlsdkapi.Vm.get problem report (method),

78prlsdkapi.Vm.get questions (method), 79prlsdkapi.Vm.get snapshots tree (method),

77prlsdkapi.Vm.get state (method), 78prlsdkapi.Vm.get statistics (method), 79prlsdkapi.Vm.get suspended screen (method),

76prlsdkapi.Vm.get tools state (method),

80prlsdkapi.Vm.initiate dev state notifications

(method), 80prlsdkapi.Vm.install tools (method), 80prlsdkapi.Vm.install utility (method), 80prlsdkapi.Vm.lock (method), 77prlsdkapi.Vm.login in guest (method), 78prlsdkapi.Vm.migrate (method), 77prlsdkapi.Vm.migrate cancel (method),

78prlsdkapi.Vm.migrate ex (method), 78prlsdkapi.Vm.pause (method), 76prlsdkapi.Vm.refresh config (method), 78prlsdkapi.Vm.reg (method), 79prlsdkapi.Vm.reset (method), 76prlsdkapi.Vm.restart (method), 76prlsdkapi.Vm.restore (method), 79prlsdkapi.Vm.resume (method), 77prlsdkapi.Vm.run compressor (method),

80prlsdkapi.Vm.set config (method), 78prlsdkapi.Vm.start (method), 76prlsdkapi.Vm.start ex (method), 76prlsdkapi.Vm.start vnc server (method),

78prlsdkapi.Vm.stop (method), 76prlsdkapi.Vm.stop vnc server (method),

78prlsdkapi.Vm.subscribe to guest statistics

(method), 79prlsdkapi.Vm.subscribe to perf stats (method),

81prlsdkapi.Vm.suspend (method), 76

prlsdkapi.Vm.switch to snapshot (method),77

prlsdkapi.Vm.tis get identifiers (method),80

prlsdkapi.Vm.tis get record (method), 80prlsdkapi.Vm.tools get shutdown capabilities

(method), 80prlsdkapi.Vm.tools send shutdown (method),

80prlsdkapi.Vm.unlock (method), 77prlsdkapi.Vm.unreg (method), 79prlsdkapi.Vm.unsubscribe from guest statistics

(method), 79prlsdkapi.Vm.unsubscribe from perf stats

(method), 81prlsdkapi.Vm.update security (method),

80prlsdkapi.Vm.update snapshot data (method),

77prlsdkapi.Vm.validate config (method),

80prlsdkapi.VmConfig (class), 58–75

prlsdkapi.VmConfig.add default device (method),58

prlsdkapi.VmConfig.create boot dev (method),65

prlsdkapi.VmConfig.create scr res (method),65

prlsdkapi.VmConfig.create share (method),61

prlsdkapi.VmConfig.create vm dev (method),58

prlsdkapi.VmConfig.get access rights (method),59

prlsdkapi.VmConfig.get all devices (method),59

prlsdkapi.VmConfig.get app in dock mode(method), 74

prlsdkapi.VmConfig.get auto start (method),69

prlsdkapi.VmConfig.get auto start delay(method), 69

prlsdkapi.VmConfig.get auto stop (method),69

298

Page 299: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

prlsdkapi.VmConfig.get background priority(method), 74

prlsdkapi.VmConfig.get boot dev (method),65

prlsdkapi.VmConfig.get boot dev count(method), 65

prlsdkapi.VmConfig.get config validity (method),58

prlsdkapi.VmConfig.get cpu accel level (method),67

prlsdkapi.VmConfig.get cpu count (method),67

prlsdkapi.VmConfig.get cpu limit (method),67

prlsdkapi.VmConfig.get cpu mode (method),67

prlsdkapi.VmConfig.get cpu units (method),67

prlsdkapi.VmConfig.get custom property(method), 68

prlsdkapi.VmConfig.get default gateway(method), 66

prlsdkapi.VmConfig.get default hdd size(method), 58

prlsdkapi.VmConfig.get default mem size(method), 58

prlsdkapi.VmConfig.get default video ram size(method), 58

prlsdkapi.VmConfig.get description (method),68

prlsdkapi.VmConfig.get dev by type (method),59

prlsdkapi.VmConfig.get devs count (method),59

prlsdkapi.VmConfig.get devs count by type(method), 59

prlsdkapi.VmConfig.get display dev (method),61

prlsdkapi.VmConfig.get display devs count(method), 61

prlsdkapi.VmConfig.get dock icon type(method), 74

prlsdkapi.VmConfig.get floppy disk (method),59

prlsdkapi.VmConfig.get floppy disks count(method), 59

prlsdkapi.VmConfig.get foreground priority(method), 74

prlsdkapi.VmConfig.get generic pci dev(method), 61

prlsdkapi.VmConfig.get generic pci devs count(method), 60

prlsdkapi.VmConfig.get generic scsi dev(method), 61

prlsdkapi.VmConfig.get generic scsi devs count(method), 61

prlsdkapi.VmConfig.get hard disk (method),59

prlsdkapi.VmConfig.get hard disks count(method), 59

prlsdkapi.VmConfig.get home path (method),68

prlsdkapi.VmConfig.get hostname (method),65

prlsdkapi.VmConfig.get icon (method),68

prlsdkapi.VmConfig.get io priority (method),68

prlsdkapi.VmConfig.get last modified date(method), 70

prlsdkapi.VmConfig.get last modifier name(method), 70

prlsdkapi.VmConfig.get name (method),65

prlsdkapi.VmConfig.get net adapter (method),60

prlsdkapi.VmConfig.get net adapters count(method), 60

prlsdkapi.VmConfig.get offline services (method),75

prlsdkapi.VmConfig.get optical disk (method),59

prlsdkapi.VmConfig.get optical disks count(method), 59

prlsdkapi.VmConfig.get os type (method),66

prlsdkapi.VmConfig.get os version (method),66

299

Page 300: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

prlsdkapi.VmConfig.get parallel port (method),60

prlsdkapi.VmConfig.get parallel ports count(method), 60

prlsdkapi.VmConfig.get ram size (method),66

prlsdkapi.VmConfig.get scr res (method),65

prlsdkapi.VmConfig.get scr res count (method),65

prlsdkapi.VmConfig.get search domains(method), 75

prlsdkapi.VmConfig.get serial port (method),60

prlsdkapi.VmConfig.get serial ports count(method), 60

prlsdkapi.VmConfig.get server host (method),68

prlsdkapi.VmConfig.get server uuid (method),68

prlsdkapi.VmConfig.get share (method),61

prlsdkapi.VmConfig.get shares count (method),61

prlsdkapi.VmConfig.get smart guard interval(method), 62

prlsdkapi.VmConfig.get smart guard max snapshots count(method), 62

prlsdkapi.VmConfig.get sound dev (method),60

prlsdkapi.VmConfig.get sound devs count(method), 60

prlsdkapi.VmConfig.get start login mode(method), 69

prlsdkapi.VmConfig.get start user login(method), 69

prlsdkapi.VmConfig.get system flags (method),73

prlsdkapi.VmConfig.get time sync interval(method), 64

prlsdkapi.VmConfig.get undo disks mode(method), 74

prlsdkapi.VmConfig.get usb device (method),60

prlsdkapi.VmConfig.get usb devices count(method), 60

prlsdkapi.VmConfig.get uuid (method),66

prlsdkapi.VmConfig.get video ram size (method),66

prlsdkapi.VmConfig.get vnchost name (method),72

prlsdkapi.VmConfig.get vncmode (method),72

prlsdkapi.VmConfig.get vncpassword (method),72

prlsdkapi.VmConfig.get vncport (method),72

prlsdkapi.VmConfig.get window mode (method),70

prlsdkapi.VmConfig.is allow select boot device(method), 64

prlsdkapi.VmConfig.is auto capture release mouse(method), 63

prlsdkapi.VmConfig.is close app on shutdown(method), 73

prlsdkapi.VmConfig.is cpu vtx enabled(method), 67

prlsdkapi.VmConfig.is default device needed(method), 58

prlsdkapi.VmConfig.is disable apic (method),73

prlsdkapi.VmConfig.is disk cache write back(method), 73

prlsdkapi.VmConfig.is exclude dock (method),72

prlsdkapi.VmConfig.is guest sharing auto mount(method), 70

prlsdkapi.VmConfig.is guest sharing enable spotlight(method), 70

prlsdkapi.VmConfig.is guest sharing enabled(method), 70

prlsdkapi.VmConfig.is host sharing enabled(method), 70

prlsdkapi.VmConfig.is map shared folders on letters(method), 71

prlsdkapi.VmConfig.is multi display (method),72

300

Page 301: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

prlsdkapi.VmConfig.is offline management enabled(method), 63

prlsdkapi.VmConfig.is os res in full scr mode(method), 73

prlsdkapi.VmConfig.is relocate task bar(method), 71

prlsdkapi.VmConfig.is scr res enabled (method),73

prlsdkapi.VmConfig.is share all host disks(method), 71

prlsdkapi.VmConfig.is share clipboard (method),63

prlsdkapi.VmConfig.is share user home dir(method), 71

prlsdkapi.VmConfig.is shared profile enabled(method), 62

prlsdkapi.VmConfig.is show task bar (method),71

prlsdkapi.VmConfig.is smart guard enabled(method), 61

prlsdkapi.VmConfig.is smart guard notify before creation(method), 61

prlsdkapi.VmConfig.is template (method),68

prlsdkapi.VmConfig.is time sync smart mode enabled(method), 64

prlsdkapi.VmConfig.is time synchronization enabled(method), 64

prlsdkapi.VmConfig.is tools auto update enabled(method), 64

prlsdkapi.VmConfig.is use default answers(method), 74

prlsdkapi.VmConfig.is use desktop (method),62

prlsdkapi.VmConfig.is use documents (method),63

prlsdkapi.VmConfig.is use music (method),63

prlsdkapi.VmConfig.is use pictures (method),63

prlsdkapi.VmConfig.is user defined shared folders enabled(method), 62

prlsdkapi.VmConfig.set allow select boot device(method), 65

prlsdkapi.VmConfig.set app in dock mode(method), 74

prlsdkapi.VmConfig.set auto capture release mouse(method), 63

prlsdkapi.VmConfig.set auto start (method),69

prlsdkapi.VmConfig.set auto start delay(method), 69

prlsdkapi.VmConfig.set auto stop (method),69

prlsdkapi.VmConfig.set background priority(method), 74

prlsdkapi.VmConfig.set close app on shutdown(method), 73

prlsdkapi.VmConfig.set cpu accel level (method),67

prlsdkapi.VmConfig.set cpu count (method),67

prlsdkapi.VmConfig.set cpu limit (method),67

prlsdkapi.VmConfig.set cpu mode (method),67

prlsdkapi.VmConfig.set cpu units (method),67

prlsdkapi.VmConfig.set custom property(method), 69

prlsdkapi.VmConfig.set default config (method),58

prlsdkapi.VmConfig.set default gateway(method), 66

prlsdkapi.VmConfig.set description (method),68

prlsdkapi.VmConfig.set disable apicsign(method), 74

prlsdkapi.VmConfig.set disk cache write back(method), 73

prlsdkapi.VmConfig.set dock icon type (method),75

prlsdkapi.VmConfig.set exclude dock (method),72

prlsdkapi.VmConfig.set foreground priority(method), 74

prlsdkapi.VmConfig.set guest sharing auto mount(method), 70

301

Page 302: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

prlsdkapi.VmConfig.set guest sharing enable spotlight(method), 70

prlsdkapi.VmConfig.set guest sharing enabled(method), 70

prlsdkapi.VmConfig.set host sharing enabled(method), 71

prlsdkapi.VmConfig.set hostname (method),66

prlsdkapi.VmConfig.set icon (method),68

prlsdkapi.VmConfig.set io priority (method),68

prlsdkapi.VmConfig.set map shared folders on letters(method), 71

prlsdkapi.VmConfig.set multi display (method),72

prlsdkapi.VmConfig.set name (method),65

prlsdkapi.VmConfig.set offline management enabled(method), 64

prlsdkapi.VmConfig.set offline services (method),75

prlsdkapi.VmConfig.set os res in full scr mode(method), 73

prlsdkapi.VmConfig.set os version (method),66

prlsdkapi.VmConfig.set ram size (method),66

prlsdkapi.VmConfig.set relocate task bar(method), 71

prlsdkapi.VmConfig.set scr res enabled(method), 73

prlsdkapi.VmConfig.set search domains(method), 75

prlsdkapi.VmConfig.set share all host disks(method), 71

prlsdkapi.VmConfig.set share clipboard(method), 63

prlsdkapi.VmConfig.set share user home dir(method), 71

prlsdkapi.VmConfig.set shared profile enabled(method), 62

prlsdkapi.VmConfig.set show task bar (method),71

prlsdkapi.VmConfig.set smart guard enabled(method), 61

prlsdkapi.VmConfig.set smart guard interval(method), 62

prlsdkapi.VmConfig.set smart guard max snapshots coun(method), 62

prlsdkapi.VmConfig.set smart guard notify before creation(method), 62

prlsdkapi.VmConfig.set start login mode(method), 69

prlsdkapi.VmConfig.set start user creds(method), 69

prlsdkapi.VmConfig.set system flags (method),73

prlsdkapi.VmConfig.set template sign (method),68

prlsdkapi.VmConfig.set time sync interval(method), 64

prlsdkapi.VmConfig.set time sync smart mode enabled(method), 64

prlsdkapi.VmConfig.set time synchronization enabled(method), 64

prlsdkapi.VmConfig.set tools auto update enabled(method), 64

prlsdkapi.VmConfig.set undo disks mode(method), 74

prlsdkapi.VmConfig.set use default answers(method), 74

prlsdkapi.VmConfig.set use desktop (method),62

prlsdkapi.VmConfig.set use documents (method),63

prlsdkapi.VmConfig.set use music (method),63

prlsdkapi.VmConfig.set use pictures (method),63

prlsdkapi.VmConfig.set user defined shared folders enabled(method), 62

prlsdkapi.VmConfig.set uuid (method),66

prlsdkapi.VmConfig.set video ram size (method),67

prlsdkapi.VmConfig.set vnchost name (method),72

302

Page 303: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

prlsdkapi.VmConfig.set vncmode (method),72

prlsdkapi.VmConfig.set vncpassword (method),72

prlsdkapi.VmConfig.set vncport (method),72

prlsdkapi.VmConfig.set window mode (method),70

prlsdkapi.VmDevice (class), 45–49prlsdkapi.VmDevice.connect (method),

45prlsdkapi.VmDevice.create (method), 45prlsdkapi.VmDevice.create image (method),

46prlsdkapi.VmDevice.disconnect (method),

45prlsdkapi.VmDevice.get description (method),

47prlsdkapi.VmDevice.get emulated type (method),

47prlsdkapi.VmDevice.get friendly name (method),

47prlsdkapi.VmDevice.get iface type (method),

47prlsdkapi.VmDevice.get image path (method),

47prlsdkapi.VmDevice.get index (method),

46prlsdkapi.VmDevice.get output file (method),

48prlsdkapi.VmDevice.get stack index (method),

48prlsdkapi.VmDevice.get sys name (method),

47prlsdkapi.VmDevice.is connected (method),

46prlsdkapi.VmDevice.is enabled (method),

46prlsdkapi.VmDevice.is passthrough (method),

48prlsdkapi.VmDevice.is remote (method),

46prlsdkapi.VmDevice.remove (method), 46prlsdkapi.VmDevice.resize image (method),

46prlsdkapi.VmDevice.set connected (method),

46prlsdkapi.VmDevice.set default stack index

(method), 48prlsdkapi.VmDevice.set description (method),

47prlsdkapi.VmDevice.set emulated type (method),

47prlsdkapi.VmDevice.set enabled (method),

46prlsdkapi.VmDevice.set friendly name (method),

47prlsdkapi.VmDevice.set iface type (method),

47prlsdkapi.VmDevice.set image path (method),

47prlsdkapi.VmDevice.set index (method),

46prlsdkapi.VmDevice.set output file (method),

48prlsdkapi.VmDevice.set passthrough (method),

48prlsdkapi.VmDevice.set remote (method),

46prlsdkapi.VmDevice.set stack index (method),

48prlsdkapi.VmDevice.set sys name (method),

47prlsdkapi.VmGuest (class), 82–83

prlsdkapi.VmGuest.get network settings(method), 83

prlsdkapi.VmGuest.logout (method), 83prlsdkapi.VmGuest.run program (method),

83prlsdkapi.VmGuest.set user passwd (method),

83prlsdkapi.VmHardDisk (class), 49–50

prlsdkapi.VmHardDisk.add partition (method),50

prlsdkapi.VmHardDisk.get disk size (method),49

prlsdkapi.VmHardDisk.get disk type (method),49

303

Page 304: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

prlsdkapi.VmHardDisk.get partition (method),50

prlsdkapi.VmHardDisk.get partitions count(method), 50

prlsdkapi.VmHardDisk.get size on disk(method), 49

prlsdkapi.VmHardDisk.is splitted (method),49

prlsdkapi.VmHardDisk.set disk size (method),49

prlsdkapi.VmHardDisk.set disk type (method),49

prlsdkapi.VmHardDisk.set splitted (method),49

prlsdkapi.VmHdPartition (class), 50–51prlsdkapi.VmHdPartition.get sys name

(method), 51prlsdkapi.VmHdPartition.remove (method),

51prlsdkapi.VmHdPartition.set sys name (method),

51prlsdkapi.VmInfo (class), 88–89

prlsdkapi.VmInfo.get access rights (method),88

prlsdkapi.VmInfo.get addition state (method),89

prlsdkapi.VmInfo.get state (method), 88prlsdkapi.VmInfo.is invalid (method), 88prlsdkapi.VmInfo.is vm waiting for answer

(method), 89prlsdkapi.VmInfo.is vnc server started (method),

89prlsdkapi.VmIO (class), 106–107prlsdkapi.VmNet (class), 51–54

prlsdkapi.VmNet.generate mac addr (method),52

prlsdkapi.VmNet.get bound adapter index(method), 52

prlsdkapi.VmNet.get bound adapter name(method), 52

prlsdkapi.VmNet.get default gateway (method),53

prlsdkapi.VmNet.get dns servers (method),53

prlsdkapi.VmNet.get mac address (method),52

prlsdkapi.VmNet.get net addresses (method),53

prlsdkapi.VmNet.get search domains (method),53

prlsdkapi.VmNet.get virtual network id(method), 53

prlsdkapi.VmNet.is auto apply (method),52

prlsdkapi.VmNet.is configure with dhcp(method), 53

prlsdkapi.VmNet.set auto apply (method),52

prlsdkapi.VmNet.set bound adapter index(method), 52

prlsdkapi.VmNet.set bound adapter name(method), 52

prlsdkapi.VmNet.set configure with dhcp(method), 53

prlsdkapi.VmNet.set default gateway (method),53

prlsdkapi.VmNet.set dns servers (method),53

prlsdkapi.VmNet.set mac address (method),52

prlsdkapi.VmNet.set net addresses (method),53

prlsdkapi.VmNet.set search domains (method),53

prlsdkapi.VmNet.set virtual network id(method), 54

prlsdkapi.VmSerial (class), 56–58prlsdkapi.VmSerial.get socket mode (method),

57prlsdkapi.VmSerial.set socket mode (method),

57prlsdkapi.VmSound (class), 55–56

prlsdkapi.VmSound.get mixer dev (method),56

prlsdkapi.VmSound.get output dev (method),56

prlsdkapi.VmSound.set mixer dev (method),56

304

Page 305: Parallels Python API Referenceupdates.cloudserver.virtuozzo.com/doc/pcs/en_us/parallels/5/rtm/... · Parallels Python API Reference API Documentation September 16, 2009 Contents Contents

INDEX INDEX

prlsdkapi.VmSound.set output dev (method),56

prlsdkapi.VmToolsInfo (class), 93prlsdkapi.VmToolsInfo.get state (method),

93prlsdkapi.VmToolsInfo.get version (method),

93prlsdkapi.VmUsb (class), 54–55

prlsdkapi.VmUsb.get autoconnect option(method), 55

prlsdkapi.VmUsb.set autoconnect option(method), 55

305