Table Of Contents
Command-line interface
Managing the IMM using IPMI
Accessing the command line
Logging in to the command-line session
Command syntax
Features and limitations
Utility commands
exit command
Description
help command
Description
history command
Description
Example
Monitor commands
clearlog command
Description
fans command
Description
Example
readlog command
Syntax
Description
Example
syshealth command
Description
Example
temps command
Description
Example
volts command
Description
Example
vpd command
Syntax
Description
Example
Server power and restart control commands
power command
Syntax
Description
reset command
Syntax
Description
Configuration commands
dhcpinfo command
Syntax
Description
Example
ifconfig command
Syntax
Description
Example
ldap command
Syntax
Description
ntp command
Syntax
Description
Example
passwordcfg command
Syntax
Description
Example
portcfg command
Syntax
Description
Example
srcfg command
Syntax
Description
Example
ssl command
Syntax
Description
Parameters
timeouts command
Syntax
Description
Example
usbeth command
Syntax
Description
Example
users command
Syntax
Description
Example
IMM control commands
clearcfg command
Description
clock command
Syntax
Description
Example
identify command
Syntax
Description
Example
resetsp command
Description
Command-line interface
Use the IMM command-line interface (CLI) to access the IMM without having to use the Web interface. It provides a subset of the management functions that are provided by the Web interface.
You can access the CLI through a Telnet or SSH session. You must be authenticated by the IMM before you can issue any CLI commands.
Managing the IMM using IPMI
The IMM comes with User ID 2 set initially to a user name of USERID and password of PASSW0RD (with a zero, not the letter O). This user has Supervisor access.
Important: Change this default password during your initial configuration for enhanced security.
The IMM also provides the following IPMI remote server management capabilities:
Command-line interfaces
The command-line interface provides direct access to server-management functions through the IPMI 2.0 protocol. You can use IPMItool to issue commands to control server power, view server information, and identify the server.
Accessing the command line
To access the command line, start a Telnet or SSH session to the IMM IP address.
Logging in to the command-line session
To log in to the command line, complete the following steps:
Step 1
Establish a connection with the IMM.
Step 2
At the user name prompt, type the user ID.
Step 3
At the password prompt, type the password that you use to log in to the IMM.
You are logged in to the command line. The command-line prompt is system>. The command-line session continues until you type exit at the command line. Then you are logged off and the session is ended.
Command syntax
Read the following guidelines before you use the commands:
•
Each command has the following format:
command [arguments] [-options]
•
The command syntax is case sensitive.
•
The command name is all lowercase.
•
All arguments must immediately follow the command. The options immediately follow the arguments.
•
Each option is always preceded by a hyphen (-). An option can be a short option (single letter) or a long option (multiple letters).
•
If an option has an argument, the argument is mandatory, for example:
ifconfig eth0 -i 192.168.70.34 -g 192.168.70.29 -s 255.255.255.0
where ifconfig is the command, eth0 is an argument, and -i, -g, and -s are options. In this example, all three options have arguments.
•
Brackets indicate that an argument or option is optional. Brackets are not part of the command that you type.
Features and limitations
The CLI has the following features and limitations:
•
Multiple concurrent CLI sessions are allowed with different access methods (Telnet or SSH). At most, two Telnet command-line sessions can be active at any time.
Note
The number of Telnet sessions is configurable; valid values are 0, 1, and 2. The value 0 means that the Telnet interface is disabled.
•
One command is allowed per line (160-character limit, including spaces).
•
There is no continuation character for long commands. The only editing function is the Backspace key to erase the character that you just typed.
•
The Up Arrow and Down Arrow keys can be used to browse through the last eight commands. The history command displays a list of the last eight commands, which you can then use as a shortcut to execute a command, as in the following example:
•
In the command-line interface, the output buffer limit is 2 KB. There is no buffering. The output of an individual command cannot exceed 2048 characters. This limit does not apply in serial redirect mode (the data is buffered during serial redirect).
•
The output of a command is displayed on the screen after the command has completed execution. This makes it impossible for commands to report real-time execution status. For example, in the verbose mode of the flashing command, the flashing progress is not shown in real time. It is shown after the command completes execution.
•
Simple text messages are used to denote command execution status, as in the following example:
State: System power off/State unknown
•
The command syntax is case sensitive.
•
There must be at least one space between an option and its argument. For example, ifconfig eth0 -i192.168.70.133 is incorrect syntax. The correct syntax is ifconfig eth0 -i 192.168.70.133.
•
All commands have the -h, -help, and ? options, which give syntax help. All of the following examples will give the same result:
•
Some of the commands that are described in the following sections might not be available. To see a list of the commands that are supported, use the help or ? option, as shown in the following examples:
Utility commands
The utility commands are as follows:
•
exit
•
help
•
history
exit command
Description
Use the exit command to log off and end the command-line interface session.
help command
Description
Use the help command to display a list of all commands with a short description for each. You can also type ? at the command prompt.
history command
Description
Use the history command to display an indexed history list of the last eight commands that were issued. The indexes can then be used as shortcuts (preceded by !) to reissue commands from this history list.
Example
Monitor commands
The monitor commands are as follows:
•
clearlog
•
fans
•
readlog
•
syshealth
•
temps
•
volts
clearlog command
Description
Use the clearlog command to clear the event log of the IMM or IMM. You must have the authority to clear event logs to use this command.
fans command
Description
Use the fans command to display the speed for each of the server fans.
Example
readlog command
Syntax
Description
Use the readlog command to display the IMM event log entries, five at a time. The entries are displayed from the most recent to the oldest.
•
readlog displays the first five entries in the event log, starting with the most recent, on its first execution, and then the next five for each subsequent call.
•
readlog -f resets the counter and displays the first 5 entries in the event log, starting with the most recent.
Example
1 I SERVPROC 12/18/03 10:18:58 Remote Login Successful.
Login ID:''USERID' CLI authenticated from 192.168.70.231 (Telnet).'
2 I SERVPROC 12/18/03 10:12:22 Remote Login successful.
Login ID: ''USERID' from web browser at IP@=192.168.70.231'
3 E SERVPROC 12/18/03 10:10:37 Failure reading I2C device.
4 E SERVPROC 12/18/03 10:10:37 Environmental monitor not responding.
5 E SERVPROC 12/18/03 10:10:37 Failure reading I2C device.
6 E SERVPROC 12/18/03 10:09:31 Fan 2 Fault. Multiple fan failures
7 E SERVPROC 12/18/03 10:09:31 Fan 1 Fault. Single fan failure
8 I SERVPROC 12/18/03 10:09:25 Ethernet[0] Link Established at 100Mb, Full Duplex.
9 I SERVPROC 12/18/03 10:09:24 Ethernet[0] configured to do Auto Speed/Auto Duplex.
10 I SERVPROC 12/18/03 10:09:24 Ethernet[0] MAC Address currently
being used: 0x00-09-6B-CA-0C-80
syshealth command
Description
Use the syshealth command to display a summary of the health of the server. The power state, system state, restart count, and IMM software status are displayed.
Example
State System on/starting UEFI
temps command
Description
Use the temps command to display all the temperatures and temperature thresholds. The same set of temperatures are displayed as in the Web interface.
Example
Temperatures are displayed in degrees Fahrenheit/Celsius
----------------------------------------
CPU1 65/18 72/22 80/27 85/29 90/32
CPU2 58/14 72/22 80/27 85/29 9/320
DASD1 66/19 73/23 82/28 88/31 9/332
Amb 59/15 70/21 83/28 90/32 9/355
Notes:
1.
The output has the following column headings:
WR: warning reset
W: warning
T: temperature (current value)
SS: soft shutdown
HS: hard shutdown
2.
All temperature values are in degrees Fahrenheit/Celsius.
volts command
Description
Use the volts command to display all the voltages and voltage thresholds. The same set of voltages are displayed as in the Web interface.
Example
HSL SSL WL WRL V WRH WH SSH HSH
----------------------------------------------------------
5v 5.02 4.00 4.15 4.50 4.60 5.25 5.50 5.75 6.00
3.3v 3.35 2.80 2.95 3.05 3.10 3.50 3.65 3.70 3.85
12v 12.25 11.10 11.30 11.50 11.85 12.15 12.25 12.40 12.65
-5v -5.10 -5.85 -5.65 -5.40 -5.20 -4.85 -4.65 -4.40 -4.20
-3.3v -3.35 -4.10 -3.95 -3.65 -3.50 -3.10 -2.95 -2.80 -2.70
Note: The output has the following column headings:
HSL: hard shutdown low
SSL: soft shutdown low
WL: warning low
WRL: warning reset low
V: voltage (current value)
WRH: warning reset high
WH: warning high
SSH: soft shutdown high
HSH: hard shutdown high
vpd command
Syntax
Description
Use the vpd command to display vital product data for the system (sys), IMM, server firmware (bios), and Dynamic System Analysis Preboot (dsa). The same information is displayed as in the Web interface.
Example
Server power and restart control commands
The server power and restart commands are as follows:
•
power
•
reset
power command
Syntax
Description
Use the power command to control the server power. To issue the power commands, you must have power and restart access authority.
•
power on turns on the server power.
•
power off turns off the server power. The -s option shuts down the operating system before the server is turned off.
•
power state displays the server power state (on or off) and the current state of the server.
•
power cycle turns off the server power and then turns on the power. The -s option shuts down the operating system before the server is turned off.
reset command
Syntax
Description
Use the reset command to restart the server. To use this command, you must have power and restart access authority. The -s option shuts down the operating system before the server is restarted.
Configuration commands
The configuration commands are as follows:
•
dhcpinfo
•
ifconfig
•
ldap
•
ntp
•
passwordcfg
•
portcfg
•
slp
•
srcfg
•
ssl
•
tcpcmdmode
•
timeouts
•
usbeth
•
users
dhcpinfo command
Syntax
Description
Use the dhcpinfo command to view the DHCP server-assigned IP configuration for eth0, if the interface is configured automatically by a DHCP server. You can use the ifconfig command to enable or disable DHCP.
Example
The following table describes the output from the example.
Option
|
Description
|
-server
|
DHCP server that assigned the configuration
|
-n
|
Assigned host name
|
-i
|
Assigned IP address
|
-g
|
Assigned gateway address
|
-s
|
Assigned subnet mask
|
-d
|
Assigned domain name
|
-dns1
|
Primary DNS server IP address
|
-dns2
|
Secondary DNS IP address
|
-dns3
|
Tertiary DNS server IP address
|
ifconfig command
Syntax
-l locally_administered_MAC
Description
Use the ifconfig command to configure the Ethernet interface. Type ifconfig eth0 to display the current Ethernet interface configuration. To change the Ethernet interface configuration, type the options, followed by the values. To change the interface configuration, you must have at least Adapter Networking and Security Configuration authority.
The following table shows the arguments for the options.
Option
|
Description
|
Values
|
-state
|
Interface state
|
disabled, enabled
|
-c
|
Configuration method
|
dhcp, static, dthens (dthens corresponds to the try dhcp server, if it fails use static config option on the Web interface)
|
-i
|
Static IP address
|
Valid IP address format
|
-g
|
Gateway address
|
Valid IP address format
|
-s
|
Subnet mask
|
Valid IP address format
|
-n
|
Host name
|
String of up to 63 characters. Can include letters, digits, periods, underscores, and hyphens.
|
-r
|
Data rate
|
10, 100, auto
|
-d
|
Duplex mode
|
full, half, auto
|
-m
|
MTU
|
Numeric between 60 and 1500
|
-l
|
LAA
|
MAC address format. Multicast addresses are not allowed (the first byte must be even).
|
Example
system> ifconfig eth0 -c static -i 192.168.70.133
These configuration changes will become active after the next reset of the IMM.
Note
The -b option in the ifconfig display is for the burned-in MAC address. The burned-in MAC address is read-only and is not configurable.
ldap command
Syntax
Description
Use the ldap command to display and configure the LDAP protocol configuration parameters.
The following table shows the arguments for the options.
Option
|
Description
|
Values
|
-a
|
User authentication method
|
Local only, LDAP only, local first then LDAP, LDAP first then local
|
-b
|
Binding method
|
Anonymous, bind with ClientDN and password, user principal bind (UPN)
|
-c
|
Client distinguished name
|
String of up to 63 characters for client_dn
|
-d
|
Search domain
|
String of up to 31 characters for search_domain
|
-f
|
Group filter
|
String of up to 63 characters for group_filter
|
-g
|
Group search attribute
|
String of up to 63 characters for group_search_attr
|
-l
|
Login permission attribute
|
String of up to 63 characters for string
|
-m
|
Domain source
|
Extract search domain from login ID, use only configured search domain, try login first then configured value
|
-n
|
Service name
|
String of up to 15 characters for service_name
|
-p
|
Client password
|
String of up to 15 characters for client_pw
|
-pc
|
Confirm client password
|
String of up to 15 characters for confirm_pw
Command usage is: ldap -p client_pw -pc confirm_pw
This option is required when you change the client password. It compares the confirm_pw argument with the client_pw argument, and the command will fail if they do not match.
|
-r
|
Root entry distinguished name (DN)
|
String of up to 63 characters for root_dn
|
s1ip
|
Server 1 host name/IP address
|
String up to 63 characters or an IP address for host name/ip_addr
|
s2ip
|
Server 2 host name/IP address
|
String up to 63 characters or an IP address for host name/ip_addr
|
s3ip
|
Server 3 host name/IP address
|
String up to 63 characters or an IP address for host name/ip_addr
|
s1pn
|
Server 1 port number
|
A numeric port number up to 5 digits for port_number.
|
s2pn
|
Server 2 port number
|
A numeric port number up to 5 digits for port_number.
|
s3pn
|
Server 3 port number
|
A numeric port number up to 5 digits for port_number.
|
-u
|
UID search attribute String
|
String of up to 23 characters for search_attrib
|
-v
|
Get LDAP server address through DNS
|
Off, on
|
-w
|
Allows wildcards in the group name
|
Off, on
|
-h
|
Displays the command usage and options
|
|
ntp command
Syntax
Description
Use the ntp command to display and configure the Network Time Protocol (NTP).
The following table shows the arguments for the options.
Option
|
Description
|
Values
|
-en
|
Enables or disables the Network Time Protocol
|
Enabled, disabled
|
-i
|
Name or IP address of the Network Time Protocol server
|
The name of the NTP server to be used for clock synchronization.
|
-f
|
The frequency (in minutes) that the IMM clock is synchronized with the Network Time Protocol server
|
3 - 1440 minutes
|
-synch
|
Requests an immediate synchronization with the Network Time Protocol server
|
No values are used with this parameter.
|
Example
passwordcfg command
Syntax
options: {-high}|{-legacy}|{-exp|-cnt|-nul}
Description
Use the passwordcfg command to display and configure the password parameters.
Option
|
Description
|
-legacy
|
Sets account security to a predefined legacy set of defaults
|
-high
|
Sets account security to a predefined high set of defaults
|
-exp
|
Maximum password age (0 - 365 days). Set to 0 for no expiration.
|
-cnt
|
Number of previous passwords that cannot be reused (0 - 5)
|
-nul
|
Allows accounts with no password (yes | no)
|
-h
|
Displays the command usage and options
|
Example
system> passwordcfg -exp 365
system> passwordcfg -nul yes
system> passwordcfg -cnt 5
Security Level: Customize
portcfg command
Syntax
Description
Use the portcfg command to configure the serial port. To change the serial port configuration, type the options, followed by the values. To change the serial port configuration, you must have at least Adapter Networking and Security Configuration authority.
The parameters are set in the hardware and cannot be changed:
•
8 data bits
•
no parity
•
1 stop bit
The following table shows the arguments for the options.
Option
|
Description
|
Values
|
-b
|
Baud rate
|
Baud rate 9600, 19200, 38400, 57600, 115200, 230400
|
-climode
|
CLI mode
|
none, cliems, cliuser
• none: The command-line interface is disabled
• cliems: The command-line interface is enabled with EMS-compatible keystroke sequences
• cliuser: The command-line interface is enabled with user-defined keystroke sequences
|
Example
-climode : 2 (CLI with user defined keystroke sequences) system>
srcfg command
Syntax
-exitcliseq exitcli_keyseq
Description
Use the srcfg command to configure the serial redirection. Type srcfg to display the current configuration. To change the serial redirect configuration, type the options, followed by the values. To change the serial redirect configuration, you must have at least Adapter Networking and Security Configuration authority.
The following table shows the arguments for the -exitcliseq option.
Option
|
Description
|
Values
|
-exitcliseq
|
Exit a command-line interface keystroke sequence
|
User-defined keystroke sequence to exit the CLI. For details, see the values for the -entercliseq option in this table.
|
Example
ssl command
Syntax
Description
Note
Before you can enable an SSL client, a client certificate must be installed.
Use the ssl command to display and configure the Secure Sockets Layer (SSL) parameters.
Option
|
Description
|
-ce
|
Enables or disables an SSL client
|
-se
|
Enables or disables an SSL server
|
-h
|
Lists usage and options
|
Parameters
The following parameters are presented in the option status display for the ssl command and are output only from the command-line interface:
Server secure transport enable
This status display is read-only and cannot be set directly.
Server Web/CMD key status
This status display is read-only and cannot be set directly. Possible command line output values are as follows:
Private Key and Cert/CSR not available
Private Key and CA-signed cert installed
Private Key and Auto-gen self-signed cert installed
Private Key and Self-signed cert installed
Private Key stored, CSR available for download
SSL server CSR key status
This status display is read-only and cannot be set directly. Possible command line output values are as follows:
Private Key and Cert/CSR not available
Private Key and CA-signed cert installed
Private Key and Auto-gen self-signed cert installed
Private Key and Self-signed cert installed
Private Key stored, CSR available for download
SSL client LDAP key status
This status display is read-only and cannot be set directly. Possible command line output values are as follows as follows:
Private Key and Cert/CSR not available
Private Key and CA-signed cert installed
Private Key and Auto-gen self-signed cert installed
Private Key and Self-signed cert installed
Private Key stored, CSR available for download
SSL client CSR key status
This status display is read-only and cannot be set directly. Possible command line output values are as follows:
Private Key and Cert/CSR not available
Private Key and CA-signed cert installed
Private Key and Auto-gen self-signed cert installed
Private Key and Self-signed cert installed
Private Key stored, CSR available for download
timeouts command
Syntax
-l loader_watchdog_option
Description
Use the timeouts command to display the timeout values or change them. To display the timeouts, type timeouts. To change timeout values, type the options followed by the values. To change timeout values, you must have at least Adapter Configuration authority.
The following table shows the arguments for the timeout values. These values match the graduated scale pull-down options for server timeouts on the Web interface.
Option
|
Timeout
|
Units
|
Values
|
-o
|
Operating system timeout
|
minutes
|
disabled, 2.5, 3, 3.5, 4
|
-l
|
Loader timeout
|
minutes
|
disabled, 0.5, 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5, 7.5, 10, 15, 20, 30, 60, 120
|
Example
usbeth command
Syntax
Description
Use the usbeth command to enable or disable the in-band LAN over USB interface. For more information about enabling or disabling this interface, see "Disabling the USB in-band interface" section on page 3-6.
Example
system>usbeth -en enabled
users command
Syntax
Description
Use the users command to access all user accounts and their authority levels and to create new user accounts and modify existing accounts.
Read the following guidelines about the users command:
•
User numbers must be from 1 to 12, inclusive.
•
User names must be less than 16 characters and can contain only numbers, letters, periods, and underscores.
•
Passwords must be more than 5 and fewer than 16 characters long and must contain at least one alphabetic and one nonalphabetic character.
•
The authority level can be one of the following levels:
–
super (supervisor)
–
ro (read only)
–
Any combination of the following values, separated by |:
am (User account management access)
rca (Remote console access)
rcvma (Remote console and virtual media access)
pr (Remote server power/restart access)
cel (Ability to clear event logs)
bc (Adapter configuration [basic])
nsc (Adapter configuration [network and security])
ac (Adapter configuration [advanced])
Example
Password Expires: no expiration
Password Expires: no expiration
Password Expires: no expiration
5. jacobyackenovic custom:cel|ac
Password Expires: no expiration
system> users -7 -n sptest -p PASSW0RD -a custom:am|rca|cel|nsc|ac
Password Expires: no expiration
Password Expires: no expiration
Password Expires: no expiration
5. jacobyackenovic custom:cel|ac
Password Expires: no expiration
7. sptest custom:am|rca|cel|nsc|ac
Password Expires: no expiration
IMM control commands
The IMM control commands are as follows:
•
clearcfg
•
clock
•
identify
•
resetsp
•
update
clearcfg command
Description
Use the clearcfg command to set the IMM configuration to its factory defaults. You must have at least Advanced Adapter Configuration authority to issue this command. After the configuration of the IMM is cleared, the IMM is restarted.
clock command
Syntax
Description
Use the clock command to display the current date and time according to the IMM clock and the GMT offset. You can set the date, time, GMT offset, and daylight saving time settings.
Note the following information:
•
For a GMT offset of +2 or +10, special daylight saving time settings are required.
•
For +2, the daylight saving time options are as follows: off, ee (Eastern Europe), gtb (Great Britain), egt (Egypt), fle (finland).
•
For +10, the daylight saving time settings are as follows: off, ea (Eastern Australia), tas (Tasmania), vlad (Vladivostok).
•
The year must be from 2000 to 2089, inclusive.
•
The month, date, hours, minutes, and seconds can be single-digit values (for example, 9:50:25 instead of 09:50:25).
•
GMT offset can be in the format of +2:00, +2, or 2 for positive offsets, and -5:00 or -5 for negative offsets.
Example
12/12/2003 13:15:23 GMT-5:00 dst on
system> clock -d 12/31/2004
12/31/2004 13:15:30 GMT-5:00 dst on
identify command
Syntax
Description
Use the identify command to turn the chassis identify LED on or off, or to have it flash. The -d option can be used with -s on to turn the LED on for only for the number of seconds specified with the -d parameter. The LED then turns off after the number of seconds elapses.
Example
system> identify -s on -d 30
resetsp command
Description
Use the resetsp command to restart the IMM or IMM. You must have at least Advanced Adapter Configuration authority to be able to issue this command.