Asu Guide
Asu Guide
User’s Guide
Advanced Settings Utility
Version 3.60
User’s Guide
Note: Before using this information and the product it supports, read the general information in Appendix B, “Notices,” on page 97.
Appendix B. Notices . . . . . . . . . . . . . . . . . . . . . . 97
Trademarks . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Important notes. . . . . . . . . . . . . . . . . . . . . . . . . 98
Documentation format . . . . . . . . . . . . . . . . . . . . . . 99
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
For a list of the ASU commands and their descriptions, see Chapter 3, “Command
reference,” on page 41.
Note: Throughout this document, the term Remote Supervisor Adapter II refers to
both the IBM Remote Supervisor Adapter II and the IBM Remote Supervisor
Adapter II SlimLine, unless otherwise noted.
Note: The PC-DOS version of the ASU supports BIOS settings only.
To support the settings of the previously listed firmware types, the following types of
settings are supported:
v Banked CMOS at 70h/71h (NS317)
v CMOS at 70h/71h and 72h/73h (NS417)
v CMOS at 72h/73h (AMD 8111)
v CMOS through baseboard management controller
v Serial EEPROM settings
v The following Remote Supervisor Adapter and Remote Supervisor Adapter II
commands:
– 8-bit values
– 16-bit values
– IP address values (32 bits)
– Strings
– Keystroke sequences
– Certificate
– Port
v The following baseboard management controller commands:
– 8-bit values
– 8-bit value within a block
– IP address values (32 bits)
– MAC address values (48 bits)
– Strings
v Single and multi-node systems
The ASU retrieves and modifies user settings from the supported firmware types
through its command-line interface. The ASU does not update any of the firmware
code.
Operating-system support
The following operating systems (32-bit and 64-bit) support the ASU.
Note: For the latest information about IBM servers, workstations, and the operating
systems that are supported, see http://www.ibm.com/servers/eserver/
serverproven/compat/us/.
v Microsoft® Windows® 2000, Windows XP, Windows Server 2003, Windows Server
2003 R2, Windows Server 2008, Windows Server 2008 R2, and Windows Vista™
Note: For the Windows operating system, you must have administrator
privileges. For more information about using the ASU in the Windows
operating system, see the readme file that is extracted when you extract
the ASU package.
v Microsoft Windows PE 1.6, Windows PE 2.0, and Windows PE 2.1
For BIOS-based servers, run the ASU on the system that contains the settings that
you want to view and change. When the ASU performs setting configuration, it
interacts with the physical hardware. On operating systems that require root or
administrator access to interact with physical hardware, you must run the ASU from
an account that has root or administrator access. (Windows and Linux require root
and administrator access.)
The Remote Supervisor Adapter device drivers and Remote Supervisor Adapter II
USB daemon are used to view and change Remote Supervisor Adapter or Remote
Supervisor Adapter II settings. If there is no Remote Supervisor Adapter or Remote
Supervisor Adapter II device driver for an operating system (such as PC-DOS), the
ASU does not support changing Remote Supervisor Adapter or Remote Supervisor
Adapter II settings for that operating system.
Windows PE support
Windows PE requires some special considerations for the ASU to function correctly.
These considerations are different for Windows PE 1.6 or earlier and Windows PE
2.0 (the version that is based on the Windows Vista operating system) or later.
Windows PE 1.6 or earlier (the Windows PE versions that are based on Windows
XP and Windows Server 2003) do not have temporary file storage, which affects
how you extract the device driver from the ASU executable file.
The Windows PE 1.6 or earlier versions also cannot recognize new USB devices
after startup, which affects the behavior of the Remote Supervisor Adapter II reset
and restart commands.
If the ASU is unable to extract the device driver to a temporary directory, it attempts
to load the device driver from the directory where the executable file is located. If
If you are running the ASU from nonwriteable media (such as a CD), the device
driver must exist on the media. You can manually extract it from the ASU
executable file (and then copy it onto the nonwriteable media) by running the
following command from a writeable media that contains the ASU:
The device driver is extracted as wflash.sys into the directory that contains the
executable file. Then, you can copy the device driver (together with the ASU
executable file) to nonwriteable media such as a bootable Windows PE CD.
Windows PE 2.0 has an integrated Microsoft IPMI device driver, and the ASU 2.3.0
or later has an embedded mapping layer that supports that driver. Therefore, no
user-installed IPMI driver or mapping layer is required. For more information about
the IPMI device-driver support in Windows PE 2.0, see “IPMI device driver support
for Windows” on page 7.
Note: The IMM-based servers do not require any type of patch; the settings
definitions are included with the IMM firmware and the IBM System x Server
Firmware.
For requirements and implementation details for applying BIOS patches to the ASU,
see “Obtaining the ASU and patch files” on page 9 and “Using ASU patches” on
page 10.
The ASU supports the following systems that do not require an externally applied
BIOS patch:
v IBM xSeries 366 Type 8863
v IBM xSeries MXE 460 Type 8874
v IBM System x3200 Types 4362 and 4363
v IBM System x3200 M2 Types 4367 and 4368
v IBM System x3200 M3 Types 7327 and 7328
v IBM System x3250 M2 Types 4190, 4191, and 4194
v IBM System x3250 M3 Types 4251, 4252, and 4261
v IBM System x3350 Types 4192 and 4193
v IBM System x3400 Types 7973, 7974, 7975, and 7976
v IBM System x3400 M2 Types 3808, 3809, 3815, 3817, 7836 and 7837
v IBM System x3400 M3 Types 7378 and 7379
v IBM System x3455 Types 7940 and 7941
v IBM System x3500 Type 7977
v IBM System x3500 M2 Type 3821, 3822, and 7839
v IBM System x3500 M3 Type 7380
v IBM System x3550 Types 1913 and 7978
v IBM System x3550 M2 Type 7946
v IBM System x3550 M3 Type 4254 and 7944
v IBM System x3620 M3 Type 7376
v IBM System x3650 Types 1914 and 7979
v IBM System x3650 M2 Type 7947
v IBM System x3650 M3 Type 4255 and 7945
v IBM System x3655 Types 7943 and 7985
v IBM System x3690 X5 Type 7148
v IBM System x3755 Types 7163 and 8867
v IBM System x3800 Types 8865 and 8866
v IBM System x3850 Types 7362, 7365, 8863, and 8864
v IBM System x3850 M2 Types 7141, 7144, and 7234
v IBM System x3850 X5 Types 7145 and 7146
The ASU supports the following systems that require an externally applied BIOS
patch:
v IBM eServer 326m Types 7969 and 7992
v IBM xSeries 206m Types 8485 and 8490
v IBM xSeries 236 Type 8841
v IBM xSeries 260 Type 8865
v IBM xSeries 306m Types 1887, 8491, and 8849
v IBM xSeries 346 Types 1880 and 8840
v IBM System x3250 Types 4364, 4365, and 4366
v IBM System x3455 Types 7984 and 7986
v IBM BladeCenter HC10 Type 7996
v IBM BladeCenter HS20 Types 1883 and 7981
v IBM IntelliStation A Pro Types 6217 and 6224
v IBM IntelliStation M Pro Types 6218, 6225, 6228, 9229, 9230, 9236, and 9237
v IBM IntelliStation Z Pro Types 6223, 9228, and 9232
The Microsoft IPMI device driver is automatically installed with Windows Server
2008 and Windows PE 2.0 or later. However, it is not installed by default with
Microsoft Windows Server 2003 R2. To install the Microsoft IPMI device driver,
complete the following steps:
1. Click Start → Control Panel → Add/Remove Programs.
2. Click Add/Remove Windows Components.
3. From the component list, select Management and Monitoring Tools, and then
click Details.
4. Select Hardware Management.
5. Click Next. The installation wizard opens and guides you through the
installation. The Windows Server 2003 R2 installation disk is required.
To verify that the Microsoft IPMI device driver is installed, complete the following
steps:
1. Click Start → Control Panel → System.
2. Click the Hardware tab.
3. Click Device Manager.
4. Click View → Show Hidden Devices.
5. Expand System devices.
6. If the Microsoft IPMI device driver is installed correctly, a device named
Microsoft Generic IPMI Compliant Device is displayed under System
devices. For a multi-node configuration, a device named Microsoft Generic
IPMI Compliant Device is created for each node.
Note: Changes are made periodically to the IBM Web site. Procedures for locating
firmware and documentation might vary slightly from what is described in this
document.
To locate and download the files that you need, complete the following steps:
1. To download the IBM Advanced Settings Utility, go to http://www-947.ibm.com/
systems/support/supportsite.wss/docdisplay?lndocid=TOOL-ASU
&brandind=5000016 or complete the following steps:
a. Go to http://www.ibm.com/systems/support/.
b. In the left pane, click Systems Management software.
c. Under Popular links, click Tools and utilities.
d. Under Configuration, click Advanced Settings Utility.
2. (For BIOS-based servers only) To download the BIOS definition file, complete
the following steps:
a. On the Support page for the server, select Software and device drivers.
b. On the “Software and device drivers” page, click BIOS.
c. Select BIOS definition file for use with IBM Advanced Setting Utility.
(The BIOS definition file must match the BIOS level that the server is
running.)
d. Select the ASU BIOS definition .exe file.
e. Follow the instructions that guide you through the download process.
3. (For BIOS-based servers only) After you download the BIOS definition file (if
needed), return to the “Software and device drivers” page to install the
device-driver software for the Remote Supervisor Adapter II and baseboard
management controller.
4. Download the IPMI device driver only if required. The IPMI device driver is not
required in Windows 2003 R2, Windows 2008, and Linux operating systems that
support OpenIPMI. For more information, see “IPMI device driver support for
Windows” on page 7 or “IPMI device driver support for Linux” on page 8. On the
“Software and device drivers” page, click OSA IPMI, and then select the
applicable device-driver file. Read the .txt file and follow the instructions that
guide you through the download process.
Starting with ASU 2.0, the ASU contains the baseboard management controller and
Remote Supervisor Adapter II patches. Depending on the server model and BIOS
level, a BIOS code patch might be required. For a list of servers that require a
BIOS patch file, see “Supported systems” on page 6. For the systems that do not
require a BIOS patch file, the BIOS patch is embedded in the BIOS ROM. If the
BIOS patch is required, you must download the BIOS patch (definition file) from the
IBM Web site and add it to the ASU (only if you are required to perform an ASU
command by using the BIOS settings).
To determine whether the BIOS patch is already available for the ASU, issue the
ASU patchlist command to display the current available patches. If the ASU
determines that a BIOS patch file is embedded in the BIOS, it displays the BIOS
patch files that are available (see the following example).
Example of ASU output when the patchlist command is issued with the BIOS patch
not listed:
Patch 1: <XX[00->99] (BMC)>
Patch 2: <XX[00->99] (RSA)>
Example of ASU output when the patchlist command is issued with the BIOS patch
listed:
Patch 1: <XX[00->99] (BMC)>
Patch 2: <XX[00->99] (RSA)>
Patch 3: <DO[14->14] (BIOS)>
If the BIOS patch is not listed, you must add the patch before you can change or
view BIOS settings. You can either add or remove a patch from the ASU.
If a BIOS patch is needed and is not listed when you issue the patchlist command,
you can download the selected BIOS definition file (patch file) from the IBM Web
site and perform a patch add, using the ASU.
When you run the ASU, it automatically scans the patches that are available and
determines whether the applicable patch exists for the setting that you want. If an
applicable patch exists, the ASU applies the setting. If the patch does not exist, the
ASU returns an error.
A patch that is added remains until you run the patchremove command on that
patch.
Notes:
1. You cannot remove the BIOS patches that are embedded in the BIOS ROM by
running the patchremove command.
2. Only one patch is supported for any major version of BIOS. For example, if
there are BIOS versions 19A and 19B, only one patch is supported for both.
Note: Be sure to install the Remote Supervisor Adapter device drivers or Remote
Supervisor Adapter II USB daemon before you use the ASU. To install the
device drivers, see the IBM Remote Supervisor Adapter II Installation
Instructions for Microsoft Windows Users or IBM Remote Supervisor Adapter
II Installation Instructions for Linux Users, which are available at
http://www.ibm.com/systems/support/.
For detailed information about using the Remote Supervisor Adapter II Web
interface for remote access, see the IBM Remote Supervisor Adapter II User’s
Guide.
You can use the ASU to configure the Remote Supervisor Adapter II Ethernet
settings.
If you have an enabled DHCP server and you want to configure the serial
connector, go to “Example of configuring the serial connection on a Remote
Supervisor Adapter II.”
To configure the Ethernet settings if you do not have a DHCP server on your
network, complete the following steps.
Note: If you are using a Linux operating system, be sure to type ./ before asu.
1. If you have not already done so, unpack the ASU files. For more information,
see “Unpacking the ASU files for Windows” on page 11 or “Unpacking the ASU
files for Linux” on page 12.
2. At the command prompt, change to the directory that contains the ASU files.
3. If you have not already done so, add the Remote Supervisor Adapter/Remote
Supervisor Adapter II ASU patch. For more information, see “Patchadd
command” on page 63 and “Patchlist command” on page 65.
Note: This step is not required if you are using ASU version 2.0 or later.
4. To view a list of all settings and their assigned values, type the following
command and press Enter:
asu show all
5. From the following list, select the items that you want to set:
v To enable the network interface on the Remote Supervisor Adapter II, type
the following command and press Enter:
asu set RSA_Network1 Enabled
v To set the IP address, type the following command and press Enter:
asu set RSA_HostIPAddress1 192.169.70.140
v To set the subnet mask, type the following command and press Enter:
asu set RSA_HostIPSubnet1 255.255.255.0.
v To set the gateway IP address, type the following command and press Enter:
asu set RSA_GatewayIPAddress1 192.168.70.1
v To enable DHCP, type the following command and press Enter:
asu set RSA_DHCP1 Enabled
v To set the data-transfer rate, type the following command and press Enter:
asu set RSA_LANDataRate1 "10M Ethernet"
v To set duplex mode, type the following command and press Enter:
asu set RSA_Duplex1 Full
6. Type asu rebootrsa and press Enter.
Note: If you are using a Linux operating system, be sure to type ./ before asu.
Note: Make sure that the baud rate matches the baud rate of the device that
you are connecting to the serial connector on the Remote Supervisor
Adapter II.
v To change the modem parity, type the following command and press Enter:
asu set RSA_ModemParity1 value
where value is None, Odd, Even, Mark, or Space. The default is None.
v To change modem stop bits, type the following command and press Enter:
asu set RSA_ModemStopBits1 value
where value is either 1 or 2. The default is 1.
5. Type asu rebootrsa and press Enter.
The following sections describe the functions that are available to support
IMM-based servers with the ASU version 3.00 or later.
Connectivity
In IMM-based servers, all firmware settings are configured through the IMM. The
ASU can connect to the IMM locally (in-band) through the Keyboard Controller Style
(KCS) interface or through the LAN over USB interface. The ASU can also connect
remotely over the LAN.
The IMM comes with a LAN over USB interface that can be configured and
activated on the running operating system. After you install and configure the
corresponding information file, the ASU can be connected to the IMM. The local
The local connection over the KCS interface does not require authentication and
follows the online connecting model and command structure of BIOS-based servers,
where no connectivity parameters are required. If you do not specify any
connectivity parameters, the ASU attempts to connect to the IMM by using default
LAN settings on the LAN over USB interface. If the ASU is unable to connect to the
IMM over the LAN, it automatically connects over the KCS interface, provided that
the correct IPMI device drivers or mapping layers are installed. For more
information about the KCS interface, see the Intelligent Platform Management
Interface Specification.
In the following example, the ASU attempts to connect through the LAN over USB
interface. If the LAN over USB interface connection has failed, the ASU attempts to
connect through the KCS interface.
asu show
You can request that the ASU connect locally, exclusively using the KCS interface,
which avoids the automated connection over the LAN over USB interface (and the
fallback to the KCS interface). If you use the --kcs option, the ASU communicates
through the KCS interface only. In the following example, the ASU attempts to
connect through the KCS interface only, without the need for authentication
parameters.
asu show --kcs
You can also request that the ASU connect locally, exclusively using the LAN over
USB interface, by specifying the --host connectivity option. The ASU does not
attempt to fall back to use the KCS interface when this option is specified. In the
following example, the ASU attempts to connect through the LAN over USB
interface only by using the default user ID and password account.
asu show --host 169.254.95.118
When the ASU runs any command on an IMM-based server, it attempts to connect
and automatically configure the LAN over USB interface, if it detects that this
interface is not configured. The ASU provides a level of automatic and default
settings. You have the option of specifying that the automatic configuration process
is skipped, if you have manually configured the IMM LAN over USB interface by
using different settings than those used by the ASU application default settings.
You can use the --noimmlancfg option to skip automatic configuration process, if
you have manually configured the interface. For example, if you want to show the
IMM list of settings and avoid using the automatic configuration process when you
attempt to connect through the LAN over USB interface, type the following
command:
asu show IMM --noimmlancfg
If the ASU is connecting remotely to the IMM over the LAN, there is no requirement
for the remote operating system of the targeted IMM to be booted (online). The
ASU can connect to the IMM remotely when the server is connected to power or is
using standby power.
You can use the ASU to enable or disable the IMM LAN over USB interface by
using the IMM.LanOverUsb setting. When you enable or disable this setting, you
must use the KCS interface because the LAN over USB interface is removed during
the set command process. This prevents the ASU set command from terminating
correctly. You must use the --kcs connectivity option to make sure that the asu
command is completed correctly and relates status.
asu set IMM.LanOverUsb Disabled --kcs
Examples:
To connect locally forcing the ASU to use the KCS interface and avoid using the
LAN over USB interface, type the following command:
asu show --kcs
For more information about connectivity parameters and usage, see “Command
connectivity options” on page 27.
Settings syntax
All settings in IMM-based servers are configured through the IMM and the settings
are classified into groups of settings. The term group is used in this document to
refer to how the settings for a specific subsystem are grouped together.
Example:
To set the external IP address in the IMM, type the following command:
asu set IMM.HostIPAddress 9.5.51.37
where IMM.HostIPAddress is the IMM setting that is used to configure the IMM
external IP address. The setting is part of the IMM group.
There are settings that include an additional index, which is referred to in this
document as an instance. The index is used to identify and set different instances
of the same setting when these are available.
Example:
To set the first instance of a number or login ID, type the following command:
asu set IMM.LoginId.1 testid
where IMM.LoginId.1 is the IMM setting that is used to configure the first instance of
a login account.
Instances of settings
Support for instances of settings on IMM-based servers was introduced in the ASU
3.0. The ASU 3.01 is extending the support of instances in several different ways.
Commands have been created or modified to provide more information about
instances and ways to create and delete them.
Instances are denoted by adding a dot, followed by the instance number to the end
of the setting name. For example, if the setting name is “IMM.LoginId,” instance
number 1 of the setting is “IMM.LoginId.1”.
Note: There is an exception to the naming convention for single instances. Single
instances do not have the dot followed by an instance number. The setting
instead appears like a non-instance setting. Single instance settings are
denoted in the output of the showvalues command by having a maximum
number of instances of ‘single’. For example, the setting iSCSI.initiatorName
is a ‘single instance’. Notice that the usual dot followed by an instance
number is not used. If the single instance exists, the setting
iSCSI.initiatorName is displayed in the show command output. If it does not
exist, the setting is not displayed in the show command output.
Instance settings are now defined to have a minimum and maximum number of
allowed instances. To determine which settings can have instances and the
minimum and maximum number of instances allowed, use the showvalues
command with the new --instances parameter. The output of this command is
detailed in “Showvalues command” on page 89.
Use the new delete command to delete an instance. This command deletes the
instance, if deleting the instance does not cause the number of instances for the
setting to go below the minimum number of allowed instances for the setting.
Note: There are restrictions for creating and deleting instances of settings that are
part of a record. For more information about the restrictions, see “Record
management.”
Record management
Record management is a new feature in the ASU 3.01. Settings that have instances
can be part of a record. A record is basically a group of settings that have
dependencies on each other. For example, a user ID and a password are
dependent on each other. A user ID must have a password and a password must
have a user ID. Therefore, they are grouped in the same record.
Each record has a setting that is defined as the “record key”. It represent the
primary setting for the record.
To determine if a setting is part of a record, use the showvalues command with the
--instances parameter. Settings that are part of a record are marked with the text
“recordKey” (if the setting is the record key) or “recordKey=key_name” (if the setting
is part of a record but is not the key), where key_name is the name of the setting
that is the record key. Examples of the showvalues output for settings that are part
of a record are shown in “Showvalues command” on page 89.
Limitation
This version of RDCLI supports only ISO image files and DVD or CD drives.
Package
The RDCLI package contains the following two binary files that are packaged in the
rdcli32 and rdcli64 directories in the ASU Linux distribution:
rdmount
Performs authentication and creates new file server processes that enable
access to the virtual disk. It can also query the existing file server
processes.
rdumount
Binary file that is used to unmount an ISO image file or DVD or CD drive
from a remote IMM-based server.
Command-line parameters
v -s address_or_hostname
The address or host name of the remote IMM.
v -d path
The image or local optical drive directory path.
v -l login
Authorized login user to the IMM.
v -p password
Password of the authorized login user.
v -w port
Authentication port used to communicate with the IMM.
Command syntax
Read the following guidelines before you use the command-line interface:
v Each command has the following format:
asu [application] [command [command_modifier] | [class]]
[options] [connect_options]
v Each command starts with asu or asu64.
v The optional configuration application can be either of the following options (see
“Command configuration applications”):
– savestat
– immcfg
v command is one of the commands that are listed in Chapter 3, “Command
reference,” on page 41.
v command_modifier is one or more options that apply only to a certain command.
These are considered command modifiers or extensions. Each command
modifier must be preceded by a double hyphen (--). (See “Command modifiers”
on page 25.)
v class is a filter that acts on a listing of settings (settings display filters). A class is
not considered a modifier or option. Classes are also used to operate a
command upon a group or class of settings. A class does not require the double
hyphen (--) as part of the syntax. For more information about a class, see
“Classes of settings” on page 23.
v option is one or more general options that globally apply to the operation. Each
option requires the preceding double hyphen (--) as part of its syntax. (See
“Command general options” on page 28.)
v connect_option is one or more parameters that are related to the ASU connection
to the IMM. Connect options are defined as options. Each requires the double
hyphen (--) as part of its syntax. (See “Command connectivity options” on page
27.)
v Brackets ([ ]) indicate that an application, option, or class is optional. Brackets
are not part of the command that you type.
The following sections describe each of the applications and outline the command
syntax and structure.
Examples
savestat write data example:
asu savestat write datafile
This command uses the contents of the datafile file to update the persistent
storage contents.
This command reads the contents of the persistent storage and writes the results to
the datafile file. The file is created if it does not already exist. If the file already
exists, it is overwritten.
The supported commands and the operating systems for which these are available
are listed in Table 1.
The additional files that are required to perform these commands are included with
the ASU package. The following required files must be in the directory from which
the ASU is run:
For Windows:
ibm_rndis_server_os.inf
device.cat
For Linux:
cdc_interface.sh
Table 1. IMM LAN over USB configuration application commands
Configuration
application Operating
command Description system support Command syntax to set the command
setip Sets the operating system IP Windows only asu immcfg --setip
address for the LAN over USB [ [--ip ip_address]
interface [--ipmask ipmask] ]
detectdevice Detects whether the IMM LAN Windows only asu immcfg -–detectdevice
over USB interface is activated
Classes of settings
For commands that support operating on multiple settings, classes are used to
indicate groups of settings. The commands that support classes are
comparedefault, help, loaddefault, show, showdefault, showlocation, and
showvalues.
To list the settings that are part of the BIOS group (BIOS-based servers):
asu show bios
nochange
This class includes all changeable settings that are not in the reboot and change
classes.
noreplicate
This class lists all settings that are not replicated when you run the replicate
command. These settings are usually unique to each system.
Class filter for the show, showvalues, showdefault, and showlocation
commands.
Example:
To list the settings that are not replicated:
asu show replicate
Command modifiers
Command modifiers are optional and are used to modify the default operation of
only specific commands. Table 2 describes the command modifiers and the
commands to which they are applicable.
Table 2. Command modifiers
Command
modifier Description SyntaxLAN-over-USB
--group Optional command modifier for the show, asu show [--group group_name]
showdefault, showvalues, showlocation,and
save commands. asu save [--group group_name]
When used with a supporting command, it is Obtain the group_name by running the following
used to specify the name of a group section. showgroups command:
asu showgroups
The group_name is obtained by running the
showgroups command.
--setlist Optional command modifier for the show, asu show [--setlist name1 name2
showdefault, showvalues, showlocation, and nameN]
save commands.
asu save [--setlist name1 name 2
When used with a supporting command, it is nameN]
used to specify a list of settings on which the
command will operate.
The connectivity options might be required when you connect the ASU to a local
IMM. When you attempt to connect the ASU to a local IMM and none of the
connectivity parameters are specified, the ASU attempts to connect to the IMM by
using the default LAN over USB interface settings. The default settings include user
ID, password, and host. The values for these settings are defined by the IMM
hardware. If none of these settings are specified on a local connection and the
default LAN over USB interface settings fail, the ASU attempts to connect over the
KCS interface. The KCS interface does not require any of these parameters.
To connect the ASU remotely to the IMM, the host parameter is required. The user
and password parameters are optional. If these parameters are not specified, the
default settings are used.
Any local or remote LAN over USB connection requires authentication. The default
authentication parameters are the default user ID and password that comes
configured with each IMM. For the default authentication settings, see the
documentation that comes with the server or optional devices.
Table 3. Command connectivity options
Connectivity
option Description Syntax
host Specifies the host name or IP address of the asu cmd [command_modifier] options
IMM to which the ASU should connect. --host host_name|ip
If you try to run the patchadd command on a system on which a BIOS CMOS
patch file is already installed in the BIOS ROM and the definition file that you use
has the same BIOS code level as the system, an error message is generated and
the ASU is not modified. Also, if you issue the patchremove command and select
the BIOS CMOS patch, an error message is generated, and the ASU does not
remove this patch.
To add and use a BIOS CMOS definition patch file on a system in which the BIOS
ROM has a BIOS CMOS patch with the same BIOS code level, use the bypass
option (--bypass) at the end of the asu command.
Examples:
asu patchadd GG16A.def --bypass
asu patchlist --bypass
asu show all --bypass
When you run the asu command with the bypass option, the ASU ignores the BIOS
CMOS patch information in BIOS ROM.
Usage
The dumptofile option is inserted at the end of any ASU command.
The dumptofile option complements in function and is mutually exclusive with the
silent option. When the dumptofile option is specified, the ASU runs in silent mode.
All output that is produced by the ASU, whether informational or error logging, is
redirected to a predefined log file. For Linux, the log file is /asulog/asuout.log. For
Windows, the log file is c:\asulog\asuout.log, where c is the system drive as defined
in Windows.
Output
The dumptofile option does not produce any additional output or filter any output
that is normally produced by the ASU. It is a simple redirect to the predefined file.
Every time the ASU runs, the predefined file is initialized. All content from a
previous ASU run is lost. There are no appends to the existing file from a previous
run.
The predefined log file has no maximum file size. If, during an ASU run, the file
reaches the file system available space, any additional output is lost.
asu show all dumptofile This ASU command shows the current value
for all settings and redirects the output to a
predefined log file.
asu set CMOS_CRTRequired Disabled This ASU command sets the value, and all
dumptofile output is redirected to the predefined log file.
Before you use the -nx option with a multi-node system that is running a Windows
operating system, see “IPMI device driver support for Windows” on page 7. If the
multi-node system is running a Linux operating system, see “IPMI device driver
support for Linux” on page 8.
Syntax
If the optional -nx parameter is specified, the ASU performs the operation for node
x, where x is the selected node in a multi-node system and is a number from 1
through 8. If the -nx parameter is not specified, the operation is performed on the
primary node (node 1). The -nx option must be at the end of the command. If the
--bypass option is also specified, the --bypass option must follow the node option.
Examples:
When you run the asu command with the --bypass option, the ASU ignores the
BIOS CMOS patch information in BIOS ROM.
Use the showsptraffic command option (--showsptraffic) to show raw traffic to and
from the service processor (SP). Use this option for debugging.
Usage
The showsptraffic option is inserted anywhere in any asu command. Any
communication with the service processor is shown.
Output
When the showsptraffic option is specified on the command line, the following lines
are interspersed with normal output:
SP Sent: <byte 1> <byte 2> ... <byte n>
SP Recv: <byte 1> <byte 2> ... <byte n>
Or
SP6 Sent: <byte 1> <byte 2> ... <byte n>
SP6 Recv: <byte 1> <byte 2> ... <byte n>
Examples
The showsptraffic option and corresponding output are shown in the following
example:
Command line:
asu show RSA_SSL_Server_Enable --showsptraffic
Output:
SP Sent: 02 06 00 00 00 00 04 09 05 01 01 01
SP Recv: 04 06 01 00 00 00 04 09 05 01 01 01 00
RSA_SSL_Server_Enable=Disabled
Command line:
asu set RSA_SSH_Enable Enabled --showsptraffic
Output:
SP Sent: 00 06 01 00 00 00 04 09 05 01 04 01 01
SP Recv: 04 06 00 00 00 00 04 09 05 01 04 01
SP Sent: 02 06 00 00 00 00 04 09 05 01 04 01
SP Recv: 04 06 01 00 00 00 04 09 05 01 04 01 01
RSA_SSH_Enable=Enabled
Usage
The silent option is inserted at the end of any ASU command. Any output that is
produced by the ASU as either informational or error logging to screen is
suppressed. To determine whether the command was successful, see the command
return code.
Output
If the ASU command is successful, the return code is zero (0). If the ASU command
is not successful, the return code is a positive number greater than zero (0). For
information about the return codes, see “Return codes” on page 33.
Examples
In the following command example, the ASU sets the value, and no output is
produced to the screen or to a file.
asu set CMOS_CRTRequired Disabled silent
Usage
The --help option can be used to give a full description of an ASU application (for
example, savestat or immcfg) or ASU command (for example, batch, set, or
loaddefault).
Output
The output is a full description of the ASU application or command, including
available options and the description of those options. Running asu --help displays
details about the --help command option.
Examples
In the following command example, the ASU displays the full description of the asu
show command.
Command line:
asu show --help
Output:
Description:
Syntax:
Where:
<cmd_mod>
Note: Use the command "asu showgroups" to find variable classes available.
options
<connect_opts>
The ASU has grouped the failure return codes into different categories. The failure
return codes are used as a signal that a failure is detected. However, these return
codes are not an indicator of a specific failure. For a more detailed error isolation,
see the return code explanation that is displayed on the screen with the specific
error condition.
The different categories of errors that are returned by the ASU are described in the
following table, including brief descriptions of the possible type of failures.
Table 4. ASU return codes
Return code value Description Explanation
0 Successful command The ASU command has been
completed successfully.
5 Input error The input that was provided
to the ASU has an error. This
might be a user-input error or
an error with the provided
definition file.
10 Software error An error occurred when you
tried to use specific software.
15 Hardware error An error occurred when the
ASU tried to communicate
with or find specific
hardware.
20 Data error An error occurred in the data
that the ASU reads or sets.
25 Program error An error occurred in the ASU
program execution flow.
30 Invalid or missing patch An ASU patch is missing or
detected an ASU patch does not
match the required level.
35 The command is not
supported.
40 Invalid value input error The input value that is
provided to the ASU has a
syntax error.
45 Batch command error One or more of the
commands that were
specified in the batch file has
failed.
80 32-bit version running on The ASU application is a
64-bit operating system 32-bit version, and you are
attempting to run it on a
64-bit operating system.
To determine whether the startup sequence settings for your System x server are
contained in the baseboard management controller, use the ASU patchextract
command. The patchextract command syntax is
asu patchextract patch_number patch_ filename
where the patch_number is the patch number for the BIOS code and patch_
filename is the generated extracted BIOS definition file.
Example:
Command line:
asu patchlist (to determine which patch is the BIOS patch)
Output:
Patch 1: <XX[00->99] <BMC>
Patch 2: <XX[00->99] <RSA>
Patch 3: <DY[14->14] <BIOS>
Command line:
asu patchextract 3 bios.def (bios.def will contain the bios definitions)
Output:
Extracted patch 3: <DY[14->14] <BIOS>> to bios.def
Open the bios.def file and review the contents. If any of the settings start with
BMCSetting (for example, BMCSetting BMC_PrimaryBootDevice2, "Second Primary
Boot Device", critical,......), the server startup sequence settings are
contained in the baseboard management controller, and you must use the
BMCSetting when you access the server startup sequence settings.
Note: Before you can access the baseboard management controller settings, the
baseboard management controller device driver must be installed. For
information about obtaining the device driver, see “Obtaining the ASU and
patch files” on page 9.
The following examples illustrate how to view the current settings and to set the
boot order sequence. Each example shows a different connectivity option to
illustrate the different method of connectivity.
To determine the current boot order sequence, start by listing the settings that
belong to the special boot-order group. The special group or class is currently
defined as BootOrder.
Example:
The setting that contains the boot order is called BootOrder.BootOrder. This
output represents an ordered list. The syntax of an ordered list is:
value1=value2=valueN
The values that are separated by the equal sign (=) represent each of the items in
the list. Therefore, this is the list of devices in the boot order.
The listed values are those devices that are currently set in the boot order.
Additional devices might be available to be included in the boot order. To learn
about all the available devices, use the showvalues command.
Example:
To list the devices that are available to be set by using the remote connection to an
IMM and the default authentication for the BootOrder.BootOrder setting, type the
following command:
asu showvalues BootOrder.BootOrder --host 9.5.51.207
The list of devices is much larger than what is shown in the previous example. Note
the double equal sign (==) sign nomenclature. The double equal sign represents the
values in an ordered list. You can select any of these values to build a new ordered
list.
After all the possible values are known, you can build a new ordered list of values
by using the set command.
To build a new boot order sequence by using the set command on a local IMM
through the LAN over USB connection:
asu set BootOrder.BootOrder "Network=Hard Disk 1=USB
Storage=Diagnostics=iSCSI=iSCSI Critical=Legacy
Only=Embedded Hypervisor" --user testuser --password
testpwd
Each of the devices in the list in the specified order constitutes the new boot order
sequence.
iSCSI configuration
The ASU supports setting iSCSI boot parameters. This section describes how to
configure iSCSI settings. This section does not describe iSCSI or the actual
meaning of each parameter.
The ASU is designed to configure iSCSI settings, which do not initially exist. This
section describes the detailed steps for creating and configuring the iSCSI settings.
Before you configure iSCSI boot parameters, read the following general information:
v The iSCSI settings are grouped into a record. The record key for the record is
the iSCSI.AttemptName setting. Each record represents an attempt. The term
attempt is equivalent to the term instance that is defined for other settings.
v More than one attempt can be defined. In the examples in this section, all the
settings that end with “.1” belong to the “first” attempt. The iSCSI.AttemptName.1
setting defines the name of the attempt group of settings.
v If more that one attempt is defined, the same setting names that define the
attempt group are used, but each attempt contains a different instance number
sequence.
v The iSCSI settings can now be created by using the ASU set command on an
instance of the iSCSI.AttemptName setting that does not already exist.
v The iSCSI settings can now be deleted by using the ASU delete command on an
instance of the iSCSIAttemptName setting. This causes all iSCSI settings for that
instance to also be deleted because iSCSI instance settings are now grouped as
a record.
v The only parameter that is defined as a global iSCSI setting to all attempts and
that does not required an instance index is the iSCSI.InitiatorName. This setting
does not require the attempt index that all the other settings require. The initiator
name is always defined as iSCSI.InitiatorName.
v The iSCSI parameters are defined in the iSCSI group of settings. To list the
available iSCSI settings, type the following command:
asu show iscsi
The following example shows the list of settings if a single attempt group is defined.
All setting names with the same instance “.1” belong to the same attempt group:
iSCSI.InitiatorName
iSCSI.MacAddress.1
iSCSI.AttemptName.1
iSCSI.IscsiMode.1
iSCSI.ConnectRetryCount.1
iSCSI.ConnectTimeout.1
iSCSI.InitiatorInfoFromDhcp.1
iSCSI.LocalIp.1
iSCSI.SubnetMask.1
iSCSI.Gateway.1
iSCSI.TargetInfoFromDhcp.1
iSCSI.TargetName.1
iSCSI.TargetIp.1
iSCSI.TargetPort.1
iSCSI.BootLun.1
iSCSI.CHAPType.1
iSCSI.CHAPName.1
iSCSI.CHAPSecret.1
iSCSI.ReverseCHAPName.1
iSCSI.ReverseCHAPSecret.1
iSCSI.MacAddress.2
The following example shows the list of settings if two attempts are defined:
iSCSI.InitiatorName
iSCSI.MacAddress.1
iSCSI.AttemptName.1
iSCSI.IscsiMode.1
iSCSI.ConnectRetryCount.1
iSCSI.ConnectTimeout.1
iSCSI.InitiatorInfoFromDhcp.1
iSCSI.LocalIp.1
iSCSI.SubnetMask.1
iSCSI.Gateway.1
iSCSI.TargetInfoFromDhcp.1
iSCSI.TargetName.1
iSCSI.TargetIp.1
iSCSI.TargetPort.1
iSCSI.BootLun.1
iSCSI.CHAPType.1
iSCSI.CHAPName.1
iSCSI.CHAPSecret.1
iSCSI.ReverseCHAPName.1
iSCSI.ReverseCHAPSecret.1
iSCSI.MacAddress.2
iSCSI.AttemptName.2
iSCSI.IscsiMode.2
iSCSI.ConnectRetryCount.2
iSCSI.ConnectTimeout.2
iSCSI.InitiatorInfoFromDhcp.2
iSCSI.LocalIp.2
iSCSI.SubnetMask.2
iSCSI.Gateway.2
iSCSI.TargetInfoFromDhcp.2
iSCSI.TargetName.2
iSCSI.TargetIp.2
iSCSI.TargetPort.2
iSCSI.BootLun.2
iSCSI.CHAPType.2
iSCSI.CHAPName.2
iSCSI.CHAPSecret.2
iSCSI.ReverseCHAPName.2
iSCSI.ReverseCHAPSecret.2
RDCLI
The RDCLI is designed to mount an ISO image file or DVD or CD drive to a remote
IMM-based server. Before you start to invoke RDCLI, make sure that:
v The remote IMM is connected to the network environment.
v There is no other remote presence session opened through the RDCLI or IMM
web interface.
v The server has a virtual media key installed and the remote presence feature is
enabled.
Example:
Type the following commands to mount an ISO image file or DVD or CD drive to a
remote IMM-based server:
rdmount -s 192.168.1.12 –d /dev/cdrom -l USERID -p PASSW0RD
rdmount -s 192.168.1.12 –d /home/install.iso -l USERID -p PASSW0RD
rdmount –s 192.168.1.12 –d /dev/cdrom -l USERID –p PASSW0RD –w 90
Type -w 90 to switch the authentication port number to 90. The default port number
is 80.
Example:
Type the following command to query existing mount sessions between the client
operating system and the remote server:
rdmount –q
If the command is successful, all available token values on the client operating
system are listed in the following format:
"Token 507: drive path /home/install.iso, mounted to SP 192.168.0.1, by user USERID"
If the command is not successful, the error message and reason for the failure are
displayed.
Example:
Type the following command to unmount an ISO image file or DVD or CD drive that
is already mounted to the remote system. In the command, the remote mount
session has the token 507.
rdumount 507
Batch command
Use the batch command to queue ASU operations without any knowledge of the
scripting capabilities of the operating system on which the ASU is running.
Syntax
The syntax of the batch command is
asu batch batch_filename [-nx] [connect_options]
where batch_filename is the name of a file that contains a list of ASU commands.
Notes:
1. If the optional -nx parameter is specified, the ASU performs the operation for
node x, where x is the selected node in a multi-node system. x can be a
number from 1 through 8. If the -nx parameter is not specified, the operation is
performed on the primary node (node 1).
2. Do not specify the –nx optional parameter in the batch file for any of the
batched commands.
3. The connect options are defined for only IMM-based servers. The --host
ip_address connect option is required if you connect remotely to the IMM. The
--user user_id and --password password connect options are required only if the
default user ID and password settings are changed in the IMM for either a local
or remote LAN connection. The --user user_id and --password password
connect options are not required if you are using the local KCS interface.
Output
When you use the batch command on a batch file, the output that is sent to stdout
and stderr is the collective output of all the commands in the batch file. The output
of each command in the batch file is preceded by the command itself, surrounded
by brackets ( [ ] ).
[command 1]
output of command 1
[command 2]
output of command 2
.
.
.
[command n]
output of command n
Example 1:
Batch file:
set IMM.PowerRestorePolicy "Always on"
set IMM.PowerOnAtSpecifiedTime_Hour 05
set IMM.PowerOnAtSpecifiedTime_Minute 00
set IMM.PowerOnAtSpecifiedTime_Second 00
set IMM.ShutdownAndPowerOff_WeekDay Sunday
set IMM.HTTPPort 81
set IMM.SSLPort 441
set IMM.TelnetPort 21
set SYSTEM_PROD_DATA.SysEncloseAssetTag "Server Tag"
set iSCSI.InitiatorName "iqn.2009-01.com.ibm:InitiatorName"
set uEFI.Com1BaudRate 9600
Output:
[set IMM.PowerRestorePolicy "Always on"]
IMM.PowerRestorePolicy=Always on
[set IMM.PowerOnAtSpecifiedTime_Hour 05]
IMM.PowerOnAtSpecifiedTime_Hour=05
[set IMM.PowerOnAtSpecifiedTime_Minute 00]
IMM.PowerOnAtSpecifiedTime_Minute=00
[set IMM.PowerOnAtSpecifiedTime_Second 00]
IMM.PowerOnAtSpecifiedTime_Second=00
[set IMM.ShutdownAndPowerOff_WeekDay Sunday]
IMM.ShutdownAndPowerOff_WeekDay=Sunday
[set IMM.HTTPPort 81]
IMM.HTTPPort=81
[set IMM.SSLPort 441]
IMM.SSLPort=441
[set IMM.TelnetPort 21]
IMM.TelnetPort=21
[set SYSTEM_PROD_DATA.SysEncloseAssetTag "Server Tag"]
SYSTEM_PROD_DATA.SysEncloseAssetTag=Server Tag
[set iSCSI.InitiatorName "iqn.2009-01.com.ibm:InitiatorName"]
iSCSI.InitiatorName=iqn.2009-01.com.ibm:InitiatorName
[set uEFI.Com1BaudRate 9600]
uEFI.Com1BaudRate=9600
Example 2:
Batch file:
show CMOS_PrimaryBootDevice1
show CMOS_PrimaryBootDevice2
show CMOS_PrimaryBootDevice3
show CMOS_PrimaryBootDevice4
Output:
[show CMOS_PrimaryBootDevice1]
CMOS_PrimaryBootDevice1=CD ROM
[show CMOS_PrimaryBootDevice2]
CMOS_PrimaryBootDevice2=Diskette Drive 0
[show CMOS_PrimaryBootDevice3]
CMOS_PrimaryBootDevice3=Hard Disk 0
[show CMOS_PrimaryBootDevice4]
CMOS_PrimaryBootDevice4=Network
Batch file:
set CMOS_PrimaryBootDevice1 "Network"
set CMOS_PrimaryBootDevice2 "Hard Disk 0"
set CMOS_PrimaryBootDevice3 "Diskette Drive 0"
set CMOS_PrimaryBootDevice4 "CD ROM"
Output:
[set CMOS_PrimaryBootDevice1 "Network"]
CMOS_PrimaryBootDevice1=Network
[set CMOS_PrimaryBootDevice2 "Hard Disk 0"]
CMOS_PrimaryBootDevice2=Hard Disk 0
[set CMOS_PrimaryBootDevice3 "Diskette Drive 0"]
CMOS_PrimaryBootDevice3=Diskette Drive 0
[set CMOS_PrimaryBootDevice4]
CMOS_PrimaryBootDevice4=CD ROM
{set CMOS_PrimaryBootDevice1]
CMOS_PrimaryBootDevice1=CD ROM
[show CMOS_PrimaryBootDevice2]
CMOS_PrimaryBootDevice2=Diskette Drive 0
[show CMOS_PrimaryBootDevice3]
CMOS_PrimaryBootDevice3=Hard Disk 0
[show CMOS_PrimaryBootDevice4]
CMOS_PrimaryBootDevice4=Network
Syntax
The syntax of the comparedefault command is
asu comparedefault [setting | class] [-v] [-nx] [connect_options]
where setting is the name of an ASU setting and class is the name of an ASU class
of settings.
Notes:
1. If the optional -v parameter is specified, the output is verbose.
2. If the optional -nx parameter is specified, the ASU performs the operation for
node x, where x is the selected node in a multi-node system. x can be a
number from 1 through 8. If the -nx parameter is not specified, the operation is
performed on the primary node (node 1).
3. The connect options are defined for only IMM-based servers. The --host
ip_address connect option is required if you connect remotely to the IMM. The
--user user_id and --password password connect options are required only if the
default user ID and password settings are changed in the IMM for either a local
or remote LAN connection. The --user user_id and --password password
connect options are not required if you are using the local KCS interface.
Output
The output of the comparedefault command shows the current and default values
for one or all settings.
Command line:
asu comparedefault uefi.com1baudrate
Output:
uEFI.Com1BaudRate=115200<115200>
Command line:
asu comparedefault CMOS_PrimaryBootDevice1
Output:
CMOS_PrimaryBootDevice1=Network<CD ROM>
Command line:
asu comparedefault CMOS_PrimaryBootDevice2 –v
Output:
CMOS_PrimaryBootDevice2: Second Startup Device = Network, CD
ROM (default)
Command line:
asu comparedefault bios
Output:
CMOS_DisketteA=1.44 MB 3.5"<1.44 MB 3.5">
CMOS_CRTRequired=Disabled<Enabled>
.
.
.
CMOS_OSUSBControl=Other OS<Other OS>
Use the createuuid command to generate and set the Universally Unique Identifier
(UUID).
Note: When you set the UUID, the command requires the setting name. You can
use the asu show command to identify the setting.
Syntax
The syntax of the createuuid command is:
asu createuuid UUID_setting_name [connect_options]
Notes:
1. The UUID_setting_name is usually defined as
SYSTEM_PROD_DATA.SysInfoUUID.
2. To view the actual setting name, which can vary from server to server, use the
show command to list the setting name that belongs to the
SYSTEM_PROD_DATA group. To view the available groups, use the
showgroups command.
3. The connect options are defined for only IMM-based servers. The --host
ip_address connect option is required if you connect remotely to the IMM. The
--user user_id and --password password connect options are required only if the
default user ID and password settings are changed in the IMM for either a local
or remote LAN connection. The --user user_id and --password password
connect options are not required if you are using the local KCS interface.
Output
To see the value that is set by the createuuid command, use the show command.
asu show SYSTEM_PROD_DATA.SysInfoUUID
The output of the show command is the new randomly generated UUID.
SYSTEM_PROD_DATA.SysInfoUUID=801a3b663e82b60104af001a64e50c94
Examples
The createuuid command and corresponding output are shown in the following
examples.
Command line:
asu createuuid SYSTEM_PROD_DATA.SysInfoUUID
Output:
The command does not produce output. To see the generated UUID, use the show
command.
asu show SYSTEM_PROD_DATA.SysInfoUUID
SYSTEM_PROD_DATA.SysInfoUUID=801a3b663e82b60104af001a64e50c94
Note: Using this command to delete the instance of a setting that is a record key
results in all other settings with the same instance number to be deleted.
Syntax
The syntax of the delete command is
asu delete setting_instance [-nx] [connect_options]
Use the asu showvalues setting command to show a list of all values that are
available for the setting.
Limitations
Settings can have a minimum number of allowed instances. The delete command
does not allow you to delete an instance if doing so causes the number of
instances to drop below the minimum number of allowed instances. To determine
the minimum number of instances allowed, use the command:
asu showvalues --instances
The output for each setting that can have instances will be displayed,
along with the minimum and maximum number of allowed instances.
Also, deleting instances that are part of a record is allowed for only the record key
setting. To determine whether or not a setting is part of a record, use the command:
asu showvalues --instances
The output for each setting that can have instances will be displayed,
along with the record information. See the asu showvalues command for
details about the record information.
Notes:
1. Values that contain spaces must be enclosed in quotation marks ( " ). If a value
contains quotation marks, add a backslash before each quotation mark ( \" ) in
the value.
2. If the optional -nx parameter is specified, the ASU performs the operation for
node x, where x is the selected node in a multi-node system. x can be a
number from 1 through 8. If the -nx parameter is not specified, the operation is
performed on the primary node (node 1).
3. The connect options are defined for only IMM-based servers. The --host
ip_address connect option is required if you connect remotely to the IMM. The
--user user_id and --password password connect options are required only if the
default user ID and password settings are changed in the IMM for either a local
or remote LAN connection. The --user user_id and --password password
connect options are not required if you are using the local KCS interface.
Deleting an instance that causes the number of instances to drop below the
minimum allowed number of instances:
The setting IMM.MacAddress.1 cannot be deleted. Too few instances.
Examples
The delete command and corresponding output are shown in the following
examples.
Command line:
asu delete IMM.Community_Name.1
Output:
Deleting IMM.Community_Name.1
Waiting for command completion status
Command completed successfully
Command line:
asu delete IMM.Community_Name.3
Output:
Could not find setting IMM.Community_Name.3
Deleting an instance that causes the number of instances to drop below the
minimum allowed number of instances:
Command line:
asu delete IMM.MacAddress.1
Output:
The setting IMM.MacAddress.1 cannot be deleted. Too few instances.
Command line:
asu delete iSCSI.ConnectTimeout.1
Output:
The setting iSCSI.ConnectTimeout.1 is part of a record and cannot be
deleted. To delete the entire instance of the record you must
delete the record’s key setting, iSCSI.AttemptName.1.
Use the dump command to see the raw contents of CMOS memory.
Syntax
The syntax of the dump command is
asu dump [-nx]
Note: If the optional -nx parameter is specified, the ASU performs the operation for
node x, where x is the selected node in a multi-node system. x can be a
number from 1 through 8. If the -nx parameter is not specified, the operation
is performed on the primary node (node 1).
Output
The output of the dump command is a table that contains the current raw
hexadecimal contents of CMOS memory. The CMOS memory setting area is
preceded by < and followed by >. CMOS memory locations that are outside the
CMOS memory setting area are denoted by *. The ASU uses information from the
CMOS memory map to determine how to access the second bank of CMOS
memory. It also uses CMOS memory limit information from the map to determine
the CMOS memory setting area.
Examples
The dump command and corresponding output are shown in the following example.
Command line:
asu dump
Output:
0 1 2 3 4 5 6 7 8 9 A B C D E F
00: 38*00*14*00*10*00*01*07*07*03*26*02*50*80<00 00
10: 40 00 00 7e 01 80 02 ff ff 00 00 f2 00 86 c0 c8
20: 60 00 00 00 00 00 00 00 00 00 00 02 27 50 07 18
30: ff ff 20 05 0d 06 00 00 c0 00 f0 ff 00 ca 00 00
40: 00 00 00 00 00 00 00 00 00 00 00 20 52 00 00 60
50: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
60: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 24
70: 10 42 08 21 00 00 81 4a 2a 00 2e 28 00 30 00 00
80: 00 00 ff 01 00>00*00*00*00*00*00*00*00*00*00*00
90: 00*00*00*00*00*00*00*00*00*00*00*00*00*00*00*00
a0: 00*00*00*00*00*00*00*00*00*00*00*00*00*00*00*00
b0: 00*00*00*00*00*00*00*00*00*00*00*00*00*00*00*00
c0: 00*00*00*00*00*00*00*00*00*00*00*00*00*00*00*00
d0: 00*00*00*00*00*00*00*00*00*00*00*00*00*00*00*00
e0: 00*00*00*00*00*00*00*00*00*00*00*00*00*00*00*00
f0: 00*00*00*32*08*9c*00*62*90*5c*cd*ff*4f*5f*ba*9f
Syntax
The syntax of the export command is
asu export setting certificate_binary_file [-nx]
where setting is the name of a valid ASU setting and certificate_binary_file is the
name of a file that is generated with the valid certificate information that is provided
by the Remote Supervisor Adapter or Remote Supervisor Adapter II.
Note: If the optional -nx parameter is specified, the ASU performs the operation for
node x, where x is the selected node in a multi-node system. x can be a
number from 1 through 8. If the -nx parameter is not specified, the operation
is performed on the primary node (node 1).
Output
The output of the export command is a binary file and a message that indicates
that the Remote Supervisor Adapter or Remote Supervisor Adapter II has
completed the command successfully.
Examples
The export command and corresponding output are shown in the following
example.
Command line:
asu export RSA_SSL_Client_PrivateKey_Export asu.cert
Output:
Certificate was exported to the file successfully!
( asu.cert file in saved in the current directory)
Note: The XML file supports the self-signed certificate request and the certificate
signing request (CSR) request. The start and end tag for the self-signed
certificate is new_key_and_self_signed_cert_info. The start and end tag for
CSR is new_key_and_cert_sign_req_info.
Template.xml:
<?xml version="1.0" encoding="utf-8"?>
<asu version="2.1">
<new_key_and_self_signed_cert_info>
<item type="Required">
<vectorID>0001</vectorID>
<name>countryName</name>
<value minlen="2" maxlen="2">xx</value>
</item>
<item type="Required">
<vectorID>0001</vectorID>
<name>stateOrProvinceName</name>
<value minlen="1" maxlen="30">xx</value>
</item>
<item type="Required">
<vectorID>0001</vectorID>
<name>localityName</name>
<value minlen="1" maxlen="50">xx</value>
</item>
<item type="Required">
<vectorID>0001</vectorID>
<name>organizationName</name>
<value minlen="1" maxlen="60">xx</value>
</item>
<item type="Required">
<vectorID>0001</vectorID>
<name>commonName</name>
<value minlen="1" maxlen="60">xx</value>
</item>
<item type="Optional">
<vectorID>0001</vectorID>
<name>Name</name>
<value minlen="1" maxlen="60">xx</value>
</item>
<item type="Optional">
<vectorID>0001</vectorID>
<name>emailAddress</name>
<value minlen="1" maxlen="60">xx</value>
</item>
<item type="Optional">
<vectorID>0001</vectorID>
<name>validityPeriod</name>
Syntax
The syntax of the generate command is
asu generate setting xml_file [-nx]
Note: If the optional -nx parameter is specified, the ASU performs the operation for
node x, where x is the selected node in a multi-node system. x can be a
number from 1 through 8. If the -nx parameter is not specified, the operation
is performed on the primary node (node 1).
Examples
The generate command for a self-signed certificate and corresponding output are
shown in the following example.
Command line:
asu generate RSA_Generate_SSL_Client_Certificate asu.xml
Output:
Certificate was generated successfully!
The generate command for a CSR certificate and corresponding output are shown
in the following example:
Command line:
asu generate RSA_Generate_SSL_Client_CSR asu.xml
Output:
Certificate was generated successfully!
Syntax
The syntax of the help command is
asu help [setting | class] [connect_options]
where setting is the name of an ASU setting and class is the name of an ASU class
of settings.
Note: The connect options are defined for only IMM-based servers. The --host
ip_address connect option is required if you connect remotely to the IMM.
The --user user_id and --password password connect options are required
only if the default user ID and password settings are changed in the IMM for
either a local or remote LAN connection. The --user user_id and --password
password connect options are not required if you are using the local KCS
interface.
Output
The output of the help command shows the help text for one or more settings. The
name and description of the setting are followed by the help title and the help text.
<setting 1>: <setting description 1>
<help title 1>
--------------
<help text 1>
<setting 2>: <setting description 2>
<help title 2>
--------------
<help text 2>
.
.
.
<setting n>: <setting description n>
<help title n>
--------------
<help text n>
Command line:
BootOrder.BootOrder: Boot Order
Output:
Specify, from the list of bootable devices, the desired order in which
to search for bootable media. One or more items from the list may be
specified.
Command line:
asu help CMOS_PrimaryBootDevice3
Output:
CMOS_PrimaryBootDevice3: Third Startup Device
Command line:
asu help bios
Output:
CMOS_DisketteA: Diskette Drive A
Syntax
The syntax of the import command is
asu import setting certificate_binary_file [-nx]
where setting is the name of an ASU setting and certificate_binary_file is the name
of a file that is generated with the valid certificate information.
Note: If the optional -nx parameter is specified, the ASU performs the operation for
node x, where x is the selected node in a multi-node system. x can be a
number from 1 through 8. If the -nx parameter is not specified, the operation
is performed on the primary node (node 1).
Output
The output of the import command is a message that indicates that the Remote
Supervisor Adapter or Remote Supervisor Adapter II has completed the command
successfully.
Examples
The import command and corresponding output are shown in the following
example.
Command line:
asu import RSA_Import_Trusted_Certificate_1 asu.cert
Output:
Certificate was imported successfully!
Limitations:
v Not all settings in the definition or configuration file have assigned default values.
v The loaddefault command sets the default settings only for the settings that
have defined default values in the configuration file.
v On BIOS-based servers, the loaddefault command should not be viewed or
used as a general restore factory defaults command.
v On IMM-based servers, when the loaddefault command is run remotely (using
the --host connectivity option) the authentication and password class settings are
not applied.
v On IMM-based servers that are running the ASU 3.00, the loaddefault command
is not functionally equivalent to the “Restore Defaults” function that is defined in
the IMM Web interface. You have to use the IMM Web interface or the server
Setup utility settings to restore the IMM settings to the factory defaults.
v On IMM-based servers that are running the ASU 3.01 or later (and have the
required IMM firmware that is described in “Using the ASU to configure settings
in IMM-based servers” on page 15), the loaddefault command is now
functionally equivalent to the “Restore Defaults” function that is defined in the
IMM Web interface. Settings from other groups are still not the equivalent of the
‘restore factory defaults’ function that is available through the server Setup utility
(F1 Setup ).
Note: For the ASU 3.01, some instances are deleted when you run the loaddefault
command. To determine which instances are deleted, use the showdefault
command. Instances that have a default value of “remove” are deleted.
Command line:
asu showdefault IMM.LoginId.7
Output:
IMM.LoginId.7=<remove>
Command line:
asu loaddefault IMM.LoginId.7
Output:
Could not find setting IMM.LoginId.7
Syntax
The syntax of the loaddefault command is
asu loaddefault [setting | class] [-v] [-nx] [connect_options]
where setting is the name of an ASU setting and class is the name of an ASU class
of settings.
Output
The output of the loaddefault command is displayed if a setting is changed to the
default value. If a setting is already set to the default value, no output is displayed.
If a setting is not already set to the default value, the value is changed, and the
output is shown as the output of the set command.
Note: Starting with the ASU 3.01, there are exceptions on IMM-based servers.
Performing the loaddefault command on a group of settings (for example,
IMM, UEFI, SYSTEM_PROD_DATA, BOOT_ORDER, and all) can trigger a
reset to factory defaults. If the group is being reset to factory defaults, the
setting names and their new values are not displayed. Instead, the ASU
displays the message Issuing reset of IMM.
Examples
The loaddefault command and corresponding output are shown in the following
examples.
Output:
uEFI.Com1BaudRate=115200
Command line:
asu loaddefault CMOS_CRTRequired
Output:
CMOS_CRTRequired=Enabled
Command line:
asu loaddefault CMOS_KbdRequired –v
Output:
CMOS_KbdRequired: Keyboardless Operation = Enabled
Command line:
asu loaddefault bios
Output:
CMOS_DisketteA=1.44 MB 3.5"
CMOS_CRTRequired= Enabled
CMOS_WakeOnLAN=Enabled
Output:
Issuing reset of IMM
The IMM has started the reset. Waiting for the reset to complete.
Connected to IMM at IP address 169.254.95.118
Reset completed successfully
Output:
Connected to IMM at IP address 9.5.107.158
SYSTEM_PROD_DATA.SysInfoProdName=
SYSTEM_PROD_DATA.SysInfoProdIdentifier=
SYSTEM_PROD_DATA.SysInfoSerialNum=
SYSTEM_PROD_DATA.SysInfoUUID=
SYSTEM_PROD_DATA.SysEncloseAssetTag=
uEFI.TurboModeEnable=Disable
uEFI.OperatingMode=Custom Mode
.
.
.
Issuing reset of IMM
The IMM has started the reset. Waiting for the reset to complete.
Connected to IMM at IP address 169.254.95.118
Reset completed successfully
Syntax
The syntax of the nodes command is
asu nodes
Output
The output of the nodes command is a string with the number of nodes currently
available on the system.
Examples
The nodes command and corresponding output are shown in the following
example.
Command line:
asu nodes
Output:
System Nodes: 2
Use the patchadd command to add support for a particular firmware setting to the
ASU. Depending on the system from which you are running this command, a BIOS
patchadd might not occur because the BIOS patch is already contained in the BIOS
ROM.
Syntax
The syntax of the patchadd command is
asu patchadd patch_filename
where patch_filename is the name of a patch file. For a description of the patch file
format, see “Using ASU patches” on page 10.
Output
The output of the patchadd command shows the success or failure of adding a
patch. If the patch succeeded, a message is shown indicating that a new patch was
written to the executable file, and information about the patch is provided. If the
patch failed, a message is shown indicating why the patch failed.
If the patch command is successful, the output looks similar to this example:
Wrote new patch <<patch identification>> to <executable>
Wrote patch footer to <executable>
If the patch command is not successful (duplicate), the output looks similar to this
example:
<<patch identification>> already patched.
Wrote patch footer to <executable>
Examples
The patchadd command and corresponding output are shown in the following
examples.
Successful patch:
Command line:
asu patchadd T2C125A.def
Output:
Wrote new patch <T2[25->25] (BIOS)> to ./asu
Wrote patch footer to ./asu
Command line:
asu patchadd T2C125A.def
Output:
BIOS def file already defined in BIOS ROM!
Use the patchextract command to extract a patch from the ASU to a patch file.
Then, you can patch the extracted patch file to another version of the ASU by using
the patchadd command.
Syntax
The syntax of the patchextract command is
asu patchextract patch_number patch_filename
where patch_number is the patch number to extract. To show the patch number for
each patch, use the patchlist command. patch_filename is the name of the patch
file that is extracted.
Output
The output of the patchextract command shows the success or failure of the
extraction operation. If the extraction is successful, a message is displayed
indicating which patch was extracted and the file name to which it was extracted.
Extracted patch <patch number>: <<patch identification>> to <patch filename>
Example
The patchextract command and corresponding output are shown in the following
example.
Command line:
asu patchextract 1 T2.def
Output:
Extracted patch 1: <T2[25->25] (BIOS)> to T2.def
Use the patchlist command to display the patches that are applied to the ASU.
Syntax
The syntax of the patchlist command is
asu patchlist
Output
The output of the patchlist command is a list of patches. Each patch has a patch
number and patch identification.
Patch <patch number 1>: <<patch identification 1>>
Patch <patch number 2>: <<patch identification 2>>
.
.
.
Patch <patch number n>: <<patch identification n>>
Example
The patchlist command and corresponding output are shown in the following
example.
Command line:
asu patchlist
Output:
Patch 1: <T2[25->25] (BIOS)>
Patch 2: <GE[00->99] (RSA)>
Patch 3: <GE[46->46] (BIOS)>
Use the patchremove command to remove a patch from the ASU. Depending on
the system from which you are running the command, the BIOS patch might not be
removed because the patch is contained in the BIOS ROM.
Syntax
The syntax of the patchremove command is
asu patchremove patch_number
where patch_number is the patch number to extract. You can use the patchlist
command to show the patch number for each patch.
Output
The output of the patchremove command shows the success or failure of the
removal operation. If the removal is successful, messages are displayed that
indicate the removal of a patch and the copying of every other patch to the
temporary executable file.
Output:
Copied patch <<patch identification>> to <temporary executable>
Removing patch <<patch identification>> from <executable>
Example
The patchremove command and corresponding output are shown in the following
example.
Command line:
asu patchremove 2
Output:
Copied patch <T2[25->25] (BIOS)> to smep2tmp-9yFPOa
Removing patch <GE[00->99] (RSA)> from ./asu
Command line:
asu patchremove 3
Output:
Can not remove patch in BIOS ROM, patch <T2[25->25] (BIOS)> is not removed.
Use the readraw command to read raw CMOS data and save it in a file that you
can use on other systems by using the writeraw command.
Syntax
The syntax of the readraw command is
asu readraw filename [-nx]
where filename is the name of a file to which the raw CMOS data is saved.
Note: If the optional -nx parameter is specified, the ASU performs the operation for
node x, where x is the selected node in a multi-node system. x can be a
number from 1 through 8. If the -nx parameter is not specified, the operation
is performed on the primary node (node 1).
Output
The output of the readraw command is a message that indicates that the raw read
is completed.
Examples
The readraw command and corresponding output are shown in the following
example.
Command line:
asu readraw CMOSraw.dat
Output:
Raw CMOS read from CMOS, written to CMOSraw.dat
Syntax
The syntax of the rebootbmc command is
asu rebootbmc [-nx]
Note: If the optional -nx parameter is specified, the ASU performs the operation for
node x, where x is the selected node in a multi-node system. x can be a
number from 1 through 8. If the -nx parameter is not specified, the operation
is performed on the primary node (node 1).
Output
The output of the rebootbmc command is a message that indicates that the restart
of the baseboard management controller is completed.
Example
The rebootbmc command and corresponding output are shown in the following
example.
Command line:
asu rebootbmc
Output:
Rebooting BMC...done
Use the rebootimm command to restart the integrated management module (IMM).
This is useful after you make changes to IMM settings for which a restart is
necessary for the changes to take effect. This command takes approximately 4
minutes to complete.
Syntax
The syntax of the rebootimm command is
asu rebootimm [-nx] [connect_options]
Notes:
1. If the optional -nx parameter is specified, the ASU performs the operation for
node x, where x is the selected node in a multi-node system. x can be a
number from 1 through 8. If the -nx parameter is not specified, the operation is
performed on the primary node (node 1).
2. The connect options are defined for only IMM-based servers. The --host
ip_address connect option is required if you connect remotely to the IMM. The
--user user_id and --password password connect options are required only if the
default user ID and password settings are changed in the IMM for either a local
or remote LAN connection. The --user user_id and --password password
connect options are not required if you are using the local KCS interface.
Output
The output of the rebootimm command is a message that indicates that the restart
of the IMM is completed.
Examples
The rebootimm command and corresponding output are shown in the following
example.
Command line:
asu rebootimm
Output:
Connected to IMM at IP address 169.254.95.118
Issuing reset command to IMM.
The IMM has started the reset. Waiting for the reset to complete.
Connected to IMM at IP address 169.254.95.118
Reset completed successfully.
Use the rebootrsa command to restart the Remote Supervisor Adapter or Remote
Supervisor Adapter II. This is useful when you must restart a Remote Supervisor
Adapter or Remote Supervisor Adapter II after you make changes to Remote
Supervisor Adapter settings for which a restart is necessary for the changes to take
effect. This command takes approximately 30 seconds to be completed.
Syntax
The syntax of the rebootrsa command is
asu rebootrsa [-nx]
Note: If the optional -nx parameter is specified, the ASU performs the operation for
node x, where x is the selected node in a multi-node system. x can be a
number from 1 through 8. If the -nx parameter is not specified, the operation
is performed on the primary node (node 1).
Output
The output of the rebootrsa command is a message that indicates that the restart
of the Remote Supervisor Adapter is completed.
Example
The rebootrsa command and corresponding output are shown in the following
example.
Command line:
asu rebootrsa
Output:
Rebooting RSA/RSA2...done
On IMM-based servers, the replicate command skips the settings that are defined
as “noreplicate.” To see the settings that are defined as “noreplicate,” use the show
command and specify the noreplicate class.
Syntax
The syntax of the replicate command is
asu replicate file_name [connect_options]
where file_name is the name of the file that was created by a previous asu save
command or by redirecting the output of a previous asu show command to a file.
Note: The connect options are defined for only IMM-based servers. The --host
ip_address connect option is required if you connect remotely to the IMM.
The --user user_id and --password password connect options are required
only if the default user ID and password settings are changed in the IMM for
either a local or remote LAN connection. The --user user_id and --password
password connect options are not required if you are using the local KCS
interface.
Output
The output of the replicate command is a list of outputs from set commands.
<setting 1>=<value 1>
<setting 2>=<value 2>
.
.
.
<setting n>=<value n>
Examples
The replicate command and corresponding output are shown in the following
examples.
Output:
uEFI.Com1BaudRate=115200
uEFI.Com1DataBits=8
uEFI.Com1Parity=None
uEFI.Com1StopBits=1
uEFI.Com1TextEmul=VT100
uEFI.Com1ActiveAfterBoot=Enable
uEFI.Com1FlowControl=Disable
Output:
CMOS_CRTRequired=Enabled
CMOS_KbdRequired=Enabled
.
.
.
CMOS_OSUSBControl=Other OS
Note: The output is identical to the show output file that is used as input to the
replicate command.
Use the resetrsa command to reset the Remote Supervisor Adapter or Remote
Supervisor Adapter II to the default settings and then restart it. This command takes
approximately 30 seconds to be completed.
Syntax
The syntax of the resetrsa command is
asu resetrsa [-nx]
Note: If the optional -nx parameter is specified, the ASU performs the operation for
node x, where x is the selected node in a multi-node system. x can be a
number from 1 through 8. If the -nx parameter is not specified, the operation
is performed on the primary node (node 1).
Output
The output of the resetrsa command is a message that indicates that the restart of
the Remote Supervisor Adapter is completed.
Example
The resetrsa command and corresponding output are shown in the following
example.
Command line:
asu resetrsa
Output:
Rebooting RSA/RSA2...done
In IMM-based servers, the backup control settings are not restored by default. To
restore the backup control settings in an IMM-based server, you must specify the
-incbackupctl modifier (see the specific syntax in Table 2 on page 25).
Limitations:
Settings that are defined in the password and authentication class are not restored
during a restore operation. To list the settings that belong to the password or
authentication class, use the following command:
asu showvalues authentication
To list only the password class settings, use the following command:
asu showvalues password
During a restore operation, the ASU does not delete settings that might exist on the
target server that is being restored and that are not included in the restore file.
The restore command simply restores the values that are defined in the restore file
for those settings that exist in the target system. Therefore, the restore operation
should be viewed as restoring values and not as a system settings restore
command.
Syntax
The syntax of the restore command is
asu restore file_name [--incbackupctl ] [-nx] [connect_options]
where file_name is the name of the file that was created by a previous asu save
command or by redirecting the output of a previous asu show command to a file.
Notes:
1. The optional –incbackupctl parameter is used on a restore operation to specify
whether the settings that are defined by the backupctl class are to be included.
To list the backcupctl class, use the show command and specify the backupctl
class.
2. The connect options are defined for only IMM-based servers. The --host
ip_address connect option is required if you connect remotely to the IMM. The
--user user_id and --password password connect options are required only if the
default user ID and password settings are changed in the IMM for either a local
or remote LAN connection. The --user user_id and --password password
connect options are not required if you are using the local KCS interface.
Output
Each setting and the restored value are displayed.
<setting 1>=<value 1>
<setting 2>=<value 2>
.
.
.
<setting n>=<value n>
Output:
uEFI.Com1BaudRate=115200
uEFI.Com1DataBits=8
uEFI.Com1Parity=None
uEFI.Com1StopBits=1
uEFI.Com1TextEmul=VT100
uEFI.Com1ActiveAfterBoot=Enable
uEFI.Com1FlowControl=Disable
Output:
CMOS_CRTRequired=Enabled
CMOS_KbdRequired=Enabled
.
.
.
CMOS_OSUSBControl=Other OS
Note: The output is identical to the save or show output file that is used as input to
the restore command.
Limitations:
Settings that are defined in the password class or authentication settings (user IDs)
class settings are not saved during a save operation. To list the settings that belong
to the password class, type the following command:
asu showvalues password
Syntax
The syntax of the save command is
asu save file_name [--group group_name | --setlist set_name1..set_nameN]
[--excbackupctl] [-nx] [connect_options]
where file_name is the name of the file to which the saved settings are written.
Notes:
1. If the optional --group parameter is specified, only settings that belong to the
specified group are saved.
2. If the optional --setlist parameter is specified, only settings that belong to the
specified list of settings are saved.
3. If the optional --excbackupctl parameter is specified, backup control settings
(settings in the class backupctl) are not saved.
4. If the optional -nx parameter is specified, the ASU performs the operation for
node x, where x is the selected node in a multi-node system. x can be a
number from 1 through 8. If the -nx parameter is not specified, the operation is
performed on the primary node (node 1).
5. The connect options are defined for only IMM-based servers. The --host
ip_address connect option is required if you connect remotely to the IMM. The
--user user_id and --password password connect options are required only if the
default user ID and password settings are changed in the IMM for either a local
or remote LAN connection. The --user user_id and --password password
connect options are not required if you are using the local KCS interface.
Output
The output of the save command is a message that indicates that the settings are
saved to the file name that is specified in the command.
Examples
The save command and corresponding output are shown in the following examples.
Output:
Settings saved to save.txt
Output:
Settings saved to save.txt
Output:
Settings saved to save.txt
Output:
Settings saved to save.txt
Output:
Settings saved to save.txt
Syntax
The syntax of the set command is either:
asu set setting value [-v] [-nx] [connect_options]
Use the command asu show all to show a list of available settings; value is the
exact value string to set for setting.
For settings with a single value, the asu showvalues command output is
setting_name=value.
Or
asu set setting value1=value2=valueN [-v] [-nx] [connect_options]
where setting is the name of a setting to change that can accept a list of values.
Use the asu showvalues setting command to show a list of all values that are
available for the setting.
For settings that allow a list of values, the asu showvalues command output
syntax is setting_name==value1=value2=valueN. The double equal sign (==) shows
that the setting can accept single or multiple values in an ordered list.
Limitations:
Settings that are defined in the password class cannot be set remotely. To list the
settings that belong to the password class, use the command:
asu showvalues password
Notes:
1. Values that contain spaces must be enclosed in quotation marks ( " ). If a value
contains quotation marks, add a backslash before each quotation mark ( \" ) in
the value.
2. If the optional -v parameter is specified, the output is verbose.
3. If the optional -nx parameter is specified, the ASU performs the operation for
node x, where x is the selected node in a multi-node system. x can be a
number from 1 through 8. If the -nx parameter is not specified, the operation is
performed on the primary node (node 1).
4. The connect options are defined for only IMM-based servers. The --host
ip_address connect option is required if you connect remotely to the IMM. The
--user user_id and --password password connect options are required only if the
default user ID and password settings are changed in the IMM for either a local
or remote LAN connection. The --user user_id and --password password
connect options are not required if you are using the local KCS interface.
Examples
The set command and corresponding output are shown in the following examples.
Command line:
asu set CMOS_CRTRequired Disabled
Output:
CMOS_CRTRequired=Disabled
Command line:
asu set CMOS_DisketteA “1.44 MB 3.5\””
Output:
CMOS_DisketteA=1.44 MB 3.5”
Command line:
asu set RSAIP_HostIPAddress1 192.168.0.100
Output:
RSAIP_HostIPAddress1=192.168.0.100
Command line:
asu set RSAString_LoginId2 rsauser
Output:
RSAString_LoginId2=rsauser
Command line to set the boot order to be CD/DVD ROM, then diskette, and then
Hard Disk 0:
asu set BootOrder.BootOrder "CD/DVD Rom=Floppy Disk=Hard Disk 0"
Output:
BootOrder.BootOrder=CD/DVD Rom=Floppy Disk=Hard Disk 0
Command line:
asu set iSCSI.AttemptName.2 "MyAttempt2Name"
Output:
iSCSI.AttempName.2=MyAttempt2Name
Note: All other settings in this record (for example, iSCSI.LocalIp.2 and
iSCSI.SubnetMask.2) are set to default values.
Command line:
asu set iSCSI.LocalIp.2 "9.5.107.170"
Output:
iSCSI.LocalIp.2=9.5.107.170
Output:
iSCSI.SubnetMask.2="255.255.255.0"
Syntax
The syntax of the show command is
asu show [all | --group group_name | setting_name |
--setlist name1..nameN | class] [-v] [-nx] [connect_options]
If no setting command modifier or class setting is specified, all settings and their
current values are displayed.
Notes:
1. If the optional all parameter is specified, all settings are displayed.
2. If the optional --group group_name is specified, only settings in the group
group_name are displayed.
3. If the optional --setlist name1..nameN is specified, only the settings that are
specified in name1..nameN are displayed.
4. If the optional class setting is specified, only settings that belong to the specific
class are displayed.
5. If the optional -v parameter is specified, the output is verbose.
6. If the optional -nx parameter is specified, the ASU performs the operation for
node x, where x is the selected node in a multi-node system. x can be a
number from 1 through 8. If the -nx parameter is not specified, the operation is
performed on the primary node (node 1).
7. The connect options are defined for only IMM-based servers. The --host
ip_address connect option is required if you connect remotely to the IMM. The
--user user_id and --password password connect options are required only if the
default user ID and password settings are changed in the IMM for either a local
or remote LAN connection. The --user user_id and --password password
connect options are not required if you are using the local KCS interface.
Output
If the –v parameter is not specified, the setting and the current value are displayed.
If the –v parameter is specified, the description of the setting is displayed as well as
an indicator that the value is the default value.
Command line:
asu show RSAIP_HostIPAddress1
Output:
RSAIP_HostIPAddress1=192.168.0.100
Command line:
asu show CMOS_WakeOnLAN –v
Output:
CMOS_WakeOnLAN: Wake On Lan = Enabled (default)
Command line:
asu show bios
Output:
CMOS_DisketteA=1.44 MB 3.5"
CMOS_CRTRequired=Disabled
.
.
.
CMOS_OSUSBControl=Other OS
Syntax
The syntax of the showdefault command is
asu showdefault [all | --group group_name | setting_name |
--setlist name1..nameN | class] [-v] [-nx] [connect_options]
If no setting command modifier or class setting is specified, all settings and their
current values are displayed.
Notes:
1. If the optional all parameter is specified, all setting are displayed.
2. If the optional --group group_name is specified, only settings in the group
group_name are displayed.
3. If the optional --setlist name1..nameN is specified, only the settings that are
specified in name1..nameN are displayed.
4. If the optional class setting is specified, only settings that belong to the specific
class are displayed.
5. If the optional -v parameter is specified, the output is verbose.
6. If the optional -nx parameter is specified, the ASU performs the operation for
node x, where x is the selected node in a multi-node system. x can be a
number from 1 through 8. If the -nx parameter is not specified, the operation is
performed on the primary node (node 1).
7. The connect options are defined for only IMM-based servers. The --host
ip_address connect option is required if you connect remotely to the IMM. The
--user user_id and --password password connect options are required only if the
default user ID and password settings are changed in the IMM for either a local
or remote LAN connection. The --user user_id and --password password
connect options are not required if you are using the local KCS interface.
Output
If the –v parameter is not specified, the setting and the default value are displayed.
If the –v parameter is specified, the description of the setting is also displayed.
For instance settings, the default state can be that the instance does not exist. If
this is the case, the default value that is output by the showdefault command is
“delete.” This indicates that all instances of the setting are deleted if the
loaddefault command is performed on the setting. For more information about
instances, see “Instances of settings” on page 18.
Command line:
asu showdefault CMOS_WakeOnLAN –v
Output:
CMOS_WakeOnLAN: Wake On Lan = Enabled
Command line:
asu showdefault bios
Output:
CMOS_DisketteA=1.44 MB 3.5"
CMOS_CRTRequired=Disabled
.
.
.
CMOS_OSUSBControl=Other OS
Command line:
asu showdefault iSCSI.AttemptName.1
Output:
iSCSI.AttemptName.1=<remove>
Syntax
The syntax of the show command is
asu showgroups [-nx] [connect_options]
Notes:
1. If the optional -nx parameter is specified, the ASU performs the operation for
node x, where x is the selected node in a multi-node system. x can be a
number from 1 through 8. If the -nx parameter is not specified, the operation is
performed on the primary node (node 1).
2. The connect options are defined for only IMM-based servers. The --host
ip_address connect option is required if you connect remotely to the IMM. The
--user user_id and --password password connect options are required only if the
default user ID and password settings are changed in the IMM for either a local
or remote LAN connection. The --user user_id and --password password
connect options are not required if you are using the local KCS interface.
Output
The setting groups that are available on the server are displayed.
Examples
The showgroups command and corresponding output are shown in the following
example.
Command line:
asu showgroups
Use the showlocation command to show the location of one or more settings. This
shows where the actual data for the setting is stored.
Syntax
The syntax of the showlocation command is
asu showlocation [all | --group group_name | setting_name |
--setlist name1..nameN | class] [-v] [-nx] [connect_options]
If no setting command modifier or class setting is specified, all settings and their
current values are displayed.
Notes:
1. If the optional all parameter is specified, all setting are displayed.
2. If the optional --group group_name is specified, only settings in the group
group_name are displayed.
3. If the optional --setlist name1..nameN is specified, only the settings that are
specified in name1..nameN are displayed.
4. If the optional class setting is specified, only settings that belong to the specific
class are displayed.
5. If the optional -v parameter is specified, the output is verbose.
6. If the optional -nx parameter is specified, the ASU performs the operation for
node x, where x is the selected node in a multi-node system. x can be a
number from 1 through 8. If the -nx parameter is not specified, the operation is
performed on the primary node (node 1).
7. The connect options are defined for only IMM-based servers. The --host
ip_address connect option is required if you connect remotely to the IMM. The
--user user_id and --password password connect options are required only if the
default user ID and password settings are changed in the IMM for either a local
or remote LAN connection. The --user user_id and --password password
connect options are not required if you are using the local KCS interface.
Output
If the –v parameter is not specified, the setting and its location are displayed. If the
–v parameter is specified, the description of the setting is also displayed.
Examples
The showlocation command and corresponding output are shown in the following
examples.
Command line:
asu showlocation CMOS_SerialA
Output:
CMOS_SerialA=CMOS[70,00,03]
Command line:
asu showlocation CMOS_SerialA –v
Output:
CMOS_SerialA: Serial Port A {
CMOS[70,00,03]
}
Command line:
asu showlocation RSA_Network1
Output:
RSA_Network1=SP[04.09.01.01.02]
Command line:
asu showlocation RSA_Network1 -v
Output:
RSA_Network1: Network Interface 1 {
SP[04.09.01.01.02]
}
Syntax
The syntax of the showvalues command is
asu showvalues [all | --group group_name | setting_name |
--setlist name1..nameN | --instances | class] [-v | -t] [-nx] [connect_options]
Notes:
1. If the optional all parameter is specified, all setting are displayed.
2. If the optional --group group_name is specified, only settings in the group
group_name are displayed.
3. If the optional --setlist name1..nameN is specified, only the settings that are
specified in name1..nameN are displayed.
4. If the optional class setting is specified, only settings that belong to the specific
class are displayed.
5. If the optional -v parameter is specified, the output is verbose.
6. If the optional -t parameter is used, the output includes the raw values.
7. If the optional -nx parameter is specified, the ASU performs the operation for
node x, where x is the selected node in a multi-node system. x can be a
number from 1 through 8. If the -nx parameter is not specified, the operation is
performed on the primary node (node 1).
8. The connect options are defined for only IMM-based servers. The --host
ip_address connect option is required if you connect remotely to the IMM. The
--user user_id and --password password connect options are required only if the
default user ID and password settings are changed in the IMM for either a local
or remote LAN connection. The --user user_id and --password password
connect options are not required if you are using the local KCS interface.
9. If the optional --instances parameter is specified, only settings that can have
instances are displayed. The minimum and maximum number of instances
allowed for the settings is also displayed. For more information about instances,
see “Instances of settings” on page 18.
Output
If the –v parameter is not specified, the setting and its values are displayed. If the
–v parameter is specified, the description of the setting is also displayed.
–v specified:
<setting>: <setting description> {
<value 1>
<value 2>
.
.
.
<value n>
}
–v not specified:
<setting>=char[<length>]
<length> is the max length string that can be entered.
If <length> is omitted, there is no maximum.
–v specified:
<setting>: <setting description> {
char[<length>]
}
<length> is the max length string that can be entered.
If <length> is omitted, there is no maximum.
–v not specified:
<setting>= x.x.x.x where (0 <= x <= 255)
–v specified:
<setting>: <setting description> {
A string formatted x.x.x.x, where x is an integer from 0 to 255
}
–v not specified:
<setting>= x:x:x:x where (0 <= x <= FF)
–v specified:
<setting>: <setting description> {
A string formatted x:x:x:x, where x is a hex integer from 0 to FF
}
–v not specified:
<setting>=(c )* where c in [0x01-0xFF, ’ESC’, ^A-^Z, ^[-^_, ’ ’-’~’]
–v specified:
<setting>: <setting description> {
A space-separated sequence of characters where each of the characters is:
0x01-0xFF, ’ESC’, ^A-^Z, ^[-^_, ’ ’, ’!’, ’#’, ’$’, ’%’, ’&’,
’(’, ’)’, ’*’, ’+’, ’,’, ’-’, ’.’, ’/’, ’0’-’9’, ’:’, ’;’, ’<’,
’=’, ’>’, ’?’, ’@’, A’-’Z’, ’[’, ’\’, ’]’, ’^’, ’_’, ’a’-’z’,
’{’, ’|’, '}’, or ’~’
If the --instances parameter is specified, the output for a setting that is not
part of a record is:
-v not specified:
<setting>= numeric type=dec min=0 max=65535 default=3260 [min=0, max=256]
The output for the setting indicates that it can have anywhere from
0 to 256 instances. This is indicated by '[min=0, max=256]’
The verbose output for the setting also indicates that it can have anywhere from 0
to 256 instances. In this case this is indicated by ‘min instances = 0’ and ‘max
instances = 256’.
If the --instances parameter is specified, the output for a settings that are part
of a record is:
-v not specified:
setting1=char[] default="" [min=0, max=12] recordKey
setting2=char[] default="" [min=0, max=12] recordKey="setting1"
setting3=char[] default=”” [min=0, max=12] recordKey="setting1"
The output for all of the settings indicate that they can have anywhere from 0 to 12
instances. setting1 is the recordKey and setting2 and setting3: are part of a record,
where setting1 is the key setting. For more information about records, see “Record
management” on page 19.
-v specified:
<setting1>: <setting1 description> {
char[]
default =
min instances = 0
max instances = 12
Record Key
}
<setting2>: <setting2 description> {
char[]
maximum characters = 16
pattern = ^(.{4,16})?
default =
Record Key = <setting1>
}
<setting3>: <setting3 description> {
char[]
maximum characters = 16
pattern = ^(.{4,16})?
default =
Record Key = <setting1>
}
The verbose output for setting1 also indicates that it can have anywhere from 0 to
256 instances. In this case this is indicated by ‘min instances = 0’ and ‘max
instances = 256’. setting1 is the recordKey and setting2 and setting3 are part of the
same record as setting1, where setting1 is the key setting. For more information
about records, see “Record management” on page 19.
Command line:
asu showvalues CMOS_SerialA
Output:
CMOS_SerialA=PnP=Auto-configure=<Port 3F8, IRQ 4>=Port 2F8,
IRQ 3=Port 3E8, IRQ 4=Port 2E8, IRQ 3=Disabled
Command line:
asu showvalues CMOS_SerialA –v
Output:
CMOS_SerialA: Serial Port A {
PnP
Auto-configure
Port 3F8, IRQ 4 (default)
Port 2F8, IRQ 3
Port 3E8, IRQ 4
Port 2E8, IRQ 3
Disabled
}
Command line:
asu showvalues CMOS_SerialA -t
Output:
CMOS_SerialA=PnP=Auto-configure=<Port 3F8, IRQ 4>=Port 2F8,
IRQ 3=Port 3E8, IRQ 4=Port 2E8, IRQ 3=Disabled
Command line:
asu showvalues -–instances
Output:
IMM.LoginId=char[] maxchars=16 pattern=^(.{4,16})? default=<remove>
[min=0, max=12] recordKey
IMM.Password=char[] default="" [min=0, max=12] recordKey="IMM.LoginId"
IMM.AuthorityLevel=<Supervisor>=ReadOnly=Custom [min=0, max=12]
recordKey="IMM.LoginId"
Beginning with ASU 3.00, the version number uses the following standard format:
w.xy.zzz
where w is the major revision number (this value changes if there are major new
features in the release), x is the minor revision number (this value changes if there
are only minor new features in the release), y is the sub-minor revision number (this
value changes if there are only fixes in the release), and zzz is the build number.
Syntax
The syntax of the version command is
asu version
Output
The output of the version command shows the current version and build date of
the ASU.
Example
The version command and corresponding output are shown in the following
example.
Command line:
asu version
Output:
Advanced Settings Utility 3.00.65A Mar 12 2009
Use the writeraw command to read and write CMOS data that is saved in a file
through the readraw command.
Syntax
The syntax of the writeraw command is
asu writeraw filename [-nx]
where filename is the name of a file in which the raw CMOS data is to be read.
Note: If the optional -nx parameter is specified, the ASU performs the operation for
node x, where x is the selected node in a multi-node system. x can be a
number from 1 through 8. If the -nx parameter is not specified, the operation
is performed on the primary node (node 1).
Output
The output of the writeraw command is a file that is generated in the directory
where the ASU is running and a message that indicates that the raw write operation
is completed.
Examples
The writeraw command and corresponding output are shown in the following
example.
Command line:
asu writeraw CMOSraw.dat
Output:
Raw CMOS read from CMOSraw.dat, written to CMOS
CMOSraw.dat file generated
You can solve many problems without outside assistance by following the
troubleshooting procedures that IBM provides in the online help or in the
documentation that is provided with your IBM product. The documentation that
comes with IBM systems also describes the diagnostic tests that you can perform.
Most systems, operating systems, and programs come with documentation that
contains troubleshooting procedures and explanations of error messages and error
codes. If you suspect a software problem, see the documentation for the operating
system or program.
For more information about Support Line and other IBM services, see
http://www.ibm.com/services/, or see http://www.ibm.com/planetwide/ for support
telephone numbers. In the U.S. and Canada, call 1-800-IBM-SERV
(1-800-426-7378).
In the U.S. and Canada, hardware service and support is available 24 hours a day,
7 days a week. In the U.K., these services are available Monday through Friday,
from 9 a.m. to 6 p.m.
IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may be
used instead. However, it is the user's responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not give you any
license to these patents. You can send license inquiries, in writing, to:
IBM Director of Licensing
IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.
IBM may use or distribute any of the information you supply in any way it believes
appropriate without incurring any obligation to you.
Trademarks
IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of
International Business Machines Corporation in the United States, other countries,
or both. If these and other IBM trademarked terms are marked on their first
occurrence in this information with a trademark symbol (® or ™), these symbols
indicate U.S. registered or common law trademarks owned by IBM at the time this
information was published. Such trademarks may also be registered or common law
trademarks in other countries. A current list of IBM trademarks is available on the
web at “Copyright and trademark information” at http://www.ibm.com/legal/
copytrade.shtml.
© Copyright IBM Corp. 2004, 2010 97
Adobe and PostScript are either registered trademarks or trademarks of Adobe
Systems Incorporated in the United States and/or other countries.
Intel, Intel Xeon, Itanium, and Pentium are trademarks or registered trademarks of
Intel Corporation or its subsidiaries in the United States and other countries.
Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc., in
the United States, other countries, or both.
UNIX is a registered trademark of The Open Group in the United States and other
countries.
Important notes
Processor speed indicates the internal clock speed of the microprocessor; other
factors also affect application performance.
CD or DVD drive speed is the variable read rate. Actual speeds vary and are often
less than the possible maximum.
When referring to processor storage, real and virtual storage, or channel volume,
KB stands for 1024 bytes, MB stands for 1 048 576 bytes, and GB stands for
1 073 741 824 bytes.
Maximum internal hard disk drive capacities assume the replacement of any
standard hard disk drives and population of all hard disk drive bays with the largest
currently supported drives that are available from IBM.
Documentation format
The publications for this product are in Adobe Portable Document Format (PDF)
and should be compliant with accessibility standards. If you experience difficulties
when you use the PDF files and want to request a web-based format or accessible
PDF document for a publication, direct your mail to the following address:
Information Development
IBM Corporation
205/A015
3039 E. Cornwallis Road
P.O. Box 12195
Research Triangle Park, North Carolina 27709-2195
U.S.A.
In the request, be sure to include the publication part number and title.
When you send information to IBM, you grant IBM a nonexclusive right to use or
distribute the information in any way it believes appropriate without incurring any
obligation to you.
Appendix B. Notices 99
100 Advanced Settings Utility Version 3.60: User’s Guide
Index
A D
accessible documentation 99 DHCP server, using 13
Advanced Settings Utility, using documentation format 99
asu command 12
configuring Ethernet settings
for Windows 2000 14 E
overview 13 Ethernet, configuring settings 13
configuring serial connection for Windows 2000 14
configuring settings in IMM-based server 15
connecting to IMM-based server 15 F
obtaining the ASU and patch files 9 firmware types supported 1
operating system support 2
supported firmware 1
supported systems 6
unpacking ASU files for Linux 12
G
getting help 95
unpacking ASU files for Windows 11
using the ASU patches 10
assistance, getting 95
ASU files H
unpacking for Linux 12 hardware service and support 96
unpacking for Windows 11 help, getting 95
B I
baseboard management controller startup sequence IBM Support Line 96
settings 34 IMM settings syntax 17
boot-order settings for IMM-based servers 36 IMM-based server
configuring settings 15
connecting ASU to 15
C IPMI device driver support
for Linux 8
classes of settings for ASU 23
for Windows 7
command configuration applications
iSCSI configuration 37
immcfg 22
savestat 22
command connectivity options 27
command general options L
--help 32 LAN over USB interface
-nx 29 configuration application syntax 22
bypass 28 immcfg 22
dumptofile 28 Linux
showsptraffic 30 IPMI device driver support 8
silent 31 support for the ASU 2
command modifiers 25 unpacking the ASU files 12
command reference 41
command syntax 21
configuring M
Ethernet settings 13 Microsoft Windows 2000
serial connection 14 configuring Ethernet settings 14
settings in IMM-based server 15 configuring serial connection 14
configuring Remote Supervisor Adapter settings
configuring Ethernet settings 13
setting up communication with the ASU 13 N
connectivity options 27 notes, important 98
notices 97
P
patch files
obtaining 9
using 10
R
Remote Supervisor Adapter
communicating with the ASU 13
configuring Ethernet settings 13
return codes 33
S
serial connector, configuring 14
settings syntax in IMM-based servers 17
software service and support 96
support, website 95
syntax for commands 21
systems supported 6
T
telephone numbers 96
trademarks 97
U
unpacking ASU files
for Linux 12
for Windows 11
W
website
publication ordering 95
support 95
support line, telephone numbers 96
Windows
IPMI device driver support 7
support for the ASU 2
unpacking ASU files 11
Windows 2000
configuring Ethernet settings 14
configuring serial connection 14
Windows PE 2.0 or later considerations 5
Windows PE l,6 or earlier considerations 4
Windows Server 2008 considerations 5
Printed in USA