A P P E N D I X  A

CLI Command Reference


CLI Command Reference

This appendix contains the most common ILOM commands used to administer your Oracle Sun server from the ILOM command-line interface (CLI).

Syntax examples in this appendix use the target starting with /SP/which applies to most Oracle Sun servers. However, if you are performing these commands from a CMM, you can interchange the starting /SP/ target with /CMM/ since the sub-targets are common across all server platforms. Or, if you are performing these commands from a server blade in a chassis monitoring module (CMM), you can the interchange the starting /SP/ target with /CH/BLn or CH/BLn/Noden depending the server blade platform.

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
cd -default
is the equivalent of typing cd /. 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

[-default] [-h|help]

Targets and Properties

Any location in the namespace.

Examples

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

-> cd /SP/users
-> create emmett

To find your location, type cd.

-> cd /SP/users 

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

[-h|help]

Targets, Properties, and Values


TABLE A-1 Targets, Properties and Values for create Command

Valid Targets

Properties

Values

Default

/SP/users/username

password

role

<string>

administrator|operator|a|u|c|r|o|s

(none)

o

/SP/services/snmp/communities/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 

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

[-h|help] [-script]

Targets


TABLE A-2 Targets for delete Command

Valid Targets

/SP/users/username

/SP/services/snmp/communities/communityname

/SP/services/snmp/user/username


Examples

-> delete /SP/users/susan
-> delete /SP/services/snmp/communities/public

dump Command

Use the dump command to transfer a file from a target to a remote location specified by the URI.

Syntax

dump -destination <URI> target

Options

[-destination]

exit Command

Use the exit command to end a CLI session.

Syntax

exit [options]

Options

[-h|help]

help Command

Use the help command to display Help information about commands and targets. Using the -o|output terse option displays usage information only. The
-o|output verbose option displays usage, description, and additional information including examples of command usage. If you do not use the
-o|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 the legal command target displays the copyright information and product use rights.

Syntax

help [options] command target

Options

[-h|help] [-o|output terse|verbose]

Commands

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

Examples


-> help load
The load command transfers a file from a remote location specified by the URI and updates the given target.
Usage: load [-script] -source <URI> [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 were specified.

load Command

Use the load command to transfer an image file from a source, indicated by a Uniform Resource Indicator (URI), to update ILOM firmware. The URI can specify a protocol and credentials used for the transfer. The load command supports multiple protocols (TFTP, SCP, FTP). If credentials are required and not specified, the command prompts you for a password. Using the -script option eliminates the prompt for a yes or no confirmation and the command acts as if yes were specified.



Note - Use this command to update your ILOM firmware and BIOS.



TABLE A-3 Targets, Properties, and Values for load Command

Valid Targets

Properties

Values

Default

/SP/users/username

password

role

<string>

administrator|operator|a|u|c|r|o|s

(none)

o


Syntax

load -source URI

Options

[-h|help] [-script]

Example

-> load -source tftp://ip_address/newmainimage


Note - A firmware upgrade will cause the server and ILOM to be reset. It is recommended that a graceful shutdown of the server be done prior to the upgrade procedure. An upgrade takes about five minutes to complete. ILOM will enter 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://ip_address/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.

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]

(The -f|force option is supported on SPARC-based systems.)

Targets


TABLE A-4 Targets for reset Command

Valid Targets

/SP

/SYS


Examples

-> reset /SP
-> reset /SYS

set Command

Use the set command to specify the properties of the target.

Syntax

set [options] target [propertyname=value]

Options

[-h|help]

Targets, Properties, and Values


TABLE A-5 Targets, Properties, and Values for set Command

Valid Targets

Properties

Values

Default

/HOST/tpm

enable

activate

forceclear

true | false

true | false

true | false

false

false

false

/SP/alertmgmt/rules

testalert

true

(none)

/SP/alertmgmt/rules/
rulename
(rulename = 1 through 15)

community_or_username

destination

destination_port

event_class_filter

 

 

 

 

event_type_filter

 

 

 

 

 

level

 

snmp_version

 

type

<string>

email_address

