A P P E N D I X  A

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 into the computer. Type 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 show



TABLE A-3 User Commands

Description

Command

Add a local user.

create /SP/users/user1

Set or change password.

set /SP/users/username Password=password

Set or change permission.

set /SP/users/username Permission=operator|administrator|user|callback

Delete a local user named user1.

delete /SP/users/user1

Change the permission level of a local user named user1.

set /SP/users/user1 Permission=operator



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.

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 Destination1.

show /SP/AgentInfo/PET/Destination1

Change alert configuration.

set /SP/AgentInfo/PET/Destination[n] IPAddress=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 port=snmpportnumber set=enabled|disabled
version1=enabled|disabled

version2c=enabled|disabled
version3=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/AgentInfo/SNMP/user/snmpusername

Display information about SNMP public (read-only) communities.

show /SP/AgentInfo/SNMP/communities/public


 


TABLE A-7 System Start, Stop, and Reset Commands

Description

Command

Start the host system.

set /SYS/CtrlInfo PowerCtrl=on

Stop the host system.

set /SYS/CtrlInfo PowerCtrl=off

Stop the host system gracefully.

set /SYS/CtrlInfo PowerCtrl=gracefuloff

Reset the host system.

set /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. 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

[-h|help]

Targets and Properties

Any location in the namespace.

Examples

To create a user named sally, use cd to change to /SP/User, then execute the create command with /SP/User as the default target.

SP-> cd /SP/User

SP-> create sally

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/User/username

password

permission

string

administrator|operator|user|callback

(None)

operator

/SP/SNMP/communities/
communityname

Permissions

ro|rw

ro

/SP/SNMP/communities/user/
username

AuthProtocol

AuthPassword

Permissions

PrivacyProtocol

PrivacyPassword

MD5

string

ro|rw

none|DES

string

MD5

(Null string)

ro

DES

(Null string)


Example

-> create /SP/User/susan role=administrator

delete

Use the delete command to remove an object from the namespace. You are not prompted to confirm a delete command.

Eliminate this prompt by using the -script option.

Syntax

delete [options] target

Options

[-h|help]

Targets

TABLE A-9 delete Command Targets

Valid Targets

/SP/User/username

/SP/SNMP/communities/communityname

/SP/SNMP/communities/user/username


Examples

-> delete /SP/User/susan

-> delete /SP/SNMP/communities/johnny

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.

Specifying command targets legal displays copyright information and product use rights.

Syntax

help [options] command [targets]

Options

[-h|help]

Commands

cd, create, delete, exit, help, load, reset, set, show, start, stop, version

Examples

-> help load

Use the load command to transfer a file from a server and update a target.

Usage: load -source URL [target]

-source: specific the location to get a file

-> help reset

Use the reset command 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.

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/User/username

password

permission

string

administrator|operator

(None)

operator

/SP/clock

Date

Time

NTPstatus

NTPserver

MM/DD/YYYY

hh:mm:ss

enabled|disabled

ipaddress

/SP/clock

/SP/AgentInfo/SNMP

port

snmpset

version1

version2

version3

decimal

enabled|disabled

enabled|disabled

enabled|disabled

enabled|disabled

161

disabled

disabled

disabled

enabled

/SP/AgentInfo/SNMP
community/
communityname

Permission

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

IIPaddress

DNS

IPSource

Gateway

Netmask

IP address|none

IP address|none

dhcp|static

IP address|none

IP dotted decimal

(None)

(None)

dhcp

(None)

xxx.xxx.xxx.xxx


Examples

-> set /SP/users/susan 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 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] target[propertyname]

Options

[-h|help]

Targets and Properties
Examples

->show /SP/network (This is the only valid command as it displays all parameters)

/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-11 start Command Target

Valid Target

Description

/SP/AgentInfo/Console

Starts an interactive session to the console.


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. You will be prompted to confirm a stop command. Eliminate this prompt by using the -script option.

Syntax

stop [options] target

Options

[-h|help] [-s|script]

Targets

TABLE A-12 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

