| blob | bbe7a45aa0c68af88e7a9abc2902f5451d13ec5c |
1 .\"
2 .\" CDDL HEADER START
3 .\"
4 .\" The contents of this file are subject to the terms of the
5 .\" Common Development and Distribution License (the "License").
6 .\" You may not use this file except in compliance with the License.
7 .\"
8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 .\" or https://opensource.org/licenses/CDDL-1.0.
10 .\" See the License for the specific language governing permissions
11 .\" and limitations under the License.
12 .\"
13 .\" When distributing Covered Code, include this CDDL HEADER in each
14 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 .\" If applicable, add the following below this CDDL HEADER, with the
16 .\" fields enclosed by brackets "[]" replaced with your own identifying
17 .\" information: Portions Copyright [yyyy] [name of copyright owner]
18 .\"
19 .\" CDDL HEADER END
20 .\"
21 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
22 .\" Copyright (c) 2012, 2018 by Delphix. All rights reserved.
23 .\" Copyright (c) 2012 Cyril Plisko. All Rights Reserved.
24 .\" Copyright (c) 2017 Datto Inc.
25 .\" Copyright (c) 2018 George Melikov. All Rights Reserved.
26 .\" Copyright 2017 Nexenta Systems, Inc.
27 .\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
28 .\"
29 .Dd March 16, 2022
30 .Dt ZPOOL-STATUS 8
31 .Os
32 .
33 .Sh NAME
34 .Nm zpool-status
35 .Nd show detailed health status for ZFS storage pools
36 .Sh SYNOPSIS
37 .Nm zpool
38 .Cm status
39 .Op Fl DegiLpPstvx
40 .Op Fl T Sy u Ns | Ns Sy d
41 .Op Fl c Op Ar SCRIPT1 Ns Oo , Ns Ar SCRIPT2 Oc Ns …
42 .Oo Ar pool Oc Ns …
43 .Op Ar interval Op Ar count
44 .
45 .Sh DESCRIPTION
46 Displays the detailed health status for the given pools.
47 If no
48 .Ar pool
49 is specified, then the status of each pool in the system is displayed.
50 For more information on pool and device health, see the
51 .Sx Device Failure and Recovery
52 section of
53 .Xr zpoolconcepts 7 .
54 .Pp
55 If a scrub or resilver is in progress, this command reports the percentage done
56 and the estimated time to completion.
57 Both of these are only approximate, because the amount of data in the pool and
58 the other workloads on the system can change.
59 .Bl -tag -width Ds
60 .It Fl -power
61 Display vdev enclosure slot power status (on or off).
62 .It Fl c Op Ar SCRIPT1 Ns Oo , Ns Ar SCRIPT2 Oc Ns …
63 Run a script (or scripts) on each vdev and include the output as a new column
64 in the
65 .Nm zpool Cm status
66 output.
67 See the
68 .Fl c
69 option of
70 .Nm zpool Cm iostat
71 for complete details.
72 .It Fl D
73 Display a histogram of deduplication statistics, showing the allocated
74 .Pq physically present on disk
75 and referenced
76 .Pq logically referenced in the pool
77 block counts and sizes by reference count.
78 .It Fl e
79 Only show unhealthy vdevs (not-ONLINE or with errors).
80 .It Fl g
81 Display vdev GUIDs instead of the normal device names
82 These GUIDs can be used in place of device names for the zpool
83 detach/offline/remove/replace commands.
84 .It Fl i
85 Display vdev initialization status.
86 .It Fl L
87 Display real paths for vdevs resolving all symbolic links.
88 This can be used to look up the current block device name regardless of the
89 .Pa /dev/disk/
90 path used to open it.
91 .It Fl p
92 Display numbers in parsable (exact) values.
93 .It Fl P
94 Display full paths for vdevs instead of only the last component of
95 the path.
96 This can be used in conjunction with the
97 .Fl L
98 flag.
99 .It Fl s
100 Display the number of leaf vdev slow I/O operations.
101 This is the number of I/O operations that didn't complete in
102 .Sy zio_slow_io_ms
103 milliseconds
104 .Pq Sy 30000 No by default .
105 This does not necessarily mean the I/O operations failed to complete, just took
106 an
107 unreasonably long amount of time.
108 This may indicate a problem with the underlying storage.
109 .It Fl t
110 Display vdev TRIM status.
111 .It Fl T Sy u Ns | Ns Sy d
112 Display a time stamp.
113 Specify
114 .Sy u
115 for a printed representation of the internal representation of time.
116 See
117 .Xr time 1 .
118 Specify
119 .Sy d
120 for standard date format.
121 See
122 .Xr date 1 .
123 .It Fl v
124 Displays verbose data error information, printing out a complete list of all
125 data errors since the last complete pool scrub.
126 If the head_errlog feature is enabled and files containing errors have been
127 removed then the respective filenames will not be reported in subsequent runs
128 of this command.
129 .It Fl x
130 Only display status for pools that are exhibiting errors or are otherwise
131 unavailable.
132 Warnings about pools not using the latest on-disk format will not be included.
133 .El
134 .
135 .Sh EXAMPLES
136 .\" These are, respectively, examples 16 from zpool.8
137 .\" Make sure to update them bidirectionally
138 .Ss Example 1 : No Adding output columns
139 Additional columns can be added to the
140 .Nm zpool Cm status No and Nm zpool Cm iostat No output with Fl c .
141 .Bd -literal -compact -offset Ds
142 .No # Nm zpool Cm status Fl c Pa vendor , Ns Pa model , Ns Pa size
143 NAME STATE READ WRITE CKSUM vendor model size
144 tank ONLINE 0 0 0
145 mirror-0 ONLINE 0 0 0
146 U1 ONLINE 0 0 0 SEAGATE ST8000NM0075 7.3T
147 U10 ONLINE 0 0 0 SEAGATE ST8000NM0075 7.3T
148 U11 ONLINE 0 0 0 SEAGATE ST8000NM0075 7.3T
149 U12 ONLINE 0 0 0 SEAGATE ST8000NM0075 7.3T
150 U13 ONLINE 0 0 0 SEAGATE ST8000NM0075 7.3T
151 U14 ONLINE 0 0 0 SEAGATE ST8000NM0075 7.3T
153 .No # Nm zpool Cm iostat Fl vc Pa size
154 capacity operations bandwidth
155 pool alloc free read write read write size
156 ---------- ----- ----- ----- ----- ----- ----- ----
157 rpool 14.6G 54.9G 4 55 250K 2.69M
158 sda1 14.6G 54.9G 4 55 250K 2.69M 70G
159 ---------- ----- ----- ----- ----- ----- ----- ----
160 .Ed
161 .
162 .Sh SEE ALSO
163 .Xr zpool-events 8 ,
164 .Xr zpool-history 8 ,
165 .Xr zpool-iostat 8 ,
166 .Xr zpool-list 8 ,
167 .Xr zpool-resilver 8 ,
168 .Xr zpool-scrub 8 ,
169 .Xr zpool-wait 8