VMware HealthAnalyzer Collector

Installation and User Guide

Release 5.1.0
December 2016
 VMware HealthAnalyzer Collector
Installation and User Guide

© 2016 VMware, Inc. All rights reserved. This product is protected by U.S. and international copyright and
intellectual property laws. This product is covered by one or more patents listed at
[Link]
VMware is a registered trademark or trademark of VMware, Inc. in the United States and/or other
jurisdictions. All other marks and names mentioned herein may be trademarks of their respective
companies.

VMware, Inc.
3401 Hillview Ave
Palo Alto, CA 94304
[Link]

© 2016 VMware, Inc. All rights reserved.

Page 2 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide

Contents

About This Document ............................................................................. 5

Intended Audience ................................................................................................................. 5
Support, Feedback and Questions ......................................................................................... 5

1. Introducing VMware HealthAnalyzer ................................................ 6

1.1 Security .......................................................................................................................... 6

2. Installing and Configuring VMware HealthAnalyzer Collector ........... 8

2.1 System Requirements .................................................................................................... 8
2.2 Installing and Configuring VMware HealthAnalyzer Collector ....................................... 8

3. Working with VMware HealthAnalyzer Collector ............................ 16

3.1 Setting Up Access to vCenter Server, View Connection Server, NSX Manager and NSX
Controller .............................................................................................................................. 16
3.2 Using the Project Explorer ........................................................................................... 23
3.3 Exporting Projects and Log Files <<export only>> ...................................................... 37

© 2016 VMware, Inc. All rights reserved.

Page 3 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide

List of Figures
Figure 1. VMware HealthAnalyzer Collector Application Installation Workflow ............................................ 8
Figure 2. VMware HealthAnalyzer Collector Virtual Appliance Installation Workflow ................................. 10
Figure 3. Project Explorer ........................................................................................................................... 23

© 2016 VMware, Inc. All rights reserved.

Page 4 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide

About This Document

This guide describes how to install, configure, and use the VMware HealthAnalyzer Collector.
The contents of this document are also available from the Help link in the VMware HealthAnalyzer
Collector user interface.

Intended Audience
This information is intended for use only by VMware Professional Services consultants, VMware partners,
and VMware customers who have a current Services Software Solutions subscription.

Support, Feedback and Questions

Contact services-software-support@[Link] if you have questions, require support, or have
suggestions for improving the VMware HealthAnalyzer Collector documentation.

© 2016 VMware, Inc. All rights reserved.

Page 5 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide

1. Introducing VMware HealthAnalyzer

VMware HealthAnalyzer automates the collection and analysis of VMware Horizon® and VMware
vSphere® inventory, including configuration and utilization data.
VMware HealthAnalyzer Collector gathers View and vSphere inventory data from the systems in your
environment. You can then export the data and send it to VMware or a VMware partner for analysis.
VMware HealthAnalyzer provides consistent, scalable data collection:
 vSphere – Data can be collected from a specified VMware vCenter Server® and other systems within
the vSphere infrastructure.
 VMware Horizon– Data for analysis of desktop systems can be captured from a View Connection
Server and all of the systems with related data within the vSphere infrastructure.
 VMware NSX® for vSphere – Data can be collected from VMware NSX Manager™ (standalone or
Cross-vCenter setup) and VMware NSX Controller™ instances.

1.1 Security
To collect VMware vCenter® data, VMware HealthAnalyzer connects to vCenter Server over port 443
using the VMware API. To collect data from View, VMware HealthAnalyzer uses a proprietary protocol
over port 443. To collect data from NSX, VMware HealthAnalyzer uses REST API to collect data from
NSX Manager and SSH protocol to collect data from NSX Controllers.
During data collection, the communication between VMware HealthAnalyzer and the target servers is
secured with HTTPS (HTTP over SSL, default port 443). For the VMware HealthAnalyzer virtual
appliance, data is stored in a local database protected by VMDK file system security. For the VMware
HealthAnalyzer application, the file is protected by default Windows or Mac security. VMware
HealthAnalyzer collects only general inventory, configuration, and some utilization information.
VMware HealthAnalyzer requires read-only permission for vCenter, read-only administrator permission for
the View Connection Server, and read-only administrator permission for NSX Manager and NSX
Controller for data collection, so consultants, administrators, or customers can use the inherent security
and authorization feature to create an account without compromising the security of the targeted vSphere,
View, and NSX environments. VMware HealthAnalyzer does not store the password of the read-only
account or any customer account.
VMware HealthAnalyzer uses the following ports.
Table 1. VMware HealthAnalyzer Network Ports

