[PDF] Parallels Python API Reference
[PDF] Parallels Python API Reference
[PDF] Parallels Python API Reference
You also want an ePaper? Increase the reach of your titles
YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.
Contents<br />
<strong>Parallels</strong> <strong>Python</strong> <strong>API</strong> <strong>Reference</strong><br />
<strong>API</strong> Documentation<br />
December 15, 2008<br />
Contents 1<br />
1 Package prlsdkapi 2<br />
1.1 Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2<br />
1.2 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2<br />
1.3 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3<br />
1.4 Class DeinitSDK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3<br />
1.4.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3<br />
1.4.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3<br />
1.4.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4<br />
1.5 Class PrlObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4<br />
1.5.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4<br />
1.5.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4<br />
1.6 Class PrlReadonlyAttrError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5<br />
1.6.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5<br />
1.6.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5<br />
1.7 Class PrlSDKError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6<br />
1.7.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6<br />
1.7.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6<br />
1.8 Class PrlSDKAsyncError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7<br />
1.8.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7<br />
1.8.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7<br />
1.9 Class PrlConstsProvider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8<br />
1.9.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8<br />
1.9.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9<br />
1.9.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9<br />
1.10 Class PrlIterator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9<br />
1.10.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9<br />
1.10.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10<br />
1.11 Class PrlResultIter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10<br />
1.11.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10<br />
1.11.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11<br />
1.12 Class Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11<br />
1.12.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11<br />
1.12.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17<br />
1.12.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17<br />
1.13 Class FoundVm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18<br />
1
CONTENTS CONTENTS<br />
1.13.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18<br />
1.13.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18<br />
1.13.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18<br />
1.14 Class LicenceInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19<br />
1.14.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19<br />
1.14.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19<br />
1.14.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20<br />
1.15 Class FSInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20<br />
1.15.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20<br />
1.15.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20<br />
1.15.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21<br />
1.16 Class FSEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21<br />
1.16.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21<br />
1.16.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22<br />
1.16.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22<br />
1.17 Class SrvConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22<br />
1.17.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23<br />
1.17.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23<br />
1.17.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24<br />
1.18 Class UserConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25<br />
1.18.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25<br />
1.18.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25<br />
1.18.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26<br />
1.19 Class DispConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26<br />
1.19.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27<br />
1.19.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28<br />
1.19.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29<br />
1.20 Class DispNet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29<br />
1.20.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29<br />
1.20.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30<br />
1.20.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30<br />
1.21 Class NetServiceStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31<br />
1.21.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31<br />
1.21.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31<br />
1.21.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31<br />
1.22 Class VmAccessRights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32<br />
1.22.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32<br />
1.22.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32<br />
1.23 Class Vm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32<br />
1.23.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33<br />
1.23.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44<br />
1.23.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48<br />
1.24 Class VmObjEmulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48<br />
1.24.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49<br />
1.24.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49<br />
1.25 Class VmVNCConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49<br />
1.25.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49<br />
1.25.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50<br />
1.25.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50<br />
1.26 Class VmDisplayDev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50<br />
1.26.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51<br />
2
CONTENTS CONTENTS<br />
1.26.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54<br />
1.26.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55<br />
1.27 Class VmBaseDev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55<br />
1.27.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55<br />
1.27.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57<br />
1.27.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57<br />
1.28 Class VmBaseDiskDev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58<br />
1.28.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58<br />
1.28.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58<br />
1.28.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59<br />
1.29 Class VmBasePortDev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59<br />
1.29.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59<br />
1.29.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60<br />
1.29.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60<br />
1.30 Class VmFloppyDev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61<br />
1.30.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61<br />
1.30.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61<br />
1.30.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62<br />
1.31 Class VmOpticalDev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62<br />
1.31.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62<br />
1.31.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63<br />
1.31.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63<br />
1.32 Class VmParallelPortDev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64<br />
1.32.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64<br />
1.32.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64<br />
1.32.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65<br />
1.33 Class VmHddDev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65<br />
1.33.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65<br />
1.33.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66<br />
1.33.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66<br />
1.34 Class VmNetDev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67<br />
1.34.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67<br />
1.34.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67<br />
1.34.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68<br />
1.35 Class VmSerialDev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68<br />
1.35.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69<br />
1.35.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69<br />
1.35.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69<br />
1.36 Class VmSoundDev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70<br />
1.36.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70<br />
1.36.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70<br />
1.36.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71<br />
1.37 Class VmUsbDev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71<br />
1.37.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71<br />
1.37.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72<br />
1.37.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72<br />
1.38 Class VmBootDev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73<br />
1.38.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73<br />
1.38.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73<br />
1.38.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74<br />
1.39 Class VmScrRes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74<br />
3
CONTENTS CONTENTS<br />
1.39.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74<br />
1.39.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75<br />
1.39.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75<br />
1.40 Class VmShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76<br />
1.40.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76<br />
1.40.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76<br />
1.40.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77<br />
1.41 Class VmStat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77<br />
1.41.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77<br />
1.41.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79<br />
1.41.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79<br />
1.42 Class VmCPUStat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80<br />
1.42.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80<br />
1.42.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80<br />
1.42.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80<br />
1.43 Class VmIFaceStat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81<br />
1.43.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81<br />
1.43.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81<br />
1.43.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82<br />
1.44 Class VmUserStat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82<br />
1.44.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82<br />
1.44.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82<br />
1.44.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83<br />
1.45 Class VmDiskStat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83<br />
1.45.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83<br />
1.45.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84<br />
1.45.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84<br />
1.46 Class VmDiskPartStat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84<br />
1.46.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84<br />
1.46.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85<br />
1.46.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85<br />
1.47 Class VmProcStat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85<br />
1.47.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85<br />
1.47.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86<br />
1.47.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86<br />
1.48 Class VmInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87<br />
1.48.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87<br />
1.48.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87<br />
1.48.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87<br />
1.49 Class VmToolsInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88<br />
1.49.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88<br />
1.49.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88<br />
1.49.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88<br />
1.50 Class SrvCfgDev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89<br />
1.50.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89<br />
1.50.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89<br />
1.50.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89<br />
1.51 Class SrvCfgNet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90<br />
1.51.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90<br />
1.51.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90<br />
1.51.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91<br />
4
CONTENTS CONTENTS<br />
1.52 Class SrvCfgHdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91<br />
1.52.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91<br />
1.52.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92<br />
1.52.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92<br />
1.53 Class SrvCfgHddPart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92<br />
1.53.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92<br />
1.53.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93<br />
1.53.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93<br />
1.54 Class SrvInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94<br />
1.54.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94<br />
1.54.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94<br />
1.54.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94<br />
1.55 Class LoginResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95<br />
1.55.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95<br />
1.55.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95<br />
1.55.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96<br />
1.56 Class RunningTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96<br />
1.56.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97<br />
1.56.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97<br />
1.56.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97<br />
1.57 Class UsrInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98<br />
1.57.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98<br />
1.57.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98<br />
1.57.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98<br />
2 Module prlsdkapi.prlsdk 100<br />
2.1 Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100<br />
2.2 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100<br />
2.3 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101<br />
2.4 Class Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101<br />
2.4.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101<br />
2.4.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102<br />
2.5 Class BaseAsync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102<br />
2.5.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103<br />
2.5.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103<br />
2.6 Class BaseServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104<br />
2.6.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104<br />
2.6.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106<br />
2.7 Class BaseVm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106<br />
2.7.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106<br />
2.7.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107<br />
2.8 Class Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107<br />
2.8.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108<br />
2.8.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109<br />
2.9 Class Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109<br />
2.9.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109<br />
2.9.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110<br />
2.10 Class OwnerRefAsync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111<br />
2.10.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111<br />
2.10.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111<br />
2.11 Class <strong>Parallels</strong>Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112<br />
2.11.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112<br />
5
CONTENTS CONTENTS<br />
2.11.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112<br />
2.12 Class PrlJobTimeoutError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113<br />
2.12.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113<br />
2.12.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113<br />
2.13 Class PrlNotImplError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114<br />
2.13.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114<br />
2.13.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114<br />
2.14 Class PrlStateError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115<br />
2.14.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115<br />
2.14.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115<br />
2.15 Class Question . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116<br />
2.15.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116<br />
2.15.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117<br />
2.16 Class Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117<br />
2.16.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117<br />
2.16.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118<br />
2.17 Class ServerInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119<br />
2.17.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119<br />
2.17.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119<br />
3 Module prlsdkapi.prlsdk.consts 121<br />
3.1 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121<br />
4 Module prlsdkapi.prlsdk.errors 135<br />
4.1 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135<br />
6
Package prlsdkapi<br />
1 Package prlsdkapi<br />
1.1 Modules<br />
• prlsdk (Section 2, p. 100)<br />
– consts (Section 3, p. 121)<br />
– errors (Section 4, p. 135)<br />
1.2 Functions<br />
bubble single char(x, y)<br />
prl sdk call prefix(prefix, meth name, object, *args)<br />
prl sdk call(meth name, object, *args)<br />
get prop doc (get func, set func)<br />
prl property(prop name, prefix=None, doc=None)<br />
prl to date time(dt string)<br />
prl datetime property(prop name, prefix=None, doc=None)<br />
prl iter property(count methname, index methodname, doc=None, arg1=None)<br />
GetClientConfig()<br />
get handle type(obj)<br />
get os type from version(os version)<br />
Determine and return OS type based on the specified OS version.<br />
Parameters<br />
os version: The version of the OS to get the type for. See<br />
consts.PVS GUEST VER xxx for the list of OS versions.<br />
Return Value<br />
A Result object containing the OS type as a string. See<br />
consts.PVS GUEST TYPE xxx for the list of OS types.<br />
prl indirect property(prop name, prefix=None, doc=None)<br />
prl sdk register objects (obj type list)<br />
7
Package prlsdkapi Class DeinitSDK<br />
1.3 Variables<br />
Name Description<br />
deinit sdk Value: DeinitSDK ()<br />
handle types constants for handle types<br />
Value: [’PHT ACCESS RIGHTS’, ’PHT BOOT DEVICE’,<br />
’PHT DISP CONFIG...<br />
device types constants for device types<br />
Value: [’PDE CLUSTERED DEVICE’,<br />
’PDE FLOPPY DISK’, ’PDE GENERIC ...<br />
key codes constants for scancodes<br />
Value: [’0’, ’1’, ’2’, ’3’, ’4’, ’5’, ’6’, ’7’,<br />
’8’, ’9’, ’A’, ’...<br />
key actions constants for key actions<br />
Value: [’PKE CLICK’, ’PKE PRESS’, ’PKE RELEASE’]<br />
DATE TIME SELECTOR Value:<br />
re.compile(r’([0-9]{4}-[0-9]{2}-[0-9]{2})?([T<br />
])?([0-9]{2...<br />
PRL DATETIME FMTS Value: (’%Y-%m-%d’, ’%H:%M:%S’, ’%Y-%m-%d<br />
%H:%M:%S’, ’%Y-%m-%dT%...<br />
1.4 Class DeinitSDK<br />
object<br />
1.4.1 Methods<br />
prlsdkapi. DeinitSDK<br />
init (self )<br />
x. init (...) initializes x; see x. class . doc for signature<br />
Overrides: object. init extit(inherited documentation)<br />
del (self )<br />
Inherited from object<br />
delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),<br />
repr (), setattr (), str ()<br />
1.4.2 Properties<br />
Name Description<br />
Inherited from object<br />
class<br />
8
Package prlsdkapi Class PrlObject<br />
1.4.3 Class Variables<br />
Name Description<br />
slots Value: ’prlsdk’<br />
1.5 Class PrlObject<br />
object<br />
prlsdkapi.PrlObject<br />
Known Subclasses: prlsdkapi.VmAccessRights, prlsdkapi.VmObjEmulation<br />
Base object class<br />
1.5.1 Methods<br />
Inherited from object<br />
delattr (), getattribute (), hash (), init (), new (), reduce (), reduce ex (),<br />
repr (), setattr (), str ()<br />
1.5.2 Properties<br />
Name Description<br />
Inherited from object<br />
class<br />
9
Package prlsdkapi Class PrlReadonlyAttrError<br />
1.6 Class PrlReadonlyAttrError<br />
object<br />
exceptions.BaseException<br />
exceptions.Exception<br />
exceptions.StandardError<br />
exceptions.AttributeError<br />
Exception class for readonly attributes<br />
1.6.1 Methods<br />
init (self, obj, prop name)<br />
prlsdkapi.PrlReadonlyAttrError<br />
x. init (...) initializes x; see x. class . doc for signature<br />
Overrides: object. init extit(inherited documentation)<br />
Inherited from exceptions.AttributeError<br />
new ()<br />
Inherited from exceptions.BaseException<br />
delattr (), getattribute (), getitem (), reduce (), repr (), setattr (),<br />
setstate (), str ()<br />
Inherited from object<br />
hash (), reduce ex ()<br />
1.6.2 Properties<br />
Name Description<br />
Inherited from exceptions.BaseException<br />
args, message<br />
Inherited from object<br />
class<br />
10
Package prlsdkapi Class PrlSDKError<br />
1.7 Class PrlSDKError<br />
object<br />
exceptions.BaseException<br />
exceptions.Exception<br />
prlsdkapi.prlsdk.<strong>Parallels</strong>Error<br />
Known Subclasses: prlsdkapi.PrlSDKAsyncError<br />
1.7.1 Methods<br />
prlsdkapi.PrlSDKError<br />
init (self, error code, call descr, message=’’)<br />
x. init (...) initializes x; see x. class . doc for signature<br />
Overrides: object. init extit(inherited documentation)<br />
get details(self )<br />
Inherited from exceptions.Exception<br />
new ()<br />
Inherited from exceptions.BaseException<br />
delattr (), getattribute (), getitem (), reduce (), repr (), setattr (),<br />
setstate (), str ()<br />
Inherited from object<br />
hash (), reduce ex ()<br />
1.7.2 Properties<br />
Name Description<br />
details<br />
Inherited from exceptions.BaseException<br />
args, message<br />
Inherited from object<br />
class<br />
11
Package prlsdkapi Class PrlSDKAsyncError<br />
1.8 Class PrlSDKAsyncError<br />
object<br />
exceptions.BaseException<br />
exceptions.Exception<br />
prlsdkapi.prlsdk.<strong>Parallels</strong>Error<br />
1.8.1 Methods<br />
init (self, job)<br />
prlsdkapi.PrlSDKError<br />
prlsdkapi.PrlSDKAsyncError<br />
x. init (...) initializes x; see x. class . doc for signature<br />
Overrides: object. init extit(inherited documentation)<br />
get details(self )<br />
Overrides: prlsdkapi.PrlSDKError.get details<br />
Inherited from exceptions.Exception<br />
new ()<br />
Inherited from exceptions.BaseException<br />
delattr (), getattribute (), getitem (), reduce (), repr (), setattr (),<br />
setstate (), str ()<br />
Inherited from object<br />
hash (), reduce ex ()<br />
1.8.2 Properties<br />
Name Description<br />
details<br />
Inherited from exceptions.BaseException<br />
args, message<br />
Inherited from object<br />
12<br />
continued on next page
Package prlsdkapi Class PrlConstsProvider<br />
class<br />
Name Description<br />
1.9 Class PrlConstsProvider<br />
object<br />
prlsdkapi.PrlConstsProvider<br />
Provide acces to constants group<br />
1.9.1 Methods<br />
init (self, source, consts prefix=’’, cmp func=None, doc=None)<br />
x. init (...) initializes x; see x. class . doc for signature<br />
Overrides: object. init extit(inherited documentation)<br />
getattr (self, name)<br />
getitem (self, name)<br />
get(self, name)<br />
Returns constant value by name<br />
Parameters<br />
name: Constant name, it could be without prexif<br />
Return Value<br />
Constant value, depends on constant type.<br />
get name(self, value, no err if notexists=True)<br />
Returns constant name by value<br />
Parameters<br />
value: Constant value<br />
no err if notexists: Shows if error should be raise for non<br />
exixting value<br />
Return Value<br />
string<br />
13
Package prlsdkapi Class PrlIterator<br />
repr (self )<br />
repr(x)<br />
Overrides: object. repr extit(inherited documentation)<br />
get list(self )<br />
Returns list of constants name<br />
Inherited from object<br />
delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),<br />
setattr (), str ()<br />
1.9.2 Properties<br />
Name Description<br />
Inherited from object<br />
class<br />
1.9.3 Class Variables<br />
Name Description<br />
slots Value: (’consts dict’, ’prefix’,<br />
’sort func’)<br />
1.10 Class PrlIterator<br />
object<br />
prlsdkapi.PrlIterator<br />
Known Subclasses: prlsdkapi.PrlResultIter<br />
Provide iterator and sequence behavior for sdk object<br />
1.10.1 Methods<br />
init (self, count getter, item getter, *args)<br />
x. init (...) initializes x; see x. class . doc for signature<br />
Overrides: object. init extit(inherited documentation)<br />
14
Package prlsdkapi Class PrlResultIter<br />
get count(self )<br />
getitem (self, index)<br />
iter (self )<br />
next(self )<br />
len (self )<br />
Inherited from object<br />
delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),<br />
repr (), setattr (), str ()<br />
1.10.2 Properties<br />
Name Description<br />
Inherited from object<br />
class<br />
1.11 Class PrlResultIter<br />
object<br />
prlsdkapi.PrlIterator<br />
1.11.1 Methods<br />
init (self, result obj)<br />
prlsdkapi.PrlResultIter<br />
x. init (...) initializes x; see x. class . doc for signature<br />
Overrides: object. init extit(inherited documentation)<br />
Inherited from prlsdkapi.PrlIterator(Section 1.10)<br />
getitem (), iter (), len (), get count(), next()<br />
Inherited from object<br />
15
Package prlsdkapi Class Server<br />
delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),<br />
repr (), setattr (), str ()<br />
1.11.2 Properties<br />
Name Description<br />
Inherited from object<br />
class<br />
1.12 Class Server<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseServer<br />
prlsdkapi.Server<br />
The Server class provides access to a <strong>Parallels</strong> Service. The class is required to use most of<br />
the functionality within the <strong>Parallels</strong> <strong>API</strong>.<br />
1.12.1 Methods<br />
begin edit common prefs(self )<br />
This method must be called before making any changes to the <strong>Parallels</strong><br />
Service common preferences (see DispConfig). When you are done making<br />
the changes, call DispConfig.commit to commit the changes.<br />
begin edit user profile(self )<br />
This method must be called before making any changes to a <strong>Parallels</strong> Service<br />
user profile. When you are done making the changes, call UserConfig.commit<br />
to commit the changes.<br />
create vm(self )<br />
Create and return a new Vm instance.<br />
Return Value<br />
A new instance of Vm.<br />
16
Package prlsdkapi Class Server<br />
register vm(self, vm path, non interactive mode=False)<br />
Register an existing virtual machine with the <strong>Parallels</strong> Service. This is an<br />
asynchronous method.<br />
Parameters<br />
vm path: Name and path of the virtual machine<br />
directory.<br />
non interactive mode: Set to True to use interactive mode. Set<br />
to False to use non-interactive mode.<br />
Return Value<br />
An instance of the Vm class containing information about the virtual<br />
machine that was registered.<br />
get vm list(self )<br />
Obtain and return a list of virtual machines from the host.<br />
Return Value<br />
A prlsdk.Result object containing a list of Vm instances. Individual<br />
Vm objects can be extracted using the prlsdk.Result.get param<br />
method.<br />
subscribe to host statistics(self )<br />
Subscribe to receive host statistics on a periodic basis. This is an<br />
asynchronous method.<br />
Return Value<br />
A Job object.<br />
unsubscribe from host statistics(self )<br />
Cancel the host statistics subscription that was started using the<br />
subscribe from host statistics method. This is an asynchronous method.<br />
Return Value<br />
A Job object.<br />
subscribe to perf stats(self )<br />
Subscribe to receive host perfomance statistics on a periodic basis. This is an<br />
asynchronous method.<br />
Return Value<br />
A Job object.<br />
17
Package prlsdkapi Class Server<br />
unsubscribe from perf stats(self )<br />
Cancel the host perfomance statistics subscription that was started using the<br />
subscribe to perf stats method. This is an asynchronous method.<br />
Return Value<br />
A Job object.<br />
get dir entries(self, path)<br />
Obtain and return the information about the specified file system entry on the<br />
host. This is an asynchronous method.<br />
Parameters<br />
path: The full path to the virtual machine directory.<br />
Return Value<br />
An instance of FSInfo containing the directory information.<br />
fs create dir(self, path)<br />
Create a new directory on the host. This is an asynchronous method.<br />
Parameters<br />
path: The new directory name and path.<br />
Return Value<br />
A Job object.<br />
fs remove dir(self, path)<br />
Remove the specified directory from the host. This is an asynchronous method.<br />
Parameters<br />
path: Name and path of the directory to remove.<br />
Return Value<br />
A Job object.<br />
fs can create file(self, file path)<br />
Determine if the current user has sufficient rights to create a file or a directory<br />
in the specified location on the host. This is an asynchronous method.<br />
Parameters<br />
file path: Name and path of the file to remove.<br />
Return Value<br />
An instance of the Job class containing the result. Success indicates<br />
that the user can create the specified file.<br />
18
Package prlsdkapi Class Server<br />
fs rename dir(self, path, new path)<br />
Rename the specified directory. This is an asynchronous method.<br />
Parameters<br />
path: Name and path of the directory to rename.<br />
new path: The new directory name and path.<br />
Return Value<br />
A Job object.<br />
update licence(self, key, user, company)<br />
Update the <strong>Parallels</strong> license. This is an asynchronous method.<br />
Parameters<br />
key: A string containing the license key.<br />
user: License user name.<br />
company: License company name.<br />
Return Value<br />
A Job object.<br />
send answer(self, answer event)<br />
Send an answer to the <strong>Parallels</strong> Service in response to a question. This is an<br />
asynchronous method.<br />
Parameters<br />
answer event: An Event object containing the answer.<br />
Return Value<br />
A Job object.<br />
search vms(self, vm list=None)<br />
Search for unregistered virtual machines at the specified location(s) on the<br />
host and return their information. This is an asynchronous method.<br />
Parameters<br />
vm list: A list of pathnames to search. Default value searches all<br />
available drives and directories.<br />
Return Value<br />
A Result object containing a list of FoundVm objects, each<br />
containing information about an individual virtual machine.<br />
19
Package prlsdkapi Class Server<br />
net service(self, operation=’u’)<br />
Allows to start, stop, or restart the <strong>Parallels</strong> network service. This is an<br />
asynchronous method.<br />
Parameters<br />
operation: Specifies the operation to perform. Possible values are:<br />
Return Value<br />
A Job object.<br />
’u’ - start network service.<br />
’d’ - stop network service.<br />
’r’ - restart network service.<br />
add network adapter(self, net adapter)<br />
Add a new virtual network adapter to the specified <strong>Parallels</strong> Service. This is<br />
an asynchronous method.<br />
Parameters<br />
net adapter: A DispNet object containing the new adapter<br />
information.<br />
Return Value<br />
A Job object.<br />
update network adapter(self, net adapter)<br />
Update the specified virtual network adapter in the <strong>Parallels</strong> Service. This is<br />
an asynchronous method.<br />
Parameters<br />
net adapter: A DispNet object containing the updated adapter<br />
information.<br />
Return Value<br />
A Job object.<br />
delete network adapter(self, net adapter)<br />
Delete the specified virtual network adapter from the <strong>Parallels</strong> Service<br />
configuration. This is an asynchronous method.<br />
Parameters<br />
net adapter: A DispNet object identifying the adapter to delete.<br />
Return Value<br />
A Job object.<br />
20
Package prlsdkapi Class Server<br />
attach to lost task(self, task uuid)<br />
The method allows to obtain a Job object attached to a running task after<br />
loosing a connection with the <strong>Parallels</strong> Service and reconnecting to it again.<br />
This is an asynchronous method.<br />
Parameters<br />
task uuid: The global task ID. The list of task IDs can be obtained<br />
from the LoginResponse object returned by the login<br />
operation.<br />
Return Value<br />
A Job object attached to the specified task.<br />
get unique fs entry name(self, path, fn prefix=’’, fn suffix=’’,<br />
index delim=’’)<br />
Automatically generates a unique name for a new directory. This is an<br />
asynchronous method.<br />
Parameters<br />
path: A full path to the target location (directory).<br />
fn prefix: Specifies a prefix to use in the directory name. Pass<br />
an empty string to use the default prefix ’tmpfile’.<br />
The name will be generated by adding a number to<br />
the prefix (e.g. tmpfile1, tmpfile2, etc.)<br />
fn suffix: Specifies a suffix to use in the directory name.<br />
index delim: A character(s) that will be inserted between the<br />
prefix and the index (e.g. tmpfile 1, tmpfile 2, etc).<br />
Return Value<br />
A Result object containing the name.<br />
get user info(self, user id)<br />
Return a UsrInfo class containing the information about the specified user.<br />
Parameters<br />
user id: The global ID of the user to get the information for.<br />
Return Value<br />
A UsrInfo object containing the user information.<br />
Inherited from prlsdkapi.prlsdk.BaseServer(Section 2.6)<br />
init (), new (), login(), login local(), logoff(), reg event handler(), shutdown(),<br />
unreg event handler()<br />
Inherited from prlsdkapi.prlsdk.Base(Section 2.4)<br />
21
Package prlsdkapi Class Server<br />
cmp (), repr ()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.12.2 Properties<br />
Name Description<br />
is local Indicates whether the current connection is<br />
local or remote: True - local connection; False -<br />
remote connection.<br />
licence info An instance of LicenceInfo.<br />
common prefs An instance of DispConfig.<br />
user profile An instance of UserConfig.<br />
statistics An instance of VmStat.<br />
fs disk list An instance of FSInfo.<br />
net service status An instance of NetServiceStatus.<br />
problem report A string containing a problem report in the<br />
event of a virtual machine operation failure.<br />
server config An instance of SrvConfig.<br />
server info An instance of SrvInfo.<br />
users info An instance of UsrInfo.<br />
questions A tuple of instances of Question.<br />
perf stats Returns an instance of Event containing the<br />
host perfomance statistics \.<br />
vm list Instance of Result containing Vm instances<br />
Inherited from prlsdkapi.prlsdk.BaseServer (Section 2.6)<br />
editing common , editing user , login result , autostart editing,<br />
connected, last session uuid, session uuid<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle , handle type<br />
Inherited from object<br />
class<br />
1.12.3 Class Variables<br />
Name Description<br />
prefix Value: ’srv’<br />
ht Value: 268435457<br />
22
Package prlsdkapi Class FoundVm<br />
1.13 Class FoundVm<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.FoundVm<br />
Contains summary information about a virtual machine.<br />
1.13.1 Methods<br />
Inherited from prlsdkapi.prlsdk.Base(Section 2.4)<br />
cmp (), init (), new (), repr ()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.13.2 Properties<br />
Name Description<br />
name Virtual machine name.<br />
os version Guest OS version.<br />
config path Name and path of the vitual machine directory.<br />
old config Indicates whether the virtual machine was<br />
created with an older version of a <strong>Parallels</strong><br />
virtualization product: True - older version;<br />
False - current version.<br />
template Indicates whether the virtual machine is a<br />
template: True - it is a template; False - it is a<br />
regular virtual machine.<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle , handle type<br />
Inherited from object<br />
class<br />
1.13.3 Class Variables<br />
Name Description<br />
prefix Value: ’foundvm’<br />
23<br />
continued on next page
Package prlsdkapi Class LicenceInfo<br />
Name Description<br />
ht Value: 268435506<br />
1.14 Class LicenceInfo<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
Contains the <strong>Parallels</strong> license information.<br />
1.14.1 Methods<br />
prlsdkapi.LicenceInfo<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), init (), new (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.14.2 Properties<br />
Name Description<br />
valid Indicates whether the license is valid: True -<br />
valid; False - invalid.<br />
license key A string containing the license key.<br />
user name A string containing the user name on the<br />
license.<br />
company name A string containing the company name on the<br />
license.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
24
Package prlsdkapi Class FSInfo<br />
1.14.3 Class Variables<br />
Name Description<br />
prefix Value: ’licinfo’<br />
ht Value: 268435495<br />
1.15 Class FSInfo<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.FSInfo<br />
Contains information about a file system entry and its immediate child elements (files and<br />
directories).<br />
1.15.1 Methods<br />
get entry(self, index)<br />
Return an FSEntry object containing information about a child file system<br />
element specified by index.<br />
Parameters<br />
index: The index of the child entry in the container (beginning with<br />
0). The total number of child entries can be determined by<br />
examining the FSInfo.entries count property.<br />
Return Value<br />
An FSEntry object containing the child entry information.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), init (), new (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.15.2 Properties<br />
25
Package prlsdkapi Class FSEntry<br />
Name Description<br />
type SDK.fs info get type(FSInfo) -> int<br />
Returns remote file system basic type:<br />
Windows or Unix like FS.<br />
entries count The number of child entries.<br />
parent entry An instance of FSEntry containing information<br />
about this file system entry.<br />
entries An iterator/sequence that allows to traverse<br />
through child files system entries. Each child<br />
entry is an instance of FSEntry.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.15.3 Class Variables<br />
Name Description<br />
prefix Value: ’fs info’<br />
ht Value: 268435459<br />
1.16 Class FSEntry<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.FSEntry<br />
Contains information about a file system entry. The instance of this class is obtained from<br />
the FSInfo object and can contain a parent file system entry information or the information<br />
about any of its child entries.<br />
1.16.1 Methods<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), init (), new (), repr (), cancel(), wait()<br />
26
Package prlsdkapi Class SrvConfig<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.16.2 Properties<br />
Name Description<br />
abs path The file system entry absolute path.<br />
relative name The file system entry relative name.<br />
size The file system entry size.<br />
permissions The file system entry permissions for the<br />
current user: ’r’ - read; ’w’ - write; ’x’ - execute.<br />
type The file system entry type (file, directory,<br />
drive). See consts.PSE xxx for the available<br />
types.<br />
last modified date The date on which the file system entry was<br />
last modified.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.16.3 Class Variables<br />
Name Description<br />
prefix Value: ’fs entry’<br />
ht Value: 268435460<br />
1.17 Class SrvConfig<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.SrvConfig<br />
Contains the host computer configuration information.<br />
27
Package prlsdkapi Class SrvConfig<br />
1.17.1 Methods<br />
get devices count(self, device type)<br />
Determine the total number of devices of the specified type installed in the<br />
host machine.<br />
Parameters<br />
device type: Device type. See consts.PDE xxx for the available<br />
types.<br />
get device(self, device type, index)<br />
Return an object containing information about a device specified by device<br />
type.<br />
Parameters<br />
device type: The type of the device to return the information for.<br />
See consts.PDE xxx for the available types.<br />
index: The index identifying the device instance (beginning<br />
with 0). To determine the number of the devices of<br />
the specified type available in the host machine, use<br />
SrvConfig.get devices count.<br />
Return Value<br />
An instance of a class corresponding to the specified device type.<br />
You can search this documentation for available device classes based<br />
on SrvCfgDev, etc.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), init (), new (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.17.2 Properties<br />
Name Description<br />
ram size The amount of memory (RAM) available on the<br />
host, in megabytes.<br />
cpu model The model of CPU on the host.<br />
cpu count The number of CPUs on the host.<br />
cpu speed The host CPU speed, in megahertz.<br />
cpu mode The CPU mode (32 bit or 64 bit).<br />
28<br />
continued on next page
Package prlsdkapi Class SrvConfig<br />
Name Description<br />
os version The host OS version information. This is a<br />
dictionary with the following elements:<br />
’type’ : string - OS type.<br />
’major’ : int - Major version number.<br />
’minor’: int - Minor version number.<br />
’sub minor’: int - Sub-minor version number.<br />
’full’: string - The full OS information as a<br />
single string.<br />
sound default enabled Determines whether a sound device on the host<br />
is enabled or disabled.<br />
usb supported Determines if USB is supported on the host.<br />
floppy devs An iterator/sequence that allows to traverse<br />
through FDD device instances. See SrvCfgDev.<br />
hdd devs An iterator/sequence that allows to traverse<br />
through HDD device instances. See SrvCfgHdd.<br />
optical devs An iterator/sequence that allows to traverse<br />
through optical disk device instances. See<br />
SrvCfgDev.<br />
parallel ports An iterator/sequence that allows to traverse<br />
through parallel port device instances. See<br />
SrvCfgDev.<br />
serial ports An iterator/sequence that allows to traverse<br />
through serial port device instances. See<br />
SrvCfgDev.<br />
sound devs An iterator/sequence that allows to traverse<br />
through sound device instances. See SrvCfgDev.<br />
usb devs An iterator/sequence that allows to traverse<br />
through USB device instances. See SrvCfgDev.<br />
net adapters An iterator/sequence that allows to traverse<br />
through net adapter device instances. See<br />
SrvCfgNet.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.17.3 Class Variables<br />
Name Description<br />
prefix Value: ’srvcfg’<br />
29<br />
continued on next page
Package prlsdkapi Class UserConfig<br />
Name Description<br />
ht Value: 268435458<br />
1.18 Class UserConfig<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.UserConfig<br />
Contains information about a <strong>Parallels</strong> Service user.<br />
1.18.1 Methods<br />
commit(self )<br />
Commit user profile changes to the <strong>Parallels</strong> Service. Every user profile<br />
modification must begin with the Server.begin edit user profile call and<br />
end with this call.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), init (), new (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.18.2 Properties<br />
Name Description<br />
dir uuid The Universally Unique Identifier (UUID) of<br />
the user.<br />
default folder Name and path of the default virtual machine<br />
directory for the user.<br />
can use mng console SDK.usrcfg get can use mng console(UserConfig)<br />
-> bool<br />
Returns sign whether user can using server<br />
management console utility.<br />
30<br />
continued on next page
Package prlsdkapi Class DispConfig<br />
Name Description<br />
can change srvcfg Indicates whether the user is allowed to modify<br />
<strong>Parallels</strong> Service preferences.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.18.3 Class Variables<br />
Name Description<br />
prefix Value: ’usrcfg’<br />
ht Value: 268435477<br />
1.19 Class DispConfig<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.prlsdk.OwnerRefAsync<br />
prlsdkapi.DispConfig<br />
The DispConfig class provides methods for managing <strong>Parallels</strong> Service preferences.<br />
31
Package prlsdkapi Class DispConfig<br />
1.19.1 Methods<br />
commit(self )<br />
Commit the changes to the <strong>Parallels</strong> Service.<br />
Before making any changes to <strong>Parallels</strong> Service preferences, call<br />
Server.begin edit common prefs to timestamp the beginning of the<br />
operation. When you are done making the changes, call this method to<br />
commit the changes to the <strong>Parallels</strong> Service. This is an asynchronous method.<br />
Return Value<br />
A Job object.<br />
create net adapter(self )<br />
Create and return a new virtual network adapter object and add it to the<br />
network adapter list.<br />
Return Value<br />
A new DispNet instance.<br />
get net adapter(self, index)<br />
Return information about the specified virtual network adapter.<br />
Parameters<br />
index: The index specifying the net adapter in the adapter list. To<br />
obtain the total number of the available adapters, examine<br />
the DispConfig.net adapters count property.<br />
Return Value<br />
A DispNet object containing the specified virtual network adapter<br />
information.<br />
remove net adapter(self, net adapter)<br />
Remove the specified virtual network adapter object from the adapter list.<br />
Parameters<br />
net adapter: Identifies the network adapter. This could be a<br />
DispNet object or the adapter’s index in the list.<br />
This is an asynchronous method.<br />
Return Value<br />
A Job object.<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync(Section 2.10)<br />
init (), new ()<br />
32
Package prlsdkapi Class DispConfig<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.19.2 Properties<br />
Name Description<br />
auto mem adjust Specifies whether the size of the memory<br />
allocated to the <strong>Parallels</strong> Service will be set<br />
automatically or manually.<br />
default vm dir Name and path of the default virtual machine<br />
folder.<br />
reserved mem limit Specifies the memory size reserved for the<br />
<strong>Parallels</strong> Service operations<br />
net adapters count The total number of the available netwrok<br />
adapters.<br />
default vnc host name The default VNC host name of this <strong>Parallels</strong><br />
Service.<br />
vnc base port The base VNC port number.<br />
can change default settings<br />
Indicates whether new users are by default<br />
allowed to modify the <strong>Parallels</strong> Service<br />
preferences. True - can modify; False - cannot<br />
modify.<br />
min security level Indicates the lowest allowable security level<br />
that can be used to connect to this <strong>Parallels</strong><br />
Service. See consts.PSL xxx for available<br />
security levels.<br />
net adapters An iterator/sequence that allows to traverse<br />
through network adapter collection. Each<br />
network adapter is an instance of DispNet.<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync (Section 2.10)<br />
owner<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
33
Package prlsdkapi Class DispNet<br />
1.19.3 Class Variables<br />
Name Description<br />
prefix Value: ’dispcfg’<br />
ht Value: 268435478<br />
1.20 Class DispNet<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.prlsdk.OwnerRefAsync<br />
prlsdkapi.DispNet<br />
Contains information about a virtual network adapter.<br />
1.20.1 Methods<br />
remove(self )<br />
Remove this object from memory.<br />
This method does not delete the adapter from the <strong>Parallels</strong> Service<br />
configuration. Use this method if you would like to cancel the changes that<br />
you’ve made to the object properties so far. The method must be called before<br />
calling DispConfig.commit. To delete an existing adapter from the<br />
configuration, use the DispConfig.remove net adapter method.<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync(Section 2.10)<br />
init (), new ()<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
34
Package prlsdkapi Class DispNet<br />
1.20.2 Properties<br />
Name Description<br />
enabled Indicates whether the adapter is enabled. True<br />
- enabled; False - disabled.<br />
dhcp enabled Inidicates whether DHCP scope is enabled for<br />
the specified virtual network adapter. True -<br />
enabled; False - disabled.<br />
network type Indicates the virtual network adapter network<br />
type. See consts.PNA xxx for the available<br />
network types.<br />
name The adapater name.<br />
uuid The adapter UUID.<br />
sys name The name of the physical network adapter to<br />
which the specified virtual network adapter is<br />
bound.<br />
index An index identifying in the <strong>Parallels</strong> Service.<br />
dhcp scope start The start IP address of DHCP scope for the<br />
adapter.<br />
dhcp scope end The end IP address of DHCP scope for the<br />
adapter.<br />
dhcp scope mask The subnet mask of DHCP scope for the<br />
adapter.<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync (Section 2.10)<br />
owner<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.20.3 Class Variables<br />
Name Description<br />
prefix Value: ’dispnet’<br />
ht Value: 268435481<br />
35
Package prlsdkapi Class NetServiceStatus<br />
1.21 Class NetServiceStatus<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.NetServiceStatus<br />
Contains the <strong>Parallels</strong> Service network status information.<br />
1.21.1 Methods<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), init (), new (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.21.2 Properties<br />
Name Description<br />
status Network service status. See consts.PSS xxx<br />
for status list.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.21.3 Class Variables<br />
Name Description<br />
prefix Value: ’netsvc’<br />
ht Value: 268435501<br />
36
Package prlsdkapi Class Vm<br />
1.22 Class VmAccessRights<br />
object<br />
prlsdkapi.PrlObject<br />
1.22.1 Methods<br />
init (self, dict=None)<br />
prlsdkapi.VmAccessRights<br />
x. init (...) initializes x; see x. class . doc for signature<br />
Overrides: object. init extit(inherited documentation)<br />
Inherited from object<br />
delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),<br />
repr (), setattr (), str ()<br />
1.22.2 Properties<br />
Name Description<br />
current is owner<br />
others rights<br />
owner<br />
owner rights<br />
Inherited from object<br />
class<br />
1.23 Class Vm<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.prlsdk.BaseVm<br />
prlsdkapi.Vm<br />
37
Package prlsdkapi Class Vm<br />
The Vm class provides methods for managing virtual machines. Whenever you want to get<br />
the information about, modify, or create a virtual machine, you have to obtain an instance<br />
of this class. The instance can be obtained using methods of verious classes. The two main<br />
methods that return an instance of Vm areServer.create vm and theServer.get vm list.<br />
1.23.1 Methods<br />
get default settings(os version, ram size=0)<br />
init (self, *args)<br />
x. init (...) initializes x; see x. class . doc for signature<br />
Overrides: object. init extit(inherited documentation)<br />
execution(self, operation, use acpi=False)<br />
Perform the specified operation on the virtual machine. This is an<br />
asynchronous method<br />
Parameters<br />
operation: ’u’(up); ’d’(down); ’p’(pause); ’r’(reset); ’s’(suspend);<br />
’e’(resume).<br />
use acpi: Specifies if ACPI should be used. Used only with down<br />
and pause operations. True - use ACPI; False - don’t<br />
use ACPI.<br />
Return Value<br />
A Job object.<br />
start(self )<br />
Start the virtual machine. This is an asynchronous method.<br />
Return Value<br />
A Job object.<br />
stop(self, acpi=False)<br />
Stop the virtual machine. This is an asynchronous method<br />
Return Value<br />
A Job object.<br />
38
Package prlsdkapi Class Vm<br />
pause(self, acpi=False)<br />
Pause the virtual machine. This is an asynchronous method.<br />
Return Value<br />
A Job object.<br />
reset(self )<br />
Reset the virtual machine (stop then start; ACPI will not be used). This is an<br />
asynchronous method.<br />
Return Value<br />
A Job object.<br />
suspend(self )<br />
Suspend the virtual machine. This is an asynchronous method<br />
Return Value<br />
A Job object.<br />
resume(self )<br />
Resume the virtual machine. This is an asynchronous method<br />
Return Value<br />
A Job object.<br />
drop suspended state(self )<br />
Drop suspended state; delete all temporary files from the hard drive. This is<br />
an asynchronous method.<br />
Return Value<br />
A Job object.<br />
39
Package prlsdkapi Class Vm<br />
clone(self, new name, root path, template=False)<br />
Clone the virtual machine. If this is a template, create a regular virtual<br />
machine from it. This is an asynchronous method.<br />
Parameters<br />
new name: The name to use for the new virtual machine.<br />
root path: Name and path of the directory where the new virtual<br />
machine should be created. To create the machine in a<br />
default directory, pass an empty string.<br />
template: Specifies whether the clone should be created as a<br />
virtual machine or as a template. True - create a<br />
template; False - create a regular virtual machine.<br />
When creating a virtual machine from a template, set<br />
the parameter value to False.<br />
Return Value<br />
A Job object.<br />
delete(self, dev list=None)<br />
Delete the virtual machine from the host. This is an asynchronous method.<br />
Parameters<br />
dev list: Files and directories to be deleted from the virtual<br />
machine directory. If none specified, delete the entire<br />
directory.<br />
Return Value<br />
A Job object.<br />
set default config(self, srv config, os version, create devices)<br />
Automatically select and set a default configuration for the new virtual<br />
machine based on the operating system that the virtual machine will be<br />
running.<br />
Parameters<br />
srv config: An instance of SrvConfig containing the host<br />
machine configuration information.<br />
os version: The version of the operating system that the<br />
virtual machine will be running. See<br />
PVS GUEST VER xxx for available options.<br />
create devices: A flag indicating whether default virtual machine<br />
devices should be created or not. True - create<br />
devices; False - don’t create.<br />
40
Package prlsdkapi Class Vm<br />
add default device(self, srv config, type)<br />
Adds a virtual device to the virtual machine. The method provides an easy<br />
way of setting devices in a virtual machine by automatically setting all the<br />
necessary device properties.<br />
Parameters<br />
srv config: An instance of SrvConfig containing the host machine<br />
configuration information.<br />
type: The type of the device to add. See {consts.PDE xxx}<br />
for available options.<br />
subscribe to guest statistics(self )<br />
Subscribe to receive the virtual machine guest statistics on a periodic basis.<br />
This is an asynchronous method.<br />
Return Value<br />
A Job object.<br />
unsubscribe from guest statistics(self )<br />
Cancel subscriptions started by subscribe to guest statistics method.<br />
This is an asynchronous method.<br />
Return Value<br />
A Job object.<br />
subscribe to perf stats(self )<br />
Subscribe to receive virtual machine perfomance statistics on a periodic basis.<br />
This is an asynchronous method.<br />
Return Value<br />
A Job object.<br />
unsubscribe from perf stats(self )<br />
Cancel subscriptions started by subscribe to perf stats method.<br />
This is an asynchronous method.<br />
Return Value<br />
A Job object.<br />
41
Package prlsdkapi Class Vm<br />
reg(self, config path, non interactive mode=False)<br />
Create a new virtual machine and register it with the <strong>Parallels</strong> Service. This is<br />
an asynchronous method.<br />
Parameters<br />
config path: Name and path of the parent directory<br />
where you would like to create the new<br />
virtual machine directory. Pass an empty<br />
string to create a directory in the default<br />
location for this <strong>Parallels</strong> Service.<br />
non interactive mode: True - use interactive mode; False - use<br />
non-interactive mode.<br />
Return Value<br />
A {job} object.<br />
unreg(self )<br />
Unregister the virtual machine from the <strong>Parallels</strong> Service. The method<br />
removes the virtual machine from the <strong>Parallels</strong> Service registry, but does not<br />
delete the virtual machine files from the hard drive.<br />
This is an asynchronous method.<br />
Return Value<br />
A Job object.<br />
change access rights(self, others right=None)<br />
Modify the virtual machine security settings. This is an asynchronous method.<br />
Parameters<br />
others right: Specifies access rights that users of this <strong>Parallels</strong><br />
Service will have to this virtual machine. The owner<br />
of the virtual machine has full access rights and is<br />
not affected by this functionality. See<br />
consts.PAO VM xxx for available options.<br />
Return Value<br />
A Job object.<br />
42
Package prlsdkapi Class Vm<br />
begin edit(self )<br />
Timestamp the beginning of the virtual machine editing operation. This<br />
method must be called before making any modifications to the virtual machine<br />
configuration. When the desired configuration properties are set, call<br />
Vm.commit to commit the changes to the <strong>Parallels</strong> Service. The two functions<br />
are used to detect collisions with other clients trying to modify the same<br />
virtual machine at the same time.<br />
This is an asynchronous method.<br />
Return Value<br />
A Job object.<br />
commit(self )<br />
Commit the virtual machine configuration changes to the <strong>Parallels</strong> Service.<br />
This is an asynchronous method.<br />
Return Value<br />
A Job object.<br />
refresh config(self )<br />
update config(self )<br />
This method is obsolete and is left for backward compatibility only.<br />
create device(self, device type)<br />
Create and return a new virtual device object based on the specified device<br />
type. Each virtual machine device type has a corresponding class in the<br />
<strong>Parallels</strong> Service <strong>Python</strong> <strong>API</strong>. You can search this documentation for available<br />
virtual device classes using the following rule: a class name begins with ’Vm’<br />
followed by the device type description followed by ’Dev’. For example:<br />
VmHddDev, VmNetDev, VmSoundDev, etc.<br />
Parameters<br />
device type: Device type. Based on the type specified here, an<br />
instance of the corresponding class will be created.<br />
See consts.PDE xxx for available options.<br />
Return Value<br />
An instance of the requested class.<br />
43
Package prlsdkapi Class Vm<br />
get devices count(self, device type)<br />
Determine the total number of devices of the specified type installed in the<br />
virtual machine.<br />
Parameters<br />
device type: Device type. See consts.PDE xxx for the available<br />
types.<br />
get device(self, device type, index)<br />
Return an object containing information about a device specified by device<br />
type.<br />
Parameters<br />
device type: The type of the device to return the information for.<br />
See consts.PDE xxx for the available types.<br />
index: The index identifying the device instance (beginning<br />
with 0). To determine the number of the devices of<br />
the specified type available in the virtual machine,<br />
use Vm.get devices count.<br />
Return Value<br />
An instance of a class corresponding to the specified device type.<br />
You can search this documentation for available virtual device<br />
classes using the following rule: a class name begins with ’Vm’<br />
followed by the device type description followed by ’Dev’. For<br />
example: VmHddDev, VmNetDev, VmSoundDev, etc.<br />
get floppy(self, index)<br />
Return information about a floppy device specified by index.<br />
Parameters<br />
index: The index of the FDD device instance. Use Vm.floppy devs<br />
to obtain the FDD device count.<br />
Return Value<br />
An instance of VmFloppyDev.<br />
get hdd(self, index)<br />
Return information about a hard disk specified by index.<br />
Parameters<br />
index: The index of the HDD device instance. Use Vm.hdd devs to<br />
obtain the HDD device count.<br />
Return Value<br />
An instance of VmHddDev.<br />
44
Package prlsdkapi Class Vm<br />
get optical(self, index)<br />
Return information about an optical disk specified by index.<br />
Parameters<br />
index: The index of the optical disk device instance. Use<br />
Vm.optical devs to obtain the optical disk device count.<br />
Return Value<br />
An instance of VmOpticalDev.<br />
get parallel port(self, index)<br />
Return information about a parallel port specified by index.<br />
Parameters<br />
index: The index of the parallel port device instance. Use<br />
Vm.parallel ports to obtain the device count.<br />
Return Value<br />
An instance of VmParallelPortDev.<br />
get serial port(self, index)<br />
Return information about a serial port specified by index.<br />
Parameters<br />
index: The index of the serial port device instance. Use<br />
Vm.serial ports to obtain the device count.<br />
Return Value<br />
An instance of VmSerialDev.<br />
get sound dev(self, index)<br />
Return information about a sound device specified by index.<br />
Parameters<br />
index: The index of the sound device instance. Use Vm.sound devs<br />
to obtain the sound device count.<br />
Return Value<br />
An instance of VmSoundDev.<br />
45
Package prlsdkapi Class Vm<br />
get usb dev(self, index)<br />
Return information about a USB device specified by index.<br />
Parameters<br />
index: The index of the USB device instance. Use Vm.usb devs to<br />
obtain the USB device count.<br />
Return Value<br />
An instance of VmUsbDev.<br />
get net adapter(self, index)<br />
Return information about a network adapter specified by index.<br />
Parameters<br />
index: The index of the network adapter instance. Use<br />
Vm.net adapters to obtain the net adapter device count.<br />
Return Value<br />
An instance of VmNetDev.<br />
create share(self )<br />
Create a new instance of VmShare.<br />
Return Value<br />
A new instance of VmShare.<br />
get share(self, index)<br />
Return information about a shared folder specified by index.<br />
Parameters<br />
index: The index identifying the shared folder instance. Use<br />
Vm.shares to obtain the shared folder instance count.<br />
Return Value<br />
An instance of VmShare.<br />
create scr res(self )<br />
get scr res(self, index)<br />
Return screen resolution by index.<br />
Parameters<br />
index: A numeric index identifying the resolution.<br />
Return Value<br />
An instance of VmScrRes.<br />
46
Package prlsdkapi Class Vm<br />
reg event handler(self, data)<br />
unreg event handler(self, data)<br />
create boot dev(self )<br />
Create a new instance of VmBootDev.<br />
Return Value<br />
A new instance of VmBootDev.<br />
get boot dev(self, index)<br />
Return information about a boot device specified by index.<br />
Parameters<br />
index: The index of the boot device. Use Vm.boot devs to obtain<br />
the boot device count.<br />
Return Value<br />
An instance of VmBootDev.<br />
create event(self )<br />
create unattended floppy(self, guest distro type, username, company name,<br />
serial key)<br />
Create a floppy disk image in the virtual machine home directory for<br />
unattended Windows installation. This is an asynchronous method.<br />
Parameters<br />
guest distro type: Windows version.<br />
username: User name.<br />
company name: Company name.<br />
serial key: Serial number.<br />
Return Value<br />
A Job object.<br />
initiate dev state notifications(self )<br />
send utility command(self, cmd, flags, buffer)<br />
set clipboard(self, buffer)<br />
get weak objects(self )<br />
47
Package prlsdkapi Class Vm<br />
get display dev(self )<br />
install tools(self )<br />
Launch the <strong>Parallels</strong> Tools installation program. This is an asynchronous<br />
function.<br />
Return Value<br />
A Job object.<br />
generate device filename(self, fn prefix=’’, fn suffix=’’, index delim=’’)<br />
Generate a unique name for a virtual device file that will be unique within the<br />
home directory of the virtual machine. This is an asynchronous function.<br />
Parameters<br />
fn prefix: A prefix to add to the name. Pass an empty string to<br />
use the default value: ”tmpfile”. The name will be<br />
generated by adding a numeric index to the prefix<br />
(e.g. tmpfile1, tmpfile2, tmpfile3, etc.)<br />
fn suffix: A suffix to add to the name. Pass an empty string for<br />
no suffix.<br />
index delim: A substring that will be inserted between the prefix<br />
and the numeric index. For example, if you specify<br />
an underscore character ’ ’ and use the default values<br />
for other parameters, the names will look like this:<br />
tmpfile 1, tmpfile 2, tmpfile 3, etc. Specify an empty<br />
string if you don’t want to insert any extra<br />
characters.<br />
Return Value<br />
A Job object.<br />
tools send shutdown(self, kind=0)<br />
Gracefully shutdown the virtual machine.<br />
Parameters<br />
kind: Shutdown option. See consts.PST VM xxx for available<br />
options.<br />
48
Package prlsdkapi Class Vm<br />
validate config(self, section)<br />
Validate the specified section of the virtual machine configuration. This is an<br />
asynchronous function.<br />
Parameters<br />
section: The name of the section of the virtual machine<br />
configuration. See consts.PVC xxx for available options.<br />
Return Value<br />
A Job object.<br />
Inherited from prlsdkapi.prlsdk.BaseVm(Section 2.7)<br />
new ()<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.23.2 Properties<br />
Name Description<br />
problem report Contains a problem report in the event of an<br />
abnormal virtual machine termination.<br />
state An instance of VmInfo.<br />
statistics An instance of VmStat.<br />
shares count The number of shared folders in a virtual<br />
machine.<br />
scr res count vm.get scr res count(Vm) -> int<br />
Returns VM screen resolutions count.<br />
boot dev count The number of devices in the virtual machine<br />
boot device priority list.<br />
name The virtual machine name.<br />
uuid The virtual machine universally unique ID.<br />
os type The type of the OS the virtual machine is<br />
running.<br />
os version The version of the OS that the virtual machine<br />
is running.<br />
ram size The amount of memory in the virtual machine.<br />
video ram size The amount of video memory in the machine.<br />
cpu count The number of CPUs in the virtual machine.<br />
49<br />
continued on next page
Package prlsdkapi Class Vm<br />
Name Description<br />
cpu mode CPU mode (32 bit or 64 bit). See<br />
consts.PCM CPU xxx.<br />
cpu accel level CPU acceleration level. See consts.PVA xxx.<br />
cpu vtx enabled vm.get cpu vtx enabled(Vm) -> bool<br />
Returns Virtual Machine CPU VTx support<br />
enabling sign.<br />
server uuid Universally unique ID of the host machine.<br />
server host Host machine name (hostname).<br />
home path The virtual machine home directory name and<br />
path.<br />
icon vm.set icon(Vm, new vm icon)<br />
Sets Virtual Machine icon.<br />
description The virtual machine description.<br />
template Determines whether the virtual machine is a<br />
template or a regular virtual machine. True -<br />
template; False - regular virtual machine.<br />
auto start Determines whether the virtual machine starts<br />
automatically on host machine boot. True -<br />
start automatically; False - don’t start.<br />
window mode vm.set window mode(Vm, vm window mode)<br />
Sets Virtual Machine window mode.<br />
last modifier name The name of the user who modified the virtual<br />
machine the last time.<br />
guest sharing enabled Determines whether guest sharing is enabled<br />
(the guest OS disk drives are visible in the host<br />
OS). True - enabled; False - disabled.<br />
guest sharing auto mount Determines whether the host shared folders are<br />
mounted automatically in the virtual machine.<br />
True - mount automatically; False - don’t<br />
mount.<br />
host sharing enabled Determines whether host sharing is enabled<br />
(host shared folders are visible in the guest<br />
OS). True - enabled; False - disabled.<br />
show task bar Determines whether the Windows task bar is<br />
displayed when the virtual machine runs in<br />
coherence mode. True - task bar is enabled;<br />
False - task bar is disabled.<br />
relocate task bar Determines whether the Windows ’task bar<br />
relocation’ feature is enabled in a virtual<br />
machine when it runs in the coherence mode.<br />
True - enabled; False - disabled.<br />
50<br />
continued on next page
Package prlsdkapi Class Vm<br />
Name Description<br />
exclude dock Determines the guest OS window behavior in<br />
coherence mode. True - don’t redraw the<br />
portion of the window that moved below the<br />
dock; False - redraw the entire window.<br />
multi display vm.set multi display(Vm, vm multi display)<br />
Sets Virtual Machine multi display sign<br />
coherence option.<br />
scr res enabled vm.set scr res enabled(Vm, vm scr res enabled)<br />
Sets Virtual Machine additional screen<br />
resolutions support enabling sign.<br />
disk cache write back Determines if disk cache write-back is enabled<br />
for this virtual machine. True - enabled; False -<br />
disabled.<br />
os res in full scr mode Determines if the guest OS screen resolution in<br />
full-screen mode is enabled or disabled. True -<br />
enabled; False - disabled.<br />
close app on shutdown vm.set close app on shutdown(Vm,<br />
close app on shutdown)<br />
Sets Virtual Machine close app on shutdown<br />
sign.<br />
system flags vm.set system flags(Vm, new vm system flags)<br />
Sets Virtual Machine system flags.<br />
app in dock mode Determines the dock mode. See<br />
consts.PDM APP IN xxx for available options.<br />
foreground priority Determines foreground process priority. See<br />
consts.PVR PRIORITY xxx for available<br />
options.<br />
background priority Determines background process priority. See<br />
PVR PRIORITY xxx for available options.<br />
dock icon type Determines the virtual machine dock icon type.<br />
See consts.PIT DOCK ICON xxx for available<br />
options.<br />
tools info vm.get tools info(Vm) -> VmToolsInfo<br />
Extracts VM Tools descriptor<br />
auto start delay Determines the time delay used during the<br />
virtual machine automatic startup, in seconds.<br />
start login mode Determines the automatic startup login mode.<br />
See PLM xxx for available options.<br />
start user login Determines the name of the user which will be<br />
used during the virtual machine automatic<br />
startup.<br />
51<br />
continued on next page
Package prlsdkapi Class Vm<br />
Name Description<br />
auto stop Determines the automatic shutdown mode for<br />
the virtual machine. See consts.PAO VM xxx<br />
for available options.<br />
questions vm.get questions(Vm) -> QuestionsList<br />
This method is an alternative for working with<br />
questions synchronically<br />
last modified date Determines the date and time when the<br />
specified virtual machine was last modified.<br />
perf stats Returns virtual machine perfomance statistics<br />
in instance of Event.<br />
user defined shared folder- Indicates whether user shared folders is<br />
s enabled<br />
enabled. True - enabled; False - disabled.<br />
access rights Returns an instance of VmAccessRights.<br />
floppy devs An iterator/sequence that allows to traverse<br />
through FDD device instances. See<br />
VmFloppyDev.<br />
hdd devs An iterator/sequence that allows to traverse<br />
through HDD device instances. See VmHddDev.<br />
optical devs An iterator/sequence that allows to traverse<br />
through optical disk device instances. See<br />
VmOpticalDev.<br />
parallel ports An iterator/sequence that allows to traverse<br />
through parallel port device instances. See<br />
VmParallelPortDev.<br />
serial ports An iterator/sequence that allows to traverse<br />
through serial port device instances. See<br />
VmSerialDev.<br />
sound devs An iterator/sequence that allows to traverse<br />
through sound device instances. See<br />
VmSoundDev.<br />
usb devs An iterator/sequence that allows to traverse<br />
through USB device instances. See VmUsbDev.<br />
net adapters An iterator/sequence that allows to traverse<br />
through net adapter device instances. See<br />
VmNetDev.<br />
floppy count The number of the available FDD devices.<br />
hdd count The number of the available HDD devices.<br />
optical count The number of the available optical disk<br />
devices.<br />
parallel port count The number of the available parallel port<br />
devides.<br />
serial port count The number of the available serial port devices.<br />
52<br />
continued on next page
Package prlsdkapi Class VmObjEmulation<br />
Name Description<br />
sound dev count The number of the available sound devices.<br />
usb dev count The number of the available USB devices.<br />
net adapter count The number of the available net adapter<br />
devices.<br />
shares An iterator/sequence that allows to traverse<br />
through shared folder instances. See VmShare.<br />
src ress An iterator that allows to traverse through<br />
VmScrRes instances.<br />
boot devs An iterator/sequence that allows to traverse<br />
through boot device instances. See VmBootDev.<br />
display dev<br />
vnc config An instance of VmVNCConfig.<br />
Inherited from prlsdkapi.prlsdk.BaseVm (Section 2.7)<br />
editing , unfin op , autostart editing<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.23.3 Class Variables<br />
Name Description<br />
prefix Value: ’vm’<br />
ht Value: 268435461<br />
1.24 Class VmObjEmulation<br />
object<br />
prlsdkapi.PrlObject<br />
prlsdkapi.VmObjEmulation<br />
Known Subclasses: prlsdkapi.VmDisplayDev, prlsdkapi.VmVNCConfig<br />
53
Package prlsdkapi Class VmVNCConfig<br />
1.24.1 Methods<br />
init (self, vm)<br />
x. init (...) initializes x; see x. class . doc for signature<br />
Overrides: object. init extit(inherited documentation)<br />
ensure attr (self )<br />
inderect self(self )<br />
call vm(self, method, *args)<br />
safe call(self, method, *args)<br />
Inherited from object<br />
delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),<br />
repr (), setattr (), str ()<br />
1.24.2 Properties<br />
Name Description<br />
Inherited from object<br />
class<br />
1.25 Class VmVNCConfig<br />
object<br />
prlsdkapi.PrlObject<br />
prlsdkapi.VmObjEmulation<br />
prlsdkapi.VmVNCConfig<br />
Contains VNC properties of a virtual machine.<br />
1.25.1 Methods<br />
Inherited from prlsdkapi.VmObjEmulation(Section 1.24)<br />
54
Package prlsdkapi Class VmDisplayDev<br />
ensure attr (), init (), call vm(), inderect self(), safe call()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),<br />
repr (), setattr (), str ()<br />
1.25.2 Properties<br />
Name Description<br />
mode The VNC mode. See consts.PRD xxx for<br />
available modes.<br />
host name The VNC hostname.<br />
port The VNC port number.<br />
password The VNC password.<br />
Inherited from object<br />
class<br />
1.25.3 Class Variables<br />
Name Description<br />
prefix Value: ’vm vnc’<br />
1.26 Class VmDisplayDev<br />
object<br />
prlsdkapi.PrlObject<br />
prlsdkapi.VmObjEmulation<br />
prlsdkapi.VmDisplayDev<br />
TheVmDisplayDev class provides methods for remote capture of screen shots of a virtual machine<br />
desktop and for sending keyboard and mouse commands to it. With this functionality,<br />
you can programmatically connect to a remote virtual machine and run its applications as<br />
if you were sitting at the virtual machine’s console. The typical usage of the Remote Desktop<br />
Access functionality is creating automation scripts for unattended operating system and<br />
other software installations.<br />
There are four groups of functions comprising the Remote Desktop Access <strong>API</strong> :<br />
• Primary display capture. These functions allow to capture a region or an entire screen<br />
55
Package prlsdkapi Class VmDisplayDev<br />
of the remote virtual machine. In scripts, you can take a snapshot of a particular screen<br />
in advance and then compare it to the screen captured at runtime. If comparison<br />
operation determines that you’ve got the screen of interest, you can interact with it by<br />
sending mouse or keyboard commands (pressing buttons, making selections, etc.).<br />
• Secondary display capture. This group of functions is almost identical to the Primary<br />
Display Capture group with the exception that it operates on a secondary display(s) if<br />
one is installed in a virtual machine.<br />
• Mouse control. These functions provide control over the mouse in a virtual machine.<br />
You can change the position of the mouse pointer, press and release mouse buttons,<br />
and use a scroll wheel. In scripts, you can move a mouse pointer to the coordinates you<br />
know in advance (coordinates of a button, an edit control, etc.) and perform an action.<br />
• Keyboard control. These functions simply send a key/action code combination to the<br />
virtual machine. In scripts, you can use these functions to interact with controls on a<br />
window opened inside the virtual machine (pressing buttons, selecting options, etc.).<br />
In a typical GUI application, essential visual controls usually have keyboard shortcuts<br />
(accelerator keys) assigned to them. If a control doesn’t have a shortcut, then you will<br />
have to use mouse control functions to position a mouse pointer over the control to<br />
select it.<br />
For more information and code samples, please see <strong>Parallels</strong> Virtualization SDK Programmer’s<br />
Guide.<br />
1.26.1 Methods<br />
init (self, vm)<br />
x. init (...) initializes x; see x. class . doc for signature<br />
Overrides: object. init extit(inherited documentation)<br />
del (self )<br />
ensure attr (self )<br />
Overrides: prlsdkapi.VmObjEmulation. ensure attr<br />
engage job(self, job)<br />
check connected(self )<br />
56
Package prlsdkapi Class VmDisplayDev<br />
connect to vm(self )<br />
Connects to a virtual machine to begin a remote desktop access session. This<br />
is an asynchronous method.<br />
Return Value<br />
A Job object.<br />
disconnect from vm(self )<br />
Ends a remote desktop access session that was started with connect to vm.<br />
get screen buffer(self )<br />
Returns the contents of the screen buffer of the primary display. The screen<br />
data is always returned as 32-bit RGBA with the alpha channel containing the<br />
value of 0.<br />
Return Value<br />
A buffer object containing the screen data.<br />
send screen size event(self, width, height, depth)<br />
Send ”screen size change” event to the virtual machine.<br />
Parameters<br />
width: The new resolution width.<br />
height: The new resolution height.<br />
depth: The new resolution depth.<br />
57
Package prlsdkapi Class VmDisplayDev<br />
capture screen to file(self, filename, x, y, width, height,<br />
format=1342177291, quality=-1)<br />
Captures a screen area of a remote virtual machine directly to a file on the<br />
client computer. This is an asynchronous method.<br />
Parameters<br />
filename: Name and path of the file to save the image to.<br />
x: The X coordinate of the area to capture.<br />
y: The Y coordinate of the area to capture.<br />
width: The width of the area to capture (pixels).<br />
height: The height of the area to capture (pixels).<br />
format: Image format to use. See consts.PIF xxx.<br />
quality: Image quality factor. Must be in the range from 0 to<br />
100, or -1. Specify 0 to use the highest data compression,<br />
100 for no compression, or -1 for the default value.<br />
Return Value<br />
A Job object.<br />
set mouse pos(self, coord xyz, buttons)<br />
Set the mouse pointer position.<br />
Parameters<br />
coord xyz: A tuple containing mouse pointer coordinates (x, y, z).<br />
The ’z’ coordinate (scroll) is optional.<br />
buttons: Mouse buttons state. See consts.PMB xxx.<br />
move mouse(self, coord dxdydz, buttons)<br />
Move the mouse pointer to a relative position and send a mouse event (press<br />
or release the specified mouse button). The position to which you want to<br />
move the pointer is calculated relatively to the center of the screen.<br />
Parameters<br />
coord dxdydz: A tuple containing mouse pointer coordinate offsets<br />
(dx, dy, dz). The ’dz’ offset (scroll) is optional.<br />
buttons: Mouse buttons state. See consts.PMB xxx.<br />
58
Package prlsdkapi Class VmDisplayDev<br />
send keys event(self, action keys pairs, action time wait=-1)<br />
Send a set of keyboard key events to the virtual machine.<br />
Parameters<br />
action keys pairs: A tuple containing action/key pairs (action,<br />
key codes). The key codes item is also a tuple<br />
containing a list of key codes. See<br />
consts.ScanCodesList for available codes or<br />
start <strong>Python</strong> from the command line, import<br />
the prlsdkapi module, and issue the print<br />
prlsdkapi.prlsdk.consts.ScanCodesList<br />
statement. See consts.PKE xxx for available<br />
actions.<br />
action time wait: A time delay between actions specified in the<br />
action keys pairs parameter (in milliseconds).<br />
send key event(self, action, keys, action time wait=0)<br />
Send a set of keyboard key events to the virtual machine.<br />
Parameters<br />
action: Action. See consts.PKE xxx for available<br />
actions.<br />
keys: A tuple containing a list of key codes. See<br />
consts.ScanCodesList for available codes.<br />
action time wait: A time delay imposed on key input after the<br />
event execution (in milliseconds).<br />
Inherited from prlsdkapi.VmObjEmulation(Section 1.24)<br />
call vm(), inderect self(), safe call()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), new (), reduce (), reduce ex (),<br />
repr (), setattr (), str ()<br />
1.26.2 Properties<br />
Name Description<br />
sliding mouse enabled Determines if sliding mouse is enabled. True -<br />
enabled; False - disabled.<br />
screen size The virtual machine screen size (width, height,<br />
depth).<br />
59<br />
continued on next page
Package prlsdkapi Class VmBaseDev<br />
Name Description<br />
dyn res tool status Determines if Dynamic Resolution Tool is<br />
enabled. True - enabled; False - disabled.<br />
Inherited from object<br />
class<br />
1.26.3 Class Variables<br />
Name Description<br />
prefix Value: ’devdisplay’<br />
1.27 Class VmBaseDev<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.prlsdk.OwnerRefAsync<br />
prlsdkapi.VmBaseDev<br />
Known Subclasses: prlsdkapi.VmBaseDiskDev, prlsdkapi.VmBasePortDev, prlsdkapi.VmFloppyDev,<br />
prlsdkapi.VmNetDev, prlsdkapi.VmSoundDev, prlsdkapi.VmUsbDev<br />
VmBaseDev is a base class that provides methods for managing virtual devices.<br />
1.27.1 Methods<br />
create(self )<br />
Create a new instance of the same class as this object.<br />
Return Value<br />
A new class instance.<br />
connect(self )<br />
Connect the device. This operation can be performed on a running virtual<br />
machine. This is an asyncronous method.<br />
Return Value<br />
A Job object.<br />
60
Package prlsdkapi Class VmBaseDev<br />
disconnect(self )<br />
Disconnect the device. This operation can be performed on a running virtual<br />
machine. This is an asyncronous method.<br />
Return Value<br />
A Job object.<br />
create image(self, allow recreate=False, non interactive mode=False)<br />
Create a virtual device image on the host. This is an asynchronous method.<br />
Parameters<br />
allow recreate: Specifies whether the existing image<br />
should be replaced. True - replace the<br />
image; False - abort the operation if image<br />
exists.<br />
non interactive mode: Specifies whether interactive mode should<br />
be used. True - use interactive mode; False<br />
- non-interactive mode.<br />
Return Value<br />
A Job object.<br />
remove(self )<br />
Remove this object from the virtual machine device list. The method only<br />
removes the object from memory. It does not delete the device from the<br />
existing virtual machine configuration.<br />
set default stack index(self )<br />
Generate and automatically assign a stack index to the storage device. A<br />
corresponding device interface (IDE or SCSI) has to be set in advance. This<br />
method applies only to VmHddDev and VmOpticalDev.<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync(Section 2.10)<br />
init (), new ()<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
61
Package prlsdkapi Class VmBaseDev<br />
1.27.2 Properties<br />
Name Description<br />
type The type of the device. See consts.PDE xxx for<br />
available types.<br />
index A numeric index identifying a device.<br />
connected Indicates whether the device is connected. True<br />
- connected; False - disconnected.<br />
enabled Indicates whether the device is enabled. True -<br />
enabled; False - disabled.<br />
remote Indicates whether this is a remote device. True<br />
- remote; False - local.<br />
emulated type The device emulation type.<br />
sys name The device system name.<br />
friendly name The user-friendly name of the device.<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync (Section 2.10)<br />
owner<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.27.3 Class Variables<br />
Name Description<br />
prefix Value: ’’<br />
int prefix Value: ’vmdev’<br />
62
Package prlsdkapi Class VmBaseDiskDev<br />
1.28 Class VmBaseDiskDev<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.prlsdk.OwnerRefAsync<br />
prlsdkapi.VmBaseDev<br />
prlsdkapi.VmBaseDiskDev<br />
Known Subclasses: prlsdkapi.VmHddDev, prlsdkapi.VmOpticalDev<br />
VmBaseDiskDev is a base class that provides methods for managing virtual hard disks.<br />
1.28.1 Methods<br />
Inherited from prlsdkapi.VmBaseDev(Section 1.27)<br />
connect(), create(), create image(), disconnect(), remove(), set default stack index()<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync(Section 2.10)<br />
init (), new ()<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.28.2 Properties<br />
Name Description<br />
iface type The disk interface type. See consts.PMS xxx<br />
for available types.<br />
image path The disk image path.<br />
passthrough Indicates whether the passthrough mode is<br />
enabled for the disk. True - enabled; False -<br />
disabled.<br />
63<br />
continued on next page
Package prlsdkapi Class VmBasePortDev<br />
Name Description<br />
stack index The virtual disk stack index.<br />
Inherited from prlsdkapi.VmBaseDev (Section 1.27)<br />
connected, emulated type, enabled, friendly name, index, remote,<br />
sys name, type<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync (Section 2.10)<br />
owner<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.28.3 Class Variables<br />
Name Description<br />
Inherited from prlsdkapi.VmBaseDev (Section 1.27)<br />
int prefix , prefix<br />
1.29 Class VmBasePortDev<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.prlsdk.OwnerRefAsync<br />
prlsdkapi.VmBaseDev<br />
prlsdkapi.VmBasePortDev<br />
Known Subclasses: prlsdkapi.VmParallelPortDev, prlsdkapi.VmSerialDev<br />
Base class providing methods for managing virtual ports (serial, parallel).<br />
1.29.1 Methods<br />
Inherited from prlsdkapi.VmBaseDev(Section 1.27)<br />
64
Package prlsdkapi Class VmBasePortDev<br />
connect(), create(), create image(), disconnect(), remove(), set default stack index()<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync(Section 2.10)<br />
init (), new ()<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.29.2 Properties<br />
Name Description<br />
output file The contents of the virtual device output file.<br />
Inherited from prlsdkapi.VmBaseDev (Section 1.27)<br />
connected, emulated type, enabled, friendly name, index, remote,<br />
sys name, type<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync (Section 2.10)<br />
owner<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.29.3 Class Variables<br />
Name Description<br />
Inherited from prlsdkapi.VmBaseDev (Section 1.27)<br />
int prefix , prefix<br />
65
Package prlsdkapi Class VmFloppyDev<br />
1.30 Class VmFloppyDev<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.prlsdk.OwnerRefAsync<br />
prlsdkapi.VmBaseDev<br />
prlsdkapi.VmFloppyDev<br />
Provides methods for managing virtual floppy disk drives.<br />
1.30.1 Methods<br />
Inherited from prlsdkapi.VmBaseDev(Section 1.27)<br />
connect(), create(), create image(), disconnect(), remove(), set default stack index()<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync(Section 2.10)<br />
init (), new ()<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.30.2 Properties<br />
Name Description<br />
Inherited from prlsdkapi.VmBaseDev (Section 1.27)<br />
connected, emulated type, enabled, friendly name, index, remote,<br />
sys name, type<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync (Section 2.10)<br />
owner<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
66<br />
continued on next page
Package prlsdkapi Class VmOpticalDev<br />
Name Description<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.30.3 Class Variables<br />
Name Description<br />
ht Value: 268435465<br />
Inherited from prlsdkapi.VmBaseDev (Section 1.27)<br />
int prefix , prefix<br />
1.31 Class VmOpticalDev<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.prlsdk.OwnerRefAsync<br />
prlsdkapi.VmBaseDev<br />
prlsdkapi.VmBaseDiskDev<br />
Provides methods for managing virtual optical disk drives.<br />
1.31.1 Methods<br />
prlsdkapi.VmOpticalDev<br />
Inherited from prlsdkapi.VmBaseDev(Section 1.27)<br />
connect(), create(), create image(), disconnect(), remove(), set default stack index()<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync(Section 2.10)<br />
init (), new ()<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
67
Package prlsdkapi Class VmOpticalDev<br />
cmp (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.31.2 Properties<br />
Name Description<br />
Inherited from prlsdkapi.VmBaseDiskDev (Section 1.28)<br />
iface type, image path, passthrough, stack index<br />
Inherited from prlsdkapi.VmBaseDev (Section 1.27)<br />
connected, emulated type, enabled, friendly name, index, remote,<br />
sys name, type<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync (Section 2.10)<br />
owner<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.31.3 Class Variables<br />
Name Description<br />
ht Value: 268435470<br />
Inherited from prlsdkapi.VmBaseDev (Section 1.27)<br />
int prefix , prefix<br />
68
Package prlsdkapi Class VmParallelPortDev<br />
1.32 Class VmParallelPortDev<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.prlsdk.OwnerRefAsync<br />
prlsdkapi.VmBaseDev<br />
prlsdkapi.VmBasePortDev<br />
Provides methods for managing virtual parallel ports.<br />
1.32.1 Methods<br />
Inherited from prlsdkapi.VmBaseDev(Section 1.27)<br />
prlsdkapi.VmParallelPortDev<br />
connect(), create(), create image(), disconnect(), remove(), set default stack index()<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync(Section 2.10)<br />
init (), new ()<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.32.2 Properties<br />
Name Description<br />
Inherited from prlsdkapi.VmBasePortDev (Section 1.29)<br />
output file<br />
Inherited from prlsdkapi.VmBaseDev (Section 1.27)<br />
connected, emulated type, enabled, friendly name, index, remote,<br />
sys name, type<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync (Section 2.10)<br />
69<br />
continued on next page
Package prlsdkapi Class VmHddDev<br />
Name Description<br />
owner<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.32.3 Class Variables<br />
Name Description<br />
ht Value: 268435468<br />
Inherited from prlsdkapi.VmBaseDev (Section 1.27)<br />
int prefix , prefix<br />
1.33 Class VmHddDev<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.prlsdk.OwnerRefAsync<br />
prlsdkapi.VmBaseDev<br />
prlsdkapi.VmBaseDiskDev<br />
Provides methods for managing virtual hard disk drives.<br />
1.33.1 Methods<br />
prlsdkapi.VmHddDev<br />
Inherited from prlsdkapi.VmBaseDev(Section 1.27)<br />
connect(), create(), create image(), disconnect(), remove(), set default stack index()<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync(Section 2.10)<br />
70
Package prlsdkapi Class VmHddDev<br />
init (), new ()<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.33.2 Properties<br />
Name Description<br />
disk type Disk type. See consts.PHD xxx for available<br />
types.<br />
splitted Determines if the virtual hard disk is split into<br />
multiple files. True - multiple files; False -<br />
single file.<br />
disk size Disk size in bytes.<br />
size on disk The size of the occupied space on the disk, in<br />
bytes.<br />
Inherited from prlsdkapi.VmBaseDiskDev (Section 1.28)<br />
iface type, image path, passthrough, stack index<br />
Inherited from prlsdkapi.VmBaseDev (Section 1.27)<br />
connected, emulated type, enabled, friendly name, index, remote,<br />
sys name, type<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync (Section 2.10)<br />
owner<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.33.3 Class Variables<br />
Name Description<br />
prefix Value: ’vmdevhdd’<br />
ht Value: 268435466<br />
Inherited from prlsdkapi.VmBaseDev (Section 1.27)<br />
int prefix<br />
71
Package prlsdkapi Class VmNetDev<br />
1.34 Class VmNetDev<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.prlsdk.OwnerRefAsync<br />
prlsdkapi.VmBaseDev<br />
prlsdkapi.VmNetDev<br />
Provides methods for managing virtual network adapters.<br />
1.34.1 Methods<br />
generate mac addr(self )<br />
Generate a unique MAC address for the adapter. The method generates a new<br />
MAC address and automatically assigns it to the adapter. The method does<br />
not return the address to the caller. To obtain the address, use<br />
VmNetDev.mac address.<br />
Inherited from prlsdkapi.VmBaseDev(Section 1.27)<br />
connect(), create(), create image(), disconnect(), remove(), set default stack index()<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync(Section 2.10)<br />
init (), new ()<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.34.2 Properties<br />
Name Description<br />
bound adapter index The index of the adapter to which this virtual<br />
adapter is bound.<br />
72<br />
continued on next page
Package prlsdkapi Class VmSerialDev<br />
Name Description<br />
bound adapter name The name of the adapter to which this virtual<br />
adapter is bound<br />
mac address The MAC address of the adapter.<br />
Inherited from prlsdkapi.VmBaseDev (Section 1.27)<br />
connected, emulated type, enabled, friendly name, index, remote,<br />
sys name, type<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync (Section 2.10)<br />
owner<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.34.3 Class Variables<br />
Name Description<br />
prefix Value: ’vmdevnet’<br />
ht Value: 268435467<br />
Inherited from prlsdkapi.VmBaseDev (Section 1.27)<br />
int prefix<br />
1.35 Class VmSerialDev<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.prlsdk.OwnerRefAsync<br />
prlsdkapi.VmBaseDev<br />
prlsdkapi.VmBasePortDev<br />
Provides methods for managing virtual serial ports.<br />
prlsdkapi.VmSerialDev<br />
73
Package prlsdkapi Class VmSerialDev<br />
1.35.1 Methods<br />
Inherited from prlsdkapi.VmBaseDev(Section 1.27)<br />
connect(), create(), create image(), disconnect(), remove(), set default stack index()<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync(Section 2.10)<br />
init (), new ()<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.35.2 Properties<br />
Name Description<br />
socket mode The socket mode of this serial port. See<br />
consts.PSP SERIAL SOCKET xxx for available<br />
modes.<br />
Inherited from prlsdkapi.VmBasePortDev (Section 1.29)<br />
output file<br />
Inherited from prlsdkapi.VmBaseDev (Section 1.27)<br />
connected, emulated type, enabled, friendly name, index, remote,<br />
sys name, type<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync (Section 2.10)<br />
owner<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.35.3 Class Variables<br />
Name Description<br />
prefix Value: ’vmdevserial’<br />
ht Value: 268435469<br />
Inherited from prlsdkapi.VmBaseDev (Section 1.27)<br />
74<br />
continued on next page
Package prlsdkapi Class VmSoundDev<br />
Name Description<br />
int prefix<br />
1.36 Class VmSoundDev<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.prlsdk.OwnerRefAsync<br />
prlsdkapi.VmBaseDev<br />
Provides methods for managing virtual sound devices.<br />
1.36.1 Methods<br />
prlsdkapi.VmSoundDev<br />
Inherited from prlsdkapi.VmBaseDev(Section 1.27)<br />
connect(), create(), create image(), disconnect(), remove(), set default stack index()<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync(Section 2.10)<br />
init (), new ()<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.36.2 Properties<br />
Name Description<br />
output dev Output device string.<br />
mixer dev Mixer device string.<br />
Inherited from prlsdkapi.VmBaseDev (Section 1.27)<br />
75<br />
continued on next page
Package prlsdkapi Class VmUsbDev<br />
Name Description<br />
connected, emulated type, enabled, friendly name, index, remote,<br />
sys name, type<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync (Section 2.10)<br />
owner<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.36.3 Class Variables<br />
Name Description<br />
prefix Value: ’vmdevsound’<br />
ht Value: 268435472<br />
Inherited from prlsdkapi.VmBaseDev (Section 1.27)<br />
int prefix<br />
1.37 Class VmUsbDev<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.prlsdk.OwnerRefAsync<br />
prlsdkapi.VmBaseDev<br />
Provides methods for managing virtual USB devices.<br />
1.37.1 Methods<br />
prlsdkapi.VmUsbDev<br />
Inherited from prlsdkapi.VmBaseDev(Section 1.27)<br />
connect(), create(), create image(), disconnect(), remove(), set default stack index()<br />
76
Package prlsdkapi Class VmUsbDev<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync(Section 2.10)<br />
init (), new ()<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.37.2 Properties<br />
Name Description<br />
autoconnect option USB controller autoconnect option. See<br />
consts.PUD xxx for available options.<br />
Inherited from prlsdkapi.VmBaseDev (Section 1.27)<br />
connected, emulated type, enabled, friendly name, index, remote,<br />
sys name, type<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync (Section 2.10)<br />
owner<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.37.3 Class Variables<br />
Name Description<br />
prefix Value: ’vmdevusb’<br />
ht Value: 268435471<br />
Inherited from prlsdkapi.VmBaseDev (Section 1.27)<br />
int prefix<br />
77
Package prlsdkapi Class VmBootDev<br />
1.38 Class VmBootDev<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.prlsdk.OwnerRefAsync<br />
prlsdkapi.VmBootDev<br />
Provides methods for managing boot devices in a virtual machine.<br />
1.38.1 Methods<br />
remove(self )<br />
Remove the device from the boot device priority list.<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync(Section 2.10)<br />
init (), new ()<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.38.2 Properties<br />
Name Description<br />
type Identifies the boot device type. See<br />
consts.PDE xxx for available types.<br />
index A numeric index of the device. Device index is<br />
a property that, together with device type, is<br />
used to uniquely identify a device on a virtual<br />
machine<br />
sequence index The boot device sequence index in the boot<br />
priority list.<br />
78<br />
continued on next page
Package prlsdkapi Class VmScrRes<br />
Name Description<br />
in use Determines whether the boot device is enabled<br />
or disabled in the boot priority list. True -<br />
enabled; False - disabled and will be ignored<br />
during boot.<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync (Section 2.10)<br />
owner<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.38.3 Class Variables<br />
Name Description<br />
prefix Value: ’bootdev’<br />
ht Value: 268435497<br />
1.39 Class VmScrRes<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.prlsdk.OwnerRefAsync<br />
prlsdkapi.VmScrRes<br />
Contains a virtual machine screen resolution information.<br />
1.39.1 Methods<br />
remove(self )<br />
Removes this screen resolution from the virtual machine configuration.<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync(Section 2.10)<br />
79
Package prlsdkapi Class VmScrRes<br />
init (), new ()<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.39.2 Properties<br />
Name Description<br />
enabled Determines whether this screen resolution is<br />
enabled in the virtual machine. True - enabled;<br />
False - disabled.<br />
width The screen resolution width.<br />
height The screen resolution height.<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync (Section 2.10)<br />
owner<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.39.3 Class Variables<br />
Name Description<br />
prefix Value: ’scrres’<br />
ht Value: 268435480<br />
80
Package prlsdkapi Class VmShare<br />
1.40 Class VmShare<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.prlsdk.OwnerRefAsync<br />
prlsdkapi.VmShare<br />
Provides methods for managing host shared folder accessibility in a virtual machine. Using<br />
these methods, you can make a host OS folder visible and accessible in a virtual machine.<br />
1.40.1 Methods<br />
remove(self )<br />
Remove this share from the virtual machine configuration.<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync(Section 2.10)<br />
init (), new ()<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.40.2 Properties<br />
Name Description<br />
name Shared folder name.<br />
path Shared folder path.<br />
description share.set description(Share,<br />
new share description)<br />
Sets VM shared folder description.<br />
enabled Determines whether the shared folder is<br />
enabled. True - enabled; False - disabled.<br />
read only Determines whether the shared folder is<br />
read-only. True - read only; False - writable.<br />
81<br />
continued on next page
Package prlsdkapi Class VmStat<br />
Name Description<br />
Inherited from prlsdkapi.prlsdk.OwnerRefAsync (Section 2.10)<br />
owner<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.40.3 Class Variables<br />
Name Description<br />
prefix Value: ’share’<br />
ht Value: 268435479<br />
1.41 Class VmStat<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.VmStat<br />
Provides methods for obtaining performance statistics hosts and virtual machines.<br />
1.41.1 Methods<br />
get cpu stat(self, index)<br />
Obtain and return CPU statistics.<br />
Parameters<br />
index: A numeric index identifying a CPU instance. To obtain the<br />
instance count, use VmStat.cpus stats count.<br />
Return Value<br />
An instance of VmCPUStat.<br />
82
Package prlsdkapi Class VmStat<br />
get iface stat(self, index)<br />
Obtain and return network interface statistics.<br />
Parameters<br />
index: A numeric instance identifying a network interface. To<br />
obtain the net interface count, use<br />
VmStat.ifaces stats count.<br />
Return Value<br />
An instance of VmIFaceStat.<br />
get user stat(self, index)<br />
Obtain and return the user session statistics.<br />
Parameters<br />
index: A numeric index identifying a user session. To obtain the<br />
user session count, use VmStat.users stats count.<br />
Return Value<br />
An instance of VmUserStat.<br />
get disk stat(self, index)<br />
Obtain and return disk drive statistics.<br />
Parameters<br />
index: A numeric index identifying a disk. To obtain the disk<br />
count, use VmStat.disks stats count.<br />
Return Value<br />
An instance of VmDiskStat.<br />
get proc stat(self, index)<br />
Obtain and return system process statistics.<br />
Parameters<br />
index: A numeric index identifying a process. To obtain the process<br />
count, use VmStat.procs stats count.<br />
Return Value<br />
An instance of VmProcStat.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), init (), new (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
83
Package prlsdkapi Class VmStat<br />
1.41.2 Properties<br />
Name Description<br />
total ram size Total RAM size in bytes.<br />
usage ram size The amount of used RAM in bytes.<br />
free ram size The amount of free RAM in bytes.<br />
total swap size Total swap size in bytes.<br />
usage swap size The amount of used swap in bytes.<br />
free swap size The amount of free swap in bytes.<br />
os uptime The operating system uptime in seconds.<br />
disp uptime The <strong>Parallels</strong> Service uptime in secounds.<br />
cpus stats count Indicates the number of instances of VmCPUStat<br />
contained in this object.<br />
ifaces stats count Indicates the number of instance of<br />
VmIFaceStat contained in this object.<br />
users stats count Indicates the number of instances of<br />
VmUserStat contained in this object.<br />
disks stats count Indicates the number of instances of<br />
VmDiskStat contained in this object.<br />
procs stats count Indicates the number of instances of<br />
VmProcStat contained in this object.<br />
cpu stats An iterator/sequence that allows to traverse<br />
through VmCPUStat instances.<br />
iface stats An iterator/sequence that allows to traverse<br />
through VmIFaceStat instances.<br />
user stats An iterator/sequence that allows to traverse<br />
through VmUserStat instances.<br />
disk stats An iterator/sequence that allows to traverse<br />
through VmDiskStat instances.<br />
proc stats An iterator/sequence that allows to traverse<br />
through VmProcStat instances.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.41.3 Class Variables<br />
Name Description<br />
prefix Value: ’stat’<br />
ht Value: 268435488<br />
84
Package prlsdkapi Class VmCPUStat<br />
1.42 Class VmCPUStat<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
Contains CPU statistics.<br />
1.42.1 Methods<br />
prlsdkapi.VmCPUStat<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), init (), new (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.42.2 Properties<br />
Name Description<br />
cpu usage The CPU usage, in percent.<br />
total time CPU total time, in seconds.<br />
user time CPU user time, in seconds.<br />
system time CPU system time, in seconds.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.42.3 Class Variables<br />
Name Description<br />
prefix Value: ’statcpu’<br />
ht Value: 268435489<br />
85
Package prlsdkapi Class VmIFaceStat<br />
1.43 Class VmIFaceStat<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
Contains network interface statistics.<br />
1.43.1 Methods<br />
prlsdkapi.VmIFaceStat<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), init (), new (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.43.2 Properties<br />
Name Description<br />
system name The network interface system name.<br />
in data size The total number of bytes the network interface<br />
has received since the <strong>Parallels</strong> Service was last<br />
started.<br />
out data size The total number of bytes the network interface<br />
has sent since the <strong>Parallels</strong> Service was last<br />
started.<br />
in pkgs count The total number of packets the network<br />
interface has received since the <strong>Parallels</strong> Service<br />
was last started.<br />
out pkgs count The total number of packets the network<br />
interface has sent since the <strong>Parallels</strong> Service<br />
was last started.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
86<br />
continued on next page
Package prlsdkapi Class VmUserStat<br />
class<br />
1.43.3 Class Variables<br />
Name Description<br />
Name Description<br />
prefix Value: ’statiface’<br />
ht Value: 268435490<br />
1.44 Class VmUserStat<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
Contains user session statistics.<br />
1.44.1 Methods<br />
prlsdkapi.VmUserStat<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), init (), new (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.44.2 Properties<br />
Name Description<br />
user name The name of the session owner.<br />
service name The name of the system service of the host OS<br />
that created the session<br />
host name The host name of the client machine from<br />
which the session was initiated.<br />
session time The session duration, in seconds.<br />
87<br />
continued on next page
Package prlsdkapi Class VmDiskStat<br />
Name Description<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.44.3 Class Variables<br />
Name Description<br />
prefix Value: ’statuser’<br />
ht Value: 268435491<br />
1.45 Class VmDiskStat<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
Contains disk drive statistics.<br />
1.45.1 Methods<br />
get part stat(self, index)<br />
prlsdkapi.VmDiskStat<br />
Obtain a return disk partition statistics.<br />
Parameters<br />
index: A numeric index identifying a partition. To obtain the<br />
partition count, use VmDiskStat.parts stats count.<br />
Return Value<br />
An instance of VmDiskPartStat.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), init (), new (), repr (), cancel(), wait()<br />
Inherited from object<br />
88
Package prlsdkapi Class VmDiskPartStat<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.45.2 Properties<br />
Name Description<br />
system name The disk drive system name.<br />
usage disk space The size of the used space on the disk, in bytes.<br />
free disk space Free disk space, in bytes.<br />
parts stats count The number of partitions on the disk.<br />
part stats An iterator/sequence that allows to traverse<br />
through VmDiskPartStat instances contained<br />
in this object.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.45.3 Class Variables<br />
Name Description<br />
prefix Value: ’statdisk’<br />
ht Value: 268435492<br />
1.46 Class VmDiskPartStat<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
Contains disk partition statistics.<br />
1.46.1 Methods<br />
prlsdkapi.VmDiskPartStat<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
89
Package prlsdkapi Class VmProcStat<br />
cmp (), init (), new (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.46.2 Properties<br />
Name Description<br />
system name Partition system name.<br />
usage disk space Used disk space.<br />
free disk space Free disk space.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.46.3 Class Variables<br />
Name Description<br />
prefix Value: ’statdiskpart’<br />
ht Value: 268435493<br />
1.47 Class VmProcStat<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
Contains system process statistics.<br />
1.47.1 Methods<br />
prlsdkapi.VmProcStat<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
90
Package prlsdkapi Class VmProcStat<br />
cmp (), init (), new (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.47.2 Properties<br />
Name Description<br />
command name The process command name.<br />
id The process system ID.<br />
owner user name The name of the process owner.<br />
total mem usage Total memory usage size, in bytes.<br />
real mem usage Real memory usage size, in bytes<br />
virt mem usage Virtual memory usage size, in bytes.<br />
start time Start time of the process, in seconds (number of<br />
seconds since January 1, 1601 (UTC)).<br />
total time Total running time of the process, in seconds<br />
user time User running time of the process, in seconds.<br />
system time System running time of the process, in seconds.<br />
state The process state. See consts.PPS PROC xxx.<br />
cpu usage The process CPU usage, in percent.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.47.3 Class Variables<br />
Name Description<br />
prefix Value: ’statproc’<br />
ht Value: 268435494<br />
91
Package prlsdkapi Class VmInfo<br />
1.48 Class VmInfo<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.VmInfo<br />
Contains a virtual machine state and access rights information.<br />
1.48.1 Methods<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), init (), new (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.48.2 Properties<br />
Name Description<br />
state The virtual machine state. See consts.VMS xxx<br />
for available states.<br />
access rights An instance of VmAccessRights.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.48.3 Class Variables<br />
Name Description<br />
prefix Value: ’vminfo’<br />
ht Value: 268435476<br />
92
Package prlsdkapi Class VmToolsInfo<br />
1.49 Class VmToolsInfo<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.VmToolsInfo<br />
Provides methods for determining whether the <strong>Parallels</strong> Tools package is installed in the<br />
specified virtual machine and for obtaining its status and version information.<br />
1.49.1 Methods<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), init (), new (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.49.2 Properties<br />
Name Description<br />
state The <strong>Parallels</strong> Tools package state information.<br />
See consts.PTS xxx for the list of states.<br />
version The <strong>Parallels</strong> Tools package version.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.49.3 Class Variables<br />
Name Description<br />
prefix Value: ’vmtoolsinfo’<br />
ht Value: 268435505<br />
93
Package prlsdkapi Class SrvCfgDev<br />
1.50 Class SrvCfgDev<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.SrvCfgDev<br />
Known Subclasses: prlsdkapi.SrvCfgHdd, prlsdkapi.SrvCfgNet<br />
SrvCfgDev is a base class that provides methods for getting information about physical<br />
devices on the host.<br />
1.50.1 Methods<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), init (), new (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.50.2 Properties<br />
Name Description<br />
name The name of the device.<br />
id The device ID.<br />
type The device type. See consts.PDE xxx.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.50.3 Class Variables<br />
Name Description<br />
prefix Value: ’srvcfgdev’<br />
94<br />
continued on next page
Package prlsdkapi Class SrvCfgNet<br />
Name Description<br />
ht Value: 268435482<br />
1.51 Class SrvCfgNet<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.SrvCfgDev<br />
prlsdkapi.SrvCfgNet<br />
Provides methods for getting information about a network adapter on the host.<br />
1.51.1 Methods<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), init (), new (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.51.2 Properties<br />
Name Description<br />
net adapter type The adapter type. See consts.PHI xxx.<br />
sys index The network adapter system index.<br />
enabled Indicates whether the adapter is enabled or<br />
disabled. True - enabled; False - disabled.<br />
Inherited from prlsdkapi.SrvCfgDev (Section 1.50)<br />
id, name, type<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
95<br />
continued on next page
Package prlsdkapi Class SrvCfgHdd<br />
class<br />
1.51.3 Class Variables<br />
Name Description<br />
Name Description<br />
prefix Value: ’srvcfgnet’<br />
ht Value: 268435485<br />
1.52 Class SrvCfgHdd<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.SrvCfgDev<br />
prlsdkapi.SrvCfgHdd<br />
Provides methods for getting information about a physical hard disk on the host.<br />
1.52.1 Methods<br />
get part(self, index)<br />
Obtain and return the specified partition information.<br />
Parameters<br />
index: A numeric index identifying the partition. To obtain the<br />
partition count, use SrvCfgHdd.parts count.<br />
Return Value<br />
An instance of SrvCfgHddPart.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), init (), new (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
96
Package prlsdkapi Class SrvCfgHddPart<br />
1.52.2 Properties<br />
Name Description<br />
size The hard disk size.<br />
index A numeric index identifying the disk.<br />
parts count The number of partitions on the disk.<br />
parts An iterator/sequence that allows to traverse<br />
through SrvCfgHddPart instances contained in<br />
this object.<br />
Inherited from prlsdkapi.SrvCfgDev (Section 1.50)<br />
id, name, type<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.52.3 Class Variables<br />
Name Description<br />
prefix Value: ’srvcfghdd’<br />
ht Value: 268435483<br />
1.53 Class SrvCfgHddPart<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
Contains information about a disk partition.<br />
1.53.1 Methods<br />
prlsdkapi.SrvCfgHddPart<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), init (), new (), repr (), cancel(), wait()<br />
97
Package prlsdkapi Class SrvCfgHddPart<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.53.2 Properties<br />
Name Description<br />
name Partition name.<br />
size Partition size.<br />
index A numeric index identifying the partition.<br />
type A numerical code identifying the type of the<br />
partition.<br />
in use Indicates whether the partition is in use, that<br />
is, whether it contains a valid file system, being<br />
used for swap or by a database, etc. True - the<br />
parition is in use; False otherwise.<br />
logical Indicates whether this is a logical partition.<br />
True - logical; False otherwise.<br />
active Indicates whether the partition is active. True -<br />
active; False otherwise.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.53.3 Class Variables<br />
Name Description<br />
prefix Value: ’srvcfghddpart’<br />
ht Value: 268435484<br />
98
Package prlsdkapi Class SrvInfo<br />
1.54 Class SrvInfo<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.SrvInfo<br />
Contains general information about a host computer. The information includes port number,<br />
host name, OS version, product version, and host machine UUID.<br />
1.54.1 Methods<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), init (), new (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.54.2 Properties<br />
Name Description<br />
host name Host name.<br />
os version OS version that the host is running.<br />
cmd port CMD port number.<br />
server uuid Host UUID (universally unique ID).<br />
product version The <strong>Parallels</strong> Service version that the host is<br />
running.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.54.3 Class Variables<br />
99<br />
continued on next page
Package prlsdkapi Class LoginResponse<br />
Name Description<br />
Name Description<br />
prefix Value: ’srvinfo’<br />
ht Value: 268435496<br />
1.55 Class LoginResponse<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.LoginResponse<br />
Contains information pertinent to a successful <strong>Parallels</strong> Service login operation.<br />
1.55.1 Methods<br />
get run task(self, index)<br />
Obtain and return a RunningTask instance.<br />
Parameters<br />
index: A numeric index of the task to obtain the handle for. Use<br />
LoginResponse to obtain the task count.<br />
Return Value<br />
An instance of RunningTask.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), init (), new (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.55.2 Properties<br />
100
Package prlsdkapi Class RunningTask<br />
Name Description<br />
session uuid The session UUID string (used to restore a<br />
session).<br />
server uuid The host machine UUID.<br />
host os version OS version that the host is running.<br />
run tasks count The number of RunningTask instances<br />
contained in this object.<br />
product version The <strong>Parallels</strong> Service version that the host is<br />
running.<br />
run tasks An iterator/sequence that allows to traverse<br />
through RunningTask instances contained in<br />
this object.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.55.3 Class Variables<br />
Name Description<br />
prefix Value: ’loginresponse’<br />
ht Value: 268435499<br />
1.56 Class RunningTask<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.RunningTask<br />
The RunningTask class is used in recovering from the lost <strong>Parallels</strong> Service connection and<br />
attaching to an existing and running task. The class is a container that contains information<br />
about a task that is still running inside the <strong>Parallels</strong> Service. For the list of tasks supported<br />
by this functionality, see consts.RTT RUNNING TASK xxx.<br />
101
Package prlsdkapi Class RunningTask<br />
1.56.1 Methods<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), init (), new (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.56.2 Properties<br />
Name Description<br />
uuid The the task UUID.<br />
type The task type. See<br />
consts.RTT RUNNING TASK xxx.<br />
parameters runningtask.get parameters(RunningTask) -><br />
string<br />
Returns task parameters as string Value returns<br />
in UTF-8 encoding<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.56.3 Class Variables<br />
Name Description<br />
prefix Value: ’runningtask’<br />
ht Value: 268435500<br />
102
Package prlsdkapi Class UsrInfo<br />
1.57 Class UsrInfo<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.UsrInfo<br />
Contains information about a <strong>Parallels</strong> Service user.<br />
1.57.1 Methods<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), init (), new (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
1.57.2 Properties<br />
Name Description<br />
name User name.<br />
uuid User UUID.<br />
session count Active session count.<br />
default vm folder Name and path of the default virtual machine<br />
directory for the user.<br />
can change srv sets Indicates whether the user is allowed to modify<br />
<strong>Parallels</strong> Service preferences. True - allowed;<br />
False - not allowed.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
1.57.3 Class Variables<br />
103
Package prlsdkapi Class UsrInfo<br />
Name Description<br />
prefix Value: ’usrinfo’<br />
ht Value: 268435508<br />
104
Module prlsdkapi.prlsdk<br />
2 Module prlsdkapi.prlsdk<br />
2.1 Modules<br />
• consts (Section 3, p. 121)<br />
• errors (Section 4, p. 135)<br />
2.2 Functions<br />
CheckServerAlive(hostname, timeout=DefaultTimeout)<br />
Lets to determine whether <strong>Parallels</strong> server on specified host alive If alive -<br />
ServerInfo will be returned else None.<br />
Return Value<br />
ServerInfo<br />
DefaultJobTimeout(...)<br />
DefaultKeyActWait(...)<br />
DefaultTimeout(...)<br />
DeinitializeSDK()<br />
Method force SDK deinitialization.<br />
GetSDKLibraryPath()<br />
Return path from witch library will be loaded.<br />
Return Value<br />
string<br />
GetServerList(msec)<br />
Lookups <strong>Parallels</strong> servers at the LAN during specified timeout.<br />
Return Value<br />
list of ServerInfo objects<br />
InitializeSDK(PRL APPLICATION MODE)<br />
Method initialize SDK. Return False if it was already initialized, else True.<br />
Return Value<br />
bool<br />
105
Module prlsdkapi.prlsdk Class Base<br />
IsSDKInitialized()<br />
Return True if SDK allready loadded.<br />
Return Value<br />
bool<br />
SetSDKLibraryPath(new path)<br />
Return path from witch library will be loaded. Raise exception if SDK <strong>API</strong><br />
allready initialized.<br />
Return Value<br />
string<br />
debug level (...)<br />
2.3 Variables<br />
Name Description<br />
SDK Value: < SDK instance at 0x00A65130,<br />
version ’3.0.3779.226510’><br />
2.4 Class Base<br />
object<br />
prlsdkapi.prlsdk.Base<br />
Known Subclasses: prlsdkapi.prlsdk.BaseAsync, prlsdkapi.FoundVm, prlsdkapi.prlsdk.BaseServer,<br />
prlsdkapi.prlsdk.Job, prlsdkapi.prlsdk.ServerInfo<br />
Base objects<br />
2.4.1 Methods<br />
cmp (x, y)<br />
cmp(x,y)<br />
init (...)<br />
x. init (...) initializes x; see x. class . doc for signature<br />
Overrides: object. init<br />
106
Module prlsdkapi.prlsdk Class BaseAsync<br />
new (T, S, ...)<br />
Return Value<br />
a new object with type S, a subtype of T<br />
Overrides: object. new<br />
repr (x)<br />
repr(x)<br />
Overrides: object. repr<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
2.4.2 Properties<br />
Name Description<br />
handle<br />
handle type handle type<br />
Inherited from object<br />
class<br />
2.5 Class BaseAsync<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
Known Subclasses: prlsdkapi.prlsdk.OwnerRefAsync, prlsdkapi.FSEntry, prlsdkapi.FSInfo,<br />
prlsdkapi.LicenceInfo, prlsdkapi.LoginResponse, prlsdkapi.NetServiceStatus, prlsdkapi.RunningTask,<br />
prlsdkapi.SrvCfgDev, prlsdkapi.SrvCfgHddPart, prlsdkapi.SrvConfig, prlsdkapi.SrvInfo, prlsdkapi.UserConfig,<br />
prlsdkapi.UsrInfo, prlsdkapi.prlsdk.BaseVm, prlsdkapi.VmCPUStat, prlsdkapi.VmDiskPartStat,<br />
prlsdkapi.VmDiskStat, prlsdkapi.VmIFaceStat, prlsdkapi.VmInfo,<br />
prlsdkapi.VmProcStat, prlsdkapi.VmStat, prlsdkapi.VmToolsInfo, prlsdkapi.VmUserStat, prlsdkapi.prlsdk.Event,<br />
prlsdkapi.prlsdk.Result<br />
Base async objects<br />
107
Module prlsdkapi.prlsdk Class BaseAsync<br />
2.5.1 Methods<br />
cmp (x, y)<br />
cmp(x,y)<br />
Overrides: prlsdkapi.prlsdk.Base. cmp<br />
init (...)<br />
x. init (...) initializes x; see x. class . doc for signature<br />
Overrides: object. init<br />
new (T, S, ...)<br />
Return Value<br />
a new object with type S, a subtype of T<br />
Overrides: object. new<br />
repr (x)<br />
repr(x)<br />
Overrides: object. repr<br />
cancel(BaseAsync)<br />
Start canceling this job, this method is asynchone so it return Result object.<br />
Return Value<br />
Result<br />
wait(BaseAsync, msec=DefaultJobWait)<br />
Waits for job finished for passed milliseconds if successefully finished self<br />
object is retuned If timeout -> PrlJobTimeoutError will be raised . If job<br />
finished with error <strong>Parallels</strong>Error will be raised.<br />
Return Value<br />
BaseAsync<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
2.5.2 Properties<br />
108
Module prlsdkapi.prlsdk Class BaseServer<br />
Name Description<br />
expected h type<br />
job<br />
finished Showes job status<br />
handle type Returns handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
2.6 Class BaseServer<br />
object<br />
prlsdkapi.prlsdk.Base<br />
Known Subclasses: prlsdkapi.Server<br />
Server base object class<br />
2.6.1 Methods<br />
init (...)<br />
prlsdkapi.prlsdk.BaseServer<br />
x. init (...) initializes x; see x. class . doc for signature<br />
Overrides: object. init<br />
new (T, S, ...)<br />
Return Value<br />
a new object with type S, a subtype of T<br />
Overrides: object. new<br />
109
Module prlsdkapi.prlsdk Class BaseServer<br />
login(Server, host, user, password, port=0, secur level=LOW, session uuid=,<br />
timeout=0)<br />
secur level – see prlsdk.consts.PSL xxx Login operation should be performed<br />
before to allow further server operations. Through Result object you could<br />
check that operation is finished. All method that checks for connection will<br />
wait until login finished.<br />
Return Value<br />
Result object<br />
login local(Server, port=0, secur level=LOW, session uuid=)<br />
secur level – see prlsdk.consts.PSL xxx Login operation should be performed<br />
before to allow further server operations. Through Result object you could<br />
check that operation is finished. All method that checks for connection will<br />
wait until login finished.<br />
Return Value<br />
Result object<br />
logoff(Server)<br />
Logoff operation will finish interactive connection session.<br />
Return Value<br />
Job object<br />
reg event handler(Server, handler, user data=None)<br />
Register server event handler. handler should take 2 arguments: Event object,<br />
user data.<br />
shutdown(srv, Srv, force=False)<br />
Let to shutdown server connection established with<br />
Return Value<br />
Job<br />
unreg event handler(Server, handler)<br />
Unregister server event handler.<br />
Inherited from prlsdkapi.prlsdk.Base(Section 2.4)<br />
cmp (), repr ()<br />
Inherited from object<br />
110
Module prlsdkapi.prlsdk Class BaseVm<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
2.6.2 Properties<br />
Name Description<br />
editing common<br />
editing user<br />
login result<br />
autostart editing<br />
connected Return connected state<br />
last session uuid<br />
session uuid Retruns last server session uuid<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle , handle type<br />
Inherited from object<br />
class<br />
2.7 Class BaseVm<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
Known Subclasses: prlsdkapi.Vm<br />
Vm base object class<br />
2.7.1 Methods<br />
init (...)<br />
prlsdkapi.prlsdk.BaseVm<br />
x. init (...) initializes x; see x. class . doc for signature<br />
Overrides: object. init<br />
111
Module prlsdkapi.prlsdk Class Event<br />
new (T, S, ...)<br />
Return Value<br />
a new object with type S, a subtype of T<br />
Overrides: object. new<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
2.7.2 Properties<br />
Name Description<br />
editing<br />
unfin op<br />
autostart editing<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
2.8 Class Event<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.prlsdk.Event<br />
Known Subclasses: prlsdkapi.prlsdk.Question<br />
Event object class<br />
112
Module prlsdkapi.prlsdk Class Event<br />
2.8.1 Methods<br />
x[y]<br />
getitem (x, y)<br />
init (...)<br />
x. init (...) initializes x; see x. class . doc for signature<br />
Overrides: object. init<br />
iter (x)<br />
iter(x)<br />
len (x)<br />
len(x)<br />
new (T, S, ...)<br />
Return Value<br />
a new object with type S, a subtype of T<br />
Overrides: object. new<br />
get param(Event, index)<br />
Returns depending on parameter type some value with passed index.<br />
Return Value<br />
value of any type<br />
get params count(Event, index)<br />
Returns parameters count.<br />
Return Value<br />
int<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
113
Module prlsdkapi.prlsdk Class Job<br />
2.8.2 Properties<br />
Name Description<br />
event code Returns event code, see prlsdk.consts.PMT xxx.<br />
event str code Returns event code string representaion.<br />
event type Returns event type, see prlsdk.consts.PMT xxx.<br />
explicit text Returns explicit event text.<br />
params count Returns event param count<br />
sender Returns question sender, see<br />
prlsdk.consts.PIE xxx.<br />
text Returns event text.<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
2.9 Class Job<br />
object<br />
prlsdkapi.prlsdk.Base<br />
Job objects<br />
2.9.1 Methods<br />
init (...)<br />
prlsdkapi.prlsdk.Job<br />
x. init (...) initializes x; see x. class . doc for signature<br />
Overrides: object. init<br />
new (T, S, ...)<br />
Return Value<br />
a new object with type S, a subtype of T<br />
Overrides: object. new<br />
114
Module prlsdkapi.prlsdk Class Job<br />
cancel(Job)<br />
Start canceling this job, this method is asynchone so it return another job.<br />
Return Value<br />
Result<br />
get held object(Job, name)<br />
Returns held onject by name, None if not held.<br />
Return Value<br />
object<br />
hold object(Job, name, obj)<br />
Add object to holding list.<br />
Return Value<br />
self<br />
wait(Job, msec=DefaultJobWait)<br />
Waits for job finished for passed milliseconds If timeout ->return False. If job<br />
finished with error <strong>Parallels</strong>Error will be raised.<br />
Return Value<br />
bool<br />
Inherited from prlsdkapi.prlsdk.Base(Section 2.4)<br />
cmp (), repr ()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
2.9.2 Properties<br />
Name Description<br />
description<br />
ret code<br />
error params Return error params as Event object.<br />
finished Showes job status<br />
op code Return job operation code, see<br />
prlsdk.consts.PJOC xxx.<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle , handle type<br />
115<br />
continued on next page
Module prlsdkapi.prlsdk Class OwnerRefAsync<br />
Name Description<br />
Inherited from object<br />
class<br />
2.10 Class OwnerRefAsync<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
prlsdkapi.prlsdk.OwnerRefAsync<br />
Known Subclasses: prlsdkapi.DispConfig, prlsdkapi.DispNet, prlsdkapi.VmBaseDev, prlsdkapi.VmBootDev,<br />
prlsdkapi.VmScrRes, prlsdkapi.VmShare<br />
Base async object with owner reference<br />
2.10.1 Methods<br />
init (...)<br />
x. init (...) initializes x; see x. class . doc for signature<br />
Overrides: object. init<br />
new (T, S, ...)<br />
Return Value<br />
a new object with type S, a subtype of T<br />
Overrides: object. new<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
2.10.2 Properties<br />
116
Module prlsdkapi.prlsdk Class <strong>Parallels</strong>Error<br />
Name Description<br />
owner<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
2.11 Class <strong>Parallels</strong>Error<br />
object<br />
exceptions.BaseException<br />
exceptions.Exception<br />
prlsdkapi.prlsdk.<strong>Parallels</strong>Error<br />
Known Subclasses: prlsdkapi.PrlSDKError, prlsdkapi.prlsdk.PrlJobTimeoutError, prlsdkapi.prlsdk.PrlNotImplError,<br />
prlsdkapi.prlsdk.PrlStateError<br />
2.11.1 Methods<br />
Inherited from exceptions.Exception<br />
init (), new ()<br />
Inherited from exceptions.BaseException<br />
delattr (), getattribute (), getitem (), reduce (), repr (), setattr (),<br />
setstate (), str ()<br />
Inherited from object<br />
hash (), reduce ex ()<br />
2.11.2 Properties<br />
Name Description<br />
Inherited from exceptions.BaseException<br />
args, message<br />
Inherited from object<br />
117<br />
continued on next page
Module prlsdkapi.prlsdk Class PrlJobTimeoutError<br />
class<br />
Name Description<br />
2.12 Class PrlJobTimeoutError<br />
object<br />
exceptions.BaseException<br />
exceptions.Exception<br />
prlsdkapi.prlsdk.<strong>Parallels</strong>Error<br />
2.12.1 Methods<br />
Inherited from exceptions.Exception<br />
init (), new ()<br />
Inherited from exceptions.BaseException<br />
prlsdkapi.prlsdk.PrlJobTimeoutError<br />
delattr (), getattribute (), getitem (), reduce (), repr (), setattr (),<br />
setstate (), str ()<br />
Inherited from object<br />
hash (), reduce ex ()<br />
2.12.2 Properties<br />
Name Description<br />
Inherited from exceptions.BaseException<br />
args, message<br />
Inherited from object<br />
class<br />
118
Module prlsdkapi.prlsdk Class PrlNotImplError<br />
2.13 Class PrlNotImplError<br />
object<br />
exceptions.BaseException<br />
exceptions.Exception<br />
prlsdkapi.prlsdk.<strong>Parallels</strong>Error<br />
2.13.1 Methods<br />
Inherited from exceptions.Exception<br />
init (), new ()<br />
Inherited from exceptions.BaseException<br />
prlsdkapi.prlsdk.PrlNotImplError<br />
delattr (), getattribute (), getitem (), reduce (), repr (), setattr (),<br />
setstate (), str ()<br />
Inherited from object<br />
hash (), reduce ex ()<br />
2.13.2 Properties<br />
Name Description<br />
Inherited from exceptions.BaseException<br />
args, message<br />
Inherited from object<br />
class<br />
119
Module prlsdkapi.prlsdk Class PrlStateError<br />
2.14 Class PrlStateError<br />
object<br />
exceptions.BaseException<br />
exceptions.Exception<br />
prlsdkapi.prlsdk.<strong>Parallels</strong>Error<br />
2.14.1 Methods<br />
Inherited from exceptions.Exception<br />
init (), new ()<br />
Inherited from exceptions.BaseException<br />
prlsdkapi.prlsdk.PrlStateError<br />
delattr (), getattribute (), getitem (), reduce (), repr (), setattr (),<br />
setstate (), str ()<br />
Inherited from object<br />
hash (), reduce ex ()<br />
2.14.2 Properties<br />
Name Description<br />
Inherited from exceptions.BaseException<br />
args, message<br />
Inherited from object<br />
class<br />
120
Module prlsdkapi.prlsdk Class Question<br />
2.15 Class Question<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
Question object class<br />
2.15.1 Methods<br />
prlsdkapi.prlsdk.Event<br />
init (...)<br />
prlsdkapi.prlsdk.Question<br />
x. init (...) initializes x; see x. class . doc for signature<br />
Overrides: object. init<br />
new (T, S, ...)<br />
Return Value<br />
a new object with type S, a subtype of T<br />
Overrides: object. new<br />
send answer(Question, answer code)<br />
Send answer.<br />
Return Value<br />
Job<br />
Inherited from prlsdkapi.prlsdk.Event(Section 2.8)<br />
getitem (), iter (), len (), get param(), get params count()<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
121
Module prlsdkapi.prlsdk Class Result<br />
2.15.2 Properties<br />
Name Description<br />
answers Returns answer variants tuple ((description,<br />
value, name), ).<br />
Inherited from prlsdkapi.prlsdk.Event (Section 2.8)<br />
event code, event str code, event type, explicit text, params count, sender,<br />
text<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle<br />
Inherited from object<br />
class<br />
2.16 Class Result<br />
object<br />
prlsdkapi.prlsdk.Base<br />
prlsdkapi.prlsdk.BaseAsync<br />
Result object class<br />
2.16.1 Methods<br />
x[y]<br />
getitem (x, y)<br />
init (...)<br />
prlsdkapi.prlsdk.Result<br />
x. init (...) initializes x; see x. class . doc for signature<br />
Overrides: object. init<br />
iter (x)<br />
iter(x)<br />
122
Module prlsdkapi.prlsdk Class Result<br />
len (x)<br />
len(x)<br />
new (T, S, ...)<br />
Return Value<br />
a new object with type S, a subtype of T<br />
Overrides: object. new<br />
get param(Result, index)<br />
Returns depending on parameter type some SDK object or string with passed<br />
index.<br />
Return Value<br />
some sdk object/string<br />
get param as string(Result, index)<br />
Returns as string representation of parameter with passed index.<br />
Return Value<br />
string<br />
get params count(Result, index)<br />
Returns parameters count.<br />
Return Value<br />
int<br />
Inherited from prlsdkapi.prlsdk.BaseAsync(Section 2.5)<br />
cmp (), repr (), cancel(), wait()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr (),<br />
str ()<br />
2.16.2 Properties<br />
Name Description<br />
params count Returns count of resulted params<br />
Inherited from prlsdkapi.prlsdk.BaseAsync (Section 2.5)<br />
expected h type , job , finished, handle type<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
123<br />
continued on next page
Module prlsdkapi.prlsdk Class ServerInfo<br />
Name Description<br />
handle<br />
Inherited from object<br />
class<br />
2.17 Class ServerInfo<br />
object<br />
prlsdkapi.prlsdk.Base<br />
ServerInfo object class<br />
2.17.1 Methods<br />
init (...)<br />
prlsdkapi.prlsdk.ServerInfo<br />
x. init (...) initializes x; see x. class . doc for signature<br />
Overrides: object. init<br />
new (T, S, ...)<br />
Return Value<br />
a new object with type S, a subtype of T<br />
Overrides: object. new<br />
str (x)<br />
str(x)<br />
Overrides: object. str<br />
Inherited from prlsdkapi.prlsdk.Base(Section 2.4)<br />
cmp (), repr ()<br />
Inherited from object<br />
delattr (), getattribute (), hash (), reduce (), reduce ex (), setattr ()<br />
2.17.2 Properties<br />
124
Module prlsdkapi.prlsdk Class ServerInfo<br />
Name Description<br />
host host name<br />
os version os version<br />
port port<br />
uuid server uuid<br />
Inherited from prlsdkapi.prlsdk.Base (Section 2.4)<br />
handle , handle type<br />
Inherited from object<br />
class<br />
125
Module prlsdkapi.prlsdk.consts<br />
3 Module prlsdkapi.prlsdk.consts<br />
3.1 Variables<br />
Name Description<br />
PAM DESKTOP Value: 1<br />
PAM SERVER Value: 0<br />
PAM WORKSTATION Value: 2<br />
PAO VM NOT SHARED Value: 0<br />
PAO VM SHARED ON -<br />
FULL ACCESS<br />
Value: 3<br />
PAO VM SHARED ON -<br />
VIEW<br />
Value: 1<br />
PAO VM SHARED ON -<br />
VIEW AND RUN<br />
Value: 2<br />
PAO VM START MANU-<br />
AL<br />
Value: 0<br />
PAO VM START ON L-<br />
OAD<br />
Value: 1<br />
PAO VM START ON R- Value: 2<br />
ELOAD<br />
PAO VM STOP Value: 0<br />
PAO VM SUSPEND Value: 1<br />
PBO CD HDD FLOPPY Value: 2<br />
PBO FLOPPY HDD CD Value: 1<br />
PBO HDD CD FLOPPY Value: 0<br />
PCM CPU AMD V Value: 2<br />
PCM CPU INTEL VT X Value: 1<br />
PCM CPU MODE 32 Value: 0<br />
PCM CPU MODE 64 Value: 1<br />
PCM CPU NONE HV Value: 0<br />
PDA DEVICE IDLE Value: 0<br />
PDA DEVICE READ Value: 1<br />
PDA DEVICE WRITE Value: 2<br />
PDE CLUSTERED DEVI-<br />
CE<br />
Value: 1<br />
PDE FLOPPY DISK Value: 3<br />
PDE GENERIC DEVICE Value: 0<br />
PDE GENERIC NETWO-<br />
RK ADAPTER<br />
Value: 8<br />
PDE GENERIC PCI DE-<br />
VICE<br />
Value: 17<br />
PDE GENERIC PORT Value: 9<br />
126<br />
continued on next page
Module prlsdkapi.prlsdk.consts Variables<br />
Name Description<br />
PDE GENERIC SCSI DE-<br />
VICE<br />
Value: 18<br />
PDE HARD DISK Value: 6<br />
PDE MASSSTORAGE D-<br />
EVICE<br />
Value: 4<br />
PDE MAX Value: 20<br />
PDE MIXER DEVICE Value: 13<br />
PDE OPTICAL DISK Value: 5<br />
PDE PARALLEL PORT Value: 11<br />
PDE PRINTER Value: 16<br />
PDE SERIAL PORT Value: 10<br />
PDE SOUND DEVICE Value: 12<br />
PDE STORAGE DEVIC-<br />
E<br />
Value: 2<br />
PDE USB DEVICE Value: 15<br />
PDT ANY TYPE Value: 65535<br />
PDT USE IMAGE FILE Value: 1<br />
PDT USE OTHER Value: 3<br />
PDT USE OUTPUT FIL-<br />
E<br />
Value: 2<br />
PDT USE REAL DEVIC-<br />
E<br />
Value: 0<br />
PFS UNIX LIKE FS Value: 1<br />
PFS WINDOWS LIKE F-<br />
S<br />
Value: 0<br />
PHD EXPANDING HAR-<br />
D DISK<br />
Value: 1<br />
PHD PLAIN HARD DIS-<br />
K<br />
Value: 0<br />
PHI REAL NET ADAPT-<br />
ER<br />
Value: 0<br />
PHI VIRTUAL NET AD-<br />
APTER<br />
Value: 1<br />
PHO LIN Value: 1<br />
PHO MAC Value: 0<br />
PHO WIN Value: 2<br />
PHT ACCESS RIGHTS Value: 268435504<br />
PHT BOOT DEVICE Value: 268435497<br />
PHT DISP CONFIG Value: 268435478<br />
PHT DISP NET ADAPT-<br />
ER<br />
Value: 268435481<br />
PHT EVENT Value: 268435474<br />
127<br />
continued on next page
Module prlsdkapi.prlsdk.consts Variables<br />
Name Description<br />
PHT EVENT PARAME-<br />
TER<br />
Value: 268435486<br />
PHT FOUND VM INFO Value: 268435506<br />
PHT HANDLES LIST Value: 268435502<br />
PHT HW GENERIC DE-<br />
VICE<br />
Value: 268435482<br />
PHT HW HARD DISK Value: 268435483<br />
PHT HW HARD DISK P-<br />
ARTITION<br />
Value: 268435484<br />
PHT HW NET ADAPTE-<br />
R<br />
Value: 268435485<br />
PHT JOB Value: 268435473<br />
PHT LICENSE Value: 268435495<br />
PHT LOGIN RESPONSE Value: 268435499<br />
PHT NET SERVICE ST-<br />
ATUS<br />
Value: 268435501<br />
PHT REMOTEDEV CM-<br />
D<br />
Value: 268435487<br />
PHT REMOTE FILESYS-<br />
TEM ENTRY<br />
Value: 268435460<br />
PHT REMOTE FILESYS-<br />
TEM INFO<br />
Value: 268435459<br />
PHT RESULT Value: 268435475<br />
PHT RUNNING TASK Value: 268435500<br />
PHT SCREEN RESOLU-<br />
TION<br />
Value: 268435480<br />
PHT SERVER Value: 268435457<br />
PHT SERVER CONFIG Value: 268435458<br />
PHT SERVER INFO Value: 268435496<br />
PHT SHARE Value: 268435479<br />
PHT STRINGS LIST Value: 268435498<br />
PHT SYSTEM STATIST-<br />
ICS<br />
Value: 268435488<br />
PHT SYSTEM STATIST-<br />
ICS CPU<br />
Value: 268435489<br />
PHT SYSTEM STATIST-<br />
ICS DISK<br />
Value: 268435492<br />
PHT SYSTEM STATIST-<br />
ICS DISK PARTITION<br />
Value: 268435493<br />
PHT SYSTEM STATIST-<br />
ICS IFACE<br />
Value: 268435490<br />
PHT SYSTEM STATIST-<br />
ICS PROCESS<br />
Value: 268435494<br />
128<br />
continued on next page
Module prlsdkapi.prlsdk.consts Variables<br />
Name Description<br />
PHT SYSTEM STATIST-<br />
ICS USER SESSION<br />
Value: 268435491<br />
PHT USER INFO Value: 268435508<br />
PHT USER PROFILE Value: 268435477<br />
PHT VIRTUAL DEV DI-<br />
SPLAY<br />
Value: 268435462<br />
PHT VIRTUAL DEV FL-<br />
OPPY<br />
Value: 268435465<br />
PHT VIRTUAL DEV HA-<br />
RD DISK<br />
Value: 268435466<br />
PHT VIRTUAL DEV KE-<br />
YBOARD<br />
Value: 268435463<br />
PHT VIRTUAL DEV M-<br />
OUSE<br />
Value: 268435464<br />
PHT VIRTUAL DEV NE-<br />
T ADAPTER<br />
Value: 268435467<br />
PHT VIRTUAL DEV OP-<br />
TICAL DISK<br />
Value: 268435470<br />
PHT VIRTUAL DEV PA-<br />
RALLEL PORT<br />
Value: 268435468<br />
PHT VIRTUAL DEV SE-<br />
RIAL PORT<br />
Value: 268435469<br />
PHT VIRTUAL DEV SO-<br />
UND<br />
Value: 268435472<br />
PHT VIRTUAL DEV US-<br />
B DEVICE<br />
Value: 268435471<br />
PHT VIRTUAL DISK Value: 268435503<br />
PHT VIRTUAL MACHI-<br />
NE<br />
Value: 268435461<br />
PHT VM INFO Value: 268435476<br />
PHT VM TOOLS INFO Value: 268435505<br />
PHY WIFI REAL NET -<br />
ADAPTER<br />
Value: 2<br />
PIF BMP Value: 1342177289<br />
PIF JPG Value: 1342177290<br />
PIF PNG Value: 1342177291<br />
PIF RAW Value: 1342177288<br />
PJOC JOB CANCEL Value: 1<br />
PJOC SRV ADD NET A-<br />
DAPTER<br />
Value: 35<br />
PJOC SRV ATTACH T-<br />
O LOST TASK<br />
Value: 39<br />
129<br />
continued on next page
Module prlsdkapi.prlsdk.consts Variables<br />
Name Description<br />
PJOC SRV COMMON P- Value: 8<br />
REFS BEGIN EDIT<br />
PJOC SRV COMMON P- Value: 9<br />
REFS COMMIT<br />
PJOC SRV DELETE NE- Value: 36<br />
T ADAPTER<br />
PJOC SRV FS CAN CR- Value: 23<br />
EATE FILE<br />
PJOC SRV FS CREATE- Value: 21<br />
DIR<br />
PJOC SRV FS GENERA- Value: 25<br />
TE ENTRY NAME<br />
PJOC SRV FS GET DIR- Value: 20<br />
ENTRIES<br />
PJOC SRV FS GET DIS- Value: 19<br />
K LIST<br />
PJOC SRV FS REMOVE- Value: 22<br />
ENTRY<br />
PJOC SRV FS RENAME- Value: 24<br />
ENTRY<br />
PJOC SRV GET ALL H- Value: 100<br />
OST USERS<br />
PJOC SRV GET COMM- Value: 7<br />
ON PREFS<br />
PJOC SRV GET LICEN- Value: 27<br />
SE INFO<br />
PJOC SRV GET NET S- Value: 34<br />
ERVICE STATUS<br />
PJOC SRV GET PROBL- Value: 38<br />
EM REPORT<br />
PJOC SRV GET SRV C- Value: 6<br />
ONFIG<br />
PJOC SRV GET STATI- Value: 11<br />
STICS<br />
PJOC SRV GET USER I- Value: 41<br />
NFO<br />
PJOC SRV GET USER I- Value: 40<br />
NFO LIST<br />
PJOC SRV GET USER - Value: 10<br />
PROFILE<br />
PJOC SRV GET VM LIS- Value: 15<br />
T<br />
130<br />
continued on next page
Module prlsdkapi.prlsdk.consts Variables<br />
Name Description<br />
PJOC SRV LOGIN Value: 3<br />
PJOC SRV LOGIN LOC- Value: 4<br />
AL<br />
PJOC SRV LOGOFF Value: 5<br />
PJOC SRV LOOKUP PA- Value: 2<br />
RALLELS SERVERS<br />
PJOC SRV NET SERVI- Value: 32<br />
CE RESTART<br />
PJOC SRV NET SERVI- Value: 33<br />
CE RESTORE DEFAUL-<br />
TS<br />
PJOC SRV NET SERVI- Value: 30<br />
CE START<br />
PJOC SRV NET SERVI- Value: 31<br />
CE STOP<br />
PJOC SRV REGISTER - Value: 14<br />
VM<br />
PJOC SRV SEND ANSW- Value: 28<br />
ER<br />
PJOC SRV SHUTDOWN Value: 18<br />
PJOC SRV START SEA- Value: 29<br />
RCH VMS<br />
PJOC SRV SUBSCRIBE - Value: 16<br />
TO HOST STATISTICS<br />
PJOC SRV UNSUBSCRI- Value: 17<br />
BE FROM HOST STATI-<br />
STICS<br />
PJOC SRV UPDATE LI- Value: 26<br />
CENSE<br />
PJOC SRV UPDATE NE- Value: 37<br />
T ADAPTER<br />
PJOC SRV USER PROF- Value: 12<br />
ILE BEGIN EDIT<br />
PJOC SRV USER PROF- Value: 13<br />
ILE COMMIT<br />
PJOC UNKNOWN Value: 0<br />
PJOC VM BEGIN EDIT Value: 62<br />
PJOC VM CANCEL CO- Value: 89<br />
MPRESSOR<br />
PJOC VM CLONE Value: 50<br />
PJOC VM COMMIT Value: 63<br />
PJOC VM CREATE UN- Value: 64<br />
ATTENDED FLOPPY<br />
131<br />
continued on next page
Module prlsdkapi.prlsdk.consts Variables<br />
Name Description<br />
PJOC VM DELETE Value: 51<br />
PJOC VM DEV CONNE-<br />
CT<br />
Value: 68<br />
PJOC VM DEV CREAT-<br />
E IMAGE<br />
Value: 70<br />
PJOC VM DEV DISCON-<br />
NECT<br />
Value: 69<br />
PJOC VM DROP SUSPE-<br />
NDED STATE<br />
Value: 49<br />
PJOC VM GENERATE -<br />
VM DEV FILENAME<br />
Value: 54<br />
PJOC VM GET PROBL-<br />
EM REPORT<br />
Value: 52<br />
PJOC VM GET STATE Value: 53<br />
PJOC VM GET STATIS-<br />
TICS<br />
Value: 57<br />
PJOC VM GET SUSPEN-<br />
DED SCREEN<br />
Value: 86<br />
PJOC VM GET TOOLS -<br />
STATE<br />
Value: 55<br />
PJOC VM INITIATE DE-<br />
V STATE NOTIFICATI-<br />
ONS<br />
Value: 65<br />
PJOC VM INSTALL TO-<br />
OLS<br />
Value: 71<br />
PJOC VM INSTALL UTI-<br />
LITY<br />
Value: 98<br />
PJOC VM PAUSE Value: 44<br />
PJOC VM REFRESH C-<br />
ONFIG<br />
Value: 56<br />
PJOC VM REG Value: 60<br />
PJOC VM RESET Value: 45<br />
PJOC VM RESTORE Value: 101<br />
PJOC VM RESUME Value: 42<br />
PJOC VM RUN COMPR-<br />
ESSOR<br />
Value: 88<br />
PJOC VM START Value: 42<br />
PJOC VM STOP Value: 43<br />
PJOC VM SUBSCRIBE -<br />
TO GUEST STATISTIC-<br />
S<br />
Value: 58<br />
PJOC VM SUSPEND Value: 46<br />
132<br />
continued on next page
Module prlsdkapi.prlsdk.consts Variables<br />
Name Description<br />
PJOC VM UNREG Value: 61<br />
PJOC VM UNSUBSCRI-<br />
BE FROM GUEST STA-<br />
TISTICS<br />
Value: 59<br />
PJOC VM UPDATE SE-<br />
CURITY<br />
Value: 66<br />
PJOC VM UPDATE TO-<br />
OLS SECTION<br />
Value: 99<br />
PJOC VM VALIDATE C-<br />
ONFIG<br />
Value: 67<br />
PKE CLICK Value: 255<br />
PKE PRESS Value: 0<br />
PKE RELEASE Value: 128<br />
PLM ROOT ACOUNT Value: 1<br />
PLM START ACOUNT Value: 0<br />
PLM USER ACOUNT Value: 2<br />
PMB LEFT BUTTON Value: 1<br />
PMB MIDDLE BUTTON Value: 4<br />
PMB NOBUTTON Value: 0<br />
PMB RIGHT BUTTON Value: 2<br />
PMS IDE DEVICE Value: 0<br />
PMS SCSI DEVICE Value: 1<br />
PMT ANSWER Value: 4<br />
PMT CRITICAL Value: 2<br />
PMT INFORMATION Value: 1<br />
PMT QUESTION Value: 3<br />
PMT WARNING Value: 0<br />
PNA BRIDGED ETHER-<br />
NET<br />
Value: 2<br />
PNA HOST ONLY Value: 0<br />
PNA SHARED Value: 1<br />
PRD AUTO Value: 1<br />
PRD DISABLED Value: 0<br />
PRD MANUAL Value: 2<br />
PRL ERR FLOPPY IMA-<br />
GE ALREADY EXIST<br />
Value: -2147483050<br />
PRL ERR HDD IMAGE -<br />
IS ALREADY EXIST<br />
Value: -2147483000<br />
PSE DIRECTORY Value: 1<br />
PSE DRIVE Value: 0<br />
PSE FILE Value: 2<br />
PSK VM REBOOT Value: 1<br />
133<br />
continued on next page
Module prlsdkapi.prlsdk.consts Variables<br />
Name Description<br />
PSK VM SHUTDOWN Value: 0<br />
PSL HIGH SECURITY Value: 2<br />
PSL LOW SECURITY Value: 0<br />
PSL NORMAL SECURI-<br />
TY<br />
Value: 1<br />
PSP SERIAL SOCKET -<br />
CLIENT<br />
Value: 1<br />
PSP SERIAL SOCKET S- Value: 0<br />
ERVER<br />
PSS NOT INSTALLED Value: 2<br />
PSS STARTED Value: 0<br />
PSS STOPPED Value: 1<br />
PSS UNKNOWN Value: 3<br />
PTIS RECORD ACTIVE Value: 1<br />
PTIS RECORD CANCE- Value: 2<br />
LED<br />
PTIS RECORD EMPTY Value: 0<br />
PTS INSTALLED Value: 2<br />
PTS NOT INSTALLED Value: 1<br />
PTS OUTDATED Value: 3<br />
PTS POSSIBLY INSTAL- Value: 0<br />
LED<br />
PTS UNKNOWN Value: 0<br />
PTU CMD INVALID Value: 0<br />
PTU CMD PTU ALIVE Value: 1<br />
PVA ACCELERATION -<br />
DISABLED<br />
Value: 0<br />
PVA ACCELERATION -<br />
HIGH<br />
Value: 2<br />
PVA ACCELERATION - Value: 1<br />
NORMAL<br />
PVC ALL Value: 1<br />
PVC BOOT OPTION Value: 3<br />
PVC CD DVD ROM Value: 10<br />
PVC CPU Value: 6<br />
PVC FLOPPY DISK Value: 9<br />
PVC GENERAL PARA- Value: 2<br />
METERS<br />
PVC HARD DISK Value: 11<br />
PVC IDE DEVICES Value: 16<br />
PVC MAIN MEMORY Value: 7<br />
PVC NETWORK ADAP-<br />
TER<br />
Value: 12<br />
134<br />
continued on next page
Module prlsdkapi.prlsdk.consts Variables<br />
Name Description<br />
PVC PARALLEL PORT Value: 15<br />
PVC REMOTE DISPLA-<br />
Y<br />
Value: 4<br />
PVC SCSI DEVICES Value: 17<br />
PVC SERIAL PORT Value: 14<br />
PVC SHARED FOLDER-<br />
S<br />
Value: 5<br />
PVC SOUND Value: 13<br />
PVC VIDEO MEMORY Value: 8<br />
PVR PRIORITY HIGH Value: 2<br />
PVR PRIORITY LOW Value: 0<br />
PVR PRIORITY NORM-<br />
AL<br />
Value: 1<br />
PVS GUEST TYPE FRE-<br />
EBSD<br />
Value: 10<br />
PVS GUEST TYPE LIN-<br />
UX<br />
Value: 9<br />
PVS GUEST TYPE MA-<br />
COS<br />
Value: 7<br />
PVS GUEST TYPE MSD-<br />
OS<br />
Value: 12<br />
PVS GUEST TYPE NET-<br />
WARE<br />
Value: 13<br />
PVS GUEST TYPE OS2 Value: 11<br />
PVS GUEST TYPE OTH-<br />
ER<br />
Value: 255<br />
PVS GUEST TYPE SOL-<br />
ARIS<br />
Value: 14<br />
PVS GUEST TYPE WIN-<br />
DOWS<br />
Value: 8<br />
PVS GUEST VER BSD 4-<br />
X<br />
Value: 2561<br />
PVS GUEST VER BSD 5-<br />
X<br />
Value: 2562<br />
PVS GUEST VER BSD 6-<br />
X<br />
Value: 2563<br />
PVS GUEST VER BSD 7-<br />
X<br />
Value: 2564<br />
PVS GUEST VER BSD -<br />
OTHER<br />
Value: 2815<br />
PVS GUEST VER DOS -<br />
MS622<br />
Value: 3073<br />
135<br />
continued on next page
Module prlsdkapi.prlsdk.consts Variables<br />
Name Description<br />
PVS GUEST VER DOS - Value: 3327<br />
OTHER<br />
PVS GUEST VER LIN C- Value: 2317<br />
ENTOS<br />
PVS GUEST VER LIN D- Value: 2310<br />
EBIAN<br />
PVS GUEST VER LIN F- Value: 2311<br />
EDORA<br />
PVS GUEST VER LIN F- Value: 2312<br />
EDORA 5<br />
PVS GUEST VER LIN K- Value: 2308<br />
RNL 24<br />
PVS GUEST VER LIN K- Value: 2309<br />
RNL 26<br />
PVS GUEST VER LIN - Value: 2307<br />
MANDRAKE<br />
PVS GUEST VER LIN O- Value: 2319<br />
PENSUSE<br />
PVS GUEST VER LIN O- Value: 2559<br />
THER<br />
PVS GUEST VER LIN R- Value: 2305<br />
EDHAT<br />
PVS GUEST VER LIN R- Value: 2316<br />
HLES3<br />
PVS GUEST VER LIN R- Value: 2318<br />
H LEGACY<br />
PVS GUEST VER LIN S- Value: 2315<br />
LES9<br />
PVS GUEST VER LIN S- Value: 2306<br />
USE<br />
PVS GUEST VER LIN U- Value: 2314<br />
BUNTU<br />
PVS GUEST VER LIN X- Value: 2313<br />
ANDROS<br />
PVS GUEST VER MAC- Value: 1794<br />
OS LEOPARD<br />
PVS GUEST VER MAC- Value: 1795<br />
OS SNOW LEOPARD<br />
PVS GUEST VER MAC- Value: 1793<br />
OS TIGER<br />
PVS GUEST VER NET - Value: 3329<br />
4X<br />
136<br />
continued on next page
Module prlsdkapi.prlsdk.consts Variables<br />
Name Description<br />
PVS GUEST VER NET - Value: 3330<br />
5X<br />
PVS GUEST VER NET - Value: 3331<br />
6X<br />
PVS GUEST VER NET - Value: 3583<br />
OTHER<br />
PVS GUEST VER OS2 E- Value: 2820<br />
CS11<br />
PVS GUEST VER OS2 E- Value: 2821<br />
CS12<br />
PVS GUEST VER OS2 - Value: 3071<br />
OTHER<br />
PVS GUEST VER OS2 - Value: 2817<br />
WARP3<br />
PVS GUEST VER OS2 - Value: 2818<br />
WARP4<br />
PVS GUEST VER OS2 - Value: 2819<br />
WARP45<br />
PVS GUEST VER OTH - Value: 65282<br />
OPENSTEP<br />
PVS GUEST VER OTH - Value: 65535<br />
OTHER<br />
PVS GUEST VER OTH - Value: 65281<br />
QNX<br />
PVS GUEST VER SOL 1- Value: 3586<br />
0<br />
PVS GUEST VER SOL 9 Value: 3585<br />
PVS GUEST VER SOL - Value: 3839<br />
OTHER<br />
PVS GUEST VER WIN - Value: 2056<br />
2003<br />
PVS GUEST VER WIN - Value: 2058<br />
2008<br />
PVS GUEST VER WIN - Value: 2054<br />
2K<br />
PVS GUEST VER WIN - Value: 2049<br />
311<br />
PVS GUEST VER WIN - Value: 2050<br />
95<br />
PVS GUEST VER WIN - Value: 2051<br />
98<br />
PVS GUEST VER WIN - Value: 2052<br />
ME<br />
137<br />
continued on next page
Module prlsdkapi.prlsdk.consts Variables<br />
Name Description<br />
PVS GUEST VER WIN - Value: 2053<br />
NT<br />
PVS GUEST VER WIN - Value: 2303<br />
OTHER<br />
PVS GUEST VER WIN - Value: 2057<br />
VISTA<br />
PVS GUEST VER WIN - Value: 2059<br />
WINDOWS7<br />
PVS GUEST VER WIN - Value: 2055<br />
XP<br />
PWM COHERENCE WI- Value: 3<br />
NDOW MODE<br />
PWM DEFAULT WIND- Value: 0<br />
OW MODE<br />
PWM FULL SCREEN W- Value: 2<br />
INDOW MODE<br />
PWM MODALITY WIN- Value: 4<br />
DOW MODE<br />
PWM WINDOWED WIN- Value: 1<br />
DOW MODE<br />
RTT RUNNING TASK - Value: 3<br />
CLONE VM<br />
RTT RUNNING TASK - Value: 6<br />
CREATE IMAGE<br />
RTT RUNNING TASK - Value: 1<br />
CREATE VM<br />
RTT RUNNING TASK - Value: 4<br />
DELETE VM<br />
RTT RUNNING TASK - Value: 2<br />
REGISTER VM<br />
RTT RUNNING TASK - Value: 7<br />
RESTORE VM<br />
RTT RUNNING TASK - Value: 0<br />
UNKNOWN<br />
RTT RUNNING TASK - Value: 5<br />
UNREG VM<br />
ScanCodesList Value: {’0’: (11), ’1’: (2), ’2’:<br />
(3), ’3’: (4), ’4’: (5), ’5’: ...<br />
VMS COMPACTING Value: 805306376<br />
VMS CONTINUING Value: 805306381<br />
VMS DELETING STAT- Value: 805306383<br />
E<br />
138<br />
continued on next page
Module prlsdkapi.prlsdk.consts Variables<br />
Name Description<br />
VMS MIGRATING Value: 805306382<br />
VMS PAUSED Value: 805306373<br />
VMS PAUSING Value: 805306380<br />
VMS RESETTING Value: 805306379<br />
VMS RESTORING Value: 805306371<br />
VMS RESUMING Value: 805306384<br />
VMS RUNNING Value: 805306372<br />
VMS SNAPSHOTING Value: 805306378<br />
VMS STARTING Value: 805306370<br />
VMS STOPPED Value: 805306369<br />
VMS STOPPING Value: 805306375<br />
VMS SUSPENDED Value: 805306377<br />
VMS SUSPENDING Value: 805306374<br />
VMS UNKNOWN Value: 0<br />
139
Module prlsdkapi.prlsdk.errors<br />
4 Module prlsdkapi.prlsdk.errors<br />
4.1 Variables<br />
Name Description<br />
GUI ERR CANT SAVE - Value: 2147569730<br />
CONFIG AS VM WAS D-<br />
ELETED<br />
GUI ERR WRONG NUM- Value: 2147569696<br />
BER OF CPU<br />
PRL ERR ACCESS DEN- Value: 2147483653<br />
IED<br />
PRL ERR ACCESS DEN- Value: 2147484545<br />
IED TO CHANGE PER-<br />
MISSIONS<br />
PRL ERR ACCESS DEN- Value: 2147483768<br />
IED TO DISK IMAGE<br />
PRL ERR ACCESS DEN- Value: 2147484512<br />
INED TO RUN WIZARD<br />
PRL ERR ACCESS TOK- Value: 2147483744<br />
EN INVALID<br />
PRL ERR ACCESS TO - Value: 2147484217<br />
VM DENIED<br />
PRL ERR ACCES DENI- Value: 2147483904<br />
ED FILE TO PARENT -<br />
PARENT DIR<br />
PRL ERR ADD HW FL- Value: 2147484439<br />
OPPY IMAGE NOT SPE-<br />
CIFYED<br />
PRL ERR ADD VM OP- Value: 2147484441<br />
ERATION WAS CANCE-<br />
LED<br />
PRL ERR ALIGN ON 4 Value: 2147484163<br />
PRL ERR ALREADY C- Value: 2147484242<br />
ONNECTED TO DISPA-<br />
TCHER<br />
PRL ERR ANOTHER U- Value: 2147484513<br />
SER SESSIONS PRESEN-<br />
T<br />
PRL ERR <strong>API</strong> INCOMP- Value: 2147484706<br />
ATIBLE<br />
PRL ERR <strong>API</strong> WASNT I- Value: 2147484295<br />
NITIALIZED<br />
140<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR ATTACH TO - Value: 2147484489<br />
TASK BAD SESSION<br />
PRL ERR AUTHENTIC- Value: 2147484464<br />
ATION FAILED<br />
PRL ERR BAD DISP C- Value: 2147483680<br />
ONFIG FILE SPECIFIE-<br />
D<br />
PRL ERR BAD PARAM- Value: 2147483779<br />
ETERS<br />
PRL ERR BAD VM CO- Value: 2147483698<br />
NFIG FILE SPECIFIED<br />
PRL ERR BAD VM DIR- Value: 2147483687<br />
CONFIG FILE SPECIFI-<br />
ED<br />
PRL ERR BUFFER OVE- Value: 2147483654<br />
RRUN<br />
PRL ERR CANNOT PR- Value: 2147484741<br />
OCESSING SAFE MOD-<br />
E FOR INVALID VM<br />
PRL ERR CANNOT PR- Value: 2147484740<br />
OCESSING UNDO DISK-<br />
S FOR INVALID VM<br />
PRL ERR CANTS CRE- Value: 2147484550<br />
ATE DISK IMAGE ON -<br />
FAT<br />
PRL ERR CANTS CRE- Value: 2147484551<br />
ATE DISK IMAGE ON -<br />
FAT32<br />
PRL ERR CANT ALOC- Value: 2147483913<br />
A MEM FILE COPY<br />
PRL ERR CANT CHAN- Value: 2147484473<br />
GE FILE PERMISSIONS<br />
PRL ERR CANT CHAN- Value: 2147484564<br />
GE OWNER OF DISK I-<br />
MAGE FILE<br />
PRL ERR CANT CHAN- Value: 2147484289<br />
GE OWNER OF FILE<br />
PRL ERR CANT CHAN- Value: 2147484563<br />
GE OWNER OF VM FIL-<br />
E<br />
PRL ERR CANT CONFI- Value: 2147484697<br />
GURE PARTITION HD-<br />
D<br />
141<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR CANT CONFI- Value: 2147484472<br />
GURE PHYSICAL HDD<br />
PRL ERR CANT CONN- Value: 2147484233<br />
ECT TO DISPATCHER<br />
PRL ERR CANT CONV- Value: 2147484432<br />
ERT HDD IMAGE FILE<br />
PRL ERR CANT CONV- Value: 2147484549<br />
ERT OLD VM WITH IN-<br />
STALLED TOOLS<br />
PRL ERR CANT CONV- Value: 2147484424<br />
ERT VM CONFIG DUE -<br />
UNDO DISKS PRESENT<br />
PRL ERR CANT CONV- Value: 2147484425<br />
ERT VM CONFIG DUE -<br />
UNDO SNAPSHOTS PR-<br />
ESENT<br />
PRL ERR CANT CREA- Value: 2147483801<br />
TE FLOPPY IMAGE<br />
PRL ERR CANT CREA- Value: 2147483800<br />
TE HDD IMAGE<br />
PRL ERR CANT CREA- Value: 2147484553<br />
TE HDD IMAGE NO SP-<br />
ACE<br />
PRL ERR CANT CREA- Value: 2147483905<br />
TE PARALLEL PORT I-<br />
MAGE<br />
PRL ERR CANT CREA- Value: 2147484672<br />
TE SERIAL PORT IMA-<br />
GE<br />
PRL ERR CANT DELE- Value: 2147484290<br />
TE FILE<br />
PRL ERR CANT EDIT S- Value: 2147483908<br />
USPENDED VM<br />
PRL ERR CANT GET F- Value: 2147484546<br />
ILE PERMISSIONS<br />
PRL ERR CANT INIT R- Value: 2147484274<br />
EAL CPUS INFO<br />
PRL ERR CANT PARSE- Value: 2147484228<br />
DISP EVENT<br />
PRL ERR CANT PARSE- Value: 2147484201<br />
VM CONFIG<br />
142<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR CANT RECR- Value: 2147484457<br />
EATE HDD<br />
PRL ERR CANT REMO- Value: 2147484680<br />
VE DIR ENTRY<br />
PRL ERR CANT REMO- Value: 2147483778<br />
VE ENTRY<br />
PRL ERR CANT REMO- Value: 2147484547<br />
VE INVALID VM AS N-<br />
ON ADMIN<br />
PRL ERR CANT RENA- Value: 2147484681<br />
ME DIR ENTRY<br />
PRL ERR CANT RENA- Value: 2147483777<br />
ME ENTRY<br />
PRL ERR CANT REPL- Value: 2147484467<br />
ACE FLOPPY IMAGE<br />
PRL ERR CANT SUSPE- Value: 2147614736<br />
ND VM WITH BOOTCA-<br />
MP<br />
PRL ERR CANT TO CH- Value: 2147484695<br />
ANGE PERMISSIONS O-<br />
N REMOTE LOCATION<br />
PRL ERR CANT TO ST- Value: 2147484520<br />
ART VM TEMPLATE<br />
PRL ERR CANT UPDA- Value: 2147484466<br />
TE DEVICE INFO<br />
PRL ERR CAN NOT GE- Value: 2147484422<br />
T DISK FREE SPACE<br />
PRL ERR CDD IMAGE - Value: 2147484168<br />
NOT SPECIFIED<br />
PRL ERR CLONE OPE- Value: 2147483911<br />
RATION CANCELED<br />
PRL ERR COMMAND S- Value: 2147484705<br />
UPPORTED ONLY AT -<br />
SERVER MODE<br />
PRL ERR COMMON SE- Value: 2147484273<br />
RVER PREFS BLOCKE-<br />
D TO CHANGE<br />
PRL ERR COMMON SE- Value: 2147483938<br />
RVER PREFS WERE C-<br />
HANGED<br />
PRL ERR COM DEVICE- Value: 2147484244<br />
ALREADY EXIST<br />
143<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR COM OUTPU- Value: 2147484181<br />
T FILE IS NOT SPECIFI-<br />
ED<br />
PRL ERR COM OUTPU- Value: 2147484183<br />
T FILE NOT EXIST<br />
PRL ERR CONCURREN- Value: 2147484226<br />
T COMMAND EXECUT-<br />
ING<br />
PRL ERR CONFIG BEG- Value: 2147484486<br />
IN EDIT NOT FOUND -<br />
OBJECT UUID<br />
PRL ERR CONFIG BEG- Value: 2147484487<br />
IN EDIT NOT FOUND -<br />
USER UUID<br />
PRL ERR CONFIG EDI- Value: 2147484451<br />
T COLLISION<br />
PRL ERR CONFIG FILE- Value: 2147483704<br />
NOT SET<br />
PRL ERR CORE STATE- Value: 2147614724<br />
CHANGE VM CONFIG<br />
PRL ERR CORE STATE- Value: 2147614723<br />
CORRUPT MEM FILE<br />
PRL ERR CORE STATE- Value: 2147614722<br />
CORRUPT SAV FILE<br />
PRL ERR CORE STATE- Value: 2147614720<br />
ERROR COMMON<br />
PRL ERR CORE STATE- Value: 2147614721<br />
INV SAV VERSION<br />
PRL ERR COULDNT C- Value: 2147484309<br />
REATE AUTHORIZATI-<br />
ON FILE<br />
PRL ERR COULDNT SE- Value: 2147484310<br />
T PERMISSIONS TO A-<br />
UTHORIZATION FILE<br />
PRL ERR CPU RESTAR- Value: 2147484544<br />
T<br />
PRL ERR CPU SHUTD- Value: 2147484537<br />
OWN<br />
PRL ERR CREATE PRI- Value: 2147577858<br />
VELEGED PROCESS<br />
PRL ERR DELETING V- Value: 2147484243<br />
M FROM CATALOGUE<br />
144<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR DEV ALREA- Value: 2147520512<br />
DY CONNECTED<br />
PRL ERR DEV ALREA- Value: 2147520513<br />
DY DISCONNECTED<br />
PRL ERR DEV DISABL- Value: 2147484483<br />
E AFTER LOST<br />
PRL ERR DEV FLOPPY- Value: 2147487744<br />
CONNECT FAILED<br />
PRL ERR DEV MAX C- Value: 2147549185<br />
D HDD EXCEEDED<br />
PRL ERR DEV MAX N- Value: 2147549184<br />
UMBER EXCEEDED<br />
PRL ERR DEV PARALL- Value: 2147512322<br />
EL PORT FILE CONNE-<br />
CT FAILED<br />
PRL ERR DEV PARALL- Value: 2147512320<br />
EL PORT PHYSICAL C-<br />
ONNECT FAILED<br />
PRL ERR DEV PARALL- Value: 2147512321<br />
EL PORT PRINTER CO-<br />
NNECT FAILED<br />
PRL ERR DEV PARALL- Value: 2147512323<br />
EL PORT REMOTE CO-<br />
NNECT FAILED<br />
PRL ERR DEV SERIAL - Value: 2147508226<br />
PORT FILE CONNECT -<br />
FAILED<br />
PRL ERR DEV SERIAL - Value: 2147508224<br />
PORT PHYSICAL CON-<br />
NECT FAILED<br />
PRL ERR DEV SERIAL - Value: 2147508225<br />
PORT PIPE CONNECT -<br />
FAILED<br />
PRL ERR DEV SERIAL - Value: 2147508227<br />
PORT REMOTE CONN-<br />
ECT FAILED<br />
PRL ERR DEV USB HA- Value: 2147516419<br />
RD DEVICE INSERTED<br />
PRL ERR DEV USB INS- Value: 2147516417<br />
TALL DRIVER FAILED<br />
PRL ERR DEV USB NO- Value: 2147516418<br />
FREE PORTS<br />
145<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR DEV USB OP- Value: 2147516416<br />
EN MANAGER FAILED<br />
PRL ERR DIRECTORY - Value: 2147483765<br />
DOES NOT EXIST<br />
PRL ERR DISK BLOCK- Value: 2147618885<br />
CREATED<br />
PRL ERR DISK BLOCK- Value: 2147618841<br />
PARTIALLY PROCESS-<br />
ED<br />
PRL ERR DISK BLOCK- Value: 2147622915<br />
SEARCH FAILED<br />
PRL ERR DISK BLOCK- Value: 2147618840<br />
SKIPPED<br />
PRL ERR DISK BOOTC- Value: 2147618905<br />
AMP WRITE MBR<br />
PRL ERR DISK CANT I- Value: 2147618889<br />
NITIALIZE IMAGE<br />
PRL ERR DISK COMPR- Value: 2147622913<br />
ESSED FILE EMPTY<br />
PRL ERR DISK CREAT- Value: 2147618838<br />
E IMAGE ERROR<br />
PRL ERR DISK DATA - Value: 2147627008<br />
NOT FOUND<br />
PRL ERR DISK DIR CR- Value: 2147618837<br />
EATE ERROR<br />
PRL ERR DISK DISK N- Value: 2147618849<br />
OT OPENED<br />
PRL ERR DISK ENLAR- Value: 2147618903<br />
GE FAILED<br />
PRL ERR DISK FAT32 - Value: 2147618851<br />
SIZE EXCEEDED<br />
PRL ERR DISK FILE C- Value: 2147618835<br />
REATE ERROR<br />
PRL ERR DISK FILE E- Value: 2147618834<br />
XISTS<br />
PRL ERR DISK FILE O- Value: 2147618836<br />
PEN ERROR<br />
PRL ERR DISK FSYNC - Value: 2147618865<br />
FAILED<br />
PRL ERR DISK FULLFS- Value: 2147618866<br />
YNC FAILED<br />
PRL ERR DISK GENER- Value: 2147618816<br />
IC ERROR<br />
146<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR DISK GET M- Value: 2147631104<br />
OUNTPATH FAILED<br />
PRL ERR DISK GET P- Value: 2147631107<br />
ARAMS FAILED<br />
PRL ERR DISK GROUP- Value: 2147618886<br />
INTERSECT<br />
PRL ERR DISK IDENTI- Value: 2147631108<br />
FY FAILED<br />
PRL ERR DISK IMAGE- Value: 2147618824<br />
S CORRUPTED<br />
PRL ERR DISK IMAGE - Value: 2147618884<br />
BUSY<br />
PRL ERR DISK INCOR- Value: 2147618887<br />
RECTLY CLOSED<br />
PRL ERR DISK INSUFF- Value: 2147618850<br />
ICIENT SPACE<br />
PRL ERR DISK INTER- Value: 2147618853<br />
NAL CLASS ERROR<br />
PRL ERR DISK INVALI- Value: 2147618825<br />
D BLOCKSIZE<br />
PRL ERR DISK INVALI- Value: 2147618867<br />
D FORMAT<br />
PRL ERR DISK INVALI- Value: 2147618833<br />
D PARAMETERS<br />
PRL ERR DISK MEMO- Value: 2147618848<br />
RY ERROR<br />
PRL ERR DISK MOUNT- Value: 2147631105<br />
FAILED<br />
PRL ERR DISK NOT IM- Value: 2147618882<br />
PLEMENTED<br />
PRL ERR DISK NOT P- Value: 2147618852<br />
ERMITTED<br />
PRL ERR DISK NOT V- Value: 2147618902<br />
ALID OFFSET<br />
PRL ERR DISK NULL P- Value: 2147618897<br />
ART SIZE<br />
PRL ERR DISK OFFSE- Value: 2147618888<br />
TS FIXED<br />
PRL ERR DISK OPERA- Value: 2147618870<br />
TION ABORTED<br />
PRL ERR DISK OPERA- Value: 2147618839<br />
TION IN PROGRESS<br />
147<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR DISK OPERA- Value: 2147618869<br />
TION NOT ALLOWED<br />
PRL ERR DISK PARTI- Value: 2147618883<br />
TIONS TABLE CYCLE<br />
PRL ERR DISK PARTI- Value: 2147618900<br />
TION INVALID NAME<br />
PRL ERR DISK PARTI- Value: 2147618899<br />
TION NOT FOUND<br />
PRL ERR DISK POINT- Value: 2147622916<br />
ERS MIXED UP<br />
PRL ERR DISK POSSIB- Value: 2147618904<br />
LE OVERRUN<br />
PRL ERR DISK READ - Value: 2147618857<br />
FAILED<br />
PRL ERR DISK READ - Value: 2147618856<br />
OUT DISK<br />
PRL ERR DISK RENAM- Value: 2147618868<br />
E ERROR<br />
PRL ERR DISK RESER- Value: 2147627009<br />
VED WORD<br />
PRL ERR DISK SET CA- Value: 2147618864<br />
CHING FAILED<br />
PRL ERR DISK SHARE- Value: 2147622912<br />
D BLOCK<br />
PRL ERR DISK SHARIN- Value: 2147618871<br />
G VIOLATION<br />
PRL ERR DISK SMALL - Value: 2147618896<br />
IMAGE SIZE<br />
PRL ERR DISK SNAPS- Value: 2147618822<br />
HOTS CORRUPTED<br />
PRL ERR DISK STATE- Value: 2147618832<br />
S ERROR<br />
PRL ERR DISK STORA- Value: 2147618823<br />
GE CORRUPTED<br />
PRL ERR DISK TRUNC- Value: 2147622914<br />
ATE FAILED<br />
PRL ERR DISK UNALI- Value: 2147618901<br />
GNED<br />
PRL ERR DISK UNMO- Value: 2147631106<br />
UNT FAILED<br />
PRL ERR DISK USER I- Value: 2147618872<br />
NTERRUPTED<br />
148<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR DISK WRITE - Value: 2147618855<br />
FAILED<br />
PRL ERR DISK WRITE - Value: 2147618854<br />
OUT DISK<br />
PRL ERR DISK WRITE - Value: 2147618881<br />
REAL FAILED<br />
PRL ERR DISK XML IN- Value: 2147618818<br />
VALID<br />
PRL ERR DISK XML IN- Value: 2147618819<br />
VALID VERSION<br />
PRL ERR DISK XML L- Value: 2147618821<br />
ARGE FILE<br />
PRL ERR DISK XML L- Value: 2147618898<br />
OCKED<br />
PRL ERR DISK XML O- Value: 2147618817<br />
PEN FAILED<br />
PRL ERR DISK XML S- Value: 2147618820<br />
AVE ERROR<br />
PRL ERR DISK XML S- Value: 2147618873<br />
AVE REMOVE ERROR<br />
PRL ERR DISK XML S- Value: 2147618880<br />
AVE RENAME ERROR<br />
PRL ERR DISP2DISP S- Value: 2147680256<br />
ESSION ALREADY AU-<br />
THORIZED<br />
PRL ERR DISP2DISP W- Value: 2147680257<br />
RONG USER SESSION -<br />
UUID<br />
PRL ERR DISPATCHER- Value: 2147484516<br />
SERVICE MODE<br />
PRL ERR DISP CONFI- Value: 2147483685<br />
G ALREADY EXISTS<br />
PRL ERR DISP CONFI- Value: 2147483712<br />
G FILE NOT SET<br />
PRL ERR DISP CONFI- Value: 2147483750<br />
G WRITE ERR<br />
PRL ERR DISP LOGON- Value: 2147484693<br />
ACTIONS REACHED U-<br />
P LIMIT<br />
PRL ERR DISP SHUTD- Value: 2147484676<br />
OWN IN PROCESS<br />
149<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR DISP VM CO- Value: 2147484694<br />
MMAND CANT BE EXE-<br />
CUTED<br />
PRL ERR DISP VM IS - Value: 2147484535<br />
NOT STARTED<br />
PRL ERR DOUBLE INI- Value: 2147483665<br />
T<br />
PRL ERR DROP SUSPE- Value: 2147484677<br />
ND FOR HDD QUEST<br />
PRL ERR ENTRY ALR- Value: 2147483776<br />
EADY EXISTS<br />
PRL ERR ENTRY DIR - Value: 2147484688<br />
ALREADY EXISTS<br />
PRL ERR ENTRY DIR - Value: 2147484689<br />
DOES NOT EXIST<br />
PRL ERR ENTRY DOE- Value: 2147483769<br />
S NOT EXIST<br />
PRL ERR EXCEED LIM- Value: 2147484552<br />
IT MAX RUNNING VM-<br />
S<br />
PRL ERR EXCEED ME- Value: 2147484165<br />
MORY LIMIT<br />
PRL ERR FAILURE Value: 2147483657<br />
PRL ERR FDD IMAGE - Value: 2147484437<br />
CLONE TO SELF<br />
PRL ERR FDD IMAGE - Value: 2147484436<br />
COPY<br />
PRL ERR FDD IMAGE - Value: 2147484169<br />
NOT SPECIFIED<br />
PRL ERR FILE DISK SP- Value: 2147484531<br />
ACE ERROR<br />
PRL ERR FILE NOT EX- Value: 2147484450<br />
IST<br />
PRL ERR FILE NOT FO- Value: 2147483664<br />
UND<br />
PRL ERR FILE OR DIR- Value: 2147484501<br />
ALREADY EXISTS<br />
PRL ERR FILE READ E- Value: 2147483920<br />
RROR<br />
PRL ERR FILE TRANS- Value: 2147639300<br />
FER CANT CREATE D-<br />
ST FILE<br />
150<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR FILE TRANS- Value: 2147639297<br />
FER CANT LOCATE S-<br />
RC FILE<br />
PRL ERR FILE TRANS- Value: 2147639298<br />
FER CANT READ SRC -<br />
FILE<br />
PRL ERR FILE TRANS- Value: 2147639301<br />
FER CANT WRITE DA-<br />
TA TO DST FILE<br />
PRL ERR FILE TRANS- Value: 2147639296<br />
FER CLIENT NOT CON-<br />
NECTED<br />
PRL ERR FILE TRANS- Value: 2147639302<br />
FER DST FILE ALREA-<br />
DY EXIST<br />
PRL ERR FILE TRANS- Value: 2147639305<br />
FER INVALID ARGUM-<br />
ENTS<br />
PRL ERR FILE TRANS- Value: 2147639299<br />
FER INVALID CREDEN-<br />
TIALS<br />
PRL ERR FILE TRANS- Value: 2147639303<br />
FER OPERATION NOT -<br />
SUPPORTED<br />
PRL ERR FILE TRANS- Value: 2147639304<br />
FER UPLOAD CANCEL-<br />
ED BY USER<br />
PRL ERR FILE WRITE - Value: 2147484530<br />
ERROR<br />
PRL ERR FIXME Value: 2147484199<br />
PRL ERR FLOPPY DRI- Value: 2147484198<br />
VE INVALID<br />
PRL ERR FLOPPY IMA- Value: 2147484246<br />
GE ALREADY EXIST<br />
PRL ERR FLOPPY IMA- Value: 2147483797<br />
GE NOT EXIST<br />
PRL ERR FREE DISC S- Value: 2147484529<br />
PACE FOR CLONE<br />
PRL ERR FREE DISK S- Value: 2147484738<br />
PACE FOR CREATE S-<br />
NAPSHOT<br />
151<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR FREE DISK S- Value: 2147484739<br />
PACE FOR REVERT T-<br />
O SNAPSHOT<br />
PRL ERR GET LICENS- Value: 2147483959<br />
E INVALID ARG<br />
PRL ERR GET MON ST- Value: 2147483944<br />
ATE INVALID ARG<br />
PRL ERR GET MON ST- Value: 2147483945<br />
ATE VM NOT CONFIG-<br />
URED<br />
PRL ERR GET MON ST- Value: 2147483943<br />
ATE VM NOT CREATE-<br />
D<br />
PRL ERR GET NET SE- Value: 2147484499<br />
RVICE STATUS FAILE-<br />
D<br />
PRL ERR GET RESOLU- Value: 2147484022<br />
TION TOOL INVALID -<br />
ARG<br />
PRL ERR GET RESOLU- Value: 2147484021<br />
TION TOOL VMNOTCR-<br />
EATED<br />
PRL ERR GET USER H- Value: 2147484227<br />
OME DIR<br />
PRL ERR GUEST MAC - Value: 2147484505<br />
INVALID VERSION<br />
PRL ERR GUEST MAC - Value: 2147484504<br />
NOT ENOUGH MEMOR-<br />
Y<br />
PRL ERR GUEST MAC - Value: 2147484567<br />
NOT MACSERVER HOS-<br />
T<br />
PRL ERR GUEST TOO- Value: 2147484707<br />
LS NOT INSTALLED<br />
PRL ERR HANDSHAKE- Value: 2147484690<br />
FAILED<br />
PRL ERR HARD DISK I- Value: 2147491842<br />
MAGE CORRUPTED<br />
PRL ERR HDD IMAGE - Value: 2147483796<br />
CLONE TO SELF<br />
PRL ERR HDD IMAGE - Value: 2147484215<br />
COPY<br />
152<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR HDD IMAGE - Value: 2147484296<br />
IS ALREADY EXIST<br />
PRL ERR HDD IMAGE - Value: 2147483795<br />
NOT EXIST<br />
PRL ERR HDD IMAGE - Value: 2147484166<br />
NOT SPECIFIED<br />
PRL ERR HOST AMD G- Value: 2147484488<br />
UEST MAC<br />
PRL ERR HVT DISABL- Value: 2147484481<br />
ED<br />
PRL ERR HVT NOT PR- Value: 2147484470<br />
ESENT<br />
PRL ERR HVT TURNE- Value: 2147484519<br />
D OFF IN CONFIG<br />
PRL ERR HYP ALLOC - Value: 2147484721<br />
VMS MEMORY<br />
PRL ERR IMAGE NEED- Value: 2147491841<br />
TO CONVERT<br />
PRL ERR IMPERSONA- Value: 2147484496<br />
TE FAILED<br />
PRL ERR INCONSISTE- Value: 2147483910<br />
NCY VM CONFIG<br />
PRL ERR INCORRECT - Value: 2147487745<br />
CDROM PATH<br />
PRL ERR INCORRECT - Value: 2147484469<br />
FDD PATH<br />
PRL ERR INCORRECT - Value: 2147484452<br />
PATH<br />
PRL ERR INSERTING - Value: 2147484216<br />
VM TO CATALOGUE<br />
PRL ERR INSTALLATI- Value: 2147484292<br />
ON PROBLEM<br />
PRL ERR INVALID AC- Value: 2147484229<br />
CESS TOKEN RECEIVE-<br />
D<br />
PRL ERR INVALID AR- Value: 2147483651<br />
G<br />
PRL ERR INVALID CO- Value: 2147484517<br />
NFIGURATION<br />
PRL ERR INVALID HA- Value: 2147483652<br />
NDLE<br />
PRL ERR INVALID HD- Value: 2147484167<br />
D GEOMETRY<br />
153<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR INVALID KE- Value: 2147484720<br />
XT REBOOT REQUIRE-<br />
D<br />
PRL ERR INVALID ME- Value: 2147484164<br />
MORY SIZE<br />
PRL ERR INVALID PA- Value: 2147491840<br />
RALLELS DISK<br />
PRL ERR INVALID PA- Value: 2147483672<br />
RAM<br />
PRL ERR IO AUTHENT- Value: 2147484420<br />
ICATION FAILED<br />
PRL ERR IO CONNECT- Value: 2147484419<br />
ION TIMEOUT<br />
PRL ERR IO DISABLED Value: 2147484480<br />
PRL ERR IO INVALID - Value: 2147484754<br />
POINTER ACCESS<br />
PRL ERR IO NO CONN- Value: 2147484673<br />
ECTION<br />
PRL ERR IO SEND QU- Value: 2147484416<br />
EUE IS FULL<br />
PRL ERR IO STOPPED Value: 2147484417<br />
PRL ERR IO UNKNOW- Value: 2147484418<br />
N VM ID<br />
PRL ERR IPFO INVALI- Value: 2147651590<br />
D MODE<br />
PRL ERR IPFO RECEI- Value: 2147651592<br />
VE FAILED<br />
PRL ERR IPFO SEND F- Value: 2147651591<br />
AILED<br />
PRL ERR IPFO SOCKE- Value: 2147651587<br />
T ACCEPT FAILED<br />
PRL ERR IPFO SOCKE- Value: 2147651585<br />
T BIND FAILED<br />
PRL ERR IPFO SOCKE- Value: 2147651588<br />
T CONNECT FAILED<br />
PRL ERR IPFO SOCKE- Value: 2147651584<br />
T CREATE FAILED<br />
PRL ERR IPFO SOCKE- Value: 2147651586<br />
T LISTEN FAILED<br />
PRL ERR IPFO SOCKE- Value: 2147651589<br />
T NOT OPENED<br />
154<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR IPHONE PRO- Value: 2147688450<br />
XY ALREADY STARTE-<br />
D<br />
PRL ERR IPHONE PRO- Value: 2147688448<br />
XY CANNOT START<br />
PRL ERR IPHONE PRO- Value: 2147688449<br />
XY CANNOT STOP<br />
PRL ERR LICENSE AU- Value: 2147553287<br />
TH FAILED<br />
PRL ERR LICENSE BE- Value: 2147553297<br />
TA KEY RELEASE PRO-<br />
DUCT<br />
PRL ERR LICENSE EX- Value: 2147553281<br />
PIRED<br />
PRL ERR LICENSE FIL- Value: 2147553296<br />
E WRITE FAILED<br />
PRL ERR LICENSE NO- Value: 2147553280<br />
T VALID<br />
PRL ERR LICENSE RE- Value: 2147553299<br />
LEASE KEY BETA PRO-<br />
DUCT<br />
PRL ERR LICENSE TO- Value: 2147553298<br />
O MANY VCPUS<br />
PRL ERR LICENSE UP- Value: 2147553289<br />
GRADE NO PERMANE-<br />
NT LICENSE<br />
PRL ERR LICENSE WR- Value: 2147553288<br />
ONG ADVANCED FIEL-<br />
D<br />
PRL ERR LICENSE WR- Value: 2147553286<br />
ONG DISTRIBUTOR<br />
PRL ERR LICENSE WR- Value: 2147553285<br />
ONG LANGUAGE<br />
PRL ERR LICENSE WR- Value: 2147553284<br />
ONG PLATFORM<br />
PRL ERR LICENSE WR- Value: 2147553283<br />
ONG PRODUCT<br />
PRL ERR LICENSE WR- Value: 2147553282<br />
ONG VERSION<br />
PRL ERR LOCAL AUT- Value: 2147484465<br />
HENTICATION FAILED<br />
PRL ERR LPT DEVICE - Value: 2147484245<br />
ALREADY EXIST<br />
155<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR LPT OUTPU- Value: 2147484182<br />
T FILE IS NOT SPECIFI-<br />
ED<br />
PRL ERR LPT OUTPU- Value: 2147484184<br />
T FILE NOT EXIST<br />
PRL ERR MAC ADDRE- Value: 2147484456<br />
SS INCORRECT<br />
PRL ERR MAC ADDRE- Value: 2147484177<br />
SS IN CORRECT LENG-<br />
TH<br />
PRL ERR MAC ADDRE- Value: 2147484176<br />
SS IS EMPTY<br />
PRL ERR MAC ADDRE- Value: 2147484180<br />
SS WITHIN CORRECT -<br />
SYMBOLS<br />
PRL ERR MAC ADDRE- Value: 2147484178<br />
SS WITH 2 ZERO STAR-<br />
T<br />
PRL ERR MAC ADDRE- Value: 2147484179<br />
SS WITH ALL ZEROS<br />
PRL ERR MAKE DIREC- Value: 2147484210<br />
TORY<br />
PRL ERR NETWORK R- Value: 2147484272<br />
OLLBACK FAILED<br />
PRL ERR NOT ALL FIL- Value: 2147483906<br />
ES WAS DELETED<br />
PRL ERR NOT CONNE- Value: 2147484241<br />
CTED TO DISPATCHE-<br />
R<br />
PRL ERR NOT ENOUG- Value: 2147484423<br />
H DISK FREE SPACE<br />
PRL ERR NOT ENOUG- Value: 2147484755<br />
H DISK SPACE TO XM-<br />
L SAVE<br />
PRL ERR NOT ENOUG- Value: 2147484312<br />
H PERMS TO OPEN AU-<br />
THORIZATION FILE<br />
PRL ERR NO BOOTIN- Value: 2147484468<br />
G DEVICE SELECTED<br />
PRL ERR NO CD DRIV- Value: 2147484696<br />
E AVAILABLE<br />
PRL ERR NO DATA Value: 2147483668<br />
156<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR NO DISP CO- Value: 2147483673<br />
NFIG FOUND<br />
PRL ERR NO MORE FR- Value: 2147484521<br />
EE INTERFACE SLOTS<br />
PRL ERR NO PROBLE- Value: 2147483781<br />
M REPORT FOUND<br />
PRL ERR NO TARGET - Value: 2147484679<br />
DIR PATH SPECIFIED<br />
PRL ERR NO TARGET - Value: 2147483764<br />
PATH SPECIFIED<br />
PRL ERR NO VM DIR - Value: 2147483686<br />
CONFIG FOUND<br />
PRL ERR NVRAM FILE- Value: 2147484726<br />
COPY<br />
PRL ERR OBJECT WA- Value: 2147484678<br />
S REMOVED<br />
PRL ERR ONLY ADMI- Value: 2147484565<br />
N CAN SET PARAMET-<br />
ER STARTLOGINMOD-<br />
E ROOT<br />
PRL ERR OPEN DISP C- Value: 2147483681<br />
ONFIG READ<br />
PRL ERR OPEN DISP C- Value: 2147483682<br />
ONFIG WRITE<br />
PRL ERR OPEN PROB- Value: 2147483782<br />
LEM REPORT READ<br />
PRL ERR OPEN VM C- Value: 2147483699<br />
ONFIG READ<br />
PRL ERR OPEN VM C- Value: 2147483700<br />
ONFIG WRITE<br />
PRL ERR OPEN VM DI- Value: 2147483688<br />
R CONFIG READ<br />
PRL ERR OPEN VM DI- Value: 2147483689<br />
R CONFIG WRITE<br />
PRL ERR OPERATION - Value: 2147483670<br />
FAILED<br />
PRL ERR OPERATION - Value: 2147483667<br />
PENDING<br />
PRL ERR OPERATION - Value: 2147484277<br />
WAS CANCELED<br />
PRL ERR OUT OF DIS- Value: 2147484311<br />
K SPACE<br />
157<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR OUT OF ME- Value: 2147483650<br />
MORY<br />
PRL ERR PARALLEL P- Value: 2147483799<br />
ORT IMAGE NOT EXIS-<br />
T<br />
PRL ERR PARALLEL P- Value: 2147484214<br />
ORT IMG COPY<br />
PRL ERR PARAM NOT- Value: 2147483671<br />
FOUND<br />
PRL ERR PARSE CLIE- Value: 2147483927<br />
NT PREFS<br />
PRL ERR PARSE COM- Value: 2147483937<br />
MON SERVER PREFS<br />
PRL ERR PARSE DISP - Value: 2147483683<br />
CONFIG<br />
PRL ERR PARSE FILES- Value: 2147483762<br />
YSTEM INFO<br />
PRL ERR PARSE HAR- Value: 2147483761<br />
D DISK HW INFO<br />
PRL ERR PARSE HOST- Value: 2147483760<br />
HW INFO<br />
PRL ERR PARSE PROB- Value: 2147483780<br />
LEM REPORT<br />
PRL ERR PARSE STAT- Value: 2147484278<br />
ISTICS<br />
PRL ERR PARSE USER- Value: 2147483763<br />
PROFILE<br />
PRL ERR PARSE VM C- Value: 2147483702<br />
ONFIG<br />
PRL ERR PARSE VM D- Value: 2147483696<br />
IR CONFIG<br />
PRL ERR PARSING EV- Value: 2147483684<br />
ENT<br />
PRL ERR PREV SESSIO- Value: 2147483748<br />
N IS ACTIVE<br />
PRL ERR PROBLEM R- Value: 2147483784<br />
EPORT ALREADY EXI-<br />
STS<br />
PRL ERR PROBLEM R- Value: 2147483783<br />
EPORT FILE NOTSET<br />
PRL ERR PROBLEM R- Value: 2147483785<br />
EPORT WRITE<br />
158<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR READONLY - Value: 2147484502<br />
FILESYSTEM<br />
PRL ERR READ XML C- Value: 2147483701<br />
ONTENT<br />
PRL ERR REBOOT HO- Value: 2147484498<br />
ST<br />
PRL ERR REMOTE DE- Value: 2147484281<br />
VICE EXIST<br />
PRL ERR REMOTE DE- Value: 2147484288<br />
VICE NOT EXIST<br />
PRL ERR REMOTE DE- Value: 2147484280<br />
VICE NOT REGISTERE-<br />
D<br />
PRL ERR REMOTE DIS- Value: 2147484484<br />
PLAY HOST NOT SPEC-<br />
IFIED<br />
PRL ERR REMOTE DIS- Value: 2147484485<br />
PLAY WRONG PORT N-<br />
UMBER<br />
PRL ERR RETRIEVE V- Value: 2147484224<br />
M CONFIG<br />
PRL ERR RETURN CO- Value: 2147483923<br />
DE RANG EEND<br />
PRL ERR REVERT IMP- Value: 2147484497<br />
ERSONATE FAILED<br />
PRL ERR SAVE VM CA- Value: 2147483792<br />
TALOG<br />
PRL ERR SAVE VM CO- Value: 2147484212<br />
NFIG<br />
PRL ERR SEARCH CO- Value: 2147483912<br />
NFIG OPERATION CA-<br />
NCELED<br />
PRL ERR SEND COMM- Value: 2147484240<br />
AND TOWS FAILED<br />
PRL ERR SERIAL IMG - Value: 2147484213<br />
COPY<br />
PRL ERR SERIAL IMG - Value: 2147484211<br />
NOT FOUND<br />
PRL ERR SERIAL POR- Value: 2147483798<br />
T IMAGE NOT EXIST<br />
PRL ERR SERVER GOE- Value: 2147484232<br />
S DOWN<br />
159<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR SERVER PRE- Value: 2147484454<br />
FS EDIT COLLISION<br />
PRL ERR SET LICENSE- Value: 2147483960<br />
INVALID ARG<br />
PRL ERR SET LICENSE- Value: 2147483961<br />
INVALID KEY<br />
PRL ERR SHUT DOWN- Value: 2147484231<br />
NOT IFICATION SERV-<br />
ICE<br />
PRL ERR SMC ERROR Value: 2147483921<br />
PRL ERR SNAPSHOTS - Value: 2147484727<br />
COPY<br />
PRL ERR SOME TASKS- Value: 2147484515<br />
PRESENT<br />
PRL ERR SOME VMS R- Value: 2147484514<br />
UNNING<br />
PRL ERR SOUND DEVI- Value: 2147504128<br />
CE WRITE FAILED<br />
PRL ERR SOUND IN D- Value: 2147504130<br />
EVICE OPEN FAILED<br />
PRL ERR SOUND OUT - Value: 2147504129<br />
DEVICE OPEN FAILED<br />
PRL ERR SSL HANDSH- Value: 2147484692<br />
AKE FAILED<br />
PRL ERR STATE ALRE- Value: 2147586069<br />
ADY EXISTS<br />
PRL ERR STATE CANT- Value: 2147586084<br />
LOAD SPECIFIED CFG<br />
PRL ERR STATE CANT- Value: 2147586064<br />
OPEN FOR WRITE<br />
PRL ERR STATE CANT- Value: 2147586057<br />
OPEN IMAGE<br />
PRL ERR STATE CANT- Value: 2147586065<br />
OPEN LOCKED<br />
PRL ERR STATE CANT- Value: 2147586066<br />
SAVE LOCKED<br />
PRL ERR STATE DELE- Value: 2147586083<br />
TE NONCLOSED<br />
PRL ERR STATE ERRO- Value: 2147586055<br />
R CREATE IMAGE<br />
PRL ERR STATE ERRO- Value: 2147586056<br />
R RENAMING IMAGE<br />
160<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR STATE FULL- Value: 2147586072<br />
DELETE FAILED<br />
PRL ERR STATE GETF- Value: 2147586085<br />
REESPACE FAILED<br />
PRL ERR STATE INT C- Value: 2147586067<br />
ORRUPTED<br />
PRL ERR STATE INVA- Value: 2147586082<br />
LID IMAGE TYPE<br />
PRL ERR STATE INVA- Value: 2147586054<br />
LID PARAMETERS<br />
PRL ERR STATE MEM- Value: 2147586081<br />
ORY ERROR<br />
PRL ERR STATE MER- Value: 2147586073<br />
GE FAILED<br />
PRL ERR STATE MER- Value: 2147586080<br />
GE NO SPACE<br />
PRL ERR STATE NOT - Value: 2147586070<br />
OPENED<br />
PRL ERR STATE NOT - Value: 2147586071<br />
PERMITTED<br />
PRL ERR STATE NOT - Value: 2147586087<br />
RELEASED<br />
PRL ERR STATE NO D- Value: 2147586049<br />
ISKS<br />
PRL ERR STATE NO S- Value: 2147586068<br />
TATE<br />
PRL ERR STATE PROC- Value: 2147586050<br />
ESS RUNNING<br />
PRL ERR STATE ROLL- Value: 2147586053<br />
BACK ERROR<br />
PRL ERR STATE ROLL- Value: 2147586052<br />
BACK IN PROGRESS<br />
PRL ERR STATE STAT- Value: 2147586086<br />
FS FAILED<br />
PRL ERR STATE STOP- Value: 2147586051<br />
PING STATE<br />
PRL ERR STATE UNEX- Value: 2147586048<br />
PECTED ERROR<br />
PRL ERR SYMBOL NO- Value: 2147483666<br />
T FOUND<br />
PRL ERR TARGET NA- Value: 2147483767<br />
ME ALREADY OCCUPI-<br />
ED<br />
161<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR TARGET PA- Value: 2147483766<br />
TH IS NOT DIRECTOR-<br />
Y<br />
PRL ERR TASK NOT F- Value: 2147483794<br />
OUND<br />
PRL ERR TIMEOUT Value: 2147483669<br />
PRL ERR TIS INVALID - Value: 2147645440<br />
UID<br />
PRL ERR TOOLS UNSU- Value: 2147484528<br />
PPORTED GUEST<br />
PRL ERR TOO LOW H- Value: 2147484256<br />
DD SIZE<br />
PRL ERR TRY AGAIN Value: 2147484752<br />
PRL ERR UNABLE DR- Value: 2147483907<br />
OP SUSPENDED STAT-<br />
E<br />
PRL ERR UNABLE SEN- Value: 2147484018<br />
D REQUEST<br />
PRL ERR UNDER OLD - Value: 2147484248<br />
HYPERVISOR<br />
PRL ERR UNEXPECTE- Value: 2147483649<br />
D<br />
PRL ERR UNIMPLEME- Value: 2147483656<br />
NTED<br />
PRL ERR UNINITIALIZ- Value: 2147483655<br />
ED<br />
PRL ERR UNRECOGNI- Value: 2147483793<br />
ZED REQUEST<br />
PRL ERR UNSUPPORT- Value: 2147487746<br />
ED DEVICE TYPE<br />
PRL ERR UNSUPPORT- Value: 2147484569<br />
ED NETWORK FILE SY-<br />
STEM<br />
PRL ERR UPDATE ME- Value: 2147484017<br />
M VM NOT CREATED<br />
PRL ERR UPD TOOLS - Value: 2147484020<br />
VER VM NOT CONFIG-<br />
URED<br />
PRL ERR UPD TOOLS - Value: 2147484019<br />
VER VM NOT CREATE-<br />
D<br />
162<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR UPD UPDAT- Value: 2147577856<br />
ER CONFIG<br />
PRL ERR UPD UPDAT- Value: 2147577857<br />
ES<br />
PRL ERR USER CANT - Value: 2147483929<br />
CHANGE ACCESS PRO-<br />
FILE<br />
PRL ERR USER CANT - Value: 2147484249<br />
CHANGE PROFILE AC-<br />
CESS PART<br />
PRL ERR USER CANT - Value: 2147483936<br />
CHANGE READ ONLY -<br />
VALUE<br />
PRL ERR USER DIREC- Value: 2147483751<br />
TORY NOT SET<br />
PRL ERR USER IS ALR- Value: 2147483745<br />
EADY LOGGED<br />
PRL ERR USER NOT F- Value: 2147484560<br />
OUND<br />
PRL ERR USER NO AU- Value: 2147484438<br />
TH TO CREATE VM IN-<br />
DIR<br />
PRL ERR USER NO AU- Value: 2147484247<br />
TH TO EDIT SERVER S-<br />
ETTINGS<br />
PRL ERR USER NO AU- Value: 2147484449<br />
TH TO EDIT VM<br />
PRL ERR USER NO AU- Value: 2147484435<br />
TH TO SAVE FILES<br />
PRL ERR USER OPERA- Value: 2147483737<br />
TION NOT AUTHORIS-<br />
ED<br />
PRL ERR USER PROFI- Value: 2147483928<br />
LE WAS CHANGED<br />
PRL ERR VA CONFIG Value: 2147581952<br />
PRL ERR VMCONF AU- Value: 2147643475<br />
TOSTART FROM CUR-<br />
RENT USER FORBIDD-<br />
EN<br />
PRL ERR VMCONF BO- Value: 2147643414<br />
OTCAMP HARD DISK S-<br />
MART GUARD NOT AL-<br />
LOW<br />
163<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR VMCONF BO- Value: 2147643408<br />
OTCAMP HARD SNAPS-<br />
HOTS NOT ALLOW<br />
PRL ERR VMCONF BO- Value: 2147643400<br />
OTCAMP HARD UNDO-<br />
DISKS NOT ALLOW<br />
PRL ERR VMCONF BO- Value: 2147643410<br />
OTCAMP SAFE MODE -<br />
NOT ALLOW<br />
PRL ERR VMCONF BO- Value: 2147643474<br />
OT OPTION DEVICE N-<br />
OT EXISTS<br />
PRL ERR VMCONF BO- Value: 2147643473<br />
OT OPTION DUPLICA-<br />
TE DEVICE<br />
PRL ERR VMCONF BO- Value: 2147643472<br />
OT OPTION INVALID -<br />
DEVICE TYPE<br />
PRL ERR VMCONF CD- Value: 2147644417<br />
DVD ROM DUPLICAT-<br />
E SYS NAME<br />
PRL ERR VMCONF CD- Value: 2147644418<br />
DVD ROM IMAGE IS N-<br />
OT EXIST<br />
PRL ERR VMCONF CD- Value: 2147644416<br />
DVD ROM SYS NAME -<br />
IS EMPTY<br />
PRL ERR VMCONF CP- Value: 2147643906<br />
U COUNT MORE HOST-<br />
CPU COUNT<br />
PRL ERR VMCONF CP- Value: 2147643905<br />
U COUNT MORE MAX -<br />
CPU COUNT<br />
PRL ERR VMCONF CP- Value: 2147643904<br />
U ZERO COUNT<br />
PRL ERR VMCONF DE- Value: 2147643398<br />
SKTOP MODE REMOT-<br />
E DEVICES<br />
PRL ERR VMCONF FL- Value: 2147644241<br />
OPPY DISK IMAGE IS -<br />
NOT EXIST<br />
164<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR VMCONF FL- Value: 2147644243<br />
OPPY DISK IMAGE IS -<br />
NOT VALID<br />
PRL ERR VMCONF FL- Value: 2147644242<br />
OPPY DISK IS NOT AC-<br />
CESSIBLE<br />
PRL ERR VMCONF FL- Value: 2147644244<br />
OPPY DISK SYS NAME-<br />
HAS INVALID SYMBO-<br />
L<br />
PRL ERR VMCONF FL- Value: 2147644240<br />
OPPY DISK SYS NAME-<br />
IS EMPTY<br />
PRL ERR VMCONF HA- Value: 2147644499<br />
RD DISK DUPLICATE S-<br />
YS NAME<br />
PRL ERR VMCONF HA- Value: 2147644497<br />
RD DISK IMAGE IS NO-<br />
T EXIST<br />
PRL ERR VMCONF HA- Value: 2147644498<br />
RD DISK IMAGE IS NO-<br />
T VALID<br />
PRL ERR VMCONF HA- Value: 2147644500<br />
RD DISK SYS NAME H-<br />
AS INVALID SYMBOL<br />
PRL ERR VMCONF HA- Value: 2147644496<br />
RD DISK SYS NAME IS -<br />
EMPTY<br />
PRL ERR VMCONF IDE- Value: 2147645184<br />
DEVICES COUNT OUT-<br />
OF RANGE<br />
PRL ERR VMCONF IDE- Value: 2147645185<br />
DEVICES DUPLICATE -<br />
STACK INDEX<br />
PRL ERR VMCONF IN- Value: 2147643415<br />
COMPAT HARD DISK S-<br />
MART GUARD NOT AL-<br />
LOW<br />
PRL ERR VMCONF IN- Value: 2147643401<br />
COMPAT HARD UNDO-<br />
DISKS NOT ALLOW<br />
165<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR VMCONF IN- Value: 2147643411<br />
COMPAT SAFE MODE -<br />
NOT ALLOW<br />
PRL ERR VMCONF IN- Value: 2147643397<br />
VALID DEVICE MAIN I-<br />
NDEX<br />
PRL ERR VMCONF MA- Value: 2147643986<br />
IN MEMORY NOT 4 RA-<br />
TIO SIZE<br />
PRL ERR VMCONF MA- Value: 2147643985<br />
IN MEMORY OUT OF -<br />
RANGE<br />
PRL ERR VMCONF MA- Value: 2147643984<br />
IN MEMORY ZERO SIZ-<br />
E<br />
PRL ERR VMCONF NE- Value: 2147644674<br />
TWORK ADAPTER DU-<br />
PLICATE MAC ADDRE-<br />
SS<br />
PRL ERR VMCONF NE- Value: 2147644672<br />
TWORK ADAPTER IN-<br />
VALID BOUND INDEX<br />
PRL ERR VMCONF NE- Value: 2147644673<br />
TWORK ADAPTER IN-<br />
VALID MAC ADDRESS<br />
PRL ERR VMCONF NO- Value: 2147643413<br />
HD IMAGES IN SAFE -<br />
MODE<br />
PRL ERR VMCONF NO- Value: 2147643412<br />
HD IMAGES IN UNDO -<br />
DISKS MODE<br />
PRL ERR VMCONF PA- Value: 2147645009<br />
RALLEL PORT IMAGE -<br />
IS NOT EXIST<br />
PRL ERR VMCONF PA- Value: 2147645010<br />
RALLEL PORT SYS NA-<br />
ME HAS INVALID SYM-<br />
BOL<br />
PRL ERR VMCONF PA- Value: 2147645008<br />
RALLEL PORT SYS NA-<br />
ME IS EMPTY<br />
166<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR VMCONF RE- Value: 2147643409<br />
AL HARD SAFE MODE -<br />
NOT ALLOW<br />
PRL ERR VMCONF RE- Value: 2147643399<br />
AL HARD UNDO DISKS-<br />
NOT ALLOW<br />
PRL ERR VMCONF RE- Value: 2147643649<br />
MOTE DISPLAY HOST -<br />
IP ADDRESS IS ZERO<br />
PRL ERR VMCONF RE- Value: 2147643650<br />
MOTE DISPLAY INVAL-<br />
ID HOST IP ADDRESS<br />
PRL ERR VMCONF RE- Value: 2147643648<br />
MOTE DISPLAY PORT -<br />
NUMBER IS ZERO<br />
PRL ERR VMCONF SC- Value: 2147645264<br />
SI DEVICES COUNT O-<br />
UT OF RANGE<br />
PRL ERR VMCONF SC- Value: 2147645265<br />
SI DEVICES DUPLICAT-<br />
E STACK INDEX<br />
PRL ERR VMCONF SE- Value: 2147644929<br />
RIAL PORT IMAGE IS -<br />
NOT EXIST<br />
PRL ERR VMCONF SE- Value: 2147644930<br />
RIAL PORT SYS NAME-<br />
HAS INVALID SYMBO-<br />
L<br />
PRL ERR VMCONF SE- Value: 2147644928<br />
RIAL PORT SYS NAME-<br />
IS EMPTY<br />
PRL ERR VMCONF SH- Value: 2147643729<br />
ARED FOLDERS DUPLI-<br />
CATE FOLDER NAME<br />
PRL ERR VMCONF SH- Value: 2147643731<br />
ARED FOLDERS DUPLI-<br />
CATE FOLDER PATH<br />
PRL ERR VMCONF SH- Value: 2147643728<br />
ARED FOLDERS EMPT-<br />
Y FOLDER NAME<br />
PRL ERR VMCONF SH- Value: 2147643730<br />
ARED FOLDERS INVA-<br />
LID FOLDER PATH<br />
167<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR VMCONF SO- Value: 2147644752<br />
UND MIXER IS EMPTY<br />
PRL ERR VMCONF SO- Value: 2147644753<br />
UND OUTPUT IS EMPT-<br />
Y<br />
PRL ERR VMCONF UN- Value: 2147643394<br />
KNOWN OS TYPE<br />
PRL ERR VMCONF UN- Value: 2147643395<br />
KNOWN OS VERSION<br />
PRL ERR VMCONF VA- Value: 2147643392<br />
LIDATION FAILED<br />
PRL ERR VMCONF VI- Value: 2147644160<br />
DEO MEMORY OUT O-<br />
F RANGE<br />
PRL ERR VMCONF VM- Value: 2147643396<br />
NAME HAS INVALID S-<br />
YMBOL<br />
PRL ERR VMCONF VM- Value: 2147643393<br />
NAME IS EMPTY<br />
PRL ERR VMDIR INVA- Value: 2147484293<br />
LID PATH<br />
PRL ERR VMDIR PAT- Value: 2147484294<br />
H IS NOT ABSOLUTE<br />
PRL ERR VM ABORT Value: 2147484453<br />
PRL ERR VM ALLOC - Value: 2147484036<br />
MEM DRV NOT START-<br />
ED<br />
PRL ERR VM ALLOC V- Value: 2147484037<br />
M MEMORY<br />
PRL ERR VM ALREAD- Value: 2147484561<br />
Y CONNECTED<br />
PRL ERR VM ALREAD- Value: 2147483940<br />
Y CREATED<br />
PRL ERR VM ALREAD- Value: 2147484743<br />
Y REGISTERED<br />
PRL ERR VM ALREAD- Value: 2147483924<br />
Y REGISTERED UNIQU-<br />
E PARAMS<br />
PRL ERR VM ALREAD- Value: 2147483925<br />
Y REGISTERED VM N-<br />
AME<br />
168<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR VM ALREAD- Value: 2147483747<br />
Y REGISTERED VM PA-<br />
TH<br />
PRL ERR VM ALREAD- Value: 2147483746<br />
Y REGISTERED VM U-<br />
UID<br />
PRL ERR VM ALREAD- Value: 2147483730<br />
Y RESUMED<br />
PRL ERR VM ALREAD- Value: 2147484674<br />
Y RUNNING<br />
PRL ERR VM ALREAD- Value: 2147483728<br />
Y SUSPENDED<br />
PRL ERR VM ANOTHE- Value: 2147484709<br />
R TOOLS IN USE<br />
PRL ERR VM APPLY C- Value: 2147484518<br />
HANGES PENDING<br />
PRL ERR VM APPLY C- Value: 2147484304<br />
ONFIG FAILED<br />
PRL ERR VM APPLY C- Value: 2147484305<br />
ONFIG NEEDS REBOO-<br />
T<br />
PRL ERR VM ASYNC C- Value: 2147484032<br />
D CONSTRUCTOR<br />
PRL ERR VM BAD OS - Value: 2147484162<br />
TYPE<br />
PRL ERR VM CANT CL- Value: 2147484448<br />
ONE HDD MISSING<br />
PRL ERR VM CANT CL- Value: 2147484306<br />
ONE RUNNING<br />
PRL ERR VM CANT D- Value: 2147484307<br />
ELETE RUNNING<br />
PRL ERR VM CANT U- Value: 2147484308<br />
NREG RUNNING<br />
PRL ERR VM COMPAC- Value: 2147647488<br />
T PROCESSING<br />
PRL ERR VM CONFIG - Value: 2147483703<br />
ALREADY EXISTS<br />
PRL ERR VM CONFIG - Value: 2147484756<br />
CAN BE RESTORED<br />
PRL ERR VM CONFIG - Value: 2147484291<br />
DOESNT EXIST<br />
169<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR VM CONFIG - Value: 2147484533<br />
INVALID SERVER UUI-<br />
D<br />
PRL ERR VM CONFIG - Value: 2147484532<br />
INVALID VM UUID<br />
PRL ERR VM CONFIG - Value: 2147484757<br />
IS ALREADY VALID<br />
PRL ERR VM CONFIG - Value: 2147483922<br />
WAS CHANGED<br />
PRL ERR VM CONF C- Value: 2147483956<br />
HANGED INVALID AR-<br />
G<br />
PRL ERR VM CONF C- Value: 2147483955<br />
HANGED NOT CREAT-<br />
ED<br />
PRL ERR VM CONF C- Value: 2147483957<br />
HANGED NOT STARTE-<br />
D<br />
PRL ERR VM CONF C- Value: 2147483958<br />
HANGED UNSUPPORT-<br />
ED DEV<br />
PRL ERR VM COULDN- Value: 2147484568<br />
T BE STARTED UNDE-<br />
R SPECIFIED USER<br />
PRL ERR VM CREATE - Value: 2147484007<br />
HDD IMG INVALID AR-<br />
G<br />
PRL ERR VM CREATE - Value: 2147484008<br />
HDD IMG INVALID CR-<br />
EATE<br />
PRL ERR VM CREATE - Value: 2147483939<br />
INVALID ARG<br />
PRL ERR VM DELETE - Value: 2147484711<br />
STATE FAILED<br />
PRL ERR VM DEVICES- Value: 2147484275<br />
INITIALIZATION FAIL-<br />
ED<br />
PRL ERR VM DEVICES- Value: 2147484276<br />
TERMINATION FAILE-<br />
D<br />
PRL ERR VM DEV CH- Value: 2147483735<br />
ANGE MEDIA FAILED<br />
170<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR VM DEV CO- Value: 2147483733<br />
NNECT FAILED<br />
PRL ERR VM DEV DIS- Value: 2147483734<br />
CONNECT FAILED<br />
PRL ERR VM DIRECT- Value: 2147484745<br />
ORY FOLDER DOESNT-<br />
EXIST<br />
PRL ERR VM DIRECT- Value: 2147484455<br />
ORY NOT EXIST<br />
PRL ERR VM DIRECT- Value: 2147483749<br />
ORY NOT INITIALIZED<br />
PRL ERR VM DIR CON- Value: 2147483697<br />
FIG ALREADY EXISTS<br />
PRL ERR VM DIR FILE- Value: 2147483705<br />
NOT SET<br />
PRL ERR VM DOES NO- Value: 2147484225<br />
T STOPPED<br />
PRL ERR VM DVD DIS- Value: 2147484724<br />
CONNECT FAILED LO-<br />
CKED<br />
PRL ERR VM EDIT UN- Value: 2147484753<br />
ABLE SWITCH OFF UN-<br />
DO DISKS MODE<br />
PRL ERR VM EDIT UN- Value: 2147484725<br />
ABLE SWITCH ON UN-<br />
DO DISKS MODE<br />
PRL ERR VM EMPTY - Value: 2147484209<br />
NAME OF CLONE<br />
PRL ERR VM FILES AL- Value: 2147484421<br />
READY REMOVED<br />
PRL ERR VM FREE V- Value: 2147484038<br />
M MEMORY<br />
PRL ERR VM GET CO- Value: 2147483721<br />
NFIG FAILED<br />
PRL ERR VM GET CO- Value: 2147483952<br />
NFIG INVALID ARG<br />
PRL ERR VM GET CO- Value: 2147483953<br />
NFIG NOT CONFIGUR-<br />
ED<br />
PRL ERR VM GET DE- Value: 2147483736<br />
VICE STATE FAILED<br />
PRL ERR VM GET HD- Value: 2147484009<br />
D IMG INVALID ARG<br />
171<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR VM GET HD- Value: 2147484016<br />
D IMG NOT OPEN<br />
PRL ERR VM GET IND- Value: 2147484005<br />
ICATORS INVALID AR-<br />
G<br />
PRL ERR VM GET IND- Value: 2147484004<br />
ICATORS NOT CREAT-<br />
ED<br />
PRL ERR VM GET IND- Value: 2147484006<br />
ICATORS NOT RUNNI-<br />
NG<br />
PRL ERR VM GET PR- Value: 2147483720<br />
OBLEM REPORT FAIL-<br />
ED<br />
PRL ERR VM GET SCR- Value: 2147483976<br />
SIZE NOT CREATED<br />
PRL ERR VM GET SCR- Value: 2147483977<br />
UPDATED NOT CREA-<br />
TED<br />
PRL ERR VM GET SCR- Value: 2147483984<br />
UPDATED NOT RUNN-<br />
ING<br />
PRL ERR VM GET STA- Value: 2147483719<br />
TUS FAILED<br />
PRL ERR VM GET STA- Value: 2147483942<br />
TUS INVALID ARG<br />
PRL ERR VM GUESTM- Value: 2147484562<br />
EM FAIL<br />
PRL ERR VM HDD SIZ- Value: 2147484023<br />
E<br />
PRL ERR VM HOME P- Value: 2147484200<br />
ATH IS NOT EMPTY<br />
PRL ERR VM HYPERVI- Value: 2147484056<br />
ZOR COMM<br />
PRL ERR VM INIT MO- Value: 2147484048<br />
NITOR<br />
PRL ERR VM INIT VCP- Value: 2147484049<br />
U<br />
PRL ERR VM INTERAC- Value: 2147484039<br />
T PRLS DRIVER<br />
PRL ERR VM INTERN- Value: 2147484265<br />
AL OS ERROR<br />
172<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR VM INVALID - Value: 2147484536<br />
SWAP REGION<br />
PRL ERR VM IN HDD - Value: 2147484024<br />
CONSTRUCTOR<br />
PRL ERR VM IS NOT S- Value: 2147484704<br />
USPENDED<br />
PRL ERR VM LOAD BI- Value: 2147484675<br />
NARY FAILED<br />
PRL ERR VM LOAD M- Value: 2147484053<br />
ONITOR<br />
PRL ERR VM MAP VM- Value: 2147484041<br />
MEM0<br />
PRL ERR VM MEMOR- Value: 2147614729<br />
Y SWAPPING IN PROG-<br />
RESS<br />
PRL ERR VM MIGRAT- Value: 2147684352<br />
E CHECKING PRECON-<br />
DITIONS FAILED<br />
PRL ERR VM MIGRAT- Value: 2147684374<br />
E COULDNT DETACH -<br />
TARGET CONNECTIO-<br />
N<br />
PRL ERR VM MIGRAT- Value: 2147684359<br />
E FLOPPY DISK IS AB-<br />
SENT ON TARGET<br />
PRL ERR VM MIGRAT- Value: 2147684369<br />
E NETWORK ADAPTE-<br />
R IS ABSENT ON TAR-<br />
GET<br />
PRL ERR VM MIGRAT- Value: 2147684358<br />
E NETWORK SHARE IS-<br />
ABSENT ON TARGET<br />
PRL ERR VM MIGRAT- Value: 2147684357<br />
E NON COMPATIBLE -<br />
CPU ON TARGET<br />
PRL ERR VM MIGRAT- Value: 2147684356<br />
E NOT ENOUGH CPUS -<br />
ON TARGET<br />
PRL ERR VM MIGRAT- Value: 2147684353<br />
E NOT ENOUGH DISK -<br />
SPACE ON SOURCE<br />
173<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR VM MIGRAT- Value: 2147684373<br />
E NOT ENOUGH DISK -<br />
SPACE ON TARGET<br />
PRL ERR VM MIGRAT- Value: 2147684360<br />
E OPTICAL DISK IS AB-<br />
SENT ON TARGET<br />
PRL ERR VM MIGRAT- Value: 2147684354<br />
E OUT OF MEMORY O-<br />
N TARGET<br />
PRL ERR VM MIGRAT- Value: 2147684368<br />
E PARALLEL PORT IS -<br />
ABSENT ON TARGET<br />
PRL ERR VM MIGRAT- Value: 2147684361<br />
E SERIAL PORT IS AB-<br />
SENT ON TARGET<br />
PRL ERR VM MIGRAT- Value: 2147684371<br />
E SOUND DEVICE IS A-<br />
BSENT ON TARGET<br />
PRL ERR VM MIGRAT- Value: 2147684355<br />
E TARGET VM HOME -<br />
PATH NOT EXISTS<br />
PRL ERR VM MIGRAT- Value: 2147684370<br />
E USB CONTROLLER I-<br />
S ABSENT ON TARGE-<br />
T<br />
PRL ERR VM MIGRAT- Value: 2147684372<br />
E VM ALREADY EXIST-<br />
S ON TARGET<br />
PRL ERR VM MONITO- Value: 2147484160<br />
R<br />
PRL ERR VM MUST BE- Value: 2147484534<br />
STOPPED BEFORE RE-<br />
NAMING<br />
PRL ERR VM MUST BE- Value: 2147484548<br />
STOPPED FOR CHAN-<br />
GE DEVICES<br />
PRL ERR VM NAME IS- Value: 2147483926<br />
EMPTY<br />
PRL ERR VM NOT CR- Value: 2147483941<br />
EATED<br />
PRL ERR VM OPERATI- Value: 2147483753<br />
ON FAILED<br />
174<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR VM PAUSE A- Value: 2147483975<br />
LREADY PAUSED<br />
PRL ERR VM PAUSE F- Value: 2147483729<br />
AILED<br />
PRL ERR VM PAUSE N- Value: 2147483973<br />
OT CREATED<br />
PRL ERR VM PAUSE N- Value: 2147483974<br />
OT STARTED<br />
PRL ERR VM POWER - Value: 2147483717<br />
OFF FAILED<br />
PRL ERR VM POWER - Value: 2147483716<br />
ON FAILED<br />
PRL ERR VM PRLS DE- Value: 2147484057<br />
SCTOP ALLOC PHYS -<br />
MEM<br />
PRL ERR VM PROCESS- Value: 2147483752<br />
IS NOT STARTED<br />
PRL ERR VM REQUES- Value: 2147484161<br />
T NOT SUPPORTED<br />
PRL ERR VM RESET F- Value: 2147483718<br />
AILED<br />
PRL ERR VM RESTAR- Value: 2147484728<br />
T GUEST FAILED<br />
PRL ERR VM RESTAR- Value: 2147483971<br />
T NOT CREATED<br />
PRL ERR VM RESTAR- Value: 2147483972<br />
T NOT STARTED<br />
PRL ERR VM RESTOR- Value: 2147483732<br />
E STATE FAILED<br />
PRL ERR VM RESUME - Value: 2147614726<br />
FAILED<br />
PRL ERR VM SAVE ST- Value: 2147483731<br />
ATE FAILED<br />
PRL ERR VM SEND AB- Value: 2147483992<br />
S MOUSE NOT CREAT-<br />
ED<br />
PRL ERR VM SEND AB- Value: 2147483993<br />
S MOUSE NOT RUNNIN-<br />
G<br />
PRL ERR VM SEND AB- Value: 2147484000<br />
S MOUSE PAUSED<br />
175<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR VM SEND KE- Value: 2147484001<br />
YBOARD NOT CREAT-<br />
ED<br />
PRL ERR VM SEND KE- Value: 2147484002<br />
YBOARD NOT RUNNIN-<br />
G<br />
PRL ERR VM SEND KE- Value: 2147484003<br />
YBOARD PAUSED<br />
PRL ERR VM SEND RE- Value: 2147483989<br />
L MOUSE NOT CREAT-<br />
ED<br />
PRL ERR VM SEND RE- Value: 2147483990<br />
L MOUSE NOT RUNNI-<br />
NG<br />
PRL ERR VM SEND RE- Value: 2147483991<br />
L MOUSE PAUSED<br />
PRL ERR VM SET CON- Value: 2147483715<br />
FIG FAILED<br />
PRL ERR VM SET CON- Value: 2147483954<br />
FIG INVALID ARG<br />
PRL ERR VM SET LICE- Value: 2147483714<br />
NSE FAILED<br />
PRL ERR VM SET VISI- Value: 2147483985<br />
BLE NOT CREATED<br />
PRL ERR VM SNAPSH- Value: 2147484712<br />
OT CHANGED VM CO-<br />
NFIG<br />
PRL ERR VM SNAPSH- Value: 2147484736<br />
OT IN SAFE MODE<br />
PRL ERR VM SNAPSH- Value: 2147484713<br />
OT IN UNDO DISKS M-<br />
ODE<br />
PRL ERR VM SPECIFY- Value: 2147484313<br />
GUEST INSTALL FILE-<br />
S<br />
PRL ERR VM START F- Value: 2147483713<br />
AILED<br />
PRL ERR VM START N- Value: 2147483969<br />
OT CONFIGURED<br />
PRL ERR VM START N- Value: 2147483968<br />
OT CREATED<br />
PRL ERR VM STOP NO- Value: 2147483970<br />
T CREATED<br />
176<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR VM SUSPEN- Value: 2147614728<br />
D CHANGED VM CONF-<br />
IG<br />
PRL ERR VM SUSPEN- Value: 2147614725<br />
D FAILED<br />
PRL ERR VM TOOLS C- Value: 2147692544<br />
ANT PARSE UPDATE -<br />
PARAMETERS<br />
PRL ERR VM TOOLS C- Value: 2147692545<br />
ANT UPDATE WITHO-<br />
UT RESTART<br />
PRL ERR VM TO REGI- Value: 2147484471<br />
STER IS NOT SPECIFIE-<br />
D<br />
PRL ERR VM UNABLE - Value: 2147484040<br />
ALLOC MEM<br />
PRL ERR VM UNABLE - Value: 2147484054<br />
ALLOC MEM MONITO-<br />
R<br />
PRL ERR VM UNABLE - Value: 2147484055<br />
CREATE TIMER<br />
PRL ERR VM UNABLE - Value: 2147484050<br />
GET GUEST CPU<br />
PRL ERR VM UNABLE - Value: 2147484033<br />
OPEN DISK IMAGE<br />
PRL ERR VM UNABLE - Value: 2147484035<br />
SEND REQUEST<br />
PRL ERR VM UNABLE - Value: 2147484025<br />
TO OPEN VIRTUAL BR-<br />
IDGE<br />
PRL ERR VM UNDEFIN- Value: 2147484034<br />
ED <strong>API</strong> CALL<br />
PRL ERR VM UPDATE - Value: 2147484722<br />
SNAPSHOT DATA FAIL-<br />
ED<br />
PRL ERR VM USER AU- Value: 2147484566<br />
THENTICATION FAILE-<br />
D<br />
PRL ERR VM UUID EM- Value: 2147484208<br />
PTY<br />
PRL ERR VM UUID NO- Value: 2147483909<br />
T FOUND<br />
177<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL ERR VM VALLOC - Value: 2147484051<br />
MON BODY<br />
PRL ERR VM VALLOC - Value: 2147484052<br />
PE IMG<br />
PRL ERR VM VIEW SC- Value: 2147483987<br />
R INVALID ARG<br />
PRL ERR VM VIEW SC- Value: 2147483986<br />
R NOT CREATED<br />
PRL ERR VM VIEW SC- Value: 2147483988<br />
R NOT RUNNING<br />
PRL ERR VTD ALREA- Value: 2147549187<br />
DY HOOKED FAILED<br />
PRL ERR VTD DEVICE- Value: 2147557376<br />
NOT MAPPED<br />
PRL ERR VTD HOOK F- Value: 2147549188<br />
AILED<br />
PRL ERR VTD HOOK - Value: 2147549189<br />
NEED REBOOT FAILE-<br />
D<br />
PRL ERR VTD INITIAL- Value: 2147549186<br />
IZATION FAILED<br />
PRL ERR VTX ENABL- Value: 2147484482<br />
ED ONLY IN SMX<br />
PRL ERR WINDOWS E- Value: 2147484440<br />
XPRESS INSTALL USE-<br />
R NAME EMPTY<br />
PRL ERR WRONG CON- Value: 2147484279<br />
NECTION SECURITY L-<br />
EVEL<br />
PRL ERR WRONG PRO- Value: 2147484691<br />
TOCOL VERSION<br />
PRL ERR WS DISP CO- Value: 2147484230<br />
NNECTION CLOSED<br />
PRL ERR X64GUEST O- Value: 2147484500<br />
N X32HOST<br />
PRL ERR X64GUEST O- Value: 2147484503<br />
N X64VM HVT DISABL-<br />
ED<br />
PRL ERR XML WRITE - Value: 2147484708<br />
FILE<br />
PRL NET ADAPTER N- Value: 2147500036<br />
OT EXIST<br />
178<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL NET BIND FAILE- Value: 2147500041<br />
D<br />
PRL NET CABLE DISC- Value: 2147500048<br />
ONNECTED<br />
PRL NET CONNECTIO- Value: 2147500053<br />
N SHARING CONFLICT<br />
PRL NET ERR ADAPT- Value: 2147500037<br />
ER CONFIG<br />
PRL NET ERR ETH NO- Value: 2147500038<br />
BINDABLE ADAPTER<br />
PRL NET ERR PRL NO- Value: 2147500039<br />
BINDABLE ADAPTER<br />
PRL NET ETHLIST CR- Value: 2147500032<br />
EATE ERROR<br />
PRL NET INSTALL FAI- Value: 2147500051<br />
LED<br />
PRL NET INSTALL TIM- Value: 2147500050<br />
EOUT<br />
PRL NET PRLNET OPE- Value: 2147500040<br />
N FAILED<br />
PRL NET RENAME FAI- Value: 2147500049<br />
LED<br />
PRL NET RESTORE DE- Value: 2147500054<br />
FAULTS PARTITIAL S-<br />
UCCESS<br />
PRL NET SRV NOTIFY- Value: 2147500035<br />
ERROR<br />
PRL NET SYSTEM ERR- Value: 2147500033<br />
OR<br />
PRL NET UNINSTALL - Value: 2147500052<br />
FAILED<br />
PRL NET VLAN UNSUP- Value: 2147500055<br />
PORTED IN THIS VERS-<br />
ION<br />
PRL NET VMDEVICE V- Value: 2147500064<br />
IRTUAL NETWORK CO-<br />
NFIG ERROR<br />
PRL NET VMDEVICE V- Value: 2147500065<br />
IRTUAL NETWORK DI-<br />
SABLED<br />
PRL NET VMDEVICE V- Value: 2147500056<br />
IRTUAL NETWORK N-<br />
OT EXIST<br />
179<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL NET VMDEVICE V- Value: 2147500057<br />
IRTUAL NETWORK N-<br />
O ADAPTER<br />
PRL NET WINSCM OP- Value: 2147500034<br />
EN ERROR<br />
PRL QUEST CDD IMA- Value: 2147484192<br />
GE NOT EXIST<br />
PRL QUEST CD DRIVE- Value: 2147484193<br />
NOT EXIST<br />
PRL QUEST EXCEED R- Value: 2147484185<br />
ECOMMENDED MEMO-<br />
RY<br />
PRL QUEST FDD DRIV- Value: 2147484197<br />
E NOT EXIST<br />
PRL QUEST FDD IMAG- Value: 2147484196<br />
E NOT EXIST<br />
PRL QUEST HDD IMA- Value: 2147484195<br />
GE NOT EXIST<br />
PRL QUEST HDD SAM- Value: 2147484194<br />
E IMAGE<br />
PRL QUEST POWER O- Value: 2147484433<br />
FF<br />
PRL QUEST RESET Value: 2147484434<br />
PRL WARN COMPACT- Value: 2147647490<br />
DESTRUCTIVE<br />
PRL WARN COMPACT- Value: 2147647489<br />
THROUGH COPY<br />
PRL WARN FAT32 FIL- Value: 2147484263<br />
E OVERRUN<br />
PRL WARN GOING TO- Value: 2147484742<br />
TAKE SMART GUARD-<br />
SNAPSHOT<br />
PRL WARN HDD ERRO- Value: 2147484264<br />
R<br />
PRL WARN IMAGE IS - Value: 2147484260<br />
STOLEN<br />
PRL WARN LAN NOT - Value: 2147484257<br />
CONNECTED<br />
PRL WARN TARGET H- Value: 2147484261<br />
OST DISK IS FULL<br />
PRL WARN TOO LOW - Value: 2147484297<br />
HDD SIZE<br />
180<br />
continued on next page
Module prlsdkapi.prlsdk.errors Variables<br />
Name Description<br />
PRL WARN UNABLE O- Value: 2147484259<br />
PEN DEVICE<br />
PRL WARN UNABLE O- Value: 2147484258<br />
PEN DEVICE NAME<br />
PRL WARN UNKNOWN- Value: 2147484262<br />
HDD REQUEST TYPE<br />
PRL WARN VM BOOT- Value: 2147487748<br />
CAMP MODE<br />
PRL WARN VM DVD D- Value: 2147484744<br />
ISCONNECTED BY GU-<br />
EST<br />
PRL WARN VM DVD D- Value: 2147484723<br />
ISCONNECT LOCKED -<br />
DEV<br />
PRL WARN VM PD3 C- Value: 2147487747<br />
OMPAT MODE<br />
PRL WARN VM PD3 C- Value: 2147487749<br />
OMPAT NO MOUSE<br />
181
Index<br />
prlsdkapi (package), 2–99<br />
prlsdkapi.PrlConstsProvider. getattr<br />
prlsdkapi. DeinitSDK (class), 3–4 (method), 8<br />
prlsdkapi. DeinitSDK . del (method), prlsdkapi.PrlConstsProvider. getitem<br />
3<br />
(method), 8<br />
prlsdkapi. get prop doc (function), 2 prlsdkapi.PrlConstsProvider.get (method),<br />
prlsdkapi. prl sdk register objects (func- 8<br />
tion), 2<br />
prlsdkapi.PrlConstsProvider.get list (method),<br />
prlsdkapi.bubble single char (function), 2 9<br />
prlsdkapi.DispConfig (class), 26–29 prlsdkapi.PrlConstsProvider.get name (method),<br />
prlsdkapi.DispConfig.commit (method), 8<br />
27<br />
prlsdkapi.PrlIterator (class), 9–10<br />
prlsdkapi.DispConfig.create net adapter prlsdkapi.PrlIterator. getitem (method),<br />
(method), 27<br />
10<br />
prlsdkapi.DispConfig.get net adapter (method), prlsdkapi.PrlIterator. iter (method), 10<br />
27<br />
prlsdkapi.PrlIterator. len (method), 10<br />
prlsdkapi.DispConfig.remove net adapter prlsdkapi.PrlIterator.get count (method),<br />
(method), 27<br />
9<br />
prlsdkapi.DispNet (class), 29–30<br />
prlsdkapi.PrlIterator.next (method), 10<br />
prlsdkapi.DispNet.remove (method), 29 prlsdkapi.PrlObject (class), 4<br />
prlsdkapi.FoundVm (class), 17–19 prlsdkapi.PrlReadonlyAttrError (class), 4–<br />
prlsdkapi.FSEntry (class), 21–22<br />
5<br />
prlsdkapi.FSInfo (class), 20–21<br />
prlsdkapi.PrlResultIter (class), 10–11<br />
prlsdkapi.FSInfo.get entry (method), 20 prlsdkapi.prlsdk (module), 100–120<br />
prlsdkapi.get handle type (function), 2 prlsdkapi.prlsdk. debug level (function),<br />
prlsdkapi.get os type from version (func- 101<br />
tion), 2<br />
prlsdkapi.prlsdk.Base (class), 101–102<br />
prlsdkapi.GetClientConfig (function), 2 prlsdkapi.prlsdk.BaseAsync (class), 102–<br />
prlsdkapi.LicenceInfo (class), 19–20 104<br />
prlsdkapi.LoginResponse (class), 95–96 prlsdkapi.prlsdk.BaseServer (class), 104–<br />
prlsdkapi.LoginResponse.get run task (method), 106<br />
95<br />
prlsdkapi.prlsdk.BaseVm (class), 106–<br />
prlsdkapi.NetServiceStatus (class), 30–31 107<br />
prlsdkapi.prl datetime property (function), prlsdkapi.prlsdk.CheckServerAlive (func-<br />
2<br />
tion), 100<br />
prlsdkapi.prl indirect property (function), prlsdkapi.prlsdk.consts (module), 121–<br />
2<br />
134<br />
prlsdkapi.prl iter property (function), 2 prlsdkapi.prlsdk.DefaultJobTimeout (func-<br />
prlsdkapi.prl property (function), 2 tion), 100<br />
prlsdkapi.prl sdk call (function), 2 prlsdkapi.prlsdk.DefaultKeyActWait (func-<br />
prlsdkapi.prl sdk call prefix (function), 2 tion), 100<br />
prlsdkapi.prl to date time (function), 2 prlsdkapi.prlsdk.DefaultTimeout (func-<br />
prlsdkapi.PrlConstsProvider (class), 8–9 tion), 100<br />
182
INDEX INDEX<br />
prlsdkapi.prlsdk.DeinitializeSDK (func- 11<br />
tion), 100<br />
prlsdkapi.Server.create vm (method), 11<br />
prlsdkapi.prlsdk.errors (module), 135– prlsdkapi.Server.delete network adapter<br />
176<br />
(method), 15<br />
prlsdkapi.prlsdk.Event (class), 107–109 prlsdkapi.Server.fs can create file (method),<br />
prlsdkapi.prlsdk.GetSDKLibraryPath (func- 13<br />
tion), 100<br />
prlsdkapi.Server.fs create dir (method),<br />
prlsdkapi.prlsdk.GetServerList (function), 13<br />
100<br />
prlsdkapi.Server.fs remove dir (method),<br />
prlsdkapi.prlsdk.InitializeSDK (function), 13<br />
100<br />
prlsdkapi.Server.fs rename dir (method),<br />
prlsdkapi.prlsdk.IsSDKInitialized (func- 13<br />
tion), 100<br />
prlsdkapi.Server.get dir entries (method),<br />
prlsdkapi.prlsdk.Job (class), 109–111 13<br />
prlsdkapi.prlsdk.OwnerRefAsync (class), prlsdkapi.Server.get unique fs entry name<br />
111–112<br />
(method), 16<br />
prlsdkapi.prlsdk.<strong>Parallels</strong>Error (class), 112– prlsdkapi.Server.get user info (method),<br />
113<br />
16<br />
prlsdkapi.prlsdk.PrlJobTimeoutError (class), prlsdkapi.Server.get vm list (method), 12<br />
113<br />
prlsdkapi.Server.net service (method), 14<br />
prlsdkapi.prlsdk.PrlNotImplError (class), prlsdkapi.Server.register vm (method), 11<br />
113–114<br />
prlsdkapi.Server.search vms (method), 14<br />
prlsdkapi.prlsdk.PrlStateError (class), 114– prlsdkapi.Server.send answer (method),<br />
115<br />
14<br />
prlsdkapi.prlsdk.Question (class), 115– prlsdkapi.Server.subscribe to host statistics<br />
117<br />
(method), 12<br />
prlsdkapi.prlsdk.Result (class), 117–119 prlsdkapi.Server.subscribe to perf stats<br />
prlsdkapi.prlsdk.ServerInfo (class), 119– (method), 12<br />
120<br />
prlsdkapi.Server.unsubscribe from host statistics<br />
prlsdkapi.prlsdk.SetSDKLibraryPath (func- (method), 12<br />
tion), 101<br />
prlsdkapi.Server.unsubscribe from perf stats<br />
prlsdkapi.PrlSDKAsyncError (class), 6–8 (method), 12<br />
prlsdkapi.PrlSDKError (class), 5–6 prlsdkapi.Server.update licence (method),<br />
prlsdkapi.PrlSDKError.get details (method), 14<br />
6<br />
prlsdkapi.Server.update network adapter<br />
prlsdkapi.RunningTask (class), 96–97 (method), 15<br />
prlsdkapi.Server (class), 11–17<br />
prlsdkapi.SrvCfgDev (class), 88–90<br />
prlsdkapi.Server.add network adapter (method), prlsdkapi.SrvCfgHdd (class), 91–92<br />
15<br />
prlsdkapi.SrvCfgHdd.get part (method),<br />
prlsdkapi.Server.attach to lost task (method), 91<br />
15<br />
prlsdkapi.SrvCfgHddPart (class), 92–93<br />
prlsdkapi.Server.begin edit common prefs prlsdkapi.SrvCfgNet (class), 90–91<br />
(method), 11<br />
prlsdkapi.SrvConfig (class), 22–25<br />
prlsdkapi.Server.begin edit user profile (method), prlsdkapi.SrvConfig.get device (method),<br />
183
INDEX INDEX<br />
23<br />
40<br />
prlsdkapi.SrvConfig.get devices count (method), prlsdkapi.Vm.get scr res (method), 41<br />
23<br />
prlsdkapi.Vm.get serial port (method),<br />
prlsdkapi.SrvInfo (class), 93–95<br />
40<br />
prlsdkapi.UserConfig (class), 25–26 prlsdkapi.Vm.get share (method), 41<br />
prlsdkapi.UserConfig.commit (method), prlsdkapi.Vm.get sound dev (method), 40<br />
25<br />
prlsdkapi.Vm.get usb dev (method), 40<br />
prlsdkapi.UsrInfo (class), 97–99<br />
prlsdkapi.Vm.get weak objects (method),<br />
prlsdkapi.Vm (class), 32–48<br />
42<br />
prlsdkapi.Vm.add default device (method), prlsdkapi.Vm.initiate dev state notifications<br />
35<br />
(method), 42<br />
prlsdkapi.Vm.begin edit (method), 37 prlsdkapi.Vm.install tools (method), 43<br />
prlsdkapi.Vm.change access rights (method), prlsdkapi.Vm.pause (method), 33<br />
37<br />
prlsdkapi.Vm.refresh config (method), 38<br />
prlsdkapi.Vm.clone (method), 34 prlsdkapi.Vm.reg (method), 36<br />
prlsdkapi.Vm.commit (method), 38 prlsdkapi.Vm.reg event handler (method),<br />
prlsdkapi.Vm.create boot dev (method), 41<br />
42<br />
prlsdkapi.Vm.reset (method), 34<br />
prlsdkapi.Vm.create device (method), 38 prlsdkapi.Vm.resume (method), 34<br />
prlsdkapi.Vm.create event (method), 42 prlsdkapi.Vm.send utility command (method),<br />
prlsdkapi.Vm.create scr res (method), 41 42<br />
prlsdkapi.Vm.create share (method), 41 prlsdkapi.Vm.set clipboard (method), 42<br />
prlsdkapi.Vm.create unattended floppy prlsdkapi.Vm.set default config (method),<br />
(method), 42<br />
35<br />
prlsdkapi.Vm.delete (method), 35 prlsdkapi.Vm.start (method), 33<br />
prlsdkapi.Vm.drop suspended state (method), prlsdkapi.Vm.stop (method), 33<br />
34<br />
prlsdkapi.Vm.subscribe to guest statistics<br />
prlsdkapi.Vm.execution (method), 33 (method), 36<br />
prlsdkapi.Vm.generate device filename (method), prlsdkapi.Vm.subscribe to perf stats (method),<br />
43<br />
36<br />
prlsdkapi.Vm.get boot dev (method), 42 prlsdkapi.Vm.suspend (method), 34<br />
prlsdkapi.Vm.get default settings (static prlsdkapi.Vm.tools send shutdown (method),<br />
method), 33<br />
43<br />
prlsdkapi.Vm.get device (method), 39 prlsdkapi.Vm.unreg (method), 37<br />
prlsdkapi.Vm.get devices count (method), prlsdkapi.Vm.unreg event handler (method),<br />
38<br />
42<br />
prlsdkapi.Vm.get display dev (method), prlsdkapi.Vm.unsubscribe from guest statistics<br />
42<br />
(method), 36<br />
prlsdkapi.Vm.get floppy (method), 39 prlsdkapi.Vm.unsubscribe from perf stats<br />
prlsdkapi.Vm.get hdd (method), 39 (method), 36<br />
prlsdkapi.Vm.get net adapter (method), prlsdkapi.Vm.update config (method), 38<br />
41<br />
prlsdkapi.Vm.validate config (method),<br />
prlsdkapi.Vm.get optical (method), 39 43<br />
prlsdkapi.Vm.get parallel port (method), prlsdkapi.VmAccessRights (class), 31–32<br />
184
INDEX INDEX<br />
prlsdkapi.VmBaseDev (class), 55–57 prlsdkapi.VmDisplayDev.send screen size event<br />
prlsdkapi.VmBaseDev.connect (method), (method), 52<br />
55<br />
prlsdkapi.VmDisplayDev.set mouse pos<br />
prlsdkapi.VmBaseDev.create (method), (method), 53<br />
55<br />
prlsdkapi.VmFloppyDev (class), 60–62<br />
prlsdkapi.VmBaseDev.create image (method), prlsdkapi.VmHddDev (class), 65–66<br />
56<br />
prlsdkapi.VmIFaceStat (class), 80–82<br />
prlsdkapi.VmBaseDev.disconnect (method), prlsdkapi.VmInfo (class), 86–87<br />
55<br />
prlsdkapi.VmNetDev (class), 66–68<br />
prlsdkapi.VmBaseDev.remove (method), prlsdkapi.VmNetDev.generate mac addr<br />
56<br />
(method), 67<br />
prlsdkapi.VmBaseDev.set default stack indexprlsdkapi.VmObjEmulation<br />
(class), 48–49<br />
(method), 56<br />
prlsdkapi.VmObjEmulation. ensure attr<br />
prlsdkapi.VmBaseDiskDev (class), 57–59 (method), 49<br />
prlsdkapi.VmBasePortDev (class), 59–60 prlsdkapi.VmObjEmulation.call vm (method),<br />
prlsdkapi.VmBootDev (class), 72–74 49<br />
prlsdkapi.VmBootDev.remove (method), prlsdkapi.VmObjEmulation.inderect self<br />
73<br />
(method), 49<br />
prlsdkapi.VmCPUStat (class), 79–80 prlsdkapi.VmObjEmulation.safe call (method),<br />
prlsdkapi.VmDiskPartStat (class), 84–85 49<br />
prlsdkapi.VmDiskStat (class), 83–84 prlsdkapi.VmOpticalDev (class), 62–63<br />
prlsdkapi.VmDiskStat.get part stat (method), prlsdkapi.VmParallelPortDev (class), 63–<br />
83<br />
65<br />
prlsdkapi.VmDisplayDev (class), 50–55 prlsdkapi.VmProcStat (class), 85–86<br />
prlsdkapi.VmDisplayDev. del (method), prlsdkapi.VmScrRes (class), 74–75<br />
51<br />
prlsdkapi.VmScrRes.remove (method), 74<br />
prlsdkapi.VmDisplayDev.capture screen to file prlsdkapi.VmSerialDev (class), 68–70<br />
(method), 52<br />
prlsdkapi.VmShare (class), 75–77<br />
prlsdkapi.VmDisplayDev.check connected prlsdkapi.VmShare.remove (method), 76<br />
(method), 51<br />
prlsdkapi.VmSoundDev (class), 70–71<br />
prlsdkapi.VmDisplayDev.connect to vm prlsdkapi.VmStat (class), 77–79<br />
(method), 51<br />
prlsdkapi.VmStat.get cpu stat (method),<br />
prlsdkapi.VmDisplayDev.disconnect from vm 77<br />
(method), 52<br />
prlsdkapi.VmStat.get disk stat (method),<br />
prlsdkapi.VmDisplayDev.engage job (method), 78<br />
51<br />
prlsdkapi.VmStat.get iface stat (method),<br />
prlsdkapi.VmDisplayDev.get screen buffer 77<br />
(method), 52<br />
prlsdkapi.VmStat.get proc stat (method),<br />
prlsdkapi.VmDisplayDev.move mouse (method), 78<br />
53<br />
prlsdkapi.VmStat.get user stat (method),<br />
prlsdkapi.VmDisplayDev.send key event 78<br />
(method), 54<br />
prlsdkapi.VmToolsInfo (class), 87–88<br />
prlsdkapi.VmDisplayDev.send keys event prlsdkapi.VmUsbDev (class), 71–72<br />
(method), 53<br />
prlsdkapi.VmUserStat (class), 82–83<br />
185
INDEX INDEX<br />
prlsdkapi.VmVNCConfig (class), 49–50<br />
186