| Integrated Lights Out Manager (ILOM) Administration Guide for ILOM 1.1.1
|
   
|
Command-Line Interface Reference
|
This chapter contains the following sections:
A.1 CLI Command Quick Reference
This section contains the most common ILOM commands used to administer your Sun server from the command-line interface (CLI).
TABLE A-1 Command Syntax and Usage
|
Content
|
Typeface
|
Description
|
|
Your input
|
Fixed-width bold
|
Text that you type. Type it exactly as shown.
|
|
Onscreen output
|
Fixed-width regular
|
Text that the computer displays.
|
|
Variable
|
Italic
|
Replace these with a name or value you choose.
|
|
Square brackets [ ]
|
|
Text in square brackets is optional.
|
|
Vertical bars |
|
|
Text separated by a vertical bar represents the only available values. Select one.
|
TABLE A-2 General Commands
|
Description
|
Command
|
|
Show all valid targets.
|
help targets
|
|
Log out of the CLI.
|
exit
|
|
Display the version of the ILOM firmware running on the ILOM.
|
version
|
|
Display clock information.
|
show /SP/clock
|
|
Display all of the CLI commands.
|
show /SP/cli/commands
|
|
Display the active ILOM sessions.
|
show /SP/sessions
|
|
Display information about commands and targets.
|
help
|
|
Display information about a specific command.
|
help create
|
|
Update the ILOM and BIOS firmware.
|
load -source tftp://newSPimage
|
|
Display a list of the ILOM event logs.
|
show /SP/logs/event/list
|
TABLE A-3 User Commands
|
Description
|
Command
|
|
Add a local user.
|
create /SP/users/user1 password=password
role=administrator|operator
|
|
Delete a local user.
|
delete /SP/users/user1
|
|
Change a local user's properties.
|
set /SP/users/user1 role=operator
|
|
Display information about all local users.
|
show -display [targets|properties|all]
-level [value|all] /SP/users
|
|
Display information about LDAP settings.
|
show /SP/clients/ldap
|
|
Change LDAP settings.
|
set /SP/clients/ldap binddn=proxyuser
bindpw=proxyuserpassword
defaultrole=administrator|operator
ipaddress=ipaddress
|
TABLE A-4 Network and Serial Port Setting Commands
|
Description
|
Command
|
|
Display network configuration information.
|
show /SP/network
|
|
Change network properties for the ILOM. Changing certain network properties, like the IP address, will disconnect your active session.
|
set /SP/network pendingipaddress=ipaddress pendingipdiscovery=dchp|static
pendingipgateway=ipgateway
pendingipnetmask=ipnetmask commitpending=true
|
|
Display information about the external serial port.
|
show /SP/serial/external
|
|
Change the external serial port configuration.
|
set /SP/serial/external pendingspeed=integer commitpending=true
|
|
Display information about the serial connection to the host.
|
show /SP/serial/host
|
|
Change the host serial port configuration.
Note: This speed setting must match the speed setting for serial port 0, COM1 or /dev/ttyS0 on the host operating system.
|
set /SP/serial/host pendingspeed=integer commitpending=true
|
TABLE A-5 Alert Commands
|
Description
|
Command
|
|
Display information about PET alerts. You can configure up to 15 alerts.
|
show /SP/alert/rules/1...15
|
|
Change alert configuration.
|
set /SP/alert/rules/1...15 destination=ipaddress level=down|critical|major|minor
|
TABLE A-6 System Management Access Commands
|
Description
|
Command
|
|
Display information about HTTP settings.
|
show /SP/services/http
|
|
Change HTTP settings, such as enabling automatic redirection to HTTPS.
|
set /SP/services/http port=portnumber secureredirect enabled|disabled
servicestate=enabled|disabled
|
|
Display information about HTTPS access.
|
show /SP/services/https
|
|
Change HTTPS settings.
|
set /SP/services/https port=portnumber servicestate=enabled|disabled
|
|
Display ssh DSA
key settings.
|
show /SP/services/ssh/keys/dsa
|
|
Display ssh RSA
key settings.
|
show /SP/services/ssh/keys/rsa
|
TABLE A-7 SNMP Commands
|
Description
|
Command
|
|
Display information about SNMP settings. By default, the SNMP port is 161 and v3 is enabled.
|
show /SP/services/snmp engineid=snmpengineid
port=snmpportnumber sets=enabled|disabled
v1=enabled|disabled v2c=enabled|disabled
v3=enabled|disabled
|
|
Display SNMP users.
|
show /SP/services/snmp/users
|
|
Add an SNMP user.
|
create /SP/services/snmp/users/snmpusername authenticationpassword=password
authenticationprotocol=MD5|SHA
permissions=rw|ro privacypassword=password privacyprotocol=none|DES
|
|
Delete an SNMP user.
|
delete /SP/services/snmp/users/snmpusername
|
|
Display information about SNMP public (read-only) communities.
|
show /SP/services/snmp/communities/public
|
|
Add this device to an SNMP public community.
|
create /SP/services/snmp/communities/
public/comm1
|
|
Delete this device from an SNMP public community.
|
delete /SP/services/snmp/communities/
public/comm1
|
|
Display information about SNMP private (read-write) communities.
|
show /SP/services/snmp/communities/private
|
|
Add this device to an SNMP private community.
|
create /SP/services/snmp/communities/
private/comm2
|
|
Delete this device from an SNMP private community.
|
delete /SP/services/snmp/communities/
private/comm2
|
TABLE A-8 Host System Commands
|
Description
|
Command
|
|
Start the host system.
|
start /SYS
|
|
Stop the host system.
|
stop /SYS
|
|
Reset the host system.
|
reset /SYS
|
|
Start a session to connect to the host console.
|
start /SP/console
|
|
Stop the session connected to the host console.
|
stop /SP/console
|
TABLE A-9 Clock Settings
|
Description
|
Command
|
|
Set the ILOM clock to synchronize with a primary NTP server.
|
set /SP/clients/ntp/server/1 address=ntpIPaddress
|
|
Set the ILOM clock to synchronize with a secondary NTP server.
|
set /SP/clients/ntp/server/2 addressntpIPaddress2
|
A.2 CLI Command Reference
This section provides reference information about the CLI commands.
A.2.1 Using the cd Command
Use the cd command to navigate the namespace. When you cd to a target location, that location then becomes the default target for all other commands. Using the -default option with no target returns you to the top of the namespace. Typing just cd displays your current location in the namespace. Typing help targets displays a list of all targets in the entire namespace.
Syntax
cd target
Options
[-d|default] [-h|help]
Targets and Properties
Any location in the namespace.
Examples
To create a user named sally, cd to /SP/users, then execute the create command with /SP/users as the default target.
-> cd /SP/users
-> create sally
To find your location, type cd.
-> cd /SP/users
A.2.2 Using the create Command
Use the create command to set up an object in the namespace. Unless you specify properties with the create command, they are empty.
Syntax
create [options] target [propertyname=value]
Options
[-d|default] [-h|help]
Targets, Properties, and Values
TABLE A-10 Targets, Properties, and Values for the create Command
|
Valid Targets
|
Properties
|
Values
|
Default
|
|
/SP/users/username
|
password
role
|
<string>
administrator/operator
|
(none)
operator
|
|
/SP/services/snmp/community/
communityname
|
permissions
|
ro|rw
|
ro
|
|
/SP/services/snmp/user/
username
|
authenticationprotocol
authenticationpassword
permissions
privacyprotocol
privacypassword
|
MD5
<string>
ro|rw
none|DES
<string>
|
MD5
(null string)
ro
DES
(null string)
|
Example
-> create /SP/users/susan role=administrator
A.2.3 Using the delete Command
Use the delete command to remove an object from the namespace. You will be prompted to confirm a delete command. Eliminate this prompt by using the
-script option.
Syntax
delete [options] [-script] target
Options
[-f|force] [-h|help] [-script]
Targets
TABLE A-11 Targets for the delete Command
|
Valid Targets
|
|
/SP/users/username
|
|
/SP/services/snmp/community/communityname
|
|
/SP/services/snmp/user/username
|
Examples
-> delete /SP/users/susan
-> delete -script /SP/alert/rules/tojohn
A.2.4 Using the exit Command
Use the exit command to terminate a session to the CLI.
Syntax
exit [options]
Options
[-h|help]
A.2.5 Using the help Command
Use the help command to display Help information about commands and targets. Using the -output terse option displays usage information only. The -output verbose option displays usage, description, and additional information including examples of command usage. If you do not use the -output option, usage information and a brief description of the command are displayed.
Specifying command targets displays a complete list of valid targets for that command from the fixed targets in /SP and /SYS. Fixed targets are targets that cannot be created by a user.
Specifying command targets legal displays copyright information and product use rights.
Syntax
help [options] command [targets]
Options
[-h|help] [-output terse|verbose]
Commands
cd, create, delete, exit, help, load, reset, set, show, start, stop, version
Examples
-> help load
The load command is used to transfer a file from a server to a target.
Usage: load -source URL [target]
-source : specify the location to get a file
-> help -output verbose reset
The reset command is used to reset a target.
Usage: reset [-script] [target]
Available options for this command:
-script : do not prompt for yes/no confirmation and act as if yes was specified.
Examples:
-> reset /SYS
Are you sure you want to reset /SYS (y/n)? y
Performing hard reset on /SYS
-> reset
/SP Are you sure you want to reset /SP (y/n)? n
Command aborted. ->
A.2.6 Using the load Command
Use the load command to transfer an image file from a source, indicated by a Uniform Resource Indicator (URI), to update the ILOM firmware. The URI can specify a protocol and credentials used for the transfer. Only the TFTP protocol is supported, so the URL must begin with tftp://. If credentials are required and not specified, the command prompts you for a password.
|
Note - Use this command to update your ILOM firmware and BIOS.
|
Syntax
load -source URL
Options
[-h|help] [-source]
Examples
-> load -source tftp://archive/newmainimage
-> load -source tftp://10.6.22.32/tftp_files/file.ima
-> load -source tftp://tftpserver.sun.com/file.ima
|
Note - A firmware upgrade will cause the server and ILOM to be reset. It is recommended that a clean shutdown of the server be done prior to the upgrade procedure. An upgrade takes about five minutes to complete. ILOM enters a special mode to load new firmware. No other tasks can be performed in ILOM until the firmware upgrade is complete and ILOM is reset.
|
-> load -source tftp://archive/newmainimage
Are you sure you want to load the specified file (y/n)? y
File upload is complete.
Firmware image verification is complete.
Do you want to preserve the configuration (y/n)? n
Updating firmware in flash RAM:
.
Firmware update is complete.
ILOM will not be restarted with the new firmware.
|
A.2.7 Using the reset Command
Use the reset command to reset the state of the target. You will be prompted to confirm a reset operation. Eliminate this prompt by using the -script option.
|
Note - The reset command does not affect the power state of hardware devices.
|
Syntax
reset [options] target
Options
[-h|help] [-script]
Targets
TABLE A-12 Targets for the reset Command
|
Valid Targets
|
|
/SP
|
|
/SYS
|
Examples
-> reset /SP
-> reset /SYS
A.2.8 Using the set Command
Use the set command to specify the properties of the target.
Syntax
set [options] [-default] target [propertyname=value]
Options
[-x examine] [-h help]
Targets, Properties, and Values
TABLE A-13 Targets, Properties, and Values for the set Command
|
Valid Targets
|
Properties
|
Values
|
Default
|
|
/SP/users/username
|
password
role
|
<string>
administrator|operator
|
(none)
operator
|
|
/SP/alert/rules/rulename
(rulename = 1 through 15)
|
level
destination
|
disable|information|warning|critical|non-recoverable
<ipaddress>
|
critical
(none)
|
|
/SP/clock
|
usentpserver
|
enabled|disabled
|
/SP/clock
|
|
/SP/services/http
|
servicestate
|
enabled|disabled
|
/SP/services/http
|
|
/SP/services/https
|
servicestate
|
enabled|disabled
|
/SP/services/https
|
|
/SP/services/snmp
|
engineid
port
sets
traps
v1
v2c
v3
|
<hexadecimal>
<decimal>
enabled|disabled
enabled|disabled
enabled|disabled
enabled|disabled
enabled|disabled
|
IP address
161
disabled
disabled
disabled
disabled
enabled
|
|
/SP/services/snmp/
community/communityname
|
permissions
|
ro|rw
|
ro
|
|
/SP/services/snmp/user
/username
|
authenticationprotocol
authenticationpassword
permissions
privacyprotocol
privacypassword
|
MD5
<string>
ro|rw
none|DES
<string>
|
MD5
(null string)
ro
DES
(null string)
|
|
/SP/clients/ldap
|
binddn
bindpw
defaultrole
ipaddress
port
searchbase
state
|
<username>
<string>
administrator|operator
<ipaddress>|none
<decimal>
<string>
enable|disabled
|
(none)
(none)
operator
none
389
(none)
disabled
|
|
/SP/clients/radius
|
defaultrole
ipaddress
port
secret
state
|
administrator|operator<ipaddress>|none
<decimal>
<string>|none
enable|disabled
|
operator
none
1812
none
disabled
|
|
/SP/clients/servers/[1|2]
|
address
|
<IP address>|<hostname>|
none
|
(none)
|
|
/SP/network
|
commitpending
pendingipaddress
pendingdiscovery
pendingipgateway
pendingipnetmask
|
true
<IP address>|none
dhcp|static
<IP address>|none
<IP dotted decimal>
|
(none)
(none)
dhcp
(none)
255.255.255.255
|
|
/SP/serial/external
|
commitpending
flowcontrol
pendingspeed
|
true
none
<decimal from list>
|
(none)
none
9600
|
|
/SP/serial/host
|
commitpending
pendingspeed
|
true
<decimal from list>
|
(none)
9600
|
Examples
-> set /SP/users/susan role=administrator
-> set /SP/clients/ldap state=enabled binddn=proxyuser bindpw=ez24get
A.2.9 Using the show Command
Use the show command to display information about targets and properties.
Using the -display option determines the type of information shown. If you specify -display targets, then all targets in the namespace below the current target are shown. If you specify -display properties, all property names and values for the target are shown. With this option you can specify certain property names, and only those values are shown. If you specify -display all, all targets in the namespace below the current target are shown, and the properties of the specified target are shown. If you do not specify a -display option, the show command acts as if -display all was specified.
The -level option controls the depth of the show command and it applies to all modes of the -display option. Specifying -level 1 displays the level of the namespace where the object exists. Values greater than 1 return information for the target's current level in the namespace and the <specified value> levels below. If the argument is -level all, it applies to the current level in the namespace and everything below.
Syntax
show [options] [-display targets|properties|all] [-level value|all] target [propertyname]
Options
[-d|-display] [-e|examine] [-l|level]
Targets and Properties
TABLE A-14 Targets for the show Command
|
Valid Targets
|
Properties
|
|
/SYS
|
|
|
/SP
|
|
|
/SP/alert
|
|
|
/SP/alert/rules/alertrulename
|
type
level
destination
|
|
/SP/clients/ldap
|
binddn
bindpw
defaultrole
ipaddress
port
searchbase
state
|
|
/SP/clients/radius
|
defaultrole
ipaddress
port
secret
state
|
|
/SP/clients/ntp
|
|
|
/SP/clients/ntp/server
|
|
|
/SP/clients/ntp/server/[1|2]
|
|
|
/SP/clock
|
datetime
usentpserver
|
|
/SP/logs
|
|
|
/SP/logs/event
|
clear
|
|
/SP/logs/event/list
|
|
|
/SP/network
|
commitpending
ipaddress
ipdiscovery
ipgateway
ipnetmask
linkstatus
macaddress
pendingipaddress
pendingdiscovery
pendingipgateway
pendingipnetmask
|
|
/SP/serial
|
|
|
/SP/serial/external
|
commitpending
flowcontrol
pendingspeed
speed
|
|
/SP/serial/host
|
commitpending
pendingspeed
speed
|
|
/SP/services
|
|
|
/SP/services/http
|
port
secureredirect
servicestate
|
|
/SP/services/https
|
port
servicestate
|
|
/SP/services/snmp
|
ngineid
port
sets
traps
v1
v2c
v3
|
|
/SP/services/snmp/communities/
|
|
|
/SP/services/snmp/communities/private
|
permissions
|
|
/SP/services/snmp/communities/public
|
permissions
|
|
/SP/services/snmp/users
|
|
|
/SP/services/ssh
|
|
|
/SP/services/ssh/keys
|
|
|
/SP/services/ssh/keys/dsa
|
fingerprint
length
publickey
|
|
/SP/services/ssh/keys/rsa
|
fingerprint
length
publickey
|
|
/SP/sessions
|
|
|
/SP/sessions/sessionid
|
starttime
source
type
user
|
|
/SP/users
|
|
|
/SP/users/username
|
role
|
Examples
-> show -display properties /SP/users/susan
/SP/users/susan
Properties:
role = Administrator
TABLE A-15
|
-> show /SP/clients -level 2
|
|
|
|
/SP/clients
|
|
|
|
|
|
Targets:
|
|
|
|
|
|
|
ldap
ntp
|
|
|
Properties:
|
|
|
|
|
Commands:
|
|
|
|
|
|
|
cd
|
|
|
|
|
show
|
|
/SP/clients/ldap
|
|
|
|
|
|
Targets:
|
|
|
|
|
Properties:
|
|
|
|
|
|
|
binddn = cn=Manager,dc=sun,dc=com
bindpw = secret
defaultrole = Operator
ipaddress = 129.144.97.180
port = 389
searchbase = ou=people,dc=sun,dc=com
state = disabled
|
|
|
Commands:
|
|
|
|
|
|
|
cd
|
|
|
|
|
show
|
|
/SP/clients/ntp
|
|
|
|
|
|
Targets:
|
|
|
|
|
|
|
server
|
|
|
Properties:
|
|
|
|
|
Commands:
cd
show
|
|
|
A.2.10 Using the start Command
Use the start command to turn on the target or to initiate a connection to the host console.
Syntax
start [options] target
Options
[-h|help] [-state]
Targets
TABLE A-16 Targets for the start Command
|
Valid Targets
|
Description
|
|
/SYS
|
Starts (powers on) the system.
|
|
/SP/console
|
Starts an interactive session to the console stream.
|
Examples
-> start /SP/console
-> start /SYS
A.2.11 Using the stop Command
Use the stop command to shut down the target or to terminate another user's connection to the host console. You will be prompted to confirm a stop command. Eliminate this prompt by using the -script option.
Syntax
stop [options] [-script] target
Options
[-f|force] [-h|help]
Targets
TABLE A-17 Targets for the stop Command
|
Valid Targets
|
Description
|
|
/SYS
|
Perform an orderly shutdown, followed by a power off of the specified hardware. Use the -force option to skip the orderly shutdown and force an immediate power off.
|
|
/SP/console
|
Terminate another user's connection to the host console.
|
Examples
-> stop /SP/console
-> stop -force /SYS
A.2.12 Using the version Command
Use the version command to display ILOM version information.
Syntax
version
Options
[-h|help]
Example
-> version
version SP firmware version: 1.0.0
SP firmware build number: 4415
SP firmware date: Mon Mar 28 10:39:46 EST 2005
SP filesystem version: 0.1.9
| Integrated Lights Out Manager (ILOM) Administration Guide for ILOM 1.1.1
|
820-0280-12
|
|
Copyright © 2007, Sun Microsystems, Inc. All Rights Reserved.