Vcenter Hyperic 58 Installation and Configuration Guide
Vcenter Hyperic 58 Installation and Configuration Guide
Vcenter Hyperic 58 Installation and Configuration Guide
Configuration Guide
vCenter Hyperic 5.8
EN-001318-05
You can find the most up-to-date technical documentation on the VMware Web site at:
http://www.vmware.com/support/
The VMware Web site also provides the latest product updates.
If you have comments about this documentation, submit your feedback to:
docfeedback@vmware.com
Copyright 2014 VMware, Inc. All rights reserved. Copyright and trademark information.
VMware, Inc.
3401 Hillview Ave.
Palo Alto, CA 94304
www.vmware.com
VMware, Inc.
Contents
45
Index
VMware, Inc.
51
55
57
VMware, Inc.
The vCenter Hyperic Installation and Configuration Guide provides procedures for installing
vCenter Hyperic components, including setting up the vCenter Hyperic database and installing the
vCenter Hyperic server and vCenter Hyperic agents.
Intended Audience
This information is intended intended for operations personnel who set up and support the
vCenter Hyperic infrastructure.
VMware, Inc.
VMware, Inc.
These tables describe the supported operating systems for vCenter Hyperic server and vCenter Hyperic
agent installations.
It is good practice that host operating systems employ a NTP time synchronization between the
vCenter Hyperic server and vCenter Hyperic agent. If you do not use NTP, metrics are displayed according
to the server time. To correlate data on the server with an agent that is not synchronized, you must calculate
the time difference.
The supported operating system tables indicate whether the supported configuration is for production or
development. Production support means you can run your production application on the platform.
The developer support designation indicates those products that are "known to work" and for which
VMware will provide best-effort support to resolving reported issues. Developer Support certifications are
not supported for use in production.
Processor
Architecture
Production/Deve
loper Support
Scaling
Considerations
x86_64
Oracle
Java SE 6
Production
x86_64
Oracle
Java SE 6
Production
x86_64
Oracle
Java SE 6
Production
x86_64
Oracle
Java SE 6
Production
x86_64
Oracle
Java SE 6
Production
JVM
On Unix-like platforms, the vCenter Hyperic server requires the libXp.so.6 X library to create charts and
other graphics in the vCenter Hyperic user interface. The location of this library varies according to version
and provider.
VMware, Inc.
Provider
Comment
Enterprise Linux
Debian
Fedora Core 5
From Fedora Core 5, the libXp.so library has been separated to its own package. Install the libXp
RPM.
Other distributions
The required libraries can be found in either the XFree86-libs or the xorg-x11-libs package.
Processor
Architecture
x86_64, x86_32
Oracle Java SE
6
x86_64, x86_32
Oracle Java SE
6
x86_64
Oracle Java SE
6
x86_64, x86_32
Oracle Java SE
6
x86_64, x86_32
Oracle Java SE
6
x86_64, x86_32
Oracle Java SE
6
x86_64, x86_32
Oracle Java SE
6
PA-Risc
Oracle Java SE
6
JVM
Considerations
IBM Java SE 6
x86_64, x86_32
Oracle Java SE
6
vCenter Hyperic supports only one vCenter Hyperic server on a host. The host must have a static IP
address for server communications.
To manage more than 100 platforms, you must run the vCenter Hyperic database on a dedicated host,
not that on which the vCenter Hyperic server runs.
"Large" is 500 to 2,000 managed platforms, or greater than 30,000 managed resources.
VMware, Inc.
Processor
Memory
Medium: 8GB
Large: 12GB
Medium: 6GB
Large: 16GB
20GB
Medium: 50GB
Large: 500GB
Supported Browsers
Hyperic supports the following browsers. Firefox is recommended.
The Skype plugin for Firefox causes unexpected behavior in the Hyperic user interface. Disable the plugin to
work around this problem.
Table 14. Supported Browsers
Browser
Version
Firefox
11, 12
Internet Safari
7, 8, 9
Safari
5.0, 5.1
Chrome
21
VMware, Inc.
10
VMware, Inc.
VMware, Inc.
A virtual appliance (vApp) is one or more virtual machine image files (.ovf),
each with a preconfigured operating system environment and application.
The vCenter Hyperic vApp contains two virtual machine images, one for the
vCenter Hyperic server and one for the vCenter Hyperic database.
Deploying the vCenter Hyperic vApp provides a simplified deployment in
which the components are already configured to work, and to work with
each other.
11
The vCenter Hyperic installer is script-based. You can do a quick install that
sets up defaults for most vCenter Hyperic server configuration options, or
run it in full mode to respond to the configuration dialog yourself. You can
also use this installer to install the vCenter Hyperic agent.
RHEL RPMs
RPMs are available. The vCenter Hyperic server RPM is the standard
vCenter Hyperic installer, wrapped in an Expect script.
On the Download VMware vCenter Hyperic 5.8 page, select the product to download and click View
Download.
Select the installer package file to download and click Download Manager.
Log in to My VMware.
(Optional) Click the Download Manager link to open the Download Manger utility.
The Download Manger allows you to pause and resume downloads of large file sets, as long as the
utility remains running.
12
(Optional) Click Download Now and run or save the installer file.
VMware, Inc.
Embedded JRE
On Windows platforms, the vCenter Hyperic agent installer is available with or without a JRE.
You must configure the JRE location with the HQ_JAVA_HOME system variable if you do a platformindependent agent install on Windows, or a platform-specific install on a Windows machine that already
has a JRE that you prefer to use.
On Windows platforms, the vCenter Hyperic agent resolves the JRE to use in the following order:
1
Embedded JRE
You define a system variable from My Computer > Properties > Advanced > Environment Variables >
System Variables > New.
VMware, Inc.
13
Procedure
1
Install PostgreSQL
You install PostgreSQL on RHEL 5.
You must be logged in as root to perform the installation.
If database initialization fails, look for error messages in /var/lib/pgsql/9.1/pgstartup.log.
Procedure
1
Run yum install postgresql91-server postgresql91-contrib to install the PostgreSQL server and
contrib modules.
What to do next
Define data and log locations. See Define Data and Log Locations, on page 14.
14
VMware, Inc.
Procedure
1
Run Export $PGDATA PathToPreferredDisk/data to set the $PGDATA environment variable to point to
the required location.
Run mv /var/lib/psql/9.1/data PathToPreferredDisk to move the data files to the new location.
What to do next
Define the PostgreSQL environment variables. See Define PostgreSQL Environment Variables, on
page 15
Define Data and Log Locations when the I/O Device is Saturated
Depending on your environment, you might select a location other than the default for data files. For
example, you might choose to store data files on a volume with plenty of space for housekeeping operations.
In the event that your I/O device is saturated, the procedure that you use differs from the usual process.
If you do not have an I/O device that is saturated, use the process described in Define Data and Log
Locations, on page 14.
Procedure
1
What to do next
Define the PostgreSQL environment variables. See Define PostgreSQL Environment Variables, on
page 15
What to do next
Configure the PostgreSQL properties. See Configure PostgreSQL Properties, on page 15.
Under the listen_addresses property, enable database connections on all interfaces on the platform.
listen_addresses = '*'
VMware, Inc.
15
Under the max_connections property, set the maximum number of connections based on the sizing
profile that corresponds to the scale of your environment. Use the following values.
Value
Description
Small
Medium
500
Large
Under the shared_buffers and effective_cache_size property, assuming the database runs on a
dedicated platform, set shared_buffers to 70-80% of memory, and effective_cache_size to 10-20%,
leaving some memory available for the operating system.
For example, given 12GB of memory, shared_buffers = 8GB and effective_cache_size = 2GB.
Under the checkpoint_segments property, verify that the value on the sizing profile corresponds to the
scale of your environment. Use the following values.
Value
Description
checkpoint_segments = 3 (default)
Small
checkpoint_segments = 3 (default)
Medium
checkpoint_segments = 32
(default)
Large
What to do next
Configure the PostgreSQL client authentication properties. See Configure PostgreSQL Client
Authentication, on page 16.
In the pg_hba.conf file, locate the line # TYPE DATABASE USER ADDRESS METHOD.
Immediately below the located line, add host all all 0.0.0.0/0 password, aligning these values
under the parameter names in the row above.
# TYPE DATABASE
host
all
USER ADDRESS
all 0.0.0.0/0
METHOD
password
You can use the address parameter to limit access to just the vCenter Hyperic server or any clients that
need to query the database.
What to do next
Create a vCenter Hyperic database user and database. See Create a vCenter Hyperic Database User and
Database, on page 17.
16
VMware, Inc.
Change the user to postgres and run # psql to connect to the database locally.
Run CREATE USER hqadmin WITH ENCRYPTED PASSWORD 'hqadmin' to create a user named hqadmin with
login and createdb privileges.
The ENCRYPTED keyword is optional.
Run CREATE DATABASE "HQ" OWNER hqadmin ENCODING 'UTF8' to create a default database for
vCenter Hyperic.
Placing quote marks around the HQ string makes the database name uppercase.
What to do next
Install the vCenter Hyperic server. See Installing and Configuring the vCenter Hyperic Server, on
page 17.
(Optional) Troubleshoot connection issues using the command telnet <dbserver hostname> 5432 from
the vCenter Hyperic server host.
(Optional) If network connections to the database fail, troubleshoot the issue in PostgreSQL log files
This is useful for watching log files, or any other file that might be appended over time. Failed
connection messages are written to the following files:
/var/lib/pgsql/data/pg_log/postgresql-day.log
/var/lib/pgsql/pgstartup.log
(Optional) If thevCenter Hyperic server fails to connect to the PostgreSQL database, determine if there
is a firewall issue by turning off the firewall on RHEL or CentOS and running
the /etc/init.d/iptables stop command as root.
VMware, Inc.
17
Configure the vCenter Hyperic Server Properties File After Installation on page 28
If you did not configure the vCenter Hyperic server properties before running the RPM server
installer, you are prompted to do so after installation. You cannot use the server until the properties
have been specified.
To assign fixed IP addresses to the vCenter Hyperic server and vCenter Hyperic database, which is the
recommended best practice, have the list of IP addresses available when running the deployment
wizard.
If you are using an external PostgreSQL database, you must set it up before installing vCenter Hyperic
server.
To configure the vCenter Hyperic server to use a keystore that you manage yourself for SSL
communication, rather than Hyperic-generated keystores, set up a JKS format keystore for the
vCenter Hyperic server on its host and import the SSL certificate for it. Make a note of the full path to
the keystore, and its password. You will supply this information when you run the Hyperic installer (in
-full mode).
The vCenter Hyperic server's keystore password and private key password must be the same,
otherwise the vCenter Hyperic server's internal Tomcat-based server will be unable to start.
Verify that the vCenter Hyperic database is available. During installation, the vCenter Hyperic server
tests the database connection.
Procedure
1
18
VMware, Inc.
Proceed through the pages of the wizard, entering appropriate values. This table lists additional
information to assist you to choose specific options.
Page
Change
Source
Enter the URL from which to download the Hyperic OVF file, or a disk
location accessible from your computer
(Optional) Edit the name and select the folder location within the
inventory where the vApp will reside.
Host/Cluster
Disk Format
Select one of the following disk formats to store the virtual machine virtual
disks.
n Thick Provision Lazy Zeroed Creates a virtual disk in a default thick
format. The space required for the virtual disk is allocated when the
virtual disk is created. Data remaining on the physical device is not
erased during creation, but is zeroed out on demand at a later time on
first write from the virtual machine. Using the default flat virtual disk
format does not zero out or eliminate the possibility of recovering
deleted files or restoring old data that might be present on this
allocated space. You cannot convert a flat disk to a thin disk.
n Thick Provision Eager Zeroed A type of thick virtual disk that
supports clustering features such as Fault Tolerance. Space required
for the virtual disk is allocated at creation time. In contrast to the flat
format, the data remaining on the physical device is zeroed out when
the virtual disk is created. It might take much longer to create disks in
this format than to create other types of disks.
n Thin Provision Use this format to save storage space. For the thin
disk, you provision as much datastore space as the disk would require
based on the value that you enter for the disk size. However, the thin
disk starts small and at first, uses only as much datastore space as the
disk needs for its initial operations. f the thin disk needs more space
later, it can grow to its maximum capacity and occupy the entire
datastore space provisioned to it. Also, you can manually convert the
thin disk into a thick disk.
Network Mapping
IP Address Allocation
Review the values that you have specified in the Ready to Complete page and optionally select Power
on after deploymentto start the server when the deployment process completes.
Click Finish.
What to do next
1
Install the vCenter Hyperic license. See Activating and Configuring Your vCenter Hyperic License,
on page 43.
Log in to the vCenter Hyperic vApp. See Log in to the vCenter Hyperic vApp, on page 20.
VMware, Inc.
19
Enter the password that you specified during deployment of the vCenter Hyperic server Administrator
account.
What to do next
Start, stop or restart the vCenter Hyperic server.
Verify that you are connected to the vCenter Hyperic server virtual machine using SSH and that the
server is stopped.
Procedure
1
On the Hardware tab of the database Virtual Machine Properties dialog box, edit the Provisioned Size
setting to increase the hard disk size, and click OK.
n
(Optional) If you are unable to perform step 1 because the setting cannot be edited, complete all the
other steps in this procedure.
a
Using SSH, connect to the ESX server on which the database virtual machine is installed.
20
Edit the virtual machine settings to increase the hard disk size.
n
VMware, Inc.
Comment
fdisk /dev/sda
To delete a partition.
Press Enter twice to define the first and last sector of the partition.
Comment
reboot
Comment
resize2fs /dev/sda3
df -h
Using SSH, connect to the vCenter Hyperic server and start the server.
VMware, Inc.
21
Qualifier
-
Run the setup script without a qualifier to perform a quick installation. Selected components will be
installed with default values for most configuration options. If you install the vCenter Hyperic server, it
will be configured to use its built-in vPostgreSQL database. A quick installation is useful if you are
evaluating vCenter Hyperic.
With a quick installation, by running the installer without a qualifier or with the -postgresqlqualifier,
the installer does not prompt you for the ports on which the vCenter Hyperic server listens for agent
and user interface requests. The default ports are automatically configured.
With a quick installation, you cannot specify the location and password for a user-managed server
keystore. The vCenter Hyperic server uses a vCenter Hyperic-managed keystore.
-full
In full mode, the installer dialog prompts for all setup configuration options. Use this option if you are
using an external database, or to configure the vCenter Hyperic server to use an SSL keystore that you
manage yourself, rather than using a vCenter Hyperic-generated keystore.
For best security and best configurability, run the installer in full mode.
-upgrade
Use upgrade mode to upgrade a 5.x vCenter Hyperic server to a later version. If you have an existing
vCenter Hyperic server installation, the server configuration and the contents of the existing
vCenter Hyperic database are preserved.
-updateScale
Use the updateScale option to change the sizing profile for the vCenter Hyperic server.
If you are using an external PostgreSQL database, you must set it up before installing vCenter Hyperic
server.
To configure the vCenter Hyperic server to use a keystore that you manage yourself for SSL
communication, rather than Hyperic-generated keystores, set up a JKS format keystore for the
vCenter Hyperic server on its host and import the SSL certificate for it. Make a note of the full path to
the keystore, and its password. You will supply this information when you run the Hyperic installer (in
-full mode).
The vCenter Hyperic server's keystore password and private key password must be the same,
otherwise the vCenter Hyperic server's internal Tomcat-based server will be unable to start.
Verify that the vCenter Hyperic database is available. During installation, the vCenter Hyperic server
tests the database connection.
Procedure
1
22
VMware, Inc.
UNIX-like OS
Windows OS
Open a command shell where mode is one of the values in the table.
Operating System
UNIX-like OS
PathToInstaller/setup.sh -full
Windows OS
PathToInstaller\setup.bat -full
Prompt
Comment
The account that you are running under must have write access the
directory location.
This value is used in alert notification emails. The value can be changed on
the Administration page in the vCenter Hyperic portal.
If the installer does not find a local SMTP server, and you do not specify
one, Hyperic cannot send alert notifications
If you accept the default, the installer will generate a key for encrypting the
database password. Type 2 to supply the string yourself and, when
prompted, type a string of at least 8 characters.
Type 1 to preserve your existing vCenter Hyperic data. You also need to
migrate your server and database to the new version.
Type 2 to erase all of the data in your vCenter Hyperic database.
The installer indicates that the installation was successful.The URL for the vCenter Hyperic portal and the
default username and password appear.
VMware, Inc.
23
What to do next
n
Integrate vCenter Hyperic with your existing enterprise directory. The vCenter Hyperic server does not
include a strength-of-password policy, or a lockout policy for failed login attempts.
Verify that any exisitng vCenter Hyperic Windows service is removed. See Remove an Existing
vCenter Hyperic Windows Service, on page 25.
If you are using an external PostgreSQL database, you must set it up before installing vCenter Hyperic
server.
To configure the vCenter Hyperic server to use a keystore that you manage yourself for SSL
communication, rather than Hyperic-generated keystores, set up a JKS format keystore for the
vCenter Hyperic server on its host and import the SSL certificate for it. Make a note of the full path to
the keystore, and its password. You will supply this information when you run the Hyperic installer (in
-full mode).
The vCenter Hyperic server's keystore password and private key password must be the same,
otherwise the vCenter Hyperic server's internal Tomcat-based server will be unable to start.
Verify that the vCenter Hyperic database is available. During installation, the vCenter Hyperic server
tests the database connection.
Procedure
1
What to do next
1
24
VMware, Inc.
Remove the Windows service for the previous instance by running hq-server.bat remove.
Configure the vCenter Hyperic Server Properties File Before RPM Server
Installation
It is good practice to configure the vCenter Hypericserver properties before you install the server using the
RedHat Package Manage package.
The directory and file name in this procedure must be exactly as specified for the RPM installer to work
correctly.
The vCenter Hyperic server installation settings are listed in vCenter Hyperic Server Properties for RPM
Installation, on page 26.
Procedure
1
Running as root, or using sudo, run mkdir -p etc/vmware/vcenter/hyperic to create a directory for the
properties file.
What to do next
Install the vCenter Hyperic server RPM. See, Install the vCenter Hyperic Server RPM, on page 25.
VMware, Inc.
The database has been configured. See Set up the vCenter Hyperic Database, on page 13.
25
SSL has been configured. See Configuring SSL Options, on page 38.
Verify that your SMTP server is listening on port 25 on the vCenter Hyperic server host.
Procedure
1
On the platform on which the vCenter Hyperic server is being installed, run yum install vfabric-
hyperic-server.
(Optional) If this is the first time that you have installed a vCenter Hyperic component on the virtual
machine, accept the end user license agreement when prompted.
What to do next
1
If you are prompted to do so, configure the vCenter Hyperic server properties. See Configure the
vCenter Hyperic Server Properties File After Installation, on page 28.
26
VMware, Inc.
# password for the initial admin user HQ_ADMIN_PASSWORD=hqadmin Password must contain at least
six characters.
# email address be for the initial admin user
HQ_ADMIN_EMAIL_ADDRESS=hqadmin@eng.vmware.com
# End of configuration for local built-in Postgresql database
################################################################################
VMware, Inc.
27
What to do next
Start the vCenter Hyperic server.
28
VMware, Inc.
Log in to the management console using the URL https://host:5480, where host is the IP address or DNS
name of the vCenter Hyperic vApp host.
You must log on as root and supply the password that was defined for the vCenter Hyperic admin
account. The default is hqadmin.
On the vCenter Hyperic vApp management console, select the System tab and click Time Zone.
On the vCenter Hyperic vApp management console, select the Network tab and click Status.
Details of the network status and network interfaces appear.
VMware, Inc.
29
Procedure
1
On the vCenter Hyperic vApp management console, select the Network tab and click Address.
Use the dropdown menus to select the required network address settings and click Save Settings.
You can click Cancel Changes to retain your existing settings.
On the vCenter Hyperic vApp management console, select the Network tab and click Proxy.
On the vCenter Hyperic vApp management console, select the System tab and click Information.
30
VMware, Inc.
(Optional) Configure the vCenter Hyperic Agent Using the Configuration Dialog on page 37
The agent configuration dialog appears in the shell when you launch a vCenter Hyperic agent that
lacks the configuration values that specify the location of the vCenter Hyperic server. The dialog
queries for the address and port of the vCenter Hyperic server, and other connection-related data.
To configure the vCenter Hyperic agent to use a keystore that you manage yourself for SSL
communication, rather than a vCenter Hyperic-generated keystore, set up a JKS-format keystore for the
vCenter Hyperic agent on its host and import its SSL certificate. Make a note of the full path to the
keystore, and its password. You configure this data in the agent's agent.properties file.
Verify that the agent keystore password and the private key password are identical.
VMware, Inc.
31
32
Creates the user and group named hyperic if they do not exist.
Adds the init script to chkconfig and sets it to on for run levels 2, 3, 4, and 5.
VMware, Inc.
Prerequisites
n
Verify that you have satisfied all the prerequisites listed in Prepare to Install the vCenter Hyperic
Agent, on page 31.
Procedure
1
Run yum install vfabric-hyperic-agent to install the agent on the platform that the agent will
monitor.
Log on as root and edit the /etc/init.d/hyperic-hqee-agent file to set the HQ_JAVA_HOME parameter to
the home directory of the JDK or JRE that the agent is to use.
What to do next
Configure the vCenter Hyperic agent in the properties file. See Activate Agent to Server Communication
Properties, on page 34.
When the agent must use an SSL keystore that you manage, rather than a vCenter Hyperic-generated
keystore.
When the agent must connect to the vCenter Hyperic server via a proxy server.
If you are deploying multiple agents, consider configuring the agent in its properties file, to streamline the
process.
Prerequisites
The vCenter Hyperic server must be running.
What to do next
Start the vCenter Hyperic agent.
HqUserHome/.hq
If this directory exists and contains agent.properties, the vCenter Hyperic agent uses the property
values defined there.
2
AgentHome/conf
VMware, Inc.
33
If the agent does not find the the required properties for establishing communications with the
vCenter Hyperic server in either of these locations, it prompts for the property values at initial start up of
the agent.
It is good practice to configure the properties in the agent.properties file before initial start up of the agent.
This is a requirement for some communication actions, and is the most efficient process when you are
deploying multiple agents.
Procedure
u
Activate the following properties by removing the hash tag at the beginning of each line.
#agent.setup.camIP=localhost
#agent.setup.camPort=7080 #agent.setup.camSSLPort=7443
#agent.setup.camSecure=yes #agent.setup.camLogin=hqadmin
#agent.setup.camPword=hqadmin #agent.setup.agentIP=*default*
#agent.setup.agentPort=*default*
#agent.setup.resetupTokens=no
The first time that you start the vCenter Hyperic agent, if agent.setup.camPword is inactive, and has a
plain text value, the agent encrypts the value.
34
Specify the location and credentials the vCenter Hyperic agent must use to contact the vCenter Hyperic
server.
Property
Property Definition
agent.setup.camIP
agent.setup.camPort
The default value is the standard plain text vCenter Hyperic server listen
port. If your server is configured for a different listen port, specify the port
number.
VMware, Inc.
Property
Property Definition
agent.setup.camSSLPort
The default value is the standard SSL vCenter Hyperic server listen port. If
your server is configured for a different listen port, specify the port
number.
agent.setup.camSecure
agent.setup.camLogin
Specify the user name for the agent to use when connecting to the server. If
you change the value from the hqadmin default value, verify that the user
account is correctly configured on the vCenter Hyperic server.
agent.setup.camPword
Specify the password for the agent to use, together with the user name
specified in agent.setup.camLogin, when connecting to the server.
Verify that the password is the one configured in vCenter Hyperic for the
user account.
(Optional) Specify the address or hostname and the listen port for the vCenter Hyperic server to use to
contact the vCenter Hyperic agent.
If you are creating a standard agent.properties file that can be used for all agents, deactivate these
properties, but do not change their values.
Property
Property Definition
agent.setup.agentIP
If you leave the default setting * default* the agent detects an IP address
on the platform and selects it as the listen address.
agent.setup.agentPort
If you leave the default setting * default* the agent uses the default
listen port (2144) as its listen address. If that port is unavailable, the agent
detects a free port and selects it as its listen port.
In the user interface, on the Inventory tab of the platform, navigate to Type & Network Properties and
click Edit.
The Agent Connection menu shows the currently selected port for bidirectional communications. For
example, 10.2.0.213:2144, where 10.2.0.213 is the IP address of the platform, and 2144 is the
bidirectional port number previously used.
Expand the menu and select the entry that shows the same IP address, and -1 as the port number.
For example, 10.2.0.213:-1.
VMware, Inc.
35
In the user interface, on the Inventory tab of the platform, navigate to Type & Network Properties and
click Edit.
The Agent Connection menu shows the currently selected port for unidirectional communications. For
example, 10.2.0.213:-1, where 10.2.0.213 is the IP address of the platform, and -1 is the
unidirectional port number previously used.
Expand the menu and select the entry that shows the same IP address, and 2144 as the port number.
For example, 10.2.0.213:2144.
If you configured a port number other than the default, select the entry with that port number.
agent.keystore.password.
36
(Optional) If you configured the agent for unidirectional communication, add [agent.keystore.alias
to the properties file, and set it to the alias of the primary certificate or private key entry of the
keystore's primary certificate.
VMware, Inc.
(Optional) Configure the vCenter Hyperic Agent Using the Configuration Dialog
The agent configuration dialog appears in the shell when you launch a vCenter Hyperic agent that lacks the
configuration values that specify the location of the vCenter Hyperic server. The dialog queries for the
address and port of the vCenter Hyperic server, and other connection-related data.
The agent configuration dialog appears in these cases:
n
The first time you start an agent, if you have not supplied the properties in agent.profile.
When you start an agent for which saved server connection data is corrupt or has been removed.
When you run the agent launcher with the setup option, which causes the agent to prompt for new
connection property settings.
You can also run the agent launcher to re-run the configuration dialog.
Procedure
1
Platform
Command
UNIX-like
sh hq-agent.sh start
Windows
Install the Windows service for the agent, then start it:sh hq-agent.bat
install sh hq-agent.bat start
Respond to the prompts, noting the following as you move through the process.
Prompt
Description
The server must be running. If the server is on the same machine as the
agent, you can type localhost. If there is a firewall blocking traffic from
the agent to the server, specify the address of the firewall.
Accept the default to configure vCenter Hyperic to use SSL for agent-toserver communication. It is good security practice to configure SSL, and is
required if you configured unidirectional communications. To configure
vCenter Hyperic to use plain HTTP for agent-to-server communication,
type no.
The prompt shows the first IP address that the agent detects on the host.
You can specify another IP address on the host. If a firewall is blocking
traffic from the server to the agent, type the IP address of the firewall, and
configure the firewall to forward traffic intended for the vCenter Hyperic
agent to the listen address of the agent host.
Specify the agent port for the vCenter Hyperic server to use when it
initiates contact with the agent. Specify the port that the agent binds to at
startup, which by default is 2144. If you have previously edited
agent.properties to define a different listen port, using the
agent.listenPort property, specify that value. If there is a firewall
blocking traffic from the server to the agent, configure the device to
forward traffic on TCP port 2144 to the vCenter Hyperic agent.
The vCenter Hyperic agent initiates a connection to the vCenter Hyperic server and the server verifies that it
can communicate with the agent.
The vCenter Hyperic agent discovers the platform and supported products running on it.
VMware, Inc.
37
By default, if the agent does not trust the certificate presented by the server, the agent issues a warning. You
can terminate the configuration process and configure SSL. The vCenter Hyperic server and the
vCenter Hyperic agent do not import untrusted certificates unless you respond yes to the warning prompt.
It is possible to configure both components to accept untrusted certificates automatically, without warning.
For security reasons, this practice is strongly discouraged. Check the values of
agent.setup.acceptUnverifiedCertificate (in AgentHome/conf/agent.properties) and
accept.unverified.certificates in ServerHome/conf/hq-server.conf.
38
VMware, Inc.
Prerequisites
n
Verify that the vCenter Hyperic agent's keystore was installed prior to initial startup of the agent.
Each agent must have its own keystore.
Verify that you have SSL certificates for the vCenter Hyperic server and each vCenter Hyperic agent.
Verfiy that you have a JKS-format keystore for the vCenter Hyperic server on its host, and that you
have imported its SSL certificate.
Note the full path to the JKS-format keystore and its password. When you run the vCenter Hyperic
installer in -full mode, the installer prompts for this information.
Procedure
1
In the agent's agent.properties file, specify values for the following properties.
Property
Value
agent.keystore.path
agent.keystore.password
(Optional) If you are configuring the vCenter Hyperic agent for unidirectional communication, specify
the keystore name in the agent.keystore.alias property.
VMware, Inc.
Define the location of your trusted keystore with the server.keystore.path property.
Define the password for your trusted keystore with the server.keystore.password property.
For each vCenter Hyperic agent reporting to the vCenter Hyperic server
a
Obtain an SSL certificate from your CA and install it on the vCenter Hyperic agent host.
Define the location of your trusted keystore with the agent.keystore.path property.
39
Define the password for your trusted keystore with the agent.keystore.password property.
For each vCenter Hyperic agent reporting to the vCenter Hyperic server, open
AgentBundle/AgentHome/agent.properties in a text editor.
Verify that each target platform on which a vCenter Hyperic agent will be installed has the following
items.
n
Procedure
1
40
VMware, Inc.
Configure the properties as required. The minimum configuration is the IP address and port of the
vCenter Hyperic install server.
Do not specify values for the agent listen address and port. At first startup, if explicit values for IP
address and port are not set, the vCenter Hyperic agent - which detects the network interfaces on the
platform - uses the first detected interface as its listen address, and port 2144 or 2443 as its listen port,
depending on whether you configure the agent for plain text or SSL communications.
The first time that the agents are started, they read the agent.properties file to identify the server
connection information, will connect to the server and register themselves.
What to do next
Perform remote agent installations. See (Optional) Deploy and Start Multiple Agents One-By-One, on
page 41 or (Optional) Deploy and Start Multiple Agents Simultaneously, on page 42.
VMware, Inc.
Log in to the install server user account that you configured with permissions to SSH into each target
platform without requiring a password.
41
Copy the agent.properties file to the /.hq directory under the home directory of the standard agent
installation user account.
The vCenter Hyperic agent registers themself with the vCenter Hyperic server and the agent runs an
autodiscovery scan to discover its host platform and supported managed products that are running on the
platform.
What to do next
Check the Auto-Discovery portlet in the vCenter Hyperic dashboard to verify that the platform was
discovered.
Create a hosts.txt file on your install server that maps the hostname to the IP address of each platform
on which you are installing an agent.
Type the following command in the sell, supplying the correct name for the agent package in the export
command.
$ export AGENT=hyperic-hq-agent-4.6.0-x86-linux.tgz
$ for host in `cat hosts.txt`; do scp $AGENT $host:</path/to/agent/install>
&& ssh $host "tar zxf $AGENT && ./hyperic-hq-agent-4.6.0/hq-agent.sh start"; done
(Optional) If the target hosts have sequential names, for example host001, host002, host003, and so on,
you can skip the hosts.txt file and use the seq command, as follows.
$ export AGENT=hyperic-hq-agent-4.6.0-x86-linux.tgz
$ for i in `seq 1 9`; do scp $AGENT host$i: && ssh host$i "tar zxf $AGENT &&
./hyperic-hq-agent-4.6.0/hq-agent.sh start"; done
The vCenter Hyperic agents registers themselves with the vCenter Hyperic server and the agents run an
autodiscovery scan to discover their host platform and supported managed products that are running on the
platform.
What to do next
Check the Auto-Discovery portlet in the vCenter Hyperic dashboard to verify that the platforms were
discovered.
42
VMware, Inc.
If your vCenter Hyperic is part of vCenter Operations Management Suite, see Configure the vCenter
Hyperic License for vCenter Operations Management Suite, on page 43.
If your vCenter Hyperic is part of vCloud Suite, see Configure the vCenter Hyperic License for vCloud
Suite, on page 43.
If your vCenter Hyperic is part of vFabric Suite, see Configure the vCenter Hyperic License for vFabric
Suite, on page 44.
If you have more than one license, you configure each of them.
vCenter Hyperic is licensed on a per managed platform basis, where a platform is:
n
A network device or network host that is managed remotely by a vCenter Hyperic agent. See
vCenter Hyperic Resource Configuration and Metrics for information about vCenter Hyperic functionality
for managing remote devices and hosts.
If you have licenses for both vCenter Operations Management Suite and vFabric Suite, you are licensed for
the total number of licenses provided by your vCenter Hyperic license plus the number of licenses provided
in your vCenter Operations Management Suite license.
What to do next
Restart the vCenter Hyperic server.
VMware, Inc.
43
Procedure
1
Add the line vcloud.license.key=LicenseKey, where LicenseKey is the vCloud Suite license key.
What to do next
Restart the vCenter Hyperic server.
If you obtained your vCenter Hyperic license as part of vFabric Suite, refer first to the license
information and procedure in Getting Started with vFabric Suite. If necessary, complete these additional
licensing tasks.
Procedure
n
(Optional) If you acquired vCenter Hyperic as a standalone product, create a file named vf.hyp-serialnumbers.txt that contains the product serial number provided by VMware. Install the file in one of the
following directories, as appropriate. If the file does not exist, create it.
(Optional) If you acquired vCenter Hyperic as part of the vFabric Suite, configure the location of the
VMware license server that administers the network license for vFabric Suite by adding the
vfabric.licenseserver.url property to ServerHome/conf/hq-server.conf.
What to do next
Restart the vCenter Hyperic server.
44
VMware, Inc.
It is good practice to upgrade your vCenter Hyperic components. New versions offer enhancements to
existing functionality, performance, and so on.
n
VMware, Inc.
45
(Optional) If you use an external vCenter Hyperic database, verify that it is backed up.
(Optional) It is good practice to archive your existing vCenter Hyperic server directory, so that you can
revert to it if necessary.
Procedure
1
Type the full path to the previous vCenter Hyperic server instance when prompted.
For example, /opt/hyperic/server-5.0.0
Type the full path to the directory under which the new server instance will be installed.
For example, to install the new instance under your existing vCenter Hyperic home directory, type
c:\hyperic\.
Update the Windows Service with the new version information. For example,
c:\hyperic\server-5.1.0\bin\hq-server.bat install
Start the new server instance. For example type /opt/hyperic/server-5.1.0/bin/hq-server.sh start.
46
(Optional) If you use an external vCenter Hyperic database, verify that it is backed up.
VMware, Inc.
(Optional) It is good practice to archive your existing vCenter Hyperic server directory, so that you can
revert to it if necessary.
For example, tar -zcvf hq-server-5.0.0-archive.tgz hq-server-5.0.0-EE.
Procedure
1
Type the full path to the previous vCenter Hyperic server instance when prompted.
For example, /opt/hyperic/server-5.0.0
Type the full path to the directory under which the new server instance will be installed.
For example, to install the new instance under your existing vCenter Hyperic home directory,
type/opt/hyperic.
You must be connected to the vCenter Hyperic vApp management console. See Connect to the
vCenter Hyperic vApp Management Console, on page 29.
Take snapshots of the vCenter Hyperic and vPostgreSQL database to retain as backup.
Identify the URL link to the new vCenter Hyperic installer TAR or ZIP file.
Procedure
1
On the Hyperic Server Upgrade tab of the vCenter Hyperic vApp management console, paste the link
to the latest version of the vCenter Hyperic installer in the upgrade text box.
Click Upgrade.
VMware, Inc.
The latest version of vCenter Hyperic server is installed under the same account that you are running
the import process.
47
n
n
Procedure
1
Copy the hq-migration-5.8.zip migration package from the installer/bin directory in your new
vCenter Hyperic installer package to the host server from which you are migrating the database,
for example an Hyperic 4.x host.
To export all configuration and metric data, in a shell run the command PathToMigrationHome/hqmigrate.sh hq-export -Dhqserver.install.path=PathToServerHome, where PathToServerHome is
the full path to the vCenter Hyperic server installation directory, or the path relative to
MigrationHome.
You can add -DconfigOnly=true to the command line to export only the configuration data.
The script reads the hq-server.conffile in the older vCenter Hypericversion, connects to its
database, exports the database, and creates a tarball with key artifacts and the database dump in
hq-migration-export-HqVersion.tgz.
By default, the archive is written to the migration_home/tmp/export-data import staging directory,
or the value of staging.dir, if specified.
2
48
VMware, Inc.
Push a vCenter Hyperic Agent Bundle from the vCenter Hyperic Server
You can update one or more vCenter Hyperic agents by pushing the new agent bundle to it from the
vCenter Hyperic server, using the vCenter Hyperic user interface.
When you update an agent bundle, the configuration settings in the agent's
AgentHome/conf/agent.properties file are not changed. However, the first time you start an agent that you
have updated from version 4.5 or earlier, passwords specified in the file are encrypted.
Prerequisites
On the Resources tab, select the server on which the agent bundle resides.
Select the appropriate bundle from the Select upgradeable agent bundle menu.
The bundle includes an update to the JRE. If you do not want to update the JRE, select the bundle that
does not include a platform in the file name, for example agent-version.number.tar.gz.
Click Execute.
The bundle is copied to the bundles directory and self-extracts. On completion of the extraction process, you
can see the version information for the upgraded agent on the Administration > Agents tab.
Prerequisites
Procedure
1
Edit the rollback.properties file in AgentHome/conf to specify the location of the new agent bundle and
the bundle it will replace.
Example:
What to do next
VMware, Inc.
49
50
VMware, Inc.
You can create a vCenter Hyperic vApp in your virtual cloud from a vApp template using VMware
vCloud Director.
To deploy a vCenter Hyperic vApp using vCloud Director requires you to complete the following
procedures, in the order specified below.
Prerequisites
n
The vCenter Hyperic server and vCenter Hyperic database OVF files must have been uploaded to a
vCloud catalog to which you have access.
Your browser must be configured appropriately for accessing and using the vCloud web-based console.
See vCloud Director User Guide for information.
Procedure
1
VMware, Inc.
51
Click My Cloud > vApps > Build New vApp to complete the vApp profile.
Option
Description
Runtime UI Text
Select a runtime
Click Next.
In the Add Virtual Machines pane, select the Hyperic vApp templates.
You find the Hyperic vApp templates in two possible locations:
Browse to and select the vCenter Hyperic server and database virtual machines:
Option
Action
Click Next.
Select the check box to signify your acceptance of the end user license agreement and click Next.
In the Configure Virtual Machines panel, select a virtual datacenter where the vCenter Hyperic vApp
will run.
10
Click Next.
11
In the Application panel, configure the user credentials for the PostgreSQL and vCenter Hyperic
databases.
Do not enter data in the What is the address of the vPostgres database text box.
12
Click Next.
13
In the Networking panel, select the Always use assigned IP addresses until this vApp or associated
networks are deleted check box and click Next.
14
What to do next
Power on the vCenter Hyperic server. See Power on the vCenter Hyperic Server, on page 52.
52
VMware, Inc.
Prerequisites
Create and configure the vCenter Hyperic vApp. See Create and Configure the vCenter Hyperic vApp, on
page 51.
Procedure
1
In vCloud Director, go to vApps > Virtual Machines, select the vPostgres virtual machine and click
Power On.
In vCloud Director, go to vApps > Virtual Machines and select the vCenter Hyperic virtual machine.
Right-click on the virtual machine to display the vApp menu and select Properties > Custom
Properties.
Type the IP address of the vCenter Hyperic database in the What is the address of the vPostgres
database text box.
VMware, Inc.
53
54
VMware, Inc.
After you have installed the vCenter Hyperic server and agents, you might need to change some of the
configuration options that you first specified. There are various properties that you can change.
This chapter includes the following topics:
n
In the agent.properties file, locate agent.setup.camPword= and type a password using a plain text
value.
What to do next
If your agent deployment strategy involves distributing a standard agent.properties file to all agents, you
must also distribute agent.scu. See Install Multiple vCenter Hyperic Agents Simultaneously, on page 40.
VMware, Inc.
55
56
Select the uninstall option that is appropriate to the agent installation environment.
Agent Installation Environment
Action
Remove the platform for the agent and delete the agent's installation
folder.
VMware, Inc.
Index
A
agent
unistall 56
upgrade 45
agent properties
activate communication properties 34
configure 33
configure for server initiated
communication 34
configure for agent initiated communication 34
configure properties file 33
for multiple agents 40, 41
agents, install multiple simultaneously 40
B
bidirectional communication 36
C
communication
bidirectional 36
SSL 3840
unidirectional agent to server 35
communication properties, activate 34
configuration, of agent using config dialog 37
configure license for vCenter Operations
Management Suite 43
configure license for vCloud Suite 43
configure license for vFabric Suite 44
D
database
create vCenter Hyperic User 17
create vCenter Hyperic 17
migrate from earlier version 45, 47
download vCenter Hyperic 12
I
installation
agent-only package 32
configure agent in properties file 33
installation, of agent using installer
script 22
of agent from RPM 32
of agent using vCenter Hyperic installer 32
of server from RPM 25
of vCenter Hyperic agent 30
remove existing vCenter Hyperic server 25
VMware, Inc.
selecting a package 11
using vCenter Hyperic setup script 17
using vCenter Hyperic vApp 17
using Windows setup wizard 17, 24
vCenter Hyperic agent installer 31
vCenter Hyperic database 13
vCenter Hyperic vApp 18
installers, vCenter Hyperic 21
J
JREs, configure locations 13
K
keystore, configure 36
L
license
activate 43
configure 43
configure for vCenter Operations Management
Suite 43
configure for vCloud Suite 43
configure for vFabric Suite 44
consumption 43
view terms 44
M
migrate 45
migration, PostgreSQL database 45, 47
multiple agents
create standard properties file 41
install individually 41
install simultaneously 40, 42
N
network status, on vApp 29
P
PostgreSQL
change data and log locations 14, 15
configure client authentication 16
configure properties 15
environment variables 15
install 14
troubleshoot connection issues 17
prerequisites, vCenter Hyperic installation 31
57
properties
configure agent 33
configure for RPM 25, 26, 28
configure for vCenter Hyperic agent 33
encrypt values 55
proxy settings, configure for vApp 30
S
server
change sizing profile 55
reboot 30
shutdown 30
upgrade 45
SSL
agent to server communication 38
change to use vCenter Hyperic keystore 40
change to use user-managed keystore 39
configuring 38
supported configurations, vCenter Hyperic 7
system requirements, vCenter Hyperic 7
T
troubleshooting, PostgreSQL connection
issues 17
U
unidirectional communication 35
upgrade
push agent bundle 49
vCenter Hyperic agent 45
vCenter Hyperic vApp 45
vCenter server 46
vCenter Hyperic server 45, 46
upgrading
vApp 47
vCenter Hyperic agent 48
V
vApp
configure proxy settings 30
connect to management console 29
create and configure 51
deploy using vCloud Director 51
install 18
log in 20
manage network address settings 29
reboot server 30
set time zone 29
shutdown server 30
upgrade 45, 47
58
VMware, Inc.