<integer>

“ “ | Log | Email | Internal | Captive Shell | Backup | Restore | Audit | IPMI | Chassis | Fault | System | ActDir

 

“ “ | Developer | Connection | Send | Product | Chassis | Command Entered | State | Action | Fault | Repair | Warning

 

disable|down|critical|major|minor

 

1|2c|3

 

email | ipmipet | snmptrap

public

(none)

0

(none)

 

 

 

 

(none)

 

 

 

 

 

(none)

 

 

3

(none)

/SP/cli

timeout

<integer>

(none)

/SP/clock

datetime

timezone

usentpserver

current date and time

EST | PST8PDT

enabled|disabled

<string>

GMT

disabled

/SP/console/history

line_count

pause_count

start_from

<integer>

<integer>

end | beginning

0

0

end

/SP/services/http

port

secureredirect

servicestate

<integer>

enabled|disabled

enabled|disabled

80

enabled

disabled

/SP/services/https

port

servicestate

<integer>

enabled|disabled

443

disabled

/SP/services/ipmi

servicestate

enabled|disabled

enabled

/SP/services/kvms

mousemode

servicestate

absolute|relative

enabled|disabled

absolute

enabled

/SP/services/snmp

engineid

mibs

port

sets

v1

v2c

v3

servicestate

<hexadecimal>

dump_uri

<integer>

enabled|disabled

enabled|disabled

enabled|disabled

enabled|disabled

enabled|disabled

IP address

(none)

161

disabled

disabled

disabled

enabled

enabled

/SP/services/snmp/
communities/private

permission

ro |rw

rw

/SP/services/snmp/

communities/public

permission

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/services/ssh

external_host

generate_new_key_action

generate_new_key_type

restart_sshd_action

state

 

true

rsa|dsa

true

enabled|disabled

 

(none)

(none)

(none)

enabled

/SP/services/sso

state

enabled|disabled

enabled

/SP/users/username

role

 

password

administrator|operator|a|u|c|r|o|s

<string>

(none)

 

(none)

/SP/clients/
activedirectory

state

defaultrole

dnslocatormode

expsearchmode

address

port

strictcertmode

timeout

logdetail

enabled | disabled

administrator | operator | a| u | c| r | o | s

enabled | disabled

enabled | disabled

<ip address> or <DNS name>

<integer between 0-65535>

enabled | disabled

<integer>

none | high | medium | low |
trace

disabled

(none)

disabled

disabled

(none)

0

disabled

4

none

/SP/clients/
activedirectory/
admingroups/n

where n is 1-5

name

 

<string>

 

(none)

 

/SP/clients/
activedirectory/
opergroups/n

where n is 1-5

name

<string>

(none)

/SP/clients/
activedirectory/
userdomains/n

where n is 1-5

domain

<string>

(none)

/SP/clients/
activedirectory/
customgroups/n

where n is 1-5

name

roles

<string>

a|u|c|r|o|s|administrator|operator

(none)

o

/SP/clients/
activedirectory/
alternateservers/
n

where n is 1-5

address

port

<ip address> or <DNS name>

<integer>

(none)

0

/SP/clients/
activedirectory/
alternateservers/
n/cert

where n is 1-5

certstatus

clear_action

issuer

load_uri

serial_number

subject

valid_from

valid_until

version

<string>

true

<string>

tftp|ftp|scp

<string>

<string>

<string>

<string>

<string>

certificate not present

(none)

(none)

(none)

(none)

(none)

(none)

(none)

(none)

/SP/clients/
activedirectory/cert/

certstatus

clear_action

issuer

load_uri

serial_number

subject

valid_from

valid_until

version

<string>

true

<string>

tftp|ftp|scp

<string>

<string>

<string>

<string>

<string>

certificate not present

(none)

(none)

(none)

(none)

(none)

(none)

(none)

(none)

/SP/clients/
activedirectory/
dnslocatorqueries/n

where n is 1-5

service

<DOMAIN>

(none)

/SP/clients/dns

auto_dns

nameserver

retries

searchpath

timeout

enabled|disabled

<string>