Port Protocol Description

22 SSH Inbound TCP port that is used by an administrator to log in to the

VMware HealthAnalyzer virtual appliance to perform maintenance
tasks. This port is not used by the VMware HealthAnalyzer application.

443 HTTPS Outbound TCP port that is used by VMware HealthAnalyzer to retrieve
data from the targeted vCenter Server. This port is specified when
configuring VMware HealthAnalyzer to retrieve data and might be
different depending on the environment.

8080 HTTP Inbound TCP port that is used by the VMware HealthAnalyzer user
interface.

© 2016 VMware, Inc. All rights reserved.

Page 6 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide

Port Protocol Description

80 and 8080 HTTP Both inbound TCP ports are used by the VMware HealthAnalyzer virtual
appliance user interface.

41984 Port used for the VMware HealthAnalyzer database.

41985 Port used for VMware HealthAnalyzer database event service.

5480 HTTPS Inbound TCP port used to access the VMware HealthAnalyzer virtual
appliance management Web interface from a Web browser.

© 2016 VMware, Inc. All rights reserved.

Page 7 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide

2. Installing and Configuring VMware HealthAnalyzer

Collector
The following sections describe how to install and configure VMware HealthAnalyzer Collector.

2.1 System Requirements

VMware HealthAnalyzer Collector is available as a Java application or as a virtual appliance. The
VMware HealthAnalyzer Collector user interface uses HTML and JavaScript, and is accessed through a
web browser. Before installing VMware HealthAnalyzer Collector, confirm that the following system
requirements are satisfied.
 Platform options:
o Microsoft Windows Server (2008 or later), Windows (7 or later) or Apple Mac (Lion, Mountain
Lion, Mavericks, Yosemite, El Capitan or Sierra).
o Directly import and power on the OVA file containing the VMware HealthAnalyzer Collector virtual
appliance using the VMware vSphere Client™ (4.0 or later), VMware Workstation™ (9 or later),
or VMware Fusion® (5 or later).
 At least 3 GB RAM.
 JRE 1.7 (JRE 1.8 64-bit is recommended)

Note Do not run VMware HealthAnalyzer Collector on the same machine that runs vCenter Server. To
avoid performance issues, do not run VMware HealthAnalyzer Collector from a shared folder or a
USB drive.

2.2 Installing and Configuring VMware HealthAnalyzer Collector

2

Before installing VMware HealthAnalyzer Collector, verify that you have satisfied all of the system
requirements and review the VMware HealthAnalyzer Release Notes for information that might affect your
installation.
Obtain the installation package from your VMware consultant or partner.

2.2.1 Installing the VMware HealthAnalyzer Collector Application

The high-level steps required to install the VMware HealthAnalyzer Collector application and display the
user interface are shown in the following figure.

Note If you have any trouble completing the installation steps, examine the files in the logs folder
within the installation folder. If you still have trouble, contact Support.

Figure 1. VMware HealthAnalyzer Collector Application Installation Workflow

Set up the
Change browser
Download the VMware Display the user
proxy settings
installation file HealthAnalyzer interface
(if necessary)
application

To install and open the VMware HealthAnalyzer Collector application

1. Download the VMware HealthAnalyzer Collector application installation file.

© 2016 VMware, Inc. All rights reserved.

Page 8 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide
2. Unzip the installation package, and open the folder containing the unzipped files. Avoid placing the
unzipped package in a folder with a long path name or with special characters.
3. Double-click [Link].
4. The VMware HealthAnalyzer Collector launcher application opens. After both the App Server and the
Database Server are running, click Connect to start the VMware HealthAnalyzer Collector user
interface in a web browser. Review and accept the end user license agreement, if prompted.

© 2016 VMware, Inc. All rights reserved.

Page 9 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide

2.2.2 Installing the VMware HealthAnalyzer Collector Virtual Appliance

