293 useradd/del/mod should be ZFS-aware
[illumos-gate.git] / usr / src / man / man1m / scadm.1m
blob12f130839a49ee626d0db63b37924e1c90a9b2e0
1 '\" te
2 .\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH SCADM 1M "Dec 20, 2005"
7 .SH NAME
8 scadm \- administer System Controller (SC)
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fB/usr/platform/\fIplatform-name\fR/sbin/scadm\fR \fIsubcommand\fR [\fIoption\fR]
13      [\fIargument\fR]...
14 .fi
16 .SH DESCRIPTION
17 .sp
18 .LP
19 The \fBscadm\fR utility administers the System Controller (\fBSC\fR). This
20 utility allows the host server to interact with the \fBSC\fR.
21 .sp
22 .LP
23 The \fBscadm\fR utility \fBmust\fR be run as root.
24 .sp
25 .LP
26 The interface, output, and location in the directory hierarchy for \fBscadm\fR
27 are uncommitted and might change.
28 .sp
29 .LP
30 \fIplatform-name\fR is the name of the platform implementation. Use the
31 \fBuname\fR \fB-i\fR command to identify the platform implementation. See
32 \fBuname\fR(1).
33 .sp
34 .LP
35 The \fBscadm\fR utility has a number of subcommands. Some subcommands have
36 specific options and arguments associated with them. See \fBSUBCOMMANDS\fR,
37 \fBOPTIONS\fR, \fBOPERANDS\fR, and \fBUSAGE\fR.
38 .SS "SUBCOMMANDS"
39 .sp
40 .LP
41 Subcommands immediately follow the \fBscadm\fR command on the command line, and
42 are separated from the command by a SPACE.
43 .sp
44 .LP
45 The following subcommands are supported
46 .sp
47 .ne 2
48 .na
49 \fBconsolehistory\fR
50 .ad
51 .sp .6
52 .RS 4n
53 Display the \fBSC\fR's console log. The \fBSC\fR maintains a running log which
54 captures all console output. This log is maintained as a first-in, first-out
55 buffer: New console output may displace old console output if the buffer is
56 full. By default, only the last eight kilobytes of the console log file are
57 displayed.
58 .sp
59 The optional \fB-a\fR argument specifies that the entire console log file be
60 displayed.
61 .sp
62 It is possible for the \fBSC\fR to fill this log more quickly than the
63 \fBconsolehistory\fR subcommand can read it. This means that it is possible for
64 some log data to be lost before it can be displayed. If this happens, the
65 \fBconsolehistory\fR subcommand displays "scadm: lost <number> bytes of console
66 log data" in the log output, to indicate that some data was lost.
67 .sp
68 The format for the \fBconsolehistory\fR subcommand is:
69 .sp
70 .in +2
71 .nf
72 scadm consolehistory [-a]
73 .fi
74 .in -2
75 .sp
77 The \fBconsolehistory\fR subcommand is not available on all platforms. If this
78 command is used on a platform that does not support it, \fBscadm\fR prints this
79 message:
80 .sp
81 .in +2
82 .nf
83 scadm: command/option not supported
84 .fi
85 .in -2
86 .sp
88 and exit with non-zero status.
89 .RE
91 .sp
92 .ne 2
93 .na
94 \fBdate\fR
95 .ad
96 .sp .6
97 .RS 4n
98 Display the \fBSC\fR's time and date
99 .sp
100 The format for the \fBdate\fR subcommand is:
102 .in +2
104 scadm date
106 .in -2
112 .ne 2
114 \fBdownload\fR
116 .sp .6
117 .RS 4n
118 Program the \fBSC\fR's firmware.
120 There are two parts to the firmware, the boot monitor and the main image.
122 By default, The \fBscadm\fR command's download programs the main firmware
123 image. The \fBboot\fR argument selects programming of the boot monitor.
125 The format for the \fBdownload\fR subcommand is:
127 .in +2
129 scadm download [boot] \fIfile\fR
131 .in -2
137 .ne 2
139 \fBfruhistory\fR
141 .sp .6
142 .RS 4n
143 Display the contents of the "field replacable unit" log maintained by the
144 \fBSC\fR. By default, only the last eight kilobytes of the fru history log file
145 are displayed. The data in contained this log contains snapshots of the
146 \fBSC\fR's "showfru" command, taken whenever the system is reset, or a hot-plug
147 event is detected by the \fBSC\fR.
149 The optional \fB-a\fR argument specifies that the entire fru log file be
150 displayed.
152 It is possible for the \fBSC\fR to fill this log more quickly than the
153 \fBfruhistory\fR subcommand can read it. This means that it is possible for
154 some log data to be lost before it can be displayed. If this happens, the
155 \fBfruhistory\fR subcommand displays "scadm: lost <number> bytes of fru log
156 data" in the log output, to indicate that some data was lost.
158 The format for the fruhistory subcommand is:
160 .in +2
162 scadm fruhistory [-a]
164 .in -2
167 The \fBfruhistory\fR subcommand is not available on all platforms. If this
168 command is used on a platform which does not support it, \fBscadm\fR prints
169 this message:
171 .in +2
173 scadm: command/option not supported
175 .in -2
178 and exit with non-zero status.
182 .ne 2
184 \fBhelp\fR
186 .sp .6
187 .RS 4n
188 Display a list of commands.
190 The format for the \fBhelp\fR subcommand is:
192 .in +2
194 scadm help
196 .in -2
202 .ne 2
204 \fBloghistory\fR
206 .sp .6
207 .RS 4n
208 Display the most recent entries in the \fBSC\fR event log. The optional
209 \fB-a\fR argument causes the entire event log history to be displayed. The
210 \fB-a\fR argument is available only on platforms which support large log files.
211 On platforms which do not support large log files, this flag has no additional
212 effect.
214 It is possible for the \fBSC\fR to fill this log more quickly than the
215 \fBloghistory\fR subcommand can read it. This means that it is possible for
216 some log data to be lost before it can be displayed. If this happens, the
217 \fBloghistory\fR subcommand displays "scadm: lost <number> events" in the log
218 output, to indicate that some data was lost.
220 The format for the \fBloghistory\fR subcommand is:
222 .in +2
224 scadm loghistory [-a]
226 .in -2
232 .ne 2
234 \fBresetrsc\fR
236 .sp .6
237 .RS 4n
238 Reset the \fBSC\fR. There are two types of resets allowed, a \fBhard\fR reset
239 and a \fBsoft\fR reset.The \fBhard\fR reset is done by default. The \fBsoft\fR
240 reset can be selected by using the \fB-s\fR option.
242 The format for the \fBresetrsc\fR subcommand is:
244 .in +2
246 scadm resetrsc [\fB-s\fR]
248 .in -2
254 .ne 2
256 \fBsend_event\fR
258 .sp .6
259 .RS 4n
260 Manually send a text based event. The \fBSC\fR can forward the event to the
261 \fBSC\fR event log. You can configure the \fB-c\fR option to send a critical
262 warning to email, alert to logged in SC users, and \fBsyslog\fR. Critical
263 events are logged to \fBsyslog\fR(3C). There is an \fB80\fR character limit to
264 the length of the associated text message.
266 The format for the \fBsend_event\fR subcommand is:
268 .in +2
270 scadm send_event [\fB-c\fR] "\fImessage\fR"
272 .in -2
278 .ne 2
280 \fBset\fR
282 .sp .6
283 .RS 4n
284 Set SC configuration variables to a value.
286 Examples of SC configuration variables include: SC IP address
287 \fBnetsc_ipaddr\fR and SC Customer Information \fBsc_customerinfo\fR. See the
288 output from the \fBscadm help\fR command for a complete list of SC
289 configuration variables.
291 The format for the \fBset\fR subcommand is:
293 .in +2
295 scadm set \fIvariable value\fR
297 .in -2
303 .ne 2
305 \fBshow\fR
307 .sp .6
308 .RS 4n
309 Display the current SC configuration variable settings. If no variable is
310 specified, \fBscadm\fR shows all variable settings.
312 The format for the \fBshow\fR subcommand is:
314 .in +2
316 scadm show [\fIvariable\fR]
318 .in -2
324 .ne 2
326 \fBshownetwork\fR
328 .sp .6
329 .RS 4n
330 Display the current network configuration parameters for SC.
332 The format for the \fBshownetwork\fR subcommand is:
334 .in +2
336 scadm shownetwork
338 .in -2
344 .ne 2
346 \fBuseradd\fR
348 .sp .6
349 .RS 4n
350 Add user accounts to the \fBSC\fR. The \fBSC\fR supports up to sixteen separate
351 users.
353 The format for the \fBuseradd\fR subcommand is:
355 .in +2
357 scadm useradd \fIusername\fR
359 .in -2
365 .ne 2
367 \fBuserdel\fR
369 .sp .6
370 .RS 4n
371 Delete a user account from \fBSC\fR.
373 The format for the \fBuserdel\fR subcommand is:
375 .in +2
377 scadm userdel \fIusername\fR
379 .in -2
385 .ne 2
387 \fBuserpassword\fR
389 .sp .6
390 .RS 4n
391 Set a password for the user account specified. This password overrides any
392 existing password currently set. There is no verification of the old password
393 before setting the new password.
395 The format for the \fBuserpassword\fR subcommand is:
397 .in +2
399 scadm userpassword \fIusername\fR
401 .in -2
407 .ne 2
409 \fBuserperm\fR
411 .sp .6
412 .RS 4n
413 Set the permission level for the user.
415 The format for the \fBuserperm\fR subcommand is:
417 .in +2
419 scadm userperm \fIusername\fR [aucr]
421 .in -2
427 .ne 2
429 \fBusershow\fR
431 .sp .6
432 .RS 4n
433 Display details on the specified user account. If a username is not specified,
434 all user accounts are displayed.
436 The format for the \fBusershow\fR subcommand is:
438 .in +2
440 scadm usershow \fIusername\fR
442 .in -2
448 .ne 2
450 \fBversion\fR
452 .sp .6
453 .RS 4n
454 Display the version numbers of the \fBSC\fR and its components.
456 The format for the \fBversion\fR subcommand is:
458 .in +2
460 scadm version [\fB-v\fR]
462 .in -2
467 .SH OPTIONS
470 The \fBresetrsc\fR, \fBsend_event\fR, and \fBversion\fR subcommands have
471 associated options. Options follow subcommands on the command line and are
472 separated from the subcommand by a SPACE.
475 The \fBresetrsc\fR subcommand supports the following options:
477 .ne 2
479 \fB\fB-s\fR\fR
481 .sp .6
482 .RS 4n
483 Perform a soft reset instead of a hard reset. A hard reset physically resets
484 the SC hardware. The SC software jumps to the boot firmware, simulating a
485 reset, for a soft reset.
490 The \fBsend_event\fR subcommand supports the following options:
492 .ne 2
494 \fB\fB-c\fR\fR
496 .sp .6
497 .RS 4n
498 Send a critical event. Without the \fB-c\fR, \fB-send_event\fR sends a warning.
503 The \fBversion\fR subcommand supports the following options:
505 .ne 2
507 \fB\fB-v\fR\fR
509 .sp .6
510 .RS 4n
511 Display a verbose output of version numbers and associated information.
516 The \fBconsolehistory\fR, \fBfruhistory\fR, and \fBloghistory\fR subcommands
517 support the following option:
519 .ne 2
521 \fB\fB-a\fR\fR
523 .sp .6
524 .RS 4n
525 Display the entire log. These subcommands normally display only the most recent
526 log data. This flag causes them to display the entire log.
529 .SH OPERANDS
532 The \fBdownload\fR, \fBsend_event\fR, \fBset\fR, \fBshow\fR, \fBuseradd\fR,
533 \fBuserdel\fR, \fBuserperm\fR, \fBusershow\fR, \fBuserpassword\fR, and
534 \fBuserperm\fR subcommands have associated arguments (operands).
537 If the subcommand has an option, the arguments follow the option on the command
538 line and is separated from the option by a SPACE. If the subcommand does not
539 have an option, the arguments follow the subcommand on the command line and are
540 separated from the subcommand by a SPACE. If there are more than one arguments,
541 they are separated from each other by a SPACE.
544 The \fBdownload\fR subcommand supports the following arguments:
546 .ne 2
548 \fBboot\fR
550 .sp .6
551 .RS 4n
552 Program the boot monitor portion of the flash. The main portion of the flash is
553 programmed without any arguments
557 .ne 2
559 \fB\fIfile\fR\fR
561 .sp .6
562 .RS 4n
563 Specify \fIfile\fR as the path to where the boot or main firmware image resides
564 for download.
566 Examples of \fIfile\fR are:
568 .in +2
570 \fB/usr/platform/\fIplatform_type\fR/lib/image/alommainfw\fR
572 .in -2
577 .in +2
579 /usr/platform/\fIplatform_type\fR/lib/image/alombootfw
581 .in -2
588 The \fBsend_event\fR subcommand supports the following arguments:
590 .ne 2
592 \fB"\fImessage\fR"\fR
594 .sp .6
595 .RS 4n
596 Describe event using the test contained in \fImessage\fR. Enclose \fImessage\fR
597 in quotation marks.
602 The \fBset\fR subcommand supports the following arguments:
604 .ne 2
606 \fB\fIvariable\fR\fR
608 .sp .6
609 .RS 4n
610 Set SC configuration \fIvariable\fR.
614 .ne 2
616 \fB\fIvalue\fR\fR
618 .sp .6
619 .RS 4n
620 Set SC configuration variable to \fIvalue\fR.
625 The \fBshow\fR subcommand supports the following arguments:
627 .ne 2
629 \fB\fIvariable\fR\fR
631 .sp .6
632 .RS 4n
633 Display the value of that particular variable.
638 The \fBuseradd\fR subcommand supports the following arguments:
640 .ne 2
642 \fB\fIusername\fR\fR
644 .sp .6
645 .RS 4n
646 Add new SC account \fIusername\fR.
651 The \fBuserdel\fR subcommand supports the following arguments:
653 .ne 2
655 \fB\fIusername\fR\fR
657 .sp .6
658 .RS 4n
659 Remove SC account \fIusername\fR.
664 The \fBuserperm\fR subcommand supports the following arguments:
666 .ne 2
668 \fB\fB-aucr\fR\fR
670 .sp .6
671 .RS 4n
672 Set permissions for SC user accounts. If no permissions are specified, all four
673 permissions are disabled and read only access is assigned.
675 The following are the definitions for permissions:
677 .ne 2
679 \fBa\fR
681 .sp .6
682 .RS 4n
683 Allow user to administer or change the SC configuration variables
687 .ne 2
689 \fBu\fR
691 .sp .6
692 .RS 4n
693 Allow user to use the user commands to modify SC accounts
697 .ne 2
699 \fBc\fR
701 .sp .6
702 .RS 4n
703 Allow user to connect to console.
707 .ne 2
709 \fBr\fR
711 .sp .6
712 .RS 4n
713 Allow user to reset SC and to power on and off the host.
719 .ne 2
721 \fB\fIusername\fR\fR
723 .sp .6
724 .RS 4n
725 Change permissions on SC account \fIusername\fR.
730 The \fB-usershow\fR subcommand supports the following arguments:
732 .ne 2
734 \fB\fIusername\fR\fR
736 .sp .6
737 .RS 4n
738 Display information on SC account \fIusername\fR. If \fIusername\fRis not
739 specified, all accounts are displayed.
744 The \fBuserpassword\fR subcommand supports the following arguments:
746 .ne 2
748 \fB\fIusername\fR\fR
750 .sp .6
751 .RS 4n
752 Set SC password for \fIusername\fR.
757 The \fBuserperm\fR subcommand supports the following arguments:
759 .ne 2
761 \fB\fIusername\fR\fR
763 .sp .6
764 .RS 4n
765 Change SC permissions for \fIusername\fR.
768 .SH EXAMPLES
770 \fBExample 1 \fRDisplaying the SC's Date and Time
773 The following command displays the SC's date and time.
776 .in +2
778 scadm date
780 .in -2
784 \fBExample 2 \fRSetting the SC's Configuration Variables
787 The following command sets the SC's configuration variable \fBnetsc_ipaddr\fR
788 to \fB192.168.1.2\fR:
791 .in +2
793 scadm set netsc_ipaddr 192.168.1.2
795 .in -2
799 \fBExample 3 \fRDisplaying the Current SC's Configuration Settings:
802 The following command displays the current SC configuration settings:
805 .in +2
807 scadm show
809 .in -2
813 \fBExample 4 \fRDisplaying the Current Settings for a Variable
816 The following command displays the current settings for the \fBsys_hostname\fR
817 variable:
820 .in +2
822 scadm show sys_hostname
824 .in -2
828 \fBExample 5 \fRSending a Text-Based Critical Event
831 The following command sends a critical event to the SC logs, alerts the current
832 SC users, and sends an event to \fBsyslog\fR(3C):
835 .in +2
837 scadm send_event \fB-c\fR "The UPS signaled a loss in power"
839 .in -2
843 \fBExample 6 \fRSending an Informational Text-Based Event
846 The following command sends an non-critical informational text based event to
847 the SC event log:
850 .in +2
852 scadm send_event "The disk is close to full capacity"
854 .in -2
858 \fBExample 7 \fRAdding a User To the SC
861 The following command adds user \fBrscroot\fR to the SC:
864 .in +2
866 scadm useradd rscroot
868 .in -2
872 \fBExample 8 \fRDeleting a User From the SC
875 The following command deletes user \fBolduser\fR from the SC:
878 .in +2
880 scadm userdel olduser
882 .in -2
886 \fBExample 9 \fRDisplaying User Details
889 The following command displays details of all user accounts:
892 .in +2
894 scadm usershow
896 .in -2
900 \fBExample 10 \fRDisplaying Details for a Specific User
903 The following command displays details of user account \fBrscroot\fR:
906 .in +2
908 scadm usershow rscroot
910 .in -2
914 \fBExample 11 \fRSetting the User Permission Level
917 The following command sets the full permission level for user \fBrscroot\fR to
918 \fBaucr\fR:
921 .in +2
923 scadm userperm rscroot aucr
925 .in -2
929 \fBExample 12 \fRSetting the User Permission Level
932 The following command sets only console access for user \fBnewuser\fR to
933 \fBc\fR:
936 .in +2
938 scadm userperm newuser c
940 .in -2
944 \fBExample 13 \fRSetting the User Permission Level
947 The following command sets the permission level for user \fBnewuser\fR to read
948 only access:
951 .in +2
953 scadm userperm newuser
955 .in -2
959 \fBExample 14 \fRDisplaying the Current Network Parameters
962 The following command displays the current network configuation parameters for
963 the SC:
966 .in +2
968 scadm shownetwork
970 .in -2
974 \fBExample 15 \fRViewing the Consolehistory
977 The following command displays the content console in the \fBSC\fR event log:
980 .in +2
982 scadm consolehistory [-a]
984 .in -2
988 \fBExample 16 \fRViewing the Fruhistory
991 The following command displays the content of the "field replacable unit" in
992 the \fBSC\fR event log:
995 .in +2
997 scadm fruhistory [-a]
999 .in -2
1003 \fBExample 17 \fRViewing the Loghistory
1006 The following command displays the most recent entries in the SC event log:
1009 .in +2
1011 scadm loghistory [-a]
1013 .in -2
1017 \fBExample 18 \fRDisplaying Verbose Information
1020 The following command displays verbose version information on the SC and its
1021 components:
1024 .in +2
1026 scadm version \fB-v\fR
1028 .in -2
1031 .SH EXIT STATUS
1034 The following exit values are returned:
1036 .ne 2
1038 \fB\fB0\fR\fR
1040 .sp .6
1041 .RS 4n
1042 Successful completion.
1046 .ne 2
1048 \fB\fBnon-zero\fR\fR
1050 .sp .6
1051 .RS 4n
1052 An error occurred.
1055 .SH ATTRIBUTES
1058 See \fBattributes\fR(5) for descriptions of the following attributes:
1063 box;
1064 c | c
1065 l | l .
1066 ATTRIBUTE TYPE  ATTRIBUTE VALUE
1068 Interface Stability     Evolving
1071 .SH SEE ALSO
1074 \fBuname\fR(1), \fBsyslog\fR(3C), \fBattributes\fR(5)