xref: /freebsd/sys/contrib/openzfs/man/man8/zpool-initialize.8 (revision 7ef62cebc2f965b0f640263e179276928885e33d)
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 May 27, 2021
30.Dt ZPOOL-INITIALIZE 8
31.Os
32.
33.Sh NAME
34.Nm zpool-initialize
35.Nd write to unallocated regions of ZFS storage pool
36.Sh SYNOPSIS
37.Nm zpool
38.Cm initialize
39.Op Fl c Ns | Ns Fl s | Ns Fl u
40.Op Fl w
41.Ar pool
42.Oo Ar device Oc Ns …
43.
44.Sh DESCRIPTION
45Begins initializing by writing to all unallocated regions on the specified
46devices, or all eligible devices in the pool if no individual devices are
47specified.
48Only leaf data or log devices may be initialized.
49.Bl -tag -width Ds
50.It Fl c , -cancel
51Cancel initializing on the specified devices, or all eligible devices if none
52are specified.
53If one or more target devices are invalid or are not currently being
54initialized, the command will fail and no cancellation will occur on any device.
55.It Fl s , -suspend
56Suspend initializing on the specified devices, or all eligible devices if none
57are specified.
58If one or more target devices are invalid or are not currently being
59initialized, the command will fail and no suspension will occur on any device.
60Initializing can then be resumed by running
61.Nm zpool Cm initialize
62with no flags on the relevant target devices.
63.It Fl u , -uninit
64Clears the initialization state on the specified devices, or all eligible
65devices if none are specified.
66If the devices are being actively initialized the command will fail.
67After being cleared
68.Nm zpool Cm initialize
69with no flags can be used to re-initialize all unallocoated regions on
70the relevant target devices.
71.It Fl w , -wait
72Wait until the devices have finished initializing before returning.
73.El
74.
75.Sh SEE ALSO
76.Xr zpool-add 8 ,
77.Xr zpool-attach 8 ,
78.Xr zpool-create 8 ,
79.Xr zpool-online 8 ,
80.Xr zpool-replace 8 ,
81.Xr zpool-trim 8
82