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