xref: /freebsd/sys/contrib/openzfs/man/man8/zpool-clear.8 (revision a90b9d0159070121c221b966469c3e36d912bf82)
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-CLEAR 8
31.Os
32.
33.Sh NAME
34.Nm zpool-clear
35.Nd clear device errors in ZFS storage pool
36.Sh SYNOPSIS
37.Nm zpool
38.Cm clear
39.Op Fl -power
40.Ar pool
41.Oo Ar device Oc Ns …
42.
43.Sh DESCRIPTION
44Clears device errors in a pool.
45If no arguments are specified, all device errors within the pool are cleared.
46If one or more devices is specified, only those errors associated with the
47specified device or devices are cleared.
48.Pp
49If the pool was suspended it will be brought back online provided the
50devices can be accessed.
51Pools with
52.Sy multihost
53enabled which have been suspended cannot be resumed when there is evidence
54that the pool was imported by another host.
55The same checks performed during an import will be applied before the clear
56proceeds.
57.Bl -tag -width Ds
58.It Fl -power
59Power on the devices's slot in the storage enclosure and wait for the device
60to show up before attempting to clear errors.
61This is done on all the devices specified.
62Alternatively, you can set the
63.Sy ZPOOL_AUTO_POWER_ON_SLOT
64environment variable to always enable this behavior.
65Note: This flag currently works on Linux only.
66.El
67.
68.Sh SEE ALSO
69.Xr zdb 8 ,
70.Xr zpool-reopen 8 ,
71.Xr zpool-status 8
72