xref: /freebsd/sys/contrib/openzfs/man/man8/zpool-initialize.8 (revision dd41de95a84d979615a2ef11df6850622bf6184e)
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 http://www.opensolaris.org/os/licensing.
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, 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 August 9, 2019
31.Dt ZPOOL-INITIALIZE 8
32.Os
33.Sh NAME
34.Nm zpool-initialize
35.Nd Write to all unallocated regions of eligible devices in a ZFS storage pool
36.Sh SYNOPSIS
37.Nm zpool
38.Cm initialize
39.Op Fl c | Fl s
40.Op Fl w
41.Ar pool
42.Op Ar device Ns ...
43.Sh DESCRIPTION
44.Bl -tag -width Ds
45.It Xo
46.Nm zpool
47.Cm initialize
48.Op Fl c | Fl s
49.Op Fl w
50.Ar pool
51.Op Ar device Ns ...
52.Xc
53Begins initializing by writing to all unallocated regions on the specified
54devices, or all eligible devices in the pool if no individual devices are
55specified.
56Only leaf data or log devices may be initialized.
57.Bl -tag -width Ds
58.It Fl c, -cancel
59Cancel initializing on the specified devices, or all eligible devices if none
60are specified.
61If one or more target devices are invalid or are not currently being
62initialized, the command will fail and no cancellation will occur on any device.
63.It Fl s -suspend
64Suspend initializing on the specified devices, or all eligible devices if none
65are specified.
66If one or more target devices are invalid or are not currently being
67initialized, the command will fail and no suspension will occur on any device.
68Initializing can then be resumed by running
69.Nm zpool Cm initialize
70with no flags on the relevant target devices.
71.It Fl w, -wait
72Wait until the devices have finished initializing before returning.
73.El
74.El
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