HP Client Virtualization User Manual

HP VMware Utilities User Guide

VMware ESXi 5.0 U2 and 5.0 U3 for September 2013

HP Part Number: 670557-407 Published: September 2013 Edition: 9

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. UNIX is a registered trademark of The Open Group.

Acknowledgments

Microsoft Windows is U.S. registered trademarks of Microsoft Corporation.

UNIX is a registered trademark of The Open Group.

1 Introduction...............................................................................................4

Installing offline bundles on an ESXi 5.0 and updates host using vSphere CLI 5.0 esxcli utility.............4

Prerequisites........................................................................................................................4

Installing offline bundles on an ESXi 5.0 and updates host using VMware vCenter Update

Manager.................................................................................................................................4

HPONCFG utility......................................................................................................................5

HPONCFG command-line syntax...........................................................................................5

HPONCFG return codes.......................................................................................................6

HPONCFG command file contents.........................................................................................6

Obtaining an entire configuration..........................................................................................6

Obtaining a specific configuration.........................................................................................7

Setting a configuration.........................................................................................................8

HPONCFG command-line examples.......................................................................................8

HPBOOTCFG utility..................................................................................................................9

HPBOOTCFG command-line syntax........................................................................................9

HPBOOTCFG ESXCLI syntax..................................................................................................9

HPBOOTCFG return codes..................................................................................................10

HPBOOTCFG command-line examples..................................................................................10

HPSSACLI utility......................................................................................................................10

HPSSACLI command-line syntax...........................................................................................10

HPSSACLI ESXCLI syntax.....................................................................................................11

HPTESTEVENT utility................................................................................................................13

HPTESTEVENT command-line syntax.....................................................................................13

HPTESTEVENT ESXCLI syntax...............................................................................................14

HPTESTEVENT return codes.................................................................................................14

HPTESTEVENT command-line examples.................................................................................14

Generating an ADU report (diagnostics) from within HPSSACLI for ESXi 5.0 and updates.................14

2 Support and other resources......................................................................16

Contacting HP .......................................................................................................................16

Before you contact HP........................................................................................................16

HP contact information.......................................................................................................16

Subscription service............................................................................................................16

Documentation feedback....................................................................................................16

New and changed information in this edition ............................................................................17

Related information.................................................................................................................17

Documents........................................................................................................................17

Websites..........................................................................................................................17

Typographic conventions.........................................................................................................17

Index.........................................................................................................19

Contents 3

1 Introduction

This section provides information about the utilities supported on VMware ESXi 5.0 and updates. The following utilities are supported on VMware ESXi 5.0 and updates host:

• HPONCFG — Command line utility used for obtaining and setting ProLiant iLO configurations.

• HPBOOTCFG — Command line utility used for configuring ProLiant server boot order.

• HPSSACLI – Command line utility used for configuration and diagnostics of ProLiant server

SmartArrays.

• HPTESTEVENT – Command line utility used to request the HP Insight Management WBEM

Providers generate the Informational Test Indication with ProviderName “HP Test” and EventID 1, and the CPQ SNMP test trap with OID 1.3.6.1.4.1.232.11.2.8.1.0.11003.

Installing offline bundles on an ESXi 5.0 and updates host using vSphere CLI 5.0 esxcli utility

This section provides information about installing the VMware ESXi 5.0 and updates offline bundles on the ESXi host. You can use the esxcli utility in conjunction with offline bundles or with a depot.

Prerequisites

Install VMware vSphere Command-Line Interface 5.0(vSphere CLI) on Microsoft Windows or Linux system. For information about importing or installing the vSphere CLI 5.0, see the VMware vSphere Command-Line Interface Installation and Reference Guide available at:

http://pubs.vmware.com/vsphere-50/topic/com.vmware.vcli.ref.doc_50/vcli-right.html.

To install the offline bundle on an ESXi host, perform the following steps:

1. Power off any virtual machines that are running on the host, and set the host into maintenance mode.

2. Transfer the bundle onto the ESXi host local path, or extract it onto an online depot.

3. Install the bundle on the ESXi host using any of the following command line:

• Install remotely from client, with offline bundle available as online depot

~# esxcli -s <server> -u root -p mypassword software vib install

-d <depotURL/bundle-index.xml>

• Install remotely from client, with offline bundle available on ESXi host

~# esxcli -s <server> -u root -p mypassword software vib install

-d <ESXi local path><bundle.zip>

• Install from ESXi host, with offline bundle available on ESXi host

~# esxcli software vib install -d <ESXi local path><bundle.zip>

4. After the bundle is installed, reboot the ESXi host to initialize the utilities.

Installing offline bundles on an ESXi 5.0 and updates host using VMware vCenter Update Manager

The offline bundle can also be installed from VMware vCenter Update Manager as a patch. For more information and detailed instructions, see the VMware vCenter Update Manager Administration Guide available at:

