xref: /freebsd/sys/contrib/openzfs/man/man8/zpool-status.8 (revision da5432eda807c4b7232d030d5157d5b417ea4f52)
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
46Displays the detailed health status for the given pools.
47If no
48.Ar pool
49is specified, then the status of each pool in the system is displayed.
50For more information on pool and device health, see the
51.Sx Device Failure and Recovery
52section of
53.Xr zpoolconcepts 7 .
54.Pp
55If a scrub or resilver is in progress, this command reports the percentage done
56and the estimated time to completion.
57Both of these are only approximate, because the amount of data in the pool and
58the 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 …
61Run a script (or scripts) on each vdev and include the output as a new column
62in the
63.Nm zpool Cm status
64output.
65See the
66.Fl c
67option of
68.Nm zpool Cm iostat
69for complete details.
70.It Fl i
71Display vdev initialization status.
72.It Fl g
73Display vdev GUIDs instead of the normal device names
74These GUIDs can be used in place of device names for the zpool
75detach/offline/remove/replace commands.
76.It Fl L
77Display real paths for vdevs resolving all symbolic links.
78This can be used to look up the current block device name regardless of the
79.Pa /dev/disk/
80path used to open it.
81.It Fl p
82Display numbers in parsable (exact) values.
83.It Fl P
84Display full paths for vdevs instead of only the last component of
85the path.
86This can be used in conjunction with the
87.Fl L
88flag.
89.It Fl D
90Display a histogram of deduplication statistics, showing the allocated
91.Pq physically present on disk
92and referenced
93.Pq logically referenced in the pool
94block counts and sizes by reference count.
95.It Fl s
96Display the number of leaf vdev slow I/O operations.
97This is the number of I/O operations that didn't complete in
98.Sy zio_slow_io_ms
99milliseconds
100.Pq Sy 30000 No by default .
101This does not necessarily mean the I/O operations failed to complete, just took
102an
103unreasonably long amount of time.
104This may indicate a problem with the underlying storage.
105.It Fl t
106Display vdev TRIM status.
107.It Fl T Sy u Ns | Ns Sy d
108Display a time stamp.
109Specify
110.Sy u
111for a printed representation of the internal representation of time.
112See
113.Xr time 2 .
114Specify
115.Sy d
116for standard date format.
117See
118.Xr date 1 .
119.It Fl v
120Displays verbose data error information, printing out a complete list of all
121data errors since the last complete pool scrub.
122If the head_errlog feature is enabled and files containing errors have been
123removed then the respective filenames will not be reported in subsequent runs
124of this command.
125.It Fl x
126Only display status for pools that are exhibiting errors or are otherwise
127unavailable.
128Warnings 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
135Additional 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
148
149.No # Nm zpool Cm iostat Fl vc Pa size
150              capacity     operations     bandwidth
151pool        alloc   free   read  write   read  write  size
152----------  -----  -----  -----  -----  -----  -----  ----
153rpool       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
166