The high-level steps required to install the VMware HealthAnalyzer Collector virtual appliance and display
the user interface are shown in the following figure.
Figure 2. VMware HealthAnalyzer Collector Virtual Appliance Installation Workflow

Download Apply the Install Change

installation latest Find or set VMware appliance
Display
files and patches to the virtual Tools, if a or browser
the user
power on the virtual appliance later proxy
interface
the virtual appliance IP address version is settings, if
appliance OS available necessary

[Link]. Installing the Virtual Appliance OVA File

To install the virtual appliance OVA File
1. Download the VMware HealthAnalyzer Collector virtual appliance installation file.
2. Unzip the installation directory file.
3. Import the OVA file using the vSphere Client (4.0 or later), Workstation (9 or later), or VMware Fusion
(5 or later).
4. Power on the virtual appliance.
The virtual appliance must continue to run until you are finished using the VMware HealthAnalyzer
Collector user interface. You can minimize its window or run the process in the background.

[Link]. Using the Virtual Appliance Web Console

The VMware HealthAnalyzer Collector virtual appliance provides a web console management user
interface. This is the standard web console for virtual appliances and vApps generated using VMware
Studio. Instead of using the command line, you can use the web console to perform tasks such as reboot,
shutdown, setting the system time zone, finding or changing the appliance IP address, and changing
network or proxy settings.

[Link]. Logging in to the Virtual Appliance

To log in to the virtual appliance web console
1. Open your browser and go to [Link] appliance IP address>:5480.
2. User name is ro ot and Password is v mw are .
If you cannot access the appliance web console, check proxy settings between the appliance and the
browser. See Section 2.2.4, Changing Browser Proxy Settings.
To log in to the virtual appliance command-line interface
1. At the login prompt, type r oot and press Enter.
2. For password, type v mw a re and press Enter.
To maintain security, change the password immediately after logging in for the first time.

[Link]. Finding the Virtual Appliance IP Address

You need to know the virtual appliance IP address to display the VMware HealthAnalyzer Collector user
interface or the virtual appliance web console.

© 2016 VMware, Inc. All rights reserved.

Page 10 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide
To display the virtual appliance IP address from the vSphere Client
1. Power on the virtual appliance.
2. Open the vSphere Client.
3. Click the Summary or Console tab to display the IP address.
To display the virtual appliance IP address from Workstation
1. Power on the virtual appliance.
2. The IP address is displayed as the virtual appliance starts.
To display the virtual appliance IP address from the command-line
Type ifconfig at an appliance command-line prompt. Use the eth0 inet address.

[Link]. Configuring the Virtual Appliance to Use a Static IP Address

By default, the virtual appliance is configured to use DHCP, but you can configure it to use a static IP
address.
To configure a static IP address from the web console
1. Open the VMware HealthAnalyzer Collector virtual appliance web console.
2. Click the Network tab, and click Address.
3. Select Use the following IP settings.
4. Enter the IP address and other network parameters (Netmask, Gateway, Preferred DNS Server,
Alternate DNS Server, Hostname) and click Save Settings.

[Link]. Changing Virtual Appliance Proxy Settings

If there is a proxy server set up between the virtual appliance and the internet or vCenter, configure the
virtual appliance to use the proxy server.
To configure the proxy
1. Open the VMware HealthAnalyzer Collector virtual appliance web console.
2. Click the Network tab.
3. Click Proxy.
4. Select Use a Proxy Server.
5. Enter the information about the proxy server:
 Proxy Server – Enter the IP address or fully qualified domain name of the proxy server.
 Proxy Port – Enter the port used by the proxy server.
6. Click Save Settings.

2.2.3 Changing the Tomcat Process Memory

You can change the amount of memory allocated to the Tomcat process for VMware HealthAnalyzer
Collector. You might need to increase the amount of memory allocated if you are using VMware
HealthAnalyzer Collector in a large environment. The procedure differs depending on whether you are
using the VMware HealthAnalyzer Collector virtual appliance or the Java application.
To change the amount of Tomcat memory with a virtual appliance
1. Log in to the virtual appliance using the user root and password v mw a re .

© 2016 VMware, Inc. All rights reserved.

