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