Sun Advanced Lights Out Manager (ALOM) 1.6 Administration Guide

This chapter introduces the System Controller Administration (scadm) utility, and shows how to use it in managing the system. The chapter consists of:

• Overview of the scadm Utility
• To Get Started With the scadm Utility
• To Set Your Path to the scadm Utility
• List of scadm Commands
• Descriptions of scadm Commands

---

Overview of the scadm Utility

The System Controller Administration (scadm) utility, which is part of the Solaris Operating System, enables you to perform many ALOM tasks while logged in to the host server.

The scadm commands control several functions, and some allow you to view or set ALOM environment variables. See List of scadm Commands for an overview of the commands, and Using ALOM Configuration Variables for an explanation of configuration variables.

You must be logged in to the host as superuser before you can use the scadm utility.

The scadm utility sends its output to stdout. You can use scadm in scripts to manage and configure ALOM from the host system. See Creating a Script to Send Alerts From ALOM.

For more information about the scadm utility, refer to the scadm man page. Type man scadm at the system prompt. The man page for scadm comes with your version of the Solaris Operating System.

1. Set your path to the scadm utility.

See To Set Your Path to the scadm Utility.

2. Log in to the host system as superuser.

3. Type scadm at the superuser prompt, and then type the command you want to use.

See List of scadm Commands

Related Information

List of scadm Commands

To set your path to the scadm utility, perform these two steps:

1. Find out the proper platform name for your system.

See To Find Your System's Platform Name.

2. Set the path to scadm on your system.

Refer to your Solaris Operating System documentation for more information about how to set the path. The procedure differs depending on which command shell you are using in the Solaris Operating System, as well as which file you want to use to contain path information.

The scadm utility resides in the following directory:

/usr/platform/platform-name/sbin 

Where platform-name is the platform name for your system.

At the system prompt, type uname -i.

The system returns a result similar to the following:

% uname -i 

SUNW,servermodel

Where servermodel is the your server model. The default installation directory for the ALOM software will be in the following directory:

/usr/platform/SUNW,servermodel/sbin

Where servermodel is the your server model.

For example, if your server model is a Sun Fire V440 server, you would see the following output from the uname -i command:

% uname -i 

SUNW,Sun-Fire-V440

and the default installation directory for the ALOM software would be in:

/usr/platform/SUNW,Sun-Fire-V440/sbin

Related Information

• To Get Started With the scadm Utility
• List of scadm Commands
• scadm Error Messages

---

List of scadm Commands

The scadm commands provide equivalent functionality to that of the ALOM commands.

Summary of scadm Commands

The following list describes the commands for the scadm utility.

Make sure that you have set your path to the scadm utility and have logged in to the host system as superuser; or use the cd command to move to the /usr/platform/platform/sbin directory, where platform is the platform name for your host server. See To Set Your Path to the scadm Utility to set your path and find out the platform name of your server.

To use a command, type the following at the host system's superuser prompt. Substitute the command you want to use for command.

# scadm command 

Related Information

scadm Error Messages

---

Descriptions of scadm Commands

scadm consolehistory

Use the scadm consolehistory command to display the SC's console log. The SC maintains a running log which captures all console output. This log is maintained as a first-in, first-out buffer. New console output may displace old console output if the buffer is full. By default, only the last eight kilobytes of the console log file are displayed.

1. Log in to the host server as superuser.

2. Do one of the following:

• To display the last eight kilobytes of the SC's console log, type the following command:


# scadm consolehistory

• To display all the entries in the SC's console log, type the following command:


# scadm consolehistory -a

Related Information

• List of scadm Commands
• scadm Error Messages

scadm date

Use the scadm date command to show the ALOM date and time. This command works like the ALOM shell command showdate.

1. Log in to the host server as superuser.

2. At the system's superuser prompt, type the following command:

# scadm date

As an example of output:

# scadm date 

MON SEP 16 21:45:00 2002 UTC

The date command shows values in the mmddHHMMccyy.SS format as described below.

Related Information

• List of scadm Commands
• scadm Error Messages

scadm download

Use the download command to program the ALOM firmware. This command works like the ALOM shell command flashupdate. See flashupdate for more on that command.

You can find the links to the download sites on the ALOM product page at:

http://www.sun.com/servers/alom.html

Caution - Do not use thescadm resetrsccommand while a firmware update is in progress. If you must reset ALOM manually, wait until after the update is complete. Otherwise, you could corrupt the ALOM firmware and render it unusable.

1. Log in to the host server as superuser.

2. Do one of the following:

• For Sun Fire V215, V245, and V445 servers, type the following command to download the image:


# scadm download /usr/platform/platform-name/lib/images/alomfw

Where platform-name is the platform name for your host server.

• For all other servers, do the following:

a. To download the ALOM main image, type the following command:

