xref: /freebsd/sys/contrib/openzfs/man/man8/zpool-wait.8 (revision c66ec88fed842fbaad62c30d510644ceb7bd2d71)
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 February 25, 2020
31.Dt ZPOOL-WAIT 8
32.Os
33.Sh NAME
34.Nm zpool-wait
35.Nd Wait for background activity to stop in a ZFS storage pool
36.Sh SYNOPSIS
37.Nm zpool
38.Cm wait
39.Op Fl Hp
40.Op Fl T Sy u Ns | Ns Sy d
41.Op Fl t Ar activity Ns Oo , Ns Ar activity Ns Oc Ns ...
42.Ar pool
43.Op Ar interval
44.Sh DESCRIPTION
45.Bl -tag -width Ds
46.It Xo
47.Nm zpool
48.Cm wait
49.Op Fl Hp
50.Op Fl T Sy u Ns | Ns Sy d
51.Op Fl t Ar activity Ns Oo , Ns Ar activity Ns Oc Ns ...
52.Ar pool
53.Op Ar interval
54.Xc
55Waits until all background activity of the given types has ceased in the given
56pool.
57The activity could cease because it has completed, or because it has been
58paused or canceled by a user, or because the pool has been exported or
59destroyed.
60If no activities are specified, the command waits until background activity of
61every type listed below has ceased.
62If there is no activity of the given types in progress, the command returns
63immediately.
64.Pp
65These are the possible values for
66.Ar activity ,
67along with what each one waits for:
68.Bd -literal
69        discard       Checkpoint to be discarded
70        free          'freeing' property to become 0
71        initialize    All initializations to cease
72        replace       All device replacements to cease
73        remove        Device removal to cease
74        resilver      Resilver to cease
75        scrub         Scrub to cease
76        trim          Manual trim to cease
77.Ed
78.Pp
79If an
80.Ar interval
81is provided, the amount of work remaining, in bytes, for each activity is
82printed every
83.Ar interval
84seconds.
85.Bl -tag -width Ds
86.It Fl H
87Scripted mode.
88Do not display headers, and separate fields by a single tab instead of arbitrary
89space.
90.It Fl p
91Display numbers in parsable (exact) values.
92.It Fl T Sy u Ns | Ns Sy d
93Display a time stamp.
94Specify
95.Sy u
96for a printed representation of the internal representation of time.
97See
98.Xr time 2 .
99Specify
100.Sy d
101for standard date format.
102See
103.Xr date 1 .
104.El
105.El
106.Sh SEE ALSO
107.Xr zpool-status 8 ,
108.Xr zpool-checkpoint 8 ,
109.Xr zpool-initialize 8 ,
110.Xr zpool-replace 8 ,
111.Xr zpool-remove 8 ,
112.Xr zpool-resilver 8 ,
113.Xr zpool-scrub 8 ,
114.Xr zpool-trim 8
115