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