6324 Add an `ndp' tool for manipulating the neighbors table
[illumos-gate.git] / usr / src / man / man1m / sasinfo.1m
blob739d98ee84e028493b26eb39530b2d76427efe63
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 1M "Jul 10, 2009"
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 .sp
47 .LP
48 The \fBsasinfo\fR utility is a command line interface that collects
49 administrative information on Serial Attached SCSI-2 (SAS-2) host bus adapter
50 (HBA) that supports the Storage Management HBA API (SM-HBA). The utility
51 reports attributes of HBA ports and of expander devices and SCSI target devices
52 that might be connected to those HBA ports.
53 .sp
54 .LP
55 \fBsasinfo\fR is implemented as a set of subcommands, described below.
56 .SH SUB-COMMANDS
57 .sp
58 .LP
59 The following subcommands are supported by \fBsasinfo\fR.
60 .sp
61 .ne 2
62 .na
63 \fB\fBhba\fR\fR
64 .ad
65 .sp .6
66 .RS 4n
67 Lists information for the HBA referenced by the specified \fIHBA_name\fR.  If
68 \fIHBA_name\fR is not specified, all HBAs on the host will be listed.
69 .RE
71 .sp
72 .ne 2
73 .na
74 \fB\fBhba-port\fR\fR
75 .ad
76 .sp .6
77 .RS 4n
78 Lists information for the HBA port referenced by the specified
79 \fIHBA_port_Name\fR.  If \fIHBA_port_Name\fR is not specified, all HBA ports on
80 the host will be listed. Note that HBA ports can be dynamically
81 configured/unconfigured so that the number of HBA ports on an HBA can change as
82 connections to target devices are established. With no connections to a storage
83 device, no HBA port is configured.
84 .RE
86 .sp
87 .ne 2
88 .na
89 \fB\fBexpander\fR\fR
90 .ad
91 .sp .6
92 .RS 4n
93 Lists hierarchical view of the expander referenced by the specified
94 \fIExpander_SAS_Addr\fR. If no argument is specified, all expanders that are
95 visible across all HBA ports on the host will be listed.
96 .RE
98 .sp
99 .ne 2
101 \fB\fBtarget-port\fR\fR
103 .sp .6
104 .RS 4n
105 Lists information for those target ports referenced by
106 \fITarget_port_SAS_Addr\fR address. If no argument is specified, all target
107 ports that are visible on the host will be listed.
111 .ne 2
113 \fB\fBlogical-unit\fR | \fBlu\fR\fR
115 .sp .6
116 .RS 4n
117 Lists the logical unit referenced by the specified \fIdevice_path\fR. If
118 \fIdevice_path\fR is not specified, all SAS logical units will be listed,
119 including the SAS Management Protocol (SMP) target port.
122 .SH OPTIONS
125 The following options are supported.
127 .ne 2
129 \fB\fB-?\fR, \fB--help\fR\fR
131 .sp .6
132 .RS 4n
133 Displays usage information
137 .ne 2
139 \fB\fB-a\fR, \fB--hba\fR \fIHBA_Name\fR\fR
141 .sp .6
142 .RS 4n
143 Retrieve HBA port information from the \fIHBA_Name\fR of an HBA on the host.
144 The \fB-a\fR option can only be used with the \fBhba-port\fR subcommand.
148 .ne 2
150 \fB\fB-l\fR, \fB--phy-linkstat\fR\fR
152 .sp .6
153 .RS 4n
154 Lists the link error statistics information for the \fBphy\fRs on the HBA port
155 referenced by the specified \fIHBA_port_Name\fR or all HBA ports if no HBA port
156 is specified. This option is used only with the \fBhba-port\fR subcommand.
160 .ne 2
162 \fB\fB-p\fR \fIHBA_port_SAS_Addr\fR, \fB--port\fR \fIHBA_port_SAS_Addr\fR\fR
164 .sp .6
165 .RS 4n
166 Retrieve remote port information from the \fIHBA_port_SAS_Addr\fR of the local
167 HBA port on the host. The \fB-p\fR option can be used only with the
168 \fBexpander\fR subcommand.
172 .ne 2
174 \fB\fB-s\fR, \fB--scsi\fR\fR
176 .sp .6
177 .RS 4n
178 Lists SCSI attributes for target ports that are requested for display. This
179 option is only used for the \fBtarget-port\fR subcommand.
183 .ne 2
185 \fB\fB-v\fR, \fB--verbose\fR\fR
187 .sp .6
188 .RS 4n
189 Display details on hardware information, such as SAS address, topology device,
190 and so forth, based on which subcommand is invoked.
194 .ne 2
196 \fB\fB-V\fR, \fB--version\fR\fR
198 .sp .6
199 .RS 4n
200 Displays the version information.
204 .ne 2
206 \fB\fB-y\fR, \fB--phy\fR\fR
208 .sp .6
209 .RS 4n
210 Lists the \fBphy\fR information on the HBA port specified by
211 \fIHBA_port_Name\fR or all HBA ports if no HBA port is specified. This option
212 is used only with the \fBhba-port\fR subcommand.
215 .SH EXAMPLES
217 \fBExample 1 \fRListing All HBAs
220 The following command lists all HBAs on the host.
223 .in +2
225 # \fBsasinfo hba\fR
226 HBA Name: SUNW-pmcs-0
227 HBA Name: SUNW-pmcs-1
229 .in -2
233 \fBExample 2 \fRListing All HBAs with Details
236 The following command lists all HBAs on the host, along with related details.
237 Note that each HBA has two HBA ports configured, with each HBA port connected
238 to a storage device.
241 .in +2
243 # \fBsasinfo hba -v\fR
244 HBA Name: SUNW-pmcs-0
245     Manufacturer: sun
246     Model: SAS Gen-2
247     Firmware Version: 1.1
248     FCode/BIOS Version: 1.1
249     Serial Number: 111-11111
250     Driver Name: smvsl
251     Driver Version: 1.1
252     Number of HBA Ports: 2
253 HBA Name: SUNW-pmcs-1
254     Manufacturer: sun
255     Model: SAS Gen-2
256     Firmware Version: 1.1
257     FCode/BIOS Version: 1.1
258     Serial Number: 111-11111
259     Driver Name: smvsl
260     Driver Version: 1.1
261     Number of HBA Ports: 2
263 .in -2
267 \fBExample 3 \fRListing All HBA Ports
270 The following command lists all HBA ports on the host.
273 .in +2
275 # \fBsasinfo hba-port\fR
276 HBA Name: SUNW-pmcs-0
277     HBA Port Name: /dev/cfg/c1
278     HBA Port Name: /dev/cfg/c2
279 HBA Name: SUNW-pmcs-1
280     HBA Port Name: /dev/cfg/c3
281     HBA Port Name: /dev/cfg/c4
283 .in -2
287 \fBExample 4 \fRListing all HBA Ports with Details
290 The following command lists all HBA ports, with accompanying details.
293 .in +2
295 # \fBsasinfo hba-port -v\fR
296 HBA Name: SUNW-pmcs-0
297     HBA Port Name: /dev/cfg/c1
298         Type: sas-device
299         State: online
300         Local SAS Address: 5000c50000d756aa
301         Attached Port SAS Address: 50800201a5a502bf
302         Number of Phys: 4
303     HBA Port Name: /dev/cfg/c25000c50000d756cc
304         Type: sas-device
305         State: online
306         Local SAS Address: 5000c50000d756aa
307         Attached Port SAS Address: 50800201a5a503bf
308         Number of Phys: 4
309 HBA Name: SUNW-pmcs-1
310     HBA Port Name: /dev/cfg/c3
311         Type: sas-device
312         State: online
313         Local SAS Address: 5000c50000d756cc
314         Attached Port SAS Address: 50800201a5a504bf
315         Number of Phys: 4
316     HBA Port Name: /dev/cfg/c4
317         Type: sas-device
318         State: online
319         Local SAS Address: 5000c50000d756cc
320         Attached Port SAS Address: 50800201a5a505bf
321         Number of Phys: 4
323 .in -2
327 \fBExample 5 \fRListing \fBphy\fR Information for All HBA Ports
330 The following command lists \fBphy\fR information for all HBA ports.
333 .in +2
335 # \fBsasinfo hba-port -y\fR
336 HBA Name: SUNW-pmcs-0
337     HBA Port Name: /dev/cfg/c1
338         Phy Information:
339          Identifier: 0
340            State: enabled
341            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
342            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
343            NegotiatedLinkRate: 3Gbit
344          Identifier: 1
345            State: enabled
346            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
347            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
348            NegotiatedLinkRate: 3Gbit
349          Identifier: 2
350            State: enabled
351            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
352            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
353            NegotiatedLinkRate: 3Gbit
354          Identifier: 3
355            State: enabled
356            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
357            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
358            NegotiatedLinkRate: 3Gbit
359     HBA Port Name: /dev/cfg/c2
360         Phy Information:
361          Identifier: 4
362            State: enabled
363            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
364            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
365            NegotiatedLinkRate: 3Gbit
366          Identifier: 5
367            State: enabled
368            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
369            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
370            NegotiatedLinkRate: 3Gbit
371         Identifier: 6
372            State: enabled
373            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
374            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
375            NegotiatedLinkRate: 3Gbit
376         Identifier: 7
377            State: enabled
378            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
379            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
380            NegotiatedLinkRate: 3Gbit
381 HBA Name: SUNW-pmcs-1
382     HBA Port Name: /dev/cfg/c3
383         Phy Information:
384          Identifier: 0
385            State: enabled
386            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
387            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
388            NegotiatedLinkRate: 3Gbit
389          Identifier: 1
390            State: enabled
391            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
392            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
393            NegotiatedLinkRate: 3Gbit
394          Identifier: 2
395            State: enabled
396            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
397            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
398            NegotiatedLinkRate: 3Gbit
399          Identifier: 3
400            State: enabled
401            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
402            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
403            NegotiatedLinkRate: 3Gbit
404     HBA Port Name: /dev/cfg/c4
405         Phy Information:
406          Identifier: 4
407            State: enabled
408            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
409            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
410            NegotiatedLinkRate: 3Gbit
411          Identifier: 5
412            State: enabled
413            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
414            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
415            NegotiatedLinkRate: 3Gbit
416          Identifier: 6
417            State: enabled
418            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
419            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
420            NegotiatedLinkRate: 3Gbit
421          Identifier: 7
422            State: enabled
423            HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
424            ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
425            NegotiatedLinkRate: 3Gbit
427 .in -2
431 \fBExample 6 \fRListing \fBphy\fR Link Error Statistics for a Specific HBA Port
434 The following command lists \fBphy\fR link error statistics for a particular
435 port.
438 .in +2
440 # \fBsasinfo hba-port -ly /dev/cfg/c1\fR
441 HBA Name: SUNW-pmcs-0
442   HBA Port Name: /dev/cfg/c1
443     Phy Information:
444       Identifier: 0
445        State: enabled
446          HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
447          ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
448          NegotiatedLinkRate: 3Gbit
449          Link Error Statistics:
450            Invalid Dword: 0
451            Running Disparity Error: 0
452            Loss of Dword Sync: 0
453            Reset Problem: 0
454       Identifier: 1
455          State: enabled
456          HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
457          ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
458          NegotiatedLinkRate: 3Gbit
459          Link Error Statistics:
460            Invalid Dword: 0
461            Running Disparity Error: 0
462            Loss of Dword Sync: 0
463            Reset Problem: 0
464        Identifier: 2
465           State: enabled
466           HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
467           ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
468           NegotiatedLinkRate: 3Gbit
469           Link Error Statistics:
470             Invalid Dword: 0
471             Running Disparity Error: 0
472             Loss of Dword Sync: 0
473             Reset Problem: 0
474        Identifier: 3
475           State: enabled
476           HardwareLinkRate(Min/Max): 1.5Gbit/3Gbit
477           ProgrammedLinkRate(Min/Max): 1.5Gbit/3Gbit
478           NegotiatedLinkRate: 3Gbit
479           Link Error Statistics:
480             Invalid Dword: 0
481             Running Disparity Error: 0
482             Loss of Dword Sync: 0
483             Reset Problem: 0
485 .in -2
489 \fBExample 7 \fRListing Expanders Connected to an HBA Port
492 The following command lists all expanders that are visible through the
493 specified HBA port.
496 .in +2
498 # \fBsasinfo expander -p /dev/cfg/c1\fR
499 HBA Name: SUNW-pmcs-0
500   HBA Port Name: /dev/cfg/c1
501     Expander SAS Address(Tier 1): 50800201a5a502bf
502        Expander SAS Address(Tier 2): 50800201a5a50233
503        Expander SAS Address(Tier 2); 5000c5000d2da812
504     Expander SAS Address(Tier 1): 50800201a5a503bf
505        Expander SAS Address(Tier 2): 50800201a5a502d2
506        Expander SAS Address(Tier 2); 5000c5000d2da823
508 .in -2
512 \fBExample 8 \fRListing Detailed Information on Expanders
515 The following command lists detailed information on all expanders that are
516 visible through the specified HBA port.
519 .in +2
521 # \fBsasinfo expander -v -p /dev/cfg/c1\fR
522 HBA Name: SUNW-pmcs-0
523   HBA Port Name: /dev/cfg/c1
524     Expander SAS Address(Tier 1): 50800201a5a502bf
525       OS Device Name: /dev/smp/expd0
526       State: online
527         Expander SAS Address(Tier 2): 50800201a5a50233
528           OS Device Name: /dev/smp/expd2
529           State: online
530         Expander SAS Address(Tier 2); 5000c5000d2da812
531           OS Device Name: /dev/smp/expd3
532           State: online
533     Expander SAS Address(Tier 1): 50800201a5a503bf
534       OS Device Name: /dev/smp/expd1
535       State: online
536         Expander SAS Address(Tier 2): 50800201a5a502d2
537           OS Device Name: /dev/smp/expd3
538           State: online
539         Expander SAS Address(Tier 2); 5000c5000d2da823
540           OS Device Name: /dev/smp/expd4
541           State: online
543 .in -2
547 \fBExample 9 \fRListing Target Ports Attached to Expanders
550 The following command lists all target ports that are attached to expanders
551 connected to a specified HBA port.
554 .in +2
556 # \fBsasinfo expander -t -p /dev/cfg/c1\fR
557 HBA Name: SUNW-pmcs-0
558   HBA Port Name: /dev/cfg/c1
559      Expander SAS Address(Tier 1): 50800201a5a502bf
560        Target Port SAS Address: 50800201a5a504f1
561           Expander SAS Address(Tier 2): 50800201a5a50233
562             Target Port SAS Address: 50800201a5a502be
563             Target Port SAS Address: 5000c5000d2da8b2
564           Expander SAS Address(Tier 2); 5000c5000d2da812
565             Target Port SAS Address: 50800201a5a502be
566             Target Port SAS Address: 50800201a5a508b2
567      Expander SAS Address(Tier 1): 50800201a5a503bf
568        Target Port SAS Address: 50800201a5a50421
569           Expander SAS Address(Tier 2): 50800201a5a502d2
570             Target Port SAS Address: 50800201a5a503be
571             Target Port SAS Address: 5000c5000d2da7be
572           Expander SAS Address(Tier 2); 5000c5000d2da823
573             Target Port SAS Address: 50800201a5a503be
574             Target Port SAS Address: 5000c5000d2da7be
576 .in -2
580 \fBExample 10 \fRListing Target Port Information
583 The following command lists all target ports discovered on the host.
586 .in +2
588 # \fBsasinfo target-port\fR
589 Target Port SAS Address: 5000c5000bae4009
590 Target Port SAS Address: 5000c5000baef4b1
591 Target Port SAS Address: 5000c5000bae3fe1
592 Target Port SAS Address: 5000c5000bae49d9
593 Target Port SAS Address: 5000c5000bae36c5
595 .in -2
599 \fBExample 11 \fRListing Target Port Information with Topology Details
602 The following command lists all target ports with the HBA port and expander
603 that they are connected to.
606 .in +2
608 # \fBsasinfo target-port -v\fR
609 Target Port SAS Address: 5000c5000bae4009
610   Type: SAS Device
611   HBA Port Name: /dev/cfg/c7
612     Expander Device SAS Address: 500e004aaaaaaa3f
613   HBA Port Name: /dev/cfg/c5
614     Expander Device SAS Address: 500e004aaaaaaa3f
615 Target Port SAS Address: 5000c5000baef4b1
616   Type: SAS Device
617   HBA Port Name: /dev/cfg/c7
618     Expander Device SAS Address: 500e004aaaaaaa3f
619   HBA Port Name: /dev/cfg/c5
620     Expander Device SAS Address: 500e004aaaaaaa3f
621 Target Port SAS Address: 5000c5000bae3fe1
622   Type: SAS Device
623   HBA Port Name: /dev/cfg/c7
624     Expander Device SAS Address: 500e004aaaaaaa3f
625   HBA Port Name: /dev/cfg/c5
626     Expander Device SAS Address: 500e004aaaaaaa3f
627 Target Port SAS Address: 5000c5000bae49d9
628   Type: SAS Device
629   HBA Port Name: /dev/cfg/c7
630     Expander Device SAS Address: 500e004aaaaaaa3f
631   HBA Port Name: /dev/cfg/c5
632     Expander Device SAS Address: 500e004aaaaaaa3f
633 Target Port SAS Address: 5000c5000bae36c5
634   Type: SAS Device
635   HBA Port Name: /dev/cfg/c7
636     Expander Device SAS Address: 500e004aaaaaaa3f
637   HBA Port Name: /dev/cfg/c5
638     Expander Device SAS Address: 500e004aaaaaaa3f
640 .in -2
644 \fBExample 12 \fRListing Target Ports with SCSI Information
647 The following command lists all target port details, including SCSI information
648 for each target port.
651 .in +2
653 # \fBsasinfo target-port -s 5000c5000bae4009\fR
654 Target Port SAS Address: 5000c5000bae4009
655    Type: SAS Device
656         HBA Port Name: /dev/cfg/c7
657             Expander Device SAS Address: 500e004aaaaaaa3f
658                 LUN : 0
659                   OS Device Name : /dev/rdsk/c6t5000C5000BAE400Bd0s2
660                   Vendor:   Sun
661                   Product:  J4400
662                   Device Type: Disk
663         HBA Port Name: /dev/cfg/c5
664             Expander Device SAS Address: 500e004aaaaaaa3f
665                 LUN : 0
666                   OS Device Name : /dev/rdsk/c6t5000C5000BAE400Bd0s2
667                   Vendor:   Sun
668                   Product:  J4400
669                   Device Type: Disk
671 .in -2
675 \fBExample 13 \fRListing the Logical Units
678 The following command lists the logical units on a host.
681 .in +2
683 # \fBsasinfo logical-unit\fR
684 OS Device Name: /dev/rdsk/c4t50020F2300B4904Ed0s2
685 OS Device Name: /dev/rdsk/c4t50020F230000B4AFd0s2
687 .in -2
691 \fBExample 14 \fRListing Additional Information on Logical Units
694 The following command displays additional logical unit  information using the
695 \fB-v\fR option for device \fB/dev/rmt/On\fR.
698 .in +2
700 # \fBsasinfo lu -v\fR
701 OS Device Name: /dev/rdsk/c4t50020F2300B4904Ed0s2
702    HBA Port Name: /dev/cfg/c1
703      Target Port SAS Address: 50020f2300b4904e
704         LUN: 0
705    Vendor: Sun
706    Product: J4400
707    Device Type: Disk
708 OS Device Name: /dev/rdsk/c4t50020F230000B4AFd0s2
709    HBA Port Name: /dev/cfg/c1
710      Target Port SAS Address: 50020f230063100b
711         LUN: 0
712    Vendor: Sun
713    Product: J4400
714    Device Type: Disk
716 .in -2
719 .SH ATTRIBUTES
722 See \fBattributes\fR(5) for descriptions of the following attributes:
727 box;
728 c | c
729 l | l .
730 ATTRIBUTE TYPE  ATTRIBUTE VALUE
732 Interface Stability     Committed
735 .SH SEE ALSO
738 \fBattributes\fR(5)