| blob | 3abd85cd386def11710f6ad6a70e7f1b1f51452e |
1 '\" te
2 .\" Copyright 2003 (c), 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 CFGADM_SBD 1M "Oct 13, 2003"
7 .SH NAME
8 cfgadm_sbd \- \fBcfgadm\fR commands for system board administration
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBcfgadm \fR \fB-l\fR [\fB-a\fR] [\fB-o\fR parsable] \fI ap_id\fR...
13 .fi
15 .LP
16 .nf
17 \fBcfgadm \fR \fB-c \fR \fIfunction\fR [\fB-f\fR] [\fB-y\fR | \fB-n\fR]
18 [\fB-o\fR unassign | nopoweroff] [\fB-v\fR] \fI ap_id\fR...
19 .fi
21 .LP
22 .nf
23 \fBcfgadm \fR \fB-t\fR [\fB-v\fR] \fI ap_id\fR...
24 .fi
26 .LP
27 .nf
28 \fBcfgadm \fR \fB-x \fR [\fB-f\fR] [\fB-v\fR] \fIfunction\fR \fI ap_id\fR...
29 .fi
31 .SH DESCRIPTION
32 .sp
33 .LP
34 The \fBcfgadm_sbd\fR plugin provides dynamic reconfiguration functionality for
35 connecting, configuring, unconfiguring, and disconnecting class \fBsbd\fR
36 system boards. It also enables you to connect or disconnect a system board from
37 a running system without having to reboot the system.
38 .sp
39 .LP
40 The \fBcfgadm\fR command resides in \fB/usr/sbin\fR. See \fBcfgadm\fR(1M). The
41 \fBcfgadm_sbd\fR plugin resides \fB/usr/platform/sun4u/lib/cfgadm\fR.
42 .sp
43 .LP
44 Each board slot appears as a single attachment point in the device tree. Each
45 component appears as a dynamic attachment point. You can view the type, state,
46 and condition of each component, and the states and condition of each board
47 slot by using the \fB-a\fR option.
48 .sp
49 .LP
50 The \fBcfgadm\fR options perform differently depending on the platform.
51 Additionally, the form of the attachment points is different depending on the
52 platform. See the \fBPlatform Notes\fR section for more information.
53 .SS "Component Conditions"
54 .sp
55 .LP
56 The following are the names and descriptions of the component conditions:
57 .sp
58 .ne 2
59 .na
60 \fBfailed\fR
61 .ad
62 .RS 11n
63 The component failed testing.
64 .RE
66 .sp
67 .ne 2
68 .na
69 \fBok\fR
70 .ad
71 .RS 11n
72 The component is operational.
73 .RE
75 .sp
76 .ne 2
77 .na
78 \fBunknown\fR
79 .ad
80 .RS 11n
81 The component has not been tested.
82 .RE
84 .SS "Component States"
85 .sp
86 .LP
87 The following is the name and description of the receptacle state for
88 components:
89 .sp
90 .ne 2
91 .na
92 \fBconnected\fR
93 .ad
94 .RS 13n
95 The component is connected to the board slot.
96 .RE
98 .sp
99 .LP
100 The following are the names and descriptions of the occupant states for
101 components:
102 .sp
103 .ne 2
104 .na
105 \fBconfigured\fR
106 .ad
107 .RS 16n
108 The component is available for use by the Solaris operating environment.
109 .RE
111 .sp
112 .ne 2
113 .na
114 \fBunconfigured\fR
115 .ad
116 .RS 16n
117 The component is not available for use by the Solaris operating environment.
118 .RE
120 .SS "Board Conditions"
121 .sp
122 .LP
123 The following are the names and descriptions of the board conditions.
124 .sp
125 .ne 2
126 .na
127 \fBfailed\fR
128 .ad
129 .RS 12n
130 The board failed testing.
131 .RE
133 .sp
134 .ne 2
135 .na
136 \fBok\fR
137 .ad
138 .RS 12n
139 The board is operational.
140 .RE
142 .sp
143 .ne 2
144 .na
145 \fBunknown\fR
146 .ad
147 .RS 12n
148 The board has not been tested.
149 .RE
151 .sp
152 .ne 2
153 .na
154 \fBunusable\fR
155 .ad
156 .RS 12n
157 The board slot is unusable.
158 .RE
160 .SS "Board States"
161 .sp
162 .LP
163 Inserting a board changes the receptacle state from empty to disconnected.
164 Removing a board changes the receptacle state from disconnected to empty.
165 .sp
166 .LP
167 \fBCaution:\fR Removing a board that is in the connected state or that is
168 powered on and in the disconnected state crashes the operating system and can
169 result in permanent damage to the system.
170 .sp
171 .LP
172 The following are the names and descriptions of the receptacle states for
173 boards:
174 .sp
175 .ne 2
176 .na
177 \fBconnected\fR
178 .ad
179 .RS 16n
180 The board is powered on and connected to the system bus. You can view the
181 components on a board only after it is in the connected state.
182 .RE
184 .sp
185 .ne 2
186 .na
187 \fBdisconnected\fR
188 .ad
189 .RS 16n
190 The board is disconnected from the system bus. A board can be in the
191 disconnected state without being powered off. However, a board must be powered
192 off and in the disconnected state before you remove it from the slot.
193 .RE
195 .sp
196 .ne 2
197 .na
198 \fBempty\fR
199 .ad
200 .RS 16n
201 A board is not present.
202 .RE
204 .sp
205 .LP
206 The occupant state of a disconnected board is always unconfigured. The
207 following table contains the names and descriptions of the occupant states for
208 boards:
209 .sp
210 .ne 2
211 .na
212 \fBconfigured\fR
213 .ad
214 .RS 16n
215 At least one component on the board is configured.
216 .RE
218 .sp
219 .ne 2
220 .na
221 \fBunconfigured\fR
222 .ad
223 .RS 16n
224 All of the components on the board are unconfigured.
225 .RE
227 .SS "Dynamic System Domains"
228 .sp
229 .LP
230 Platforms based on dynamic system domains (DSDs, referred to as domains in this
231 document) divide the slots in the chassis into electrically isolated hardware
232 partitions (that is, DSDs). Platforms that are not based on DSDs assign all
233 slots to the system permanently.
234 .sp
235 .LP
236 A slot can be empty or populated, and it can be assigned or available to any
237 number of domains. The number of slots available to a given domain is
238 controlled by an available component list (\fBACL\fR) that is maintained on the
239 system controller. The \fBACL\fR is not the access control list provided by the
240 Solaris operating environment.
241 .sp
242 .LP
243 A slot is visible to a domain only if the slot is in the domain's \fBACL\fR and
244 if it is not assigned to another domain. An unassigned slot is visible to all
245 domains that have the slot in their \fBACL\fR. After a slot has been assigned
246 to a domain, the slot is no longer visible to any other domain.
247 .sp
248 .LP
249 A slot that is visible to a domain, but not assigned, must first be assigned to
250 the domain before any other state changing commands are applied. The assign can
251 be done explicitly using \fB\fR\fB-x\fR\fB assign\fR or implicitly as part of a
252 connect. A slot must be unassigned from a domain before it can be used by
253 another domain. The unassign is always explicit, either directly using
254 \fB\fR\fB-x\fR\fB unassign\fR or as an option to disconnect using
255 \fB\fR\fB-o\fR\fB unassign\fR.
256 .SS "State Change Functions"
257 .sp
258 .LP
259 Functions that change the state of a board slot or a component on the board can
260 be issued concurrently against any attachment point. Only one state changing
261 operation is permitted at a given time. A \fBY\fR in the Busy field in the
262 state changing information indicates an operation is in progress.
263 .sp
264 .LP
265 The following list contains the functions that change the state:
266 .RS +4
267 .TP
268 .ie t \(bu
269 .el o
270 configure
271 .RE
272 .RS +4
273 .TP
274 .ie t \(bu
275 .el o
276 unconfigure
277 .RE
278 .RS +4
279 .TP
280 .ie t \(bu
281 .el o
282 connect
283 .RE
284 .RS +4
285 .TP
286 .ie t \(bu
287 .el o
288 disconnect
289 .RE
290 .SS "Availability Change Functions"
291 .sp
292 .LP
293 Commands that change the availability of a board can be issued concurrently
294 against any attachment point. Only one availability change operation is
295 permitted at a given time. These functions also change the information string
296 in the \fBcfgadm\fR \fB-l\fR output. A \fBY\fR in the Busy field indicates that
297 an operation is in progress.
298 .sp
299 .LP
300 The following list contains the functions that change the availability:
301 .RS +4
302 .TP
303 .ie t \(bu
304 .el o
305 \fBassign\fR
306 .RE
307 .RS +4
308 .TP
309 .ie t \(bu
310 .el o
311 \fBunassign\fR
312 .RE
313 .SS "Condition Change Functions"
314 .sp
315 .LP
316 Functions that change the condition of a board slot or a component on the board
317 can be issued concurrently against any attachment point. Only one condition
318 change operation is permitted at a given time. These functions also change the
319 information string in the \fBcfgadm\fR \fB-l\fR output. A \fBY\fR in the Busy
320 field indicates an operation is in progress.
321 .sp
322 .LP
323 The following list contains the functions that change the condition:
324 .RS +4
325 .TP
326 .ie t \(bu
327 .el o
328 \fBpoweron\fR
329 .RE
330 .RS +4
331 .TP
332 .ie t \(bu
333 .el o
334 \fBpoweroff\fR
335 .RE
336 .RS +4
337 .TP
338 .ie t \(bu
339 .el o
340 \fBtest\fR
341 .RE
342 .SS "Unconfigure Process"
343 .sp
344 .LP
345 This section contains a description of the unconfigure process, and illustrates
346 the states of source and target boards at different stages during the process
347 of moving permanent memory.
348 .sp
349 .LP
350 In the following code examples, the permanent memory on board 0 must be moved
351 to another board in the domain. Thus, board 0 is the source, and board 1 is the
352 target.
353 .sp
354 .LP
355 A status change operation cannot be initiated on a board while it is marked as
356 busy. For brevity, the \fBCPU\fR information has been removed from the code
357 examples.
358 .sp
359 .LP
360 The process is started with the following command:
361 .sp
362 .in +2
363 .nf
364 # \fBcfgadm -c unconfigure -y SB0::memory &\fR
365 .fi
366 .in -2
367 .sp
369 .sp
370 .LP
371 First, the memory on board 1 in the same address range as the permanent memory
372 on board 0 must be deleted. During this phase, the source board, the target
373 board, and the memory attachment points are marked as busy. You can display the
374 status with the following command:
375 .sp
376 .in +2
377 .nf
378 # \fBcfgadm -a -s cols=ap_id:type:r_state:o_state:busy SB0 SB1\fR
380 Ap_Id Type Receptacle Occupant Busy
381 SB0 CPU connected configured y
382 SB0::memory memory connected configured y
383 SB1 CPU connected configured y
384 SB1::memory memory connected configured y
386 .fi
387 .in -2
388 .sp
390 .sp
391 .LP
392 After the memory has been deleted on board 1, it is marked as unconfigured. The
393 memory on board 0 remains configured, but it is still marked as busy, as in the
394 following example.
395 .sp
396 .in +2
397 .nf
398 Ap_Id Type Receptacle Occupant Busy
399 SB0 CPU connected configured y
400 SB0::memory memory connected configured y
401 SB1 CPU connected configured y
402 SB1::memory memory connected unconfigured n
404 .fi
405 .in -2
406 .sp
408 .sp
409 .LP
410 The memory from board 0 is then copied to board 1. After it has been copied,
411 the occupant state for the memory is switched. The memory on board 0 becomes
412 unconfigured, and the memory on board 1 becomes configured. At this point in
413 the process, only board 0 remains busy, as in the following example.
414 .sp
415 .in +2
416 .nf
417 Ap_Id Type Receptacle Occupant Busy
418 SB0 CPU connected configured y
419 SB0::memory memory connected unconfigured n
420 SB1 CPU connected configured n
421 SB1::memory memory connected configured n
423 .fi
424 .in -2
425 .sp
427 .sp
428 .LP
429 After the entire process has been completed, the memory on board 0 remains
430 unconfigured, and the attachment points are not busy, as in the following
431 example.
432 .sp
433 .in +2
434 .nf
435 Ap_Id Type Receptacle Occupant Busy
436 SB0 CPU connected configured n
437 SB0::memory memory connected unconfigured n
438 SB1 CPU connected configured n
439 SB1::memory memory connected configured n
441 .fi
442 .in -2
443 .sp
445 .sp
446 .LP
447 The permanent memory has been moved, and the memory on board 0 has been
448 unconfigured. At this point, you can initiate a new state changing operation on
449 either board.
450 .SS "Platform-Specific Options"
451 .sp
452 .LP
453 You can specify platform-specific options that follow the options interpreted
454 by the system board plugin. All platform-specific options must be preceded by
455 the \fBplatform\fR keyword. The following example contains the general format
456 of a command with platform-specific options:
457 .sp
458 .LP
459 \fB\fIcommand\fR -o \fIsbd_options\fR,platform=\fIplatform_options\fR\fR
460 .SH OPTIONS
461 .sp
462 .LP
463 This man page does not include the \fB-v\fR, \fB-a\fR, \fB-s\fR, or \fB-h\fR
464 options for the \fBcfgadm\fR command. See \fBcfgadm\fR(1M) for descriptions of
465 those options. The following options are supported by the \fBcfgadm_sbd\fR
466 plugin:
467 .sp
468 .ne 2
469 .na
470 \fB\fB-c \fR\fIfunction\fR\fR
471 .ad
472 .RS 15n
473 Performs a state change function. You can use the following functions:
474 .sp
475 .ne 2
476 .na
477 \fBunconfigure\fR
478 .ad
479 .RS 15n
480 Changes the occupant state to unconfigured. This function applies to system
481 board slots and to all of the components on the system board.
482 .sp
483 The \fBunconfigure\fR function removes the \fBCPU\fRs from the \fBCPU\fR list
484 and deletes the physical memory from the system memory pool. If any device is
485 still in use, the \fBcfgadm\fR command fails and reports the failure to the
486 user. You can retry the command as soon as the device is no longer busy. If a
487 \fBCPU\fR is in use, you must ensure that it is off line before you proceed.
488 See \fBpbind\fR(1M), \fBpsradm\fR(1M) and \fBpsrinfo\fR(1M).
489 .sp
490 The \fBunconfigure\fR function moves the physical memory to another system
491 board before it deletes the memory from the board you want to unconfigure.
492 Depending of the type of memory being moved, the command fails if it cannot
493 find enough memory on another board or if it cannot find an appropriate
494 physical memory range.
495 .sp
496 For permanent memory, the operating system must be suspended (that is,
497 quiesced) while the memory is moved and the memory controllers are
498 reprogrammed. If the operating system must be suspended, you will be prompted
499 to proceed with the operation. You can use the \fB-y\fR or \fB-n\fR options to
500 always answer yes or no respectively.
501 .sp
502 Moving memory can take several minutes to complete, depending on the amount of
503 memory and the system load. You can monitor the progress of the operation by
504 issuing a status command against the memory attachment point. You can also
505 interrupt the memory operation by stopping the \fBcfgadm\fR command. The
506 deleted memory is returned to the system memory pool.
507 .RE
509 .sp
510 .ne 2
511 .na
512 \fBdisconnect\fR
513 .ad
514 .RS 15n
515 Changes the receptacle state to disconnected. This function applies only to
516 system board slots.
517 .sp
518 If the occupant state is configured, the \fBdisconnect\fR function attempts to
519 unconfigure the occupant. It then powers off the system board. At this point,
520 the board can be removed from the slot.
521 .sp
522 This function leaves the board in the assigned state on platforms that support
523 dynamic system domains.
524 .sp
525 If you specify \fB-o nopoweroff\fR, the \fBdisconnect\fR function leaves the
526 board powered on. If you specify \fB-o unassign\fR, the \fBdisconnect\fR
527 function unassigns the board from the domain.
528 .sp
529 If you unassign a board from a domain, you can assign it to another domain.
530 However, if it is assigned to another domain, it is not available to the domain
531 from which is was unassigned.
532 .RE
534 .sp
535 .ne 2
536 .na
537 \fBconfigure\fR
538 .ad
539 .RS 15n
540 Changes the occupant state to configured. This function applies to system board
541 slots and to any components on the system board.
542 .sp
543 If the receptacle state is disconnected, the \fBconfigure\fR function attempts
544 to connect the receptacle. It then walks the tree of devices that is created by
545 the \fBconnect\fR function, and attaches the devices if necessary. Running this
546 function configures all of the components on the board, except those that have
547 already been configured.
548 .sp
549 For \fBCPU\fRs, the \fBconfigure\fR function adds the \fBCPU\fRs to the
550 \fBCPU\fR list. For memory, the \fBconfigure\fR function ensures that the
551 memory is initialized then adds the memory to the system memory pool. The
552 \fBCPU\fRs and the memory are ready for use after the \fBconfigure\fR function
553 has been completed successfully.
554 .sp
555 For I/O devices, you must use the \fBmount\fR and the \fBifconfig\fR commands
556 before the devices can be used. See \fBifconfig\fR(1M) and \fBmount\fR(1M).
557 .RE
559 .sp
560 .ne 2
561 .na
562 \fBconnect\fR
563 .ad
564 .RS 15n
565 Changes the receptacle state to connected. This function applies only to system
566 board slots.
567 .sp
568 If the board slot is not assigned to the domain, the \fBconnect\fR function
569 attempts to assign the slot to the domain. Next, it powers on and tests the
570 board, then it connects the board electronically to the system bus and probes
571 the components.
572 .sp
573 After the \fBconnect\fR function is completed successfully, you can use the
574 \fB-a\fR option to view the status of the components on the board. The
575 \fBconnect\fR function leaves all of the components in the unconfigured state.
576 .sp
577 The assignment step applies only to platforms that support dynamic system
578 domains.
579 .RE
581 .RE
583 .sp
584 .ne 2
585 .na
586 \fB\fB-f\fR\fR
587 .ad
588 .RS 15n
589 Overrides software state changing constraints.
590 .sp
591 The \fB-f\fR option never overrides fundamental safety and availability
592 constraints of the hardware and operating system.
593 .RE
595 .sp
596 .ne 2
597 .na
598 \fB\fB-l\fR\fR
599 .ad
600 .RS 15n
601 Lists the state and condition of attachment points specified in the format
602 controlled by the \fB-s\fR, \fB-v\fR, and \fB-a\fR options as specified in
603 \fBcfgadm\fR(1M). The \fBcfgadm_sbd\fR plugin provides specific information in
604 the info field as described below. The format of this information might be
605 altered by the \fB\fR\fB-o\fR\fB parsable\fR option.
606 .sp
607 The parsable \fBinfo\fR field is composed of the following:
608 .sp
609 .ne 2
610 .na
611 \fBcpu\fR
612 .ad
613 .RS 10n
614 The \fBcpu\fR type displays the following information:
615 .sp
616 .ne 2
617 .na
618 \fB\fBcpuid=\fR\fI#\fR\fB[,\fR\fI#\fR\fB\&.\|.\|.]\fR\fR
619 .ad
620 .RS 24n
621 Where \fI#\fR is a number, and represents the \fBID\fR of the \fBCPU\fR. If
622 more than one \fI#\fR is present, this \fBCPU\fR has multiple active virtual
623 processors.
624 .RE
626 .sp
627 .ne 2
628 .na
629 \fB\fBspeed=\fR\fI#\fR\fR
630 .ad
631 .RS 24n
632 Where \fI#\fR is a number and represents the speed of the \fBCPU\fR in
633 \fBMHz\fR.
634 .RE
636 .sp
637 .ne 2
638 .na
639 \fB\fBecache=\fR\fI#\fR\fR
640 .ad
641 .RS 24n
642 Where \fI#\fR is a number and represents the size of the ecache in MBytes. If
643 the \fBCPU\fR has multiple active virtual processors, the ecache could either
644 be shared among the virtual processors, or divided between them.
645 .RE
647 .RE
649 .sp
650 .ne 2
651 .na
652 \fBmemory\fR
653 .ad
654 .RS 10n
655 The \fBmemory\fR type displays the following information, as appropriate:
656 .sp
657 .ne 2
658 .na
659 \fBaddress=\fI#\fR\fR
660 .ad
661 .RS 26n
662 Where \fI#\fR is a number, representing the base physical address.
663 .RE
665 .sp
666 .ne 2
667 .na
668 \fBsize=\fI#\fR\fR
669 .ad
670 .RS 26n
671 Where \fI#\fR is a number, representing the size of the memory in \fBKBytes\fR.
672 .RE
674 .sp
675 .ne 2
676 .na
677 \fBpermanent=\fI#\fR\fR
678 .ad
679 .RS 26n
680 Where \fI#\fR is a number, representing the size of permanent memory in
681 \fBKBytes\fR.
682 .RE
684 .sp
685 .ne 2
686 .na
687 \fBunconfigurable\fR
688 .ad
689 .RS 26n
690 An operating system setting that prevents the memory from being unconfigured.
691 .RE
693 .sp
694 .ne 2
695 .na
696 \fBinter-board-interleave\fR
697 .ad
698 .RS 26n
699 The board is participating in interleaving with other boards.
700 .RE
702 .sp
703 .ne 2
704 .na
705 \fBsource=\fIap_id\fR\fR
706 .ad
707 .RS 26n
708 Represents the source attachment point.
709 .RE
711 .sp
712 .ne 2
713 .na
714 \fBtarget=\fIap_id\fR\fR
715 .ad
716 .RS 26n
717 Represents the target attachment point.
718 .RE
720 .sp
721 .ne 2
722 .na
723 \fBdeleted=\fI#\fR\fR
724 .ad
725 .RS 26n
726 Where \fI#\fR is a number, representing the amount of memory that has already
727 been deleted in \fBKBytes\fR.
728 .RE
730 .sp
731 .ne 2
732 .na
733 \fBremaining=\fI#\fR\fR
734 .ad
735 .RS 26n
736 Where \fI#\fR is a number, representing the amount of memory to be deleted in
737 \fBKBytes\fR.
738 .RE
740 .RE
742 .sp
743 .ne 2
744 .na
745 \fBio\fR
746 .ad
747 .RS 10n
748 The \fBio\fR type displays the following information:
749 .sp
750 .ne 2
751 .na
752 \fBdevice=\fIpath\fR\fR
753 .ad
754 .RS 15n
755 Represents the physical path to the I/O component.
756 .RE
758 .sp
759 .ne 2
760 .na
761 \fBreferenced\fR
762 .ad
763 .RS 15n
764 The I/O component is referenced.
765 .RE
767 .RE
769 .sp
770 .ne 2
771 .na
772 \fBboard\fR
773 .ad
774 .RS 10n
775 The \fBboard\fR type displays the following boolean names. If they are not
776 present, then the opposite applies.
777 .sp
778 .ne 2
779 .na
780 \fBassigned\fR
781 .ad
782 .RS 14n
783 The board is assigned to the domain.
784 .RE
786 .sp
787 .ne 2
788 .na
789 \fBpowered-on\fR
790 .ad
791 .RS 14n
792 The board is powered on.
793 .RE
795 The same items appear in the \fBinfo\fR field in a more readable format if the
796 \fB-o\fR \fBparsable\fR option is not specified.
797 .RE
799 .RE
801 .sp
802 .ne 2
803 .na
804 \fB\fB-o\fR parsable\fR
805 .ad
806 .RS 15n
807 Returns the information in the \fBinfo\fR field as a boolean \fIname\fR or a
808 set of \fBname=value\fR pairs, separated by a space character.
809 .sp
810 The \fB-o parsable\fR option can be used in conjunction with the \fB-s\fR
811 option. See the \fBcfgadm\fR(1M) man page for more information about the
812 \fB-s\fR option.
813 .RE
815 .sp
816 .ne 2
817 .na
818 \fB\fB-t\fR\fR
819 .ad
820 .RS 15n
821 Tests the board.
822 .sp
823 Before a board can be connected, it must pass the appropriate level of testing.
824 .sp
825 Use of this option always attempts to test the board, even if it has already
826 passed the appropriate level of testing. Testing is also performed when a
827 \fB\fR\fB-c\fR\fB connect\fR state change function is issued, in which case the
828 test step can be skipped if the board already shows an appropriate level of
829 testing. Thus the \fB-t\fR option can be used to explicitly request that the
830 board be tested.
831 .RE
833 .sp
834 .ne 2
835 .na
836 \fB\fB-x\fR\fI function\fR\fR
837 .ad
838 .RS 15n
839 Performs an sbd-class function. You can use the following functions:
840 .sp
841 .ne 2
842 .na
843 \fBassign\fR
844 .ad
845 .RS 12n
846 Assigns a board to a domain.
847 .sp
848 The receptacle state must be disconnected or empty. The board must also be
849 listed in the domain available component list. See Dynamic System Domains.
850 .RE
852 .sp
853 .ne 2
854 .na
855 \fBunassign\fR
856 .ad
857 .RS 12n
858 Unassigns a board from a domain.
859 .sp
860 The receptacle state must be disconnected or empty. The board must also be
861 listed in the domain available component list. See Dynamic System Domains.
862 .RE
864 .sp
865 .ne 2
866 .na
867 \fBpoweron\fR
868 .ad
869 .RS 12n
870 Powers the system board on.
871 .sp
872 The receptacle state must be disconnected.
873 .RE
875 .sp
876 .ne 2
877 .na
878 \fBpoweroff\fR
879 .ad
880 .RS 12n
881 Powers the system board off.
882 .sp
883 The receptacle state must be disconnected.
884 .RE
886 .RE
888 .SH OPERANDS
889 .sp
890 .LP
891 The following operands are supported:
892 .sp
893 .ne 2
894 .na
895 \fBReceptacle \fIap_id\fR\fR
896 .ad
897 .RS 20n
898 For the Sun Fire high-end systems such as the Sun Fire 15K , the receptacle
899 attachment point \fBID\fR takes the form \fBSB\fIX\fR\fR or \fBIO\fIX\fR\fR,
900 where \fIX\fR equals the slot number.
901 .sp
902 The exact format depends on the platform and typically corresponds to the
903 physical labelling on the machine. See the platform specific information in the
904 \fBNOTES\fR section.
905 .RE
907 .sp
908 .ne 2
909 .na
910 \fBComponent \fIap_id\fR\fR
911 .ad
912 .RS 20n
913 The component attachment point \fBID\fR takes the form \fIcomponent_typeX\fR,
914 where \fIcomponent_type\fR equals one of the component types described in
915 "Component Types" and \fIX\fR equals the component number. The component number
916 is a board-relative unit number.
917 .sp
918 The above convention does not apply to memory compontents. Any DR action on a
919 memory attachment point affects all of the memory on the system board.
920 .RE
922 .SH EXAMPLES
923 .sp
924 .LP
925 The following examples show user input and system output on a Sun Fire 15K
926 system. User input, specifically references to attachment points and system
927 output might differ on other Sun Fire systems, such as the Sun Fire midrange
928 systems such as the 6800. Refer to the Platform Notes for specific information
929 about using the \fBcfgadm_sbd\fR plugin on non-Sun Fire high-end models.
930 .LP
931 \fBExample 1 \fRListing All of the System Board
932 .sp
933 .in +2
934 .nf
935 # \fBcfgadm -a -s "select=class(sbd)"\fR
937 Ap_Id Type Receptacle Occupant Condition
938 SB0 CPU connected configured ok
939 SB0::cpu0 cpu connected configured ok
940 SB0::memory memory connected configured ok
941 IO1 HPCI connected configured ok
942 IO1::pci0 io connected configured ok
943 IO1::pci1 io connected configured ok
944 SB2 CPU disconnected unconfigured failed
945 SB3 CPU disconnected unconfigured unusable
946 SB4 unknown empty unconfigured unknown
947 .fi
948 .in -2
949 .sp
951 .sp
952 .LP
953 This example demonstrates the mapping of the following conditions:
955 .RS +4
956 .TP
957 .ie t \(bu
958 .el o
959 The board in Slot 2 failed testing.
960 .RE
961 .RS +4
962 .TP
963 .ie t \(bu
964 .el o
965 Slot 3 is unusable; thus, you cannot hot plug a board into that slot.
966 .RE
967 .LP
968 \fBExample 2 \fRListing All of the \fBCPU\fRs on the System Board
969 .sp
970 .in +2
971 .nf
972 # \fBcfgadm -a -s "select=class(sbd):type(cpu)"\fR
974 Ap_Id Type Receptacle Occupant Condition
975 SB0::cpu0 cpu connected configured ok
976 SB0::cpu1 cpu connected configured ok
977 SB0::cpu2 cpu connected configured ok
978 SB0::cpu3 cpu connected configured ok
979 .fi
980 .in -2
981 .sp
983 .LP
984 \fBExample 3 \fRDisplaying the \fBCPU\fR Information Field
985 .sp
986 .in +2
987 .nf
988 # \fBcfgadm -l -s noheadings,cols=info SB0::cpu0\fR
990 cpuid 16, speed 400 MHz, ecache 8 Mbytes
991 .fi
992 .in -2
993 .sp
995 .LP
996 \fBExample 4 \fRDisplaying the \fBCPU\fR Information Field in Parsable Format
997 .sp
998 .in +2
999 .nf
1000 # \fBcfgadm -l -s noheadings,cols=info -o parsable SB0::cpu0\fR
1002 cpuid=16 speed=400 ecache=8
1003 .fi
1004 .in -2
1005 .sp
1007 .LP
1008 \fBExample 5 \fRDisplaying the Devices on an I/O Board
1009 .sp
1010 .in +2
1011 .nf
1012 # \fBcfgadm -a -s noheadings,cols=ap_id:info -o parsable IO1\fR
1014 IO1 powered-on assigned
1015 IO1::pci0 device=/devices/saf@0/pci@0,2000 referenced
1016 IO1::pci1 device=/devices/saf@0/pci@1,2000 referenced
1017 .fi
1018 .in -2
1019 .sp
1021 .LP
1022 \fBExample 6 \fRMonitoring an Unconfigure Operation
1023 .sp
1024 .LP
1025 In the following example, the memory sizes are displayed in Kbytes.
1027 .sp
1028 .in +2
1029 .nf
1030 # \fBcfgadm -c unconfigure -y SB0::memory &\fR
1031 # \fBcfgadm -l -s noheadings,cols=info -o parsable SB0::memory SB1::memory\fR
1033 address=0x0 size=2097152 permanent=752592 target=SB1::memory
1034 deleted=1273680 remaining=823472
1035 address=0x1000000 size=2097152 source=SB0::memory
1036 .fi
1037 .in -2
1038 .sp
1040 .LP
1041 \fBExample 7 \fRAssigning a Slot to a Domain
1042 .sp
1043 .in +2
1044 .nf
1045 # \fBcfgadm -x assign SB2\fR
1046 .fi
1047 .in -2
1048 .sp
1050 .LP
1051 \fBExample 8 \fRUnassigning a Slot from a Domain
1052 .sp
1053 .in +2
1054 .nf
1055 # \fBcfgadm -x unassign SB3\fR
1056 .fi
1057 .in -2
1058 .sp
1060 .SH ATTRIBUTES
1061 .sp
1062 .LP
1063 See \fBattributes\fR(5) for a description of the following attribute:
1064 .sp
1066 .sp
1067 .TS
1068 box;
1069 c | c
1070 l | l .
1071 ATTRIBUTE TYPE ATTRIBUTE VALUE
1072 _
1073 Stability See below.
1074 .TE
1076 .sp
1077 .LP
1078 The interface stability is evolving. The output stability is unstable.
1079 .SH SEE ALSO
1080 .sp
1081 .LP
1082 \fBcfgadm\fR(1M), \fBdevfsadm\fR(1M), \fBifconfig\fR(1M), \fBmount\fR(1M),
1083 \fBpbind\fR(1M), \fBpsradm\fR(1M), \fBpsrinfo\fR(1M),
1084 \fBconfig_admin\fR(3CFGADM), \fBattributes\fR(5)
1085 .SH NOTES
1086 .sp
1087 .LP
1088 This section contains information on how to monitor the progress of a memory
1089 delete operation. It also contains platform specific information.
1090 .SS "Memory Delete Monitoring"
1091 .sp
1092 .LP
1093 The following shell script can be used to monitor the progress of a memory
1094 delete operation.
1095 .sp
1096 .in +2
1097 .nf
1098 # \fBcfgadm -c unconfigure -y SB0::memory &\fR
1099 # \fBwatch_memdel SB0\fR
1101 #!/bin/sh
1102 # This is the watch_memdel script.
1104 if [ -z "$1" ]; then
1105 printf "usage: %s board_id\en" `basename $0`
1106 exit 1
1107 fi
1109 board_id=$1
1111 cfgadm_info='cfgadm -s noheadings,cols=info -o parsable'
1113 eval `$cfgadm_info $board_id::memory`
1115 if [ -z "$remaining" ]; then
1116 echo no memory delete in progress involving $board_id
1117 exit 0
1118 fi
1120 echo deleting target $target
1122 while true
1123 do
1124 eval `$cfgadm_info $board_id::memory`
1126 if [ -n "$remaining" -a "$remaining" -ne 0 ]
1127 then
1128 echo $deleted KBytes deleted, $remaining KBytes remaining
1129 remaining=
1130 else
1131 echo memory delete is done
1132 exit 0
1133 fi
1134 sleep 1
1135 done
1136 exit 0
1137 .fi
1138 .in -2
1139 .sp
1141 .SS "Sun Enterprise 10000 Platform Notes"
1142 .sp
1143 .LP
1144 The following syntax is used to refer to Platform Notes attachment points on
1145 the Sun Enterprise 10000 system:
1146 .sp
1147 .in +2
1148 .nf
1149 \fIboard\fR::\fIcomponent\fR
1150 .fi
1151 .in -2
1152 .sp
1154 .sp
1155 .LP
1156 where \fIboard\fR refers to the system board; and \fIcomponent\fR refers to
1157 the individual component. System boards can range from \fBSB0\fR (zero) to
1158 \fBSB15\fR. A maximum of sixteen system boards are available.
1159 .sp
1160 .LP
1161 The DR 3.0 model running on a Sun Enterprise 10000 domain supports a limited
1162 subset of the functionality provided by the \fBcfgadm_sbd\fR plugin. The only
1163 supported operation is to view the status of attachment points in the domain.
1164 This corresponds to the \fB-l\fR option and all of its associated options.
1165 .sp
1166 .LP
1167 Attempting to perform any other operation from the domain will result in an
1168 error that states that the operation is not supported. All operations to add or
1169 remove a system board must be initiated from the System Service Processor.
1170 .SS "Sun Fire High-End System Platform Notes"
1171 .sp
1172 .LP
1173 The following syntax is used to refer to attachment points on the Sun Fire
1174 high-end systems:
1175 .sp
1176 .in +2
1177 .nf
1178 \fIboard\fR::\fIcomponent\fR
1179 .fi
1180 .in -2
1181 .sp
1183 .sp
1184 .LP
1185 where \fIboard\fR refers to the system board or I/O board; and \fIcomponent\fR
1186 refers to the individual component.
1187 .sp
1188 .LP
1189 Depending on the system's configuration, system boards can range from \fBSB0\fR
1190 (zero) through \fBSB17\fR, and I/O boards can range from \fBIO0\fR (IO zero)
1191 through \fBIO17\fR. (A maximum of eighteen system and I/O boards are
1192 available).
1193 .sp
1194 .LP
1195 The \fB-t\fR and \fB-x\fR options behave differently on the Sun Fire high-end
1196 system platforms. The following list describes their behavior:
1197 .sp
1198 .ne 2
1199 .na
1200 \fB\fB-t\fR\fR
1201 .ad
1202 .RS 24n
1203 The system controller uses a CPU to test system boards by running \fBLPOST\fR,
1204 sequenced by the \fBhpost\fR command. To test I/O boards, the driver starts the
1205 testing in response to the \fB-t\fR option, and the test runs automatically
1206 without user intervention. The driver unconfigures a CPU and a stretch of
1207 contiguous physical memory. Then, it sends a command to the system controller
1208 to test the board. The system controller uses the CPU and memory to test the
1209 I/O board from inside of a transaction/error cage. You can only use CPUs from
1210 system boards (not MCPU boards) to test I/O boards.
1211 .RE
1213 .sp
1214 .ne 2
1215 .na
1216 \fB\fB-x\fR \fBassign | unassign\fR\fR
1217 .ad
1218 .RS 24n
1219 In the Sun Fire high-end system administration model, the platform
1220 administrator controls the platform hardware through the use of an available
1221 component list for each domain. This information is maintained on the system
1222 controller. Only the platform administrator can modify the available component
1223 list for a domain.
1224 .sp
1225 The domain administrator is only allowed to assign or unassign a board if it is
1226 in the available component list for that domain. The platform administrator
1227 does not have this restriction, and can assign or unassign a board even if it
1228 is not in the available component list for a domain.
1229 .RE
1231 .SS "Sun Fire 15K Component Types"
1232 .sp
1233 .LP
1234 The following are the names and descriptions of the component types:
1235 .sp
1236 .ne 2
1237 .na
1238 \fB\fBcpu\fR\fR
1239 .ad
1240 .RS 10n
1241 \fBCPU\fR
1242 .RE
1244 .sp
1245 .ne 2
1246 .na
1247 \fB\fBio\fR\fR
1248 .ad
1249 .RS 10n
1250 \fBI/O\fR device
1251 .RE
1253 .sp
1254 .ne 2
1255 .na
1256 \fB\fBmemory\fR\fR
1257 .ad
1258 .RS 10n
1259 Memory
1260 .RE
1262 .sp
1263 .LP
1264 \fBNote:\fR An operation on a memory component affects all of the memory
1265 components on the board.
1266 .SS "Sun Fire Midrange Systems Platform Notes"
1267 .sp
1268 .LP
1269 References to attachment points are slightly different on Sun Fire midrange
1270 servers such as the 6800, 4810, 4800, and 3800 systems than on the Sun Fire
1271 high-end systems. The following syntax is used to refer to attachment points on
1272 Sun Fire systems other than the Sun Fire 15K:
1273 .sp
1274 .in +2
1275 .nf
1276 N#.\fIboard\fR::\fIcomponent\fR
1277 .fi
1278 .in -2
1279 .sp
1281 .sp
1282 .LP
1283 where \fBN#\fR refers to the node; \fIboard\fR refers to the system board or
1284 I/O board; and \fIcomponent\fR refers to the individual component.
1285 .sp
1286 .LP
1287 Depending on the system's configuration, system boards can range from \fBSB0\fR
1288 through \fBSB5\fR, and I/O boards can range from \fBIB6\fR through \fBIB9\fR.
1289 (A maximum of six system and four I/O boards are available).
1290 .SS "Sun Fire Midrange System Component Types"
1291 .sp
1292 .LP
1293 The following are the names and descriptions of the component types:
1294 .sp
1295 .ne 2
1296 .na
1297 \fB\fBcpu\fR\fR
1298 .ad
1299 .RS 10n
1300 \fBCPU\fR
1301 .RE
1303 .sp
1304 .ne 2
1305 .na
1306 \fB\fBpci\fR\fR
1307 .ad
1308 .RS 10n
1309 \fBI/O\fR device
1310 .RE
1312 .sp
1313 .ne 2
1314 .na
1315 \fB\fBmemory\fR\fR
1316 .ad
1317 .RS 10n
1318 Memory
1319 .RE
1321 .sp
1322 .LP
1323 \fBNote:\fR An operation on a memory component affects all of the memory
1324 components on the board.