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 http://www.opensolaris.org/os/licensing.
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.\"
22.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
23.\" Copyright (c) 2012, 2018 by Delphix. All rights reserved.
24.\" Copyright (c) 2012 Cyril Plisko. All Rights Reserved.
25.\" Copyright (c) 2017 Datto Inc.
26.\" Copyright (c) 2018 George Melikov. All Rights Reserved.
27.\" Copyright 2017 Nexenta Systems, Inc.
28.\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
29.\"
30.Dd May 15, 2020
31.Dt ZPOOL-STATUS 8
32.Os
33.Sh NAME
34.Nm zpool Ns Pf - Cm status
35.Nd Display detailed health status for the given ZFS storage pools
36.Sh SYNOPSIS
37.Nm
38.Cm status
39.Oo Fl c Ar SCRIPT Oc
40.Op Fl DigLpPstvx
41.Op Fl T Sy u Ns | Ns Sy d
42.Oo Ar pool Oc Ns ...
43.Op Ar interval Op Ar count
44.Sh DESCRIPTION
45.Bl -tag -width Ds
46.It Xo
47.Nm
48.Cm status
49.Op Fl c Op Ar SCRIPT1 Ns Oo , Ns Ar SCRIPT2 Oc Ns ...
50.Op Fl DigLpPstvx
51.Op Fl T Sy u Ns | Ns Sy d
52.Oo Ar pool Oc Ns ...
53.Op Ar interval Op Ar count
54.Xc
55Displays the detailed health status for the given pools.
56If no
57.Ar pool
58is specified, then the status of each pool in the system is displayed.
59For more information on pool and device health, see the
60.Em Device Failure and Recovery
61section of
62.Xr zpoolconcepts 8 .
63.Pp
64If a scrub or resilver is in progress, this command reports the percentage done
65and the estimated time to completion.
66Both of these are only approximate, because the amount of data in the pool and
67the other workloads on the system can change.
68.Bl -tag -width Ds
69.It Fl c Op Ar SCRIPT1 Ns Oo , Ns Ar SCRIPT2 Oc Ns ...
70Run a script (or scripts) on each vdev and include the output as a new column
71in the
72.Nm zpool Cm status
73output.  See the
74.Fl c
75option of
76.Nm zpool Cm iostat
77for complete details.
78.It Fl i
79Display vdev initialization status.
80.It Fl g
81Display vdev GUIDs instead of the normal device names. These GUIDs
82can be used in place of device names for the zpool
83detach/offline/remove/replace commands.
84.It Fl L
85Display real paths for vdevs resolving all symbolic links. This can
86be used to look up the current block device name regardless of the
87.Pa /dev/disk/
88path used to open it.
89.It Fl p
90Display numbers in parsable (exact) values.
91.It Fl P
92Display full paths for vdevs instead of only the last component of
93the path. This can be used in conjunction with the
94.Fl L
95flag.
96.It Fl D
97Display a histogram of deduplication statistics, showing the allocated
98.Pq physically present on disk
99and referenced
100.Pq logically referenced in the pool
101block counts and sizes by reference count.
102.It Fl s
103Display the number of leaf VDEV slow IOs.  This is the number of IOs that
104didn't complete in \fBzio_slow_io_ms\fR milliseconds (default 30 seconds).
105This does not necessarily mean the IOs failed to complete, just took an
106unreasonably long amount of time.  This may indicate a problem with the
107underlying storage.
108.It Fl t
109Display vdev TRIM status.
110.It Fl T Sy u Ns | Ns Sy d
111Display a time stamp.
112Specify
113.Sy u
114for a printed representation of the internal representation of time.
115See
116.Xr time 2 .
117Specify
118.Sy d
119for standard date format.
120See
121.Xr date 1 .
122.It Fl v
123Displays verbose data error information, printing out a complete list of all
124data errors since the last complete pool scrub.
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.El
131.Sh SEE ALSO
132.Xr zpool-events 8 ,
133.Xr zpool-history 8 ,
134.Xr zpool-iostat 8 ,
135.Xr zpool-list 8 ,
136.Xr zpool-resilver 8 ,
137.Xr zpool-scrub 8 ,
138.Xr zpool-wait 8
139