Command-Line Interface Reference
|
This chapter contains the most common Embedded Lights Out Manager (ELOM) commands used to administer your Sun server from the command-line interface (CLI). This chapter contains the following sections:
CLI Command Quick Reference
The following tables provide a quick reference to the most common ELOM CLI commands.
TABLE A-1 Command Syntax and Usage
|
Content
|
Typeface
|
Description
|
|
Your input
|
Fixed-width bold
|
Text that you type at the computer. Enter it in 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
|
|
Log out of the CLI.
|
exit
|
|
Display the version of the ELOM firmware running on the SP.
|
version
|
|
Display information about commands and targets.
|
help
|
|
Display information about a specific command.
|
help command or target
|
TABLE A-3 User Commands
|
Description
|
Command
|
|
Add a local user.
|
create /SP/users/username (user names must be between 8-16 characters in length)
|
|
Set or change password.
|
set /SP/users/username password=xxxx (passwords must be between 8-16 characters in length)
|
|
Set or change permission.
|
set /SP/users/username permission=operator|administrator|callback|user (the default is operator)
|
|
Delete a local user.
|
delete /SP/users/username
|
|
Change a local user's properties.
|
set /SP/users/username permission=operator
|
|
Display information about all local users.
|
show -display [targets|properties|all]
-level [value|all] /SP/users
|
TABLE A-4 Network and Serial Port Setting Commands
|
Description
|
Command
|
|
Display network configuration information.
|
show /SP/network
|
|
Change network properties for the ELOM. Changing certain network properties, like the IP address, will disconnect your active session. You cannot change the MACaddress.
|
set /SP/network
IPAddress=xxx.xxx.xxx.xxx
Netmask=xxx.xxx.xxx.xxx
Gateway=xxx.xxx.xxx.xxx
|
|
Set DHCP or change to static settings.
|
set /SP/network IPSource=[dhcp|static]
|
TABLE A-5 Alert Commands
|
Description
|
Command
|
|
Display information about PET alerts.
|
show /SP/AgentInfo/PET/Destination[1...4]
|
|
Change alert configuration.
|
set /SP/AgentInfo/PET/ Destination[1...4] IPAdress=ipaddress
|
TABLE A-6 SNMP Commands
|
Description
|
Command
|
|
Display information about SNMP settings. By default, the SNMP port is 161, and v3 is enabled.
|
show /SP/AgentInfo/SNMP
|
|
|
show /SP/AgentInfo/SNMP port=snmpportnumber snmpset=enabled|disabled
|
|
Display SNMP users.
|
show /SP/AgentInfo/SNMP/user
|
|
Add an SNMP user.
|
create /SP/AgentInfo/SNMP/user/snmpusername authpassword=password
authprotocol=[MD5|SHA]
permission=rw|ro privacypassword=password privacyprotocol=none|DES
|
|
Delete an SNMP user.
|
delete /SP/services/SNMP/user/snmpusername
|
|
Display information about SNMP public (read-only) communities.
|
show /SP/AgentInfo/SNMP/communities/public
|
|
Add this device to an SNMP public community.
|
create /SP/AgentInfo/SNMP/communities/
public/comm1
|
|
Delete this device from an SNMP public community.
|
delete /SP/AgentInfo/SNMP/communities/
public/comm1
|
|
Display information about SNMP private (read-write) communities.
|
show /SP/AgentInfo/SNMP/communities/private
|
|
Add this device to an SNMP private community.
|
create /SP/AgentInfo/SNMP/communities/
private/comm2
|
|
Delete this device from an SNMP private community.
|
delete /SP/AgentInfo/NMP/communities/
private/comm2
|
TABLE A-7 System Start and Stop Commands
|
Description
|
Command
|
|
Start the host system.
|
set /SP/SYS/CtrlInfo PowerCtrl=on
|
|
Stop the host system gracefully.
|
set /SP/SYS/CtrlInfo PowerCtrl=gracefuloff
|
|
Stop the host system forcefully.
|
set /SP/SYS/CtrlInfo PowerCtrl=forceoff
|
|
Reset the host system.
|
set /SP/SYS/CtrlInfo PowerCtrl=reset
|
|
Start a session to connect to the host console.
|
start /SP/AgentInfo/console
|
|
Stop the session connected to the host console.
|
stop /SP/AgentInfo/console
|
CLI Command Reference
This section provides reference information about the CLI commands.
cd
Use the cd command to navigate the namespace. When you use cd to change 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. Entering just cd displays your current location in the namespace. Entering help targets displays a list of all targets in the entire namespace.
Syntax
cd target
Options
[-h|help]
Targets and Properties
Any location in the namespace.
Examples
To create a user named newuser1, use cd to change to /SP/users, then execute the create command with /SP/users as the default target.
-> cd /SP/users
-> create newuser1
To return to the root position, enter:
-> cd /
create
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
[-h|help]
Targets, Properties, and Values
TABLE A-8 Create command Targets, Properties, Values, and Defaults
|
Valid Targets
|
Properties
|
Values
|
Default
|
|
/SP/users/username
|
password
role
|
string
[administrator|operator|user|callback]
|
(None)
operator
|
|
/SP/AgentInfo/SNMP/communities/
communityname
|
permissions
|
[ro|rw]
|
ro
|
|
/SP/AgentInfo/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
delete
Use the delete command to remove an object from the namespace. You are not prompted to confirm a delete command.
Syntax
delete [options] target
Options
[-h|help]
Targets
TABLE A-9 delete Command Targets
|
Valid Targets
|
|
/SP/users/username
|
|
/SP/AgentInfo/SNMP/communities/communityname
|
|
/SP/AgentInfo/SNMP/user/username
|
Example
-> delete /SP/users/basicuser
exit
Use the exit command to terminate a session to the CLI.
Syntax
exit [options]
Options
[-h|help]
help
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. Fixed targets are targets that cannot be created by a user.
Syntax
help command
Options
[-h|help]
Commands
cd, create, delete, exit, help, load, reset, set, show, start, stop, version
Example
-> help load
The load command is used to transfer a file from a server and update a target.
Usage: load -source URL targets
Available options for this command:
-help : display help message of this command
|
set
Use the set command to change the value of a property associated with a target.
Syntax
set [target] property=value [propertyname=value]
Options
[-h help]
Targets, Properties, and Values
TABLE A-10 set Command Targets, Properties, and Values
|
Valid Targets
|
Properties
|
Values
|
Default
|
|
/SP/users/username
|
password
permission
|
string
[administrator|operator|user|callback]
|
(None)
operator
|
|
/SP/clock
|
Date
Time
|
MM/DD/CCYY
hh/mm/ss
|
/SP/clock
|
|
/SP/AgentInfo/SNMP
|
port
snmpset
version1
version2c
version3
|
decimal
[enabled|disabled]
[enabled|disabled]
[enabled|disabled]
[enabled|disabled]
|
161
disabled
disabled
disabled
enabled
|
|
/SP/AgentInfo/SNMP
communities/communityname
|
Permissions
|
[ro|rw]
|
ro
|
|
/SP/AgentInfo/SNMP/user
/username
|
AuthProtocol
AuthPassword
Permission
PrivacyProtocol
PrivacyPassword
|
[MD5|SHA]
string
[ro|rw]
[none|DES]
string
|
MD5
(Null string)
ro
DES
(Null string)
|
|
/SP/network
|
IPAddress
Netmask
Gateway
DNS
IPSource
Hostname
|
[IP address|none]
[IP address|none]
[IP address|none]
[IP address|none]
[dhcp|static]
STRING
|
(None)
255.255.255.255
(None)
(None)
(None)
|
Example
-> set /SP/users/basicuser permission=administrator
show
Use the show command to display information about targets and properties.
The show command is used to display information about managed elements. It can be used to view information about a single managed elements, a tree of managed elements, or managed elements matching a property value filter.
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|commands|all] [-ll -level 1|2|3...|all] [target] [property property...]
Options
[-d|display] [-h|-help] [-l|level]
Targets and Properties
TABLE A-11 show Command Targets and Properties
|
Valid Targets
|
Properties
|
|
/SP/network
|
MACaddress
|
|
|
IPAddress
|
|
|
Netmask
|
|
|
Gateway
|
|
|
DNS
|
|
|
IPSource
|
|
|
Hostname
|
Examples
->show /SP/network
/SP/network
Targets:
Target Commands:
show
set
|
start
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]
Targets
TABLE A-12 start Command Target
|
Valid Target
|
Description
|
|
/SP/AgentInfo/Console
|
Starts an interactive session to the console stream.
|
Examples
-> start /SP/AgentInfo/Console
stop
Use the stop command to shut down the target or to terminate another user’s connection to the host console.
Syntax
stop [options] target
Options
[-h|help]
Targets
TABLE A-13 stop Command Target
|
Valid Target
|
Description
|
|
/SP/AgentInfo/Console
|
Terminate another user’s connection to the host console.
|
Examples
-> stop /SP/AgentInfo/Console
reset
Use the reset command to reset the target’s state. This command can be used with and without options.
Syntax
reset [target]
Options
[-h|help]
Example
-> reset /system3
version
Use the version command to display ELOM version information.
Syntax
version
Options
[-h|help]
Example
-> version
SM CLP Version v1.0.0
SM ME Addressing Version v1.0.0
CLI Error MessagesVerbs
cd
|
Error Message
|
Description
|
|
Current default target: current path
|
Did not specify target
|
|
cd: invalid target target path
|
Target node does not exist, invalid path
|
create
|
Error Message
|
Description
|
|
create: Parent object does not exist
|
Parent node does not exist
|
|
create: Object cannot be created
|
Do not specify target name
|
|
create failed
|
Cannot create a node
|
delete
|
Error Message
|
Description
|
|
delete: invalid target target path
|
Invalid target or do not specify target name
|
|
delete: Object target path cannot be deleted
|
Invalid target
|
exit
|
Error Message
|
Description
|
|
exit: sytax error, the exit command does not support a target.
|
Did not support exit
|
help
|
Error Message
|
Description
|
|
help: Invalid command input string - type help for a list of commands.
|
Input string does not match any name in command list
|
|
help: Invalid command syntax
Usage: help [-o|-output terse|verbose] [<command>|legal|targets]
|
Too many parameter
|
reset
|
Error Message
|
Description
|
|
reset: invalid target target path
|
Invalid target or do not specify target name
|
|
reset: Object target path cannot be reset
|
Invalid target
|
set
|
Error Message
|
Description
|
|
set: syntax error
|
if no any argument, this is command syntax error
|
|
set: invalid target input token
|
User input more than one token at first time.
|
|
set: invalid property input token
|
Input token is not a property
|
|
set: object input token cannot be written
|
Input token is only readable
|
|
Could not set node name to input value string
|
Set fail
|
Targets
show
|
Error Message
|
Description
|
|
show: invalid target target path
|
Input invalid target path
|
start
|
Error Message
|
Description
|
|
start: invalid target target path
|
Invalid target or do not specify target name
|
|
start: Object target path cannot be started
|
Invalid target
|
stop
|
Error Message
|
Description
|
|
stop: invalid target target path
|
Invalid target or do not specify target name
|
|
stop: Object target path cannot be stopped
|
Invalid target
|
|
console de-activate successful
|
Not specify examine option, do it actually
|
version
|
Version
|
|
Error Message
|
Description
|
|
Invalid syntax, the version command does not support a target.
|
Do not support version command.
|
/SP/users
|
Error Message
|
Description
|
|
Maximum number of users exceeded.
|
Maximum number of users exceeded.
|
|
Password should be more than 8 character and less than 20 characters.
|
Password rule
|
|
Username and Password can not be the same.
|
User rule
|
|
Every character of password only can be 0-9 a-z A-z.
|
Password rule
|
|
Inconsistent passwords entered.
|
Password rule
|
|
create: target name must only contain alphabets and digits
|
Username rule
|
|
create: target name should be lower case
|
Username rule
|
|
create: invalid arguments
|
Username rule
|
/SP/network
|
/SP/network
|
|
Error Message
|
Description
|
|
Could not be modified under DHCP.
|
User should turn off DHCP flag before setting IP, Net mask, DNS and Gateway.
|
|
Invalid IP
|
Invalid IP
|
/SP/clock
|
Error Message
|
Description
|
|
set: bad parameter date and time string
|
Wrong format of date and time.
|
/SP/TftpUpdate and /SP/CPLDUpdate
|
Error Message
|
Description
|
|
Invalid filename.
|
Invalid filename.
|
|
cannot get ip
|
Cannot get ip
|
|
Cannot get file
|
Cannot get file
|
|
Cannot get save flag
|
Cannot get save flag
|
|
Please DC off.
|
Alert user to turn DC off before updating.
|
|
Update environment has something wrong, please check IP, Filename and Saveflag.
|
Need to check tftp update IP Filename or Saveflag.
|
|
Could not update.
|
Maybe someone has done updating.
|
|
Getting image fail.
|
Cannot upload image to server.
|
|
BIOS progress file cannot be found.
|
Cannot find BIOS progress file.
|
|
wrong parameter.
|
Should set update=action
|
|
Could not get correct update mode from config file.
|
Setting of tftp update has something wrong.
|
|
Set server IP fail.
|
Set tftp or cpld IP address fail.
|
|
Set source file fail.
|
Set tftp or cpld filename address fail.
|
|
Set save configuration fail.
|
Set tftp or cpld save flag address fail.
|
|
Update environment has something wrong, please check IP and Filename.
|
Setting of cpld update has something wrong.
|
/SP/AgentInfo/PEF and /SP/AgentInfo/PET
|
Error Message
|
Description
|
|
Get PEF fail
|
Get PEF fail
|
|
Incorrect Parameter
|
Incorrect Parameter
|
|
Need to enable status first
|
User should enable status before setting PEF event table.
|
|
Set PEF fail
|
Set PEF fail
|
/SP/AgentInfo/SEL
|
Error Message
|
Description
|
|
IPMI open failure
|
Cannot connect with bmc
|
|
IPMI request failure
|
Cannot get information from bmc
|
/SP/AgentInfo/Mail
|
Error Message
|
Description
|
|
IPMI read failure
|
Reading information from bmc fail.
|
|
IPMI write failure
|
Setting information to bmc fail.
|
|
Parameter cannot be empty and should less than 64 bits
|
Mail address string should be between 1 to 64 characters
|
|
Please input correct Email format
|
Email format is wrong.
|
/SP/AgentInfo/SNMP
|
Error Message
|
Description
|
|
Could not get snmp community info.
|
Could not get snmp community info.
|
|
Could not add snmp community.
|
Could not add snmp community.
|
/SP/AgentInfo/Console
|
|
|
Error Message
|
Description
|
|
No response query console
|
No response
|
|
Error: Select returned with nothing to read
|
Returned with nothing to read
|
|
Error in console session
|
Console session closed abnormally
|
/SYS/BoardInfo/
/SYS/ProductInfo/
/SYS/ChassisInfo/
/SYS/CPU/
/SYS/Fan/
/SYS/Temperature/
/SYS/Voltage
|
Error Message
|
Description
|
|
IPMI open fail
|
Cannot connect with BMC
|
|
Cannot get FRU data
|
Cannot get FRU data
|
/SYS/CtrlInfo/
|
Error Message
|
Description
|
|
IPC read fail
|
Read Boot Option fail
|
|
wrong variable
|
Set wrong variable
|
| Sun Blade X6250 Server Module Embedded Lights Out Manager Administration Guide
|
820-1253-14
|
   
|
Copyright © 2008, Sun Microsystems, Inc. All Rights Reserved.