diff options
Diffstat (limited to 'cddl/contrib/opensolaris/cmd/zpool/zpool.8')
| -rw-r--r-- | cddl/contrib/opensolaris/cmd/zpool/zpool.8 | 3408 |
1 files changed, 1639 insertions, 1769 deletions
diff --git a/cddl/contrib/opensolaris/cmd/zpool/zpool.8 b/cddl/contrib/opensolaris/cmd/zpool/zpool.8 index 8c41f42..f89c2ee 100644 --- a/cddl/contrib/opensolaris/cmd/zpool/zpool.8 +++ b/cddl/contrib/opensolaris/cmd/zpool/zpool.8 @@ -1,492 +1,485 @@ '\" te -.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved. -.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. -.\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the -.\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.\" Portions Copyright 2011 Justin T. Gibbs <gibbs@FreeBSD.org> -.\" Portions Copyright 2011 Martin Matuska <mm@FreeBSD.org> -.TH ZPOOL 8 "September 21, 2009" FreeBSD -.SH NAME -zpool \- configures ZFS storage pools -.SH SYNOPSIS -.LP -.nf -\fBzpool\fR [\fB-?\fR] -.fi - -.LP -.nf -\fBzpool add\fR [\fB-fn\fR] \fIpool\fR \fIvdev\fR ... -.fi - -.LP -.nf -\fBzpool attach\fR [\fB-f\fR] \fIpool\fR \fIdevice\fR \fInew_device\fR -.fi - -.LP -.nf -\fBzpool clear\fR \fIpool\fR [\fIdevice\fR] -.fi - -.LP -.nf -\fBzpool create\fR [\fB-fn\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-O\fR \fIfile-system-property=value\fR] - ... [\fB-m\fR \fImountpoint\fR] [\fB-R\fR \fIroot\fR] \fIpool\fR \fIvdev\fR ... -.fi - -.LP -.nf -\fBzpool destroy\fR [\fB-f\fR] \fIpool\fR -.fi - -.LP -.nf -\fBzpool detach\fR \fIpool\fR \fIdevice\fR -.fi - -.LP -.nf -\fBzpool export\fR [\fB-f\fR] \fIpool\fR ... -.fi - -.LP -.nf -\fBzpool get\fR "\fIall\fR" | \fIproperty\fR[,...] \fIpool\fR ... -.fi - -.LP -.nf -\fBzpool history\fR [\fB-il\fR] [\fIpool\fR] ... -.fi - -.LP -.nf -\fBzpool import\fR [\fB-d\fR \fIdir\fR] [\fB-D\fR] -.fi - -.LP -.nf -\fBzpool import\fR [\fB-o \fImntopts\fR\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR] - [\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] \fB-a\fR -.fi - -.LP -.nf -\fBzpool import\fR [\fB-o \fImntopts\fR\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR] - [\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] \fIpool\fR |\fIid\fR [\fInewpool\fR] -.fi - -.LP -.nf -\fBzpool iostat\fR [\fB-T\fR u | d ] [\fB-v\fR] [\fIpool\fR] ... [\fIinterval\fR[\fIcount\fR]] -.fi - -.LP -.nf -\fBzpool labelclear\fR [\fB-f\fR] \fIdevice\fR -.fi - -.LP -.nf -\fBzpool list\fR [\fB-H\fR] [\fB-o\fR \fIproperty\fR[,...]] [\fIpool\fR] ... -.fi - -.LP -.nf -\fBzpool offline\fR [\fB-t\fR] \fIpool\fR \fIdevice\fR ... -.fi - -.LP -.nf -\fBzpool online\fR \fIpool\fR \fIdevice\fR ... -.fi - -.LP -.nf -\fBzpool remove\fR \fIpool\fR \fIdevice\fR ... -.fi - -.LP -.nf -\fBzpool replace\fR [\fB-f\fR] \fIpool\fR \fIdevice\fR [\fInew_device\fR] -.fi - -.LP -.nf -\fBzpool scrub\fR [\fB-s\fR] \fIpool\fR ... -.fi - -.LP -.nf -\fBzpool set\fR \fIproperty\fR=\fIvalue\fR \fIpool\fR -.fi - -.LP -.nf -\fBzpool status\fR [\fB-xv\fR] [\fIpool\fR] ... -.fi - -.LP -.nf -\fBzpool upgrade\fR -.fi - -.LP -.nf -\fBzpool upgrade\fR \fB-v\fR -.fi - -.LP -.nf -\fBzpool upgrade\fR [\fB-V\fR \fIversion\fR] \fB-a\fR | \fIpool\fR ... -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBzpool\fR command configures \fBZFS\fR storage pools. A storage pool is a -collection of devices that provides physical storage and data replication for -\fBZFS\fR datasets. -.sp -.LP -All datasets within a storage pool share the same space. See \fBzfs\fR(8) for -information on managing datasets. -.SS "Virtual Devices (\fBvdev\fRs)" -.sp -.LP -A "virtual device" describes a single device or a collection of devices -organized according to certain performance and fault characteristics. The -following virtual devices are supported: -.sp -.ne 2 -.na -\fB\fBdisk\fR\fR -.ad -.RS 10n -A block device, typically located under \fB/dev\fR. \fBZFS\fR can use -individual slices, partitions or \fBgeom(4)\fR objects, though the recommended -mode of operation is to use whole disks. A disk can be specified by a full -path, or it can be a shorthand name (the relative portion of the path under -"/dev"). For example, "da0" is equivalent to "/dev/da0". -.RE - -.sp -.ne 2 -.na -\fB\fBfile\fR\fR -.ad -.RS 10n +.\" Copyright (c) 2011, Martin Matuska <mm@FreeBSD.org>. +.\" All Rights Reserved. +.\" +.\" The contents of this file are subject to the terms of the +.\" Common Development and Distribution License (the "License"). +.\" You may not use this file except in compliance with the License. +.\" +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE +.\" or http://www.opensolaris.org/os/licensing. +.\" See the License for the specific language governing permissions +.\" and limitations under the License. +.\" +.\" When distributing Covered Code, include this CDDL HEADER in each +.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE. +.\" If applicable, add the following below this CDDL HEADER, with the +.\" fields enclosed by brackets "[]" replaced with your own identifying +.\" information: Portions Copyright [yyyy] [name of copyright owner] +.\" +.\" Copyright (c) 2010, Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright 2011, Nexenta Systems, Inc. All Rights Reserved. +.\" Copyright (c) 2011, Justin T. Gibbs <gibbs@FreeBSD.org> +.\" +.\" $FreeBSD$ +.\" +.Dd November 26, 2011 +.Dt ZPOOL 8 +.Os +.Sh NAME +.Nm zpool +.Nd configures ZFS storage pools +.Sh SYNOPSIS +.Nm +.Op Fl \&? +.Nm +.Cm add +.Op Fl fn +.Ar pool vdev ... +.Nm +.Cm attach +.Op Fl f +.Ar pool device new_device +.Nm +.Cm clear +.Op Fl F Op Fl n +.Ar pool +.Op Ar device +.Nm +.Cm create +.Op Fl fn +.Op Fl o Ar property Ns = Ns Ar value +.Ar ... +.Op Fl O Ar file-system-property Ns = Ns Ar value +.Ar ... +.Op Fl m Ar mountpoint +.Op Fl R Ar root +.Ar pool vdev ... +.Nm +.Cm destroy +.Op Fl f +.Ar pool +.Nm +.Cm detach +.Ar pool device +.Nm +.Cm export +.Op Fl f +.Ar pool ... +.Nm +.Cm get +.Ar all | property Ns Op , Ns Ar ... +.Ar pool ... +.Nm +.Cm history +.Op Fl il +.Op Ar pool +.Ar ... +.Nm +.Cm import +.Op Fl d Ar dir | Fl c Ar cachefile +.Op Fl D +.Nm +.Cm import +.Op Fl o Ar mntopts +.Op Fl o Ar property Ns = Ns Ar value +.Ar ... +.Op Fl d Ar dir | Fl c Ar cachefile +.Op Fl D +.Op Fl f +.Op Fl m +.Op Fl N +.Op Fl R Ar root +.Op Fl F Op Fl n +.Fl a +.Nm +.Cm import +.Op Fl o Ar mntopts +.Op Fl o Ar property Ns = Ns Ar value +.Ar ... +.Op Fl d Ar dir | Fl c Ar cachefile +.Op Fl D +.Op Fl f +.Op Fl m +.Op Fl N +.Op Fl R Ar root +.Op Fl F Op Fl n +.Ar pool | id +.Op Ar newpool +.Nm +.Cm iostat +.Op Fl T Cm d Ns | Ns Cm u +.Op Fl v +.Op Ar pool +.Ar ... +.Nm +.Cm labelclear +.Op Fl f +.Ar device +.Nm +.Cm list +.Op Fl H +.Op Fl o Ar property Ns Op , Ns Ar ... +.Op Fl T Cm d Ns | Ns Cm u +.Op Ar pool +.Ar ... +.Op Ar inverval Op Ar count +.Nm +.Cm offline +.Op Fl t +.Ar pool device ... +.Nm +.Cm online +.Op Fl e +.Ar pool device ... +.Nm +.Cm remove +.Ar pool device ... +.Nm +.Cm replace +.Op Fl f +.Ar pool device +.Op Ar new_device +.Nm +.Cm scrub +.Op Fl s +.Ar pool ... +.Nm +.Cm set +.Ar property Ns = Ns Ar value pool +.Nm +.Cm split +.Op Fl n +.Op Fl R Ar altroot +.Op Fl o Ar mntopts +.Op Fl o Ar property Ns = Ns Ar value +.Ar pool newpool +.Op Ar device ... +.Nm +.Cm status +.Op Fl vx +.Op Fl T Cm d Ns | Ns Cm u +.Op Ar pool +.Ar ... +.Op Ar interval Op Ar count +.Nm +.Cm upgrade +.Op Fl v +.Nm +.Cm upgrade +.Op Fl V Ar version +.Fl a | Ar pool ... +.Sh DESCRIPTION +The +.Nm +command configures +.Tn ZFS +storage pools. A storage pool is a collection of devices that provides physical +storage and data replication for +.Tn ZFS +datasets. +.Pp +All datasets within a storage pool share the same space. See +.Xr zfs 8 +for information on managing datasets. +.Ss Virtual Devices (vdevs) +A +.Qq virtual device +.Pq No vdev +describes a single device or a collection of devices organized according to +certain performance and fault characteristics. The following virtual devices +are supported: +.Bl -tag +.It Sy disk +A block device, typically located under +.Pa /dev Ns . +.Tn ZFS +can use individual slices or partitions, though the recommended mode of +operation is to use whole disks. A disk can be specified by a full path to the +device or the +.Xr geom 4 +provider name. When given a whole disk, +.Tn ZFS +automatically labels the disk, if necessary. +.It Sy file A regular file. The use of files as a backing store is strongly discouraged. It is designed primarily for experimental purposes, as the fault tolerance of a -file is only as good as the file system of which it is a part. A file must be +file is only as good the file system of which it is a part. A file must be specified by a full path. -.RE - -.sp -.ne 2 -.na -\fB\fBmirror\fR\fR -.ad -.RS 10n +.It Sy mirror A mirror of two or more devices. Data is replicated in an identical fashion -across all components of a mirror. A mirror with \fIN\fR disks of size \fIX\fR -can hold \fIX\fR bytes and can withstand (\fIN-1\fR) devices failing before -data integrity is compromised. -.RE - -.sp -.ne 2 -.na -\fB\fBraidz\fR\fR -.ad -.br -.na -\fB\fBraidz1\fR\fR -.ad -.br -.na -\fB\fBraidz2\fR\fR -.ad -.br -.na -\fB\fBraidz3\fR\fR -.ad -.RS 10n -A variation on \fBRAID-5\fR that allows for better distribution of parity and -eliminates the "\fBRAID-5\fR write hole" (in which data and parity become -inconsistent after a power loss). Data and parity is striped across all disks -within a \fBraidz\fR group. -.sp -A \fBraidz\fR group can have single-, double- , or triple parity, meaning that -the \fBraidz\fR group can sustain one, two, or three failures, respectively, -without losing any data. The \fBraidz1\fR \fBvdev\fR type specifies a -single-parity \fBraidz\fR group; the \fBraidz2\fR \fBvdev\fR type specifies a -double-parity \fBraidz\fR group; and the \fBraidz3\fR \fBvdev\fR type specifies -a triple-parity \fBraidz\fR group. The \fBraidz\fR \fBvdev\fR type is an alias -for \fBraidz1\fR. -.sp -A \fBraidz\fR group with \fIN\fR disks of size \fIX\fR with \fIP\fR parity -disks can hold approximately (\fIN-P\fR)*\fIX\fR bytes and can withstand -\fIP\fR device(s) failing before data integrity is compromised. The minimum -number of devices in a \fBraidz\fR group is one more than the number of parity -disks. The recommended number is between 3 and 9 to help increase performance. -.RE - -.sp -.ne 2 -.na -\fB\fBspare\fR\fR -.ad -.RS 10n -A special pseudo-\fBvdev\fR which keeps track of available hot spares for a -pool. For more information, see the "Hot Spares" section. -.RE - -.sp -.ne 2 -.na -\fB\fBlog\fR\fR -.ad -.RS 10n +across all components of a mirror. A mirror with +.Em N +disks of size +.Em X +can hold +.Em X +bytes and can withstand +.Pq Em N-1 +devices failing before data integrity is compromised. +.It Sy raidz +.No ( or Sy raidz1 raidz2 raidz3 Ns ). +A variation on +.Sy RAID-5 +that allows for better distribution of parity and eliminates the +.Qq Sy RAID-5 No write hole +(in which data and parity become inconsistent after a power loss). Data and +parity is striped across all disks within a +.No raidz +group. +.Pp +A +.No raidz +group can have single-, double- , or triple parity, meaning that the +.No raidz +group can sustain one, two, or three failures, respectively, without +losing any data. The +.Sy raidz1 No vdev +type specifies a single-parity +.No raidz +group; the +.Sy raidz2 No vdev +type specifies a double-parity +.No raidz +group; and the +.Sy raidz3 No vdev +type specifies a triple-parity +.No raidz +group. The +.Sy raidz No vdev +type is an alias for +.Sy raidz1 Ns . +.Pp +A +.No raidz +group with +.Em N +disks of size +.Em X +with +.Em P +parity disks can hold approximately +.Sm off +.Pq Em N-P +*X +.Sm on +bytes and can withstand +.Em P +device(s) failing before data integrity is compromised. The minimum number of +devices in a +.No raidz +group is one more than the number of parity disks. The +recommended number is between 3 and 9 to help increase performance. +.It Sy spare +A special +.No pseudo- Ns No vdev +which keeps track of available hot spares for a pool. +For more information, see the +.Qq Sx Hot Spares +section. +.It Sy log A separate-intent log device. If more than one log device is specified, then writes are load-balanced between devices. Log devices can be mirrored. However, -\fBraidz\fR \fBvdev\fR types are not supported for the intent log. For more -information, see the "Intent Log" section. -.RE - -.sp -.ne 2 -.na -\fB\fBcache\fR\fR -.ad -.RS 10n -A device used to cache storage pool data. A cache device cannot be cannot be -configured as a mirror or \fBraidz\fR group. For more information, see the -"Cache Devices" section. -.RE - -.sp -.LP -Virtual devices cannot be nested, so a mirror or \fBraidz\fR virtual device can -only contain files or disks. Mirrors of mirrors (or other combinations) are not +.No raidz +.No vdev +types are not supported for the intent log. For more information, +see the +.Qq Sx Intent Log +section. +.It Sy cache +A device used to cache storage pool data. A cache device cannot be configured +as a mirror or +.No raidz +group. For more information, see the +.Qq Sx Cache Devices +section. +.El +.Pp +Virtual devices cannot be nested, so a mirror or +.No raidz +virtual device can only +contain files or disks. Mirrors of mirrors (or other combinations) are not allowed. -.sp -.LP +.Pp A pool can have any number of virtual devices at the top of the configuration -(known as "root vdevs"). Data is dynamically distributed across all top-level -devices to balance data among devices. As new virtual devices are added, -\fBZFS\fR automatically places data on the newly available devices. -.sp -.LP +(known as +.Qq root +.No vdev Ns s). +Data is dynamically distributed across all top-level devices to balance data +among devices. As new virtual devices are added, +.Tn ZFS +automatically places data on the newly available devices. +.Pp Virtual devices are specified one at a time on the command line, separated by -whitespace. The keywords "mirror" and "raidz" are used to distinguish where a -group ends and another begins. For example, the following creates two root -vdevs, each a mirror of two disks: -.sp -.in +2 -.nf -# \fBzpool create mypool mirror da0 da1 mirror da2 da3\fR -.fi -.in -2 -.sp - -.SS "Device Failure and Recovery" -.sp -.LP -\fBZFS\fR supports a rich set of mechanisms for handling device failure and -data corruption. All metadata and data is checksummed, and \fBZFS\fR +whitespace. The keywords +.Qq mirror +and +.Qq raidz +are used to distinguish where a group ends and another begins. For example, the +following creates two root +.No vdev Ns s, +each a mirror of two disks: +.Ss Device Failure and Recovery +.Tn ZFS +supports a rich set of mechanisms for handling device failure and data +corruption. All metadata and data is checksummed, and +.Tn ZFS automatically repairs bad data from a good copy when corruption is detected. -.sp -.LP +.Pp In order to take advantage of these features, a pool must make use of some form -of redundancy, using either mirrored or \fBraidz\fR groups. While \fBZFS\fR -supports running in a non-redundant configuration, where each root vdev is -simply a disk or file, this is strongly discouraged. A single case of bit +of redundancy, using either mirrored or +.No raidz +groups. While +.Tn ZFS +supports running in a non-redundant configuration, where each root +.No vdev +is simply a disk or file, this is strongly discouraged. A single case of bit corruption can render some or all of your data unavailable. -.sp -.LP +.Pp A pool's health status is described by one of three states: online, degraded, or faulted. An online pool has all devices operating normally. A degraded pool is one in which one or more devices have failed, but the data is still available due to a redundant configuration. A faulted pool has corrupted metadata, or one or more faulted devices, and insufficient replicas to continue functioning. -.sp -.LP -The health of the top-level vdev, such as mirror or \fBraidz\fR device, is -potentially impacted by the state of its associated vdevs, or component -devices. A top-level vdev or component device is in one of the following -states: -.sp -.ne 2 -.na -\fB\fBDEGRADED\fR\fR -.ad -.RS 12n -One or more top-level vdevs is in the degraded state because one or more +.Pp +The health of the top-level +.No vdev , +such as mirror or +.No raidz +device, is +potentially impacted by the state of its associated +.No vdev Ns s, +or component devices. A top-level +.No vdev +or component device is in one of the following states: +.Bl -tag -width "DEGRADED" +.It Sy DEGRADED +One or more top-level +.No vdev Ns s +is in the degraded state because one or more component devices are offline. Sufficient replicas exist to continue functioning. -.sp +.Pp One or more component devices is in the degraded or faulted state, but sufficient replicas exist to continue functioning. The underlying conditions are as follows: -.RS +4 -.TP -.ie t \(bu -.el o +.Bl -bullet -offset 2n +.It The number of checksum errors exceeds acceptable levels and the device is -degraded as an indication that something may be wrong. \fBZFS\fR continues to -use the device as necessary. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The number of I/O errors exceeds acceptable levels. The device could not be +degraded as an indication that something may be wrong. +.Tn ZFS +continues to use the device as necessary. +.It +The number of +.Tn I/O +errors exceeds acceptable levels. The device could not be marked as faulted because there are insufficient replicas to continue functioning. -.RE -.RE - -.sp -.ne 2 -.na -\fB\fBFAULTED\fR\fR -.ad -.RS 12n -One or more top-level vdevs is in the faulted state because one or more +.El +.It Sy FAULTED +One or more top-level +.No vdev Ns s +is in the faulted state because one or more component devices are offline. Insufficient replicas exist to continue functioning. -.sp +.Pp One or more component devices is in the faulted state, and insufficient replicas exist to continue functioning. The underlying conditions are as follows: -.RS +4 -.TP -.ie t \(bu -.el o +.Bl -bullet -offset 2n +.It The device could be opened, but the contents did not match expected values. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The number of I/O errors exceeds acceptable levels and the device is faulted to +.It +The number of +.Tn I/O +errors exceeds acceptable levels and the device is faulted to prevent further use of the device. -.RE -.RE - -.sp -.ne 2 -.na -\fB\fBOFFLINE\fR\fR -.ad -.RS 12n -The device was explicitly taken offline by the "\fBzpool offline\fR" command. -.RE - -.sp -.ne 2 -.na -\fB\fBONLINE\fR\fR -.ad -.RS 12n +.El +.It Sy OFFLINE +The device was explicitly taken offline by the +.Qq Nm Cm offline +command. +.It Sy ONLINE The device is online and functioning. -.RE - -.sp -.ne 2 -.na -\fB\fBREMOVED\fR\fR -.ad -.RS 12n +.It Sy REMOVED The device was physically removed while the system was running. Device removal detection is hardware-dependent and may not be supported on all platforms. -.RE - -.sp -.ne 2 -.na -\fB\fBUNAVAIL\fR\fR -.ad -.RS 12n +.It Sy UNAVAIL The device could not be opened. If a pool is imported when a device was unavailable, then the device will be identified by a unique identifier instead of its path since the path was never correct in the first place. -.RE - -.sp -.LP -If a device is removed and later re-attached to the system, \fBZFS\fR attempts -to put the device online automatically. Device attach detection is +.El +.Pp +If a device is removed and later reattached to the system, +.Tn ZFS +attempts to put the device online automatically. Device attach detection is hardware-dependent and might not be supported on all platforms. -.SS "Hot Spares" -.sp -.LP -\fBZFS\fR allows devices to be associated with pools as "hot spares". These -devices are not actively used in the pool, but when an active device fails, it -is automatically replaced by a hot spare. To create a pool with hot spares, -specify a "spare" \fBvdev\fR with any number of devices. For example, -.sp -.in +2 -.nf -# zpool create pool mirror da0 da1 spare da2 da3 -.fi -.in -2 -.sp - -.sp -.LP -Spares can be shared across multiple pools, and can be added with the "\fBzpool -add\fR" command and removed with the "\fBzpool remove\fR" command. Once a spare -replacement is initiated, a new "spare" \fBvdev\fR is created within the -configuration that will remain there until the original device is replaced. At -this point, the hot spare becomes available again if another device fails. -.sp -.LP +.Ss Hot Spares +.Tn ZFS +allows devices to be associated with pools as +.Qq hot spares Ns . +These devices are not actively used in the pool, but when an active device +fails, it is automatically replaced by a hot spare. To create a pool with hot +spares, specify a +.Qq spare +.No vdev +with any number of devices. For example, +.Bd -literal -offset 2n +.Li # Ic zpool create pool mirror da0 da1 spare da2 da3 +.Ed +.Pp +Spares can be shared across multiple pools, and can be added with the +.Qq Nm Cm add +command and removed with the +.Qq Nm Cm remove +command. Once a spare replacement is initiated, a new "spare" +.No vdev +is created +within the configuration that will remain there until the original device is +replaced. At this point, the hot spare becomes available again if another +device fails. +.Pp If a pool has a shared spare that is currently being used, the pool can not be exported since other pools may use this shared spare, which may lead to potential data corruption. -.sp -.LP +.Pp An in-progress spare replacement can be cancelled by detaching the hot spare. If the original faulted device is detached, then the hot spare assumes its place in the configuration, and is removed from the spare list of all active pools. -.sp -.LP +.Pp Spares cannot replace log devices. -.SS "Intent Log" -.sp -.LP -The \fBZFS\fR Intent Log (\fBZIL\fR) satisfies \fBPOSIX\fR requirements for -synchronous transactions. For instance, databases often require their -transactions to be on stable storage devices when returning from a system call. -\fBNFS\fR and other applications can also use \fBfsync\fR() to ensure data -stability. By default, the intent log is allocated from blocks within the main -pool. However, it might be possible to get better performance using separate -intent log devices such as \fBNVRAM\fR or a dedicated disk. For example: -.sp -.in +2 -.nf -\fB# zpool create pool da0 da1 log da3\fR -.fi -.in -2 -.sp - -.sp -.LP +.Ss Intent Log +The +.Tn ZFS +Intent Log +.Pq Tn ZIL +satisfies +.Tn POSIX +requirements for synchronous transactions. For instance, databases often +require their transactions to be on stable storage devices when returning from +a system call. +.Tn NFS +and other applications can also use +.Xr fsync 2 +to ensure data stability. By default, the intent log is allocated from blocks +within the main pool. However, it might be possible to get better performance +using separate intent log devices such as +.Tn NVRAM +or a dedicated disk. For example: +.Bd -literal -offset 2n +.Li # Ic zpool create pool da0 da1 log da2 +.Ed +.Pp Multiple log devices can also be specified, and they can be mirrored. See the -EXAMPLES section for an example of mirroring multiple log devices. -.sp -.LP -Log devices can be added, replaced, attached, detached, and imported and -exported as part of the larger pool. Mirrored log devices can be removed by -specifying the top-level mirror for the log. -.SS "Cache Devices" -.sp -.LP +.Sx EXAMPLES +section for an example of mirroring multiple log devices. +.Pp +Log devices can be added, replaced, attached, detached, imported and exported +as part of the larger pool. Mirrored log devices can be removed by specifying +the top-level mirror for the log. +.Ss Cache devices Devices can be added to a storage pool as "cache devices." These devices provide an additional layer of caching between main memory and disk. For read-heavy workloads, where the working set size is much larger than what can @@ -494,172 +487,149 @@ be cached in main memory, using cache devices allow much more of this working set to be served from low latency media. Using cache devices provides the greatest performance improvement for random read-workloads of mostly static content. -.sp -.LP -To create a pool with cache devices, specify a "cache" \fBvdev\fR with any -number of devices. For example: -.sp -.in +2 -.nf -\fB# zpool create pool da0 da1 cache da2 da3\fR -.fi -.in -2 -.sp - -.sp -.LP -Cache devices cannot be mirrored or part of a \fBraidz\fR configuration. If a -read error is encountered on a cache device, that read \fBI/O\fR is reissued to -the original storage pool device, which might be part of a mirrored or -\fBraidz\fR configuration. -.sp -.LP +.Pp +To create a pool with cache devices, specify a "cache" +.No vdev +with any number of devices. For example: +.Bd -literal -offset 2n +.Li # Ic zpool create pool da0 da1 cache da2 da3 +.Ed +.Pp +Cache devices cannot be mirrored or part of a +.No raidz +configuration. If a read +error is encountered on a cache device, that read +.Tn I/O +is reissued to the original storage pool device, which might be part of a +mirrored or +.No raidz +configuration. +.Pp The content of the cache devices is considered volatile, as is the case with other system caches. -.SS "Properties" -.sp -.LP +.Ss Properties Each pool has several properties associated with it. Some properties are read-only statistics while others are configurable and change the behavior of the pool. The following are read-only properties: -.sp -.ne 2 -.na -\fB\fBavailable\fR\fR -.ad -.RS 20n -Amount of storage available within the pool. This property can also be referred -to by its shortened column name, "avail". -.RE - -.sp -.ne 2 -.na -\fB\fBcapacity\fR\fR -.ad -.RS 20n +.Bl -tag -width "dedupratio" +.It Sy alloc +Amount of storage space within the pool that has been physically allocated. +.It Sy capacity Percentage of pool space used. This property can also be referred to by its shortened column name, "cap". -.RE - -.sp -.ne 2 -.na -\fB\fBhealth\fR\fR -.ad -.RS 20n -The current health of the pool. Health can be "\fBONLINE\fR", "\fBDEGRADED\fR", -"\fBFAULTED\fR", " \fBOFFLINE\fR", "\fBREMOVED\fR", or "\fBUNAVAIL\fR". -.RE - -.sp -.ne 2 -.na -\fB\fBguid\fR\fR -.ad -.RS 20n +.It Sy comment +A text string consisting of printable ASCII characters that will be stored +such that it is available even if the pool becomes faulted. An administrator +can provide additional information about a pool using this property. +.It Sy dedupratio +The deduplication ratio specified for a pool, expressed as a multiplier. +For example, a +.S dedupratio +value of 1.76 indicates that 1.76 units of data were stored but only 1 unit of disk space was actually consumed. See +.Xr zfs 8 +for a description of the deduplication feature. +.It Sy free +Number of blocks within the pool that are not allocated. +.It Sy guid A unique identifier for the pool. -.RE - -.sp -.ne 2 -.na -\fB\fBsize\fR\fR -.ad -.RS 20n +.It Sy health +The current health of the pool. Health can be +.Qq Sy ONLINE Ns , +.Qq Sy DEGRADED Ns , +.Qq Sy FAULTED Ns , +.Qq Sy OFFLINE Ns , +.Qq Sy REMOVED Ns , or +.Qq Sy UNAVAIL Ns . +.It Sy size Total size of the storage pool. -.RE - -.sp -.ne 2 -.na -\fB\fBused\fR\fR -.ad -.RS 20n +.It Sy used Amount of storage space used within the pool. -.RE - -.sp -.LP +.El +.Pp These space usage properties report actual physical space available to the storage pool. The physical space can be different from the total amount of space that any contained datasets can actually use. The amount of space used in -a \fBraidz\fR configuration depends on the characteristics of the data being -written. In addition, \fBZFS\fR reserves some space for internal accounting -that the \fBzfs\fR(8) command takes into account, but the \fBzpool\fR command -does not. For non-full pools of a reasonable size, these effects should be -invisible. For small pools, or pools that are close to being completely full, -these discrepancies may become more noticeable. -.sp -.LP +a +.No raidz +configuration depends on the characteristics of the data being written. +In addition, +.Tn ZFS +reserves some space for internal accounting that the +.Xr zfs 8 +command takes into account, but the +.Xr zpool 8 +command does not. For non-full pools of a reasonable size, these effects should +be invisible. For small pools, or pools that are close to being completely +full, these discrepancies may become more noticeable. +.Pp The following property can be set at creation time and import time: -.sp -.ne 2 -.na -\fB\fBaltroot\fR\fR -.ad -.sp .6 -.RS 4n +.Bl -tag -width 2n +.It Sy altroot Alternate root directory. If set, this directory is prepended to any mount points within the pool. This can be used when examining an unknown pool where the mount points cannot be trusted, or in an alternate boot environment, where -the typical paths are not valid. \fBaltroot\fR is not a persistent property. It -is valid only while the system is up. Setting \fBaltroot\fR defaults to using -\fBcachefile\fR=none, though this may be overridden using an explicit setting. -.RE - -.sp -.LP +the typical paths are not valid. +.Sy altroot +is not a persistent property. It is valid only while the system is up. +Setting +.Sy altroot +defaults to using +.Cm cachefile=none Ns , +though this may be overridden using an explicit setting. +.El +.Pp +The following property can only be set at import time: +.Bl -tag -width 2n +.It Sy readonly Ns = Ns Cm on No | Cm off +If set to +.Cm on Ns , +pool will be imported in read-only mode with the following restrictions: +.Bl -bullet -offset 2n +.It +Synchronous data in the intent log will not be accessible +.It +Properties of the pool can not be changed +.It +Datasets of this pool can only be mounted read-only +.It +To write to a read-only pool, a export and import of the pool is required. +.El +.El +.Pp The following properties can be set at creation time and import time, and later -changed with the \fBzpool set\fR command: -.sp -.ne 2 -.na -\fB\fBautoexpand\fR=\fBon\fR | \fBoff\fR\fR -.ad -.sp .6 -.RS 4n +changed with the +.Ic zpool set +command: +.Bl -tag -width 2n +.It Sy autoexpand Ns = Ns Cm on No | Cm off Controls automatic pool expansion when the underlying LUN is grown. If set to -\fBon\fR, the pool will be resized according to the size of the expanded -device. If the device is part of a mirror or \fBraidz\fR then all devices -within that mirror/\fBraidz\fR group must be expanded before the new space is -made available to the pool. The default behavior is \fBoff\fR. This property -can also be referred to by its shortened column name, \fBexpand\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBautoreplace\fR=\fBon\fR | \fBoff\fR\fR -.ad -.sp .6 -.RS 4n -Controls automatic device replacement. If set to "\fBoff\fR", device -replacement must be initiated by the administrator by using the "\fBzpool -replace\fR" command. If set to "\fBon\fR", any new device, found in the same +.Qq Cm on Ns , +the pool will be resized according to the size of the expanded +device. If the device is part of a mirror or +.No raidz +then all devices within that +.No mirror/ Ns No raidz +group must be expanded before the new space is made available to +the pool. The default behavior is +.Qq off Ns . +This property can also be referred to by its shortened column name, +.Sy expand Ns . +.It Sy autoreplace Ns = Ns Cm on No | Cm off +Controls automatic device replacement. If set to +.Qq Cm off Ns , +device replacement must be initiated by the administrator by using the +.Qq Nm Cm replace +command. If set to +.Qq Cm on Ns , +any new device, found in the same physical location as a device that previously belonged to the pool, is -automatically formatted and replaced. The default behavior is "\fBoff\fR". This -property can also be referred to by its shortened column name, "replace". -.RE - -.sp -.ne 2 -.na -\fB\fBbootfs\fR=\fIpool\fR/\fIdataset\fR\fR -.ad -.sp .6 -.RS 4n +automatically formatted and replaced. The default behavior is +.Qq Cm off Ns . +This property can also be referred to by its shortened column name, "replace". +.It Sy bootfs Ns = Ns Ar pool Ns / Ns Ar dataset Identifies the default bootable dataset for the root pool. This property is expected to be set mainly by the installation and upgrade programs. -.RE - -.sp -.ne 2 -.na -\fB\fBcachefile\fR=\fIpath\fR | \fBnone\fR\fR -.ad -.sp .6 -.RS 4n +.It Sy cachefile Ns = Ns Ar path No | Cm none Controls the location of where the pool configuration is cached. Discovering all pools on system startup requires a cached copy of the configuration data that is stored on the root file system. All pools in this cache are @@ -667,1137 +637,1072 @@ automatically imported when the system boots. Some environments, such as install and clustering, need to cache this information in a different location so that pools are not automatically imported. Setting this property caches the pool configuration in a different location that can later be imported with -"\fBzpool import -c\fR". Setting it to the special value "\fBnone\fR" creates a -temporary pool that is never cached, and the special value \fB\&''\fR (empty -string) uses the default location. -.sp -Multiple pools can share the same cache file. Because the kernel destroys and -recreates this file when pools are added and removed, care should be taken when -attempting to access this file. When the last pool using a \fBcachefile\fR is -exported or destroyed, the file is removed. -.RE - -.sp -.ne 2 -.na -\fB\fBdelegation\fR=\fBon\fR | \fBoff\fR\fR -.ad -.sp .6 -.RS 4n +.Qq Nm Cm import Fl c . +Setting it to the special value +.Qq Cm none +creates a temporary pool that is never cached, and the special value +.Cm '' +(empty string) uses the default location. +.It Sy dedupditto Ns = Ns Ar number +Threshold for the number of block ditto copies. If the reference count for a +deduplicated block increases above this number, a new ditto copy of this block +is automatically stored. Deafult setting is +.Cm 0 Ns . +.It Sy delegation Ns = Ns Cm on No | Cm off Controls whether a non-privileged user is granted access based on the dataset -permissions defined on the dataset. See \fBzfs\fR(8) for more information on -\fBZFS\fR delegated administration. -.RE - -.sp -.ne 2 -.na -\fB\fBfailmode\fR=\fBwait\fR | \fBcontinue\fR | \fBpanic\fR\fR -.ad -.sp .6 -.RS 4n +permissions defined on the dataset. See +.Xr zfs 8 +for more information on +.Tn ZFS +delegated administration. +.It Sy failmode Ns = Ns Cm wait No | Cm continue No | Cm panic Controls the system behavior in the event of catastrophic pool failure. This condition is typically a result of a loss of connectivity to the underlying storage device(s) or a failure of all devices within the pool. The behavior of such an event is determined as follows: -.sp -.ne 2 -.na -\fB\fBwait\fR\fR -.ad -.RS 12n -Blocks all \fBI/O\fR access until the device connectivity is recovered and the -errors are cleared. This is the default behavior. -.RE - -.sp -.ne 2 -.na -\fB\fBcontinue\fR\fR -.ad -.RS 12n -Returns \fBEIO\fR to any new write \fBI/O\fR requests but allows reads to any -of the remaining healthy devices. Any write requests that have yet to be -committed to disk would be blocked. -.RE - -.sp -.ne 2 -.na -\fB\fBpanic\fR\fR -.ad -.RS 12n +.Bl -tag -width indent +.It Sy wait +Blocks all +.Tn I/O +access until the device connectivity is recovered and the errors are cleared. +This is the default behavior. +.It Sy continue +Returns +.Em EIO +to any new write +.Tn I/O +requests but allows reads to any of the remaining healthy devices. Any write +requests that have yet to be committed to disk would be blocked. +.It Sy panic Prints out a message to the console and generates a system crash dump. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBlistsnaps\fR=on | off\fR -.ad -.sp .6 -.RS 4n +.El +.It Sy listsnaps Ns = Ns Cm on No | Cm off Controls whether information about snapshots associated with this pool is -output when "\fBzfs list\fR" is run without the \fB-t\fR option. The default -value is "off". -.RE - -.sp -.ne 2 -.na -\fB\fBversion\fR=\fIversion\fR\fR -.ad -.sp .6 -.RS 4n +output when +.Qq Nm zfs Cm list +is run without the +.Fl t +option. The default value is +.Cm off . +.It Sy version Ns = Ns Ar version The current on-disk version of the pool. This can be increased, but never -decreased. The preferred method of updating pools is with the "\fBzpool -upgrade\fR" command, though this property can be used when a specific version -is needed for backwards compatibility. This property can be any number between -1 and the current version reported by "\fBzpool upgrade -v\fR". -.RE - -.SS "Subcommands" -.sp -.LP +decreased. The preferred method of updating pools is with the +.Qq Nm Cm upgrade +command, though this property can be used when a specific version is needed +for backwards compatibility. This property can be any number between 1 and the +current version reported by +.Qo Ic zpool upgrade -v Qc Ns . +.El +.Sh SUBCOMMANDS All subcommands that modify state are logged persistently to the pool in their original form. -.sp -.LP -The \fBzpool\fR command provides subcommands to create and destroy storage -pools, add capacity to storage pools, and provide information about the storage -pools. The following subcommands are supported: -.sp -.ne 2 -.na -\fB\fBzpool\fR \fB-?\fR\fR -.ad -.sp .6 -.RS 4n +.Pp +The +.Nm +command provides subcommands to create and destroy storage pools, add capacity +to storage pools, and provide information about the storage pools. The following +subcommands are supported: +.Bl -tag -width 2n +.It Xo +.Nm +.Op Fl \&? +.Xc +.Pp Displays a help message. -.RE - -.sp -.ne 2 -.na -\fB\fBzpool add\fR [\fB-fn\fR] \fIpool\fR \fIvdev\fR ...\fR -.ad -.sp .6 -.RS 4n -Adds the specified virtual devices to the given pool. The \fIvdev\fR -specification is described in the "Virtual Devices" section. The behavior of -the \fB-f\fR option, and the device checks performed are described in the -"zpool create" subcommand. -.sp -.ne 2 -.na -\fB\fB-f\fR\fR -.ad -.RS 6n -Forces use of \fBvdev\fRs, even if they appear in use or specify a conflicting -replication level. Not all devices can be overridden in this manner. -.RE - -.sp -.ne 2 -.na -\fB\fB-n\fR\fR -.ad -.RS 6n +.It Xo +.Nm +.Cm add +.Op Fl fn +.Ar pool vdev ... +.Xc +.Pp +Adds the specified virtual devices to the given pool. The +.No vdev +specification is described in the +.Qq Sx Virtual Devices +section. The behavior of the +.Fl f +option, and the device checks performed are described in the +.Qq Nm Cm create +subcommand. +.Bl -tag -width indent +.It Fl f +Forces use of +.Ar vdev Ns , +even if they appear in use or specify a conflicting replication level. +Not all devices can be overridden in this manner. +.It Fl n Displays the configuration that would be used without actually adding the -\fBvdev\fRs. The actual pool creation can still fail due to insufficient -privileges or device sharing. -.RE - +.Ar vdev Ns s. +The actual pool creation can still fail due to insufficient privileges or device +sharing. +.Pp Do not add a disk that is currently configured as a quorum device to a zpool. After a disk is in the pool, that disk can then be configured as a quorum device. -.RE - -.sp -.ne 2 -.na -\fB\fBzpool attach\fR [\fB-f\fR] \fIpool\fR \fIdevice\fR \fInew_device\fR\fR -.ad -.sp .6 -.RS 4n -Attaches \fInew_device\fR to an existing \fBzpool\fR device. The existing -device cannot be part of a \fBraidz\fR configuration. If \fIdevice\fR is not -currently part of a mirrored configuration, \fIdevice\fR automatically -transforms into a two-way mirror of \fIdevice\fR and \fInew_device\fR. If -\fIdevice\fR is part of a two-way mirror, attaching \fInew_device\fR creates a -three-way mirror, and so on. In either case, \fInew_device\fR begins to -resilver immediately. -.sp -.ne 2 -.na -\fB\fB-f\fR\fR -.ad -.RS 6n -Forces use of \fInew_device\fR, even if its appears to be in use. Not all -devices can be overridden in this manner. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBzpool clear\fR \fIpool\fR [\fIdevice\fR] ...\fR -.ad -.sp .6 -.RS 4n +.El +.It Xo +.Nm +.Cm attach +.Op Fl f +.Ar pool device new_device +.Xc +.Pp +Attaches +.Ar new_device +to an existing +.Sy zpool +device. The existing device cannot be part of a +.No raidz +configuration. If +.Ar device +is not currently part of a mirrored configuration, +.Ar device +automatically transforms into a two-way mirror of +.Ar device No and Ar new_device Ns . If +.Ar device +is part of a two-way mirror, attaching +.Ar new_device +creates a three-way mirror, and so on. In either case, +.Ar new_device +begins to resilver immediately. +.Bl -tag -width indent +.It Fl f +Forces use of +.Ar new_device Ns , +even if its appears to be in use. Not all devices can be overridden in this +manner. +.El +.It Xo +.Nm +.Cm clear +.Op Fl F Op Fl n +.Ar pool +.Op Ar device +.Xc +.Pp Clears device errors in a pool. If no arguments are specified, all device errors within the pool are cleared. If one or more devices is specified, only those errors associated with the specified device or devices are cleared. -.RE - -.sp -.ne 2 -.na -\fB\fBzpool create\fR [\fB-fn\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-O\fR -\fIfile-system-property=value\fR] ... [\fB-m\fR \fImountpoint\fR] [\fB-R\fR -\fIroot\fR] \fIpool\fR \fIvdev\fR ...\fR -.ad -.sp .6 -.RS 4n +.Bl -tag -width indent +.It Fl F +Initiates recovery mode for an unopenable pool. Attempts to discard the last +few transactions in the pool to return it to an openable state. Not all damaged +pools can be recovered by using this option. If successful, the data from the +discarded transactions is irretrievably lost. +.It Fl n +Used in combination with the +.Fl F +flag. Check whether discarding transactions would make the pool openable, but +do not actually discard any transactions. +.El +.It Xo +.Nm +.Cm create +.Op Fl fn +.Op Fl o Ar property Ns = Ns Ar value +.Ar ... +.Op Fl O Ar file-system-property Ns = Ns Ar value +.Ar ... +.Op Fl m Ar mountpoint +.Op Fl R Ar root +.Ar pool vdev ... +.Xc +.Pp Creates a new storage pool containing the virtual devices specified on the command line. The pool name must begin with a letter, and can only contain alphanumeric characters as well as underscore ("_"), dash ("-"), and period ("."). The pool names "mirror", "raidz", "spare" and "log" are reserved, as are -names beginning with the pattern "c[0-9]". The \fBvdev\fR specification is -described in the "Virtual Devices" section. -.sp +names beginning with the pattern "c[0-9]". The +.No vdev +specification is described in the +.Qq Sx Virtual Devices +section. +.Pp The command verifies that each device specified is accessible and not currently in use by another subsystem. There are some uses, such as being currently mounted, or specified as the dedicated dump device, that prevents a device from -ever being used by \fBZFS\fR. Other uses, such as having a preexisting -\fBUFS\fR file system, can be overridden with the \fB-f\fR option. -.sp +ever being used by +.Tn ZFS +Other uses, such as having a preexisting +.Sy UFS +file system, can be overridden with the +.Fl f +option. +.Pp The command also checks that the replication strategy for the pool is consistent. An attempt to combine redundant and non-redundant storage in a -single pool, or to mix disks and files, results in an error unless \fB-f\fR is -specified. The use of differently sized devices within a single \fBraidz\fR or -mirror group is also flagged as an error unless \fB-f\fR is specified. -.sp -Unless the \fB-R\fR option is specified, the default mount point is -"/\fIpool\fR". The mount point must not exist or must be empty, or else the -root dataset cannot be mounted. This can be overridden with the \fB-m\fR +single pool, or to mix disks and files, results in an error unless +.Fl f +is specified. The use of differently sized devices within a single +.No raidz +or mirror group is also flagged as an error unless +.Fl f +is specified. +.Pp +Unless the +.Fl R +option is specified, the default mount point is +.Qq Pa /pool Ns . +The mount point must not exist or must be empty, or else the +root dataset cannot be mounted. This can be overridden with the +.Fl m option. -.sp -.ne 2 -.na -\fB\fB-f\fR\fR -.ad -.sp .6 -.RS 4n -Forces use of \fBvdev\fRs, even if they appear in use or specify a conflicting -replication level. Not all devices can be overridden in this manner. -.RE - -.sp -.ne 2 -.na -\fB\fB-n\fR\fR -.ad -.sp .6 -.RS 4n +.Bl -tag -width indent +.It Fl f +Forces use of +.Ar vdev Ns s, +even if they appear in use or specify a conflicting replication level. +Not all devices can be overridden in this manner. +.It Fl n Displays the configuration that would be used without actually creating the pool. The actual pool creation can still fail due to insufficient privileges or device sharing. -.RE - -.sp -.ne 2 -.na -\fB\fB-o\fR \fIproperty=value\fR [\fB-o\fR \fIproperty=value\fR] ...\fR -.ad -.sp .6 -.RS 4n -Sets the given pool properties. See the "Properties" section for a list of -valid properties that can be set. -.RE - -.sp -.ne 2 -.na -\fB\fB-O\fR \fIfile-system-property=value\fR\fR -.ad -.br -.na -\fB[\fB-O\fR \fIfile-system-property=value\fR] ...\fR -.ad -.sp .6 -.RS 4n +.It Xo +.Fl o Ar property Ns = Ns Ar value +.Op Fl o Ar property Ns = Ns Ar value +.Ar ... +.Xc +Sets the given pool properties. See the +.Qq Sx Properties +section for a list of valid properties that can be set. +.It Xo +.Fl O +.Ar file-system-property Ns = Ns Ar value +.Op Fl O Ar file-system-property Ns = Ns Ar value +.Ar ... +.Xc Sets the given file system properties in the root file system of the pool. See -the "Properties" section of \fBzfs\fR(8) for a list of valid properties that +.Xr zfs 8 Properties +for a list of valid properties that can be set. -.RE - -.sp -.ne 2 -.na -\fB\fB-R\fR \fIroot\fR\fR -.ad -.sp .6 -.RS 4n -Equivalent to "-o cachefile=none,altroot=\fIroot\fR" -.RE - -.sp -.ne 2 -.na -\fB\fB-m\fR \fImountpoint\fR\fR -.ad -.sp .6 -.RS 4n +.It Fl R Ar root +Equivalent to +.Qq Fl o Cm cachefile=none,altroot= Ns Pa root +.It Fl m Ar mountpoint Sets the mount point for the root dataset. The default mount point is -"/\fIpool\fR" or "\fBaltroot\fR/\fIpool\fR" if \fBaltroot\fR is specified. The -mount point must be an absolute path, "\fBlegacy\fR", or "\fBnone\fR". For more -information on dataset mount points, see \fBzfs\fR(8). -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBzpool destroy\fR [\fB-f\fR] \fIpool\fR\fR -.ad -.sp .6 -.RS 4n +.Qq Pa /pool +or +.Qq Cm altroot Ns Pa /pool +if +.Sy altroot +is specified. The mount point must be an absolute path, +.Qq Cm legacy Ns , or Qq Cm none Ns . +For more information on dataset mount points, see +.Xr zfs 8 Ns \&. +.El +.It Xo +.Nm +.Cm destroy +.Op Fl f +.Ar pool +.Xc +.Pp Destroys the given pool, freeing up any devices for other use. This command tries to unmount any active datasets before destroying the pool. -.sp -.ne 2 -.na -\fB\fB-f\fR\fR -.ad -.RS 6n +.Bl -tag -width indent +.It Fl f Forces any active datasets contained within the pool to be unmounted. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBzpool detach\fR \fIpool\fR \fIdevice\fR\fR -.ad -.sp .6 -.RS 4n -Detaches \fIdevice\fR from a mirror. The operation is refused if there are no -other valid replicas of the data. -.RE - -.sp -.ne 2 -.na -\fB\fBzpool export\fR [\fB-f\fR] \fIpool\fR ...\fR -.ad -.sp .6 -.RS 4n +.El +.It Xo +.Nm +.Cm detach +.Ar pool device +.Xc +.Pp +Detaches +.Ar device +from a mirror. The operation is refused if there are no other valid replicas +of the data. +.It Xo +.Nm +.Cm export +.Op Fl f +.Ar pool ... +.Xc +.Pp Exports the given pools from the system. All devices are marked as exported, but are still considered in use by other subsystems. The devices can be moved between systems (even those of different endianness) and imported as long as a sufficient number of devices are present. -.sp +.Pp Before exporting the pool, all datasets within the pool are unmounted. A pool can not be exported if it has a shared spare that is currently being used. -.sp -For pools to be portable, you must give the \fBzpool\fR command whole disks, -not just slices, so that \fBZFS\fR can label the disks with portable \fBEFI\fR +.Pp +For pools to be portable, you must give the +.Nm +command whole disks, not just slices, so that +.Tn ZFS +can label the disks with portable +.Sy EFI labels. Otherwise, disk drivers on platforms of different endianness will not recognize the disks. -.sp -.ne 2 -.na -\fB\fB-f\fR\fR -.ad -.RS 6n -Forcefully unmount all datasets, using the "\fBunmount -f\fR" command. -.sp +.Bl -tag -width indent +.It Fl f +Forcefully unmount all datasets, using the +.Qq Nm unmount Fl f +command. +.Pp This command will forcefully export the pool even if it has a shared spare that is currently being used. This may lead to potential data corruption. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBzpool get\fR "\fIall\fR" | \fIproperty\fR[,...] \fIpool\fR ...\fR -.ad -.sp .6 -.RS 4n -Retrieves the given list of properties (or all properties if "\fBall\fR" is -used) for the specified storage pool(s). These properties are displayed with +.El +.It Xo +.Nm +.Cm get +.Ar all | property Ns Op , Ns Ar ... +.Ar pool ... +.Xc +.Pp +Retrieves the given list of properties (or all properties if +.Qq Cm all +is used) for the specified storage pool(s). These properties are displayed with the following fields: -.sp -.in +2 -.nf - name Name of storage pool - property Property name - value Property value - source Property source, either 'default' or 'local'. -.fi -.in -2 -.sp - -See the "Properties" section for more information on the available pool -properties. -.RE - -.sp -.ne 2 -.na -\fB\fBzpool history\fR [\fB-il\fR] [\fIpool\fR] ...\fR -.ad -.sp .6 -.RS 4n +.Bl -column -offset indent "property" +.It name Ta Name of storage pool +.It property Ta Property name +.It value Ta Property value +.It source Ta Property source, either 'default' or 'local'. +.El +.Pp +See the +.Qq Sx Properties +section for more information on the available pool properties. +.It Xo +.Nm +.Cm history +.Op Fl il +.Op Ar pool +.Ar ... +.Xc +.Pp Displays the command history of the specified pools or all pools if no pool is specified. -.sp -.ne 2 -.na -\fB\fB-i\fR\fR -.ad -.RS 6n -Displays internally logged \fBZFS\fR events in addition to user initiated -events. -.RE - -.sp -.ne 2 -.na -\fB\fB-l\fR\fR -.ad -.RS 6n +.Bl -tag -width indent +.It Fl i +Displays internally logged +.Tn ZFS +events in addition to user initiated events. +.It Fl l Displays log records in long format, which in addition to standard format -includes, the user name, the hostname, and the jail in which the operation was +includes, the user name, the hostname, and the zone in which the operation was performed. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBzpool import\fR [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR] -[\fB-D\fR]\fR -.ad -.sp .6 -.RS 4n -Lists pools available to import. If the \fB-d\fR option is not specified, this -command searches for devices in "/dev/dsk". The \fB-d\fR option can be -specified multiple times, and all directories are searched. If the device -appears to be part of an exported pool, this command displays a summary of the -pool with the name of the pool, a numeric identifier, as well as the \fIvdev\fR -layout and current health of the device for each device or file. Destroyed -pools, pools that were previously destroyed with the "\fBzpool destroy\fR" -command, are not listed unless the \fB-D\fR option is specified. -.sp +.El +.It Xo +.Nm +.Cm import +.Op Fl d Ar dir | Fl c Ar cachefile +.Op Fl D +.Xc +.Pp +Lists pools available to import. If the +.Fl d +option is not specified, this command searches for devices in +.Qq Pa /dev Ns . +The +.Fl d +option can be specified multiple times, and all directories are searched. If +the device appears to be part of an exported pool, this command displays a +summary of the pool with the name of the pool, a numeric identifier, as well as +the +.No vdev +layout and current health of the device for each device or file. +Destroyed pools, pools that were previously destroyed with the +.Qq Nm Cm destroy +command, are not listed unless the +.Fl D +option is specified. +.Pp The numeric identifier is unique, and can be used instead of the pool name when multiple exported pools of the same name are available. -.sp -.ne 2 -.na -\fB\fB-c\fR \fIcachefile\fR\fR -.ad -.RS 16n -Reads configuration from the given \fBcachefile\fR that was created with the -"\fBcachefile\fR" pool property. This \fBcachefile\fR is used instead of -searching for devices. -.RE - -.sp -.ne 2 -.na -\fB\fB-d\fR \fIdir\fR\fR -.ad -.RS 16n -Searches for devices or files in \fIdir\fR. The \fB-d\fR option can be -specified multiple times. -.RE - -.sp -.ne 2 -.na -\fB\fB-D\fR\fR -.ad -.RS 16n +.Bl -tag -width indent +.It Fl c Ar cachefile +Reads configuration from the given +.Ar cachefile +that was created with the +.Qq Sy cachefile +pool property. This +.Ar cachefile +is used instead of searching for devices. +.It Fl d Ar dir +Searches for devices or files in +.Ar dir Ns . +The +.Fl d +option can be specified multiple times. +.It Fl D Lists destroyed pools only. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBzpool import\fR [\fB-o\fR \fImntopts\fR] [ \fB-o\fR -\fIproperty\fR=\fIvalue\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR] -[\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] \fB-a\fR\fR -.ad -.sp .6 -.RS 4n +.El +.It Xo +.Nm +.Cm import +.Op Fl o Ar mntopts +.Op Fl o Ar property Ns = Ns Ar value +.Ar ... +.Op Fl d Ar dir | Fl c Ar cachefile +.Op Fl D +.Op Fl f +.Op Fl m +.Op Fl N +.Op Fl R Ar root +.Op Fl F Op Fl +.Fl a +.Xc +.Pp Imports all pools found in the search directories. Identical to the previous command, except that all pools with a sufficient number of devices available are imported. Destroyed pools, pools that were previously destroyed with the -"\fBzpool destroy\fR" command, will not be imported unless the \fB-D\fR option -is specified. -.sp -.ne 2 -.na -\fB\fB-o\fR \fImntopts\fR\fR -.ad -.RS 21n +.Qq Nm Cm destroy +command, will not be imported unless the +.Fl D +option is specified. +.Bl -tag -width indent +.It Fl o Ar mntopts Comma-separated list of mount options to use when mounting datasets within the -pool. See \fBzfs\fR(8) for a description of dataset properties and mount -options. -.RE - -.sp -.ne 2 -.na -\fB\fB-o\fR \fIproperty=value\fR\fR -.ad -.RS 21n -Sets the specified property on the imported pool. See the "Properties" section -for more information on the available pool properties. -.RE - -.sp -.ne 2 -.na -\fB\fB-c\fR \fIcachefile\fR\fR -.ad -.RS 21n -Reads configuration from the given \fBcachefile\fR that was created with the -"\fBcachefile\fR" pool property. This \fBcachefile\fR is used instead of -searching for devices. -.RE - -.sp -.ne 2 -.na -\fB\fB-d\fR \fIdir\fR\fR -.ad -.RS 21n -Searches for devices or files in \fIdir\fR. The \fB-d\fR option can be -specified multiple times. This option is incompatible with the \fB-c\fR option. -.RE - -.sp -.ne 2 -.na -\fB\fB-D\fR\fR -.ad -.RS 21n -Imports destroyed pools only. The \fB-f\fR option is also required. -.RE - -.sp -.ne 2 -.na -\fB\fB-f\fR\fR -.ad -.RS 21n +pool. See +.Xr zfs 8 +for a description of dataset properties and mount options. +.It Fl o Ar property Ns = Ns Ar value +Sets the specified property on the imported pool. See the +.Qq Sx Properties +section for more information on the available pool properties. +.It Fl c Ar cachefile +Reads configuration from the given +.Ar cachefile +that was created with the +.Qq Sy cachefile +pool property. This +.Ar cachefile +is used instead of searching for devices. +.It Fl d Ar dir +Searches for devices or files in +.Ar dir Ns . +The +.Fl d +option can be specified multiple times. This option is incompatible with the +.Fl c +option. +.It Fl D +Imports destroyed pools only. The +.Fl f +option is also required. +.It Fl f Forces import, even if the pool appears to be potentially active. -.RE - -.sp -.ne 2 -.na -\fB\fB-a\fR\fR -.ad -.RS 21n +.It Fl m +Enables import with missing log devices. +.It Fl N +Do not mount any filesystems from the imported pool. +.It Fl R Ar root +Sets the +.Qq Sy cachefile +property to +.Qq Cm none +and the +.Qq Sy altroot +property to +.Qq Ar root +.It Fl F +Recovery mode for a non-importable pool. Attempt to return the pool to an +importable state by discarding the last few transactions. Not all damaged pools +can be recovered by using this option. If successful, the data from the +discarded transactions is irretrievably lost. This option is ignored if the +pool is importable or already imported. +.It Fl n +Used with the +.Fl F +recovery option. Determines whether a non-importable pool can be made +importable again, but does not actually perform the pool recovery. For more +details about pool recovery mode, see the +.Fl F +option, above. +.It Fl a Searches for and imports all pools found. -.RE - -.sp -.ne 2 -.na -\fB\fB-R\fR \fIroot\fR\fR -.ad -.RS 21n -Sets the "\fBcachefile\fR" property to "\fBnone\fR" and the "\fIaltroot\fR" -property to "\fIroot\fR". -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBzpool import\fR [\fB-o\fR \fImntopts\fR] [ \fB-o\fR -\fIproperty\fR=\fIvalue\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR] -[\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] \fIpool\fR | \fIid\fR -[\fInewpool\fR]\fR -.ad -.sp .6 -.RS 4n +.El +.It Xo +.Nm +.Cm import +.Op Fl o Ar mntopts +.Op Fl o Ar property Ns = Ns Ar value +.Ar ... +.Op Fl d Ar dir | Fl c Ar cachefile +.Op Fl D +.Op Fl f +.Op Fl m +.Op Fl N +.Op Fl R Ar root +.Op Fl F Op Fl n +.Ar pool | id +.Op Ar newpool +.Xc +.Pp Imports a specific pool. A pool can be identified by its name or the numeric -identifier. If \fInewpool\fR is specified, the pool is imported using the name -\fInewpool\fR. Otherwise, it is imported with the same name as its exported -name. -.sp -If a device is removed from a system without running "\fBzpool export\fR" +identifier. If +.Ar newpool +is specified, the pool is imported using the name +.Ar newpool Ns . +Otherwise, it is imported with the same name as its exported name. +.Pp +If a device is removed from a system without running +.Qq Nm Cm export first, the device appears as potentially active. It cannot be determined if this was a failed export, or whether the device is really in use from another -host. To import a pool in this state, the \fB-f\fR option is required. -.sp -.ne 2 -.na -\fB\fB-o\fR \fImntopts\fR\fR -.ad -.sp .6 -.RS 4n +host. To import a pool in this state, the +.Fl f +option is required. +.Bl -tag -width indent +.It Fl o Ar mntopts Comma-separated list of mount options to use when mounting datasets within the -pool. See \fBzfs\fR(8) for a description of dataset properties and mount -options. -.RE - -.sp -.ne 2 -.na -\fB\fB-o\fR \fIproperty=value\fR\fR -.ad -.sp .6 -.RS 4n -Sets the specified property on the imported pool. See the "Properties" section -for more information on the available pool properties. -.RE - -.sp -.ne 2 -.na -\fB\fB-c\fR \fIcachefile\fR\fR -.ad -.sp .6 -.RS 4n -Reads configuration from the given \fBcachefile\fR that was created with the -"\fBcachefile\fR" pool property. This \fBcachefile\fR is used instead of -searching for devices. -.RE - -.sp -.ne 2 -.na -\fB\fB-d\fR \fIdir\fR\fR -.ad -.sp .6 -.RS 4n -Searches for devices or files in \fIdir\fR. The \fB-d\fR option can be -specified multiple times. This option is incompatible with the \fB-c\fR option. -.RE - -.sp -.ne 2 -.na -\fB\fB-D\fR\fR -.ad -.sp .6 -.RS 4n -Imports destroyed pool. The \fB-f\fR option is also required. -.RE - -.sp -.ne 2 -.na -\fB\fB-f\fR\fR -.ad -.sp .6 -.RS 4n +pool. See +.Xr zfs 8 +for a description of dataset properties and mount options. +.It Fl o Ar property Ns = Ns Ar value +Sets the specified property on the imported pool. See the +.Qq Sx Properties +section for more information on the available pool properties. +.It Fl c Ar cachefile +Reads configuration from the given +.Ar cachefile +that was created with the +.Qq Sy cachefile +pool property. This +.Ar cachefile +is used instead of searching for devices. +.It Fl d Ar dir +Searches for devices or files in +.Ar dir Ns . +The +.Fl d +option can be specified multiple times. This option is incompatible with the +.Fl c +option. +.It Fl D +Imports destroyed pools only. The +.Fl f +option is also required. +.It Fl f Forces import, even if the pool appears to be potentially active. -.RE - -.sp -.ne 2 -.na -\fB\fB-R\fR \fIroot\fR\fR -.ad -.sp .6 -.RS 4n -Sets the "\fBcachefile\fR" property to "\fBnone\fR" and the "\fIaltroot\fR" -property to "\fIroot\fR". -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBzpool iostat\fR [\fB-T\fR \fBu\fR | \fBd\fR] [\fB-v\fR] [\fIpool\fR] ... -[\fIinterval\fR[\fIcount\fR]]\fR -.ad -.sp .6 -.RS 4n -Displays \fBI/O\fR statistics for the given pools. When given an interval, the -statistics are printed every \fIinterval\fR seconds until \fBCtrl-C\fR is -pressed. If no \fIpools\fR are specified, statistics for every pool in the -system is shown. If \fIcount\fR is specified, the command exits after -\fIcount\fR reports are printed. -.sp -.ne 2 -.na -\fB\fB-T\fR \fBu\fR | \fBd\fR\fR -.ad -.RS 12n -Display a time stamp. -.sp -Specify \fBu\fR for a printed representation of the internal representation of -time. See \fBtime\fR(2). Specify \fBd\fR for standard date format. See -\fBdate\fR(1). -.RE - -.sp -.ne 2 -.na -\fB\fB-v\fR\fR -.ad -.RS 12n -Verbose statistics. Reports usage statistics for individual \fIvdevs\fR within -the pool, in addition to the pool-wide statistics. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBzpool labelclear\fR [\fB-f\fR] \fIdevice\fR -.ad -.sp .6 -.RS 4n -Removes ZFS label information from the specified device. The device must not -be part of an active pool configuration. -.sp -.ne 2 -.mk -.na -\fB\fB-f\fR\fR -.ad -.RS 12n -.rt +.It Fl m +Enables import with missing log devices. +.It Fl N +Do not mount any filesystems from the imported pool. +.It Fl R Ar root +Equivalent to +.Qq Fl o Cm cachefile=none,altroot= Ns Pa root +.It Fl F +Recovery mode for a non-importable pool. Attempt to return the pool to an +importable state by discarding the last few transactions. Not all damaged pools +can be recovered by using this option. If successful, the data from the +discarded transactions is irretrievably lost. This option is ignored if the +pool is importable or already imported. +.It Fl n +Used with the +.Fl F +recovery option. Determines whether a non-importable pool can be made +importable again, but does not actually perform the pool recovery. For more +details about pool recovery mode, see the +.Fl F +option, above. +.El +.It Xo +.Nm +.Cm iostat +.Op Fl T Cm d Ns | Ns Cm u +.Op Fl v +.Op Ar pool +.Ar ... +.Op Ar interval Op Ar count +.Xc +.Pp +Displays +.Tn I/O +statistics for the given pools. When given an interval, the statistics are +printed every +.Ar interval +seconds until +.Sy Ctrl-C +is pressed. If no +.Ar pools +are specified, statistics for every pool in the system is shown. If +.Ar count +is specified, the command exits after +.Ar count +reports are printed. +.Bl -tag -width indent +.It Fl T Cm d Ns | Ns Cm u +Print a timestamp. +.Pp +Use modifier +.Cm d +for standard date format. See +.Xr date 1 Ns . +Use modifier +.Cm u +for unixtime +.Pq equals Qq Ic date +%s Ns . +.It Fl v +Verbose statistics. Reports usage statistics for individual +.No vdev Ns s +within the pool, in addition to the pool-wide statistics. +.El +.It Xo +.Nm +.Cm labelclear +.Op Fl f +.Ar device +.Xc +.Pp +Removes +.Tn ZFS +label information from the specified +.Ar device Ns . +The +.Ar device +must not be part of an active pool configuration. +.Bl -tag -width indent +.It Fl v Treat exported or foreign devices as inactive. -.RE - -.RE - -.sp -.ne 2 -.mk -.na -\fB\fBzpool list\fR [\fB-H\fR] [\fB-o\fR \fIprops\fR[,...]] [\fIpool\fR] ...\fR -.ad -.sp .6 -.RS 4n +.El +.It Xo +.Nm +.Cm list +.Op Fl H +.Op Fl o Ar property Ns Op , Ns Ar ... +.Op Fl T Cm d Ns | Ns Cm u +.Op Ar pool +.Ar ... +.Op Ar inverval Op Ar count +.Xc +.Pp Lists the given pools along with a health status and space usage. When given no arguments, all pools in the system are listed. -.sp -.ne 2 -.na -\fB\fB-H\fR\fR -.ad -.RS 12n +.Pp +When given an interval, the output is printed every +.Ar interval +seconds until +.Sy Ctrl-C +is pressed. If +.Ar count +is specified, the command exits after +.Ar count +reports are printed. +.Bl -tag -width indent +.It Fl H Scripted mode. Do not display headers, and separate fields by a single tab instead of arbitrary space. -.RE - -.sp -.ne 2 -.na -\fB\fB-o\fR \fIprops\fR\fR -.ad -.RS 12n -Comma-separated list of properties to display. See the "Properties" section for -a list of valid properties. The default list is "name, size, used, available, -capacity, health, altroot" -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBzpool offline\fR [\fB-t\fR] \fIpool\fR \fIdevice\fR ...\fR -.ad -.sp .6 -.RS 4n -Takes the specified physical device offline. While the \fIdevice\fR is offline, -no attempt is made to read or write to the device. -.sp -This command is not applicable to spares or cache devices. -.sp -.ne 2 -.na -\fB\fB-t\fR\fR -.ad -.RS 6n +.It Fl o Ar property Ns Op , Ns Ar ... +Comma-separated list of properties to display. See the +.Qq Sx Properties +section for a list of valid properties. The default list is +.Sy name Ns , +.Sy size Ns , +.Sy used Ns , +.Sy available Ns , +.Sy capacity Ns , +.Sy health Ns , +.Sy altroot Ns . +.It Fl T Cm d Ns | Ns Cm u +Print a timestamp. +.Pp +Use modifier +.Cm d +for standard date format. See +.Xr date 1 Ns . +Use modifier +.Cm u +for unixtime +.Pq equals Qq Ic date +%s Ns . +.El +.It Xo +.Nm +.Cm offline +.Op Fl t +.Ar pool device ... +.Xc +.Pp +Takes the specified physical device offline. While the +.Ar device +is offline, no attempt is made to read or write to the device. +.Bl -tag -width indent +.It Fl t Temporary. Upon reboot, the specified physical device reverts to its previous state. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBzpool online\fR [\fB-e\fR] \fIpool\fR \fIdevice\fR...\fR -.ad -.sp .6 -.RS 4n +.El +.It Xo +.Nm +.Cm online +.Op Fl e +.Ar pool device ... +.Xc +.Pp Brings the specified physical device online. -.sp +.Pp This command is not applicable to spares or cache devices. -.sp -.ne 2 -.na -\fB\fB-e\fR\fR -.ad -.RS 6n +.Bl -tag -width indent +.It Fl e Expand the device to use all available space. If the device is part of a mirror -or \fBraidz\fR then all devices must be expanded before the new space will -become available to the pool. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBzpool remove\fR \fIpool\fR \fIdevice\fR ...\fR -.ad -.sp .6 -.RS 4n +or +.No raidz +then all devices must be expanded before the new space will become +available to the pool. +.El +.It Xo +.Nm +.Cm remove +.Ar pool device ... +.Xc +.Pp Removes the specified device from the pool. This command currently only supports removing hot spares, cache, and log devices. A mirrored log device can be removed by specifying the top-level mirror for the log. Non-log devices that -are part of a mirrored configuration can be removed using the \fBzpool -detach\fR command. Non-redundant and \fBraidz\fR devices cannot be removed from -a pool. -.RE - -.sp -.ne 2 -.na -\fB\fBzpool replace\fR [\fB-f\fR] \fIpool\fR \fIold_device\fR -[\fInew_device\fR]\fR -.ad -.sp .6 -.RS 4n -Replaces \fIold_device\fR with \fInew_device\fR. This is equivalent to -attaching \fInew_device\fR, waiting for it to resilver, and then detaching -\fIold_device\fR. -.sp -The size of \fInew_device\fR must be greater than or equal to the minimum size -of all the devices in a mirror or \fBraidz\fR configuration. -.sp -\fInew_device\fR is required if the pool is not redundant. If \fInew_device\fR -is not specified, it defaults to \fIold_device\fR. This form of replacement is -useful after an existing disk has failed and has been physically replaced. In -this case, the new disk may have the same \fB/dev/dsk\fR path as the old -device, even though it is actually a different disk. \fBZFS\fR recognizes this. -.sp -.ne 2 -.na -\fB\fB-f\fR\fR -.ad -.RS 6n -Forces use of \fInew_device\fR, even if its appears to be in use. Not all -devices can be overridden in this manner. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBzpool scrub\fR [\fB-s\fR] \fIpool\fR ...\fR -.ad -.sp .6 -.RS 4n +are part of a mirrored configuration can be removed using the +.Qq Nm Cm detach +command. Non-redundant and +.No raidz +devices cannot be removed from a pool. +.It Xo +.Nm +.Cm replace +.Op Fl f +.Ar pool device +.Op Ar new_device +.Xc +.Pp +Replaces +.Ar old_device +with +.Ar new_device Ns . +This is equivalent to attaching +.Ar new_device Ns , +waiting for it to resilver, and then detaching +.Ar old_device Ns . +.Pp +The size of +.Ar new_device +must be greater than or equal to the minimum size +of all the devices in a mirror or +.No raidz +configuration. +.Pp +.Ar new_device +is required if the pool is not redundant. If +.Ar new_device +is not specified, it defaults to +.Ar old_device Ns . +This form of replacement is useful after an existing disk has failed and has +been physically replaced. In this case, the new disk may have the same +.Pa /dev +path as the old device, even though it is actually a different disk. +.Tn ZFS +recognizes this. +.Bl -tag -width indent +.It Fl f +Forces use of +.Ar new_device Ns , +even if its appears to be in use. Not all devices can be overridden in this +manner. +.El +.It Xo +.Nm +.Cm scrub +.Op Fl s +.Ar pool ... +.Xc +.Pp Begins a scrub. The scrub examines all data in the specified pools to verify -that it checksums correctly. For replicated (mirror or \fBraidz\fR) devices, -\fBZFS\fR automatically repairs any damage discovered during the scrub. The -"\fBzpool status\fR" command reports the progress of the scrub and summarizes -the results of the scrub upon completion. -.sp +that it checksums correctly. For replicated (mirror or +.No raidz Ns ) +devices, +.Tn ZFS +automatically repairs any damage discovered during the scrub. The +.Qq Nm Cm status +command reports the progress of the scrub and summarizes the results of the +scrub upon completion. +.Pp Scrubbing and resilvering are very similar operations. The difference is that -resilvering only examines data that \fBZFS\fR knows to be out of date (for -example, when attaching a new device to a mirror or replacing an existing -device), whereas scrubbing examines all data to discover silent errors due to -hardware faults or disk failure. -.sp -Because scrubbing and resilvering are \fBI/O\fR-intensive operations, \fBZFS\fR -only allows one at a time. If a scrub is already in progress, the "\fBzpool -scrub\fR" command terminates it and starts a new scrub. If a resilver is in -progress, \fBZFS\fR does not allow a scrub to be started until the resilver -completes. -.sp -.ne 2 -.na -\fB\fB-s\fR\fR -.ad -.RS 6n +resilvering only examines data that +.Tn ZFS +knows to be out of date (for example, when attaching a new device to a mirror +or replacing an existing device), whereas scrubbing examines all data to +discover silent errors due to hardware faults or disk failure. +.Pp +Because scrubbing and resilvering are +.Tn I/O Ns -intensive +operations, +.Tn ZFS +only allows one at a time. If a scrub is already in progress, the +.Qq Nm Cm scrub +command returns an error. To start a new scrub, you have to stop the old scrub +with the +.Qq Nm Cm scrub Fl s +command first. If a resilver is in progress, +.Tn ZFS +does not allow a scrub to be started until the resilver completes. +.Bl -tag -width indent +.It Fl s Stop scrubbing. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBzpool set\fR \fIproperty\fR=\fIvalue\fR \fIpool\fR\fR -.ad -.sp .6 -.RS 4n -Sets the given property on the specified pool. See the "Properties" section for -more information on what properties can be set and acceptable values. -.RE - -.sp -.ne 2 -.na -\fB\fBzpool status\fR [\fB-xv\fR] [\fIpool\fR] ...\fR -.ad -.sp .6 -.RS 4n -Displays the detailed health status for the given pools. If no \fIpool\fR is -specified, then the status of each pool in the system is displayed. For more -information on pool and device health, see the "Device Failure and Recovery" +.El +.It Xo +.Nm +.Cm set +.Ar property Ns = Ns Ar value pool +.Xc +.Pp +Sets the given property on the specified pool. See the +.Qq Sx Properties +section for more information on what properties can be set and acceptable +values. +.It Xo +.Nm +.Cm split +.Op Fl n +.Op Fl R Ar altroot +.Op Fl o Ar mntopts +.Op Fl o Ar property Ns = Ns Ar value +.Ar pool newpool +.Op Ar device ... +.Xc +.Pp +Splits off one disk from each mirrored top-level +.No vdev +in a pool and creates a new pool from the split-off disks. The original pool +must be made up of one or more mirrors and must not be in the process of +resilvering. The +.Cm split +subcommand chooses the last device in each mirror +.No vdev +unless overridden by a device specification on the command line. +.Pp +When using a +.Ar device +argument, +.Cm split +includes the specified device(s) in a new pool and, should any devices remain +unspecified, assigns the last device in each mirror +.No vdev +to that pool, as it does normally. If you are uncertain about the outcome of a +.Cm split +command, use the +.Fl n +("dry-run") option to ensure your command will have the effect you intend. +.Bl -tag -width indent +.It Fl R Ar altroot +Automatically import the newly created pool after splitting, using the +specified +.Ar altroot +parameter for the new pool's alternate root. See the +.Sy altroot +description in the +.Qq Sx Properties +section, above. +.It Fl n +Displays the configuration that would be created without actually splitting the +pool. The actual pool split could still fail due to insufficient privileges or +device status. +.It Fl o Ar mntopts +Comma-separated list of mount options to use when mounting datasets within the +pool. See +.Xr zfs 8 +for a description of dataset properties and mount options. Valid only in +conjunction with the +.Fl R +option. +.It Fl o Ar property Ns = Ns Ar value +Sets the specified property on the new pool. See the +.Qq Sx Properties +section, above, for more information on the available pool properties. +.El +.It Xo +.Nm +.Cm status +.Op Fl vx +.Op Fl T Cm d Ns | Ns Cm u +.Op Ar pool +.Ar ... +.Op Ar interval Op Ar count +.Xc +.Pp +Displays the detailed health status for the given pools. If no +.Ar pool +is specified, then the status of each pool in the system is displayed. For more +information on pool and device health, see the +.Qq Sx Device Failure and Recovery section. -.sp +.Pp +When given an interval, the output is printed every +.Ar interval +seconds until +.Sy Ctrl-C +is pressed. If +.Ar count +is specified, the command exits after +.Ar count +reports are printed. +.Pp If a scrub or resilver is in progress, this command reports the percentage done and the estimated time to completion. Both of these are only approximate, because the amount of data in the pool and the other workloads on the system can change. -.sp -.ne 2 -.na -\fB\fB-x\fR\fR -.ad -.RS 6n +.Bl -tag -width indent +.It Fl x Only display status for pools that are exhibiting errors or are otherwise unavailable. -.RE - -.sp -.ne 2 -.na -\fB\fB-v\fR\fR -.ad -.RS 6n +.It Fl v Displays verbose data error information, printing out a complete list of all data errors since the last complete pool scrub. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBzpool upgrade\fR\fR -.ad -.sp .6 -.RS 4n -Displays all pools formatted using a different \fBZFS\fR on-disk version. Older -versions can continue to be used, but some features may not be available. These -pools can be upgraded using "\fBzpool upgrade -a\fR". Pools that are formatted -with a more recent version are also displayed, although these pools will be -inaccessible on the system. -.RE - -.sp -.ne 2 -.na -\fB\fBzpool upgrade\fR \fB-v\fR\fR -.ad -.sp .6 -.RS 4n -Displays \fBZFS\fR versions supported by the current software. The current -\fBZFS\fR versions and all previous supported versions are displayed, along +.It Fl T Cm d Ns | Ns Cm u +Print a timestamp. +.Pp +Use modifier +.Cm d +for standard date format. See +.Xr date 1 Ns . +Use modifier +.Cm u +for unixtime +.Pq equals Qq Ic date +%s Ns . +.El +.It Xo +.Nm +.Cm upgrade +.Op Fl v +.Xc +.Pp +Displays all pools formatted using a different +.Tn ZFS +pool on-disk version. Older versions can continue to be used, but some +features may not be available. These pools can be upgraded using +.Qq Nm Cm upgrade Fl a . +Pools that are formatted with a more recent version are also displayed, +although these pools will be inaccessible on the system. +.Bl -tag -width indent +.It Fl v +Displays +.Tn ZFS +pool versions supported by the current software. The current +.Tn ZFS +pool version and all previous supported versions are displayed, along with an explanation of the features provided with each version. -.RE - -.sp -.ne 2 -.na -\fB\fBzpool upgrade\fR [\fB-V\fR \fIversion\fR] \fB-a\fR | \fIpool\fR ...\fR -.ad -.sp .6 -.RS 4n -Upgrades the given pool to the latest on-disk version. Once this is done, the -pool will no longer be accessible on systems running older versions of the +.El +.It Xo +.Nm +.Cm upgrade +.Op Fl V Ar version +.Fl a | Ar pool ... +.Xc +.Pp +Upgrades the given pool to the latest on-disk pool version. Once this is done, +the pool will no longer be accessible on systems running older versions of the software. -.sp -.ne 2 -.na -\fB\fB-a\fR\fR -.ad -.RS 14n +.Bl -tag -width indent +.It Fl a Upgrades all pools. -.RE - -.sp -.ne 2 -.na -\fB\fB-V\fR \fIversion\fR\fR -.ad -.RS 14n -Upgrade to the specified version. If the \fB-V\fR flag is not specified, the -pool is upgraded to the most recent version. This option can only be used to -increase the version number, and only up to the most recent version supported -by this software. -.RE - -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRCreating a RAID-Z Storage Pool -.sp -.LP -The following command creates a pool with a single \fBraidz\fR root \fIvdev\fR +.It Fl V Ar version +Upgrade to the specified version. If the +.Fl V +flag is not specified, the pool is upgraded to the most recent version. This +option can only be used to increase the version number, and only up to the most +recent version supported by this software. +.El +.El +.Sh EXAMPLES +.Bl -tag -width 0n +.It Sy Example 1 No Creating a RAID-Z Storage Pool +.Pp +The following command creates a pool with a single +.No raidz +root +.No vdev that consists of six disks. - -.sp -.in +2 -.nf -# \fBzpool create tank raidz da0 da1 da2 da3 da4 da5\fR -.fi -.in -2 -.sp - -.LP -\fBExample 2 \fRCreating a Mirrored Storage Pool -.sp -.LP +.Bd -literal -offset 2n +.Li # Ic zpool create tank raidz da0 da1 da2 da3 da4 da5 +.Ed +.It Sy Example 2 No Creating a Mirrored Storage Pool +.Pp The following command creates a pool with two mirrors, where each mirror contains two disks. - -.sp -.in +2 -.nf -# \fBzpool create tank mirror da0 da1 mirror da2 da3\fR -.fi -.in -2 -.sp - -.LP -\fBExample 3 \fRCreating a ZFS Storage Pool by Using Slices -.sp -.LP -The following command creates an unmirrored pool using two disk slices. - -.sp -.in +2 -.nf -# \fBzpool create tank /dev/da0s1 da1s4\fR -.fi -.in -2 -.sp - -.LP -\fBExample 4 \fRCreating a ZFS Storage Pool by Using Files -.sp -.LP +.Bd -literal -offset 2n +.Li # Ic zpool create tank mirror da0 da1 mirror da2 da3 +.Ed +.It Sy Example 3 No Creating a Tn ZFS No Storage Pool by Using Partitions +.Pp +The following command creates an unmirrored pool using two GPT partitions. +.Bd -literal -offset 2n +.Li # Ic zpool create tank da0p3 da1p3 +.Ed +.It Sy Example 4 No Creating a Tn ZFS No Storage Pool by Using Files +.Pp The following command creates an unmirrored pool using files. While not recommended, a pool based on files can be useful for experimental purposes. - -.sp -.in +2 -.nf -# \fBzpool create tank /path/to/file/a /path/to/file/b\fR -.fi -.in -2 -.sp - -.LP -\fBExample 5 \fRAdding a Mirror to a ZFS Storage Pool -.sp -.LP -The following command adds two mirrored disks to the pool "\fItank\fR", +.Bd -literal -offset 2n +.Li # Ic zpool create tank /path/to/file/a /path/to/file/b +.Ed +.It Sy Example 5 No Adding a Mirror to a Tn ZFS No Storage Pool +.Pp +The following command adds two mirrored disks to the pool +.Em tank Ns , assuming the pool is already made up of two-way mirrors. The additional space is immediately available to any datasets within the pool. - -.sp -.in +2 -.nf -# \fBzpool add tank mirror da0 da1\fR -.fi -.in -2 -.sp - -.LP -\fBExample 6 \fRListing Available ZFS Storage Pools -.sp -.LP -The following command lists all available pools on the system. In this case, -the pool \fIzion\fR is faulted due to a missing device. - -.sp -.LP -The results from this command are similar to the following: - -.sp -.in +2 -.nf -# \fBzpool list\fR - NAME SIZE USED AVAIL CAP HEALTH ALTROOT - pool 67.5G 2.92M 67.5G 0% ONLINE - - tank 67.5G 2.92M 67.5G 0% ONLINE - - zion - - - 0% FAULTED - -.fi -.in -2 -.sp - -.LP -\fBExample 7 \fRDestroying a ZFS Storage Pool -.sp -.LP -The following command destroys the pool "\fItank\fR" and any datasets contained -within. - -.sp -.in +2 -.nf -# \fBzpool destroy -f tank\fR -.fi -.in -2 -.sp - -.LP -\fBExample 8 \fRExporting a ZFS Storage Pool -.sp -.LP -The following command exports the devices in pool \fItank\fR so that they can -be relocated or later imported. - -.sp -.in +2 -.nf -# \fBzpool export tank\fR -.fi -.in -2 -.sp - -.LP -\fBExample 9 \fRImporting a ZFS Storage Pool -.sp -.LP +.Bd -literal -offset 2n +.Li # Ic zpool add tank mirror da2 da3 +.Ed +.It Sy Example 6 No Listing Available Tn ZFS No Storage Pools +.Pp +The following command lists all available pools on the system. +.Bd -literal -offset 2n +.Li # Ic zpool list +NAME SIZE ALLOC FREE CAP DEDUP HEALTH ALTROOT +pool 2.70T 473G 2.24T 17% 1.00x ONLINE - +test 1.98G 89.5K 1.98G 0% 1.00x ONLINE - +.Ed +.It Sy Example 7 No Listing All Properties for a Pool +.Pp +The following command lists all the properties for a pool. +.Bd -literal -offset 2n +.Li # Ic zpool get all pool +pool size 2.70T - +pool capacity 17% - +pool altroot - default +pool health ONLINE - +pool guid 2501120270416322443 default +pool version 28 default +pool bootfs pool/root local +pool delegation on default +pool autoreplace off default +pool cachefile - default +pool failmode wait default +pool listsnapshots off default +pool autoexpand off default +pool dedupditto 0 default +pool dedupratio 1.00x - +pool free 2.24T - +pool allocated 473G - +pool readonly off - +.Ed +.It Sy Example 8 No Destroying a Tn ZFS No Storage Pool +.Pp +The following command destroys the pool +.Qq Em tank +and any datasets contained within. +.Bd -literal -offset 2n +.Li # Ic zpool destroy -f tank +.Ed +.It Sy Example 9 No Exporting a Tn ZFS No Storage Pool +.Pp +The following command exports the devices in pool +.Em tank +so that they can be relocated or later imported. +.Bd -literal -offset 2n +.Li # Ic zpool export tank +.Ed +.It Sy Example 10 No Importing a Tn ZFS No Storage Pool +.Pp The following command displays available pools, and then imports the pool -"tank" for use on the system. - -.sp -.LP +.Qq Em tank +for use on the system. +.Pp The results from this command are similar to the following: +.Bd -literal -offset 2n +.Li # Ic zpool import -.sp -.in +2 -.nf -# \fBzpool import\fR pool: tank id: 15451357997522795478 state: ONLINE @@ -1808,132 +1713,83 @@ config: mirror ONLINE da0 ONLINE da1 ONLINE - -# \fBzpool import tank\fR -.fi -.in -2 -.sp - -.LP -\fBExample 10 \fRUpgrading All ZFS Storage Pools to the Current Version -.sp -.LP -The following command upgrades all ZFS Storage pools to the current version of +.Ed +.It Xo +.Sy Example 11 +Upgrading All +.Tn ZFS +Storage Pools to the Current Version +.Xc +.Pp +The following command upgrades all +.Tn ZFS +Storage pools to the current version of the software. - -.sp -.in +2 -.nf -# \fBzpool upgrade -a\fR -This system is currently running ZFS version 2. -.fi -.in -2 -.sp - -.LP -\fBExample 11 \fRManaging Hot Spares -.sp -.LP +.Bd -literal -offset 2n +.Li # Ic zpool upgrade -a +This system is currently running ZFS pool version 28. +.Ed +.It Sy Example 12 No Managing Hot Spares +.Pp The following command creates a new pool with an available hot spare: - -.sp -.in +2 -.nf -# \fBzpool create tank mirror da0 da1 spare da2\fR -.fi -.in -2 -.sp - -.sp -.LP +.Bd -literal -offset 2n +.Li # Ic zpool create tank mirror da0 da1 spare da2 +.Ed +.Pp If one of the disks were to fail, the pool would be reduced to the degraded state. The failed device can be replaced using the following command: - -.sp -.in +2 -.nf -# \fBzpool replace tank da0 da2\fR -.fi -.in -2 -.sp - -.sp -.LP +.Bd -literal -offset 2n +.Li # Ic zpool replace tank da0 da2 +.Ed +.Pp Once the data has been resilvered, the spare is automatically removed and is made available should another device fails. The hot spare can be permanently removed from the pool using the following command: - -.sp -.in +2 -.nf -# \fBzpool remove tank da3\fR -.fi -.in -2 -.sp - -.LP -\fBExample 12 \fRCreating a ZFS Pool with Mirrored Separate Intent Logs -.sp -.LP -The following command creates a ZFS storage pool consisting of two, two-way +.Bd -literal -offset 2n +.Li # Ic zpool remove tank da2 +.Ed +.It Xo +.Sy Example 13 +Creating a +.Tn ZFS +Pool with Mirrored Separate Intent Logs +.Xc +.Pp +The following command creates a +.Tn ZFS +storage pool consisting of two, two-way mirrors and mirrored log devices: - -.sp -.in +2 -.nf -# \fBzpool create pool mirror da0 da1 mirror da2 da3 log mirror \e - da4 da5\fR -.fi -.in -2 -.sp - -.LP -\fBExample 13 \fRAdding Cache Devices to a ZFS Pool -.sp -.LP -The following command adds two disks for use as cache devices to a ZFS storage -pool: - -.sp -.in +2 -.nf -# \fBzpool add pool cache c2d0 c3d0\fR -.fi -.in -2 -.sp - -.sp -.LP +.Bd -literal -offset 2n +.Li # Ic zpool create pool mirror da0 da1 mirror da2 da3 log miror da4 da5 +.Ed +.It Sy Example 14 No Adding Cache Devices to a Tn ZFS No Pool +.Pp +The following command adds two disks for use as cache devices to a +.Tn ZFS +storage pool: +.Bd -literal -offset 2n +.Li # Ic zpool add pool cache da2 da3 +.Ed +.Pp Once added, the cache devices gradually fill with content from main memory. Depending on the size of your cache devices, it could take over an hour for -them to fill. Capacity and reads can be monitored using the \fBiostat\fR option -as follows: - -.sp -.in +2 -.nf -# \fBzpool iostat -v pool 5\fR -.fi -.in -2 -.sp - -.LP -\fBExample 14 \fRRemoving a Mirrored Log Device -.sp -.LP -The following command removes the mirrored log device \fBmirror-2\fR. - -.sp -.LP +them to fill. Capacity and reads can be monitored using the +.Cm iostat +subcommand as follows: +.Bd -literal -offset 2n +.Li # Ic zpool iostat -v pool 5 +.Ed +.It Sy Example 15 No Removing a Mirrored Log Device +.Pp +The following command removes the mirrored log device +.Em mirror-2 Ns . +.Pp Given this configuration: - -.sp -.in +2 -.nf +.Bd -literal -offset 2n pool: tank state: ONLINE scrub: none requested -config: + config: NAME STATE READ WRITE CKSUM tank ONLINE 0 0 0 @@ -1947,54 +1803,68 @@ config: mirror-2 ONLINE 0 0 0 da4 ONLINE 0 0 0 da5 ONLINE 0 0 0 -.fi -.in -2 -.sp - -.sp -.LP -The command to remove the mirrored log \fBmirror-2\fR is: - -.sp -.in +2 -.nf -# \fBzpool remove tank mirror-2\fR -.fi -.in -2 -.sp - -.SH EXIT STATUS -.sp -.LP +.Ed +.Pp +The command to remove the mirrored log +.Em mirror-2 +is: +.Bd -literal -offset 2n +.Li # Ic zpool remove tank mirror-2 +.Ed +.It Sy Example 16 No Recovering a Faulted Tn ZFS No Pool +.Pp +If a pool is faulted but recoverable, a message indicating this state is +provided by +.Qq Nm Cm status +if the pool was cached (see the +.Fl c Ar cachefile +argument above), or as part of the error output from a failed +.Qq Nm Cm import +of the pool. +.Pp +Recover a cached pool with the +.Qq Nm Cm clear +command: +.Bd -literal -offset 2n +.Li # Ic zpool clear -F data +Pool data returned to its state as of Tue Sep 08 13:23:35 2009. +Discarded approximately 29 seconds of transactions. +.Ed +.Pp +If the pool configuration was not cached, use +.Qq Nm Cm import +with the recovery mode flag: +.Bd -literal -offset 2n +.Li # Ic zpool import -F data +Pool data returned to its state as of Tue Sep 08 13:23:35 2009. +Discarded approximately 29 seconds of transactions. +.Ed +.El +.Sh EXIT STATUS The following exit values are returned: -.sp -.ne 2 -.na -\fB\fB0\fR\fR -.ad -.RS 5n +.Bl -tag -offset 2n -width 2n +.It 0 Successful completion. -.RE - -.sp -.ne 2 -.na -\fB\fB1\fR\fR -.ad -.RS 5n +.It 1 An error occurred. -.RE - -.sp -.ne 2 -.na -\fB\fB2\fR\fR -.ad -.RS 5n +.It 2 Invalid command line options were specified. -.RE - -.SH SEE ALSO -.sp -.LP -zfs(8) +.El +.Sh SEE ALSO +.Xr zfs 8 +.Sh AUTHORS +This manual page is a +.Xr mdoc 7 +reimplementation of the +.Tn OpenSolaris +manual page +.Em zpool(1M) , +modified and customized for +.Fx +and licensed under the Common Development and Distribution License +.Pq Tn CDDL . +.Pp +The +.Xr mdoc 7 +implementation of this manual page was initially written by +.An Martin Matuska Aq mm@FreeBSD.org . |
