.\" ."This file created December 2007
.\"
.TH "HARDWARE_INFO" "l" "January 2008" " " "Platform Commands"
.SH "NAME"
hardware_info \- Display the server hardware capabilities of a server
.br
Version 1.3.3 (October 2010)
.SH "SYNOPSIS"
.B hardware_info [ \-v ]
.br
.B hardware_info \-w [ \-D <delimiter> ] [ \-v ]
.br
.B hardware_info \-W <keyword> [ \-v ]
.br
.B hardware_info \-l [ \-v ]
.br
.B hardware_info \-h | \-?
.br
.SH "DESCRIPTION"
This script is used to display the server hardware capabilities of a server.

This information is displayed for each server
.br
\- Product name
.br
\- BIOS version
.br
\- RAM: size of the physical RAM
.br
\- CPU: Number of installed processors, type for each processor
.br
\- Disk: Disk devices, type (HDD, SSD), manufacturer,
        model number, serial number and interface
.br
\- CD/DVD: Optical devices, vendor, model number, interface

Depending on the hardware capabilities of the server the following
information is displayed.

\- RAID: Size, manufacturer, model number, serial number of each
        physical disk drive
.br
\- DAL1/2 card memory size
.br
\- SAMP type and serial number
.br
\- Number of power supply
.br
\- BMC availability and firmware revision

In verbose mode it also shows
.br
\- USB: Vendor and product name of USB devices
       like memory sticks, CDROMs, modems.

.SH "OPTIONS"
Valid command line options
.br
 \-h, \-?: Display help message
 \-v: Verbose output
 \-w: Display information formatted for string extraction
 \-l: List valid keywords for -W
 \-W <keyword>: Display only one data record, depending on <keyword>
 \-D <delimiter>: User defined <delimiter> instead of the default
                 delimiter % (use with \-w)
.SH "OUTPUT FORMATS"
hardware_info provides three output formats: Screen output for human readers,
machine output for further processing by other programs (string extraction),
and a particular value to reduce execution time.
.SH "SCREEN OUTPUT"
The screen output is formatted to provide people a overview of the system
.SH "MACHINE OUTPUT"
The machine output is activated with the option \-w. It displays one
information record per line using the formatting
\fB<keyword><delimiter><value>\fR.

The \fBkeyword\fR is a unique string to identify the data record.
(See section KEYWORDS for a list of available keywords or use option \-l.)

The default \fBdelimiter\fR is '%'. With the option \-D <delimiter> it can be
changed to any user defined character.

The \fBvalue\fR is the information about the server

The RAM and disk size is available in the binary units B, KiB, MiB, GiB and
the decimal units KB, MB, GB.

The verbose information (USB) is also available without the option "-v".

.SH "PARTICULAR VALUE"
If only a particular value is required, the option \-W <keyword> can be used.
<keyword> must be exact one keyword from the machine output.
It is not case sensitive. hardware_info displays the <value> from the machine
output without any surrounding characters and without a linefeed.
This significantly reduces the execution time, because only the requested
data is generated.
.SH "KEYWORDS"
All possible keywords used by hardware_info. The index _n is increased depending
on the actual number of components. Use the option -l to get a list of
keywords available on the current server

PRODUCT_MANUFACTURER
.br
PRODUCT_NAME
.br
BIOS_VERSION
.br
BIOS_RELEASE_DATE
.br
RAM_PHYSICAL_B
.br
RAM_PHYSICAL_KB
.br
RAM_PHYSICAL_MB
.br
RAM_PHYSICAL_GB
.br
RAM_PHYSICAL_KIB
.br
RAM_PHYSICAL_MIB
.br
RAM_PHYSICAL_GIB
.br
CPU_NUMBER
.br
CPU_MODEL_0
.br
DISK_DEVICE_LIST
.br
DISK_DEVICE_0
.br
DISK_TYPE_0
.br
DISK_INTERFACE_0
.br
DISK_SIZE_B_0
.br
DISK_SIZE_KB_0
.br
DISK_SIZE_MB_0
.br
DISK_SIZE_GB_0
.br
DISK_SIZE_KIB_0
.br
DISK_SIZE_MIB_0
.br
DISK_SIZE_GIB_0
.br
DISK_MODEL_0
.br
DISK_SERIAL_0
.br
CD_DEVICE_LIST
.br
CD_DEVICE_0
.br
CD_INTERFACE_0
.br
CD_VENDOR_0
.br
CD_MODEL_0
.br
BMC_AVAILABLE
.br
BMC_FIRMWARE_REVISION
.br
SAMP_TYPE
.br
SAMP_SERIAL
.br
POWER_DEVICES
.br
USB_DEVICES_NUMBER
.br
USB_BUS_0
.br
USB_DEVICE_0
.br
USB_VENDOR_0
.br
USB_PRODUCT_1

