Asu Manual
Asu Manual
IBM
Note Before using this information and the product it supports, read the information in Notices on page 113.
Edition Notice This edition applies to version 9.20 of IBM Advanced Settings Utility and to all subsequent releases and modifications until otherwise indicated in new editions. Fifteenth Edition (May 2012) Copyright International Business Machines Corporation 2004, 2012. US Government Users Restricted Rights -- Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. Copyright IBM Corporation 2012. US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
Contents
Tables . . . . . . . . . . . . . . . v Chapter 1. Using the Advanced Settings Utility . . . . . . . . . . . . . . . . 1
Limitations . . . . . . . . . . . . . . Supported firmware . . . . . . . . . . . Operating system support . . . . . . . . . WinPE support . . . . . . . . . . . Windows Server 2008 support . . . . . . IPMI device driver support for Windows . . . . Installing the Microsoft IPMI device driver . . Verifying the installation . . . . . . . . IPMI device driver support for Linux . . . . . Obtaining the ASU and patch files . . . . . . Downloading the Advanced Settings Utility . . Using ASU patch files . . . . . . . . . Extracting the ASU files for Windows. . . . Extracting the ASU files for Linux . . . . . Using the ASU commands . . . . . . . . Using the ASU to configure the Remote Supervisor Adapters settings . . . . . . . . . . . Setting up communication with the ASU . . Configuring the Ethernet settings on a Remote Supervisor Adapter II . . . . . . . . . Configuring IMM-based servers using ASU. . . Connectivity . . . . . . . . . . . . Enabling and disabling the LAN over USB interface . . . . . . . . . . . . . Settings syntax . . . . . . . . . . . Instances of settings . . . . . . . . . Using the Remote Disk Command Line Interface . Using the ASU to configure settings for VMware ESXi/vSphere Hypervisor . . . . . . . . uEFI settings in an IMMv1 system. . . . . uEFI settings in an IMM2 system . . . . . Known limitations . . . . . . . . . . . . 1 . 1 . 3 . 4 . 6 . 7 . 8 . 8 . 8 . 9 . 9 . 10 . 11 . 12 . 12 . 13 . 13 . 13 . 15 . 16 . . . . . . . . 17 18 18 20 21 24 25 26 Baseboard management controller startup sequence (boot order) settings . . . . . . . . . . . Boot order settings for IMM-based servers . . . Configuring iSCSI . . . . . . . . . . . . IPv6 related settings in IMM. . . . . . . . . Managing certificates for IMM-based systems . . . Signing a certificate sign request using certificate authority . . . . . . . . . . . . . . Revoking a certificate . . . . . . . . . . Supported commands for IMM-based certificate management . . . . . . . . . . . . . Disabling the corresponding server . . . . . Remote Disk Command Line Interface . . . . . 50 51 52 54 54 54 55 55 55 58
iii
Software service and support . Hardware service and support. Product services - Taiwan . .
. . .
. . .
. . .
. . .
. . .
. . .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. 114 . 114
Notices . . . . . . . . . . . . . . 113
iv
Tables
1. 2. 3. 4. 5. 6. Connection options for ESXi/vSphere Hypervisor image . . . . . . . . . . IMM LAN over USB configuration application commands . . . . . . . . . . . . . Supported devices and interfaces . . . . . Commands. . . . . . . . . . . . . Options . . . . . . . . . . . . . . Command options parameters . . . . . . 26 31 32 32 33 35 7. 8. 9. 10. 11. 12. 13. Available switch device codes Command modifiers . . . Command connectivity options ASU return codes . . . . RDCLI return codes . . . . Supported ASU commands . Explanation of XML. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 41 43 48 49 55 73
vi
Limitations
For IMM-based servers, consider the limitations in this topic. Some settings might require that you restart the IMM before the settings become effective or so that the values that are set through ASU can display in the IMM web interface. For IMM-based servers, ASU supports the commands to generate, import, or export security certificates. The IMM version must be at least yuoo78m or later so that ASU can manage security certificates.
Supported firmware
This topic lists the firmware types and settings that are supported by the Advanced Settings Utility.
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. The ASU supports the following firmware types: v BIOS firmware v Remote Supervisor Adapter firmware v Remote Supervisor Adapter II firmware v Baseboard management controller firmware v IBM System x Server firmware v IMM firmware v Remote Supervisor Adapter firmware v Original Design Manufacturer integrated baseboard management controller firmware v Original Design Manufacturer Remote Supervisor Adapter firmware Note: The PC-DOS version of the ASU supports BIOS settings only.
Supported settings
For the firmware types, the following settings are supported: v Banked CMOS at 70h/71h (NS317) v v v v v CMOS at 70h/71h and 72h/73h (NS417) CMOS at 72h/73h (AMD 8111) CMOS through baseboard management controller Serial EEPROM settings 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.
If this message is displayed, install the compat-libstdc++*.rpm that is included on the distribution media. For Linux operating systems, you must have the lsusb utility installed as a prerequisite. You can find the installation package of this utility in the corresponding Linux distribution media. For BIOS-based servers, run the ASU on the system that contains the settings that you want to view and change. When the ASU configures the settings, it interacts with the physical hardware. On operating systems that require root or administrator access to interact with the 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
Chapter 1. Using the Advanced Settings Utility
ASU does not support changing Remote Supervisor Adapter or Remote Supervisor Adapter II settings for that operating system. For baseboard management controller settings, an Intelligent Platform Management Interface (IPMI) device driver is required. A corresponding IBM IPMI mapping layer might also be required. The ASU supports interfacing with different versions of the IPMI device driver (OSA, MSI, Microsoft IPMI Driver, and OpenIPMI). For Microsoft Windows-based implementations, see IPMI device driver support for Windows.For Linux-based implementations, see IPMI device driver support for Linux. Notes v You cannot use the ASU to configure Remote Supervisor Adapter II settings from Red Hat Enterprise Linux AS 2.1 because there is no Remote Supervisor Adapter II device driver for the Red Hat Enterprise Linux AS 2.1 operating system. v You cannot use the ASU to configure Remote Supervisor Adapter or Remote Supervisor Adapter II settings from PC-DOS because there is no Remote Supervisor Adapter or Remote Supervisor Adapter II device driver for PC-DOS. v You can view or change settings on a local server only. v You cannot use the ASU to configure baseboard management controller settings from PC-DOS because there is no baseboard management controller device driver for PC-DOS. v The PC-DOS version of the ASU does not support a multi-node-capable server when it is configured as multi-node. v The PC-DOS version of the ASU does not support a server in which the BIOS settings are stored in the baseboard management controller (for example, an IBM System x3950 M2 server). v You cannot unpack the Windows ASU packages on a server or workstation that is running a 64-bit version of WinPE. You can unpack the Windows ASU packages on a server or workstation that is running any of the other Windows operating systems that support the ASU. (For a list of operating systems that support the ASU, see Operating-system support.) Note: For the latest information about IBM servers, workstations, and the operating systems that are supported, see Compatibility for hardware, applications, and middleware.
WinPE support
Windows Preinstallation Environment (WinPE) requires some special considerations for the Advanced Settings Utility (ASU) to function correctly. These considerations are different for WinPE 1.6 or earlier and WinPE 2.0 (the version that is based on the Windows Vista operating system) or later.
WinPE 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 WinPE 2.0, see IPMI device driver support for Windows.
Supported systems
The ASU supports the servers, blade servers, and computers that are listed in the following lists. v v v v v IBM IBM IBM IBM IBM System System System System System x3100 x3200 x3200 x3250 x3250 M4 M2 M3 M2 M3 Type Type Type Type Type 2582 4367, 7327, 4190, 4251, 4368 7328 4191, 4194, 7650 4252, 4261
v IBM System x3250 M4 Type 2583 v IBM System x3400 Type 7973, 7974 v v v v v v v v v v v v IBM IBM IBM IBM IBM IBM IBM IBM IBM IBM IBM IBM System System System System System System System System System System System System x3400 x3400 x3400 x3500 x3550 x3500 x3500 x3530 x3550 x3550 x3500 x3550 Type 7975, 7976 M2 Type 7836, 7837 M3 Type 7378, 7379 Type 7977 Type 7978, 1913 M2 Type 7839 M3 Type 7380 M4 M2 M3 M4 M4 Type Type Type Type Type 7160 7946, 4198 7944, 4254 7383/* 7914/*
v IBM System x3620 M3 Type 7376 v IBM System x3630 M3 Type 7377 v IBM System x3630 M4 Type 7158 v IBM System x3650 Type 7979, 1914 v IBM System x3650 M2 Type 7947, 4199 v IBM System x3650 M3 Type 7945, 4255, 5454 v IBM System x3650 M4 Type 7915/* v IBM System x3690 X5 Type 7148, 7149 v IBM System x3690 X5 Type 7192, 7147
v v v v v v v v v v v v v v
IBM IBM IBM IBM IBM IBM IBM IBM IBM IBM IBM IBM IBM IBM
M4 Type 8722,8733 M3 Type 7164 M2 / x3950 M2 Type 7141, 7144 M2 / x3950 M2 Type 7233, 7234 X5 / x3950 X5 Type 7145, 7146
System x3850 X5 / x3950 X5 Type 7143, 7191 System x iDataPlex dx320 Type 6388 System x iDataPlex dx360 M2 Type 7321, 6380, 7323 System x iDataPlex dx360 M3 Type 6391 System x iDataPlex dx360 M4 Type 7912, 7913, 7918, 7919 BladeCenter HS12 Type 8014, 8028, 1916 BladeCenter HS21 Type 8853, 1885 BladeCenter HS21 XM Type 7995, 1915 BladeCenter HS22 Type 7870, 1936, 7809, 1910
v IBM BladeCenter HS22V Type 7871, 1949 v IBM BladeCenter HS23 Type 7875, 1929 v v v v v IBM IBM IBM IBM IBM BladeCenter BladeCenter BladeCenter BladeCenter BladeCenter HS23E Type 8038, 8039 LS21/LS41 Type 7971, 7972 LS22/LS42 Type 7901, 7902 HX5 Type 7872, 1909 HX5 Type 7873, 1910
v IBM Flex System x220 Compute Node Type 7906,2585 v IBM Flex System x240 Compute Node Type 8737,8738,7863 For the latest list of supported systems, see Support for IBM Systems.
Procedure
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.
What to do next
You can verify that the installation was successful. For instructions, see Verifying the installation.
Procedure
1. Click Start Control Panel System. 2. Select the Hardware tab. 3. Click Device Manager. 4. Click View Show Hidden Devices. 5. Expand System devices. 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.
Results
For an IBM System x3950 M2 server (multi-node configuration), the Microsoft IPMI device driver is the only supported IPMI driver.
Notes
1. The default version of OpenIPMI that is in Red Hat Enterprise Linux 3 Update 6 and Red Hat Enterprise Linux 3 Update 7 has a timing issue; therefore, it is not supported by the ASU. In this case, the OSA IPMI mapping layer is required. 2. For an IBM System x3950 M2 server (multi-node configuration), the OpenIPMI device driver is the only supported IPMI driver.
Procedure
1. To download the IBM Advanced Settings Utility, go to the IBM Support Portal or complete the following steps: a. Go to the Support for IBM systems page. b. In the navigation 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, download the BIOS definition file: 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, 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. If required, download the IPMI device driver using the following steps. 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 or IPMI device driver support for Linux. a. On the Software and device drivers page, click OSA IPMI, and then select the applicable device-driver file. b. Read the .txt file and follow the instructions that guide you through the download process. 5. After you have downloaded the OSA IPMI device driver file: a. Select the applicable mapping layer for OSA IPMI file. b. Read the .txt file, and follow the instructions that guide you through the download process. 6. (For BIOS-based servers only.) On the "Software and device drivers" page: a. Click Remote Supervisor Adapter II. b. Select the applicable RSA II daemon. c. Read the .txt file, and follow the instructions that guide you through the download process.
Example of ASU output when the patchlist command is issued with the BIOS patch listed:
10
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. The following illustration shows how patches are added and removed in the ASU binary code. For each BIOS code and firmware type, the internal locations of the settings vary. A patch informs the ASU where the settings are located for a single BIOS code version. If a BIOS patch is needed and is not listed when you use the patchlist command, 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 if 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 displays 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.
Procedure
1. Change directories to the directory that contains the downloaded ASU files. 2. Choose one of the following methods to extract the ASU files: v Using Windows, double-click filename.exe, where filename is the file name for the Advanced Settings Utility for Windows that you downloaded. The files are automatically extracted to the same directory. v Using a command prompt, type filename.exe, where filename is the file name for the Advanced Settings Utility for Windows that you downloaded.
What to do next
The ASU requires additional files for IMM-based servers. These files are required to automatically configure and activate the LAN over a USB interface. The ASU uses the LAN over USB interface as a connectivity option. For more information about connectivity options, see Command connectivity options.
Chapter 1. Using the Advanced Settings Utility
11
Procedure
1. Open an xterm or other terminal window. 2. Change directories to the directory that contains the downloaded ASU files. 3. From a shell command prompt, type one of the following commands and press Enter. v If the .tgz file for ASU was downloaded: Enter tar -zxvf filename.tgz where filename is the file name of the Advanced Settings Utility for Linux that you downloaded. The files are extracted to the same directory. v If the .rpm file for ASU was downloaded: Enter rpm -Uvh filename.rpm where filename is the file name of the Advanced Settings Utility for Linux that you downloaded. The files are extracted to the /opt/ibm/toolscenter/asu directory.
What to do next
The ASU requires additional files for IMM-based servers. These files are required to automatically configure and activate the LAN over a USB interface. The ASU uses the LAN over USB interface as a connectivity option. For more information about connectivity options, see Command connectivity options.
Explanation of variables
v In the commands, setting is the name of a setting that you want to view or change, and value is the value that you are placing on the setting.
12
v If value contains spaces, enclose the value string in quotation marks ("). v If you are using a Linux operating system, you must add either a period (.) to the path environment variable or type ./ before each ASU command. For example, type ./asu or, for a 64-bit operating system, type ./asu64.
Procedure
1. Turn on the system. 2. When the prompt Press F1 for Configuration/Setup is displayed, press F1. 3. On the Configuration/Setup Utility main menu, select Advanced Setup, and then select RSA Settings. 4. Select Other OS for a Windows operating system, or select Linux OS as the operating-system USB selection. 5. Select Save the Values and Reboot RSA, and then press Enter. Wait until the message RSA Settings saved is displayed. 6. Exit the Configuration/Setup Utility program and complete the startup of the operating system.
13
Note: If you have an accessible, active, and configured Dynamic Host Configuration Protocol (DHCP) server on your network, the host name, IP address, gateway address, and subnet mask are set automatically. You can use the Configuration/Setup Utility program that is part of the server BIOS to select DHCP server settings. For more information, 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 is available at http://www.ibm.com/systems/support/. You can also configure the DHCP setting by using the ASU. To use the ASU, continue with the following procedure. If you have an enabled DHCP server and you want to configure the serial connector, go to .
Procedure
1. If you have not already, extract the ASU files. For more information, see Extracting the ASU files for Windows or Extracting the ASU files for Linux. 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 and Patchlist command. 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 command asu show all and press Enter. 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. Restart the system by entering asu rebootrsa and pressing Enter.
14
Procedure
1. If you have not already, extract the ASU files. For more information, see Extracting the ASU files for Windows or Extracting the ASU files for Linux. 2. At the command prompt, change directories to the directory that contains the ASU files. 3. To view a list of all of the settings and assigned values, enter the asu show all command and press Enter: 4. From the following list, select the items that you want to set. v To change the modem baud rate, type the following command and press Enter: asu set RSA_ModemBaudRate1 value where value is a number from 2400 through 57600 in increments of 2400 (for example, 2400, 4800, 7200, 9600, ..., 57600). The default is 57600. 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 o 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 o 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. Restart the system by typing asu rebootrsa and pressing Enter.
15
For IMM-based servers, after you use the ASU to change settings, you must reset the IMM before you flash new firmware. If you do not reset the IMM, the changes you made to the settings might be lost. To reset the IMM, run the asu rebootimm command. The following sections describe the functions that are available to support IMM-based servers with the ASU.
Connectivity
For 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 LAN over USB connection requires authentication. A new set of connectivity parameters are required when the ASU is connected over the LAN. If the LAN over USB interface was disabled before executing a ASU command, ASU configures and activates it for ASU connection. After executing the command, ASU disables the interface. If the interface was enabled before, it remains enabled without changes so that ASU can keep the LAN over USER interface the same status as before and after the ASU command. 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 connectivity parameters, the ASU attempts to connect to the IMM by using the 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.
16
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 online. The ASU can connect to the IMM remotely when the server is connected to power or is using standby power. Both IPv4 and IPv6 are supported remotely by ASU. Before running ASU, be sure that the IMM net configuration is correct. To connect remotely, the --host option is a required. The following example indicates the minimum required parameter when the ASU connects remotely through the LAN to the IMM external port. asu show --host target_IMM_external_IP_address
To connect remotely to an IMM from a Windows client to display all available settings, type the following command. The IMM external IP address is 9.5.51.37.
asu show all --host 9.5.51.37 --user testid --password test
To connect locally to an IMM from a Windows operating system to display all available settings, type the following command. The ASU connects to the IMM through the LAN over USB interface.
asu show all --user testid --password test
Chapter 1. Using the Advanced Settings Utility
17
To connect locally to an IMM from a Windows operating system to display all available settings, type the following command. The ASU attempts to connect over the LAN over USB interface by using the default IMM authentication credentials. If the default settings do not match, the ASU attempts to use the KCS interface, provided that the IPMI device drivers and mapping layers are installed.
asu show all
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.
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. The following groups of settings or firmware settings are supported: v UEFI - UEFI (BIOS) settings v BootOrder - Boot-order configuration in UEFI v iSCSI - iSCSI supported settings (Boot-over-iSCSI settings) v SYSTEM_PROD_DATA - User-configurable VPD settings There is a new setting syntax to use for identifying the corresponding group of settings. The setting name is preceded by the corresponding group name:
group_name.setting_name
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. 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
This topic explains instances of settings on IMM-based servers. The ASU 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
18
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. The 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.
Record management
This topic explains how instances can be part of a record and how to manage instances in a record. Record management is a new feature in the ASU. 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 represents the primary setting for the record. All settings in a record are created or deleted as a group. To create an instance of a record, you must first perform a "set" on the key setting of the record. This automatically causes an instance to be created and set to its default value for all other settings in the record. For examples of creating an instance of a setting, see the Set command.
19
To delete an instance of a record, the delete command is performed on the "record key" setting. This automatically deletes all other instances for the settings in the record. For examples of deleting an instance of a setting, see the Delete command.
Considerations
Note the following points before using the RDCLI: v To use the RDCLI mount image to connect to a remote IMM-based system, the system must be installed with the remote present key and function enabled. v RDCLI does not work if there is a session started with the remote present function through the IMM web user interface. v RDCLI is supported only in rack IMM-based servers. RDCLI does not support IMM-based blade servers.
20
Package
RDCLI contents: rdmount -- Performs authentication and spawns new file server processes that allow access to the virtual disk. It can also query the existing file server processes. rdumount -- Binary to unmount an ISO, DVD, or CD from a remote IMM-based server These 2 binaries are packaged under the rdcli32 and rdcli64 directory within ASU Linux distribution.
Supported commands
For the ESXi/vSphere Hypervisor OS, ASU only supports three basic commands for configuration. show: get the current setting value
21
set: modify the current setting value showvalues: get the values the setting support Note: The <setting_name> is the setting that refers to IMM, uEFI, and BootOrder. But a group name such as IMM, uEFI, or all is not supported.
Supported settings
BootOrder settings BootOrder.BootOrder BootOrder.WolBootOrder
IMM settings
IMM.ShutdownAndPowerOff IMM.PowerOnServer IMM.ShutdownAndRestart IMM.LoginId.1 IMM.AuthorityLevel.1 IMM.Password.1 IMM.UserAccountManagementPriv.1 IMM.RemoteConsolePriv.1 IMM.RemoteConsoleDiskPriv.1 IMM.RemotePowerPriv.1 IMM.ClearEventLogPriv.1 IMM.BasicAdapterConfigPriv.1 IMM.AdapterConfigNetworkSecurityPriv.1 IMM.AdvancedAdapterConfigPriv.1 IMM.SNMPv3_AuthenticationProtocol.1 IMM.SNMPv3_PrivacyProtocol.1 IMM.SNMPv3_PrivacyPassword.1 IMM.SNMPv3_AccessType.1 IMM.SNMPv3_TrapHostname.1 IMM.User_Authentication_Method
22
IMM.LockoutPeriod IMM.WebTimeout IMM.AccountSecurity IMM.LoginPassword IMM.RemoteAlertRecipient_Status.1 IMM.RemoteAlertRecipient_Name.1 IMM.RemoteAlertRecipient_Email.1 IMM.RemoteAlertRecipient_IncludeEventLog.1 IMM.RetryLimit IMM.EntriesDelay IMM.RetryDelay IMM.SerialRedirectionCLIMode1 IMM.SerialBaudRate IMM.CIMOverHTTPPort IMM.CIMOverHTTPSPort IMM.HTTPPort IMM.SSLPort IMM.TelnetPort IMM.SSHPort IMM.SNMP_AgentPort IMM.SNMP_TrapPort IMM.SNMPTraps IMM.Community_Name.1 IMM.SSL_Server_Enable IMM.CIMXMLOverHTTPS_Enable IMM.SSL_Client_Enable IMM.SSH_Enable
23
24
uEFI.Com1DataBits uEFI.Com1Parity uEFI.Com1StopBits uEFI.Com1TextEmul uEFI.Com1ActiveAfterBoot uEFI.Com1FlowControl uEFI.EnergyManager uEFI.PerformanceStates uEFI.WatchdogTimerUefi uEFI.WatchdogTimerUefiValue uEFI.RebootOnNMI uEFI.ForceLegacyVideo uEFI.Rehook19 uEFI.ThunkSupport uEFI.EnableLegacyPxe uEFI.Usb20_1
You can also get the list using the command asu show uefi <connection_options> in a Windows or Linux operating system of your current IMM2 system. Notes: 1. The settings listed above are all supported through the ESXi CIM stack. However, some IMMv1 or IMM2 systems might not have all of the settings above. Some settings might not be supported by different systems. 2. ASU ESXi support is limited: v Only three commands are supported. Other ASU commands like showdefault, loaddefault, and showgroups are still not supported. v ASU only supports a uEFI group on IMM2-based systems; no other groups or subgroups are supported. v There is no support for setting attributes. Some settings have dependency or are read-only, but ASU ESXi support cannot check it. If you try to modify
25
read-only settings, some might fail and some might set successfully, but cannot take effect on IMM/uEFI systems. 3. Some of the above settings have instance IDs; for example IMM.LoginId.1, where 1 is a positive integer instance ID. Generally, the instance ID 1 is the default, and you can configure it.
Table 1. Connection options for ESXi/vSphere Hypervisor image Parameter --host <OS ip> Required Yes Description ESXi/vSphere Hypervisor image IP address. Both IPv4 and IPv6 are supported. ESXi/vSphere Hypervisor image user, need root here Password for root user If [http] is not specified, ASU uses https to connect to the ESXi/vSphere Hypervisor image. The connection port; the default port for https is 5989.
--port <port>
Optional
asu.exe set <setting_name> <setting_value> --host <OS_ip> --user root asu.exe showvalues <setting_name> --host <OS_ip> --user root
Known limitations
This topic lists all of the known limitations. 1. RDCLI only supports ISO/CDROM/DVDROM as the mount source. 2. RDCLI does not support non-IMM systems. 3. Limitations on system settings (x3755 M3 type 7164): v Settings are read-only: BMC_User02LAN_Priv BMC_User02Serial_Priv BMC_User02Name BMC_NetworkMACAddress v Settings are dependent on other settings: BMC_NetworkIPAddress BMC_NetworkIPSubnetMask These two settings can be set only after BMC_NetworkIPAddrSource is set to "Static Address." v Settings need proper value: BMC_NetworkIPDefaultGateway BMC_NetworkIPBackupGateway Value of these settings must follow the same pattern as BMC_NetworkIPAddress and BMC_NetworkIPSubnetMask v After configuration, you must wait one second for settings to take effective. BMC_NetworkIPAddress BMC_NetworkIPSubnetMask BMC_NetworkIPDefaultGateway
26
v BMC_NetworkIPAddrSource only supports DHCP/Static Address/Other 4. ASU certificate management does not support system list below:
x3755 M3 Type 7164
5. ASU does not support the loaddefault value for the boot order on IMM-based systems. The loaddefault command does not change the boot order to the default value.
27
28
Command syntax
Before using the command-line interface, read the following guidelines. 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 fodcfg v command is one of the commands that is listed in the Command reference. 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.) 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. 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.) 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.) v Brackets ([ ]) indicate that an application, option, or class is optional. Brackets are not part of the command that you type.
29
Savestat
The savestat application is used by the scripting toolkit to save and restore the state information about the system. This function is supported for both IMM-based servers and some BIOS-based servers. The use cases for these are identical, other than the following differences: v A file called savestat.def is used for BIOS-based servers. It is supplied in the scripting toolkit run environment. v Using savestat on IMM-based servers might require additional connectivity parameters because the data is in the IMM on the server.
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. Windows:
ibm_rndis_server_os.inf device.cat
Linux:
cdc_interface.sh
30
Table 2. IMM LAN over USB configuration application commands Configuration application command setip Operating system support Windows only Command syntax to set the command asu immcfg --setip
Description Sets the operating system IP address for the LAN over USB interface Detects whether the IMM LAN over USB interface is activated
detectdevice
Windows only
asu immcfg --detectdevice asu immcfg --installdriver [--inf inf_path/name] asu immcfg --detectdriver
installdriver
Installs the IMM LAN Windows only over USB device driver Windows only Detects whether the device driver for the IMM LAN over USB interface is installed in the operating system Automatically detects Windows the presence of the Linux IMM LAN/USB device, installs the required device driver, VMware and delegates to IMM to assign IP address to the OS USB-LAN interface. Windows Auto configures the IMM LAN/USB Linux device using all default settings. VMware Default settings include: Packaged INF/CAT and .SH files Default IP addresses: 169.254.95.120 for the OS IP Address. Note: Assumes 169.254.95.118 as the IMM IP address. For multinode, the primary node is always assigned 169.254.95.120, the secondary node is 169.254.96.120, and all other must follow this pattern.
detectdriver
autocfgdhcp
autocfgstatic
31
Table 2. IMM LAN over USB configuration application commands (continued) Configuration application command disable-imm-lan Operating system support Command syntax to set the command asu immcfg --disable-imm-lan Note: This case is for inband only. This parameter is also available when you try to operate a normal ASU command like: asu show all --disable-imm-lan It also disables the LAN interface after the command is done.
Description
Takes down the IMM Windows USB LAN. 1) For Linux Windows it disables the LAN interface VMware with Windows API, unsets IP(SetupDiChangeState). 2) for Linux/VMware, it calls the ifdown and unset IP, removes the configuration file in the Linux cdc_interface.sh.
Command syntax
asu fodcfg <command> [options] [command options] [device&interface] [connection options]
Commands
Table 4. Commands Command acquirekey Description Acquire and download the activation key from the IBM web site.
32
Table 4. Commands (continued) Command installkey uninstallkey reportkey exportkey Description Install activation keys from the user-specified location to the key repository. Uninstall activation keys from the device. Inventory information of a specified key repository. Export activation keys from a specific key store.
Table 5. Options Option --help --disable-imm-lan [command options]: Acquirekey command -m <MT/DC> -u <unique id> -d <dir> -r --ibmid <userid:pwd> --auth <code> Installkey command: -f <keyfilename|dir> For the system/option feature, specify the system machine type (MT) here. For the IOM switch, specify device code (DC). Unique identifier information Download the key file to <dir> location. Install the downloaded activation key. IBM ID credential for the interactive IBM web site IBM authorization code A single activation key file. Fodcfg installs a single activation key file Description Display this help in the console window and exit. This command is the same as running with no parameters. Disable the USB LAN interface on an IMM system.
Uninstallkey command: Activation key ID returned from the report command. If keyid is "all," uninstall all keys. --keyid <keyid> Note: Some devices must follow rules to install and uninstall activation keys; --keyid all might not work correctly. Uninstall the (Upgrade 2) key first, and then (Upgrade 1). See device documents for the key management operation rules. Reportkey command: None Exportkey command: --keyid <keyid> -d <dir> [device&interface]: --device <device> --interface <interface> Support interface: ipmi, kcs, cim, snmp. Activation key ID returned from the report command. If keyid is "all", export all keys. Download the key file to <dir> location. The default value is the current folder. Support device: IMM, CMM, Switch.
Note: If a device is specified, the default interface value is all supported interfaces by the device. If an interface is specified, the default device value is the device that supports this interface. If neither are specified, the default device is IMM. [connection options]:
Chapter 2. Using the command-line interface
33
Table 5. Options (continued) Option --host <IP> --user <userid> --password <password> --cimhttp --port <port> --tftp <IP:port> --community <community> --authproto <MD5/SHA> --privproto <DES/AES> --privpasswd <password> Description Remote key repository. The default is the local IMM device. Key repository credential user name Password of the key repository Use http for the cim interface. Port for the cim interface. The default is 5989. Tftp server for the snmp interface Community for snmpv1v2. The default is public Authorization protocol for snmpv3. The default is no auth. Privacy protocol for snmpv3. The default is No privacy. Privacy password. The default is None.
Command sample
asu.exe fodcfg installkey -f .\ibm_fod_7870abcdefg_anyos.key --host 10.10.10.1
Using the address 10.10.10.1, install the activation key ibm_fod_7870abcdefg_anyos.key on the default device IMM.
asu.exe fodcfg uninstallkey --keyid b2e61a48881917af --host 10.10.10.1 --user USERID --password PASSW0RD --device cmm interface cim
Using the address 10.10.10.1 through the cim interface, uninstall the activation key b2e61a48881917af in CMM.
asu.exe fodcfg uninstallkey --device switch --keyid all --user abc --password abc123 --authproto MD5 --tftp 9.125.90.179:69 --host 9.125.90.190
Using the address 9.125.90.190 through the snmp interface, uninstall all the activation keys in the switch. Note: The ASU fodcfg application needs an extra tftp server to run on switches using the snmp interface. Make sure that you have both write and read access for the tftp server. The ASU fodcfg application supports both snmp v1v2 and snmp v3. Make sure that the switch is properly configured and that you have the authority to perform operations on the switch.
34
ASU supports FoD key management in-band when --host is not specified. First, ASU tries to get the IP address for the LAN-over-USB. The default values for --user and --password are USERID and PASSW0RD, respectively. ASU defaults to KCS if LAN-over-USB fails. ASU supports work on the CIM interface by connecting with HTTP and HTTPS. By default, ASU tries to connect with HTTPS, and the default port is 5989. You can specify --cimhttp to try the connection with HTTP, and then also specify --port 5988, which is the port for HTTP. Before running ASU, configure the IMM correctly.
CMM
Only the CIM interface is supported on CMM; no in-band methods are available. You must enter --host for CMM management. The default values for --user and --password are USERID and PASSW0RD, respectively. ASU supports both HTTP and HTTPS. You can use the CIM interface on a CMM device the same as on an IMM device. Before running ASU, make sure that the CMM CIM interface is configured correctly.
IOM switches
The IOM switch is designed to use SNMP for FoD activation key management, and needs additional TFTP server for key file transactions. ASU supports operations only on TFTP. You must prepare TFTP before running the ASU command for FoD management on the IOM switch. In the command line, --tftp <IP:port> is for tftp. Make sure that you have both read and write access for TFTP. You do not need to do operations on TFTP server directory; ASU automatically uploads and downloads keys and files. ASU supports both SNMPv1v2 and SNMPv3. You do not need to specify --user and --password for SNMPv1v2. However, if --user and --password are specified, ASU tries to run SNMPv3 with the snmp user and authorization password first, then defaults to SNMPv1v2 if SNMPv3. --privproto and -privpasswd are for SNMPv3 privacy encryption. Before running ASU, make sure that the configuration on the IOM switch for the SNMP interface is correct. Note: ASU supports both SNMPv1v2 and SNMPv3. To use the correct one, make sure that both the interface and the IOM switch are supported. The current ASU FoD operation on switches is only support on IPv4. IPv6 will be supported in a future release.
35
Table 6. Command options parameters (continued) Parameter -u <unique id> -m <MT/DC> Required Yes Yes Description Unique identifier information. The machine type/device code. For the system/option feature, specify the system machine type (MT). For the IOM switch, specify the device code (DC). The IBM authorization code. If no authcode is provided, ASU gets the key without generating it. Download the key file to <dir> location. The default value is the current folder. Install the downloaded activation key.
--auth <code>
Optional
-d <dir>
Optional
-r
Optional
Values -u and -m specify the system information. Value -u is a unique identifier and -m is the system server type or switch device code. To get the keys that are installed on the IMM/CMM, enter the server type -m. For the switch keys, enter the device code. The available switch device codes are shown below. When no authorization code is entered, ASU downloads the keys for that system directly. If --auth is specified, ASU tries to generate and then download the keys for that system using the authorization code. You can specify -r using the acquirekey command to generate and download keys and install them automatically. If -r is not specified, ASU gets the key and puts it in the local folder without installing it. To install the key automatically, you must specify both [device&interface] and [connection options].
Table 7. Available switch device codes Feature description IBM Flex System Fabric EN4093 10Gb Scalable Switch (Upgrade 1) Install on system IBM Flex System Enterprise Chassis[8721] IBM Flex System Enterprise Chassis[7893] IBM Flex System Enterprise Chassis[8721] IBM Flex System Enterprise Chassis[7893] Device code FCA1EL Unique ID format IBM Switch Serial Number(12 characters)
FC3597
FCA1EM
FC3597
36
Table 7. Available switch device codes (continued) Feature description Install on system Device code FC3599 Unique ID format IBM Switch Serial Number(12 characters)
IBM Flex System IBM Flex System EN2092 1Gb Ethernet Enterprise Scalable Switch Chassis[7893] (Upgrade 1) IBM Flex System Enterprise Chassis[8721] IBM Flex System IBM Flex System EN2092 1Gb Ethernet Enterprise Scalable Switch Chassis[8721] (10Gb Uplinks) IBM Flex System Enterprise Chassis[7893] IBM Flex System IB6131 Infiniband Switch (FDR Upgrade) IBM Flex System Enterprise Chassis[8721]
FCA1QW
FCA1EN
FC3594
FCA1QX
Classes of settings
This topic explains classes and how they are used in the Advanced Settings Utility. 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.
Classes
The ASU classes of settings are described in the following list: all This class includes all settings that are listed in the ASU for the Remote Supervisor Adapter or Remote Supervisor Adapter II, baseboard management controller, and BIOS. authentication This class includes all settings that are classified as authentication settings, which includes passwords, user IDs, and authority-related settings. The save and restore commands do not save or restore this class of settings. You can list the user IDs and authority-related settings using the show command. You cannot list the password settings using the show command. To list the password settings, use the showvalues command. Example: List the settings defined as authentication, including the password settings. Password settings are normally not displayed when you use the show command. To display the available password, use the showvalues command with the password class:
asu showvalues authentication
37
backupctl This class lists all settings that are not restored when you run the restore command. An additional flag is required for these settings to be included during a restore operation. For more information, see the Restore command. Class filter for the show, showvalues, showdefault, and showlocation commands. To list the settings that are not restored if saved, type the following command:
asu show backupctl
bios This class includes all settings that match the installed BIOS code level. bmc This class includes all settings that are identified as baseboard management controller settings. change This class includes all settings that are not in the reboot class that can be changed safely and changed back before the system is restarted. critical This class includes all settings that you cannot change safely before a restart but that must be tested. group This class includes all settings that belong to the specified group. To view the supported groups, use the showgroups command. Settings in BIOS-based servers and IMM-based servers are cataloged in classes or groups. If specified, the class is used as a filter for the command that is displaying or operating on the settings. Class filter for the show, showvalues, showdefault, showlocation, save, restore, and replicate commands. Examples: To list the settings that are part of the IMM group (IMM-based servers):
asu show IMM
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 noreplicate
password This class lists all settings that are classified as password settings. Password setting values are not displayed with a show command.
38
This class filter can be used with the following commands to list the settings classified as password: showvalues, showdefault, and showlocation (BIOS-based servers only) commands. Example: List the settings that are defined as password settings. Password settings are normally not displayed when you use the show command. To display the available password, use the showvalues command with the password class:
asu showvalues password
rsa This class includes all settings that are identified as Remote Supervisor Adapter and Remote Supervisor Adapter II settings. readonly This class includes all settings that are read-only (for example, settings that you cannot change). reboot This class includes all settings that can be changed safely before a restart. If changing a setting does not preclude starting from the hard disk drive on the next startup, the setting is in this class. writeonly This class includes all settings that are write-only (for example, settings that you can change but that cannot be read, such as passwords).
Refer to the ASU User's Guide for the settings marked as (*). After modifying the setting BootModes.SystemBootMode to Legacy Only, you cannot display or set it. The output of the show command might look like this one:
D:\asu>asu show BootModes.OptimizedBoot --host 9.119.41.101 IBM Advanced Settings Utility version 9.00.76N Licensed Materials - Property of IBM (C) Copyright IBM Corp. 2007-2012 All Rights Reserved Connected to IMM at IP address 9.119.41.101 This setting cannot be shown because it is hidden!
The setting SystemRecovery.POSTWatchdogTimerValue is read-only if the setting SystemRecovery.POSTWatchdogTimer is disabled. The dependency information is:
Chapter 2. Using the command-line interface
39
D:\asu>asu showvalues SystemRecovery.POSTWatchdogTimerValue --host 9.119.41.101 IBM Advanced Settings Utility version 9.00.76N Licensed Materials - Property of IBM (C) Copyright IBM Corp. 2007-2012 All Rights Reserved Connected to IMM at IP address 9.119.41.101 SystemRecovery.POSTWatchdogTimerValue= numeric min=5 max=20 step=1 default=5
This setting is read-only if the result of the following expression is set to true:
SystemRecovery.POSTWatchdogTimer == Disable "
Refer to the ASU User's Guide for the settings marked as (*). If you try to modify the value, the following output is displayed:
D:\asu>asu set SystemRecovery.POSTWatchdogTimerValue 7 --host 9.119.41.101 IBM Advanced Settings Utility version 9.00.76N Licensed Materials - Property of IBM (C) Copyright IBM Corp. 2007-2012 All Rights Reserved Connected to IMM at IP address 9.119.41.101 This setting cannot be set because it is read-only!
Setting groups and setting values also have internal independencies. You cannot display or change them because they are hidden. When you use the showvalues command, some settings are marked with an asterisk. Asterisks mean that the settings are not only dependent on other internal settings, but also depend on the system environment. You can modify these settings using the uEFI F1 menu. The sample output can be described as below:
D:\asu>asu showvalues Power.PowerPerformanceBias --host 9.125.90.191 IBM Advanced Settings Utility version 9.00.76N Licensed Materials - Property of IBM (C) Copyright IBM Corp. 2007-2012 All Rights Reserved Connected to IMM at IP address 9.125.90.191 (*)Power.PowerPerformanceBias=<Platform Controlled>=OS Controlled
Refer to the ASU User's Guide for the settings marked as (*). Note: Only the show and set commands support setting interdependencies. Use the showvalues command to see the values of the dependency information. Other commands like save, replicate, restore, and batch ignore the dependencies restriction.
Command modifiers
This topic describes the command modifiers and the commands to which they apply.
Purpose
Command modifiers are optional. Use command modifiers to modify the default operation of specific commands.
40
Table 8. Command modifiers Command modifier --group Description Optional command modifier for the show, showdefault, showvalues, showlocation,and save commands. When used with a supporting command, it is used to specify the name of a group section. The group_name is obtained by running the showgroups command. --setlist Optional command modifier for the show, showdefault, showvalues, showlocation, and save commands. When used with a supporting command, it is used to specify a list of settings on which the command operates. --excbackupctl Optional command modifier for the save command. Use this command modifier during a save command to exclude saving the backup control settings in a file. The default in a save command is to include all backupctl settings. To review the backupctl settings, use the asu show backupctl command. This command is mutually exclusive to the incbackupctl command modifier. asu save file_name [--excbackupctl] asu show [--setlist name1 name2 nameN] asu save [--setlist name1 name 2 nameN] SyntaxLAN-over-USB asu show [--group group_name] asu save [--group group_name] Obtain the group_name by running the following showgroups command: asu showgroups
41
Table 8. Command modifiers (continued) Command modifier --incbackupctl Description Optional command modifier for the restore command. Use this command modifier during a restore command to include the backup control settings. The backupctl settings are not restored by default. To review the backupctl settings, use the asu show backupctl command. This command is mutually exclusive to the excbackupctl command modifier. --instances Optional command modifier for the showvalues command. Use this command modifier during a showvalues command to show the names of settings that can have instances. This command is mutually exclusive to the group command modifier. --help Optional command modifier for all commands and applications. Use this command modifier to show the help text for an ASU command or application. asu command | application --help asu showvalues [--instances] SyntaxLAN-over-USB asu save file_name [--incbackupctl]
42
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 9. Command connectivity options Connectivity option host Description Syntax
Specifies the host name or IP asu cmd address of the IMM to which [command_modifier] options the ASU should connect. --host host_name|ip asu cmd [command_modifier] options --host=host_name | ip Specifies the user name to asu cmd use when you are [command_modifier] options authenticating with the IMM. --user user_id asu cmd [command_modifier] options --user=user_id Specifies the password to use asu cmd when you are authenticating [command_modifier] options with the IMM. --password password asu cmd [command_modifier] options --password=password Specifies the name of a file that contains the password to use when you are authenticating with the IMM. asu cmd [command_modifier] options --password-file file_name asu cmd [command_modifier] options --passwordfile=file_name asu cmd [command_modifier] options --kcs
user
password
password-file
kcs
Specifies to send commands by using the KCS IPMI interface only. This option requires the IPMI device driver. For more information, see IPMI device driver support for Windows or IPMI device driver support for Linux. This option does not require authentication.
43
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.
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.
44
45
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 SP Recv: 04 06 00 00 00 SP Sent: 02 06 00 00 00 SP Recv: 04 06 01 00 00 RSA_SSH_Enable=Enabled 00 00 00 00 04 04 04 04 09 09 09 09 05 05 05 05 01 01 01 01 04 04 04 04 01 01 01 01 01 01
46
Output Description: If <setting> is specified, current value is only shown for setting. Show the current value for one or all settings. If "--group all" is specified, current values are shown for all settings. If "--group <group>" is specified then only values are shown for settings in that group. If "--setlist <setting1>...<settingN>" is specified, the list of settings from <setting1> to <settingN> are specified. Syntax:
show [<setting>][<cmdmod>] [<options>] [<connect_opts>]
where
<cmd_mod>
Note: Use the command "asu showgroups" to find variable classes available. --setlist <name 1>...<name n> - Operate commands on list of settings. --group <variableclass> - Operate commands on the group of setting options. --silent - Silent execution. Use return code to retrieve status. --dumptofile - Silent execution and output to asuout.log file. -n<node> - Node number node in a multinode system -v - Verbose <connect_opts> Note: These connectivity options apply to IMM-based servers only:
Chapter 2. Using the command-line interface
47
--host <ip> - Address of the IMM to operate on. --user <user> - User name used to authenticate to the IMM --password <pwd> - Password used to authenticate to the IMM --password-file <fn> - File containing password to authenticate with IMM
Return codes
This section lists and explains the return codes for both ASU and RDCLI.
Explanation The ASU command has been completed successfully. 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. An error occurred when you tried to use specific software. An error occurred when the ASU tried to communicate with or find specific hardware. An error occurred in the data that the ASU reads or sets. An error occurred in the ASU program execution flow. An ASU patch is missing or an ASU patch does not match the required level.
10 15 20 25 30 35 40 45
Software error Hardware error Data error Program error Invalid or missing patch detected The command is not supported. Invalid value input error Batch command error
The input value that is provided to the ASU has a syntax error. One or more of the commands that were specified in the batch file has failed.
48
Explanation The ASU application is a 32-bit version, and you are attempting to run it on a 64-bit operating system.
13 14 22 34
Error from ending the previous Failed to end an existing RDCLI process on RDCLI process the current local machine. Error from system call Invalid token You failed to authenticate. Check your login information, IMM setting, and firewall status. Socket error, socket connection fail Could not reach the Service Processor IMM authentication site-check, hostname/IP/ports/the installation, of IMM remote disk key Indicate a target IMM by hostname or IP address. Error occurred when invoking an operation system call. Invalid token ended the process. You did not pass authentication because your information is incorrect , or you entered the wrong IMM configuration or an improper firewall status. Check that they are all correct. Socket connection error occurred. Some unknown errors occurred during the authentication process. Check all configuration and input.
37 38
44
Provide a target IMM hostname or IP address when issuing the RDCLI command.
49
Table 11. RDCLI return codes (continued) Return code value Description 59 You failed to mount remote disk. Check to see if others have already used the remote disk, and unmount their disk before mounting yours. The remote disk session stopped. Specify a port argument to connect to the IMM Virtual Disk port. No virtual drives found. Try again later. Local drive to remote drive attach failed. Could not open target file Explanation You did not mount the local file onto IMM remote disk because the disk is occupied by another user.
60 62
The connect session between the local computer and IMM are broken. Provide a correct port number to connect to IMM if you do want to not use the default port number. No virtual drive on IMM is currently available. Failed to map the local file to the IMM remote disk. Failed to open the local file that you want to mount.
63 64 65 66
You did not install the remote presence key Lack remote key. Install the key to activate the remote disk on IMM. You must install the key now. function. There is already a link on that machine, so unmount first. There is already a session mounting file on the same IMM as the local machine. Unmount the previous session before you issue a new RDCLI command.
67
where the patch_number is the patch number for the BIOS code and patch_ filename is the generated extracted BIOS definition file. Command line
50
Command line asu patchextract 3 bios.def - bios.def contains 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.
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.
51
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. 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. A sample output for this command:
BootOrder.BootOrder=Network=Hard Disk 1=USB Storage=Diagnostics=iSCSI=iSCSI Critical=Legacy Only=Embedded Hypervisor --user testuser --password testpwd
Configuring iSCSI
The ASU supports setting iSCSI boot parameters. This section describes how to configure iSCSI settings. 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.
52
v If more than 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 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 using the ASU delete command on an instance of the iSCSIAttemptName setting. This command deletes all iSCSI settings for that instance because iSCSI instance settings are grouped as a record. v The iSCSI.InitiatorName parameter is the only one defined as a global iSCSI setting to all attempts and does not required an instance index. 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
53
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
where 64 is the address prefix for an IPv6 address. You must enter /'in the setting string as a prefix between the address and prefix.
Procedure
1. Export the certificate sign request file using the asu export command. 2. Convert the certificate sign request format from DER to PEM. 3. Enter the command, Openssl req -in asu_csr.der -inform DER -out asu_csr.pem -outform PEM.
54
4. Sign the certificate sign request using the certificate authority just set up. 5. Enter the command, Openssl ca -policy policy_anything -out asu_cert.pem -infiles asu_csr.pem. 6. Convert the certificate format from PEM to DER. The certificate sign request file is ready to import. 7. Import the certificate sign request file using the asu_import command. 8. Enter the command, Openssl x509 -in asu_cert.pem -inform PEM -out asu_cert.der outform DER. You receive the signed certificate "asu_cert.der" for your certificate sign request file "asu_csr.der."
Revoking a certificate
This topic provides the command that you enter to revoke a signed certificate. You cannot sign the same certificate sign request twice. You must revoke it before signing it again. Use the following command to revoke a certificate signed by this certificate authority.
openssl ca -revoke cert.pem
Note: You can also view the supported commands for certificate settings by running the Showvalues command. On a command line, enter the following information:
asu showvalues IMM.SSL_HTTPS_SERVER_CERT
Procedure
1. Before using HTTPS Server Certificate Management, disable the HTTPS server:
Chapter 2. Using the command-line interface
55
a. On a command line, check to see if the IMM HTTPS server configuration for the web server is disabled by entering the asu show IMM.SSL_Server_Enable command. The following output is displayed: IMM.SSL_Server_Enable=Disabled. b. If the server is enabled, disable the IMM HTTPS server configuration for the web server using the asu set IMM.SSL_Server_Enable Disabled command. The following output is displayed: IMM.SSL_Server_Enable=Disabled. c. Restart the IMM to enable the change (enable or disable) by entering the asu rebootimm command. 2. Before using IBM Systems Director over HTTPS Certificate Management, disable the director over the HTTPS server: a. On a command line, enter the asu show IMM. CIMXMLOverHTTPS_Enable command to see if the IBM Systems Director Over HTTPS is disabled. The following output is displayed: IMM.CIMXMLOverHTTPS_Enable=Disabled. b. If the server is enabled, disable IBM Systems Director Over HTTPS using the asu set IMM.CIMXMLOverHTTPS_Enable Disabled command. The following output is displayed: IMM.CIMXMLOverHTTPS_Enable=Disabled. c. Restart the IMM to enable the change (enable or disable) by entering the asu rebootimm command. 3. Before using SSL Client Certificate Management, disable the SSL Client Configuration for the LDAP client: a. On a command line, check to see if the SSL Client Configuration for LDAP client is disabled by entering the asu show IMM.SSL_Client_Enable command. The following output is displayed: IMM.IMM.SSL_Client_Enable=Disabled. b. If the server is enabled, disable the IMM SSL Client Configuration for LDAP using the asu set IMM.SSL_Client_Enable Disabled command. The following output is displayed: IMM.SSL_Client_Enable=Disabled.
56
You can tell from the output that commands generate and export are supported for the setting, IMM.SSL_HTTPS_SERVER_CSR.
An xml file, like asu.xml in this command line, is required in the generate command for all settings that support "generate," except SSH_SERVER_KEY. For instructions on creating this xml, refer to "Generate command." A certificate sign request must be signed by an independent certificate authority to be a certificate.
The asu_csr.der file is saved in the current directory. You can export a certificate or a certificate sign request. If a certificate sign request is signed by an independent certificate authority, it is a CA-signed certificate.
Importing a certificate
After you export a certificate, you can get the certificate sign request file "asu_csr.der." You must sign it using an independent certificate authority. You can only import the CA-signed certificate, which is different than a self_signed one, into HTTPS Server Certificate Management and IBM Systems Director over HTTPS Certificate Management. The following two settings for SSL Client Certificate Management only permit CA-signed certificates to be imported: v SSL_LDAP_CLIENT_CERT
Chapter 2. Using the command-line interface
57
v SSL_LDAP_CLIENT_CSR The following three settings allow both self-signed and CA-signed certificates to be imported: v SSL_CLIENT_TRUSTED_CERT1 v SSL_CLIENT_TRUSTED_CERT2 v SSL_CLIENT_TRUSTED_CERT3 For settings SSL_CLIENT_TRUSTED_CERT1, SSL_CLIENT_TRUSTED_CERT2, and SSL_CLIENT_TRUSTED_CERT3, if the certificate already exists, you must delete it before importing the certificate. The certificate to be imported should be in DER form. To set up your own independent certificate authority and sign your certificate sign request file, see "Using the OpenSSL to set up a certificate authority and sign a certificate sign request." On a command line, if you enter:
asu import IMM.SSL_HTTPS_SERVER_CERT asu_cert.der
Note: "asu_cert.der" is a CA-signed certificate after asu_csr.der is signed using your own certificate authority.
Deleting a certificate
In SSL Client Certificate Management, only three settings support the "deletecert" command: v SSL_CLIENT_TRUSTED_CERT1 v SSL_CLIENT_TRUSTED_CERT2 v SSL_CLIENT_TRUSTED_CERT3 On a command line, if you enter:
asu deletecert IMM.SSL_CLIENT_TRUSTED_CERT1
58
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
"2002:325b:1000::097D:5AF5" is an IPv6 address of IMM. If the mount is successful, a message displays that the mount operation completed without error. Otherwise, a message states that the mount operation failed and provides details about the failure. "-w 90" means that you can switch the authentication port to 90, the default port number is 80. Query the existing mount sessions between the client operating system and the remote server:
rdmount q
If it succeeds, it list all available tokens on this client operating system in the format list below:
"Token 507: drive path /home/install.iso, mounted to SP 192.168.0.1, by user USERID"
If it fails, an error message prints with the reason for the failure. Unmount an ISO/DVD/CD that is already mounted to the remote system. For example, the remote mount session has the token 507: rdumount 507. If the action was successful, a message displays saying that the present remote session has ended. If the action failed, an error message and reason for the failure prints.
59
60
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. 4. All consecutive "set" commands in a batch file are set synchronously, and the inconsecutive "set" command parts are set one-by-one. If an error happens in one "set" command, all consecutive "set" commands also work, and the commands above the error are set successfully. However the ones below the error stop working.
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
61
The batch command and corresponding output are shown in the following examples.
Example 1
Batch file:
set set set set set set set set set set set IMM.PowerRestorePolicy "Always on" IMM.PowerOnAtSpecifiedTime_Hour 05 IMM.PowerOnAtSpecifiedTime_Minute 00 IMM.PowerOnAtSpecifiedTime_Second 00 IMM.ShutdownAndPowerOff_WeekDay Sunday IMM.HTTPPort 81 IMM.SSLPort 441 IMM.TelnetPort 21 SYSTEM_PROD_DATA.SysEncloseAssetTag "Server Tag" iSCSI.InitiatorName "iqn.2009-01.com.ibm:InitiatorName" 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 show show show CMOS_PrimaryBootDevice1 CMOS_PrimaryBootDevice2 CMOS_PrimaryBootDevice3 CMOS_PrimaryBootDevice4
Output:
[show CMOS_PrimaryBootDevice1] CMOS_PrimaryBootDevice1=CD ROM [show CMOS_PrimaryBootDevice2] CMOS_PrimaryBootDevice2=Diskette Drive 0
62
Example 3
Batch file:
set set set set CMOS_PrimaryBootDevice1 CMOS_PrimaryBootDevice2 CMOS_PrimaryBootDevice3 CMOS_PrimaryBootDevice4 "Network" "Hard Disk 0" "Diskette Drive 0" "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
Comparedefault command
Use the comparedefault command to compare current values to default values for one or more settings.
Syntax
The syntax of the batch command is
asu comparedefault [setting | class] [-v] [-nx] [connect_options]
where 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.
Chapter 3. Using the commands
63
Output
The output of the comparedefault command shows the current and default values for one or all settings. Without the -v parameter:
<setting 1>=<current value 1><<default value1>> <setting 2>=<current value 2><<default value2>> <setting n>=<current value n><<default valuen>>
<setting n>: <setting n description> = <current value n>, <default value n> (default)
The comparedefault command and corresponding output are shown in the following examples.
Example 1
Command line:
asu comparedefault uefi.com1baudrate
Output:
uEFI.Com1BaudRate=115200<115200>
Example 2
Command line:
asu comparedefault CMOS_PrimaryBootDevice1
Output:
CMOS_PrimaryBootDevice1=Network<CD ROM>
Example 3
Command line:
asu comparedefault CMOS_PrimaryBootDevice2 -v
Output:
CMOS_PrimaryBootDevice2: Second Startup Device = Network, CD ROM (default)
Example 4
Command line:
asu comparedefault bios
Output:
64
Createuuid command
Use the createuuid command to generate and set the Universally Unique Identifier (UUID). This command is for IMM-based servers only.
Syntax
Note: When you set the UUID, the command requires the setting name. You can use the asu show command to identify the setting. 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
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
65
Delete command
Use the delete command to delete an instance of a setting. This command is for IMM-based servers only.
Syntax
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. The syntax of the delete command is
asu delete setting_instance [-nx] [connect_options]
where setting_instance is the name of an instance of a setting to delete. Use the command asu show all to show a list of available setting instances. 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. Node 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.
66
Output
The delete command and corresponding output are shown in the following examples.
Output:
Deleting IMM.Community_Name.1 Waiting for command completion status Command completed successfully
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.
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 records key setting, iSCSI.AttemptName.1.
Deletecert command
Use the deletecert command to delete a certificate on IMM. This command is for IMM-based servers only.
Syntax
Note: Only Client Trusted Certificate setting is supported for this command. See "Supported commands for IMM-based certificate management" to learn more about supported commands of settings. The syntax of the deletecert command is
asu deletecert setting_[-nx] [connect_options]
Chapter 3. Using the commands
67
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:
Certificate was deleted successfully!
Dump command
Use the dump command to see the raw contents of CMOS memory. This command is for BIOS-based servers only.
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. The dump command and corresponding output are shown in the following example. Command line:
asu dump
Output:
68
0 1 00: 10: 20: 30: 40: 50: 60: 70: 80: 90: a0: b0: c0: d0: e0: f0:
Encrypt command
Use the encrypt command to encrypt a setting value.
Syntax
The value that you encrypt can be any valid string. If the value contains spaces, it must be enclosed in double-quotes () so that you can use the encrypted value in the setenc command. The syntax of the encrypt command is
asu encrypt <value>
Output
The output of the encrypt command shows the encrypted string of data that you enter. For example, if you enter value, the output is s56RrL6. The encrypt command and corresponding output are shown in the following examples. Command line:
asu encrypt something to input
Output:
pzMRbH7QfvsPWGtRWacRmL7T
Command line:
asu encrypt something_to_input
Output:
pzMRbH7QfvsPWGtRWacRmL7T
69
Export command
Use the export command to export a selected certificate or certificate sign request (CSR) file.
Syntax
This export command is only for the Remote Supervisor Adapter and Remote Supervisor Adapter II and IMM. Specially, out-of-band mode of the command is supported only for IMM. This command fails if the certificate or certificate sign request is not available in the Remote Supervisor Adapter, Remote Supervisor Adapter II, or IMM. The export command generates a binary file that is saved in the current directory. Note: To learn more about supported commands of settings for IMM-based servers, see "Supported commands for IMM-based certificate management." The syntax of the export is
asu export setting certificate_binary_file [-nx] [connect_options]
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, Remote Supervisor Adapter II, or IMM. To learn more about supported command of settings, see "Supported commands for IMM-based certificate management."
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. Node 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 IMM-based servers only. 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 export command is a binary file and a message that indicates that the Remote Supervisor Adapter, Remote Supervisor Adapter II, or IMM completed the command successfully. The export command and corresponding output are shown in the following example.
70
Output:
Certificate was exported to the file successfully! ( asu.cert file is saved in the current directory)
Output:
Certificate was exported successfully! ( asu.cert file in saved in the current directory)
Generate command
Use the generate command to generate a private key and public key pair with a self-signed certificate or a certificate sign request. The generate command is targeted to only the Remote Supervisor Adapter, Remote Supervisor Adapter II, or IMM. Specially, out-of-band mode of the command is supported for IMM only. The generate command generates a private key and public key pair with a self-signed certificate or certificate sign request (CSR). The generation can take a few seconds to complete, depending on the state of the Remote Supervisor Adapter, Remote Supervisor Adapter II, or IMM. The generate command requires an Extensible Markup Language (XML) file that contains the certificate information that you want in the directory from which the ASU is running. When you extract the ASU files, a template file (template.xml) is extracted. This file provides an XML file with the correct syntax. Modify this XML file with the information you need to generate the selected certificate. To learn more about supported commands of settings for IMM-based servers, see "Supported commands for IMM-based certificate management." Note: The XML file supports the self-signed certificate request and the certificate sign request (CSR). The start and end tag for the self-signed certificate is new_key_and_self_signed_cert_info. The start and end tag for a certificate sign request 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>
Chapter 3. Using the commands
71
<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> <value minlen="0" maxlen="2">xx</value> </item> <item type="Optional"> <vectorID>0001</vectorID> <name>organizationalUnitName</name> <value minlen="0" maxlen="60">xx</value> </item> <item type="Optional"> <vectorID>0001</vectorID> <name>Surname</name> <value minlen="0" maxlen="60">xx</value> </item> <item type="Optional"> <vectorID>0001</vectorID> <name>givenName</name> <value minlen="0" maxlen="60">xx</value> </item> <item type="Optional"> <vectorID>0001</vectorID> <name>Initials</name> <value minlen="0" maxlen="20">xx</value> </item> <item type="Optional"> <vectorID>0001</vectorID> <name>dnQualifier</name> <value minlen="0" maxlen="60">xx</value> </item> </new_key_and_self_signed_cert_info> <new_key_and_cert_sign_req_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>
72
<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>organizationalUnitName</name> <value minlen="0" maxlen="60">xx</value> </item> <item type="Optional"> <vectorID>0001</vectorID> <name>Surname</name> <value minlen="0" maxlen="60">xx</value> </item> <item type="Optional"> <vectorID>0001</vectorID> <name>givenName</name> <value minlen="0" maxlen="60">xx</value> </item> <item type="Optional"> <vectorID>0001</vectorID> </item> <item type="Optional"> <vectorID>0001</vectorID> <name>Initials</name> <value minlen="0" maxlen="20">xx</value> </item> <item type="Optional"> <vectorID>0001</vectorID> <name>dnQualifier</name> <value minlen="0" maxlen="60">xx</value> </item> <item type="Optional"> <vectorID>0002</vectorID> <name>challengePassword</name> <value minlen="6" maxlen="30">xx</value> </item> <item type="Optional"> <vectorID>0002</vectorID> <name>unstructuredName</name> <value minlen="1" maxlen="60">xx</value> </item> </new_key_and_cert_sign_req_info> </asu> Table 13. Explanation of XML Item Country name Description The two-letter ISO abbreviation for your country
Chapter 3. Using the commands
73
Table 13. Explanation of XML (continued) Item State or Province name Locality name Organization name Common name Description The state or province where your organization is located. Do not abbreviate. The city where your organization is located The exact legal name of your organization. Do not abbreviate. A fully qualified domain name that resolves to the SSL VPN device. For example, to secure the URL https:// ssl.yourdomain.com, the common name of the certificate sign request should be ssl.yourdomain.com. Optional field for entering a contact name Optional field for entering a contact email address Optional field for the name of the unit in your organization Optional field for entering the surname of a contact person Optional field for entering the given name of a contact name Optional field for entering the initials of a contact name Optional field for entering the domain name qualifier Optional attribute. If you specify a challenge password in the certificate sign request, you must know the challenge password if you want to revoke the certificate later. Optional field for entering the unstructured name for a contact
Name Email address Organization unit name Surname givenName Initials dnQualifier Challenge password
unstructuredName
Notes
1. xx is a user input field. The minimum length for each vector (item) is identified by minlen=, and the maximum length is identified by maxlen=. For example, for the vector named stateOrProvinceName, the minlen is 1, the maxlen is 30, and a valid xx value is Vermont. 2. Items that are identified as "Required" have to be updated with user data. Items that are identified as "Optional" do not have to be updated. If the optional items are not updated, remove them from the XML file. 3. The ASU requires that you provide the XML file with the correct data for the generate command to run correctly.
Syntax
The syntax of the generate command is
asu generate setting xml_file [-nx] [connect_options]
where setting is the name of a valid Remote Supervisor Adapter, Remote Supervisor Adapter II, or IMM setting and xml_file is the name of an XML file that contains valid information. When generating a SSH key in IMM, the syntax of the generate command is
asu generate setting [-nx] [connect_options]
74
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. Node 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 IMM-based servers only. 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 generate command is a message that indicates that the Remote Supervisor Adapter, Remote Supervisor Adapter II, or IMM has completed the command successfully. The generate command for a self-signed certificate and corresponding output are shown in the following example. Command Command line:
asu generate RSA_Generate_SSL_Client_Certificate asu.xml
Output:
Certificate was generated successfully!
Command line:
asu generate IMM.SSL_HTTPS_SERVER_CERT asu.xml
Output:
Certificate was generated successfully!
The generate command for a certificate sign request certificate and corresponding output are shown in the following example: Command line:
asu generate IMM.SSL_HTTPS_SERVER_CSR asu.xml
Output:
Certificate was generated successfully!
The generate command for SSH Key and corresponding output are shown in the following example: Command line:
asu generate IMM.SSH_SERVER_KEY
Output:
Certificate was generated successfully!
75
Help command
Use the help command to view help for one or more settings. For BIOS settings, the help from this command is the same help that you access when you press F1 during startup.
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 IMM-based servers only. 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>
The help command and corresponding output are shown in the following examples. Command line:
BootOrder.BootOrder: Boot Order Help for 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:
76
Output:
CMOS_PrimaryBootDevice3: Third Startup Device Help for Startup Device ----------------------The system uses a startup sequence to determine which device will be the startup device. The startup device is the diskette drive, hard disk, or network adapter which will be used to load the operating system. This field specifies the third device for which a system start will be attempted. If the start from this device fails, the system will attempt to start from the fourth startup device.
Command line:
asu help bios
Output:
CMOS_DisketteA: Diskette Drive A Help for Diskette Drive ----------------------If you change or add a diskette drive, you might need to use this option to set the correct type. CMOS_CRTRequired: Displayless Operation Help for Displayless Operation -----------------------------This option suppresses the error messages that normally occur when no video device is present. CMOS_OSUSBControl: OS USB Selection Operating System USB Support ---------------------------Choose which operating system you will be using for RSA II USB support.
Import command
Use the command to import a certificate into the Remote Supervisor Adapter, Remote Supervisor Adapter II, or IMM.
Syntax
The import command is targeted to a Remote Supervisor Adapter , Remote Supervisor Adapter II or IMM. Use the command to import a certificate into the Remote Supervisor Adapter or Remote Supervisor Adapter II command or IMM. Specially, out-of-band mode of the command is supported only for IMM. The import command requires a binary certificate file that is in the same directory from which the ASU is running. You are only allowed to import the CA-signed certificate (it differs from self-signed) into section HTTPS Server Certificate Management and IBM Systems Director over HTTPS Certificate Management.
77
For section SSL Client Certificate Management, the first two settings SSL_LDAP_CLIENT_CERT, SSL_LDAP_CLIENT_CSR, also only permit CA-signed certificate to be imported. But for the other three settings v SSL_CLIENT_TRUSTED_CERT1 v SSL_CLIENT_TRUSTED_CERT2 v SSL_CLIENT_TRUSTED_CERT3 both self-signed and CA-signed are allowed to be imported. The certificate to be imported should be in DER form. If you want to set up your own independent certificate authority, and sign your certificate sign request file, see Using the OpenSSL to set up a certificate authority and Sign a certificate sign request. Note: See Supported commands for IMM-based certificate management to learn more about supported commands of settings for IMM-based server. For settings:
SSL_CLIENT_TRUSTED_CERT1 SSL_CLIENT_TRUSTED_CERT2 SSL_CLIENT_TRUSTED_CERT3
If the certificate already exists, you must delete it before import the certificate. The syntax of the import command is
asu import setting certificate_binary_file [-nx] [connect_options]
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.
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 IMM-based servers only. 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 import command is a message that indicates that the Remote Supervisor Adapter, Remote Supervisor Adapter II, or IMM has completed the command successfully. You are only allowed to import the signed certificate in DER form. See Using the OpenSSL to set up a certificate authority and sign a certificate sign request to learn about how to set up your own CA.
78
The import command and corresponding output are shown in the following examples. Command line:
asu import RSA_Import_Trusted_Certificate_1 asu.cert
Output:
Certificate was imported successfully!
Command line:
asu import IMM.SSL_HTTPS_SERVER_CERT asu.cert
Output:
Certificate was imported successfully!
Loaddefault command
Use the loaddefault command to load default values for one or more settings.
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), 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. The following example shows using the showdefault command on a setting that has a default action of remove and then performing the loaddefault command on the setting. Command line:
asu showdefault IMM.LoginId.7
Output:
IMM.LoginId.7=<remove>
Chapter 3. Using the commands
79
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.
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. Node 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 IMM-based servers only. 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 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. Without the -v parameter:
<setting 1>=<default value 1> <setting 2>=<default value 2> <setting n>=<default value n>
80
The loaddefault command and corresponding output are shown in the following examples. Command line:
asu loaddefault uEFI.Com1BaudRate
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 . .
Chapter 3. Using the commands
81
. 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
Patchadd command
Use the patchadd command to add support for a particular firmware setting to the ASU. This command is for BIOS-based servers only. 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.
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>
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
82
Output:
BIOS def file already defined in BIOS ROM!
Patchextract command
Use the patchextract command to extract a patch from the ASU to a patch file. This command is for BIOS-based servers only. You can patch the extracted patch file to another version of the ASU 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 and patch_filename is the name of the patch file that is extracted. To show the patch number for each patch, use the patchlist command.
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 name of the file to which it was extracted.
Extracted patch <patch number>: <<patch identification>> to <patch filename>
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
Patchlist command
Use the patchlist command to display the patches that are applied to the ASU. This command is for BIOS-based servers only.
Syntax
The syntax of the patchlist command is
asu patchlist
83
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>>
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)>
Patchremove command
Use the patchremove command to remove a patch from the ASU. This command is for BIOS-based servers only. Depending on the system from which you are running the patchremovecommand, 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. 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.
Copied patch <<patch identification>> to <temporary executable> Removing patch <<patch identification>> from <executable>
The patchremove command and corresponding output are shown in the following examples. Command line:
asu patchremove 2
84
Output:
Copied patch <T2[25->25] (BIOS)> to smep2tmp-9yFPOa Removing patch <GE[00->99] (RSA)> from ./asu
The patchremove command is attempting to remove a BIOS patch that is in BIOS ROM and the corresponding output are shown in the following example. Command line:
asu patchremove 3
Output:
Cannot remove patch in BIOS ROM, patch <T2[25->25]. (BIOS)> is not removed.
Readraw command
Use the redraw command to read raw CMOS data and save it in a file to use on other systems by using the writeraw command. This command is for BIOS-based servers only.
Syntax
The syntax of the redraw 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. Node 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. Command line:
asu readraw CMOSraw.dat
Output:
Raw CMOS read from CMOS, written to CMOSraw.dat
Rebootbmc command
Use the rebootbmc command to restart the baseboard management controller. This command is for BIOS-based servers only. This command is useful because you must restart the system after you make changes to baseboard management controller settings.
85
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. Node 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. The rebootbmc command and corresponding output are shown in the following example. Command line:
asu rebootbmc
Output:
Rebooting BMC...done
Rebootimm command
Use the rebootimm command to restart the integrated management module (IMM). This command is for BIOS-based servers only. This command is useful because you must restart the IMM after making changes to IMM settings. This command takes approximately four minutes to complete.
Syntax
The syntax of the rebootimm command is
asu rebootimm [-nx] [connect_options] [-a]
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. Node 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).
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. Node 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 IMM-based servers only. 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.
86
3. If the option a parameter is specified, ASU restarts all nodes in the same partition. ASU does not support restarting multiple partitions.
Output
The output of the rebootimm command is a message that indicates that the restart of the IMM is completed. 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.
Rebootrsa command
Use the rebootrsa command to restart the Remote Supervisor Adapter or Remote Supervisor Adapter II. This command is for BIOS-based servers only. This command is useful because you must restart a Remote Supervisor Adapter or Remote Supervisor Adapter II after you make changes to the Remote Supervisor Adapter settings. This command takes approximately 30 seconds to complete.
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. Node 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. The rebootrsa command and corresponding output are shown in the following example. Command line:
asu rebootrsa
Output:
Rebooting RSA/RSA2...done
87
Replicate command
Use the replicate command to replicate all settings in the input update configuration file. 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 IMM-based servers only. 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 output from set commands.
<setting 1>=<value 1> <setting 2>=<value 2> <setting n>=<value n>
The replicate command and corresponding output are shown in the following examples. Command line (IMM-based servers):
asu replicate rep.data
Output:
uEFI.Com1BaudRate=115200 uEFI.Com1DataBits=8 uEFI.Com1Parity=None
88
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.
Resetrsa 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 is for BIOS-based servers only. This command takes approximately 30 seconds to complete.
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. Node 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. The resetrsa command and corresponding output are shown in the following example. Command line:
asu resetrsa
89
Output:
Rebooting RSA/RSA2...done
Restore command
Use the restore command to restore all settings that are defined in the update configuration file on the server. On IMM-based servers, the backup control settings are not restored by default. To restore the backup control settings on an IMM-based server, you must specify the -incbackupctl modifier (see the specific syntax in Table 2).
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 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 if the settings 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 IMM-based servers only. 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.
90
The restore command and corresponding output are shown in the following example. Command line (IMM-based servers):
asu restore rep.data
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 in the restore command.
Save command
Use the save command to save all settings to a file.
91
By default, backup control settings (settings in the class backupctl) are saved unless an optional modifier is specified. The supported modifiers include --group, --setlist, and --excbackupctl (see the specific syntax in Table 2.
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. Node 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 IMM-based servers only. 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. The save command and corresponding output are shown in the following examples. Command line to save all settings:
asu save save.txt
Output:
Settings saved to save.txt
92
Output:
Settings saved to save.txt
Output:
Settings saved to save.txt
Output:
Settings saved to save.txt
Command line to save all settings except those in the backupctl class:
asu save save.txt --excbackupctl
Output:
Settings saved to save.txt
93
uEFI.TurboModeEnable=Enable uEFI.ProcessorEistEnable=Enable
Output:
Settings saved to save.txt
Set command
Use the set command to change the value of a setting or to list a setting. The set command also creates an instance if the instance number does not exist, and if the instance value is less than or equal to the maximum allowed instances for the setting. For more information about instances, see Instances of settings.
Syntax
The syntax of the set command is either
asu set setting value [-v] [-nx] [connect_options]
where setting is the name of a setting to change. Use the command asu show all to show a list of available settings; value is the exact value string to set for the 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.
94
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. Node 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 IMM-based servers only. 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 set command when the -v parameter is not specified is the setting name and the new value. When the -v parameter is specified, the description of the setting is also shown. The setting with a single value without the -v parameter:
<setting>=<new value>
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
Chapter 3. Using the commands
95
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
Create a new record instance and set the record key setting
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. To set the other settings for this instance in this record: 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"
Setenc command
Use the setenc command to change the value of a setting or to list a setting. You can apply an <encrypted value> to a setting. The encrypted value is a value returned by the encrypt command. If <encrypted value> contains spaces, it must be enclosed in double-quotes (").
Syntax
The syntax of the setenc command is either
asu setenc setting <encrypted value>
96
Use the command asu show all to show a list of available settings; value is the exact encrypted value string to set for setting. For settings with a single value, the asu showvalues command output is setting_name=<encrypted 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.
Output
The output of the setenc command when the -v parameter is not specified is the setting name and the new value. When the -v parameter is specified, the description of the setting is also shown. The setting with a single value without the -v parameter:
<setting>=<new value>
The setenc command and corresponding output are shown in the following examples. Command line:
asu setenc CMOS_CRTRequired 5vMOYnMPa1 The 5vMOYnMPa1 equals Enable encrypted by command encrypt.
Output:
CMOS_CRTRequired=Disabled
Show command
Use the show command to see the current value of one or more settings.
Syntax
The syntax of the show command is either
asu show [all | --group group_name | setting_name | --setlist name1..nameN | class] [-v] [-nx] [connect_options]
97
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. Node 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 IMM-based servers only. 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. The setting without the -v parameter:
<setting>=<current 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:
98
Showdefault command
Use the showdefault command to show the default value for one or more settings.
Syntax
The syntax of the showdefault command is either
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 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. Node 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 IMM-based servers only. 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. The setting without the -v parameter:
setting=default value
For instance settings, the default state can be that the instance does not exist. If this is the case, the default value that is displayed by the showdefault command is
99
"delete." This response 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. The showdefault command and corresponding output are shown in the following examples. 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>
Showgroups command
Use the showgroups command to list the setting groups that are available on the server. The settings are organized into groups. All uEFI settings belong to the uEFI group, and all BIOS settings belong to the BIOS group. The listed groups can be used as a class of commands that support the class modifier, or they can be used with the --group group option on commands that support this option.
Syntax
The syntax of the showgroups 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. Node 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 IMM-based servers only. 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
100
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. The showgroups command and corresponding output are shown in the following examples. Command line:
asu showgroups
Showlocation command
Use the showlocation command to show the location of one or more settings. This command is for BIOS-based servers only. This command 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 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. Node 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).
101
7. The connect options are defined for IMM-based servers only. 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. Without the -v parameter:
<setting>=<location>[<extra location info>] if <location> is CMOS, <extra location info> is of the form <byte offset>","<bit offset>","<number of bits> if <location> is SP, <extra location info> is of the form <SP dot byte 1>"."<SP dot byte 2>"," ... "."<SP dot byte n> if <location> is SP6, <extra location info> is of the form ">"<write command info> ">"<read command info> and <write command info> and <read command info> are of the form <read command byte>["@"<data offset>] ("."<command data>)*["|"<request data length>]
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
102
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] }
Showvalues command
Use the showvalues command to list all possible values for one or more settings. This command is useful for finding the value parameter that is used for the set command. Now, the showvalues command also describes the setting interdependencies information.
Syntax
The syntax of the showvalues command is
asu showdefault [all | --group group_name | setting_name | --setlist name1..nameN | class] [-v] [-nx] [connect_options]
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 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 -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. Node 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 IMM-based servers only. 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.
103
Output
If the -v parameter is not specified, the setting and its value are displayed. If the -v parameter is specified, the description of the setting is also displayed. If the setting is an enumerated type:
-v and -t not specified: <setting>=<value 1>=<value 2>=...=<value n> -v specified: <setting>: <setting description> { <value 1> <value 2> . . . <value n> } -t specified: <setting>=<value 1>[<raw 1>]=<value 2>[<raw 2>]=...=<value n>[<raw n>]
If the --instances parameter is specified, the output for a setting that is not part of a record is:
104
-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] -v specified: <setting>: T <setting description> { numeric data numeric type = dec minimum value = 0 maximum value = 65535 default value = 3260 min instances = 0 max instances = 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 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.
-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, it 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,
105
where setting1 is the key setting. For more information about records, see Record management. If the setting is a certificate related setting:
-v not specified: <setting>=*<generate>=<import>=...=<export> -v specified: <setting>:<setting long name> { generate import export } "generate, import, export" are methods supported by this certificate setting.
Refer to the ASU User's Guide for the settings which is marked as(*). Setting 1 depends on both internal settings and system environment:
(*)<setting 1>=<value 11>=<value 12>=...=<value 1n>
See the ASU User's Guide for the settings marked as(*). The showvalues command and corresponding output are shown in the following examples. 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
106
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"
Command line:
asu showvalues IMM.SSL_HTTPS_SERVER_CERT
Output:
IMM.SSL_HTTPS_SERVER_CERT=*generate=import=export
Version command
Use the version command to show the version and build date of the ASU. 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. 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
Writeraw command
Use the writeraw command to read and write CMOS data that is saved in a file through the readraw command. This command is for BIOS-based servers only.
Chapter 3. Using the commands
107
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. Node 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. 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
Nodes command
Use the nodes command to detect the available notes in current system. This command is for IMM and legacy servers.
Syntax
The syntax of the nodes command is
asu nodes
Note: You can use it on a multinode system or a single node system. On a single node system, 1 is always reported.
Output
The output of the nodes command is a string with a number of nodes currently available on the system. The nodes command and corresponding output are shown in the following example. Command line:
asu nodes
Output:
108
System Nodes: 2
109
110
111
112
Notices
This information was developed for products and services offered in the U.S.A. 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 North Castle Drive Armonk, NY 10504-1785 U.S.A. INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-IBM websites are provided for convenience only and do not in any manner serve as an endorsement of those websites. The materials at those websites are not part of the materials for this IBM product, and use of those websites is at your own risk. IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you.
113
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. Adobe and PostScript are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. Cell Broadband Engine is a trademark of Sony Computer Entertainment, Inc., in the United States, other countries, or both and is used under license therefrom. 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. Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both. Microsoft, Windows, and Windows NT are trademarks of Microsoft Corporation in the United States, other countries, or both. UNIX is a registered trademark of The Open Group in the United States and other countries. Other company, product, or service names may be trademarks or service marks of others.
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. When referring to hard disk drive capacity or communications volume, MB stands for 1 000 000 bytes, and GB stands for 1 000 000 000 bytes. Total user-accessible capacity can vary depending on operating environments. 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.
114
Maximum memory might require replacement of the standard memory with an optional memory module. IBM makes no representation or warranties regarding non-IBM products and services that are ServerProven, including but not limited to the implied warranties of merchantability and fitness for a particular purpose. These products are offered and warranted solely by third parties. IBM makes no representations or warranties with respect to non-IBM products. Support (if any) for the non-IBM products is provided by the third party, not IBM. Some software might differ from its retail version (if available) and might not include user manuals or all program functionality.
Notices
115
116
Thank you for your support. Send your comments to the address on the reverse side of this form. If you would like a response from IBM, please fill in the following information:
Address
Email address
___________________________________________________________________________________________________
Fold and _ _ _ _ _ _ _ _ _ _Fold and_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _Please _ _ _ _ _ staple _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ Tape _ _ _ _ _ _ _ _ Tape _ _ _ _ do not _ _ _ _ NO POSTAGE NECESSARY IF MAILED IN THE UNITED STATES
International Business Machines Corporation PO Box 12195 Research Triangle Park NC U.S.A. 27709-9990
_________________________________________________________________________________________ Fold and Tape Please do not staple Fold and Tape
Printed in USA