Page 11 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide
2. Open the configuration file using vi or another text editor:
vi /usr/share/vha/tomcat/conf/vha-tomcat-memory
3. Locate the default value of 2048 and change it to your desired value. This is the amount of memory
allocated to Tomcat in megabytes.
4. Restart the appliance with the following command:
shutdown –r now
5. You can confirm that the memory value changed by issuing the following command and reviewing the
argument –Xmx.
ps –ef | grep catalina
To change the amount of Tomcat memory using the Java application
1. Quit the VMware HealthAnalyzer Collector Java application.
2. Go to the directory where the VMware HealthAnalyzer Collector Java application was unzipped.
3. Open the configuration file using a text or XML editor:
<unzipped location>/resources/[Link]
4. Locate the util:map XML section that contains memory settings by searching for vha-start.
Change the –Xmx value to the desired value. For example, to change the Tomcat memory to
1024 MB, change the XML as follows:
<util:map id="vha-start" map-class="[Link]">
<entry key="java" value="" />
<entry key="-Xmx1024m" value="" />
5. Save the file, and start the VMware HealthAnalyzer Collector Java application.

2.2.4 Changing Browser Proxy Settings

Proxy servers might be used as part of a corporate firewall. A proxy server acts as an intermediary
between a client computer and the internet by intercepting requests and contacting the target server to
make the request on behalf of the client. Proxies offer fast access to cached content, filter content, and
hide computers from the internet to improve security.
However, a proxy server will also prevent the VMware HealthAnalyzer Collector user interface from
accessing the appliance because it does not recognize that the appliance is running locally. If you are
running the VMware HealthAnalyzer Collector on a LAN that runs behind a proxy server, you probably
need to change the proxy settings before you can display the VMware HealthAnalyzer Collector user
interface. VMware recommends that you bypass the proxy by configuring your browser proxy settings to
add the VMware HealthAnalyzer Collector virtual appliance to the list of addresses that do not use a
proxy.
If there is no proxy server, ignore these procedures.
To change proxy settings for Firefox
1. Start your Firefox browser.
2. Click Tools > Options.
3. Click the Network tab.
4. Click Settings.
5. Select Manual proxy configuration if it is not already selected.

© 2016 VMware, Inc. All rights reserved.

Page 12 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide
6. In the No proxy for text box, type a comma delimiter followed by the appliance IP address.
7. Click OK in each dialog box until you have exited.
To change proxy settings for Internet Explorer
1. Start your Internet Explorer browser.
2. Click Tools > Internet Options.
3. Click the Connections tab.
4. Click LAN Settings.
5. Click Advanced.
6. In the text box labeled Do not use proxy server for addresses beginning with, type a semicolon
delimiter after any existing entries, followed by the appliance IP address.
7. Click OK in each dialog box until you have exited.

2.2.5 Displaying the VMware HealthAnalyzer Collector User Interface

All project setup and data collection is performed using the VMware HealthAnalyzer Collector user
interface. The first time you display the user interface you might be asked to agree to the EULA.
To display the VMware HealthAnalyzer Collector user interface using the VMware HealthAnalyzer
application
1. Start your browser.
2. Enter the URL as [Link]
If you cannot access the user interface, check the browser proxy settings and verify that there is no port
conflict with another application. Verify that both the application server and database server start. If you
have any trouble accessing the user interface, examine the files in the logs folder within the installation
folder to see if there are any port conflicts with another application.
To display the VMware HealthAnalyzer Collector user interface using the VMware HealthAnalyzer
virtual appliance
1. Start your browser.
2. Enter the URL as [Link] appliance IP address>.

[Link]. Port Settings

The VMware HealthAnalyzer Collector virtual appliance uses port 80 and 8080. It is not necessary to
specify the port number with the URL. Port conflicts are unlikely because all processes that run are
known in advance, but if you do not want to use default ports 80 or 8080, change the port numbers using
the one of the procedures given in the following sections.
For the user interface, it is not necessary to specify the port number with the URL. Port conflicts are
unlikely because all processes that run are known in advance. Follow this procedure if you need to
change the port used by the VMware HealthAnalyzer Collector application.

© 2016 VMware, Inc. All rights reserved.

Page 13 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide
To change the port used by the VMware HealthAnalyzer Collector application
1. Start the VMware HealthAnalyzer Collector Java application.
2. Click the disclosure triangle to the left of App Server or Database Server to reveal the port number.