<integer between 0 and 5>

<string>

<integer between 1 and 10>

disabled

(none)

(none)

(none)

(none)

/SP/clients/ldap

binddn

bindpw

defaultrole

 

address

port

searchbase

state

<username>

<string>

administrator|operator|a|u|c|r|o|s

<ipaddress>|none

<integer>

<string>

enable|disabled

(none)

(none)

 

o

(none)

389

(none)

disabled

/SP/clients/ldapssl

state

defaultrole

dnslocatormode

address

port

strictmode

optionalUserMapping

timeout

logdetail

enabled | disabled

administrator | operator | a| u | c| r | o | s

enabled | disabled

<ip address> or <DNS name>

<integer between 0-65535>

enabled | disabled

enabled | disabled

<integer>

none | high | medium | low |
trace

disabled

(none)

disabled

(none)

0

disabled

disabled

4

none

/SP/clients/
ldapssl/
admingroups/n

where n is 1-5

name

 

<string>

 

(none)

 

/SP/clients/
ldapssl/
opergroups/n

where n is 1-5

name

 

<string>

 

(none)

 

/SP/clients/
ldapssl/
userdomains/n

where n is 1-5

domain

 

<string>

 

(none)

 

/SP/clients/ldapssl/
customgroups/
n

where n is 1-5

name

roles

<string>

administrator | operator | a | u| c | r | o | s

(none)


(none)

/SP/clients/ldapssl/
alternateserver/
n

where n is 1-5

address

port

<string>

<integer>

(none)

0

/SP/clients/ldapssl/
alternateservers/
n/cert

where n is 1-5

certstatus

clear_action

issuer

load_uri

serial_number

subject

valid_from

valid_until

version

<string>

true

<string>

tftp|ftp|scp

<string>

<string>

<string>

<string>

<string>

(none)

(none)

(none)

(none)

(none)

(none)

(none)

(none)

(none)

/SP/clients/ldapssl/
cert/

certstatus

clear_action

issuer

load_uri

serial_number

subject

valid_from

valid_until

version

<string>

true

<string>

tftp|ftp|scp

<string>

<string>

<string>

<string>

<string>

certificate not present

(none)

(none)

(none)

(none)

(none)

(none)

(none)

(none)

/SP/clients/
ldapssl/
cert/n

where n is 1-5

domain

 

<string>

 

(none)

 

/SP/clients/ntp/server/
[1|2]

address

<ipaddress>

(none)

/SP/clients/radius

defaultrole

address

port

secret

state

administrator|operator|a|u|c|r|o|s|none
<ipaddress>|none

<integer>

<string>|none

enable|disabled

operator


(none)

1812

(none)

disabled

/SP/clients/smtp

address

port

state

<ipaddress>

<integer>

enabled | disabled

IP address

25

enabled

/SP/clients/syslog[1|2]

address

<ipaddress>

IP address

/SP/config

dump_uri

load_uri

passphrase

tftp|ftp|sftp|scp|http|https

tftp|ftp|sftp|scp|http|https

<string>

(none)

(none)

(none)

/SP/diag

snapshot

(none)

(none)

/SP/network

commitpending

pendingipaddress

pendingdiscovery

pendingipgateway

pendingipnetmask

state

true

<ipaddress>|none

dhcp|static

<ipaddress>|none

<IP dotted decimal>

enabled | disabled

(none)

(none)

dhcp

(none)

10.8.255.255

enabled

/SP/network/ipv6

state

autoconfig

 

pending_static_ipaddress

commitpending

enabled | disabled

stateless | dhcpv6_stateless | dhcpv6_stateful | disable

<ipv6_address>

true

enabled

stateless

 

(none)

(none)

/SP/network/test

ping

ping6

<ipv4_address>

<ipv6_address>

(none)

(none)

/SP/preferences/banner

connect_message

login_message

login_message_acceptance

<string>

<string>

enabled | disabled

(none)

(none)

disabled

/SP/serial/external

commitpending

flowcontrol

pendingspeed

speed

true

none

<integer from list>

<integer from list>

(none)

(none)

9600

