xref: /freebsd/sys/contrib/openzfs/man/man8/zpool-wait.8 (revision 61145dc2b94f12f6a47344fb9aac702321880e43)
1.\" SPDX-License-Identifier: CDDL-1.0
2.\"
3.\" CDDL HEADER START
4.\"
5.\" The contents of this file are subject to the terms of the
6.\" Common Development and Distribution License (the "License").
7.\" You may not use this file except in compliance with the License.
8.\"
9.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10.\" or https://opensource.org/licenses/CDDL-1.0.
11.\" See the License for the specific language governing permissions
12.\" and limitations under the License.
13.\"
14.\" When distributing Covered Code, include this CDDL HEADER in each
15.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16.\" If applicable, add the following below this CDDL HEADER, with the
17.\" fields enclosed by brackets "[]" replaced with your own identifying
18.\" information: Portions Copyright [yyyy] [name of copyright owner]
19.\"
20.\" CDDL HEADER END
21.\"
22.\"
23.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
24.\" Copyright (c) 2012, 2021 by Delphix. All rights reserved.
25.\" Copyright (c) 2012 Cyril Plisko. All Rights Reserved.
26.\" Copyright (c) 2017 Datto Inc.
27.\" Copyright (c) 2018 George Melikov. All Rights Reserved.
28.\" Copyright 2017 Nexenta Systems, Inc.
29.\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
30.\"
31.Dd May 27, 2021
32.Dt ZPOOL-WAIT 8
33.Os
34.
35.Sh NAME
36.Nm zpool-wait
37.Nd wait for activity to stop in a ZFS storage pool
38.Sh SYNOPSIS
39.Nm zpool
40.Cm wait
41.Op Fl Hp
42.Op Fl T Sy u Ns | Ns Sy d
43.Op Fl t Ar activity Ns Oo , Ns Ar activity Ns Oc Ns …
44.Ar pool
45.Op Ar interval
46.
47.Sh DESCRIPTION
48Waits until all background activity of the given types has ceased in the given
49pool.
50The activity could cease because it has completed, or because it has been
51paused or canceled by a user, or because the pool has been exported or
52destroyed.
53If no activities are specified, the command waits until background activity of
54every type listed below has ceased.
55If there is no activity of the given types in progress, the command returns
56immediately.
57.Pp
58These are the possible values for
59.Ar activity ,
60along with what each one waits for:
61.Bl -tag -compact -offset Ds -width "raidz_expand"
62.It Sy discard
63Checkpoint to be discarded
64.It Sy free
65.Sy freeing
66property to become
67.Sy 0
68.It Sy initialize
69All initializations to cease
70.It Sy replace
71All device replacements to cease
72.It Sy remove
73Device removal to cease
74.It Sy resilver
75Resilver to cease
76.It Sy scrub
77Scrub to cease
78.It Sy trim
79Manual trim to cease
80.It Sy raidz_expand
81Attaching to a RAID-Z vdev to complete
82.El
83.Pp
84If an
85.Ar interval
86is provided, the amount of work remaining, in bytes, for each activity is
87printed every
88.Ar interval
89seconds.
90.Bl -tag -width Ds
91.It Fl H
92Scripted mode.
93Do not display headers, and separate fields by a single tab instead of arbitrary
94space.
95.It Fl p
96Display numbers in parsable (exact) values.
97.It Fl T Sy u Ns | Ns Sy d
98Display a time stamp.
99Specify
100.Sy u
101for a printed representation of the internal representation of time.
102See
103.Xr time 1 .
104Specify
105.Sy d
106for standard date format.
107See
108.Xr date 1 .
109.El
110.
111.Sh SEE ALSO
112.Xr zpool-checkpoint 8 ,
113.Xr zpool-initialize 8 ,
114.Xr zpool-remove 8 ,
115.Xr zpool-replace 8 ,
116.Xr zpool-resilver 8 ,
117.Xr zpool-scrub 8 ,
118.Xr zpool-status 8 ,
119.Xr zpool-trim 8
120