diff options
Diffstat (limited to 'man/man8/zpool.8')
| -rw-r--r-- | man/man8/zpool.8 | 282 |
1 files changed, 16 insertions, 266 deletions
diff --git a/man/man8/zpool.8 b/man/man8/zpool.8 index 1f14eee98..8927407c6 100644 --- a/man/man8/zpool.8 +++ b/man/man8/zpool.8 @@ -15,7 +15,7 @@ .\" CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your .\" own identifying information: .\" Portions Copyright [yyyy] [name of copyright owner] -.TH zpool 8 "14 December 2012" "ZFS pool 28, filesystem 5" "System Administration Commands" +.TH zpool 8 "May 11, 2016" "ZFS pool 28, filesystem 5" "System Administration Commands" .SH NAME zpool \- configures ZFS storage pools .SH SYNOPSIS @@ -189,40 +189,33 @@ All datasets within a storage pool share the same space. See \fBzfs\fR(8) for in 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 -.mk .na \fB\fBdisk\fR\fR .ad .RS 10n -.rt A block device, typically located under \fB/dev\fR. \fBZFS\fR can use individual partitions, 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, "sda" is equivalent to "/dev/sda". A whole disk can be specified by omitting the partition designation. When given a whole disk, \fBZFS\fR automatically labels the disk, if necessary. .RE .sp .ne 2 -.mk .na \fB\fBfile\fR\fR .ad .RS 10n -.rt 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 specified by a full path. .RE .sp .ne 2 -.mk .na \fB\fBmirror\fR\fR .ad .RS 10n -.rt 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 -.mk .na \fB\fBraidz\fR\fR .ad @@ -239,7 +232,6 @@ A mirror of two or more devices. Data is replicated in an identical fashion acro \fB\fBraidz3\fR\fR .ad .RS 10n -.rt 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. @@ -249,34 +241,28 @@ A \fBraidz\fR group with \fIN\fR disks of size \fIX\fR with \fIP\fR parity disks .sp .ne 2 -.mk .na \fB\fBspare\fR\fR .ad .RS 10n -.rt 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 -.mk .na \fB\fBlog\fR\fR .ad .RS 10n -.rt 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 -.mk .na \fB\fBcache\fR\fR .ad .RS 10n -.rt A device used to cache storage pool data. A cache device cannot be configured as a mirror or \fBraidz\fR group. For more information, see the "Cache Devices" section. .RE @@ -312,12 +298,10 @@ A pool's health status is described by one of three states: online, degraded, or 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 -.mk .na \fB\fBDEGRADED\fR\fR .ad .RS 12n -.rt One or more top-level vdevs is in the degraded state because one or more component devices are offline. Sufficient replicas exist to continue functioning. .sp 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: @@ -337,12 +321,10 @@ The number of I/O errors exceeds acceptable levels. The device could not be mark .sp .ne 2 -.mk .na \fB\fBFAULTED\fR\fR .ad .RS 12n -.rt One or more top-level vdevs is in the faulted state because one or more component devices are offline. Insufficient replicas exist to continue functioning. .sp One or more component devices is in the faulted state, and insufficient replicas exist to continue functioning. The underlying conditions are as follows: @@ -362,45 +344,37 @@ The number of I/O errors exceeds acceptable levels and the device is faulted to .sp .ne 2 -.mk .na \fB\fBOFFLINE\fR\fR .ad .RS 12n -.rt The device was explicitly taken offline by the "\fBzpool offline\fR" command. .RE .sp .ne 2 -.mk .na \fB\fBONLINE\fR\fR .ad .RS 12n -.rt The device is online and functioning. .RE .sp .ne 2 -.mk .na \fB\fBREMOVED\fR\fR .ad .RS 12n -.rt 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 -.mk .na \fB\fBUNAVAIL\fR\fR .ad .RS 12n -.rt 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 @@ -476,34 +450,28 @@ The content of the cache devices is considered volatile, as is the case with oth 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 -.mk .na \fB\fBavailable\fR\fR .ad .RS 20n -.rt Amount of storage available within the pool. This property can also be referred to by its shortened column name, "avail". .RE .sp .ne 2 -.mk .na \fB\fBcapacity\fR\fR .ad .RS 20n -.rt Percentage of pool space used. This property can also be referred to by its shortened column name, "cap". .RE .sp .ne 2 -.mk .na \fB\fBexpandsize\fR\fR .ad .RS 20n -.rt Amount of uninitialized space within the pool or device that can be used to increase the total capacity of the pool. Uninitialized space consists of any space on an EFI labeled vdev which has not been brought online @@ -512,34 +480,28 @@ any space on an EFI labeled vdev which has not been brought online .sp .ne 2 -.mk .na \fB\fBfragmentation\fR\fR .ad .RS 20n -.rt The amount of fragmentation in the pool. .RE .sp .ne 2 -.mk .na \fB\fBfree\fR\fR .ad .RS 20n -.rt The amount of free space available in the pool. .RE .sp .ne 2 -.mk .na \fB\fBfreeing\fR\fR .ad .RS 20n -.rt After a file system or snapshot is destroyed, the space it was using is returned to the pool asynchronously. \fB\fBfreeing\fR\fR is the amount of space remaining to be reclaimed. Over time \fB\fBfreeing\fR\fR will decrease @@ -548,45 +510,37 @@ while \fB\fBfree\fR\fR increases. .sp .ne 2 -.mk .na \fB\fBhealth\fR\fR .ad .RS 20n -.rt 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 -.mk .na \fB\fBguid\fR\fR .ad .RS 20n -.rt A unique identifier for the pool. .RE .sp .ne 2 -.mk .na \fB\fBsize\fR\fR .ad .RS 20n -.rt Total size of the storage pool. .RE .sp .ne 2 -.mk .na \fB\fBunsupported@\fR\fIfeature_guid\fR\fR .ad .RS 20n -.rt .sp Information about unsupported features that are enabled on the pool. See \fBzpool-features\fR(5) for details. @@ -594,12 +548,10 @@ Information about unsupported features that are enabled on the pool. See .sp .ne 2 -.mk .na \fB\fBused\fR\fR .ad .RS 20n -.rt Amount of storage space used within the pool. .RE @@ -612,13 +564,12 @@ The space usage properties report actual physical space available to the storage The following property can be set at creation time: .sp .ne 2 -.mk .na -\fB\fBashift\fR\fR +\fB\fBashift\fR=\fIashift\fR\fR .ad .sp .6 .RS 4n -Pool sector size exponent, to the power of 2 (internally referred to as "ashift"). I/O operations will be aligned to the specified size boundaries. Additionally, the minimum (disk) write size will be set to the specified size, so this represents a space vs. performance trade-off. The typical case for setting this property is when performance is important and the underlying disks use 4KiB sectors but report 512B sectors to the OS (for compatibility reasons); in that case, set \fBashift=12\fR (which is 1<<12 = 4096). +Pool sector size exponent, to the power of 2 (internally referred to as "ashift"). Values from 9 to 13, inclusive, are valid; also, the special value 0 (the default) means to auto-detect using the kernel's block layer and a ZFS internal exception list. I/O operations will be aligned to the specified size boundaries. Additionally, the minimum (disk) write size will be set to the specified size, so this represents a space vs. performance trade-off. The typical case for setting this property is when performance is important and the underlying disks use 4KiB sectors but report 512B sectors to the OS (for compatibility reasons); in that case, set \fBashift=12\fR (which is 1<<12 = 4096). .LP For optimal performance, the pool sector size should be greater than or equal to the sector size of the underlying disks. Since the property cannot be changed after pool creation, if in a given pool, you \fIever\fR want to use drives that \fIreport\fR 4KiB sectors, you must set \fBashift=12\fR at pool creation time. .LP @@ -630,9 +581,8 @@ Keep in mind is that the \fBashift\fR is \fIvdev\fR specific and is not a \fIpoo The following property can be set at creation time and import time: .sp .ne 2 -.mk .na -\fB\fBaltroot\fR\fR +\fB\fBaltroot\fR=(unset) | \fIpath\fR\fR .ad .sp .6 .RS 4n @@ -644,9 +594,8 @@ Alternate root directory. If set, this directory is prepended to any mount point The following property can only be set at import time: .sp .ne 2 -.mk .na -\fB\fBreadonly\fR=\fBon\fR | \fBoff\fR\fR +\fB\fBreadonly\fR=\fBoff\fR | \fBon\fR\fR .ad .sp .6 .RS 4n @@ -662,9 +611,8 @@ To write to a read-only pool, a export and import of the pool is required. The following properties can be set at creation time and import time, and later changed with the \fBzpool set\fR command: .sp .ne 2 -.mk .na -\fB\fBautoexpand\fR=\fBon\fR | \fBoff\fR\fR +\fB\fBautoexpand\fR=\fBoff\fR | \fBon\fR\fR .ad .sp .6 .RS 4n @@ -673,9 +621,8 @@ Controls automatic pool expansion when the underlying LUN is grown. If set to \f .sp .ne 2 -.mk .na -\fB\fBautoreplace\fR=\fBon\fR | \fBoff\fR\fR +\fB\fBautoreplace\fR=\fBoff\fR | \fBon\fR\fR .ad .sp .6 .RS 4n @@ -684,20 +631,18 @@ Controls automatic device replacement. If set to "\fBoff\fR", device replacement .sp .ne 2 -.mk .na -\fB\fBbootfs\fR=\fIpool\fR/\fIdataset\fR\fR +\fB\fBbootfs\fR=(unset) | \fIpool\fR/\fIdataset\fR\fR .ad .sp .6 .RS 4n -Identifies the default bootable dataset for the root pool. This property is expected to be set mainly by the installation and upgrade programs. +Identifies the default bootable dataset for the root pool. This property is expected to be set mainly by the installation and upgrade programs. Not all Linux distribution boot processes use the \fBbootfs\fR property. .RE .sp .ne 2 -.mk .na -\fB\fBcachefile\fR=\fIpath\fR | \fBnone\fR\fR +\fB\fBcachefile\fR=fBnone\fR | \fIpath\fR\fR .ad .sp .6 .RS 4n @@ -708,9 +653,8 @@ Multiple pools can share the same cache file. Because the kernel destroys and re .sp .ne 2 -.mk .na -\fB\fBcomment\fR=\fB\fItext\fR\fR +\fB\fBcomment\fR=(unset) | \fB\fItext\fR\fR .ad .sp .6 .RS 4n @@ -719,18 +663,16 @@ A text string consisting of printable ASCII characters that will be stored such .sp .ne 2 -.mk .na \fB\fBdedupditto\fR=\fB\fInumber\fR\fR .ad .sp .6 .RS 4n -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. The default setting is 0 which causes no ditto copies to be created for deduplicated blocks. The minimum legal nonzero setting is 100. +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. The default setting is 0 which causes no ditto copies to be created for deduplicated blocks. The minimum valid nonzero setting is 100. .RE .sp .ne 2 -.mk .na \fB\fBdelegation\fR=\fBon\fR | \fBoff\fR\fR .ad @@ -741,7 +683,6 @@ Controls whether a non-privileged user is granted access based on the dataset pe .sp .ne 2 -.mk .na \fB\fBfailmode\fR=\fBwait\fR | \fBcontinue\fR | \fBpanic\fR\fR .ad @@ -750,34 +691,28 @@ Controls whether a non-privileged user is granted access based on the dataset pe 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 -.mk .na \fB\fBwait\fR\fR .ad .RS 12n -.rt 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 -.mk .na \fB\fBcontinue\fR\fR .ad .RS 12n -.rt 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 -.mk .na \fB\fBpanic\fR\fR .ad .RS 12n -.rt Prints out a message to the console and generates a system crash dump. .RE @@ -797,20 +732,20 @@ details on feature states. .sp .ne 2 -.mk .na -\fB\fBlistsnaps\fR=on | off\fR +\fB\fBlistsnapshots\fR=on | off\fR .ad .sp .6 .RS 4n 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". +.sp +This property can also be referred to by its shortened name, \fBlistsnaps\fR. .RE .sp .ne 2 -.mk .na -\fB\fBversion\fR=\fIversion\fR\fR +\fB\fBversion\fR=(unset) | \fIversion\fR\fR .ad .sp .6 .RS 4n @@ -826,7 +761,6 @@ All subcommands that modify state are logged persistently to the pool in their o 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 -.mk .na \fB\fBzpool\fR \fB-?\fR\fR .ad @@ -837,7 +771,6 @@ Displays a help message. .sp .ne 2 -.mk .na \fB\fBzpool add\fR [\fB-fgLnP\fR] [\fB-o\fR \fIproperty=value\fR] \fIpool\fR \fIvdev\fR ...\fR .ad @@ -846,62 +779,51 @@ Displays a help message. 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 -.mk .na \fB\fB-f\fR\fR .ad .RS 6n -.rt 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 -.mk .na \fB\fB-g\fR\fR .ad .RS 6n -.rt Display vdev GUIDs instead of the normal device names. These GUIDs can be used in place of device names for the zpool detach/offline/remove/replace commands. .RE .sp .ne 2 -.mk .na \fB\fB-L\fR\fR .ad .RS 6n -.rt Display real paths for vdevs resolving all symbolic links. This can be used to look up the current block device name regardless of the /dev/disk/ path used to open it. .RE .sp .ne 2 -.mk .na \fB\fB-n\fR\fR .ad .RS 6n -.rt 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 .sp .ne 2 -.mk .na \fB\fB-P\fR\fR .ad .RS 6n -.rt Display full paths for vdevs instead of only the last component of the path. This can be used in conjunction with the \fB-L\fR flag. .RE .sp .ne 2 -.mk .na \fB\fB-o\fR \fIproperty=value\fR .ad @@ -915,7 +837,6 @@ Do not add a disk that is currently configured as a quorum device to a zpool. Af .sp .ne 2 -.mk .na \fB\fBzpool attach\fR [\fB-f\fR] [\fB-o\fR \fIproperty=value\fR] \fIpool\fR \fIdevice\fR \fInew_device\fR\fR .ad @@ -924,18 +845,15 @@ Do not add a disk that is currently configured as a quorum device to a zpool. Af 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 -.mk .na \fB\fB-f\fR\fR .ad .RS 6n -.rt Forces use of \fInew_device\fR, even if its appears to be in use. Not all devices can be overridden in this manner. .RE .sp .ne 2 -.mk .na \fB\fB-o\fR \fIproperty=value\fR .ad @@ -948,7 +866,6 @@ Sets the given pool properties. See the "Properties" section for a list of valid .sp .ne 2 -.mk .na \fB\fBzpool clear\fR \fIpool\fR [\fIdevice\fR] ...\fR .ad @@ -959,7 +876,6 @@ Clears device errors in a pool. If no arguments are specified, all device errors .sp .ne 2 -.mk .na \fB\fBzpool create\fR [\fB-fnd\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] [\fB-t\fR \fItname\fR] \fIpool\fR \fIvdev\fR ...\fR .ad @@ -976,7 +892,6 @@ Unless the \fB-R\fR option is specified, the default mount point is "/\fIpool\fR By default all supported features are enabled on the new pool unless the \fB-d\fR option is specified. .sp .ne 2 -.mk .na \fB\fB-f\fR\fR .ad @@ -987,7 +902,6 @@ Forces use of \fBvdev\fRs, even if they appear in use or specify a conflicting r .sp .ne 2 -.mk .na \fB\fB-n\fR\fR .ad @@ -998,7 +912,6 @@ Displays the configuration that would be used without actually creating the pool .sp .ne 2 -.mk .na \fB\fB-d\fR\fR .ad @@ -1019,7 +932,6 @@ Sets the given pool properties. See the "Properties" section for a list of valid .sp .ne 2 -.mk .na \fB\fB-O\fR \fIfile-system-property=value\fR\fR .ad @@ -1034,7 +946,6 @@ Sets the given file system properties in the root file system of the pool. See t .sp .ne 2 -.mk .na \fB\fB-R\fR \fIroot\fR\fR .ad @@ -1045,7 +956,6 @@ Equivalent to "-o cachefile=none,altroot=\fIroot\fR" .sp .ne 2 -.mk .na \fB\fB-m\fR \fImountpoint\fR\fR .ad @@ -1056,7 +966,6 @@ Sets the mount point for the root dataset. The default mount point is "/\fIpool\ .sp .ne 2 -.mk .na \fB\fB-t\fR \fItname\fR\fR .ad @@ -1069,7 +978,6 @@ Sets the in-core pool name to "\fBtname\fR" while the on-disk name will be the n .sp .ne 2 -.mk .na \fB\fBzpool destroy\fR [\fB-f\fR] \fIpool\fR\fR .ad @@ -1078,12 +986,10 @@ Sets the in-core pool name to "\fBtname\fR" while the on-disk name will be the n 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 -.mk .na \fB\fB-f\fR\fR .ad .RS 6n -.rt Forces any active datasets contained within the pool to be unmounted. .RE @@ -1091,7 +997,6 @@ Forces any active datasets contained within the pool to be unmounted. .sp .ne 2 -.mk .na \fB\fBzpool detach\fR \fIpool\fR \fIdevice\fR\fR .ad @@ -1104,7 +1009,6 @@ Detaches \fIdevice\fR from a mirror. The operation is refused if there are no ot .sp .ne 2 -.mk .na \fBzpool events\fR [\fB-vHfc\fR] [\fIpool\fR] ... .ad @@ -1114,45 +1018,37 @@ Description of the different events generated by the ZFS kernel modules. See \fB .sp .ne 2 -.mk .na \fB\fB-v\fR\fR .ad .RS 6n -.rt Get a full detail of the events and what information is available about it. .RE .sp .ne 2 -.mk .na \fB\fB-H\fR\fR .ad .RS 6n -.rt Scripted mode. Do not display headers, and separate fields by a single tab instead of arbitrary space. .RE .sp .ne 2 -.mk .na \fB\fB-f\fR\fR .ad .RS 6n -.rt Follow mode. .RE .sp .ne 2 -.mk .na \fB\fB-c\fR\fR .ad .RS 6n -.rt Clear all previous events. .RE @@ -1160,7 +1056,6 @@ Clear all previous events. .sp .ne 2 -.mk .na \fB\fBzpool export\fR [\fB-a\fR] [\fB-f\fR] \fIpool\fR ...\fR .ad @@ -1173,23 +1068,19 @@ Before exporting the pool, all datasets within the pool are unmounted. A pool ca For pools to be portable, you must give the \fBzpool\fR command whole disks, not just partitions, so that \fBZFS\fR can label the disks with portable \fBEFI\fR labels. Otherwise, disk drivers on platforms of different endianness will not recognize the disks. .sp .ne 2 -.mk .na \fB\fB-a\fR\fR .ad .RS 6n -.rt Exports all pools imported on the system. .RE .sp .ne 2 -.mk .na \fB\fB-f\fR\fR .ad .RS 6n -.rt Forcefully unmount all datasets, using the "\fBunmount -f\fR" command. .sp 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. @@ -1199,7 +1090,6 @@ This command will forcefully export the pool even if it has a shared spare that .sp .ne 2 -.mk .na \fB\fBzpool get\fR [\fB-Hp\fR] [\fB-o \fR\fIfield\fR[,...]] "\fIall\fR" | \fIproperty\fR[,...] \fIpool\fR ...\fR @@ -1222,23 +1112,19 @@ See the "Properties" section for more information on the available pool properti .sp .ne 2 -.mk .na \fB\fB-H\fR\fR .ad .RS 6n -.rt Scripted mode. Do not display headers, and separate fields by a single tab instead of arbitrary space. .RE .sp .ne 2 -.mk .na \fB\fB-p\fR\fR .ad .RS 6n -.rt Display numbers in parseable (exact) values. .RE @@ -1257,7 +1143,6 @@ is the default value. .sp .ne 2 -.mk .na \fB\fBzpool history\fR [\fB-il\fR] [\fIpool\fR] ...\fR .ad @@ -1266,23 +1151,19 @@ is the default value. Displays the command history of the specified pools or all pools if no pool is specified. .sp .ne 2 -.mk .na \fB\fB-i\fR\fR .ad .RS 6n -.rt Displays internally logged \fBZFS\fR events in addition to user initiated events. .RE .sp .ne 2 -.mk .na \fB\fB-l\fR\fR .ad .RS 6n -.rt Displays log records in long format, which in addition to standard format includes, the user name, the hostname, and the zone in which the operation was performed. .RE @@ -1290,7 +1171,6 @@ Displays log records in long format, which in addition to standard format includ .sp .ne 2 -.mk .na \fB\fBzpool import\fR [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR] [\fB-D\fR]\fR .ad @@ -1301,34 +1181,28 @@ Lists pools available to import. If the \fB-d\fR option is not specified, this c 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 -.mk .na \fB\fB-c\fR \fIcachefile\fR\fR .ad .RS 16n -.rt 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 -.mk .na \fB\fB-d\fR \fIdir\fR\fR .ad .RS 16n -.rt Searches for devices or files in \fIdir\fR. The \fB-d\fR option can be specified multiple times. .RE .sp .ne 2 -.mk .na \fB\fB-D\fR\fR .ad .RS 16n -.rt Lists destroyed pools only. .RE @@ -1336,7 +1210,6 @@ Lists destroyed pools only. .sp .ne 2 -.mk .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-m\fR] [\fB-N\fR] [\fB-R\fR \fIroot\fR] [\fB-F\fR [\fB-n\fR]] [\fB-s\fR] \fB-a\fR\fR .ad @@ -1345,73 +1218,60 @@ Lists destroyed pools only. 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 -.mk .na \fB\fB-o\fR \fImntopts\fR\fR .ad .RS 21n -.rt 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 -.mk .na \fB\fB-o\fR \fIproperty=value\fR\fR .ad .RS 21n -.rt Sets the specified property on the imported pool. See the "Properties" section for more information on the available pool properties. .RE .sp .ne 2 -.mk .na \fB\fB-c\fR \fIcachefile\fR\fR .ad .RS 21n -.rt 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 -.mk .na \fB\fB-d\fR \fIdir\fR\fR .ad .RS 21n -.rt 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 -.mk .na \fB\fB-D\fR\fR .ad .RS 21n -.rt Imports destroyed pools only. The \fB-f\fR option is also required. .RE .sp .ne 2 -.mk .na \fB\fB-f\fR\fR .ad .RS 21n -.rt Forces import, even if the pool appears to be potentially active. .RE .sp .ne 2 -.mk .na \fB\fB-F\fR\fR .ad @@ -1421,18 +1281,15 @@ Recovery mode for a non-importable pool. Attempt to return the pool to an import .sp .ne 2 -.mk .na \fB\fB-a\fR\fR .ad .RS 21n -.rt Searches for and imports all pools found. .RE .sp .ne 2 -.mk .na \fB\fB-m\fR\fR .ad @@ -1442,18 +1299,15 @@ Allows a pool to import when there is a missing log device. .sp .ne 2 -.mk .na \fB\fB-R\fR \fIroot\fR\fR .ad .RS 21n -.rt Sets the "\fBcachefile\fR" property to "\fBnone\fR" and the "\fIaltroot\fR" property to "\fIroot\fR". .RE .sp .ne 2 -.mk .na \fB\fB-N\fR\fR .ad @@ -1463,7 +1317,6 @@ Import the pool without mounting any file systems. .sp .ne 2 -.mk .na \fB\fB-n\fR\fR .ad @@ -1473,7 +1326,6 @@ Used with the \fB-F\fR recovery option. Determines whether a non-importable pool .sp .ne 2 -.mk .na \fB\fB-X\fR\fR .ad @@ -1484,7 +1336,6 @@ Used with the \fB-F\fR recovery option. Determines whether extreme measures to f .sp .ne 2 -.mk .na \fB\fB-T\fR\fR .ad @@ -1495,12 +1346,10 @@ Specify the txg to use for rollback. Implies \fB-FX\fR. For more details about .sp .ne 2 -.mk .na \fB\fB-s\fR .ad .RS 21n -.rt Scan using the default search path, the libblkid cache will not be consulted. A custom search path may be specified by setting the \fBZPOOL_IMPORT_PATH\fR environment variable. .RE @@ -1508,7 +1357,6 @@ Scan using the default search path, the libblkid cache will not be consulted. A .sp .ne 2 -.mk .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-m\fR] [\fB-R\fR \fIroot\fR] [\fB-F\fR [\fB-n\fR]] [\fB-t\fR]] [\fB-s\fR] \fIpool\fR | \fIid\fR [\fInewpool\fR]\fR .ad @@ -1519,7 +1367,6 @@ Imports a specific pool. A pool can be identified by its name or the numeric ide If a device is removed from a system without running "\fBzpool export\fR" 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 -.mk .na \fB\fB-o\fR \fImntopts\fR\fR .ad @@ -1530,7 +1377,6 @@ Comma-separated list of mount options to use when mounting datasets within the p .sp .ne 2 -.mk .na \fB\fB-o\fR \fIproperty=value\fR\fR .ad @@ -1541,7 +1387,6 @@ Sets the specified property on the imported pool. See the "Properties" section f .sp .ne 2 -.mk .na \fB\fB-c\fR \fIcachefile\fR\fR .ad @@ -1552,7 +1397,6 @@ Reads configuration from the given \fBcachefile\fR that was created with the "\f .sp .ne 2 -.mk .na \fB\fB-d\fR \fIdir\fR\fR .ad @@ -1563,7 +1407,6 @@ Searches for devices or files in \fIdir\fR. The \fB-d\fR option can be specified .sp .ne 2 -.mk .na \fB\fB-D\fR\fR .ad @@ -1574,7 +1417,6 @@ Imports destroyed pool. The \fB-f\fR option is also required. .sp .ne 2 -.mk .na \fB\fB-f\fR\fR .ad @@ -1585,7 +1427,6 @@ Forces import, even if the pool appears to be potentially active. .sp .ne 2 -.mk .na \fB\fB-F\fR\fR .ad @@ -1596,7 +1437,6 @@ Recovery mode for a non-importable pool. Attempt to return the pool to an import .sp .ne 2 -.mk .na \fB\fB-R\fR \fIroot\fR\fR .ad @@ -1607,7 +1447,6 @@ Sets the "\fBcachefile\fR" property to "\fBnone\fR" and the "\fIaltroot\fR" prop .sp .ne 2 -.mk .na \fB\fB-n\fR\fR .ad @@ -1618,7 +1457,6 @@ Used with the \fB-F\fR recovery option. Determines whether a non-importable pool .sp .ne 2 -.mk .na \fB\fB-X\fR\fR .ad @@ -1630,7 +1468,6 @@ Used with the \fB-F\fR recovery option. Determines whether extreme measures to f .sp .ne 2 -.mk .na \fB\fB-T\fR\fR .ad @@ -1642,7 +1479,6 @@ Specify the txg to use for rollback. Implies \fB-FX\fR. For more details about .sp .ne 2 -.mk .na \fB\fB-t\fR\fR .ad @@ -1653,7 +1489,6 @@ Used with "\fBnewpool\fR". Specifies that "\fBnewpool\fR" is temporary. Temporar .sp .ne 2 -.mk .na \fB\fB-m\fR\fR .ad @@ -1664,7 +1499,6 @@ Allows a pool to import when there is a missing log device. .sp .ne 2 -.mk .na \fB\fB-s\fR .ad @@ -1677,7 +1511,6 @@ Scan using the default search path, the libblkid cache will not be consulted. A .sp .ne 2 -.mk .na \fB\fBzpool iostat\fR [\fB-T\fR \fBd\fR | \fBu\fR] [\fB-ghHLpPvy\fR] [\fB-w\fR|[\fB-lq\fR]] [[\fIpool\fR ...]|[\fIpool vdev\fR ...]|[\fIvdev\fR ...]] [\fIinterval\fR[\fIcount\fR]]\fR @@ -1697,12 +1530,10 @@ note that the units of 'K', 'M', 'G'... that are printed in the report are in base 1024. To get the raw values, use the \fB-p\fR flag. .sp .ne 2 -.mk .na \fB\fB-T\fR \fBu\fR | \fBd\fR\fR .ad .RS 12n -.rt 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). @@ -1710,18 +1541,15 @@ Specify \fBu\fR for a printed representation of the internal representation of t .sp .ne 2 -.mk .na \fB\fB-g\fR\fR .ad .RS 12n -.rt Display vdev GUIDs instead of the normal device names. These GUIDs can be used in place of device names for the zpool detach/offline/remove/replace commands. .RE .sp .ne 2 -.mk .na \fB\fB-H\fR\fR .ad @@ -1737,13 +1565,11 @@ Scripted mode. Do not display headers, and separate fields by a single tab inste \fB\fB-L\fR\fR .ad .RS 12n -.rt Display real paths for vdevs resolving all symbolic links. This can be used to look up the current block device name regardless of the /dev/disk/ path used to open it. .RE .sp .ne 2 -.mk .na \fB\fB-p\fR\fR .ad @@ -1759,29 +1585,24 @@ Display numbers in parseable (exact) values. Time values are in nanoseconds. \fB\fB-P\fR\fR .ad .RS 12n -.rt Display full paths for vdevs instead of only the last component of the path. This can be used in conjunction with the \fB-L\fR flag. .RE .sp .ne 2 -.mk .na \fB\fB-v\fR\fR .ad .RS 12n -.rt Verbose statistics. Reports usage statistics for individual \fIvdevs\fR within the pool, in addition to the pool-wide statistics. .RE .sp .ne 2 -.mk .na \fB\fB-y\fR\fR .ad .RS 12n -.rt Omit statistics since boot. Normally the first line of output reports the statistics since boot. This option suppresses that first line of output. .RE .sp @@ -1957,7 +1778,6 @@ from the end of the interval. .RE .sp .ne 2 -.mk .na \fB\fBzpool labelclear\fR [\fB-f\fR] \fIdevice\fR .ad @@ -1966,12 +1786,10 @@ from the end of the interval. 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 Treat exported or foreign devices as inactive. .RE @@ -1979,7 +1797,6 @@ Treat exported or foreign devices as inactive. .sp .ne 2 -.mk .na \fB\fBzpool list\fR [\fB-T\fR \fBd\fR | \fBu\fR] [\fB-HgLpPv\fR] [\fB-o\fR \fIprops\fR[,...]] [\fIpool\fR] ... [\fIinterval\fR[\fIcount\fR]]\fR .ad @@ -1988,40 +1805,33 @@ Treat exported or foreign devices as inactive. Lists the given pools along with a health status and space usage. If no \fIpools\fR are specified, all pools in the system are listed. When given an \fIinterval\fR, the information is printed every \fIinterval\fR seconds until \fBCtrl-C\fR is pressed. If \fIcount\fR is specified, the command exits after \fIcount\fR reports are printed. .sp .ne 2 -.mk .na \fB\fB-H\fR\fR .ad .RS 12n -.rt Scripted mode. Do not display headers, and separate fields by a single tab instead of arbitrary space. .RE .sp .ne 2 -.mk .na \fB\fB-g\fR\fR .ad .RS 12n -.rt Display vdev GUIDs instead of the normal device names. These GUIDs can be used in place of device names for the zpool detach/offline/remove/replace commands. .RE .sp .ne 2 -.mk .na \fB\fB-L\fR\fR .ad .RS 12n -.rt Display real paths for vdevs resolving all symbolic links. This can be used to look up the current block device name regardless of the /dev/disk/ path used to open it. .RE .sp .ne 2 -.mk .na \fB\fB-p\fR\fR .ad @@ -2037,18 +1847,15 @@ Display numbers in parsable (exact) values. \fB\fB-P\fR\fR .ad .RS 12n -.rt Display full paths for vdevs instead of only the last component of the path. This can be used in conjunction with the \fB-L\fR flag. .RE .sp .ne 2 -.mk .na \fB\fB-T\fR \fBd\fR | \fBu\fR\fR .ad .RS 12n -.rt 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). @@ -2056,23 +1863,19 @@ Specify \fBu\fR for a printed representation of the internal representation of t .sp .ne 2 -.mk .na \fB\fB-o\fR \fIprops\fR\fR .ad .RS 12n -.rt 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, fragmentation, expandsize, capacity, dedupratio, health, altroot" .RE .sp .ne 2 -.mk .na \fB\fB-v\fR\fR .ad .RS 12n -.rt Verbose statistics. Reports usage statistics for individual \fIvdevs\fR within the pool, in addition to the pool-wise statistics. .RE @@ -2080,7 +1883,6 @@ Verbose statistics. Reports usage statistics for individual \fIvdevs\fR within t .sp .ne 2 -.mk .na \fB\fBzpool offline\fR [\fB-t\fR] \fIpool\fR \fIdevice\fR ...\fR .ad @@ -2091,12 +1893,10 @@ Takes the specified physical device offline. While the \fIdevice\fR is offline, This command is not applicable to spares or cache devices. .sp .ne 2 -.mk .na \fB\fB-t\fR\fR .ad .RS 6n -.rt Temporary. Upon reboot, the specified physical device reverts to its previous state. .RE @@ -2104,7 +1904,6 @@ Temporary. Upon reboot, the specified physical device reverts to its previous st .sp .ne 2 -.mk .na \fB\fBzpool online\fR [\fB-e\fR] \fIpool\fR \fIdevice\fR...\fR .ad @@ -2115,12 +1914,10 @@ Brings the specified physical device online. This command is not applicable to spares or cache devices. .sp .ne 2 -.mk .na \fB\fB-e\fR\fR .ad .RS 6n -.rt 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 @@ -2128,7 +1925,6 @@ Expand the device to use all available space. If the device is part of a mirror .sp .ne 2 -.mk .na \fB\fBzpool reguid\fR \fIpool\fR .ad @@ -2160,7 +1956,6 @@ Removes the specified device from the pool. This command currently only supports .sp .ne 2 -.mk .na \fB\fBzpool replace\fR [\fB-f\fR] [\fB-o\fR \fIproperty=value\fR] \fIpool\fR \fIold_device\fR [\fInew_device\fR]\fR .ad @@ -2173,18 +1968,15 @@ The size of \fInew_device\fR must be greater than or equal to the minimum size o \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\fR path as the old device, even though it is actually a different disk. \fBZFS\fR recognizes this. .sp .ne 2 -.mk .na \fB\fB-f\fR\fR .ad .RS 6n -.rt Forces use of \fInew_device\fR, even if its appears to be in use. Not all devices can be overridden in this manner. .RE .sp .ne 2 -.mk .na \fB\fB-o\fR \fIproperty=value\fR .ad @@ -2197,7 +1989,6 @@ Sets the given pool properties. See the "Properties" section for a list of valid .sp .ne 2 -.mk .na \fB\fBzpool scrub\fR [\fB-s\fR] \fIpool\fR ...\fR .ad @@ -2210,12 +2001,10 @@ Scrubbing and resilvering are very similar operations. The difference is that re 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 -.mk .na \fB\fB-s\fR\fR .ad .RS 6n -.rt Stop scrubbing. .RE @@ -2223,7 +2012,6 @@ Stop scrubbing. .sp .ne 2 -.mk .na \fB\fBzpool set\fR \fIproperty\fR=\fIvalue\fR \fIpool\fR\fR .ad @@ -2234,7 +2022,6 @@ Sets the given property on the specified pool. See the "Properties" section for .sp .ne 2 -.mk .na \fBzpool split\fR [\fB-gLnP\fR] [\fB-R\fR \fIaltroot\fR] [\fB-o\fR \fIproperty=value\fR] \fIpool\fR \fInewpool\fR [\fIdevice\fR ...] .ad @@ -2246,29 +2033,24 @@ The optional \fIdevice\fR specification causes the specified device(s) to be inc .sp .ne 2 -.mk .na \fB\fB-g\fR\fR .ad .RS 6n -.rt Display vdev GUIDs instead of the normal device names. These GUIDs can be used in place of device names for the zpool detach/offline/remove/replace commands. .RE .sp .ne 2 -.mk .na \fB\fB-L\fR\fR .ad .RS 6n -.rt Display real paths for vdevs resolving all symbolic links. This can be used to look up the current block device name regardless of the /dev/disk/ path used to open it. .RE .sp .ne 2 -.mk .na \fB\fB-n\fR \fR .ad @@ -2279,18 +2061,15 @@ Do dry run, do not actually perform the split. Print out the expected configurat .sp .ne 2 -.mk .na \fB\fB-P\fR\fR .ad .RS 6n -.rt Display full paths for vdevs instead of only the last component of the path. This can be used in conjunction with the \fB-L\fR flag. .RE .sp .ne 2 -.mk .na \fB\fB-R\fR \fIaltroot\fR \fR .ad @@ -2301,7 +2080,6 @@ Set \fIaltroot\fR for \fInewpool\fR and automatically import it. This can be us .sp .ne 2 -.mk .na \fB\fB-o\fR \fIproperty=value\fR \fR .ad @@ -2314,7 +2092,6 @@ Sets the specified property for \fInewpool\fR. See the “Properties” section .sp .ne 2 -.mk .na \fBzpool status\fR [\fB-gLPvxD\fR] [\fB-T\fR d | u] [\fIpool\fR] ... [\fIinterval\fR [\fIcount\fR]] .ad @@ -2326,79 +2103,65 @@ If a scrub or resilver is in progress, this command reports the percentage done .sp .ne 2 -.mk .na \fB\fB-g\fR\fR .ad .RS 12n -.rt Display vdev GUIDs instead of the normal device names. These GUIDs can be used innplace of device names for the zpool detach/offline/remove/replace commands. .RE .sp .ne 2 -.mk .na \fB\fB-L\fR\fR .ad .RS 12n -.rt Display real paths for vdevs resolving all symbolic links. This can be used to look up the current block device name regardless of the /dev/disk/ path used to open it. .RE .sp .ne 2 -.mk .na \fB\fB-P\fR\fR .ad .RS 12n -.rt Display full paths for vdevs instead of only the last component of the path. This can be used in conjunction with the \fB-L\fR flag. .RE .sp .ne 2 -.mk .na \fB\fB-v\fR\fR .ad .RS 12n -.rt Displays verbose data error information, printing out a complete list of all data errors since the last complete pool scrub. .RE .sp .ne 2 -.mk .na \fB\fB-x\fR\fR .ad .RS 12n -.rt Only display status for pools that are exhibiting errors or are otherwise unavailable. Warnings about pools not using the latest on-disk format will not be included. .RE .sp .ne 2 -.mk .na \fB\fB-D\fR\fR .ad .RS 12n -.rt Display a histogram of deduplication statistics, showing the allocated (physically present on disk) and referenced (logically referenced in the pool) block counts and sizes by reference count. .RE .sp .ne 2 -.mk .na \fB\fB-T\fR \fBd\fR | \fBu\fR\fR .ad .RS 12n -.rt 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). @@ -2408,7 +2171,6 @@ Specify \fBu\fR for a printed representation of the internal representation of t .sp .ne 2 -.mk .na \fB\fBzpool upgrade\fR\fR .ad @@ -2419,7 +2181,6 @@ Displays pools which do not have all supported features enabled and pools format .sp .ne 2 -.mk .na \fB\fBzpool upgrade\fR \fB-v\fR\fR .ad @@ -2430,7 +2191,6 @@ Displays legacy \fBZFS\fR versions supported by the current software. See \fBzfs .sp .ne 2 -.mk .na \fB\fBzpool upgrade\fR [\fB-V\fR \fIversion\fR] \fB-a\fR | \fIpool\fR ...\fR .ad @@ -2439,23 +2199,19 @@ Displays legacy \fBZFS\fR versions supported by the current software. See \fBzfs Enables all supported features on the given pool. Once this is done, the pool will no longer be accessible on systems that do not support feature flags. See \fBzfs-features\fR(5) for details on compatibility with systems that support feature flags, but do not support all features enabled on the pool. .sp .ne 2 -.mk .na \fB\fB-a\fR\fR .ad .RS 14n -.rt Enables all supported features on all pools. .RE .sp .ne 2 -.mk .na \fB\fB-V\fR \fIversion\fR\fR .ad .RS 14n -.rt Upgrade to the specified legacy version. If the \fB-V\fR flag is specified, no features will be enabled on the pool. This option can only be used to increase the version number up to the last supported legacy version number. .RE @@ -2781,34 +2537,28 @@ data 23.9G 14.6G 9.30G 48% - 61% 1.00x ONLINE - The following exit values are returned: .sp .ne 2 -.mk .na \fB\fB0\fR\fR .ad .RS 5n -.rt Successful completion. .RE .sp .ne 2 -.mk .na \fB\fB1\fR\fR .ad .RS 5n -.rt An error occurred. .RE .sp .ne 2 -.mk .na \fB\fB2\fR\fR .ad .RS 5n -.rt Invalid command line options were specified. .RE |