# scadm download /usr/platform/platform-name/lib/images/alommainfw 

Where platform-name is the platform name for your host server.

b. To download the boot monitor image, type the following command:

# scadm download boot /usr/platform/platform-name/lib/images/alombootfw

Where platform-name is the platform name for your host server.

See To Set Your Path to the scadm Utility to set your path and find out the platform name of your server.

Command Option

The download command uses one option: boot.

This option directs the download command to program the boot monitor with the downloaded file you specify.

Related Information

• List of scadm Commands
• scadm Error Messages

scadm fruhistory

Use the scadm fruhistory command to display the most recent entries in the field-replaceable unit (FRU) log maintained by the SC. The optional -a argument causes the entire FRU log history to be displayed. This command is similar to the ALOM shell command showfru.

1. Log in to the host server as superuser.

2. Do one of the following:

• To display the most recent entries in the FRU log, type the following command:


# scadm fruhistory

• To display all the entries in the FRU log, type the following command:


# scadm fruhistory -a

Related Information

• List of scadm Commands
• scadm Error Messages

scadm help

Use the help command to list the available commands for the scadm utility and shows their syntax.

1. Log in to the host server as superuser.

2. At the system's superuser prompt, type the following command:

# scadm help 

For example:

# scadm help 

USAGE: scadm <command> [options] 

   For a list of commands, type "scadm help" 

scadm- COMMANDS SUPPORTED 

   help, date, set, show, resetrsc, download, send_event, modem_setup,

   useradd, userdel, usershow, userpassword, userperm, shownetwork, 

   consolehistory, fruhistory, loghistory, version

SCADM - COMMAND DETAILS 

   scadm help => this message 

   scadm date [-s] | [[mmdd]HHMM | mmddHHMM[cc]yy] [.SS] => print or set date 

   scadm set <variable> <value> => set variable to value 

   scadm show [variable] => show variable(s)

   scadm resetrsc [-s] => reset SC (-s soft reset) 

   scadm download [boot] <file> => program firmware or [boot] monitor 

   scadm send_event [-c] "message" => send message as event (-c CRITICAL) 

   scadm modem_setup => connect to modem port 

   scadm useradd <username> => add SC user account 

   scadm userdel <username> => delete SC user account 

   scadm usershow [username] =>show user details 

   scadm userpassword <username> => set user password 

   scadm userperm <username> [cuar] => set user permissions 

   scadm shownetwork => show network configuration 

   scadm consolehistory [-a] => show SC console log

   scadm fruhistory [-a] => show SC FRU log

   scadm loghistory [-a] => show SC event log 

   scadm version [-v] => show SC version (-v verbose)

#

Related Information

• List of scadm Commands
• scadm Error Messages

scadm loghistory

Use the scadm loghistory command to display the most recent entries in the ALOM event buffer. These events include server reset events and all ALOM or scadm commands that change the state of the system (such as reset, poweroff, and poweron in the ALOM command shell). This command is similar to the ALOM shell command showlogs. Each event recorded in the log has the following format:

date time errorcode: message

Where date time is the date and time at which the event occurred, as recorded by ALOM, errorcode is the code for the logged event, and message is a short description of the event.

The optional -a argument causes the entire SC event log history to be displayed. The -a argument is available only on the Sun Fire V215, V225, and V445 servers running the Solaris 10 6/06 OS.

1. Log in to the host server as superuser.

2. Do one of the following:

• For Sun Fire V215, V225, and V445 servers running the Solaris 10 6/06 OS, at the superuser prompt, type the following command to display all the entries in the SC event log:


# scadm loghistory -a

• For all servers, at the superuser prompt, type the following command to display the most recent entries in the SC event log:


# scadm loghistory

The following example shows an event log entry:

MAR 08 13:41:21 wgs-48-49: 00060000: "SC Login: User admin Logged on." 

Related Information

• List of scadm Commands
• scadm Error Messages

scadm modem_setup

The scadm modem_setup command is not supported on the Netra 240, Netra 440, Sun Fire V210, Sun Fire V240, Sun Fire V250, or Sun Fire V440 servers. For information about how to set up an external modem to support incoming transactions, see the description of the if_modem variable (see if_modem).

Related Information

• List of scadm Commands
• scadm Error Messages

scadm resetrsc

Use the scadm resetrsc command to reset ALOM. This command works like the ALOM shell command resetsc. See resetsc for more information on that command.

Caution - Do not use the scadmresetrsccommand while a firmware update (scadmdownloador flashupdate) is in progress. If you must reset ALOM, wait until after the update is complete. Otherwise, you could corrupt the ALOM firmware and render it unusable. Seescadm downloadand flashupdatefor more information.

1. Log in to the host server as superuser.

2. At the superuser prompt, type the following command:

