Sun Remote System Control (RSC) User's Guide

Chapter 5 Using the `rscadm` Utility

The rscadm utility and its subcommands allow administration of RSC from the host. You must log in to the server as root to use rscadm. Most rscadm subcommands are also available using the RSC command shell, but rscadm is convenient for:

Reconfiguring RSC when account passwords are unknown

Resetting RSC when it fails to respond

Backing up configuration data

Downloading RSC firmware

Synchronizing RSC date and time to the server's date and time.

The rscadm utility uses the following subcommands.

Table 5-1 rscadm Subcommands


Subcommand	Description
`help`	Displays a list of `rscadm` commands and brief descriptions for each
`date`	Displays or sets the current time and date
`set`	Sets a configuration variable
`show`	Displays one or more configuration variables
`resetrsc`	Resets RSC immediately
`download`	Downloads firmware to the RSC flash PROM
`send_event`	Logs an event; can also send an alert message
`modem_setup`	Changes configuration of the modem connected to the RSC serial port
`useradd`	Adds an RSC user account
`userdel`	Deletes an RSC user account
`usershow`	Shows characteristics of an RSC user account
`userpassword`	Sets or changes a user's password
`userperm`	Sets the authorization for a user

`rscadm` Subcommands

`help`

This subcommand prints out a basic Help message including a list of rscadm subcommands and a short description of each.

`date [-s] date [[mmdd]HHMM|mmddHHMM[cc]yy]][.SS]`

Use the date subcommand to show the current date and time; use the -s option to synchronize RSC time to the server time. Supply a date with the subcommand to set RSC time to a time other than the server time.

See "date [[mmdd]HHMM|mmddHHMM[cc]yy][.SS] " for a description of date formats.

`set` `variable value`

Use the set subcommand to set a RSC configuration variable. See "RSC Configuration Variables" for descriptions of these variables.

You can use the null string ("") to set a variable to null. To set a variable to a string that includes spaces or UNIX shell special characters, enclose the string in double quotes. For example:

# rscadm set page_info2 ""
# rscadm set page_init1 "&F &E0"

`show [variable]`

Use the show subcommand to display the value of one or more RSC configuration variables. If you do not specify a variable, RSC displays all configuration variables. See "RSC Configuration Variables" for descriptions of these variables.

`resetrsc [-s]`

This subcommand resets RSC immediately. To terminate all connections cleanly before the reset, use the -s option. If no argument is supplied, this subcommand performs a hard reset and drops all connections.

`download [boot]file`

This subcommand supports downloading new firmware residing in file into RSC. If you specify boot, the contents of file will be installed in the boot section of RSC non-volatile memory. If you do not specify boot, the contents of file will be installed in the main firmware section of RSC non-volatile memory.

When the transfer completes, RSC resets itself. If the host keyswitch is in the Lock position, you cannot update RSC firmware, and an error message displays.

`send_event [-c]message`

Use this subcommand to enter an event into the RSC event log. Use the -c option to also send an alert message that RSC forwards according to the alert configuration. The message is an ASCII string of no more than 80 characters. To use a string that includes spaces or UNIX shell special characters, enclose the string in double quotes.

See Appendix C, Creating a Script That Sends an Alert Message or RSC Event for an example of a Perl script that uses this subcommand to send an alert.

`modem_setup`

Use this subcommand to change configuration of the modem connected to the RSC serial port. If the modem is properly connected, you can enter standard AT commands and see responses from the modem. At the beginning of a line, enter the escape character (~) followed by a period to exit from this subcommand. Example:

# rscadm modem_setup
AT <enter>
OK
~.
#

The escape sequence for rscadm modem_setup is always ~. The RSC console has a configurable exit character, but the escape character for rscadm modem_setup is hard-coded.

User Account Administration Subcommands

To administer user accounts from the host using rscadm, log in to the host as root and use the rscadm utility with the following subcommands:

useradd (see "useradd username")

userdel (see "userdel username")

usershow (see "usershow [username] ")

userpassword (see "userpassword username")

usserperm (see "userperm username [c][u][a][r]")

`rscadm` Error Messages

This section offers further explanation of error messages received from the rscadm utility. The last 12 messages are usage error messages.

Passwords didn't match, try again

During execution of the userpassword subcommand, you enter the password twice. If passwords do not match, you are prompted to enter again.

rscadm: all user slots are full

This error occurs if you try to add a user account when RSC already has four accounts configured; RSC supports only four user accounts. You must delete an account before you can add another.

rscadm: command line too long

Check for an extremely long command line.

rscadm: command unknown

You used an invalid rscadm subcommand.

rscadm: could not connect to modem

During execution of the modem_setup subcommand, RSC could not connect to the RSC modem. Is the modem connected? Perhaps the modem is currently being used by the paging subsystem, or RSC is connected to another modem.

rscadm: could not disconnect from modem

During execution of the modem_setup subcommand, RSC refused to disconnect from the modem.

rscadm: could not read date from RSC

An undefined error in RSC firmware occurred when trying to get the RSC date.

rscadm: could not send alert

During execution of the send_event subcommand, RSC firmware couldn't send event.

rscadm: could not set date on RSC

RSC detected an internal error while trying to set the date.

rscadm: couldn't add user

RSC encountered an internal error when trying to add a user account. The RSC SEEPROM may be faulty.

rscadm: couldn't change password

RSC encountered an internal error when trying to change a user password. The RSC SEEPROM may be faulty.

rscadm: couldn't change permissions

RSC encountered an internal error when trying to change user permissions. The RSC SEEPROM may be faulty.

rscadm: couldn't create thread

During execution of the modem_setup subcommand, a thread create call failed.

rscadm: couldn't delete user

RSC encountered an internal error when trying to delete a user account. The RSC SEEPROM may be faulty.

rscadm: couldn't get information on user

RSC encountered an internal error when trying to access user information during a usershow subcommand. The RSC SEEPROM may be faulty.

rscadm: download failed, RSC reported erase error