| blob | 8f9580cf086e745fb72ece61adeee6e152812ddf |
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 DigLpPstvx
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 c Op Ar SCRIPT1 Ns Oo , Ns Ar SCRIPT2 Oc Ns …
61 Run a script (or scripts) on each vdev and include the output as a new column
62 in the
63 .Nm zpool Cm status
64 output.
65 See the
66 .Fl c
67 option of
68 .Nm zpool Cm iostat
69 for complete details.
70 .It Fl i
71 Display vdev initialization status.
72 .It Fl g
73 Display vdev GUIDs instead of the normal device names
74 These GUIDs can be used in place of device names for the zpool
75 detach/offline/remove/replace commands.
76 .It Fl L
77 Display real paths for vdevs resolving all symbolic links.
78 This can be used to look up the current block device name regardless of the
79 .Pa /dev/disk/
80 path used to open it.
81 .It Fl p
82 Display numbers in parsable (exact) values.
83 .It Fl P
84 Display full paths for vdevs instead of only the last component of
85 the path.
86 This can be used in conjunction with the
87 .Fl L
88 flag.
89 .It Fl D
90 Display a histogram of deduplication statistics, showing the allocated
91 .Pq physically present on disk
92 and referenced
93 .Pq logically referenced in the pool
94 block counts and sizes by reference count.
95 .It Fl s
96 Display the number of leaf vdev slow I/O operations.
97 This is the number of I/O operations that didn't complete in
98 .Sy zio_slow_io_ms
99 milliseconds
100 .Pq Sy 30000 No by default .
101 This does not necessarily mean the I/O operations failed to complete, just took
102 an
103 unreasonably long amount of time.
104 This may indicate a problem with the underlying storage.
105 .It Fl t
106 Display vdev TRIM status.
107 .It Fl T Sy u Ns | Ns Sy d
108 Display a time stamp.
109 Specify
110 .Sy u
111 for a printed representation of the internal representation of time.
112 See
113 .Xr time 2 .
114 Specify
115 .Sy d
116 for standard date format.
117 See
118 .Xr date 1 .
119 .It Fl v
120 Displays verbose data error information, printing out a complete list of all
121 data errors since the last complete pool scrub.
122 If the head_errlog feature is enabled and files containing errors have been
123 removed then the respective filenames will not be reported in subsequent runs
124 of this command.
125 .It Fl x
126 Only display status for pools that are exhibiting errors or are otherwise
127 unavailable.
128 Warnings about pools not using the latest on-disk format will not be included.
129 .El
130 .
131 .Sh EXAMPLES
132 .\" These are, respectively, examples 16 from zpool.8
133 .\" Make sure to update them bidirectionally
134 .Ss Example 1 : No Adding output columns
135 Additional columns can be added to the
136 .Nm zpool Cm status No and Nm zpool Cm iostat No output with Fl c .
137 .Bd -literal -compact -offset Ds
138 .No # Nm zpool Cm status Fl c Pa vendor , Ns Pa model , Ns Pa size
139 NAME STATE READ WRITE CKSUM vendor model size
140 tank ONLINE 0 0 0
141 mirror-0 ONLINE 0 0 0
142 U1 ONLINE 0 0 0 SEAGATE ST8000NM0075 7.3T
143 U10 ONLINE 0 0 0 SEAGATE ST8000NM0075 7.3T
144 U11 ONLINE 0 0 0 SEAGATE ST8000NM0075 7.3T
145 U12 ONLINE 0 0 0 SEAGATE ST8000NM0075 7.3T
146 U13 ONLINE 0 0 0 SEAGATE ST8000NM0075 7.3T
147 U14 ONLINE 0 0 0 SEAGATE ST8000NM0075 7.3T
149 .No # Nm zpool Cm iostat Fl vc Pa size
150 capacity operations bandwidth
151 pool alloc free read write read write size
152 ---------- ----- ----- ----- ----- ----- ----- ----
153 rpool 14.6G 54.9G 4 55 250K 2.69M
154 sda1 14.6G 54.9G 4 55 250K 2.69M 70G
155 ---------- ----- ----- ----- ----- ----- ----- ----
156 .Ed
157 .
158 .Sh SEE ALSO
159 .Xr zpool-events 8 ,
160 .Xr zpool-history 8 ,
161 .Xr zpool-iostat 8 ,
162 .Xr zpool-list 8 ,
163 .Xr zpool-resilver 8 ,
164 .Xr zpool-scrub 8 ,
165 .Xr zpool-wait 8