# scadm resetrsc option

Where option is -s, if desired.

This command causes ALOM to reset immediately.

After you reset ALOM, the serial connection times out at the login prompt after one minute and takes the console write lock automatically if no one else has it by then. The username field shows auto in the showusers command output entry for the serial interface. For example:

sc> showusers

username  connection  login time      client IP addr   console

--------------------------------------------------------------

auto      serial      Apr 14 10:30                     system

The word system under console means that the connection has the console write lock.

If you use the console -f command after resetting ALOM and the serial connection times out, you receive this message:

sc> console -f

Warning: User <auto> currently has write permission to this console and forcibly removing them will terminate any current write actions and all work will be lost. Would you like to continue? [y/n]y

3. Type y for yes, if you want to obtain the console write lock.

See console, resetsc, and showusers for more information.

Command Option

The resetrsc command uses one option: -s.

This option causes a soft reset to occur. If you type scadm resetrsc without using the -s option, a hard reset occurs.

Related Information

• List of scadm Commands
• scadm Error Messages

scadm send_event

All events recorded in the ALOM event log can be sent as email alerts.

Use the scadm send_event command to send the events to the following destinations:

• Email--You can send alerts to email addresses that you configure using the mgt_mailalert configuration variable. See mgt_mailalert for more information.
• The server's syslog--You set up this option using the sys_eventlevel configuration variable. See sys_eventlevel.
• All users currently logged in to ALOM--You configure this option using the sc_clieventlevel configuration variable. See sc_clieventlevel.

1. Log in to the host server as superuser.

2. At the superuser prompt, type the following command:

# scadm send_event "message" 

Where message is your customized message.

For example:

Using the -c option sends a critical event:

# scadm send_event -c "Restarting the server at 4:00 PM" 

Using the send_event without the -c option sends a major event:

# scadm send_event "TEST" 

Related Information

• List of scadm Commands
• scadm Error Messages
• Sending Customized Alerts

scadm set

Use the scadm set command to set an ALOM configuration variable to the desired value. This command works like the ALOM shell command setsc. See Overview of the ALOM Command Shell for more information.

1. Log in to the host server as superuser.

2. At the superuser prompt, type the following command:

# scadm set variable value

Where variable is the name of the variable you want to set, and value is its value.

For example:

# scadm set netsc_ipaddr 123.123.123.123 

Note that the set command accepts only two parameters: a variable and one value string. If the value string that you want to set in the variable contains more than one word, enclose the entire value string in quotation marks. For example:

# scadm set mgt_mailalert "dgd@central 3"

Related Information

• List of scadm Commands
• scadm Error Messages

scadm show

Use the scadm show command to view the value for the specified ALOM configuration variable. This command works like the ALOM shell command showsc. See Overview of the ALOM Command Shell for more information on that command.

1. Log in to the host server as superuser.

2. At the superuser prompt, type the following command:

# scadm show variable 

Where variable is the name of the variable.

For example:

# scadm show netsc_ipaddr 

xxx.xxx.xxx.xxx 

Typing scadm show with no variables displays the values for all variables.

# scadm show 

if_network="true" 

if_modem="false" 

if_emailalerts="false" 

sys_autorestart="xir" 

sys_xirtimeout="900" 

netsc_tpelinktest="true" 

netsc_dhcp="false" 

netsc_ipaddr="129.148.40.233" 

netsc_ipnetmask="255.255.255.0" 

netsc_ipgateway="129.148.40.254" 

mgt_mailhost="" 

mgt_mailalert=""

sc_customerinfo="" 

sc_escapechars="#." 

sc_powerondelay="true" 

sc_powerstatememory="false" 

sc_clipasswdecho="true" 

sc_cliprompt="sc" 

sc_clitimeout="0" 

sc_clieventlevel="2" 

sc_backupuserdata="true" 

sys_eventlevel="2"

Related Information

• List of scadm Commands
• scadm Error Messages

scadm shownetwork

Use the scadm shownetwork command to display the current network configuration. This command is similar to the ALOM shell command shownetwork. See shownetwork for more on that command.

The command output appears similar to the following example, with the actual IP addresses, netmask, and Ethernet addresses in your network configuration in place of XXX.XXX.XXX.XXX.

1. Log in to the host server as superuser.

2. At the superuser prompt, type the following command:

# scadm shownetwork 

SC network configuration is: 

IP address: XXX.XXX.XXX.XXX 

Gateway Address: XXX.XXX.XXX.XXX 

Netmask: XXX.XXX.XXX.XXX 

Ethernet Address: XX:XX:XX:XX:XX:XX

Related Information

• List of scadm Commands
• scadm Error Messages

scadm useradd

Use the scadm useradd command to add a user account to ALOM. This command is similar to the ALOM shell command useradd. See useradd for more on that command.

