Contents
Previous Next
Installing the VmPerl and VmCOM Scripting APIs on a Windows Host
On either a Windows server host or a Windows remote computer, you can use either the VmPerl API or the VmCOM API. Both scripting APIs are installed automatically on the GSX Server for Windows host from the master installer if you chose a complete installation. In addition, you can make the APIs available for download by customizing the download menu on the Login page of the VMware Management Interface. For more information, see
Customizing the Download Menu.
You have a choice of installing either the VmCOM or the VmPerl API, or both.
1. Choose Start > Run and browse to the directory where you saved the downloaded installer file (the name is similar to VMware-VmPerlAPI-<xxxx>.exe or VMware-VmCOMAPI-<xxxx>.exe, where <xxxx> is a series of numbers representing the version and build numbers).
2. The installer starts. Click Next.
3. Acknowledge the end user license agreement (EULA). Select I accept the terms in the license agreement, then click Next.
4. Choose the directory in which to install the scripting API. To install it in a directory other than the default, click Change and browse to your directory of choice. If the directory does not exist, the installer creates it for you. Click Next.
Note: Windows and the Microsoft Installer limit the path length to 255 characters for a path to a folder on a local drive, and 240 characters for a path to a folder on a mapped or shared drive. If the path to the scripting API program folder exceeds this limit, an error message appears. You must select or enter a shorter path.
5. If you want to change any settings or information you provided, now is the time to make those changes. Click Back until you reach the dialog box containing the information you want to change.
Otherwise, click Install. The installer begins copying files to your host.
6. Click Finish. The VMware Scripting API is installed.
If you install the VmCOM API, two directories named MiniMUI and SampleScripts are created in the VmCOM API directory. The MiniMUI directory contains a sample Microsoft Visual Basic 6 project that uses the VmCOM API. The SampleScripts directory contains VBScript and JScript samples using the VmCOM API.
If you install the VmPerl API, a SampleScripts directory is created in the VmPerl API directory. The SampleScripts directory contains sample scripts using the VmPerl API.