3. Click Stop.
4. Enter the desired port values.
5. Click Save.
6. Click Start.
To change the port used by the VMware HealthAnalyzer Collector virtual appliance
1. Log in to the virtual appliance.
2. From the virtual appliance command-line interface, run the following command as root using your
own password.
sudo -s
3. Edit /usr/share/vha/tomcat/conf/[Link] and change the following:
Connector port="8080"
to
Connector port="x"

© 2016 VMware, Inc. All rights reserved.

Page 14 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide
where x is the new port number.
4. Save and close the file.
5. Reboot the virtual appliance.

2.2.6 Shutting Down VMware HealthAnalyzer Collector

When you are finished working with VMware HealthAnalyzer Collector, close the browser and perform a
graceful shutdown. The procedure for shutting down depends on whether you are using the VMware
HealthAnalyzer Collector application or the virtual appliance.

[Link]. Shutting Down the VMware HealthAnalyzer Collector Application

To shut down VMware HealthAnalyzer Collector, click Quit.

[Link]. Shutting Down the VMware HealthAnalyzer Collector Virtual Appliance

To shut down the VMware HealthAnalyzer Collector virtual appliance from the web console
1. Open the VMware HealthAnalyzer Collector virtual appliance web console.
2. Click the System tab (this is default).
3. Click Information (this is default).
4. Click Shutdown.
To shut down the VMware HealthAnalyzer Collector virtual appliance from the command line
1. Log in to the virtual appliance.
2. From the virtual appliance command-line interface, if you are not already running as the root user, run
the following command as root using your own password:
sudo -s
3. Type shutdown -h now and press Enter.

2.2.7 Uninstalling VMware HealthAnalyzer Collector

To uninstall VMware HealthAnalyzer Collector, remove the installation folder and all associated files.

© 2016 VMware, Inc. All rights reserved.

Page 15 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide

3. Working with VMware HealthAnalyzer Collector

VMware HealthAnalyzer Collector provides consistent, scalable data collection from vSphere, View, or
NSX environments.

3.1 Setting Up Access to vCenter Server, View Connection Server,

NSX Manager and NSX Controller
Although you could use the administrator account to access the target systems and collect data, it is a
best practice to restrict use of the administrator account. The preferred approach is to ask the
administrator to set up user accounts on the target vCenter Server and View Connection Server with
limited permissions sufficient to collect data.
Set up an account on vCenter Server
1. Set up an account with read-only privileges for all objects.
2. To collect iSCSI manager data, add Host > Configuration > Storage partition configuration
privileges.

© 2016 VMware, Inc. All rights reserved.

Page 16 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide
3. To collect storage policy data, add Profile-driven storage > Profile-driven storage view privileges.

4. If you are not able to change the Profile-driven storage view or Storage partition configuration
privileges, iSCSI and VM storage profile collection can be turned off by updating the following file in
VMware HealthAnalyzer Collector.
<VHA_Instance>/tomcat/tomcat/webapps/vha/WEB-INF/classes/[Link]
Set the following properties to f al se and then restart the VMware HealthAnalyzer Collector instance.
[Link]
[Link]

© 2016 VMware, Inc. All rights reserved.

Page 17 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide
Set up an account on the target View Connection Server
1. Log in to the View Connection Server administration user interface.
2. Select View Configuration > Administrators > Add User or Group to start the wizard.
3. Click Add.

4. In the Find User or Group dialog box, select a user to change and click OK.

© 2016 VMware, Inc. All rights reserved.

Page 18 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide
5. In the Add Administrator Or Permission wizard, select the administrator and click Next.

6. Verify that the Administrators (Read only) role is marked Yes and click Next.

© 2016 VMware, Inc. All rights reserved.

Page 19 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide
7. Select Root and click Finish.

8. Select the user or group added in earlier step and click Add Permission.
9. In the Add Permission dialog box, select Global Configuration and Policy Administrators (Read
only) role and click Finish.

© 2016 VMware, Inc. All rights reserved.

Page 20 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide
The selected user is shown with Administrators (Read only) and Global Configuration and Policy
Administrators (Read only) roles.

Set up an account on the target NSX Manger

