ESX System Analyzer Version 1.0 Installation Guide Page 1
Table of Contents ESX System Analyzer Installation Guide 1. Installing ESX System Analyzer... 3 ESX System Analyzer Appliance Distribution... 3 Requirements... 3 Before Starting... 3 2. Deploying ESX System Analyzer from vsphere Client... 4 Procedure... 4 3. Deploying ESX System Analyzer from OVF Tool... 10 Using OVF Tool... 10 Command-Line Options... 10 4. Troubleshooting... 12 5. Log in to the Application... 12 Page 2
1. Installing ESX System Analyzer ESX System Analyzer Appliance Distribution The ESX System Analyzer Appliance software is distributed as an Open Virtualization Format (OVF) file. The file that contains the ESX System Analyzer 5 is ESX System Analyzer.ovf. The distribution archive contains the following items: OVF file that contains parameters for ESX System Analyzer Hard disk image (VMDK) Manifest for the archive User deploys the OVF file directly from the vsphere Client; and do not need to extract the archive before performing the deployment. Requirements The following are the requirements, to run ESX System Analyzer: - ESX System Analyzer virtual appliance specifications: o 20GB virtual disk o 512MB virtual memory o 1 vcpu - vcenter Server 2.5, 4.0, 4.1, 5.0 - ESX Hosts 3.5, 4.0, 4.1 - Username and password for a vcenter Server user with administrator access - Root password for all ESX hosts to be analyzed - Root SSH enabled on all ESX hosts to be analyzed The ESX System Analyzer application is compatible with following browsers: 1. Internet Explorer 8 2. Internet Explorer 7 3. Mozilla Firefox 6.0.2 4. Chrome 13.0.782 Before Starting The ESX System Analyzer can be installed using any method for deploying an OVF supported by the environment. The following section describes how to deploy ESX System Analyzer tool OVF with the vsphere Client, a Windows application for managing and configuring the vcenter Server. The instructions assume that the host or cluster to which user wants to deploy ESX System Analyzer have already been configured in vcenter Server. Page 3
Before starting, make sure that the ESX System Analyzer distribution archive is in a location that is accessible to the computer on which the vsphere Client is running. 2. Deploying ESX System Analyzer from vsphere Client In the vsphere Client, the Deploy OVF Wizard is used to create a virtual machine running the ESX System Analyzer application, as described in this section. While the following procedure provides a general guideline for how to deploy ESX System Analyzer, the exact steps that you need to perform may vary depending on the characteristics of environment and setup. Procedure 1. Open vsphere Client and select the target host on which ESX System Analyzer OVF needs to be deployed. 2. From the vsphere Client main menu, choose File > Deploy OVF Template. The Deploy OVF Template Source window appears. Figure 1: Select Source 3. Click on Browse button, and provide the location of ESX System Analyzer OVF. Page 4
4. Click Next. 5. The OVF Template Details window appears. The details include the product being installed, the size of the OVF file (download size), and the amount of disk space that needs to be available for the virtual machine (size on disk). Figure 2: OVF Template Details window 6. Verify the OVF template details and click Next. 7. The Name and Location window appears. Page 5
Figure 3: Name and Location window 8. Enter the name for the VM to be deployed in the Name field and click Next. This name value is used to identify the new virtual machine in the infrastructure so use any name that distinguishes this particular VM in the environment. 9. The Datastore window appears. There should be at least 20 GB hard disk space available for deploying ESX System Analyzer. Page 6
Figure 4: Datastore window 10. Select the datastore on which Virtual machine, running ESX System Analyzer, to be stored. Click Next. 11. The Disk Format window appears. Page 7
Figure 5: Disk Format window 12. Select the format that this VM should use and Click Next. 13. The Ready to Complete window appears. Page 8
Figure 6: Ready to Complete window 14. Review the settings shown for the deployment and, if needed, click the Back button to modify any of the settings shown. 15. Click Finish to complete the deployment. A message notifies user when the installation completes. 16. Click Close to dismiss the Deployment Completed Successfully dialog box. Page 9
3. Deploying ESX System Analyzer from OVF Tool This section describes how to deploy ESX System Analyzer from the command line. As an alternative to using the vsphere Client to deploy the ESX System Analyzer tool as described in "Before Starting" section, OVF Tool, which is a command-line client, could also be used. Using OVF Tool OVF Tool is a command- line utility that supports importing and exporting of OVF packages from ESX hosts and other products. A VI location refers to any location on a product, such as vsphere, Server or ESX. This section describes how to run and select OVF Tool options. To run OVF Tool from the command line 1. At the command- line prompt, run the OVF Tool. ovftool <source locator> <target locator> where <source locator> and <target locator> are the paths to the source and target for the virtual machine, OVF package or VI location. 2. If additional options need to be specified, type them before the source and target locators. ovftool <options> <source locator> <target locator> 3. To display all options, type ovftool -h. Command- Line Options For every command, user needs to specify the source and target locators. Locator <source locator> <target locator Table 1: Source and Target Locator Definition Path to the source, which must be an OVF package. A path to an OVF The target locator can be a VI locator identifying a cluster, host, or a vsphere location Table 2 shows all the command-line options. Options perform actions only between certain source and target types. Table 2 shows which source and target types each option works with. If the user specifies an option using an irrelevant source or target type, the command does nothing. All options can be set using the form --option=value. Binary options can be enabled or disabled explicitly. For example: --option=true, --option=false. Option Name Long Option Short Name Relevant Source Types Relevant Target Types Description Page 10
--datastore -ds N/A VI Target datastore name for a VI or vsphere deployment. --diskmode -dm N/A VMX, VI Selects target disk format. Common formats are monolithicsparse, monolithicflat, twogbmaxextentsparse, twogbmaxextentflat, streamoptimized, thin (VI target), thick (VI target) --help -h N/A N/A Prints the OVF Tool help message with usage information. --name -n N/A All Specifies the target name. Defaults to the source name. --poweron N/A All Powers on a virtual machine or vapp deployed on a VI target. Binary option --sourcetype -st All All Explicitly expresses that the source is OVF. --targettype -tt All All Explicitly express that the target is VI. Table 2: Command line options For example: C:\>ovftool "C:\ESX System Analyzer\ESX System Analyzer.ovf" "vi://192.168.111.151" C:\>ovftool -ds= Datastore1 "C:\ESX System Analyzer\ESX System Analyzer.ovf" "vi://192.168.111.151" Page 11
4. Troubleshooting ESX System Analyzer Installation Guide If any of the following problems are experienced, please try the given solution: 1. After OVF deployment, not able to power on the VM: This could be the case, when OVF got deployed but VM required more resources to boot, then what it is getting currently. Check the resources like memory, HDD etc if these are enough for powering on ESX System Analyzer VM. 2. After OVF deployment, no IP address is assigned to VM: This could be the case when your VM is not connected to any network. Check the network settings and connection of host on which VM is deployed. Check if VM is connected to network or not. 5. Log in to the Application To log in to the ESX System Analyzer application, follow the below steps: 1. Power on the deployed Virtual Machine. 2. Enter username as root and password as vmware. 3. Right click on desktop and open command terminal. 4. If tomcat is not started automatically, start it manually by typing command service tomcat5 start and press Enter. 5. Type ifconfig and press Enter. 6. Note the IP address of virtual machine. 7. Now open the browser in the machine, where ESX System Analyzer application needs to be accessed. 8. Type https://<ip address of deployed VM>:8443/ua/Initial.jsp or http://<ip address of deployed VM>:8080/ua/Initial.jsp in address bar and press Enter. The login page of application will get opened. 9. Refer ESX System Analyzer User Guide for using the application. Page 12