1scadm(1M) System Administration Commands scadm(1M)
2
6 scadm - administer System Controller (SC)
7
9 /usr/platform/platform-name/sbin/scadm subcommand [option]
10 [argument]...
11
14 The scadm utility administers the System Controller (SC). This utility
15 allows the host server to interact with the SC.
16 The scadm utility must be run as root.
19 The interface, output, and location in the directory hierarchy for
22 scadm are uncommitted and might change.
23 platform-name is the name of the platform implementation. Use the uname
26 -i command to identify the platform implementation. See uname(1).
27 The scadm utility has a number of subcommands. Some subcommands have
30 specific options and arguments associated with them. See SUBCOMMANDS,
31 OPTIONS, OPERANDS, and USAGE.
32 SUBCOMMANDS
34 Subcommands immediately follow the scadm command on the command line,
35 and are separated from the command by a SPACE.
36 The following subcommands are supported
39 consolehistory
41 Display the SC's console log. The SC maintains a running log which
43 captures all console output. This log is maintained as a first-in,
44 first-out buffer: New console output may displace old console out‐
45 put if the buffer is full. By default, only the last eight kilo‐
46 bytes of the console log file are displayed.
47 The optional -a argument specifies that the entire console log file
49 be displayed.
50 It is possible for the SC to fill this log more quickly than the
52 consolehistory subcommand can read it. This means that it is possi‐
53 ble for some log data to be lost before it can be displayed. If
54 this happens, the consolehistory subcommand displays "scadm: lost
55 <number> bytes of console log data" in the log output, to indicate
56 that some data was lost.
57 The format for the consolehistory subcommand is:
59 scadm consolehistory [-a]
61 The consolehistory subcommand is not available on all platforms. If
64 this command is used on a platform that does not support it, scadm
65 prints this message:
66 scadm: command/option not supported
68 and exit with non-zero status.
71 date
74 Display the SC's time and date
76 The format for the date subcommand is:
78 scadm date
80 download
85 Program the SC's firmware.
87 There are two parts to the firmware, the boot monitor and the main
89 image.
90 By default, The scadm command's download programs the main firmware
92 image. The boot argument selects programming of the boot monitor.
93 The format for the download subcommand is:
95 scadm download [boot] file
97 fruhistory
102 Display the contents of the "field replacable unit" log maintained
104 by the SC. By default, only the last eight kilobytes of the fru
105 history log file are displayed. The data in contained this log con‐
106 tains snapshots of the SC's "showfru" command, taken whenever the
107 system is reset, or a hot-plug event is detected by the SC.
108 The optional -a argument specifies that the entire fru log file be
110 displayed.
111 It is possible for the SC to fill this log more quickly than the
113 fruhistory subcommand can read it. This means that it is possible
114 for some log data to be lost before it can be displayed. If this
115 happens, the fruhistory subcommand displays "scadm: lost <number>
116 bytes of fru log data" in the log output, to indicate that some
117 data was lost.
118 The format for the fruhistory subcommand is:
120 scadm fruhistory [-a]
122 The fruhistory subcommand is not available on all platforms. If
125 this command is used on a platform which does not support it, scadm
126 prints this message:
127 scadm: command/option not supported
129 and exit with non-zero status.
132 help
135 Display a list of commands.
137 The format for the help subcommand is:
139 scadm help
141 loghistory
146 Display the most recent entries in the SC event log. The optional
148 -a argument causes the entire event log history to be displayed.
149 The -a argument is available only on platforms which support large
150 log files. On platforms which do not support large log files, this
151 flag has no additional effect.
152 It is possible for the SC to fill this log more quickly than the
154 loghistory subcommand can read it. This means that it is possible
155 for some log data to be lost before it can be displayed. If this
156 happens, the loghistory subcommand displays "scadm: lost <number>
157 events" in the log output, to indicate that some data was lost.
158 The format for the loghistory subcommand is:
160 scadm loghistory [-a]
162 resetrsc
167 Reset the SC. There are two types of resets allowed, a hard reset
169 and a soft reset.The hard reset is done by default. The soft reset
170 can be selected by using the -s option.
171 The format for the resetrsc subcommand is:
173 scadm resetrsc [-s]
175 send_event
180 Manually send a text based event. The SC can forward the event to
182 the SC event log. You can configure the -c option to send a criti‐
183 cal warning to email, alert to logged in SC users, and syslog.
184 Critical events are logged to syslog(3C). There is an 80 character
185 limit to the length of the associated text message.
186 The format for the send_event subcommand is:
188 scadm send_event [-c] "message"
190 set
195 Set SC configuration variables to a value.
197 Examples of SC configuration variables include: SC IP address
199 netsc_ipaddr and SC Customer Information sc_customerinfo. See the
200 output from the scadm help command for a complete list of SC con‐
201 figuration variables.
202 The format for the set subcommand is:
204 scadm set variable value
206 show
211 Display the current SC configuration variable settings. If no vari‐
213 able is specified, scadm shows all variable settings.
214 The format for the show subcommand is:
216 scadm show [variable]
218 shownetwork
223 Display the current network configuration parameters for SC.
225 The format for the shownetwork subcommand is:
227 scadm shownetwork
229 useradd
234 Add user accounts to the SC. The SC supports up to sixteen separate
236 users.
237 The format for the useradd subcommand is:
239 scadm useradd username
241 userdel
246 Delete a user account from SC.
248 The format for the userdel subcommand is:
250 scadm userdel username
252 userpassword
257 Set a password for the user account specified. This password over‐
259 rides any existing password currently set. There is no verification
260 of the old password before setting the new password.
261 The format for the userpassword subcommand is:
263 scadm userpassword username
265 userperm
270 Set the permission level for the user.
272 The format for the userperm subcommand is:
274 scadm userperm username [aucr]
276 usershow
281 Display details on the specified user account. If a username is not
283 specified, all user accounts are displayed.
284 The format for the usershow subcommand is:
286 scadm usershow username
288 version
293 Display the version numbers of the SC and its components.
295 The format for the version subcommand is:
297 scadm version [-v]
299
304 The resetrsc, send_event, and version subcommands have associated
305 options. Options follow subcommands on the command line and are sepa‐
306 rated from the subcommand by a SPACE.
307 The resetrsc subcommand supports the following options:
310 -s
312 Perform a soft reset instead of a hard reset. A hard reset physi‐
314 cally resets the SC hardware. The SC software jumps to the boot
315 firmware, simulating a reset, for a soft reset.
316 The send_event subcommand supports the following options:
320 -c
322 Send a critical event. Without the -c, -send_event sends a warning.
324 The version subcommand supports the following options:
328 -v
330 Display a verbose output of version numbers and associated informa‐
332 tion.
333 The consolehistory, fruhistory, and loghistory subcommands support the
337 following option:
338 -a
340 Display the entire log. These subcommands normally display only the
342 most recent log data. This flag causes them to display the entire
343 log.
344
347 The download, send_event, set, show, useradd, userdel, userperm, user‐
348 show, userpassword, and userperm subcommands have associated arguments
349 (operands).
350 If the subcommand has an option, the arguments follow the option on the
353 command line and is separated from the option by a SPACE. If the sub‐
354 command does not have an option, the arguments follow the subcommand on
355 the command line and are separated from the subcommand by a SPACE. If
356 there are more than one arguments, they are separated from each other
357 by a SPACE.
358 The download subcommand supports the following arguments:
361 boot
363 Program the boot monitor portion of the flash. The main portion of
365 the flash is programmed without any arguments
366 file
369 Specify file as the path to where the boot or main firmware image
371 resides for download.
372 Examples of file are:
374 /usr/platform/platform_type/lib/image/alommainfw
376 or
379 /usr/platform/platform_type/lib/image/alombootfw
381 The send_event subcommand supports the following arguments:
387 "message"
389 Describe event using the test contained in message. Enclose message
391 in quotation marks.
392 The set subcommand supports the following arguments:
396 variable
398 Set SC configuration variable.
400 value
403 Set SC configuration variable to value.
405 The show subcommand supports the following arguments:
409 variable
411 Display the value of that particular variable.
413 The useradd subcommand supports the following arguments:
417 username
419 Add new SC account username.
421 The userdel subcommand supports the following arguments:
425 username
427 Remove SC account username.
429 The userperm subcommand supports the following arguments:
433 -aucr
435 Set permissions for SC user accounts. If no permissions are speci‐
437 fied, all four permissions are disabled and read only access is
438 assigned.
439 The following are the definitions for permissions:
441 a
443 Allow user to administer or change the SC configuration vari‐
445 ables
446 u
449 Allow user to use the user commands to modify SC accounts
451 c
454 Allow user to connect to console.
456 r
459 Allow user to reset SC and to power on and off the host.
461 username
465 Change permissions on SC account username.
467 The -usershow subcommand supports the following arguments:
471 username
473 Display information on SC account username. If usernameis not spec‐
475 ified, all accounts are displayed.
476 The userpassword subcommand supports the following arguments:
480 username
482 Set SC password for username.
484 The userperm subcommand supports the following arguments:
488 username
490 Change SC permissions for username.
492
495 Example 1 Displaying the SC's Date and Time
496 The following command displays the SC's date and time.
499 scadm date
502 Example 2 Setting the SC's Configuration Variables
506 The following command sets the SC's configuration variable netsc_ipaddr
509 to 192.168.1.2:
510 scadm set netsc_ipaddr 192.168.1.2
513 Example 3 Displaying the Current SC's Configuration Settings:
517 The following command displays the current SC configuration settings:
520 scadm show
523 Example 4 Displaying the Current Settings for a Variable
527 The following command displays the current settings for the sys_host‐
530 name variable:
531 scadm show sys_hostname
534 Example 5 Sending a Text-Based Critical Event
538 The following command sends a critical event to the SC logs, alerts the
541 current SC users, and sends an event to syslog(3C):
542 scadm send_event -c "The UPS signaled a loss in power"
545 Example 6 Sending an Informational Text-Based Event
549 The following command sends an non-critical informational text based
552 event to the SC event log:
553 scadm send_event "The disk is close to full capacity"
556 Example 7 Adding a User To the SC
560 The following command adds user rscroot to the SC:
563 scadm useradd rscroot
566 Example 8 Deleting a User From the SC
570 The following command deletes user olduser from the SC:
573 scadm userdel olduser
576 Example 9 Displaying User Details
580 The following command displays details of all user accounts:
583 scadm usershow
586 Example 10 Displaying Details for a Specific User
590 The following command displays details of user account rscroot:
593 scadm usershow rscroot
596 Example 11 Setting the User Permission Level
600 The following command sets the full permission level for user rscroot
603 to aucr:
604 scadm userperm rscroot aucr
607 Example 12 Setting the User Permission Level
611 The following command sets only console access for user newuser to c:
614 scadm userperm newuser c
617 Example 13 Setting the User Permission Level
621 The following command sets the permission level for user newuser to
624 read only access:
625 scadm userperm newuser
628 Example 14 Displaying the Current Network Parameters
632 The following command displays the current network configuation parame‐
635 ters for the SC:
636 scadm shownetwork
639 Example 15 Viewing the Consolehistory
643 The following command displays the content console in the SC event log:
646 scadm consolehistory [-a]
649 Example 16 Viewing the Fruhistory
653 The following command displays the content of the "field replacable
656 unit" in the SC event log:
657 scadm fruhistory [-a]
660 Example 17 Viewing the Loghistory
664 The following command displays the most recent entries in the SC event
667 log:
668 scadm loghistory [-a]
671 Example 18 Displaying Verbose Information
675 The following command displays verbose version information on the SC
678 and its components:
679 scadm version -v
682
686 The following exit values are returned:
687 0
689 Successful completion.
691 non-zero
694 An error occurred.
696
699 See attributes(5) for descriptions of the following attributes:
700 ┌─────────────────────────────┬─────────────────────────────┐
705 │ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
706 ├─────────────────────────────┼─────────────────────────────┤
707 │Availability │SUNWkvm │
708 ├─────────────────────────────┼─────────────────────────────┤
709 │Interface Stability │Evolving │
710 └─────────────────────────────┴─────────────────────────────┘
711
713 uname(1), syslog(3C), attributes(5)
714SunOS 5.11 20 Dec 2005 scadm(1M)