HP Vmware Utilities User Guide: Vmware Vsphere 5.5 For September 2013
HP Vmware Utilities User Guide: Vmware Vsphere 5.5 For September 2013
HP Vmware Utilities User Guide: Vmware Vsphere 5.5 For September 2013
Contents 3
1 Introduction
This section provides information about the utilities supported on VMware vSphere 5.5 and updates.
The following utilities are supported on VMware vSphere 5.5 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.
Installing offline bundles on an vSphere 5.5 and updates host using vSphere
CLI 5.0 esxcli utility
This section provides information about installing the VMware vSphere 5.5 updates offline bundles
on the vSphere 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 vSphere 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 vSphere host local path, or extract it onto an online depot.
3. Install the bundle on the vSphere 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 vSphere host
~# esxcli -s <server> -u root -p mypassword software vib install
-d <vSphere local path><bundle.zip>
• Install from vSphere host, with offline bundle available on vSphere host
~# esxcli software vib install -d <vSphere local path><bundle.zip>
4. After the bundle is installed, reboot the vSphere host to initialize the utilities.
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 vSphere Server Support Matrix. To
visit the vSphere 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
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
Argument Function
-a, --all This argument captures complete Management Processor configuration to the
file. This option should be used along with the "-w" option.
-i --input This argument Get/Set Management Processor Configuration from the XML
input received through the standard input stream.
-s,--substitute This argument substitutes variables present in the input configuration file with
the values specified in "namevaluepairs".
-f, - -file=filename This argument sets the iLO 2, iLO 3 or iLO 4 configuration based on the
information in the XML input file named filename.
-l, - -log=filename This argument logs replies to the text log file named filename.
-v, - -xmlverbose Writes all the responses from iLO 2, iLO 3 or iLO 4.
-g, - -get_hostinfo This argument returns the host server name and serial number.
-m, - -minfwlevel 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)
Argument Function
-r, - -reset This argument resets the iLO 2, iLO 3 or iLO 4 to factory defaults.
0 Script succeeded.
1 Script failed
7 You are not a root/superuser. Only root/superuser can access the utility.
If the script itself fails, errors are reported in the log file created by HPONCFG.
<HPONCFG VERSION="1.1">
<!–Generated 04/15/04 15:20:36—>
6 Introduction
<MOD_DIR_CONFIG>
<DIR_AUTHENTICATION_ENABLED VALUE="N" />
<DIR_LOCAL_USER_ACCT VALUE="Y" />
<DIR_SERVER_ADDRESS VALUE=""/>
<DIR_SERVER_PORT VALUE="25"/>
<DIR_OBJECT_DN VALUE=" "/>
<DIR_OBJECT_PASSWORD VALUE=""/>
<DIR_USER_CONTEXT_1 VALUE=""/>
<DIR_USER_CONTEXT_2 VALUE="_"/>
<DIR_USER_CONTEXT_3 VALUE=""/>
</MOD_DIR_CONFIG>
<MOD_NETWORK_SETTINGS>
<SPEED_AUTOSELECT VALUE="Y"/>
<NIC_SPEED VALUE="100"/>
<FULL_DUPLEX VALUE="Y"/>
<IP_ADDRESS VALUE="XX.XXX.XXX.XX"/>
<SUBNET_MASK VALUE="xxx.xxx.xxx.x"/>
<GATEWAY_IP_ADDRESS VALUE="XX.XXX.XXX.X"/>
<DNS_NAME VALUE="ILOD234KJ44D002"/>
<PRIM_DNS_SERVER value="xx.xx.x.xxx"/>
<DHCP_ENABLE VALUE="Y"/>
<DOMAIN_NAME VALUE="americas.cpqcorp.net"/>
<DHCP_GATEWAY VALUE="Y"/>
<DHCP_DNS_SERVER VALUE="Y"/>
<DHCP_STATIC_ROUTE VALUE="Y"/>
<DHCP_WINS_SERVER VALUE="Y"/>
<REG_WINS_SERVER VALUE="Y"/>
<PRIM_WINS_SERVER value="xx.xx.x.xxx"/>
<STATIC_ROUTE_1 DEST="0.0.0.0" GATEWAY="0.0.0.0"/>
<STATIC_ROUTE_2 DEST="0.0.0.0" GATEWAY="0.0.0.0"/>
<STATIC_ROUTE_3 DEST="0.0.0.0" GATEWAY="0.0.0.0"/>
</MOD_NETWORK_SETTINGS>
<ADD_USER
USER_NAME="Administrator"
USER_LOGIN="Administrator"
PASSWORD="">
</ADD_USER>
<ADD_USER
USER_NAME="Landy9"
USER_LOGIN="mandy9"
PASSWORD="">
</ADD_USER>
<RESET_RIB VALUE="Y"/>
</HPONCFG>
For security reasons, the user passwords are not returned.
HPONCFG utility 7
The requested information is returned in the log file, which, in this example, is named log.txt.
The contents of the log file are shown below:
<GET_GLOBAL_SETTINGS>
<SESSION_TIMEOUT VALUE="30"/>
<ILO_FUNCT_ENABLED VALUE="Y"/>
<F8_PROMPT_ENABLED VALUE="Y"/>
<REMOTE_CONSOLE_PORT_STATUS VALUE="3"/>
<REMOTE_CONSOLE_ENCRYPTION VALUE="N"/>
<PREFER_TERMINAL_SERVICES VALUE="N"/>
<HTTPS_PORT VALUE="443"/>
<HTTP_PORT VALUE="80"/>
<REMOTE_CONSOLE_PORT VALUE="23"/>
<TERMINAL_SERVICES_PORT VALUE="3389"/>
<VIRTUAL_MEDIA_PORT VALUE="17988"/>
<MIN_PASSWORD VALUE="4"/>
</GET_GLOBAL_SETTINGS>
Setting a configuration
A specific configuration can be sent to the iLO 2, iLO 3 or iLO 4 by using the command format:
/opt/hp/tools # ./hponcfg -f add_user.xml -l log.txt
In this example, the input file has contents:
<!–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>
</USER_INFO>
</LOGIN>
</RIBCL>
The specified user will be added to the device.
hponcfg -g This argument returns the host server name and serial number.
8 Introduction
/opt/hp/tools # ./hponcfg —m 2
The following output is displayed:
HPBOOTCFG utility
The hpbootcfg 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 vSphere Server Support Matrix. To
visit the vSphere Server Matrix page, go to www.hp.com/go/vmware and select Certified ProLiants
under Tools/Resource section.
This utility allows an application to set the device for the next subsequent boot of the system.
-F Sets Floppy Drive as the first boot device for the system boot
-C Sets CD-ROM Drive as the first boot device for the system boot
-H Sets Hard Drive as the first boot device for the system boot
-T Sets Tape Drive as the first boot device for the system boot
-S Sets system configuration utility as the boot device for the current boot
-Q Sets quick configuration utility as the boot device for the current boot
-R Sets ROM-Based Setup Utility (RBSU) as the boot device for the current boot
-P Sets PXE client as the boot device for the current boot
-r Sets remote configuration as the boot device for the current boot
-d Sets remote dial out as the boot device for the current boot
-n Sets remote network as the boot device for the current boot
-b Bypasses F1 / F2 prompts
HPBOOTCFG utility 9
The following output is displayed:
0 Indicates success
HPSSACLI utility
The HPSSACLI 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
Array Controllers Reference Guide available at:http://h20000.www2.hp.com/bc/docs/support/
SupportManual/c00729544/c00729544.pdf.
Additional references to HP Smart Storage Administrator guides and white papers are available
at:
http://h20000.www2.hp.com/bizsupport/TechSupport/DocumentIndex.jsp?lang=en&cc=us&
contentType=SupportManual&prodTypeId=18964&prodSeriesId=468780&docIndexId=64179.
10 Introduction
Table 7 HPSSACLI Command-Line Arguments
Argument Function
namespace Each plugin must have an associated namespace which defines any environment or other system
variables required by the application.
object A plugin must have one or more associated objects which defines a single operation.
cmd options Additional switches associated with the command itself (if necessary).
“command-string” This is the string which dictates the operation that should be executed by the target application itself.
The current namespace and command names are: hpssacli and cmd respectively. The {cmd
options} parameter can be cmdopts or -q. There is no need for an {object} type for
hpssacli since the application operates on internal commands supplied in the command-string.
Example 1 This example shows the information about all the SmartArray controller on the server.
Example 2 This example shows the detailed configuration information for the SmartArray controller
in slot 0.
HPSSACLI utility 11
Firmware Version: 3.70
Rebuild Priority: Medium
Expand Priority: Medium
Surface Scan Delay: 15 secs
Surface Scan Mode: Idle
Queue Depth: Automatic
Monitor and Performance Delay: 60 min
Elevator Sort: Enabled
Degraded Performance Optimization: Disabled
Inconsistency Repair Policy: Disabled
Wait for Cache Room: Disabled
Surface Analysis Inconsistency Notification: Disabled
Post Prompt Timeout: 0 secs
Cache Board Present: True
Cache Status: OK
Accelerator Ratio: 25% Read / 75% Write
Drive Write Cache: Disabled
Total Cache Size: 1024 MB
Total Cache Memory Available: 912 MB
No-Battery Write Cache: Disabled
Cache Backup Power Source: Capacitors
Battery/Capacitor Count: 1
Battery/Capacitor Status: OK
SATA NCQ Supported: True
Array: A
Interface Type: SAS
Unused Space: 0 MB
Status: OK
Logical Drive: 1
Size: 136.7 GB
Fault Tolerance: RAID 1
Heads: 255
Sectors Per Track: 32
Cylinders: 35132
Strip Size: 256 KB
Full Stripe Size: 256 KB
Status: OK
Array Accelerator: Enabled
Unique Identifier: 600508B1001CB65083D63C5E781ABF65
Disk Name: vmhba2:C0:T0:L1
Mount Points: None
Logical Drive Label: A00D1AF35001438013A25C90F0BA
Mirror Group 0:
physicaldrive 1I:1:1 (port 1I:box 1:bay 1, SAS, 146 GB, OK)
Mirror Group 1:
physicaldrive 1I:1:2 (port 1I:box 1:bay 2, SAS, 146 GB, OK)
physicaldrive 1I:1:1
Port: 1I
Box: 1
Bay: 1
Status: OK
Drive Type: Data Drive
Interface Type: SAS
Size: 146 GB
12 Introduction
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
unassigned
physicaldrive 1I:1:3
Port: 1I
Box: 1
Bay: 3
Status: OK
Drive Type: Unassigned Drive
Interface Type: SAS
Size: 146 GB
Rotational Speed: 10000
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 HPSSACLI command. Commands
and options for additional operations using the HPSSACLI, such as creating a logical drive, are
documented in the Configuring Arrays on HP Smart Array Controllers Reference Guide.
HPTESTEVENT utility
The hptestevent utility allows an application to request, so that 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.
The HP Insight Management WBEM Providers must be installed, enabled and running on the system
where this utility is executed. The WBEM Providers must be configured to send indications to the
listener. VMware SNMP traps must be enabled and configured to use WBEM indications as a
source for SNMP traps.
The Informational Test Indication and the CPQ Test SNMP trap will be sent to any listener configured
to receive indications from the system.
See the HP Insight Management WBEM Provider Datasheets for information on the test indication,
and the SNMP Data Migration Guide for information on the test SNMP trap on the BSC (Business
Support Center).
HPTESTEVENT utility 13
There are no command options for the hptestevent utility.
0 Indicates success
3 Request failed, couldn't determine if HP WBEM Providers are installed and running. No test
event will be generated.
4 Request failed, HP WBEM Providers are not installed and running. No test event will be
generated.
14 Introduction
1. Obtain and install the HP Smart Storage Administrator Diagnostics Utility (HP SSADU) CLI:
1. Browse to http://www.hp.com
2. Click on Support & Drivers
3. Select Drivers & Software
4. In the search box, type HP Smart Storage Administrator Utility
5. Select the operating system of the client machine that will be used to remotely access the
machine running vSphere 5.5 and updates.
6. Under the Software – System Management menu, proceed to download the HP Smart
Storage Administrator Diagnostics Utility (HP SSADU) CLI by clicking on the link.
7. Install the Windows component or Linux RPM package onto the client machine.
2. 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 vSphere 5.5 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:
hpssaduesxi --server=<server_ip_address> --user=<username>
--password=<password> <targetfile.zip>
Example Usage:
hpssaduesxi --server=10.12.132.5 --user=root --password=root.123
myreport.zip
The hpssaduesxi application uses the supplied parameters to remotely obtain the report from your
target vSphere 5.5 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 hpssaduesxi application also contains onboard help which can be obtained by typing
hpssaduesxi with no parameters.
Generating an ADU report (diagnostics) from within HPSSACLI for vSphere 5.5 and updates 15
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.
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 [email protected]. Include the document title and manufacturing part
number. All submissions become the property of HP.
Related information
Following documents and websites provide related information:
Documents
Following documents are supported for the product:
• HP VMware vSphere 5.1 Release Notes
• HP VMware vSphere 5.1 and updates Getting Started Guide
Websites
HP documents regarding VMware are available at the following location:
https://h20392.www2.hp.com/portal/swdepot/searchProducts.do.
Typographic conventions
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.
Command A command name or qualified command phrase.
Computer output Text displayed by the computer.
Ctrl+x A 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 VARIABLE The name of an environment variable, for example, PATH.
ERROR NAME The name of an error, usually returned in the errno variable.
Key The name of a keyboard key. Return and Enter both refer to the
same key.
Term The defined use of an important word or phrase.
User input Commands and other text that you type.
Variable The 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.
R
related documentation, 17
19