Parallels® Server SDK ReadMe -------------------------------------------------------------------------------- CONTENTS: 1. About Parallels Server SDK 2. System Requirements 2.1. Mac OS Client Computers 2.2. Windows Client Computers 2.3. Linux Client Computers 3. Network Requirements 4. Installing SDK 4.1. Installing on Mac OS X 4.2. Installing on Windows 4.3. Installing on Linux 5. Removing SDK 5.1. Removing from Mac OS X 5.2. Removing from Windows 5.3. Removing from Linux 6. Copyright Notice 7. Contact Info -------------------------------------------------------------------------------- 1. About Parallels Server SDK Parallels Server SDK is a development kit used to build Parallels Server client applications. The SDK provides cross-platform C and Python APIs and includes the following components: - C header files - Dynamic libraries - A Python package used to develop client applications in Python. - Parallels Command-Line Tool (prlctl) - a sample client application that was developed using the Parallels Server SDK. The C source code and the executable version is included. This is a fully functional console application that can be used to perform a full range of operations on a Parallels server and its virtual machines. - A collection of sample virtual machine configuration files in XML format for use with the Parallels Command-Line Tool (above). The configuration information contained in each file can be customized to suit a particular need. -------------------------------------------------------------------------------- 2. System Requirements Parallels Server SDK can be installed on any computer that complies with the following system requirements. 2.1. Mac OS X client computers Hardware Requirements - Intel-powered Core™ Duo or Core Solo Mac® Mini, iMac®, MacBook™, MacBook Pro, MacBook Air, Mac Pro, or Xserve. - Ethernet or WiFi network adapter. Software Requirements - Mac OS X Tiger 10.4.8 or later - Mac OS X Leopard 10.5.2 or later 2.2. Windows client Computers Hardware Requirements - Intel-compatible x86 (32-bit) or x64 (64-bit) processor. - Ethernet or WiFi network adapter. Software Requirements - Windows Vista® Ultimate (x32, x64) - Windows Server® 2003 Standard Edition SP2, R2 (x32, x64) - Windows Server 2003 Enterprise Edition SP2, R2 (x32, x64) - Windows XP Professional Edition SP2 (x32, x64) - Windows 2003 Home Server (x32, x64) 2.3. Linux client Computers Hardware Requirements - Intel-compatible x86 (32-bit) or x64 (64-bit) processor. - Ethernet network adapter. Software Requirements - Red Hat® Enterprise Linux WS4 (x32, x64) - Red Hat Enterprise Linux AS4 (x32, x64) - Red Hat Enterprise Linux ES4 (x32, x64) - Red Hat Enterprise Linux 5 (x32, x64) - CentOS 4.x (x32, x64) - CentOS 5.0 (x32, x64) - CentOS 5.1 (x32, x64) - Ubuntu Server 7.10 (x32, x64) - SUSE® Linux Enterprise Server 10 SP1 (x32, x64) -------------------------------------------------------------------------------- 3. Network Requirements To connect to a Parallels server using the provided APIs, your client computer must be able to establish a network connection with the host computer running the server. The client computer can be connected to a local area network via a wired or a wireless interface. Clients communicate with a Parallels server via TCP/IP. The server is listening on port 6400. Please make sure that the port is not blocked by a firewall. -------------------------------------------------------------------------------- 4. Installing Parallels Server SDK 4.1. Installing Parallels Server SDK on Mac OS X 1) Locate and open the Parallels Server SDK DMG package. 2) Double-click Install Parallels Server SDK to launch the installation wizard. 3) In the Welcome window, click Continue. 4) In the Easy Install on "Macintosh HD" window, click Install to perform basic installation of Parallels Server SDK. The default installation path for Parallels Server is /Library/Frameworks/ParallelsServer.framework. The Python package files are copied to the standard Python path. 5) In the Finish Up window, click Restart to restart your Mac and finish the installation. 4.2. Installing Parallels Server SDK on Windows 1) Locate the Parallels Server package and double-click the "Parallels Server SDK.exe" file to launch the installation wizard. 2) In the Welcome window, click Next. 3) In the License Agreement window, carefully read the Software End User License Agreement for Parallels Server. If you agree with the terms of the license agreement, select "I accept the terms" in the license agreement and click Next. If you want to print the text of the license agreement for your records, click Print. Note: You have to accept the Software License Agreement to proceed with the installation. 4) In the Destination Folder window, specify the folder where you want to install the SDK and click Next. By default, Parallels Server SDK is installed to the following location: C:\Program Files\Parallels\Parallels Server SDK The Python package files are copied to the standard Python path. 5) In the Ready to Install the Program window, click Install to begin the installation. 6) When the installation is complete, click Finish to exit the wizard. 4.3. Installing Parallels Server SDK on Linux 1) Locate the Parallels Server installation package and launch the parallels-server-sdk-3.0.XXXX.XXXXX.run file to run Parallels Server SDK Installer. You can also open this file in a terminal. 2) Confirm that you want to install Parallels Server SDK by clicking Run when prompted. 3) In the License Agreement window, carefully read the Software License Agreement. If you agree with the stated terms and conditions, choose Accept. If you don't agree, choose Decline. Note: You have to accept the Software License Agreement to proceed with the installation. 4) In the Installation Completed window, click Exit to quit the Installer. -------------------------------------------------------------------------------- 6. Copyright Notice Copyright© 1999-2008 by Parallels Software International Inc. All rights reserved. Parallels, Coherence, Parallels Transporter, Parallels Compressor, Parallels Desktop, and Parallels Explorer are registered trademarks of Parallels Software International, Inc. The Parallels logo is a trademark of Parallels Software International, Inc. This product is based on a technology that is the subject matter of a number of patent pending applications. Distribution of this work or derivative of this work in any form is prohibited unless prior written permission is obtained from the copyright holder. Microsoft, Windows, Windows Server, Windows NT, Windows Vista, and MS-DOS are registered trademarks of Microsoft Corporation. Linux is a registered trademark of Linus Torvalds. Apple, Mac, and Mac OS are trademarks of Apple Inc. VMware is a registered trademark of VMware, Inc. All other marks and names mentioned herein may be trademarks of their respective owners. -------------------------------------------------------------------------------- 7. Contact Info Product Website: www.parallels.com Support: www.parallels.com/support