A P P E N D I X  A

Command-Line Interface Reference

This appendix contains the following sections:


CLI Command Quick Reference

This appendix contains the most common embedded lights out manager 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 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/User/user1

Set or change password.

set /SP/User/user Password=xxxx

Set or change permission.

pset /SP/User/user Permission=Operator|Administrator

Delete a local user.

delete /SP/User/user1

Change a local user's properties.

set /SP/User/user1 Permission=operator

Display information about all local users.

show -display [targets|properties|all]
-level
[value|all] /SP/User



TABLE A-4 Network and Serial Port Setting Commands

Description

Command

Display network configuration information.

show /SP/AgentInfo

Change network properties for the ELOM. Changing certain network properties, like the IP address, will disconnect your active session.

set /SP/AgentInfo

IpAddress=xxx.xxx.xxx.xxx

NetMask=xxx.xxx.xxx.xxx

Gateway=xxx.xxx.xxx.xxx

Set DHCP or change to static settings

set /SP/AgentInfo DhcpConfigured=[enable|disable]



TABLE A-5 Alert Commands

Description

Command

Display information about PET alerts.

show /SP/AgentInfo/PET

Change alert configuration.

set /SP/AgentInfo/PET/Destination[n]=ipaddress


TABLE A-6 System Management Access Commands
TABLE A-7 SNMP Commands

TABLE A-8 Host System Commands

Description

Command

Start the host system.

set /SP/SystemInfo/CtrlInfo PowerCtrl=on

Stop the host system gracefully.

set /SP/SystemInfo/CtrlInfo PowerCtrl=gracefuloff

Stop the host system forcefully.

set /SP/SystemInfo/CtrlInfo PowerCtrl=forceoff

Reset the host system.

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

[-d|default] [-e|examine] [-h|help]

Targets and Properties

Any location in the namespace.

Examples

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

cd /SP/User

create sally

To find your location, enter cd.

cd /SP/User

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

[-d|default] [-e|examine] [-h|help]

Targets, Properties, and Values

TABLE A-9 Properties and Values for the Create Command

Valid Targets

Properties

Values

Default

/SP/User/username

Password

Permission

Status

string

administrator|operator|user

(none)

operator

/SP/AgentInfo/SNMP/communities/
communityname

Permission

ro|rw

ro

/SP/AgentInfo/SNMP/users/
username

AuthProtocol

AuthPassword

Permission

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 will be prompted to confirm a delete command.

Eliminate this prompt by using the -script option.

Syntax

delete [options] [-script] target

Options

[-x|examine] [-f|force] [-h|help] [-script]

Targets

TABLE A-10

Valid Targets

/SP/User/username


Examples

-> delete /SP/User/susan

-> delete /SP/AgentInfo/SNMP/users/john

exit

Use the exit command to terminate a session to the CLI.

Syntax

exit [options]

Options

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

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

set

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-11 Set Command Targets, Properties, and Values

Valid Targets

Properties

Values

Default

/SP/User/username

Password

Permission

Status

string

administrator|operator|user

enable|disable

(none)

operator

disable


Examples

-> set /SP/User/susan Permission=administrator

show

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 were 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-12 Show Command Targets

Valid Targets

Properties

Values

/SP/User

(none)

(none)

/SP/User/username

Status

Permission

Password

enable|disable

Administrator|Operator

string


Examples

show -display properties /SP/User/susan

/SP/User/susan
 Targets:
 
 Properties:
    Status=enable
    Permission= Administrator
    Password=(Cannot show property)
 

start

Use the start command to turn on the target or to initiate a connection to the host console.

Syntax

start [options] target

Options

[-x|examine] [-h|help] [-state]

Targets

TABLE 0-1

Valid Targets

Description

/SP/console

Starts an interactive session to the console stream.


Examples

-> start /SP/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] [-script] target

Options

[-x|examine] [-h|help]

Targets

TABLE 0-2

Valid Targets

Description

/SP/console

Terminate another user's connection to the host console.


Examples

stop /SP/console

version

Use the version command to display the ELOM version information.

Syntax

version

Options

[-x|examine] [-h|help]

Example

version

SM CLP Version v1.0.0
SM ME Addressing Version v1.0.0