xref: /freebsd/sys/contrib/openzfs/man/man8/zpool-offline.8 (revision b356da806b5207833324a7cdd863adc72189fa58)
1eda14cbcSMatt Macy.\"
2eda14cbcSMatt Macy.\" CDDL HEADER START
3eda14cbcSMatt Macy.\"
4eda14cbcSMatt Macy.\" The contents of this file are subject to the terms of the
5eda14cbcSMatt Macy.\" Common Development and Distribution License (the "License").
6eda14cbcSMatt Macy.\" You may not use this file except in compliance with the License.
7eda14cbcSMatt Macy.\"
8eda14cbcSMatt Macy.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9271171e0SMartin Matuska.\" or https://opensource.org/licenses/CDDL-1.0.
10eda14cbcSMatt Macy.\" See the License for the specific language governing permissions
11eda14cbcSMatt Macy.\" and limitations under the License.
12eda14cbcSMatt Macy.\"
13eda14cbcSMatt Macy.\" When distributing Covered Code, include this CDDL HEADER in each
14eda14cbcSMatt Macy.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15eda14cbcSMatt Macy.\" If applicable, add the following below this CDDL HEADER, with the
16eda14cbcSMatt Macy.\" fields enclosed by brackets "[]" replaced with your own identifying
17eda14cbcSMatt Macy.\" information: Portions Copyright [yyyy] [name of copyright owner]
18eda14cbcSMatt Macy.\"
19eda14cbcSMatt Macy.\" CDDL HEADER END
20eda14cbcSMatt Macy.\"
21eda14cbcSMatt Macy.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
22eda14cbcSMatt Macy.\" Copyright (c) 2012, 2018 by Delphix. All rights reserved.
23eda14cbcSMatt Macy.\" Copyright (c) 2012 Cyril Plisko. All Rights Reserved.
24eda14cbcSMatt Macy.\" Copyright (c) 2017 Datto Inc.
25eda14cbcSMatt Macy.\" Copyright (c) 2018 George Melikov. All Rights Reserved.
26eda14cbcSMatt Macy.\" Copyright 2017 Nexenta Systems, Inc.
27eda14cbcSMatt Macy.\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
28eda14cbcSMatt Macy.\"
29eda14cbcSMatt Macy.Dd August 9, 2019
30eda14cbcSMatt Macy.Dt ZPOOL-OFFLINE 8
31eda14cbcSMatt Macy.Os
3216038816SMartin Matuska.
33eda14cbcSMatt Macy.Sh NAME
347877fdebSMatt Macy.Nm zpool-offline
3516038816SMartin Matuska.Nd take physical devices offline in ZFS storage pool
36eda14cbcSMatt Macy.Sh SYNOPSIS
377877fdebSMatt Macy.Nm zpool
38eda14cbcSMatt Macy.Cm offline
39*b356da80SMartin Matuska.Op Fl Sy -power Ns | Ns Op Fl Sy ft
4016038816SMartin Matuska.Ar pool
4116038816SMartin Matuska.Ar device Ns …
427877fdebSMatt Macy.Nm zpool
43eda14cbcSMatt Macy.Cm online
44*b356da80SMartin Matuska.Op Fl Sy -power
45*b356da80SMartin Matuska.Op Fl Sy e
4616038816SMartin Matuska.Ar pool
4716038816SMartin Matuska.Ar device Ns …
4816038816SMartin Matuska.
49eda14cbcSMatt Macy.Sh DESCRIPTION
50eda14cbcSMatt Macy.Bl -tag -width Ds
51eda14cbcSMatt Macy.It Xo
527877fdebSMatt Macy.Nm zpool
53eda14cbcSMatt Macy.Cm offline
54*b356da80SMartin Matuska.Op Fl Sy -power Ns | Ns Op Fl Sy ft
5516038816SMartin Matuska.Ar pool
5616038816SMartin Matuska.Ar device Ns …
57eda14cbcSMatt Macy.Xc
58eda14cbcSMatt MacyTakes the specified physical device offline.
59eda14cbcSMatt MacyWhile the
60eda14cbcSMatt Macy.Ar device
61eda14cbcSMatt Macyis offline, no attempt is made to read or write to the device.
62eda14cbcSMatt MacyThis command is not applicable to spares.
63eda14cbcSMatt Macy.Bl -tag -width Ds
64*b356da80SMartin Matuska.It Fl -power
65*b356da80SMartin MatuskaPower off the device's slot in the storage enclosure.
66*b356da80SMartin MatuskaThis flag currently works on Linux only
67eda14cbcSMatt Macy.It Fl f
6816038816SMartin MatuskaForce fault.
6916038816SMartin MatuskaInstead of offlining the disk, put it into a faulted state.
7016038816SMartin MatuskaThe fault will persist across imports unless the
71eda14cbcSMatt Macy.Fl t
72eda14cbcSMatt Macyflag was specified.
73eda14cbcSMatt Macy.It Fl t
74eda14cbcSMatt MacyTemporary.
75eda14cbcSMatt MacyUpon reboot, the specified physical device reverts to its previous state.
76eda14cbcSMatt Macy.El
77eda14cbcSMatt Macy.It Xo
787877fdebSMatt Macy.Nm zpool
79eda14cbcSMatt Macy.Cm online
80*b356da80SMartin Matuska.Op Fl -power
81eda14cbcSMatt Macy.Op Fl e
8216038816SMartin Matuska.Ar pool
8316038816SMartin Matuska.Ar device Ns …
84eda14cbcSMatt Macy.Xc
85eda14cbcSMatt MacyBrings the specified physical device online.
86eda14cbcSMatt MacyThis command is not applicable to spares.
87eda14cbcSMatt Macy.Bl -tag -width Ds
88*b356da80SMartin Matuska.It Fl -power
89*b356da80SMartin MatuskaPower on the device's slot in the storage enclosure and wait for the device
90*b356da80SMartin Matuskato show up before attempting to online it.
91*b356da80SMartin MatuskaAlternatively, you can set the
92*b356da80SMartin Matuska.Sy ZPOOL_AUTO_POWER_ON_SLOT
93*b356da80SMartin Matuskaenvironment variable to always enable this behavior.
94*b356da80SMartin MatuskaThis flag currently works on Linux only
95eda14cbcSMatt Macy.It Fl e
96eda14cbcSMatt MacyExpand the device to use all available space.
97eda14cbcSMatt MacyIf the device is part of a mirror or raidz then all devices must be expanded
98eda14cbcSMatt Macybefore the new space will become available to the pool.
99eda14cbcSMatt Macy.El
100eda14cbcSMatt Macy.El
10116038816SMartin Matuska.
102eda14cbcSMatt Macy.Sh SEE ALSO
103eda14cbcSMatt Macy.Xr zpool-detach 8 ,
104eda14cbcSMatt Macy.Xr zpool-remove 8 ,
105eda14cbcSMatt Macy.Xr zpool-reopen 8 ,
106eda14cbcSMatt Macy.Xr zpool-resilver 8
107