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.
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.
•HPACUCLI – Command line utility used for configuration and diagnostics of ProLiant server
SmartArrays.
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:
•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 AdministrationGuide available at:
The HPONFCG utility only supports HP ProLiant 300/500/700 and Blade servers.
4Introduction
Page 5
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 WindowsEditions Support Matrix.
For more information, see the Remote Management website:http://www.hp.com/servers/lights-out
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
-f, - -file=filename
-m, - -minfwlevel
-w, - -writeconfig=filename
HPONCFG return codes
This section provides description about the return code after running the command.
FunctionArgument
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.
This argument writes the iLO 2, iLO 3 or iLO 4 configuration obtained from the
device to the XML output file named filename.
This argument resets the iLO 2, iLO 3 or iLO 4 to factory defaults.-r, - -reset
These arguments display simple help messages.-h, - -help, - -?
Table 2 hponcfg return codes
MeaningValue
The script was sent successfully to the device.0
The script could not be sent to the device. There is an error in xml.1
The Management processor is not present, or the driver is not running.2
HPONCFG utility5
Page 6
Table 2 hponcfg return codes (continued)
MeaningValue
The iLO flash is still in progress.3
The script is unable to create an output file.255
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:
For security reasons, the user passwords are not returned.
Obtaining a specific configuration
A specific configuration can be obtained using the appropriate XML input file. For example, here
are the contents of a typical XML input file, get_global.xml:
<!-- Sample file for Get Global command -->
<RIBCL VERSION="2.0">
<LOGIN USER_LOGIN="x" PASSWORD="x">
<RIB_INFO MODE="read">
<GET_GLOBAL_SETTINGS />
</RIB_INFO>
</LOGIN>
</RIBCL>
The XML commands are read from the input file get_global.xml and are processed by the
device:
<!–Add user with minimal privileges to test default setting of assigned privileges to 'N'—>
<RIBCL version="1.2"/>
<LOGIN USER_LOGIN="x" PASSWORD="x">
<USER_INFO MODE="write">
<ADD_USER USER_NAME="Landy9" USER_LOGIN="mandy9"
PASSWORD="floppyshoes">
<RESET_SERVER_PRIV value="Y" />
<ADMIN_PRIV value="Y" />
</ADD_USER>
HPONCFG utility7
Page 8
</USER_INFO>
</LOGIN>
</RIBCL>
The specified user will be added to the device.
HPONCFG command-line examples
This section provides sample examples to run the utility.
Table 3 hponcfg command-line examples
To view the command usage options, run the following command:
/opt/hp/tools # ./hponcfg —h
All options supported by the command are listed in the output.
To get the host server name and serial number, run the following command:
/opt/hp/tools # ./hponcfg —g
The following output is displayed:
Firmware Revision = 2.05 Device type = iLO 2 Driver name = hpilo
Host Information:
Server Name: localhost.americas.hpqcorp.net
Server Number: 000000000
To set the minimum firmware level, run the following command:
/opt/hp/tools # ./hponcfg —m 2
The following output is displayed:
DescriptionCommand-line argument
This argument displays help information.hponcfg -h
This argument returns the host server name and serial number.hponcfg -g
Firmware Revision = 2.05 Device type = iLO 2 Driver name = hpilo
HPBOOTCFG utility
The hpbootcfg utility only supports HP ProLiant 300/500/700 and Blade servers.
This utility allows an application to set the device for the next subsequent boot of the system.
Sets Floppy Drive as the first boot device for the system boot-F
Sets CD-ROM Drive as the first boot device for the system boot-C
Sets Hard Drive as the first boot device for the system boot-H
Sets Tape Drive as the first boot device for the system boot-T
Sets system configuration utility as the boot device for the current boot-S
8Introduction
Sets quick configuration utility as the boot device for the current boot-Q
Page 9
Table 4 hpbootcfg Command Line Arguments (continued)
FunctionArgument
Sets ROM-Based Setup Utility (RBSU) as the boot device for the current boot-R
Sets PXE client as the boot device for the current boot-P
Sets remote configuration as the boot device for the current boot-r
Sets remote dial out as the boot device for the current boot-d
Sets remote network as the boot device for the current boot-n
Bypasses F1 / F2 prompts-b
HPBOOTCFG ESXCLI syntax
The hpbootcfg utility is supported by the ESXCLI utility.
To view the command usage options, run the following command:
# esxcli hpbootcfg
The following output is displayed:
Usage: esxcli hpbootcfg {cmd} [cmd options]
Available Commands:
execute execute — hpbootcfg command with options parameter
help — show hpbootcfg help
show — show current hpbootcfg settings
To view the current boot settings, run the following command:
# esxcli hpbootcfg show
The following output is displayed:
00 00: Normal Device first, normal boot process
To set the command parameter values, run the following command:
# esxcli hpbootcfg execute -D
The following output is displayed:
00 00: Normal Device first, normal boot process
HPBOOTCFG return codes
This section provides description about the return code after running the command.
Table 5 hpbootcfg return codes
MeaningValue
Indicates success0
Indicates failureNon zero
HPBOOTCFG command-line examples
This section provides sample examples to run the utility.
HPBOOTCFG utility9
Page 10
Table 6 hpbootcfg command-line examples
HPACUCLI utility
The HPACUCLI utility supports HP ProLiant 300/500/700 and Blade servers with integrated
SmartArray controllers and option controllers. The utility supports reporting and configuration of
the SmartArray. Configuration includes the ability to create arrays; create, expand, and delete
logical drives and many other advanced operations. The information provided in the guide is
introductory and example focused . For more information, see Configuring Arrays on HP Smart
Using VMware esxcli requires knowledge about the CLI usage. The VMware vSphere command
line documentation is available at: http://www.vmware.com/support/developer/vcli/.
The following is an overview of the ESXCLI command-line format:
This argument displays help information./opt/hp/tools/hpbootcfg -h
This argument sets the default values./opt/hp/tools/hpbootcfg -D
Table 7 HPACUCLI Command Line Arguments
FunctionArgument
The esxcli applicationesxcli
namespace
Each plugin must have an associated namespace which defines any environment or other system variables
required by the application.
A plugin must have one or more associated objects which defines a single operation.object
Prepares the esxcli target to accept a command line string.command
Additional switches associated with the command itself (if necessary).cmd options
This is the string which dictates the operation that should be executing by the target application itself.“command-string”
The current namespace and command names are: hpacucli and cmd respectively. The {cmdoptions} parameter can be cmdopts or -q. There is no need for an {object} type for ACUCLI
since the application operates on internal commands supplied in the command-string.
HPACUCLI ESXCLI syntax
The HPACUCLI utility is supported by the ESXCLI utility.
Use the following command syntax for all commands:
physicaldrive 1I:1:1
Port: 1I
Box: 1
Bay: 1
Status: OK
Drive Type: Data Drive
Interface Type: SAS
Size: 146 GB
Rotational Speed: 10000
Firmware Revision: HPDE
Serial Number: 6SD3FJVL0000B145MFXB
Model: HP EG0146FAWHU
Current Temperature (C): 36
Maximum Temperature (C): 46
PHY Count: 2
PHY Transfer Rate: 6.0GBPS, Unknown
physicaldrive 1I:1:2
Port: 1I
Box: 1
Bay: 2
Status: OK
Drive Type: Data Drive
Interface Type: SAS
Size: 146 GB
Rotational Speed: 10000
Firmware Revision: HPDE
Serial Number: 6SD3EVBH0000B144Q7RD
Model: HP EG0146FAWHU
Current Temperature (C): 37
Maximum Temperature (C): 49
PHY Count: 2
PHY Transfer Rate: 6.0GBPS, Unknown
Firmware Revision: HPDE
Serial Number: 6SD3FK4A0000B145J6JK
Model: HP EG0146FAWHU
Current Temperature (C): 37
Maximum Temperature (C): 48
PHY Count: 2
PHY Transfer Rate: 6.0GBPS, Unknown
...
These examples are not inclusive of all the capabilities of the HPACUCLI command. Commands
and options for additional operations using the HPACUCLI, such as creating a logical drive, are
documented in the HP Array Configuration Utility User Guide.
Generating an ADU report (diagnostics) from within HPACUCLI for ESXi
5.0 and updates
The ACUCLI application contains the ability to generate a diagnostic report of the system and its
Smart Array storage configuration. The following steps are required in order to obtain an ADU
report from a remote machine running ESXi 5.0 and updates.
1.Obtain and install the HP Array Diagnostics and SmartSSD Wear Gauge Utility:
a. Browse to http://www.hp.com
b. Click on Support & Drivers
c. Select Drivers & Software
d. In the search box, type HP Array Configuration Utility
e. Select the operating system of the client machine that will be used to remotely access the
machine running ESXi 5.0 and updates.
f. Under the Software – System Management menu, proceed to download the HP ProLiant
Array Diagnostics and SmartSSD Wear Gauge Utility by clicking on it’s link.
NOTE:The desired version is 9.x or newer.
g. Install the Windows component or Linux RPM package onto the client machine
2.Note the location where the package has installed the included applications and then update
your system path to include this location.
3.The client machine used to access the remote ESXi 5.0 and updates machine must also have
the vSphere CLI esxcli command line tool installed and must be accessible through the
system path. Ensure that the client machine location is included in the path.
4.Use the following tool and associated command-line parameters to perform the creation and
retrieval of the report:
The hpaduesxi application uses the supplied parameters to remotely obtain the report from your
target ESXi 5.0 and updates machine and saves the data into the target zip file. The zip file can
then be opened with any third-party zip application or with the unzip command under Linux.
The hpaduesxi application also contains onboard help which can be obtained by typing hpaduesxi
with no parameters.
Generating an ADU report (diagnostics) from within HPACUCLI for ESXi 5.0 and updates13
Page 14
2 Support and other resources
This chapter provides information about the contact details and reference documents.
Contacting HP
This section provides information about the prerequisites to be verified before contacting HP and
mechanism supported by the organization for sharing the feedback.
Before you contact HP
Be sure to have the following information available before you call contact HP:
•Technical support registration number (if applicable)
•Product serial number
•Product model name and number
•Product identification number
•Applicable error message
•Add-on boards or hardware
•Third-party hardware or software
•Operating system type and revision level
HP contact information
For the name of the nearest HP authorized reseller:
•See the Contact HP worldwide (in English) webpage (http://welcome.hp.com/country/us/
en/wwcontact.html).
For HP technical support:
•In the United States, for contact options see the Contact HP United States webpage (http://
welcome.hp.com/country/us/en/contact_us.html). To contact HP by phone:
◦Call 1-800-HP-INVENT (1-800-474-6836). This service is available 24 hours a day, 7
days a week. For continuous quality improvement, calls may be recorded or monitored.
◦If you have purchased a Care Pack (service upgrade), call 1-800-633-3600. For more
information about Care Packs, refer to the HP website (http://www.hp.com/hps).
◦In other locations, see the Contact HP worldwide (in English) webpage (http://
welcome.hp.com/country/us/en/wwcontact.html)
Subscription service
HP recommends that you register your product at the Subscriber's Choice for Business website:
http://www.hp.com/country/us/en/contact_us.html After registering, you will receive email
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 docsfeedback@hp.com. Include the document title and manufacturing part
number. All submissions become the property of HP.
14Support and other resources
Page 15
New and changed information in this edition
Current edition of the document provides information about the HPACUCLI utility supported on the
ESXi version 5.0 and updates platform.
Related information
Following documents and websites provide related information:
Documents
Following documents are supported for the product:
•HP VMware ESXi 5.0 Release Notes
•HP VMware ESXi 5.0 and Updates Getting Started Guide
•HP Insight Management WBEM Providers for HP integrated VMware ESXi Data Sheet
Websites
HP documents regarding VMware are available at the following location:
This document uses the following typographical conventions:
%, $, or #A percent sign represents the C shell system prompt. A dollar sign
represents the system prompt for the Bourne, Korn, and POSIX
shells. A number sign represents the superuser prompt.
audit(5)A manpage. The manpage name is audit, and it is located in
Section 5.
CommandA command name or qualified command phrase.
Computer outputText displayed by the computer.
Ctrl+xA key sequence. A sequence such as Ctrl+x indicates that you
must hold down the key labeled Ctrl while you press another key
or mouse button.
ENVIRONMENT VARIABLEThe name of an environment variable, for example, PATH.
ERROR NAMEThe name of an error, usually returned in the errno variable.
KeyThe name of a keyboard key. Return and Enter both refer to the
same key.
TermThe defined use of an important word or phrase.
User inputCommands and other text that you type.
VariableThe name of a placeholder in a command, function, or other
syntax display that you replace with an actual value.
[]The contents are optional in syntax. If the contents are a list
separated by |, you must choose one of the items.
{}The contents are required in syntax. If the contents are a list
separated by |, you must choose one of the items.
...The preceding element can be repeated an arbitrary number of
times.
Indicates the continuation of a code example.
|Separates items in a list of choices.
New and changed information in this edition15
Page 16
WARNINGA warning calls attention to important information that if not
understood or followed will result in personal injury or
nonrecoverable system problems.
CAUTIONA caution calls attention to important information that if not
understood or followed will result in data loss, data corruption,
or damage to hardware or software.
IMPORTANTThis alert provides essential information to explain a concept or
to complete a task
NOTEA note contains additional information to emphasize or supplement
important points of the main text.
16Support and other resources
Page 17
Index
D
document
related documentation, 15
R
related documentation, 15
17
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.