xref: /freebsd-src/sys/contrib/openzfs/man/man8/zpool-initialize.8 (revision eda14cbc264d6969b02f2b1994cef11148e914f1)
1*eda14cbcSMatt Macy.\"
2*eda14cbcSMatt Macy.\" CDDL HEADER START
3*eda14cbcSMatt Macy.\"
4*eda14cbcSMatt Macy.\" The contents of this file are subject to the terms of the
5*eda14cbcSMatt Macy.\" Common Development and Distribution License (the "License").
6*eda14cbcSMatt Macy.\" You may not use this file except in compliance with the License.
7*eda14cbcSMatt Macy.\"
8*eda14cbcSMatt Macy.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9*eda14cbcSMatt Macy.\" or http://www.opensolaris.org/os/licensing.
10*eda14cbcSMatt Macy.\" See the License for the specific language governing permissions
11*eda14cbcSMatt Macy.\" and limitations under the License.
12*eda14cbcSMatt Macy.\"
13*eda14cbcSMatt Macy.\" When distributing Covered Code, include this CDDL HEADER in each
14*eda14cbcSMatt Macy.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15*eda14cbcSMatt Macy.\" If applicable, add the following below this CDDL HEADER, with the
16*eda14cbcSMatt Macy.\" fields enclosed by brackets "[]" replaced with your own identifying
17*eda14cbcSMatt Macy.\" information: Portions Copyright [yyyy] [name of copyright owner]
18*eda14cbcSMatt Macy.\"
19*eda14cbcSMatt Macy.\" CDDL HEADER END
20*eda14cbcSMatt Macy.\"
21*eda14cbcSMatt Macy.\"
22*eda14cbcSMatt Macy.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
23*eda14cbcSMatt Macy.\" Copyright (c) 2012, 2018 by Delphix. All rights reserved.
24*eda14cbcSMatt Macy.\" Copyright (c) 2012 Cyril Plisko. All Rights Reserved.
25*eda14cbcSMatt Macy.\" Copyright (c) 2017 Datto Inc.
26*eda14cbcSMatt Macy.\" Copyright (c) 2018 George Melikov. All Rights Reserved.
27*eda14cbcSMatt Macy.\" Copyright 2017 Nexenta Systems, Inc.
28*eda14cbcSMatt Macy.\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
29*eda14cbcSMatt Macy.\"
30*eda14cbcSMatt Macy.Dd August 9, 2019
31*eda14cbcSMatt Macy.Dt ZPOOL-INITIALIZE 8
32*eda14cbcSMatt Macy.Os
33*eda14cbcSMatt Macy.Sh NAME
34*eda14cbcSMatt Macy.Nm zpool Ns Pf - Cm initialize
35*eda14cbcSMatt Macy.Nd Write to all unallocated regions of eligible devices in a ZFS storage pool
36*eda14cbcSMatt Macy.Sh SYNOPSIS
37*eda14cbcSMatt Macy.Nm
38*eda14cbcSMatt Macy.Cm initialize
39*eda14cbcSMatt Macy.Op Fl c | Fl s
40*eda14cbcSMatt Macy.Op Fl w
41*eda14cbcSMatt Macy.Ar pool
42*eda14cbcSMatt Macy.Op Ar device Ns ...
43*eda14cbcSMatt Macy.Sh DESCRIPTION
44*eda14cbcSMatt Macy.Bl -tag -width Ds
45*eda14cbcSMatt Macy.It Xo
46*eda14cbcSMatt Macy.Nm
47*eda14cbcSMatt Macy.Cm initialize
48*eda14cbcSMatt Macy.Op Fl c | Fl s
49*eda14cbcSMatt Macy.Op Fl w
50*eda14cbcSMatt Macy.Ar pool
51*eda14cbcSMatt Macy.Op Ar device Ns ...
52*eda14cbcSMatt Macy.Xc
53*eda14cbcSMatt MacyBegins initializing by writing to all unallocated regions on the specified
54*eda14cbcSMatt Macydevices, or all eligible devices in the pool if no individual devices are
55*eda14cbcSMatt Macyspecified.
56*eda14cbcSMatt MacyOnly leaf data or log devices may be initialized.
57*eda14cbcSMatt Macy.Bl -tag -width Ds
58*eda14cbcSMatt Macy.It Fl c, -cancel
59*eda14cbcSMatt MacyCancel initializing on the specified devices, or all eligible devices if none
60*eda14cbcSMatt Macyare specified.
61*eda14cbcSMatt MacyIf one or more target devices are invalid or are not currently being
62*eda14cbcSMatt Macyinitialized, the command will fail and no cancellation will occur on any device.
63*eda14cbcSMatt Macy.It Fl s -suspend
64*eda14cbcSMatt MacySuspend initializing on the specified devices, or all eligible devices if none
65*eda14cbcSMatt Macyare specified.
66*eda14cbcSMatt MacyIf one or more target devices are invalid or are not currently being
67*eda14cbcSMatt Macyinitialized, the command will fail and no suspension will occur on any device.
68*eda14cbcSMatt MacyInitializing can then be resumed by running
69*eda14cbcSMatt Macy.Nm zpool Cm initialize
70*eda14cbcSMatt Macywith no flags on the relevant target devices.
71*eda14cbcSMatt Macy.It Fl w, -wait
72*eda14cbcSMatt MacyWait until the devices have finished initializing before returning.
73*eda14cbcSMatt Macy.El
74*eda14cbcSMatt Macy.El
75*eda14cbcSMatt Macy.Sh SEE ALSO
76*eda14cbcSMatt Macy.Xr zpool-add 8 ,
77*eda14cbcSMatt Macy.Xr zpool-attach 8 ,
78*eda14cbcSMatt Macy.Xr zpool-create 8 ,
79*eda14cbcSMatt Macy.Xr zpool-online 8 ,
80*eda14cbcSMatt Macy.Xr zpool-replace 8 ,
81*eda14cbcSMatt Macy.Xr zpool-trim 8
82