You can add a maximum of 15 unique user accounts to ALOM.

1. Log in to the host server as superuser.

2. At the superuser prompt, type the following command:

# scadm useradd username 

Where username is the name of the user you want to add. The username variable has the following restrictions:

• Valid characters are alphabetic (letter) and numeric characters, period (.), underscore (_), and hyphen (-).
• Maximum length is 16 characters, at least one of which must be a lowercase alphabetic character.
• First character must be alphabetic.

To assign a password to a user name, use the scadm userpassword command. See scadm userpassword.

To set permission levels for a user name, use the scadm userperm command. See scadm userperm.

Related Information

• List of scadm Commands
• scadm Error Messages

scadm userdel

Use the scadm userdel command to delete a user account from ALOM. This command is similar to the ALOM shell command userdel. See userdel for more on that command.

1. Log in to the host server as superuser.

2. At the superuser prompt, type the following command:

# scadm userdel username

Where username is the name of the user you want to delete.

Related Information

• List of scadm Commands
• scadm Error Messages

scadm userpassword

Use the scadm userpassword command to set or change the password for the specified user account. This command is similar to the ALOM shell command userpassword. See userpassword for more on that command.

1. Log in to the host server as superuser.

2. At the superuser prompt, type the following command:

# scadm userpassword username 

Where username is the name of the user for whom you want to set or change the password.

This command does not prompt you for the existing password.

For example:

# scadm userpassword msmith 

New password: 

Re-enter new password: 

Password Restrictions

Passwords have the following restrictions:

• They can contain at least six to eight characters.
• They must contain at least two alphabetic characters (uppercase or lowercase letter) and at least one numeric or special character. Alphabetic characters can be both uppercase and lowercase.
• They must differ from your login name and any reverse or circular shift of your login name. For comparison purposes, uppercase and lowercase letters are equivalent.
• The new password must differ from the old by at least three characters. For comparison purposes, uppercase and lowercase letters are equivalent.

Related Information

• List of scadm Commands
• scadm Error Messages

scadm userperm

Use the userperm command to set or change permission levels for a specified user account. This command is similar to the ALOM shell command userperm. See userperm for more information.

Permission Levels

All users can read ALOM information, but you need authorization to perform ALOM functions or change settings. There are four permission levels that increase a user's authorization.

If you do not assign a permission level to the specified user (that is, you assigned zero permission levels), then that user has read-only permission. This is the default level for a new ALOM user account.

To see a user's permission levels, use the usershow command. See scadm usershow.

1. Log in to the host server as superuser.

2. At the superuser prompt, type the following command:

# scadm userperm username perms 

Where username is the specified user account and perms is the permission level(s) you want to set or change (if any).

For example, to assign c and r user permissions to user msmith, you would type the following from the system superuser prompt:

# scadm userperm msmith cr

Related Information

• List of scadm Commands
• scadm Error Messages

scadm usershow

The scadm usershow command shows a specified user's ALOM account, along with each user's permissions and whether a password has been assigned. See scadm userperm, and scadm userpassword for more on permissions and passwords. To see this information for a particular user, type the desired user name after the usershow command. If you do not enter any user names, usershow displays all of the accounts. This command is similar to the ALOM shell command usershow. See usershow for more on that command.

1. Log in to the host server as superuser.

2. To see the information for one user, type the following command at the superuser prompt:

# scadm usershow username

Where username is the name of the specified user whose information you want to show, if desired. If you do not any user names, usershow displays all of the accounts.

For example:

#scadm usershow

Username      Permissions      Password? 

---------------------------------------- 

admin          cuar             Assigned

wwilson        cuar             Assigned

jadams         --cr             None

#scadm usershow wwilson

Username      Permissions      Password? 

----------------------------------------

wwilson        cuar             Assigned

Related Information

• List of scadm Commands
• scadm Error Messages

scadm version

Use the scadm version command to display ALOM version information.

1. Log in to the host server as superuser.

2. At the superuser prompt, type the following command:

# scadm version option

Where option is -v, if desired.

For example:

# scadm version

SC Version v1.4

SC Bootmon Version:  v1.4.0

SC Firmware Version:  v1.4.0

# scadm version -v

SC Version v1.4

SC Bootmon Version:  v1.4.0

SC Bootmon checksum: DE232BFF

SC Firmware Version:  v1.4.0

SC Build Release: 06

SC firmware checksum: EAC2EF86

SC firmware built: Feb 23 2006, 15:17:59

SC System Memory Size 8MB

SC NVRAM Version = a

Related Information

• List of scadm Commands
• scadm Error Messages

Sun Advanced Lights Out Manager (ALOM) 1.6 Administration Guide

819-2445-11

Copyright © 2006, Sun Microsystems, Inc. All Rights Reserved.