Move everything from /var/adm to /var/log
[unleashed.git] / share / man / man8 / sasinfo.8
blobe2ff250e10db5a36f2a9f59dcb96eaf7cbe69fcb
1 '\" te
2 .\" Copyright (c) 2009, 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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
4 .\"  See the License for the specific language governing permissions and limitations under the License. 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
5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH SASINFO 8 "April 9, 2016"
7 .SH NAME
8 sasinfo \- Serial Attached SCSI HBA port command line interface
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBsasinfo\fR hba [\fB-v\fR] [\fIHBA_Name\fR]...
13 .fi
15 .LP
16 .nf
17 \fBsasinfo\fR hba-port [\fB-lvy\fR] [\fB-a\fR \fIHBA_Name\fR] [\fIHBA_port_nam\fR]...
18 .fi
20 .LP
21 .nf
22 \fBsasinfo\fR expander [\fB-vt\fR] [\fB-p\fR \fIHBA_port_Name\fR] [\fIExpander_SAS_Addr\fR]...
23 .fi
25 .LP
26 .nf
27 \fBsasinfo\fR target-port [\fB-s\fR | \fB-v\fR] [\fITarget_port_SAS_Addr\fR]...
28 .fi
30 .LP
31 .nf
32 \fBsasinfo\fR logical-unit | lu [\fB-v\fR] [\fIdevice_path\fR]...
33 .fi
35 .LP
36 .nf
37 \fBsasinfo\fR [\fB-V\fR]
38 .fi
40 .LP
41 .nf
42 \fBsasinfo\fR [\fB-?\fR]
43 .fi
45 .SH DESCRIPTION
46 .LP
47 The \fBsasinfo\fR utility is a command line interface that collects
48 administrative information on Serial Attached SCSI-2 (SAS-2) host bus adapter
49 (HBA) that supports the Storage Management HBA API (SM-HBA). The utility
50 reports attributes of HBA ports and of expander devices and SCSI target devices
51 that might be connected to those HBA ports.
52 .sp
53 .LP
54 \fBsasinfo\fR is implemented as a set of subcommands, described below.
55 .SH SUBCOMMANDS
56 .LP
57 The following subcommands are supported by \fBsasinfo\fR.
58 .sp
59 .ne 2
60 .na
61 \fB\fBhba\fR\fR
62 .ad
63 .sp .6
64 .RS 4n
65 Lists information for the HBA referenced by the specified \fIHBA_name\fR.  If
66 \fIHBA_name\fR is not specified, all HBAs on the host will be listed.
67 .RE
69 .sp
70 .ne 2
71 .na
72 \fB\fBhba-port\fR\fR
73 .ad
74 .sp .6
75 .RS 4n
76 Lists information for the HBA port referenced by the specified
77 \fIHBA_port_Name\fR.  If \fIHBA_port_Name\fR is not specified, all HBA ports on
78 the host will be listed. Note that HBA ports can be dynamically
79 configured/unconfigured so that the number of HBA ports on an HBA can change as
80 connections to target devices are established. With no connections to a storage
81 device, no HBA port is configured.
82 .RE
84 .sp
85 .ne 2
86 .na
87 \fB\fBexpander\fR\fR
88 .ad
89 .sp .6
90 .RS 4n
91 Lists hierarchical view of the expander referenced by the specified
92 \fIExpander_SAS_Addr\fR. If no argument is specified, all expanders that are
93 visible across all HBA ports on the host will be listed.
94 .RE
96 .sp
97 .ne 2
98 .na
99 \fB\fBtarget-port\fR\fR
101 .sp .6
102 .RS 4n
103 Lists information for those target ports referenced by
104 \fITarget_port_SAS_Addr\fR address. If no argument is specified, all target
105 ports that are visible on the host will be listed.
109 .ne 2
111 \fB\fBlogical-unit\fR | \fBlu\fR\fR
113 .sp .6
114 .RS 4n
115 Lists the logical unit referenced by the specified \fIdevice_path\fR. If
116 \fIdevice_path\fR is not specified, all SAS logical units will be listed,
117 including the SAS Management Protocol (SMP) target port.
120 .SH OPTIONS
122 The following options are supported.
124 .ne 2
126 \fB\fB-?\fR, \fB--help\fR\fR
128 .sp .6
129 .RS 4n
130 Displays usage information
134 .ne 2
136 \fB\fB-a\fR, \fB--hba\fR \fIHBA_Name\fR\fR
138 .sp .6
139 .RS 4n
140 Retrieve HBA port information from the \fIHBA_Name\fR of an HBA on the host.
141 The \fB-a\fR option can only be used with the \fBhba-port\fR subcommand.
145 .ne 2
147 \fB\fB-l\fR, \fB--phy-linkstat\fR\fR
149 .sp .6
150 .RS 4n
151 Lists the link error statistics information for the \fBphy\fRs on the HBA port
152 referenced by the specified \fIHBA_port_Name\fR or all HBA ports if no HBA port
153 is specified. This option is used only with the \fBhba-port\fR subcommand.
157 .ne 2
159 \fB\fB-p\fR \fIHBA_port_SAS_Addr\fR, \fB--port\fR \fIHBA_port_SAS_Addr\fR\fR
161 .sp .6
162 .RS 4n
163 Retrieve remote port information from the \fIHBA_port_SAS_Addr\fR of the local
164 HBA port on the host. The \fB-p\fR option can be used only with the
165 \fBexpander\fR subcommand.
169 .ne 2
171 \fB\fB-s\fR, \fB--scsi\fR\fR
173 .sp .6
174 .RS 4n
175 Lists SCSI attributes for target ports that are requested for display. This
176 option is only used for the \fBtarget-port\fR subcommand.
180 .ne 2
182 \fB\fB-v\fR, \fB--verbose\fR\fR
184 .sp .6
185 .RS 4n
186 Display details on hardware information, such as SAS address, topology device,
187 and so forth, based on which subcommand is invoked.
191 .ne 2
193 \fB\fB-V\fR, \fB--version\fR\fR
195 .sp .6
196 .RS 4n
197 Displays the version information.
201 .ne 2
203 \fB\fB-y\fR, \fB--phy\fR\fR
205 .sp .6
206 .RS 4n
207 Lists the \fBphy\fR information on the HBA port specified by
208 \fIHBA_port_Name\fR or all HBA ports if no HBA port is specified. This option
209 is used only with the \fBhba-port\fR subcommand.
212 .SH EXAMPLES
214 \fBExample 1 \fRListing All HBAs
217 The following command lists all HBAs on the host.
220 .in +2
222 # \fBsasinfo hba\fR
223 HBA Name: SUNW-pmcs-0
224 HBA Name: SUNW-pmcs-1
226 .in -2
230 \fBExample 2 \fRListing All HBAs with Details
233 The following command lists all HBAs on the host, along with related details.
234 Note that each HBA has two HBA ports configured, with each HBA port connected
235 to a storage device.
238 .in +2
240 # \fBsasinfo hba -v\fR
241 HBA Name: SUNW-pmcs-0
242     Manufacturer: sun
243     Model: SAS Gen-2
244     Firmware Version: 1.1
245     FCode/BIOS Version: 1.1
246     Serial Number: 111-11111
247     Driver Name: smvsl
248     Driver Version: 1.1
249     Number of HBA Ports: 2
250 HBA Name: SUNW-pmcs-1
251     Manufacturer: sun
252     Model: SAS Gen-2
253     Firmware Version: 1.1
254     FCode/BIOS Version: 1.1
255     Serial Number: 111-11111
256     Driver Name: smvsl
257     Driver Version: 1.1
258     Number of HBA Ports: 2
260 .in -2
264 \fBExample 3 \fRListing All HBA Ports
267 The following command lists all HBA ports on the host.
270 .in +2
272 # \fBsasinfo hba-port\fR
273 HBA Name: SUNW-pmcs-0
274     HBA Port Name: /dev/cfg/c1
275     HBA Port Name: /dev/cfg/c2
276 HBA Name: SUNW-pmcs-1
277     HBA Port Name: /dev/cfg/c3
278     HBA Port Name: /dev/cfg/c4
280 .in -2
284 \fBExample 4 \fRListing all HBA Ports with Details
287 The following command lists all HBA ports, with accompanying details.
290 .in +2
292 # \fBsasinfo hba-port -v\fR
293 HBA Name: SUNW-pmcs-0
294     HBA Port Name: /dev/cfg/c1
295         Type: sas-device
296         State: online
297         Local SAS Address: 5000c50000d756aa
298         Attached Port SAS Address: 50800201a5a502bf
299         Number of Phys: 4
300     HBA Port Name: /dev/cfg/c25000c50000d756cc
301         Type: sas-device
302         State: online
303         Local SAS Address: 5000c50000d756aa
304         Attached Port SAS Address: 50800201a5a503bf
305         Number of Phys: 4
306 HBA Name: SUNW-pmcs-1
307     HBA Port Name: /dev/cfg/c3
308         Type: sas-device
309         State: online
310         Local SAS Address: 5000c50000d756cc
311         Attached Port SAS Address: 50800201a5a504bf
312         Number of Phys: 4
313     HBA Port Name: /dev/cfg/c4
314         Type: sas-device
315         State: online
316         Local SAS Address: 5000c50000d756cc
317         Attached Port SAS Address: 50800201a5a505bf
318         Number of Phys: 4
320 .in -2
324 \fBExample 5 \fRListing \fBphy\fR Information for All HBA Ports
327 The following command lists \fBphy\fR information for all HBA ports.
330 .in +2
332 # \fBsasinfo hba-port -y\fR
333 HBA Name: SUNW-pmcs-0
334     HBA Port Name: /dev/cfg/c1
335         Phy Information:
336          Identifier: 0
337            State: enabled
338            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
339            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
340            NegotiatedLinkRate: 3Gbit
341          Identifier: 1
342            State: enabled
343            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
344            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
345            NegotiatedLinkRate: 3Gbit
346          Identifier: 2
347            State: enabled
348            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
349            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
350            NegotiatedLinkRate: 3Gbit
351          Identifier: 3
352            State: enabled
353            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
354            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
355            NegotiatedLinkRate: 3Gbit
356     HBA Port Name: /dev/cfg/c2
357         Phy Information:
358          Identifier: 4
359            State: enabled
360            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
361            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
362            NegotiatedLinkRate: 3Gbit
363          Identifier: 5
364            State: enabled
365            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
366            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
367            NegotiatedLinkRate: 3Gbit
368         Identifier: 6
369            State: enabled
370            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
371            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
372            NegotiatedLinkRate: 3Gbit
373         Identifier: 7
374            State: enabled
375            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
376            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
377            NegotiatedLinkRate: 3Gbit
378 HBA Name: SUNW-pmcs-1
379     HBA Port Name: /dev/cfg/c3
380         Phy Information:
381          Identifier: 0
382            State: enabled
383            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
384            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
385            NegotiatedLinkRate: 3Gbit
386          Identifier: 1
387            State: enabled
388            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
389            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
390            NegotiatedLinkRate: 3Gbit
391          Identifier: 2
392            State: enabled
393            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
394            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
395            NegotiatedLinkRate: 3Gbit
396          Identifier: 3
397            State: enabled
398            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
399            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
400            NegotiatedLinkRate: 3Gbit
401     HBA Port Name: /dev/cfg/c4
402         Phy Information:
403          Identifier: 4
404            State: enabled
405            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
406            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
407            NegotiatedLinkRate: 3Gbit
408          Identifier: 5
409            State: enabled
410            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
411            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
412            NegotiatedLinkRate: 3Gbit
413          Identifier: 6
414            State: enabled
415            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
416            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
417            NegotiatedLinkRate: 3Gbit
418          Identifier: 7
419            State: enabled
420            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
421            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
422            NegotiatedLinkRate: 3Gbit
424 .in -2
428 \fBExample 6 \fRListing \fBphy\fR Link Error Statistics for a Specific HBA Port
431 The following command lists \fBphy\fR link error statistics for a particular
432 port.
435 .in +2
437 # \fBsasinfo hba-port -ly /dev/cfg/c1\fR
438 HBA Name: SUNW-pmcs-0
439   HBA Port Name: /dev/cfg/c1
440     Phy Information:
441       Identifier: 0
442        State: enabled
443          HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
444          ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
445          NegotiatedLinkRate: 3Gbit
446          Link Error Statistics:
447            Invalid Dword: 0
448            Running Disparity Error: 0
449            Loss of Dword Sync: 0
450            Reset Problem: 0
451       Identifier: 1
452          State: enabled
453          HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
454          ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
455          NegotiatedLinkRate: 3Gbit
456          Link Error Statistics:
457            Invalid Dword: 0
458            Running Disparity Error: 0
459            Loss of Dword Sync: 0
460            Reset Problem: 0
461        Identifier: 2
462           State: enabled
463           HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
464           ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
465           NegotiatedLinkRate: 3Gbit
466           Link Error Statistics:
467             Invalid Dword: 0
468             Running Disparity Error: 0
469             Loss of Dword Sync: 0
470             Reset Problem: 0
471        Identifier: 3
472           State: enabled
473           HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
474           ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
475           NegotiatedLinkRate: 3Gbit
476           Link Error Statistics:
477             Invalid Dword: 0
478             Running Disparity Error: 0
479             Loss of Dword Sync: 0
480             Reset Problem: 0
482 .in -2
486 \fBExample 7 \fRListing Expanders Connected to an HBA Port
489 The following command lists all expanders that are visible through the
490 specified HBA port.
493 .in +2
495 # \fBsasinfo expander -p /dev/cfg/c1\fR
496 HBA Name: SUNW-pmcs-0
497   HBA Port Name: /dev/cfg/c1
498     Expander SAS Address(Tier 1): 50800201a5a502bf
499        Expander SAS Address(Tier 2): 50800201a5a50233
500        Expander SAS Address(Tier 2); 5000c5000d2da812
501     Expander SAS Address(Tier 1): 50800201a5a503bf
502        Expander SAS Address(Tier 2): 50800201a5a502d2
503        Expander SAS Address(Tier 2); 5000c5000d2da823
505 .in -2
509 \fBExample 8 \fRListing Detailed Information on Expanders
512 The following command lists detailed information on all expanders that are
513 visible through the specified HBA port.
516 .in +2
518 # \fBsasinfo expander -v -p /dev/cfg/c1\fR
519 HBA Name: SUNW-pmcs-0
520   HBA Port Name: /dev/cfg/c1
521     Expander SAS Address(Tier 1): 50800201a5a502bf
522       OS Device Name: /dev/smp/expd0
523       State: online
524         Expander SAS Address(Tier 2): 50800201a5a50233
525           OS Device Name: /dev/smp/expd2
526           State: online
527         Expander SAS Address(Tier 2); 5000c5000d2da812
528           OS Device Name: /dev/smp/expd3
529           State: online
530     Expander SAS Address(Tier 1): 50800201a5a503bf
531       OS Device Name: /dev/smp/expd1
532       State: online
533         Expander SAS Address(Tier 2): 50800201a5a502d2
534           OS Device Name: /dev/smp/expd3
535           State: online
536         Expander SAS Address(Tier 2); 5000c5000d2da823
537           OS Device Name: /dev/smp/expd4
538           State: online
540 .in -2
544 \fBExample 9 \fRListing Target Ports Attached to Expanders
547 The following command lists all target ports that are attached to expanders
548 connected to a specified HBA port.
551 .in +2
553 # \fBsasinfo expander -t -p /dev/cfg/c1\fR
554 HBA Name: SUNW-pmcs-0
555   HBA Port Name: /dev/cfg/c1
556      Expander SAS Address(Tier 1): 50800201a5a502bf
557        Target Port SAS Address: 50800201a5a504f1
558           Expander SAS Address(Tier 2): 50800201a5a50233
559             Target Port SAS Address: 50800201a5a502be
560             Target Port SAS Address: 5000c5000d2da8b2
561           Expander SAS Address(Tier 2); 5000c5000d2da812
562             Target Port SAS Address: 50800201a5a502be
563             Target Port SAS Address: 50800201a5a508b2
564      Expander SAS Address(Tier 1): 50800201a5a503bf
565        Target Port SAS Address: 50800201a5a50421
566           Expander SAS Address(Tier 2): 50800201a5a502d2
567             Target Port SAS Address: 50800201a5a503be
568             Target Port SAS Address: 5000c5000d2da7be
569           Expander SAS Address(Tier 2); 5000c5000d2da823
570             Target Port SAS Address: 50800201a5a503be
571             Target Port SAS Address: 5000c5000d2da7be
573 .in -2
577 \fBExample 10 \fRListing Target Port Information
580 The following command lists all target ports discovered on the host.
583 .in +2
585 # \fBsasinfo target-port\fR
586 Target Port SAS Address: 5000c5000bae4009
587 Target Port SAS Address: 5000c5000baef4b1
588 Target Port SAS Address: 5000c5000bae3fe1
589 Target Port SAS Address: 5000c5000bae49d9
590 Target Port SAS Address: 5000c5000bae36c5
592 .in -2
596 \fBExample 11 \fRListing Target Port Information with Topology Details
599 The following command lists all target ports with the HBA port and expander
600 that they are connected to.
603 .in +2
605 # \fBsasinfo target-port -v\fR
606 Target Port SAS Address: 5000c5000bae4009
607   Type: SAS Device
608   HBA Port Name: /dev/cfg/c7
609     Expander Device SAS Address: 500e004aaaaaaa3f
610   HBA Port Name: /dev/cfg/c5
611     Expander Device SAS Address: 500e004aaaaaaa3f
612 Target Port SAS Address: 5000c5000baef4b1
613   Type: SAS Device
614   HBA Port Name: /dev/cfg/c7
615     Expander Device SAS Address: 500e004aaaaaaa3f
616   HBA Port Name: /dev/cfg/c5
617     Expander Device SAS Address: 500e004aaaaaaa3f
618 Target Port SAS Address: 5000c5000bae3fe1
619   Type: SAS Device
620   HBA Port Name: /dev/cfg/c7
621     Expander Device SAS Address: 500e004aaaaaaa3f
622   HBA Port Name: /dev/cfg/c5
623     Expander Device SAS Address: 500e004aaaaaaa3f
624 Target Port SAS Address: 5000c5000bae49d9
625   Type: SAS Device
626   HBA Port Name: /dev/cfg/c7
627     Expander Device SAS Address: 500e004aaaaaaa3f
628   HBA Port Name: /dev/cfg/c5
629     Expander Device SAS Address: 500e004aaaaaaa3f
630 Target Port SAS Address: 5000c5000bae36c5
631   Type: SAS Device
632   HBA Port Name: /dev/cfg/c7
633     Expander Device SAS Address: 500e004aaaaaaa3f
634   HBA Port Name: /dev/cfg/c5
635     Expander Device SAS Address: 500e004aaaaaaa3f
637 .in -2
641 \fBExample 12 \fRListing Target Ports with SCSI Information
644 The following command lists all target port details, including SCSI information
645 for each target port.
648 .in +2
650 # \fBsasinfo target-port -s 5000c5000bae4009\fR
651 Target Port SAS Address: 5000c5000bae4009
652    Type: SAS Device
653         HBA Port Name: /dev/cfg/c7
654             Expander Device SAS Address: 500e004aaaaaaa3f
655                 LUN : 0
656                   OS Device Name : /dev/rdsk/c6t5000C5000BAE400Bd0s2
657                   Vendor:   Sun
658                   Product:  J4400
659                   Device Type: Disk
660         HBA Port Name: /dev/cfg/c5
661             Expander Device SAS Address: 500e004aaaaaaa3f
662                 LUN : 0
663                   OS Device Name : /dev/rdsk/c6t5000C5000BAE400Bd0s2
664                   Vendor:   Sun
665                   Product:  J4400
666                   Device Type: Disk
668 .in -2
672 \fBExample 13 \fRListing the Logical Units
675 The following command lists the logical units on a host.
678 .in +2
680 # \fBsasinfo logical-unit\fR
681 OS Device Name: /dev/rdsk/c4t50020F2300B4904Ed0s2
682 OS Device Name: /dev/rdsk/c4t50020F230000B4AFd0s2
684 .in -2
688 \fBExample 14 \fRListing Additional Information on Logical Units
691 The following command displays additional logical unit  information using the
692 \fB-v\fR option for device \fB/dev/rmt/On\fR.
695 .in +2
697 # \fBsasinfo lu -v\fR
698 OS Device Name: /dev/rdsk/c4t50020F2300B4904Ed0s2
699    HBA Port Name: /dev/cfg/c1
700      Target Port SAS Address: 50020f2300b4904e
701         LUN: 0
702    Vendor: Sun
703    Product: J4400
704    Device Type: Disk
705 OS Device Name: /dev/rdsk/c4t50020F230000B4AFd0s2
706    HBA Port Name: /dev/cfg/c1
707      Target Port SAS Address: 50020f230063100b
708         LUN: 0
709    Vendor: Sun
710    Product: J4400
711    Device Type: Disk
713 .in -2
716 .SH ATTRIBUTES
718 See \fBattributes\fR(5) for descriptions of the following attributes:
723 box;
724 c | c
725 l | l .
726 ATTRIBUTE TYPE  ATTRIBUTE VALUE
728 Interface Stability     Committed
731 .SH SEE ALSO
733 \fBattributes\fR(5)