1. Log in to the VMware vSphere Web Client user interface.
2. Select Networking & Security > NSX Managers > <NSX Manager>.
3. Select Manager > Users.
4. Click + to add new user.

© 2016 VMware, Inc. All rights reserved.

Page 21 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide
5. Select Specify a vCenter user and type in the vCenter user in the User field.

6. Click Next.

© 2016 VMware, Inc. All rights reserved.

Page 22 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide
7. Select NSX Administrator, and under Select Roles, click Finish.

Set up an account on the target NSX Controller

1. Use the default administrator account for the NSX Controller and make sure SSH port 22 is open on
the NSX Controller VM for data collection from VMware HealthAnalyzer Collector.

3.2 Using the Project Explorer

Use the Project Explorer to create and manage folders and projects.
The Project Explorer opens when you start VMware HealthAnalyzer Collector. Initially, the list of folders is
empty. From other VMware HealthAnalyzer Collector screens, click Project Explorer to return to the
Project Explorer. In the following figure, an existing folder (Company 1) is selected, and associated
information is displayed in the right pane.
Figure 3. Project Explorer

© 2016 VMware, Inc. All rights reserved.

Page 23 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide

3.2.1 Managing Folders

Folders are used to contain and organize projects. Each project must be created in a folder, and each
folder can contain one or more projects.

Note You must create a folder before you can create a new project.

To create a new folder

1. Click New Folder.

2. Enter a folder name and optionally a description.

3. Click OK.

© 2016 VMware, Inc. All rights reserved.

Page 24 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide
To edit the information for a folder
1. Click the name of a folder to select it.
2. Click Edit to open the Edit Folder dialog box.

3. Change the folder name or description, and click OK.

To delete a folder
Deleting a folder also deletes all projects within that folder and all data and reports associated with those
projects.
1. Click the name of a folder to select it.
2. Click Delete.
3. Click Yes to confirm the action.

3.2.2 Creating a New Project and Starting to Collect Data

Create a project to begin the process of collecting data.
The procedure differs according to whether you are collecting data from vSphere or View.
 vSphere – The initial discovery phase identifies the data centers and clusters that are available for
data collection. You are given the option of filtering out any data centers or clusters that you do not
want to include. The collection phase then collects data for the selected items.
 View – You first identify and collect information from a View Connection Server, and then identify one
or more vCenter Server instances from which to collect detailed data.

© 2016 VMware, Inc. All rights reserved.

Page 25 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide
To create a new project for vSphere data collection and start collecting data
1. Click the VMware HealthAnalyzer Collector folder where you want to create a new project.
2. Click New Project to create a new project within the folder. The Create Project dialog box appears.

3. Select vSphere (5.x) or vSphere (6.x) as the project type. This selection determines the best
practices catalog that will be used.
 For vSphere 5.x, Service Kit R1.2 is used.
 For vSphere 6.x, Service Kit 2.0.1 is used.

© 2016 VMware, Inc. All rights reserved.

Page 26 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide
4. Type a project name for the new project, and optionally a description and customer name.
5. Click OK.
The VMware vCenter Info tab of the project panel appears. This is where you supply information for
the vCenter Server that will be the source for data collection. For vSphere 4.x, specify the vCenter
Server host name or IP address, the user name of the read-only user account you created earlier,
and the password. For more information, see Section 3.1, Setting Up Access to vCenter Server, View
Connection Server, NSX Manager and NSX Controller.

For vSphere 5.x, also specify the single sign-on (SSO) server.

6. Type the host name or IP address of the vCenter Server.

