1 .\"
2 .\" This file and its contents are supplied under the terms of the
3 .\" Common Development and Distribution License ("CDDL"), version 1.0.
4 .\" You may only use this file in accordance with the terms of version
5 .\" 1.0 of the CDDL.
6 .\"
7 .\" A full copy of the text of the CDDL should have accompanied this
8 .\" source. A copy of the CDDL is also available via the Internet at
9 .\" http://www.illumos.org/license/CDDL.
10 .\"
11 .\" Copyright 2014 Joyent, Inc.
12 .\" Copyright 2016 Nexenta Systems, Inc.
13 .\"
14 .Dd October 06, 2017
15 .Dt DISKINFO 1M
16 .Os
17 .Sh NAME
18 .Nm diskinfo
19 .Nd provide disk device inventory and status
20 .Sh SYNOPSIS
21 .Nm
22 .Op Fl aHp
23 .Op Fl c Ns | Ns Fl P
24 .Sh DESCRIPTION
25 The diskinfo tool provides information about the disk devices in the system.
26 Because it interacts with the kernel's device management subsystem, this tool
27 can be used only from the global zone.
28 If run in any other zone, its output will be incomplete and unreliable.
29 .Pp
30 There are three main modes.
31 The default mode, when neither the
32 .Fl c
33 nor
34 .Fl P
35 option is specified, provides a basic inventory of the disk devices in the
36 system.
37 Each line describes a single device and contains the device's attachment bus or
38 fabric type, the base name of the device in the
39 .Pa /dev/dsk
40 directory, the disk's vendor and product identification strings, the size
41 .Pq storage capacity
42 of the device, whether the device is removable, and whether it is solid-state.
43 .Pp
44 The
45 .Fl P
46 option selects physical mode.
47 In this mode, each line of output likewise describes one disk device; however,
48 the fields provided indicate the base name of the device in the
49 .Pa /dev/dsk
50 directory, the disk's vendor and product identification strings, the serial
51 number of the device, whether the device is faulty as diagnosed by
52 .Xr fmd 1M ,
53 whether the locate or identification indicator is on for the device
54 .Pq if one is present ,
55 and the chassis and bay number containing the disk if known.
56 .Pp
57 The
58 .Fl c
59 option selects compact mode.
60 This mode provides all of the information provided by both the default mode and
61 physical mode in a compact format.
62 .Pp
63 See
64 .Sx OUTPUT FIELDS
65 below for a detailed description of each column.
66 .Sh OPTIONS
67 .Bl -tag -width Ds
68 .It Fl a
69 Show all disk bays, including those don't have disks installed.
70 .It Fl c
71 Select compact mode output.
72 At most one of
73 .Fl c
74 and
75 .Fl P
76 may be present on the command line.
77 .It Fl H
78 Do not print a header.
79 This provides output suitable for passing into text processing tools.
80 .It Fl P
81 Select physical mode output.
82 At most one of
83 .Fl P
84 and
85 .Fl c
86 may be present on the command line.
87 .It Fl p
88 Parsable output.
89 When
90 .Fl p
91 is selected, the size
92 .Pq storage capacity
93 is output in bytes instead of in human-readable units, and the device's location
94 .Pq if known
95 is provided as a comma-separated chassis and bay number instead of a
96 human-readable location.
97 This option may be used in any output mode and is intended for use by scripts or
98 other robotic tooling.
99 .El
100 .Sh OUTPUT FIELDS
101 .Bl -tag -width "LOCATION"
102 .It Sy DISK
103 The base name of the device node within the
104 .Pa /dev/dsk
105 directory.
106 The names of partitions and/or slices, if any, are derived from this name as
107 described by
108 .Xr prtvtoc 1M .
109 .Pp
110 This field is available in all output modes.
111 .It Sy FLRS
112 A condensed field incorporating the same information as the
113 .Sy FLT , LOC , RMV ,
114 and
115 .Sy SSD
116 fields.
117 Each field is condensed to a single character.
118 If the field is true, the first letter of the field name will appear in its
119 position in the string; otherwise, the
120 .Qq Sy -
121 character will appear instead.
122 .Pp
123 This field is available only in compact output mode.
124 .It Sy FLT
125 A boolean field indicating whether the device is faulty; specifically, whether
126 the fault indicator
127 .Pq if one is present
128 is active.
129 .Pp
130 This field is available only in physical output mode.
131 .It Sy LOC
132 A boolean field indicating whether the locate or identify indicator, if any,
133 associated with the device's bay, is active.
134 .Pp
135 This field is available only in physical output mode.
136 .It Sy LOCATION
137 The physical chassis and bay name
138 .Po or chassis and bay numbers, if
139 .Fl p
140 is given
141 .Pc
142 in which the device is located.
143 The chassis number is identified in human-readable output within
144 .Bq square brackets ;
145 chassis 0 is the host chassis itself.
146 The bay name, if any, is provided by the enclosure, typically via a SCSI
147 Enclosure Services processor.
148 .Pp
149 This field is available in compact and physical output modes.
150 .It Sy PID
151 The product identification string reported by the device.
152 .Pp
153 This field is available in all output modes.
154 .It Sy RMV
155 A boolean field indicating whether the device is removable.
156 USB storage devices, most optical drives and changers, and certain other devices
157 that report themselves as removable will be identified as such.
158 .Pp
159 This field is available only in default output mode.
160 .It Sy SERIAL
161 The serial number of the device.
162 The entire serial number is reported if the device and its drivers provide it.
163 .Pp
164 This field is available in compact and physical output modes.
165 .It Sy SIZE
166 The device's storage capacity.
167 If the
168 .Fl p
169 option is given, this is reported in bytes; otherwise, it is reported in a
170 human-readable format with units specified.
171 All units are based on powers of 2 and are expressed in SI standard notation.
172 .Pp
173 This field is available in compact and default output modes.
174 .It Sy SSD
175 A boolean field indicating whether the device is solid-state.
176 .Pp
177 This field is available only in default output mode.
178 .It Sy TYPE
179 The transport
180 .Pq fabric or bus
181 type by which the storage device is attached to the host, if known.
182 Typical transports include SCSI and USB.
183 .Pp
184 This field is available in compact and default output modes.
185 .It Sy VID
186 The vendor identification string reported by the device.
187 .Pp
188 This field is available in all output modes.
189 .El
190 .Sh SEE ALSO
191 .Xr fmd 1M ,
192 .Xr prtvtoc 1M ,
193 .Xr sd 7D