9600

/SP/serial/host

commitpending

pendingspeed

speed

true

<integer from list>

<integer from list>

(none)

9600

9600

/SP/

check_physical_presence

hostname

reset_to_defaults

system_contact

system_description

system_identifier

system_location

true|false

<string>

all|factory|none

<string>

<string>

<string>

<string>

(none)

(none)

(none)

(none)

(none)

(none)

(none)


Examples

-> set /SP/users/susan role=administrator
-> set /SP/clients/ldap state=enabled binddn=proxyuser bindpw=ez24get 

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

The -o|output option specifies the output and form of command output. ILOM only supports -o table, which displays targets and properties in tabular form.

The alias, show components, is a shortcut for the following CLI command:

-> show -o table -level all /SYS component state

The show components alias produces the same output as the above command. Thus, it enables you to restrict the table output to a single property below each target.

Syntax

show [options] [-display targets|properties|all] [-level value|all] target [propertyname]

Options

[-d|-display] [-l|level] [-o|output]

Targets and Properties


TABLE A-6 Targets and Properties for show Command

Valid Targets

Properties

/HOST/tpm

activate

enable

forceclear

/SYS

 

/SYS/DBP/HDDn

where n is a valid HDD slot

type

ipmi_name

fru_name

fru_manufacturer

fru_version

fru_serial_number

controller_id

disk_id

capacity

device_name

disk_type

wwn

raid_status

raid_ids

/STORAGE/raid/controller@od:00.0

where 00.0 is the ID for the controller

fru_manufacturer

fru_model

pci_vendor_id

pci_device_id

pci_subvendor_id

pci_subdevice_id

raid_levels

max_disks

max_raids

max_hot_spares

max_global_hot_spares

min_stripe_size

max_stripe_size

/STORAGE/raid/controller@od:00.0/
raid_id0

where 00.0 is the ID for the controller, and raid_id0 is the target RAID disk

level

status

disk_capacity

device_name

mounted

/STORAGE/raid/controller@od:00.0/
raid_id0/disk_id0

where 00.0 is the ID for the controller, and raid_id0 is the target RAID disk, and disk_id0 is the target disk

fru_manufacturer

fru_serial_number

fru_version

status

capacity

device_name

disk_type

wwn

raid_ids

system_drive_slot

/SP

 

/SP/alertmgmt/rules/
rulename
(rulename = 1 through 15)

community|username

destination

destination_port

event_class_filter

event_type_filter

level

snmp_version

type

/SP/cli

timeout

/SP/clients/
activedirectory

 

state

certfilestatus

defaultrole

getcertfile

address

logdetail

port

strictcertmode

timeout

/SP/clients/
activedirectory/
admingroups/n

where n is 1-5

name

/SP/clients/
activedirectory/
alternateservers/n

where n is 1-5

address

port

/SP/clients/
activedirectory/
alternateservers/n/cert

where n is 1-5

clear_action

issuer

load_uri

serial_number

subject

valid_from

valid_until

version

/SP/clients/
activedirectory/cert

certstatus

clear_action

issuer

load_uri

serial_number

subject

valid_from

valid_until

version

/SP/clients/
activedirectory/
customgroups/n

where n is 1-5

name

roles

/SP/clients/
activedirectory/
opergroups/n

where n is 1-5

name

 

/SP/clients/
activedirectory/
userdomains/n

where n is 1-5

domain

 

/SP/clients/dns

auto_dns

nameserver

searchpath

/SP/clients/ldap

binddn

bindpw

defaultrole

address

port

searchbase

state

/SP/clients/ldapssl

defaultrole

address

logdetail

port

optionalUserMapping

state

strictcertmode

timeout

/SP/clients/
ldapssl/
admingroups/n

where n is 1-5

name

 

/SP/clients/
ldapssl/
alternateservers/n

where n is 1-5

address

port

/SP/clients/
ldapssl/
alternateservers/n/cert

where n is 1-5

cert_status

clear_action

issuer

load_uri

serial_number

subject

valid_from

valid_until

version

/SP/clients/ldapssl/cert

