HP 3PAR Host Explorer Deployment Tool
User Guide
Abstract
This document provides the information about remotely deploying, and executing the Host Explorer tool on all the hosts connected
to 3PAR array.
HP Part Number: 748767-001
Published: February 2014
Edition: 1
© Copyright 2014 Hewlett-Packard Development Company, L.P.
The information contained herein is subject to change without notice. The only warranties for HP products and services are set forth in the express
warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. HP shall
not be liable for technical or editorial errors or omissions contained herein.
Acknowledgments
Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial
Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under
vendor's standard commercial license.
The information contained herein is subject to change without notice. The only warranties for HP products and services are set forth in the express
warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. HP shall
not be liable for technical or editorial errors or omissions contained herein.
Intel and Pentium are trademarks of Intel Corporation in the U.S. and other countries.
Microsoft, Windows, Windows XP, Windows Server 2003/2008 (x86, x64), and Windows Vista and Windows 7 are U.S. registered trademarks
of Microsoft Corporation.
Java is a registered trademark of Oracle and/or its affiliates.
Contents
1 Overview..................................................................................................4
Introduction..............................................................................................................................4
Acronyms and abbreviations......................................................................................................4
2 Prerequisites for installing HP 3PAR HE Deployment tool..................................5
Installing JDK...........................................................................................................................5
Setting up JAVA_HOME............................................................................................................5
Settings on WINDOWS (Local, Target) Hosts...............................................................................5
Settings on LINUX/HPUX/SOLARIS.............................................................................................6
3 Installation and removing HP 3PAR HE Deployment tool...................................7
Installing HP 3PAR HE Deployment tool.......................................................................................7
Directories installed..............................................................................................................7
Verifying the installation ...........................................................................................................8
Removing the HP 3PAR HE Deployment tool.................................................................................8
4 Using HP 3PAR HE Deployment Tool GUI......................................................9
Host configuration....................................................................................................................9
Add host...........................................................................................................................10
Removing a host................................................................................................................11
Deploy Host Explorer..............................................................................................................11
Select OS Type..................................................................................................................12
Selecting hosts...................................................................................................................13
Installing the HE as an agent...............................................................................................13
Deploy.............................................................................................................................13
Historical Reports....................................................................................................................14
Selecting a report..............................................................................................................14
Settings.................................................................................................................................15
Changing the default HE installer package............................................................................17
5 Support and other resources......................................................................18
Contacting HP........................................................................................................................18
Subscription......................................................................................................................18
Documentation feedback.........................................................................................................18
Typographic conventions.........................................................................................................18
A Support matrix.........................................................................................20
Index.........................................................................................................21
Contents 3
1 Overview
Introduction
HP 3PAR HE (Host Explorer) Deployment tool can remotely deploy, and execute the HP HE tool
on all the hosts connected to an array, which in turn transfers the host related configuration
information to the 3PAR array.
The HP 3PAR HE Deployment tool is installed, and deployed in a system that has the network
connectivity to all the hosts where the HE bits are deployed remotely.
The HP 3PAR HE Deployment tool enables the user to remotely transfer and install the HE utility for
the supported hosts except for the Host Explorer for VMWare. The user can optionally configure
HE to run as a service, or as a daemon process on the target host (and manually remove when
needed).
HP 3PAR HE Deployment tool enables you to:
• Enter the IP addresses, hostnames, and user credentials for each host attached to the array.
The users shall discover all the hosts that are connected to the storage array manually.
• Perform a connectivity test to a given host, remotely log in, transfer and execute the HE utility
remotely. After the remote execution is successful, based on the user preference, the tool
initiates to remove, and delete the HE utility remotely.
Acronyms and abbreviations
API Application Programming Interface
HE Host Explorer
SAN Storage Area Network
4 Overview
2 Prerequisites for installing HP 3PAR HE Deployment tool
Installing JDK
Java Development Kit (JDK) has to be installed on the same server machine that has HP 3PAR HE
Deployment tool installed. The supported Java version is JDK 1.6 or higher.
Setting up JAVA_HOME
After installing JDK on Windows, you must set the JAVA_HOME environment variable to point to
the Java installation directory.
1. Locate the JDK installation directory
If you are aware of the installation path for the Java Runtime Environment, proceed to Step
2. Otherwise, find the installation path as specified below:
If you have not changed the installation path for the Java Runtime Environment during
installation, then locate the directory under C:\Program Files\Java. Using the Explorer,
open the directory.
One or more subdirectories reside inside the path, such as C:\Program Files\Java\
jdk6.
2. Set the JAVA_HOME variable.
After verifying the Java installation path, perform the following task to set the Java_Home
variable:
a. Right-click the My Computer icon on your desktop and select Properties.
b. Click Advanced tab.
c. Click the Environment Variables button.
d. Under System Variables, click New.
e. Enter the variable name: JAVA_HOME.
f. Enter the variable value as the installation path for JDK.
g. If the Java installation directory has space in its path name, you can use the shortened
path name (for example:C:\Progra~1\Java\jdk6) in the environment variable.
NOTE: For Windows users on 64-bit systems:
• Progra~1 = 'Program Files'
• Progra~2 = 'Program Files(x86)'
h. Click OK.
i. Click Apply Changes.
Close all command windows before making these changes and open a new command window.
You cannot reload the environment variables from an active command prompt. For more information,
see “Support matrix” (page 20).
The following settings are mandatory for the remote communication from Windows management
station to Windows/Unix host(s) for the HE Deployment tool to work.
Settings on WINDOWS (Local, Target) Hosts
• Ensure WMI is enabled and running.
• Ensure WMI Windows Installer Provider is installed
Installing JDK 5
Settings on LINUX/HPUX/SOLARIS
Ensure that SSH is running and password authentication is enabled.
To enable password
authentication, set passwordAuthentication.in
/etc/ssh/sshd_config file to yes and
restart the ssh service.
SOLARIS: For installing HE package non-interactively, set the "action" property to "nocheck" in
the file:
/var/sadm/install/admin/default
6 Prerequisites for installing HP 3PAR HE Deployment tool
3 Installation and removing HP 3PAR HE Deployment tool
Installing HP 3PAR HE Deployment tool
To install HP 3PAR HE Deployment tool:
1. Logon the host as a System Administrator.
2. Insert the HP Host Explorer Deployment tool CD into the CD-ROM drive.
3. Open the Windows Explorer window.
4. Select Start All Programs Accessories Windows Explorer.
5. Double-click the CD-ROM drive to expand the files.
6. Double-click the appropriate file:
• For x86-32 bit platforms:HP 3PAR Host Explorer Deployment Tool_x86.exe
• For x86-64 bit platforms:HP 3PAR Host Explorer Deployment Tool_x64.exe
Directories installed
The following directories are installed in the HP 3PAR HE Deployment tool folder:
• bin – This directory contains the batch files and DLLs related to HP 3PAR HE Deployment tool
GUI and CLI. Changes must not be made in this directory.
Double-click the HEDeploymentTool.bat, or execute it from the command prompt to launch
the HP 3PAR HE Deployment tool GUI.
• conf – This directory lists the configuration files.
1. HEDeployConfig.properties – This contains two properties.
◦ concurrency – This value indicates the number of concurrent HE deployments that
can happen with the tool. The default value is 5.
◦ reportcount – This value indicates the number of historical reports that can be
displayed in the GUI Historical Reports tab. The default value is 10.
NOTE: If the Historical Reports tab is open and the value is changed, perform one of
these actions:
◦ Close an re-launch the GUI.
◦ Click another tab and then, click Historical Reports tab.
The changes are reflected in the Historical Reports tab.
2. HEPackages.xml – This file, it represents the HE OS-Platform combinations and the
relative path of the corresponding file locations.
3. HostCredentials-all.xml – This file, represents the hosts that are configured by
the user. Initially the file is empty.
4. log4j.properties – This is a property file for logging the errors while generating the
report. The log level value of the following properties can be modified:
a. log4j.logger.com.hp.ua.he=INFO,CliLogger
b. log4j.logger.com.hp.he.hedeploytool.gui =INFO,GuiLogger
The default logging level for GUI and CLI logging is INFO. It can also be changed
to ERROR, DEBUG, and WARN.
c. log4j.appender.xxx.File – The path of the generated log files. By default, it
is set to GUIlog.log and CLIlog.log in the logs directory. You can change it
to the desired location and rename the file.
Installing HP 3PAR HE Deployment tool 7
d. log4j.xxx.Append – The boolean value representing whether logs should be
appended. By default, it is set to true.
e. log4j.xxx.MaxFileSize – The maximum file size before the next file is generated.
The default value is set to 1MB.
• data – This directory contains XML files that correspond to the current deployment. It also has
a reports directory that stores historical reports. The reports generated are in .xml format
and have the following naming convention:
HostCredentials_YYYY-MM-DD_timestamp.xml.
• lib – This directory contains all the libraries used in the tool.
• logs – This directory contains the tool logs. Two log files are generated, one for GUI and
another for CLI. The path has to be set in log4j.properties file. By default, the log files
are generated in the logs directory and their names are GUIlog.log and CLIlog.log.
• packages – This directory contains all the HE installation packages.
Verifying the installation
To verify the installation:
1. Log on as the System Administrator.
2. Select Start Control Panel Add/Remove Programs.
Result: The Add/Remove Programs window appears.
3. Verify HP 3PAR Host Explorer Deployment tool appears in the Currently installed programs
column.
Removing the HP 3PAR HE Deployment tool
To remove the HP 3PAR HE Deployment tool:
1. Logon as the System Administrator.
2. Select Start Settings Control Panel Add/Remove Programs.
Result: The Add/Remove Programs window appears.
3. Select HP 3PAR Host Explorer Deployment tool.
4. Click Remove.
8 Installation and removing HP 3PAR HE Deployment tool
4 Using HP 3PAR HE Deployment Tool GUI
Open HP 3PAR HE Deployment tool by double-clicking the shortcut icon on the desktop, or by
selecting Start Menu All Programs Hewlett-Packard HP 3PAR Host Explorer HP 3PAR Host
Explorer Deployment Tool.
NOTE: If the GUI does not launch when opened from the desktop shortcut, then the user has to
launch the GUI from the command line to troubleshoot as specified in this“section” (page 7).
The HP 3PAR HE Deployment tool page is displayed, as shown in Figure 1 (page 9).
After opening the GUI, the user can view the following options in the left navigation:
• Host Configuration
• Deploy Host Explorer
• Historical Reports
• Settings
Figure 1 HP 3PAR HE Deployment tool options
Host configuration
The Host Configuration option appears as shown in Figure 2 (page 10).
Host Configuration option lists the host credentials that are currently configured. The fields shown
are as follows:
• Host IP – This displays the IP address of the configured OS type.
• Username – This displays the User name associated with the IP address.
• OS type – This displays the type of the operating system.
• Domain – This displays the domain associated with the IP address (applicable only for Windows
OS).
Host configuration 9
Figure 2 Host configuration
Add host
To add a host:
1. Click the Add button. The Add Host dialog box appears.
2. Click the OS Type menu to select the OS options:
• Windows
• Linux
• Solaris
• HPUX
10 Using HP 3PAR HE Deployment Tool GUI
3. Enter the Host IP, User Name, Password, Re-enter Password and click OK.
If the validation succeeds, it is added to the list under the Host Configuration screen.
If the user selects WINDOWS OS Type, then the Domain field appears as shown in Figure 3
(page 11).
If the Host user name is part of a domain, then the user has to enter the Domain field in addition
to the other fields. Else, it can be left empty.
Figure 3 Domain field appears in Windows OS type
Removing a host
To remove a host:
• Select a row and click Remove. You can remove only one at a time.
Deploy Host Explorer
The Deploy Host Explorer option appears as shown in Figure 4 (page 12).
Deploy Host Explorer 11
This option displays the hosts along with their OS type that are configured and has an option to
deploy the HE as an agent to the hosts.
Figure 4 Deploy Host Explorer
NOTE: By default, Install as Agent option is not selected, which results in the HE deployment tool
to remotely copy the corresponding HE executable to the host, install, execute it once, and then
remove the transferred HE executable from the host.
Select OS Type
You can select the view by selecting the appropriate OS type from the Select OS type menu.
For example, if All is selected from the Select OS type menu, configured hosts of all the operating
systems are displayed.
12 Using HP 3PAR HE Deployment Tool GUI
Selecting hosts
Select hosts by performing one of these actions:
• Select the option beside each host that is configured.
• Enable the Select All option, to select all the hosts that are displayed.
Installing the HE as an agent
Select the Install As Agent option, to deploy the HE as an agent to the hosts that are selected and
execute it.
Deploy
1. Click Deploy for deploying the HE on the selected hosts.
The Deploy Host Explorer dialog box is displayed with the following message:
Deploy Host Explorer 13
Host Explorer deployment is in progress. Please check the logs for
status.
2. Click OK to complete the deployment process.
The generated logs are saved in the logs directory.
Historical Reports
On the Historical Reports screen the following fields are displayed for the selected report:
• Host Name
• OS Type
• Status
• Start Date Time
• End Date Time
Selecting a report
The user must click on the drop-down option corresponding to Select Report which lists the report
names as shown in Figure 5 (page 15).
On selecting the report, the report data is displayed in the table below. The data displays the Host
IPs included for HE deployment, their OS Type, status of HE deployment, Start Date Time and End
Date Time of HE deployment on the host as shown in Figure 6 (page 15).
Number of reports displayed can be configured, as explained in the HEDeployConfig properties
file under the Directories installed section. By default, the last ten reports are displayed.
14 Using HP 3PAR HE Deployment Tool GUI
Figure 5 List of reports
Figure 6 Report data
NOTE: When HE Deployment tool is used to deploy HE to a remote Windows host which is not
connected to any 3PAR array with "Install as Agent" option unchecked, the report data shows a
"Success" HE deployment status corresponding to the host though HE execution does not succeed.
Settings
Settings screen, lists all the possible OS-platform combinations of HE and the default relative path
of the installer packages as shown in Figure 7 (page 16).
Settings 15
Figure 7 OS specific HE installer packages
16 Using HP 3PAR HE Deployment Tool GUI
Changing the default HE installer package
To change the default installer package:
1. Double-click on any of the package path (right-side), a window is opened.
2. The Packages folder is opened by default.
3. Select the appropriate installer package and click Open.
4. The newly selected installer package reflects on the Source Package Path section for the specific
OS-Platform.
NOTE: Apart from the Packages folder, the user cannot browse to other folders. User must
manually place the installer packages in the Packages folder to replace the default installer package.
Settings 17
5 Support and other resources
Contacting HP
For worldwide technical support information, see the HP support website:
http://www.hp.com/support
Before contacting HP, collect the following information:
• Product model names and numbers
• Technical support registration number (if applicable)
• Product serial numbers
• Error messages
• Operating system type and revision level
• Detailed questions
Subscription
HP recommends you to register your product at the Subscriber's Choice for Business website:
http://www.hp.com/go/e-updates
After registering, you will receive e-mail notification of product enhancements, new driver versions,
firmware updates, and other product resources.
Documentation feedback
HP welcomes your feedback.
To make comments and suggestions about product documentation, send a message to
[email protected]. All submissions become the property of HP.
Typographic conventions
Table 1 Document conventions
Convention Element
Blue text:Table 1 (page 18) Cross-reference links, e-mail addresses, and website addresses.
Bold text • Keys that are pressed.
• Text typed into a GUI element, such as a box.
• GUI elements that are clicked or selected, such as menu and list items,
buttons, tabs, and check boxes.
Italic text Text emphasis
Monospace text • File and directory names
• System output
• Code
• Commands, their arguments, and argument values
Monospace, italic text • Code variables.
• Command variables.
Monospace, bold text Emphasized monospace text.
WARNING! Indicates that failure to follow directions could result in bodily harm or death.
18 Support and other resources
CAUTION: Indicates that failure to follow directions could result in damage to equipment or data.
IMPORTANT: Provides clarifying information or specific instructions.
NOTE: Provides additional information.
TIP: Provides helpful hints and shortcuts.
Typographic conventions 19
A Support matrix
The following are the system requirements for HP 3PAR HE Deployment tool:
Support Item Supported Platforms, Versions, or Configuration
Management Station Windows Server 2008 onwards
Version of Java 1.6 or higher
IP network addresses IPv4
20 Support matrix
Index
A
add host, 10
C
changing default installer package, 17
D
deploy, 13
deploy host explorer, 11
directories installed, 7
H
historical reports, 14
host configuration, 9
host explorer deployment tool, 4
I
install as agent, 13
installing HP 3PAR HE deployment tool, 7
installing JDK, 5
R
remove host, 11
Removing HP 3PAR HE deployment tool, 8
S
Select OS, 12
select report, 14
selecting hosts, 13
setting up JAVA_HOME, 5
settings, 15
support and other resources, 18
U
using GUI, 9
V
verifying the installation, 8
21