[-x|examine] [-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


Properties and Values for Targets

This section contains all the properties and values for each target.

Targets and Verbs

Targets and verbs for / and /SP/ are shown below:


Relative Targets

Supported Verbs

cd

exit

help

load

create

delete

Set

show

start

stop

reset

version

/

x

x

x

 

 

 

x

x

 

 

 

x

/SP/

x

x

x

x

 

 

x

x

 

 

x

x


/SP/

Properties, values, and access for /SP/ are shown below:


Property Name

Valid Value

Access

Description

Firmwareversion

N/A

R

firmware version

Timeout

N/A

R/W

timeout value of CLI session

CPLDVersion

N/A

R

display CPLD version


User

The user target is used to change and display information on the access rights of individual users. A user is selected via her or his user name. When the configurations have been modified by CLI. Targets and verbs for user are shown below:


Relative Targets

Supported Verbs

cd

exit

help

load

create

delete

Set

show

start

stop

reset

version

/SP/user

x

x

x

 

 

 

x

x

 

 

 

x

/SP/user/username

x

x

x

x

 

 

x

x

 

 

x

x


/SP/user/username

Properties, values, and access for /SP/user/username are shown below:


Property Name

Valid Value

Access

Description

status

enable, disable

R/W

status of this user

permission

administrator, operator, user, callback

R/W

permission of this user

password

STRING

W

password of this user


 

Network

Targets and Verbs

Targets and verbs for /SP/network are shown below:


Relative Targets

Supported Verbs

cd

exit

help

load

create

delete

Set

show

start

stop

reset

version

/SP/network

x

x

x

 

 

 

 

 

 

 

 

 


/SP/network

Properties, values, and access for /SP/network are shown below:


Property Name

Valid Value

Access

Description

MACaddress

N/A

R

Agent ethernet MAC address

IPAddress

IP ADDRESS

R/W

Configuration of the agent IP address

Netmask

IP ADDRESS

R/W

Configuration of the agent IP subnet mask

Gateway

IP ADDRESS

R/W

Configuration of the agent IP gateway address

DNS

IP ADDRESS

R/W

Configuration of the agent DNS server address

IPsource

static, dhcp

R/W

Configuration of the agent IP address source

Hostname

STRING

R/W

Configuration of the agent hostname


Targets and Verbs

Targets and verbs for /SP/clock are shown below:


Relative Targets

Supported Verbs

cd

exit

help

load

create

delete

Set

show

start

stop

reset

version

/SP/clock

x

x

x

 

 

 

x

x

 

 

 

x


 

Clock

/SP/clock

Properties, values, and access for /SP/clock are shown below:


Property Name

Valid Value

Access

Description

Date

MM/DD/YYYY

R/W

Date of agent

Time

hh:mm:ss

R/W

Time of agent

NTPstatus

enable, disable

R/W

Synchronize time using NTP.

NTPserver

IP ADDRESS

R/W

IP address of NTP server

TimeZoneID

Time zone id

R/W

Time zone id show in TimeZoneList

TimeZone

Time zone name

R

Time zone places of TimeZoneID show in TimeZoneList


/SP/clock/TimeZoneList

N/A

TftpUpdate

/SP/TftpUpdate

Properties, values, and access for /SP/TftpUpdate are shown below:


Property Name

Valid Value

Access

Description

ServerIP

IP ADDRESS

R/W

Set the IP address for the TFTP server.

FileName

STRING

R/W

Set the file name for the image.

BIOSCMOS

save, notsave (w)

SaveCMOS, NotSaveCMOS (r)

R/W

Flag of TftpUpdate

Update

action

W

Start the firmware and BIOS update.


CPLDUpdate

/SP/CPLDUpdate

Properties, values, and access for /SP/CPLDUpdate are shown below:


Property Name

Valid Value

Access

Description

ServerIP

IP ADDRESS

R/W

Set the IP address for the TFTP server.

FileName

STRING

R/W

Set the file name for the image.

CPLDUpdate

action

W

Start to update the firmware and BIOS.


Management Agent Information

Targets and Verbs

The targets and verbs for /SP/AgentInfo are shown below:


Relative Targets

Supported Verbs

cd

exit

help

load

create

delete

Set

show

start

stop

reset

version

/SP/AgentInfo

x

x

x

 

 

 

x

x

x

x

 

x

/SP/AgentInfo/PEF

x

x

x

 

 

 

x

x

 

 

 

x

/SP/AgentInfo/PEF/EventFilterTable[1:6]

x

x

x

 

 

 

x

x

 

 

 

x

/SP/AgentInfo/PET

x

x

x

 

 

 

x

x

 

 

 

x

/SP/AgentInfo/PET/Destination[1:4]

x

x

x

 

 

 

x

x

 

 

 

x

/SP/AgentInfo/SEL

x

x

x

 

 

 

x

x

 

 

 

x

/SP/AgentInfo/Console

x

x

x

 

 

 

 

 

x

x

 

x

/SP/AgentInfo/Mail

x

x

x

 

 

 

x

x

 

 

 

x

/SP/AgentInfo/Mail/receiver[1:10]

x

x

x

 

 

 

x

x

 

 

 

x

/SP/AgentInfo/SNMP

x

x

x

 

 

 

x

x

 

 

 

x

/SP/AgentInfo/SNMP/communities

x

x

x

 

x

x

x

x

 

 

 

x

/SP/AgentInfo/SNMP/users

x

x

x

 

x

x

x

x

 

 

 

x


/SP/AgentInfo/PEF

Properties, values, and access for /SP/Agent/PEF are shown below:


Property Name

Valid Value

Access

Description

PEFGlobalCtrl

enable, disable

R/W

PEF global control switch

PEFActionGlobalCtrlPowerOff

enable, disable

R/W

PEF action global control - power

PEFActionGlobalCtrlPowerCycle

enable, disable

R/W

PEF action global control - power

PEFActionGlobalCtrlPowerReset

enable, disable

R/W

PEF action global control - power

PEFActionGlobalCtrlAlert

enable, disable

R/W

PEF action global control - alert

PEFActionGlobalCtrlMail

enable, disable

R/W

PEF action global control - mail

PEFActionGlobalCtrlInterrupt

enable, disable

R/W

PEF action global control - interrupt


/SP/Agent/PEF/EventFilterTable[1:6]

Properties, values, and access for /SP/AgentInfo/PEF/EventFilterTable[1:6} are shown below:


Property Name

Valid Value

Access

Description

Status

enable, disable

R/W

Enable/Disable this table

Sensortype

all, voltage, temperature, memory

R/W

Event filter sensor type

powerctrl

PowerOff, PowerReset, PowerCycle, disable

R/W

Event action - power

diagnosticInterrupt

enable, disable

R/W

Event action - interrupt

sendalert

enable, disable

R/W

Event action - alert

sendmail

enable, disable

R/W

Event action - mail


/SP/AgentInfo/PET/Destination[1:4]

Properties, values, and access for /SP/AgentInfo/PET/Destination[1:4} are shown below:


Property Name

Valid Value

Access

Description

IP

IP ADDRESS

R/W

PET IP Address


/SP/AgentInfo/SEL/

Properties, values, and access for /SP/AgentInfo/SEL are shown below:


Property Name

Valid Value

Access

Description

CearEventlog

action

R/W

Clear event logs


/SP/AgentInfo/Mail

Properties, values, and access for /SP/AgentInfo/Mail are shown below:


Property Name

Valid Value

Access

Description

SMTPServer

IP ADDRESS

R/W

SMTP server IP address

Sender

STRING

R/W

Mail notification sender

ClearSMTPServer

action

W

Clear SMTP server IP address

ClearSender

action

W

Clear Mail notification sender


/SP/AgentInfo/Mail/receiver[1:10]

Properties, values, and access for /SP/AgentInfo/Mail/receiver[1:10] are shown below:


Property Name

Valid Value

Access

Description

EmailAddress

MAIL ADDRESS

R/W

Receiver mail address

ClearReceiver

action

W

Clear the mail address


/SP/AgentInfo/SNMP

Properties, values, and access for /SP/AgentInfo/SNMP are shown below:


Property Name

Valid Value

Access

Description

port

INTEGER(0-65535)

R/W

SNMP daemon port

snmpset

enable, disable

R/W

SNMP management information settable

version1

enable, disable

R/W

SNMP protocol version 1 support

version2c

enable, disable

R/W

SNMP protocol version 2c support

version3

enable, disable

R/W

SNMP protocol version 3 support


/SP/AgentInfo/SNMP/communities/community

Properties, values, and access for /SP/AgentInfo/SNMP/communities/community are shown below:


Property Name

Valid Value

Access

Description

Permission

ro, rw

R/W

SNMP community permission


/SP/AgentInfor/SNMP/users/user

Properties, values, and access for /SP/AgentInfo/SNMP/users/user are shown below:


Property Name

Valid Value

Access

Description

Permission

ro, rw

R/W

SNMP user permission

AuthProtocol

MD5, SHA

R/W

SNMP v3 user authentication protocol

AuthPassword

STRING

W

SNMP v3 user authentication protocol

PrivacyProtocol

none, DES

R/W

SNMP v3 user privacy protocol

PrivacyPassword

STRING

W

SNMP v3 user privacy password


System Information

The System Information contains board, product, chassis, CPU, memory module, and health information. It also allows you to control the power state.

Targets and Verbs

The targets and verbs for /SYS/ are shown below:


Relative Targets

Supported Verbs

cd

exit

help

load

create

delete

Set

show

start

stop

reset

version

/SYS

x

x

x

 

 

 

 

x

 

 

 

x

/SYS/BoardInfo

x

x

x

 

 

 

 

x

 

 

 

x

/SYS/CtrlInfo

x

x

x

 

 

 

 

x

 

 

 

x

/SYS/CPU

x

x

x

 

 

 

 

x

 

 

 

x

/SYS/CPU/CPU[1:N]

x

x

x

 

 

 

 

x

 

 

 

x

/SYS/MemModule

x

x

x

 

 

 

 

x

 

 

 

x

/SYS/MemModule/MemModule[1:N]

x

x

x

 

 

 

 

x

 

 

 

x

/SYS/NICInfo0

x

x

x

 

 

 

 

x

 

 

 

x

/SYS/NICInfo1

x

x

x

 

 

 

 

x

 

 

 

x

/SYS/Fan

x

x

x

 

 

 

 

x

 

 

 

x

/SYS/Fan/Fan[1:N]

x

x

x

 

 

 

 

x

 

 

 

x

/SYS/Temperature

x

x

x

 

 

 

 

x

 

 

 

x

/SYS/Temperature/Temperature[1:N]

x

x

x

 

 

 

 

x

 

 

 

x

/SYS/Voltage

x

x

x

 

 

 

 

x

 

 

 

x

/SYS/Voltage/Voltage[1:N]

x

x

x

 

 

 

 

x

 

 

 

x


/Sys/BoardInfo

Properties, values, and access for /SYS/BoardInfo are shown below:


Property Name

Valid Value

Access

Description

BIOSVersion

-

R

Display the BIOS version.

BoardMfgDateTime

-

R

Displays the date of manufacture for the management board.

BoardProductName

-

R

Displays the product name of the management board.

BoardSerialNumber

-

R

Displays the serial number of the management board.


/SYS/CtrlInfo

Properties, values, and access for /SYS/CtrlInfo are shown below:


Property Name

Valid Value

Access

Description

PowerStatus

on, off

R

Displays the power status.

PowerCtrl

on, off, gracefuloff, reset

W

Control power.

BootCtrl

regular, PXE, BIOSSetup, PCCheck_enable, PCCheck_disable

RW

Control boot and display boot status.

IdLedCtrl

on, off

RW

Control IdLed and display IdLed status.


/SYS/CPU/CPU[0:N]

Properties, values, and access for /SYS/CPU/CPU[1:N] are shown below:


Property Name

Valid Value

Access

Description

SocketDesignation

-

R

Displays the CPU socket designation.

Manufacturer

-

R

Displays the CPU manufacturer.

Name

-

R

Displays the CPU name.

Speed

-

R

Displays the CPU speed

Status

-

R

Displays the CPU status


/SYS/NICInfo0

Properties, values, and access for /SYS/NICInfo0 are shown below:


Property Name

Valid Value

Access

Description

Name

-

R

Displays the NIC name.

PartNumber

-

R

Displays the NIC part number.

MACAddress1

-

R

Displays the NIC MAC address 1.

MACAddress2

-

R

Displays the NIC MAD address 2.


/SYS/NICInfo1

Properties, values, and access for /SYS/NICInfo1 are shown below:


Property Name

Valid Value

Access

Description

Name

-

R

Displays the NIC name.

PartNumber

-

R

Displays the NIC part number.

MACAddress1

-

R

Displays the NIC MAC address 1.

MACAddress2

-

R

Displays the NIC MAD address 2.


/SYS/MemModule/MemModule[1:N]

Properties, values, and access for /SYS/MemModule/MemModule[1:N] are shown below:


Property Name

Valid Value

Access

Description

Designation

-

R

Displays the Memory Module designation.

Type

-

R

Displays the Memory Module type.

Speed

-

R

Displays the Memory Module speed.

Size

-

R

Displays the Memory Module size.


/SYS/Fan/Fan[1:N]

Properties, values, and access for /SYS/Fan/Fan[1:N] are shown below:


Property Name

Valid Value

Access

Description

Designation

-

R

Displays the temperature designation.

Status

-

R

Displays the temperature status.

SensorReading

-

R

Displays the temperature current value.

LNCT

-

R

Displays the temperature lower warning threshold.

LCT

-

R

Displays the temperature lower critical threshold.

UNCT

-

R

Displays the temperature upper warning threshold.

UCT

-

R

Displays the temperature upper critical threshold.


/SYS/Voltage[1:N]

Properties, values, and access for /SYS/Voltage[1:N] are shown below:


Property Name

Valid Value

Access

Description

Designation

-

R

Displays the voltage designation.

Status

-

R

Displays the voltage status.

Sensor Reading

-

R

Displays the voltage current value.

LNCT

-

R

Displays the voltage lower warning threshold.

LCT

-

R

Displays the voltage lower critical threshold.

UNCT

-

R

Displays the voltage upper warning threshold.

UCT

-

R

Displays the voltage upper critical threshold.