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