xref: /freebsd/sys/contrib/openzfs/man/man8/zpool-status.8 (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
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 DeigLpPstvx
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 -power
61Display vdev enclosure slot power status (on or off).
62.It Fl c Op Ar SCRIPT1 Ns Oo , Ns Ar SCRIPT2 Oc Ns …
63Run a script (or scripts) on each vdev and include the output as a new column
64in the
65.Nm zpool Cm status
66output.
67See the
68.Fl c
69option of
70.Nm zpool Cm iostat
71for complete details.
72.It Fl e
73Only show unhealthy vdevs (not-ONLINE or with errors).
74.It Fl i
75Display vdev initialization status.
76.It Fl g
77Display vdev GUIDs instead of the normal device names
78These GUIDs can be used in place of device names for the zpool
79detach/offline/remove/replace commands.
80.It Fl L
81Display real paths for vdevs resolving all symbolic links.
82This can be used to look up the current block device name regardless of the
83.Pa /dev/disk/
84path used to open it.
85.It Fl p
86Display numbers in parsable (exact) values.
87.It Fl P
88Display full paths for vdevs instead of only the last component of
89the path.
90This can be used in conjunction with the
91.Fl L
92flag.
93.It Fl D
94Display a histogram of deduplication statistics, showing the allocated
95.Pq physically present on disk
96and referenced
97.Pq logically referenced in the pool
98block counts and sizes by reference count.
99.It Fl s
100Display the number of leaf vdev slow I/O operations.
101This is the number of I/O operations that didn't complete in
102.Sy zio_slow_io_ms
103milliseconds
104.Pq Sy 30000 No by default .
105This does not necessarily mean the I/O operations failed to complete, just took
106an
107unreasonably long amount of time.
108This may indicate a problem with the underlying storage.
109.It Fl t
110Display vdev TRIM status.
111.It Fl T Sy u Ns | Ns Sy d
112Display a time stamp.
113Specify
114.Sy u
115for a printed representation of the internal representation of time.
116See
117.Xr time 1 .
118Specify
119.Sy d
120for standard date format.
121See
122.Xr date 1 .
123.It Fl v
124Displays verbose data error information, printing out a complete list of all
125data errors since the last complete pool scrub.
126If the head_errlog feature is enabled and files containing errors have been
127removed then the respective filenames will not be reported in subsequent runs
128of this command.
129.It Fl x
130Only display status for pools that are exhibiting errors or are otherwise
131unavailable.
132Warnings 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
139Additional 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
152
153.No # Nm zpool Cm iostat Fl vc Pa size
154              capacity     operations     bandwidth
155pool        alloc   free   read  write   read  write  size
156----------  -----  -----  -----  -----  -----  -----  ----
157rpool       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
170