certstatus

clear_action

issuer

load_uri

serial_number

subject

valid_from

valid_until

version

/SP/clients/
ldapssl/
customgroups/n

where n is 1-5

name

roles

/SP/clients/
ldapssl/
opergroups/n

where n is 1-5

name

 

/SP/clients/
ldapssl/
userdomains/n

where n is 1-5

domain

/SP/clients/ntp/server/[1|2]

address

/SP/clients/radius

address

port

secret

state

/SP/clients/smtp

port

state

/SP/clock

datetime

usentpserver

uptime

timezone

/SP/config

dump_uri

load_uri

passphrase

/SP/console

escapechars

/SP/console/history

line_count

pause_count

start_from

/SP/diag/snapshot

dataset

dump_uri

result

/SP/firmware

load_uri

/SP/logs/event

clear

/SP/network

commitpending

dhcp_server_ip

ipaddress

ipdiscovery

ipgateway

ipnetmask

macaddress

pendingipaddress

pendingdiscovery

pendingipgateway

pendingipnetmask

state

/SP/network/ipv6

state

autoconfig

dhcpv6_server_duid

link_local_ipaddress

static_ipaddress

ipgateway

pending_static_ipaddress

dynamic_ipaddress_1

/SP/network/test

ping

ping6

/SP/powermgmt

actual_power

permitted_power

available_power

/SP/preferences/banner

connect_message

login_message

login_message_acceptance

/SP/serial/external

flowcontrol

speed

/SP/serial/host

commitpending

pendingspeed

speed

/SP/services/http

port

secureredirect

servicestate

/SP/services/https

cert_status

servicestate

/SP/services/https/ssl

cert_status

/SP/services/https/ssl/default_cert

issuer

subject

valid_from

valid_until

/SP/services/https/ssl/custom_cert

clear_action

issuer

load_uri

subject

valid_from

valid_until

/SP/services/https/ssl/custom_key

key_present

load_uri

clear_action

/SP/services/ipmi

servicestate

/SP/services/kvms

mousemode

servicestate

/SP/services/servicetag

passphrase

product_urn

state

/SP/services/snmp

engineid

mibs

port

sets

v1

v2c

v3

servicestate

/SP/services/snmp/communities/private

permissions

/SP/services/snmp/communities/public

permissions

/SP/services/snmp/users/username

password

role

/SP/services/ssh

state

/SP/services/ssh/keys/dsa

fingerprint

length

privatekey

publickey

/SP/services/ssh/keys/rsa

fingerprint

length

privatekey

publickey

/SP/services/sso

state

/SP/sessions/sessionid

username

starttime

type

mode

/SP/users/username

role

password

/SP/users/username/ssh/keys/1

fingerprint

algorithm

load_uri

clear_action

embedded_comment

bit_length

/SP/users/username/service

service_password

service_password_expires

/SP/users/username/escalation

escalation_password

escalation_password_expires


Examples

-> show /SP/users/user1

-> show /SP/clients -level2

-> show components

start Command

Use the start command to turn on the target or to initiate a connection to the host console. Using the -script option eliminates the prompt for a yes or no confirmation and the command acts as if yes were specified.

Syntax

start [options] target

Options

[-h|help] [-script]

Targets


TABLE A-7 Targets for start Command

Valid Targets

Description

/SYS or /CH

Starts (powers on) the system or chassis.

/SP/console

Starts an interactive session to the console stream.


Examples

-> start /SP/console
-> start /SYS

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. The -f|force option specifies that the action will be performed immediately.

Syntax

stop [options] [-script] target

Options

[-f|force] [-h|help]

Targets


TABLE A-8 Targets for stop Command

Valid Targets

Description

/SYS or /CH

Perform an orderly shutdown, followed by a power off of the specified system or chassis. Use the -f|-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

version Command

Use the version command to display ILOM version information.

Syntax

version

Options

[-h|help]

Example


-> version
version SP firmware version: 3.0.0
SP firmware build number: 4415
SP firmware date: Mon Mar 28 10:39:46 EST 2008
SP filesystem version: 0.1.9