xref: /freebsd/sys/contrib/openzfs/man/man8/zpool-online.8 (revision e0c4386e7e71d93b0edc0c8fa156263fc4a8b0b6)
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 August 9, 2019
30.Dt ZPOOL-OFFLINE 8
31.Os
32.
33.Sh NAME
34.Nm zpool-offline
35.Nd take physical devices offline in ZFS storage pool
36.Sh SYNOPSIS
37.Nm zpool
38.Cm offline
39.Op Fl Sy -power Ns | Ns Op Fl Sy ft
40.Ar pool
41.Ar device Ns …
42.Nm zpool
43.Cm online
44.Op Fl Sy -power
45.Op Fl Sy e
46.Ar pool
47.Ar device Ns …
48.
49.Sh DESCRIPTION
50.Bl -tag -width Ds
51.It Xo
52.Nm zpool
53.Cm offline
54.Op Fl Sy -power Ns | Ns Op Fl Sy ft
55.Ar pool
56.Ar device Ns …
57.Xc
58Takes the specified physical device offline.
59While the
60.Ar device
61is offline, no attempt is made to read or write to the device.
62This command is not applicable to spares.
63.Bl -tag -width Ds
64.It Fl -power
65Power off the device's slot in the storage enclosure.
66This flag currently works on Linux only
67.It Fl f
68Force fault.
69Instead of offlining the disk, put it into a faulted state.
70The fault will persist across imports unless the
71.Fl t
72flag was specified.
73.It Fl t
74Temporary.
75Upon reboot, the specified physical device reverts to its previous state.
76.El
77.It Xo
78.Nm zpool
79.Cm online
80.Op Fl -power
81.Op Fl e
82.Ar pool
83.Ar device Ns …
84.Xc
85Brings the specified physical device online.
86This command is not applicable to spares.
87.Bl -tag -width Ds
88.It Fl -power
89Power on the device's slot in the storage enclosure and wait for the device
90to show up before attempting to online it.
91Alternatively, you can set the
92.Sy ZPOOL_AUTO_POWER_ON_SLOT
93environment variable to always enable this behavior.
94This flag currently works on Linux only
95.It Fl e
96Expand the device to use all available space.
97If the device is part of a mirror or raidz then all devices must be expanded
98before the new space will become available to the pool.
99.El
100.El
101.
102.Sh SEE ALSO
103.Xr zpool-detach 8 ,
104.Xr zpool-remove 8 ,
105.Xr zpool-reopen 8 ,
106.Xr zpool-resilver 8
107