http://pubs.vmware.com/vsphere-50/topic/com.vmware.vsphere.update_manager.doc_50/ GUID-F7191592-048B-40C7-A610-CFEE6A790AB0.html.

4 Introduction

HPONCFG utility

The HPONFCG utility only supports HP ProLiant 300/500/700/900 Server series, 100 Series Gen8 servers, and HP ProLiant BL Servers that are listed in the ESXi Server Support Matrix. To visit the ESXi Server Matrix page, go to www.hp.com/go/vmware and select Certified ProLiants under Tools/Resource section.

HP offers support for the iLO 2, iLO 3 and iLO 4 features available on ProLiant servers with the

HPONCFG utility. HPONCFG is an online configuration tool used to set up and reconfigure iLO 2, iLO3 and iLO 4

without requiring a reboot of the server operating system. The utility runs in a command-line mode and must be executed from an operating system command-line.

Observe the following requirements before using HPONCFG:

• The iLO 2, iLO 3 or iLO 4 Management Interface Driver must be loaded on the server. HPONCFG

displays a warning if the driver is not installed.

• HPONCFG requires minimum iLO 2, iLO 3 and iLO 4 firmware versions. To determine the

minimum firmware version required, see the HP SmartStart Scripting Toolkit Linux and Windows Editions Support Matrix.

For more information, see the Remote Management website:http://www.hp.com/servers/lights-out

HPONCFG command-line syntax

Use the following format at the command line:

hponcfg -f filename [-l filename] [-v] [-m minFw] -g [-m minFw] -w filename [-m minFw] -r [-m minFw ] -h -?

The HPONCFG utility can be accessed from the location: /opt/hp/tools.

IMPORTANT: Because the-w argument does not capture certain types of information, such as

the administrator password, data files created with HPONCFG using the-w argument cannot then be used as input files for HPONCFG, unless they are modified first.

Table 1 hponcfg Command Line Arguments

FunctionArgument

-a, --all

-i --input

-s,--substitute

-f, - -file=filename

-m, - -minfwlevel

This argument captures complete Management Processor configuration to the file. This option should be used along with the "-w" option.

This argument Get/Set Management Processor Configuration from the XML input received through the standard input stream.

This argument substitutes variables present in the input configuration file with the values specified in "namevaluepairs".

This argument sets the iLO 2, iLO 3 or iLO 4 configuration based on the information in the XML input file named filename.

This argument logs replies to the text log file named filename.-l, - -log=filename

Writes all the responses from iLO 2, iLO 3 or iLO 4.-v, - -xmlverbose

This argument returns the host server name and serial number.-g, - -get_hostinfo

This argument indicates to HPONCFG the minimum firmware level that must be present in the management device to execute the RIBCL script. If the minimum level is not met, HPONCFG returns an error without performing any additional actions.

-w, - -writeconfig=filename

This argument writes the iLO 2, iLO 3 or iLO 4 configuration obtained from the device to the XML output file named filename.

HPONCFG utility 5

Table 1 hponcfg Command Line Arguments (continued)

HPONCFG return codes

This section provides description about the return code after running the command.

Table 2 hponcfg return codes

FunctionArgument

This argument resets the iLO 2, iLO 3 or iLO 4 to factory defaults.-r, - -reset

These arguments display simple help messages.-h, - -help, - -?

MeaningValue

ERROR: A general system error detected while running HPONCFG-1

Script succeeded.0

Script failed1

ERROR : Unable to shutdown the iLo Channel Interface2

Firmware flash is in progress. Please wait for a while.3

General error detected while checking firmware flash.4

iLO Lights-Out functionality is Disabled.5 Please enable Lights-Out functionality before using this software. To Enable Lights-Out functionality: Set iLO Security Override Switch to ON and Use iLO ROM-based Setup Utility or iLO Browser interface to enable lights-out

functionality.

You are not a root/superuser. Only root/superuser can access the utility.7

ERROR: Please specify firmware level as numeric input9

Could not get status of the Lights-Out Functionality10

ERROR: Failed to capture the configuration13 - 20

If the script itself fails, errors are reported in the log file created by HPONCFG.

HPONCFG command file contents

The hponcfg command can be used to perform the following tasks:

• Obtain an entire configuration

• Obtain a specific configuration

• Set a configuration

Obtaining an entire configuration

The hponcfg command can be used to obtain an entire configuration from an iLO 2, iLO 3 or iLO 4. In this case, the utility executes from the command line without specification of an input file. The name of the output file is given on the command line. For example:

/opt/hp/tools # ./hponcfg -w config.xml

In this example, the utility indicated that it obtained the data successfully and wrote it to the output file as requested. The following is a typical example of the contents of the output file:

6 Introduction

+ 13 hidden pages