Note If you use a host name, first confirm that it can be pinged from the network. If you cannot access
the server using a DNS name, use an IP address. If the target server is configured to use HTTP,
you must explicitly add an HTTP prefix (for example, [Link]

© 2016 VMware, Inc. All rights reserved.

Page 27 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide
7. Type the login credentials for the vCenter Server in the User and Password fields. You can include a
domain name in the User field by using the domain\user format.
8. Click Next.
VMware HealthAnalyzer Collector now collects data from the specified vCenter Server. During data
collection, VMware HealthAnalyzer Collector reports its progress with messages such as the
following:
 Initiating connection
 Collecting VM inventory
 Collecting vCenter references
 Collecting connection server references
 Collecting datastore inventory
 Collecting pool inventory
 Collecting desktop inventory

9. If the data collection process takes a long time without updating the progress information, and you
believe there is a problem, try to cancel the collection from the UI. Look for any collection-related
errors in the logs/[Link] file in the unzipped installation folder.
10. When data collection is complete, the VMware vCenter Discovery tab appears. The tab lists the
vCenter Server with the data centers and clusters that were discovered during data collection. Click
the arrow to expand the list. If there are any data centers or clusters that you do not want to include in
your analysis, deselect them.

© 2016 VMware, Inc. All rights reserved.

Page 28 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide
A note on the page indicates that VMware HealthAnalyzer might require additional memory when
collecting from a large environment. Click the i icon to display additional information about memory
configuration.

11. Click Next to start collecting data from all of the specified systems. During data collection, VMware
HealthAnalyzer reports its progress with messages such as the following:
 Initiating connection
 Collecting inventory for Datacenter[…]
 Collecting HostSystem[…]
 Collecting VirtualMachine[…]
 Collecting Folder[…]
 Collecting ResourcePool[…]
 Collecting Datastore[…]
 Collecting DistributedVirtualPortGroup[…]
 Processing collected data
 Dataset processed successfully
12. If the data collection process takes a long time without updating the progress information, and you
believe there is a problem, try to cancel the collection from the UI. Look for any collection-related
errors in the logs/[Link] file in the unzipped installation folder.

© 2016 VMware, Inc. All rights reserved.

Page 29 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide
To create a new project for View data collection and start collecting data
1. Click the VMware HealthAnalyzer folder where you want to create a new project.
2. Click New Project to create a new project within the folder. The Create Project dialog box appears.

3. Select View (5.x/6.x/7.x) - Service Kit R3.0 as the project type.

4. Type a project name for the new project, and optionally a description and customer name.

© 2016 VMware, Inc. All rights reserved.

Page 30 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide
5. Click OK.
The Horizon View Info tab of the project panel appears. This is where you supply the information for
the View Connection Server.

6. Type the host name or IP address of the View Connection Server.

Note If you use a host name, first confirm that it can be pinged from the network. If you cannot access
the server using a DNS name, use an IP address. If the target server is configured to use HTTP,
you must explicitly prefix target server with the HTTP (for example, [Link]

7. Type the login credentials for the View Connection Server in the User and Password fields. You can
include a domain name in the User field by using the domain\user format.
8. Click Next.
VMware HealthAnalyzer now collects data from the specified View Connection Server. During data
collection, VMware HealthAnalyzer reports its progress with messages such as the following:
 Initiating connection
 Collecting VM inventory
 Collecting vCenter references
 Collecting connection server references
 Collecting datastore inventory
 Collecting pool inventory
 Collecting desktop inventory

© 2016 VMware, Inc. All rights reserved.

Page 31 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide
9. The VMware vCenter Info tab appears. Supply information about one or more vCenter Server
instances and specify the SSO server.

10. Type the host name or IP address of a vCenter Server.

If the target server is not configured to use the default HTTPS port 443, you must also specify the port
(for example, [Link]:8089 or [Link] If you use a host name, first
confirm that it can be pinged from the network. If you cannot access the server using a DNS name,
use an IP address.
11. (Optional) To add an additional vCenter Server, click Add vCenter.
If View infrastructure machines, such as View Connection Servers, View security servers, View
transfer servers, View Composer servers, and vCenter Server instances hosting View desktops are
virtual machines, enter all vCenter Server systems that host these virtual machines. If all vCenter
Server systems are not included, manual analysis must be performed for several best practices that
rely on this data.
12. After supplying information for all vCenter Server instances, click Next to start collecting data from all
of the specified systems. During data collection, VMware HealthAnalyzer reports its progress with
messages such as the following:
 Initiating connection
 Collecting inventory for Datacenter[…]
 Collecting HostSystem[…]
 Collecting VirtualMachine[…]
 Collecting Folder[…]
 Collecting ResourcePool[…]
 Collecting Datastore[…]
 Collecting DistributedVirtualPortGroup[…]
 Processing collected data
 Dataset processed successfully

© 2016 VMware, Inc. All rights reserved.

Page 32 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide
13. If the data collection process takes a long time without updating the progress information, and you
believe there is a problem, try to cancel the collection from the UI. Look for any collection-related
errors in the logs/[Link] file in the unzipped installation folder.
To create a new project for NSX data collection and start collecting data
1. Click the VMware HealthAnalyzer folder where you want to create a new project.
2. Click New Project to create a new project within the folder. The Create Project dialog box appears.

3. Select NSX (6.x) - Service Kit R1.0 – Tech Preview as the project type.
4. Type a project name for the new project, and optionally a description and customer name.
5. Click OK. Accept the Tech Preview disclaimer by clicking OK to continue.

© 2016 VMware, Inc. All rights reserved.

Page 33 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide
The NSX Manager Info tab of the project panel appears. This is where you supply the information for
the NSX Manager. For Cross-vCenter setup, additional NSX Manager instances could be added by
clicking on Add NSX Manager.

6. Type the host name or IP address of the NSX Manager.

Note If you use a host name, first confirm that it can be pinged from the network. If you cannot access
the server using a DNS name, use an IP address.

7. Type the login credentials for the NSX Manager in the User and Password fields. You can include a
domain name in the User field by using the domain\user format.
8. Click Next.
VMware HealthAnalyzer now collects data from the specified NSX Manager. During data collection,
VMware HealthAnalyzer reports its progress with messages such as the following:
 Initiating connection
 Collecting NSX Manager vCenter Info
 Collecting NSX Edge list info
 Collecting NSX Cluster List info
 Collecting High Availability configuration for Edge […]
 Collecting NSX Host List for cluster […]
 Collecting Storage information for NSX Edge VM […]
 Collecting NSX Manager Communication Channel Health
 Collecting Health Status for ESX Host […]
 Collecting NSX VM list for ESX Host […]

© 2016 VMware, Inc. All rights reserved.

Page 34 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide
9. The NSX Controller Info tab appears. Supply password information about one or more NSX
Controller instances as setup with NSX Manager.

10. After supplying information for all NSX Controller instances, click Next to start collecting data from all
of the specified systems. During data collection, VMware HealthAnalyzer reports its progress with
messages such as the following:
 Initiating connection
 Collecting VTEP Table information for VNI […]
 Collecting Control Cluster configuration information for VNI Id […]
 Collecting Host Connection Table information for VNI […]
 Dataset processed successfully

© 2016 VMware, Inc. All rights reserved.

Page 35 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide

3.2.3 Managing Projects

This section describes the project actions that are available in the Project Explorer.
To open a project to view best practice data, assign grades, or create a report
Click the name of the project and click Open. The project summary and inventory details are displayed.

To edit the information for a project

1. Click the name of a project to select it.
2. Click Edit to open the Edit Project dialog box.

3. Make the needed changes and click OK.

© 2016 VMware, Inc. All rights reserved.

Page 36 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide
To display vSphere project filters applied when the project was set up
1. Click the name of a project to select it.
2. Click Show Filter to open the Collection Filter dialog box.

3. Click OK.
To delete a project
Deleting a project deletes all data and the report associated with that project.
1. Click the name of a project to select it.
2. Click Delete.
3. Click Yes to confirm the action.

3.3 Exporting Projects and Log Files <<export only>>

3.3.1 Exporting Projects
You can export a project from VMware HealthAnalyzer Collector for analysis by VMware or a VMware
partner.
To export a project
When you export a project, the project is stored in a binary file. This file can be copied to another
computer, for example, to review after you leave the site.
1. In the Project Explorer, click the name of the project you want to export.
2. Click Export and follow the prompts to save the project to your disk.

Note The exact procedure for saving a file differs depending on which browser you use to access
VMware HealthAnalyzer Collector.

3.3.2 Exporting Log Files

You can export log files to help in diagnosing any issues that arise in your use of VMware HealthAnalyzer
Collector.
To generate the Health Check Report
1. Click Admin in the upper right area of the VMware HealthAnalyzer Collector interface.

© 2016 VMware, Inc. All rights reserved.

Page 37 of 38
 VMware HealthAnalyzer Collector
Installation and User Guide
2. Select Log Files.

3. Click Save File to save the [Link] file to your computer.

© 2016 VMware, Inc. All rights reserved.

Page 38 of 38