2 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
3 .\" Copyright 2011 Nexenta Systems, Inc. All rights reserved.
4 .\" Copyright (c) 2013 by Delphix. All rights reserved.
5 .\" Copyright (c) 2012 Cyril Plisko. All Rights Reserved.
6 .\" Copyright (c) 2017 Datto Inc.
7 .\" The contents of this file are subject to the terms of the Common Development
8 .\" and Distribution License (the "License"). You may not use this file except
9 .\" in compliance with the License. You can obtain a copy of the license at
10 .\" usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
12 .\" See the License for the specific language governing permissions and
13 .\" limitations under the License. When distributing Covered Code, include this
14 .\" CDDL HEADER in each file and include the License file at
15 .\" usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this
16 .\" CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your
17 .\" own identifying information:
18 .\" Portions Copyright [yyyy] [name of copyright owner]
19 .TH zpool 8 "April 12, 2017" "ZFS pool 28, filesystem 5" "System Administration Commands"
21 zpool \- configures ZFS storage pools
25 \fBzpool\fR [\fB-?\fR]
30 \fBzpool add\fR [\fB-fgLnP\fR] [\fB-o\fR \fIproperty=value\fR] \fIpool\fR \fIvdev\fR ...
35 \fBzpool attach\fR [\fB-f\fR] [\fB-o\fR \fIproperty=value\fR] \fIpool\fR \fIdevice\fR \fInew_device\fR
40 \fBzpool clear\fR \fIpool\fR [\fIdevice\fR]
45 \fBzpool create\fR [\fB-fnd\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-o\fR feature@\fIfeature=value\fR]
46 ... [\fB-O\fR \fIfile-system-property=value\fR] ... [\fB-m\fR \fImountpoint\fR] [\fB-R\fR \fIroot\fR]
47 ... [\fB-t\fR \fItname\fR] \fIpool\fR \fIvdev\fR ...
52 \fBzpool destroy\fR [\fB-f\fR] \fIpool\fR
57 \fBzpool detach\fR \fIpool\fR \fIdevice\fR
62 \fBzpool events\fR [\fB-vHfc\fR] [\fIpool\fR] ...
67 \fBzpool export\fR [\fB-a\fR] [\fB-f\fR] \fIpool\fR ...
72 \fBzpool get\fR [\fB-Hp\fR] [\fB-o \fR\fIfield\fR[,...]] "\fIall\fR" | \fIproperty\fR[,...] \fIpool\fR ...
77 \fBzpool history\fR [\fB-il\fR] [\fIpool\fR] ...
82 \fBzpool import\fR [\fB-d\fR \fIdir\fR] [\fB-D\fR]
87 \fBzpool import\fR [\fB-o \fImntopts\fR\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR]
88 [\fB-D\fR] [\fB-f\fR] [\fB-m\fR] [\fB-N\fR] [\fB-R\fR \fIroot\fR] [\fB-F\fR [\fB-n\fR] [\fB-X\fR\] [\fB-T\fR\]] [\fB-s\fR] \fB-a\fR
93 \fBzpool import\fR [\fB-o \fImntopts\fR\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR]
94 [\fB-D\fR] [\fB-f\fR] [\fB-m\fR] [\fB-R\fR \fIroot\fR] [\fB-F\fR [\fB-n\fR] [\fB-X\fR] [\fB-T\fR\]] [\fB-t\fR]] [\fB-s\fR]
95 \fIpool\fR | \fIid\fR [\fInewpool\fR]
100 \fB\fBzpool iostat\fR [[[\fB-c\fR \fBSCRIPT\fR] [\fB-lq\fR]] | \fB-rw\fR] [\fB-T\fR \fBd\fR | \fBu\fR] [\fB-ghHLpPvy\fR]
101 [[\fIpool\fR ...]|[\fIpool vdev\fR ...]|[\fIvdev\fR ...]] [\fIinterval\fR[\fIcount\fR]]\fR
107 \fBzpool labelclear\fR [\fB-f\fR] \fIdevice\fR
112 \fBzpool list\fR [\fB-T\fR d | u ] [\fB-HgLpPv\fR] [\fB-o\fR \fIproperty\fR[,...]] [\fIpool\fR] ...
113 [\fIinterval\fR[\fIcount\fR]]
118 \fBzpool offline\fR [\fB-f\fR] [\fB-t\fR] \fIpool\fR \fIdevice\fR ...
123 \fBzpool online\fR \fIpool\fR \fIdevice\fR ...
128 \fBzpool reguid\fR \fIpool\fR
133 \fBzpool reopen\fR \fIpool\fR
138 \fBzpool remove\fR \fIpool\fR \fIdevice\fR ...
143 \fBzpool replace\fR [\fB-f\fR] [\fB-o\fR \fIproperty=value\fR] \fIpool\fR \fIdevice\fR [\fInew_device\fR]
148 \fBzpool scrub\fR [\fB-s\fR] \fIpool\fR ...
153 \fBzpool set\fR \fIproperty\fR=\fIvalue\fR \fIpool\fR
158 \fBzpool split\fR [\fB-gLnP\fR] [\fB-R\fR \fIaltroot\fR] [\fB-o\fR \fIproperty=value\fR] \fIpool\fR \fInewpool\fR [\fIdevice\fR ...]
163 \fBzpool status\fR [\fB-c\fR \fBSCRIPT\fR] [\fB-gLPvxD\fR] [\fB-T\fR d | u] [\fIpool\fR] ... [\fIinterval\fR [\fIcount\fR]]
168 \fBzpool sync\fR [\fBpool\fR] ...
178 \fBzpool upgrade\fR \fB-v\fR
183 \fBzpool upgrade\fR [\fB-V\fR \fIversion\fR] \fB-a\fR | \fIpool\fR ...
189 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.
192 All datasets within a storage pool share the same space. See \fBzfs\fR(8) for information on managing datasets.
193 .SS "Virtual Devices (vdevs)"
196 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:
203 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.
212 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.
221 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.
242 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.
244 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.
246 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.
255 A special pseudo-\fBvdev\fR which keeps track of available hot spares for a pool. For more information, see the "Hot Spares" section.
264 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.
273 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.
278 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 allowed.
281 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.
284 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:
288 # \fBzpool create mypool mirror sda sdb mirror sdc sdd\fR
293 .SS "Device Failure and Recovery"
296 \fBZFS\fR supports a rich set of mechanisms for handling device failure and data corruption. All metadata and data is checksummed, and \fBZFS\fR automatically repairs bad data from a good copy when corruption is detected.
299 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 corruption can render some or all of your data unavailable.
302 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.
305 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:
312 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.
314 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:
319 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.
325 The number of I/O errors exceeds acceptable levels. The device could not be marked as faulted because there are insufficient replicas to continue functioning.
335 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.
337 One or more component devices is in the faulted state, and insufficient replicas exist to continue functioning. The underlying conditions are as follows:
342 The device could be opened, but the contents did not match expected values.
348 The number of I/O errors exceeds acceptable levels and the device is faulted to prevent further use of the device.
358 The device was explicitly taken offline by the "\fBzpool offline\fR" command.
367 The device is online and functioning.
376 The device was physically removed while the system was running. Device removal detection is hardware-dependent and may not be supported on all platforms.
385 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.
390 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 hardware-dependent and might not be supported on all platforms.
394 \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,
398 # zpool create pool mirror sda sdb spare sdc sdd
405 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.
408 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.
411 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.
414 Spares cannot replace log devices.
418 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:
422 \fB# zpool create pool sda sdb log sdc\fR
429 Multiple log devices can also be specified, and they can be mirrored. See the EXAMPLES section for an example of mirroring multiple log devices.
432 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.
436 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 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.
439 To create a pool with cache devices, specify a "cache" \fBvdev\fR with any number of devices. For example:
443 \fB# zpool create pool sda sdb cache sdc sdd\fR
450 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.
453 The content of the cache devices is considered volatile, as is the case with other system caches.
457 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:
461 \fB\fBavailable\fR\fR
464 Amount of storage available within the pool. This property can also be referred to by its shortened column name, "avail".
473 Percentage of pool space used. This property can also be referred to by its shortened column name, "cap".
479 \fB\fBexpandsize\fR\fR
482 Amount of uninitialized space within the pool or device that can be used to
483 increase the total capacity of the pool. Uninitialized space consists of
484 any space on an EFI labeled vdev which has not been brought online
485 (i.e. zpool online -e). This space occurs when a LUN is dynamically expanded.
491 \fB\fBfragmentation\fR\fR
494 The amount of fragmentation in the pool.
503 The amount of free space available in the pool.
512 After a file system or snapshot is destroyed, the space it was using is
513 returned to the pool asynchronously. \fB\fBfreeing\fR\fR is the amount of
514 space remaining to be reclaimed. Over time \fB\fBfreeing\fR\fR will decrease
515 while \fB\fBfree\fR\fR increases.
524 The current health of the pool. Health can be "\fBONLINE\fR", "\fBDEGRADED\fR", "\fBFAULTED\fR", " \fBOFFLINE\fR", "\fBREMOVED\fR", or "\fBUNAVAIL\fR".
533 A unique identifier for the pool.
542 Total size of the storage pool.
548 \fB\fBunsupported@\fR\fIfeature_guid\fR\fR
552 Information about unsupported features that are enabled on the pool. See
553 \fBzpool-features\fR(5) for details.
562 Amount of storage space used within the pool.
567 The 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.
571 The following property can be set at creation time and import time:
575 \fB\fBaltroot\fR=(unset) | \fIpath\fR\fR
579 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.
584 The following property can only be set at import time:
588 \fB\fBreadonly\fR=\fBoff\fR | \fBon\fR\fR
592 If set to \fBon\fR, the pool will be imported in read-only mode: Synchronous data in the intent log will not be accessible, properties of the pool can not be changed and datasets of the pool can only be mounted read-only. The \fBreadonly\fR property of its datasets will be implicitly set to \fBon\fR.
594 It can also be specified by its column name of \fBrdonly\fR.
596 To write to a read-only pool, a export and import of the pool is required.
601 The following properties can be set at creation time and import time, and later changed with the \fBzpool set\fR command:
605 \fB\fBashift\fR=\fIashift\fR\fR
609 Pool sector size exponent, to the power of 2 (internally referred to as "ashift"). Values from 9 to 16, 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. For optimal performance, the pool sector size should be greater than or equal to the sector size of the underlying disks. 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).
611 When set, this property is used as the default hint value in \fIsubsequent\fR vdev operations (add, attach and replace). Changing this value will \fInot\fR modify any existing vdev, not even on disk replacement; however it can be used, for instance, to replace a dying 512B sectors disk with a newer 4KiB sectors device: this will probably result in bad performance but at the same time could prevent loss of data.
617 \fB\fBautoexpand\fR=\fBoff\fR | \fBon\fR\fR
621 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.
627 \fB\fBautoreplace\fR=\fBoff\fR | \fBon\fR\fR
631 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 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". Autoreplace can also be used with virtual disks (like device mapper) provided that you use the /dev/disk/by-vdev paths setup by vdev_id.conf. See the vdev_id.conf man page for more details. Autoreplace and autoonline require libudev to be present at build time. If you're using device mapper disks, you must have libdevmapper installed at build time as well.
637 \fB\fBbootfs\fR=(unset) | \fIpool\fR/\fIdataset\fR\fR
641 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.
647 \fB\fBcachefile\fR=\fBnone\fR | \fIpath\fR\fR
651 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 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.
653 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.
659 \fB\fBcomment\fR=(unset) | \fB\fItext\fR\fR
663 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.
669 \fB\fBdedupditto\fR=\fB\fInumber\fR\fR
673 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.
679 \fB\fBdelegation\fR=\fBon\fR | \fBoff\fR\fR
683 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.
689 \fB\fBfailmode\fR=\fBwait\fR | \fBcontinue\fR | \fBpanic\fR\fR
693 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:
700 Blocks all \fBI/O\fR access until the device connectivity is recovered and the errors are cleared. This is the default behavior.
709 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.
718 Prints out a message to the console and generates a system crash dump.
726 \fB\fBfeature@\fR\fIfeature_name\fR=\fBenabled\fR\fR
729 The value of this property is the current state of \fIfeature_name\fR. The
730 only valid value when setting this property is \fBenabled\fR which moves
731 \fIfeature_name\fR to the enabled state. See \fBzpool-features\fR(5) for
732 details on feature states.
738 \fB\fBlistsnapshots\fR=on | off\fR
742 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".
744 This property can also be referred to by its shortened name, \fBlistsnaps\fR.
750 \fB\fBversion\fR=(unset) | \fIversion\fR\fR
754 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. Once feature flags are enabled on a pool this property will no longer have a value.
760 All subcommands that modify state are logged persistently to the pool in their original form.
763 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:
767 \fB\fBzpool\fR \fB-?\fR\fR
771 Displays a help message.
777 \fB\fBzpool add\fR [\fB-fgLnP\fR] [\fB-o\fR \fIproperty=value\fR] \fIpool\fR \fIvdev\fR ...\fR
781 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.
788 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.
797 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.
806 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.
815 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.
824 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.
830 \fB\fB-o\fR \fIproperty=value\fR
834 Sets the given pool properties. See the "Properties" section for a list of valid properties that can be set. The only property supported at the moment is \fBashift\fR.
837 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.
843 \fB\fBzpool attach\fR [\fB-f\fR] [\fB-o\fR \fIproperty=value\fR] \fIpool\fR \fIdevice\fR \fInew_device\fR\fR
847 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.
854 Forces use of \fInew_device\fR, even if its appears to be in use. Not all devices can be overridden in this manner.
860 \fB\fB-o\fR \fIproperty=value\fR
864 Sets the given pool properties. See the "Properties" section for a list of valid properties that can be set. The only property supported at the moment is \fBashift\fR.
872 \fB\fBzpool clear\fR \fIpool\fR [\fIdevice\fR] ...\fR
876 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.
882 \fB\fBzpool create\fR [\fB-fnd\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-o\fR feature@\fIfeature=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
886 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 ("-"), period ("."), colon (":"), and space (" "). 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.
888 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.
890 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.
892 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 option.
894 By default all supported features are enabled on the new pool unless the \fB-d\fR option is specified.
902 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.
912 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.
922 Do not enable any features on the new pool. Individual features can be enabled by setting their corresponding properties to \fBenabled\fR with the \fB-o\fR option. See \fBzpool-features\fR(5) for details about feature properties.
928 \fB\fB-o\fR \fIproperty=value\fR [\fB-o\fR \fIproperty=value\fR] ...\fR
932 Sets the given pool properties. See the "Properties" section for a list of valid properties that can be set.
938 \fB\fB-o\fR feature@\fIfeature=value\fR [\fB-o\fR feature@\fIfeature=value\fR] ...\fR
942 Sets the given pool feature. See \fBzpool-features(5)\fR for a list of valid features that can be set.
944 Value can be either \fBdisabled\fR or \fBenabled\fR.
950 \fB\fB-O\fR \fIfile-system-property=value\fR\fR
954 \fB[\fB-O\fR \fIfile-system-property=value\fR] ...\fR
958 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 can be set.
964 \fB\fB-R\fR \fIroot\fR\fR
968 Equivalent to "-o cachefile=none,altroot=\fIroot\fR"
974 \fB\fB-m\fR \fImountpoint\fR\fR
978 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).
984 \fB\fB-t\fR \fItname\fR\fR
988 Sets the in-core pool name to "\fBtname\fR" while the on-disk name will be the name specified as the pool name "\fBpool\fR". This will set the default cachefile property to none. This is intended to handle name space collisions when creating pools for other systems, such as virtual machines or physical machines whose pools live on network block devices.
996 \fB\fBzpool destroy\fR [\fB-f\fR] \fIpool\fR\fR
1000 Destroys the given pool, freeing up any devices for other use. This command tries to unmount any active datasets before destroying the pool.
1007 Forces any active datasets contained within the pool to be unmounted.
1015 \fB\fBzpool detach\fR \fIpool\fR \fIdevice\fR\fR
1019 Detaches \fIdevice\fR from a mirror. The operation is refused if there are no other valid replicas of the data. If \fIdevice\fR may be re-added to the pool later on then consider the "\fBzpool offline\fR" command instead.
1027 \fBzpool events\fR [\fB-vHfc\fR] [\fIpool\fR] ...
1031 Description of the different events generated by the ZFS kernel modules. See \fBzfs-events\fR(5) for more information about the subclasses and event payloads that can be generated.
1039 Get a full detail of the events and what information is available about it.
1048 Scripted mode. Do not display headers, and separate fields by a single tab instead of arbitrary space.
1066 Clear all previous events.
1074 \fB\fBzpool export\fR [\fB-a\fR] [\fB-f\fR] \fIpool\fR ...\fR
1078 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.
1080 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.
1082 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.
1089 Exports all pools imported on the system.
1098 Forcefully unmount all datasets, using the "\fBunmount -f\fR" command.
1100 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.
1108 \fB\fBzpool get\fR [\fB-Hp\fR] [\fB-o \fR\fIfield\fR[,...]] "\fIall\fR" | \fIproperty\fR[,...]
1113 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 the following fields:
1117 name Name of storage pool
1118 property Property name
1119 value Property value
1120 source Property source, either 'default' or 'local'.
1125 See the "Properties" section for more information on the available pool properties.
1133 Scripted mode. Do not display headers, and separate fields by a single tab instead of arbitrary space.
1142 Display numbers in parsable (exact) values.
1148 \fB\fB-o\fR \fIfield\fR\fR
1151 A comma-separated list of columns to display. \fBname,property,value,source\fR
1152 is the default value.
1159 \fB\fBzpool history\fR [\fB-il\fR] [\fIpool\fR] ...\fR
1163 Displays the command history of the specified pools or all pools if no pool is specified.
1170 Displays internally logged \fBZFS\fR events in addition to user initiated events.
1179 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.
1187 \fB\fBzpool import\fR [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR] [\fB-D\fR]\fR
1191 Lists pools available to import. If the \fB-d\fR option is not specified, this command searches for devices in "/dev". 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.
1193 The numeric identifier is unique, and can be used instead of the pool name when multiple exported pools of the same name are available.
1197 \fB\fB-c\fR \fIcachefile\fR\fR
1200 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.
1206 \fB\fB-d\fR \fIdir\fR\fR
1209 Searches for devices or files in \fIdir\fR. The \fB-d\fR option can be specified multiple times.
1218 Lists destroyed pools only.
1226 \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
1230 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.
1234 \fB\fB-o\fR \fImntopts\fR\fR
1237 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.
1243 \fB\fB-o\fR \fIproperty=value\fR\fR
1246 Sets the specified property on the imported pool. See the "Properties" section for more information on the available pool properties.
1252 \fB\fB-c\fR \fIcachefile\fR\fR
1255 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.
1261 \fB\fB-d\fR \fIdir\fR\fR
1264 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.
1273 Imports destroyed pools only. The \fB-f\fR option is also required.
1282 Forces import, even if the pool appears to be potentially active.
1291 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.
1300 Searches for and imports all pools found.
1309 Allows a pool to import when there is a missing log device.
1315 \fB\fB-R\fR \fIroot\fR\fR
1318 Sets the "\fBcachefile\fR" property to "\fBnone\fR" and the "\fIaltroot\fR" property to "\fIroot\fR".
1327 Import the pool without mounting any file systems.
1336 Used with the \fB-F\fR 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 \fB-F\fR option, above.
1345 Used with the \fB-F\fR recovery option. Determines whether extreme measures to find a valid txg should take place. This allows the pool to be rolled back to a txg which is no longer guaranteed to be consistent. Pools imported at an inconsistent txg may contain uncorrectable checksum errors. For more details about pool recovery mode, see the \fB-F\fR option, above.
1346 \fBWARNING\fR: This option can be extremely hazardous to the health of your pool and should only be used as a last resort.
1355 Specify the txg to use for rollback. Implies \fB-FX\fR. For more details about pool recovery mode, see the \fB-X\fR option, above.
1356 \fBWARNING\fR: This option can be extremely hazardous to the health of your pool and should only be used as a last resort.
1365 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.
1373 \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
1377 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.
1379 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.
1383 \fB\fB-o\fR \fImntopts\fR\fR
1387 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.
1393 \fB\fB-o\fR \fIproperty=value\fR\fR
1397 Sets the specified property on the imported pool. See the "Properties" section for more information on the available pool properties.
1403 \fB\fB-c\fR \fIcachefile\fR\fR
1407 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.
1413 \fB\fB-d\fR \fIdir\fR\fR
1417 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.
1427 Imports destroyed pool. The \fB-f\fR option is also required.
1437 Forces import, even if the pool appears to be potentially active.
1447 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.
1453 \fB\fB-R\fR \fIroot\fR\fR
1457 Sets the "\fBcachefile\fR" property to "\fBnone\fR" and the "\fIaltroot\fR" property to "\fIroot\fR".
1467 Used with the \fB-F\fR 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 \fB-F\fR option, above.
1477 Used with the \fB-F\fR recovery option. Determines whether extreme measures to find a valid txg should take place. This allows the pool to be rolled back to a txg which is no longer guaranteed to be consistent. Pools imported at an inconsistent txg may contain uncorrectable checksum errors. For more details about pool recovery mode, see the \fB-F\fR option, above.
1478 \fBWARNING\fR: This option can be extremely hazardous to the health of your pool and should only be used as a last resort.
1488 Specify the txg to use for rollback. Implies \fB-FX\fR. For more details about pool recovery mode, see the \fB-X\fR option, above.
1489 \fBWARNING\fR: This option can be extremely hazardous to the health of your pool and should only be used as a last resort.
1499 Used with "\fBnewpool\fR". Specifies that "\fBnewpool\fR" is temporary. Temporary pool names last until export. Ensures that the original pool name will be used in all label updates and therefore is retained upon export. Will also set -o cachefile=none when not explicitly specified.
1509 Allows a pool to import when there is a missing log device.
1519 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.
1527 \fB\fBzpool iostat\fR [[[\fB-c\fR \fBSCRIPT\fR] [\fB-lq\fR]] | \fB-rw\fR] [\fB-T\fR \fBd\fR | \fBu\fR] [\fB-ghHLpPvy\fR] [[\fIpool\fR ...]|[\fIpool vdev\fR ...]|[\fIvdev\fR ...]] [\fIinterval\fR[\fIcount\fR]]\fR
1532 Displays \fBI/O\fR statistics for the given \fIpool\fRs/\fIvdev\fRs. You can
1533 pass in a list of \fIpool\fRs, a \fIpool\fR and list of \fIvdev\fRs in that
1534 \fIpool\fR, or a list of any \fIvdev\fRs from any \fIpool\fR. If no items are
1535 specified, statistics for every pool in the system are shown. When given an
1536 interval, the statistics are printed every \fIinterval\fR seconds until
1537 \fBCtrl-C\fR is pressed. If \fIcount\fR is specified, the command exits after
1538 \fIcount\fR reports are printed. The first report printed is always the
1539 statistics since boot regardless of whether \fIinterval\fR and \fIcount\fR
1540 are passed. However, this behavior can be suppressed with the -y flag. Also
1541 note that the units of 'K', 'M', 'G'... that are printed in the report are in
1542 base 1024. To get the raw values, use the \fB-p\fR flag.
1546 \fB\fB-c\fR \fB[SCRIPT1,SCRIPT2,...]\fR
1549 Run a script (or scripts) on each vdev and include the output in zpool iostat
1551 The \fB-c\fR option allows you to run script(s) for each vdev and display the
1552 output in zpool iostat. For security reasons, a user can only execute scripts
1553 as an unprivileged user. By default, a user may run a script from ~/.zpool.d
1554 or /etc/zfs/zpool.d. The default search path can be overriden by setting
1555 the \fBZPOOL_SCRIPTS_PATH\fR environment variable. A privileged user can run
1556 \fB-c\fR if they have the \fBZPOOL_SCRIPTS_AS_ROOT\fR environment variable set.
1557 If a script requires the use of a privileged command (like \fBsmartctl(8)\fR)
1558 then it's recommended you allow the user access to it in /etc/sudoers or add
1559 the user to the /etc/sudoers.d/zfs file.
1561 If \fB-c\fR is passed without a script name, it prints a list of all scripts.
1562 \fB-c\fR also sets verbose mode (\fB-v\fR).
1564 Script output should be in the form of "name=value". The column name is
1565 set to "name" and the value is set to "value". Multiple lines can be used to
1566 output multiple columns. The first line of output not in the "name=value"
1567 format is displayed without a column title, and no more output after that is
1568 displayed. This can be useful for printing error messages. Blank or NULL
1569 values are printed as a '-' to make output awk-able.
1571 The following environment variables are set before running each script:
1573 \fB$VDEV_PATH\fR: Full path to the vdev.
1575 \fB$VDEV_UPATH\fR: "Underlying path" to the vdev. For device mapper, multipath, or
1576 partitioned vdevs, \fBVDEV_UPATH\fR is the actual underlying /dev/sd* disk.
1577 This can be useful if the command you're running requires a /dev/sd* device.
1579 \fB$VDEV_ENC_SYSFS_PATH\fR: The sysfs path to the vdev's enclosure LEDs (if any).
1585 \fB\fB-T\fR \fBu\fR | \fBd\fR\fR
1588 Display a time stamp.
1590 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).
1599 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.
1608 Scripted mode. Do not display headers, and separate fields by a single tab instead of arbitrary space.
1617 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.
1626 Display numbers in parsable (exact) values. Time values are in nanoseconds.
1635 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.
1644 Print request size histograms for the leaf ZIOs. This includes histograms of
1645 individual ZIOs ("ind") and aggregate ZIOs ("agg"). These stats can be useful
1646 for seeing how well the ZFS IO aggregator is working. Do not confuse these
1647 request size stats with the block layer requests; it's possible ZIOs can
1648 be broken up before being sent to the block device.
1657 Verbose statistics. Reports usage statistics for individual \fIvdevs\fR within the pool, in addition to the pool-wide statistics.
1666 Omit statistics since boot. Normally the first line of output reports the statistics since boot. This option suppresses that first line of output.
1674 Display latency histograms:
1682 Total IO time (queuing + disk IO time).
1689 Disk IO time (time reading/writing the disk).
1696 Amount of time IO spent in synchronous priority queues. Does not include
1704 Amount of time IO spent in asynchronous priority queues. Does not include
1712 Amount of time IO spent in scrub queue. Does not include disk time.
1717 All histogram buckets are power-of-two sized. The time labels are the end
1718 ranges of the buckets, so for example, a 15ns bucket stores latencies from
1719 8-15ns. The last bucket is also a catch-all for latencies higher than the
1728 Include average latency statistics:
1736 Average total IO time (queuing + disk IO time).
1743 Average disk IO time (time reading/writing the disk).
1750 Average amount of time IO spent in synchronous priority queues. Does not
1758 Average amount of time IO spent in asynchronous priority queues. Does not
1766 Average queuing time in scrub queue. Does not include disk time.
1776 Include active queue statistics. Each priority queue has both pending ("pend")
1777 and active ("activ") IOs. Pending IOs are waiting to be issued to the disk, and
1778 active IOs have been issued to disk and are waiting for completion. These stats
1779 are broken out by priority queue:
1786 Current number of entries in synchronous priority queues.
1793 Current number of entries in asynchronous priority queues.
1800 Current number of entries in scrub queue.
1803 All queue statistics are instantaneous measurements of the number of entries
1804 in the queues. If you specify an interval, the measurements will be sampled
1805 from the end of the interval.
1813 \fB\fBzpool labelclear\fR [\fB-f\fR] \fIdevice\fR
1817 Removes ZFS label information from the specified device. The device must not be part of an active pool configuration.
1824 Treat exported or foreign devices as inactive.
1832 \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
1836 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.
1843 Scripted mode. Do not display headers, and separate fields by a single tab instead of arbitrary space.
1852 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.
1861 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.
1870 Display numbers in parsable (exact) values.
1879 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.
1885 \fB\fB-T\fR \fBd\fR | \fBu\fR\fR
1888 Display a time stamp.
1890 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).
1896 \fB\fB-o\fR \fIprops\fR\fR
1899 Comma-separated list of properties to display. See the "Properties" section for a list of valid properties. The default list is "name, size, alloc, free, fragmentation, expandsize, capacity, dedupratio, health, altroot"
1908 Verbose statistics. Reports usage statistics for individual \fIvdevs\fR within the pool, in addition to the pool-wise statistics.
1916 \fB\fBzpool offline\fR [\fB-f\fR] [\fB-t\fR] \fIpool\fR \fIdevice\fR ...\fR
1920 Takes the specified physical device offline. While the \fIdevice\fR is offline, no attempt is made to read or write to the device.
1927 Force fault. Instead of offlining the disk, put it into a faulted state. The
1928 fault will persist across imports unless the \fB-t\fR flag was specified.
1937 Temporary. Upon reboot, the specified physical device reverts to its previous state.
1945 \fB\fBzpool online\fR [\fB-e\fR] \fIpool\fR \fIdevice\fR...\fR
1949 Brings the specified physical device online.
1951 This command is not applicable to spares or cache devices.
1958 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.
1966 \fB\fBzpool reguid\fR \fIpool\fR
1970 Generates a new unique identifier for the pool. You must ensure that all
1971 devices in this pool are online and healthy before performing this action.
1977 \fB\fBzpool reopen\fR \fIpool\fR
1981 Reopen all the vdevs associated with the pool.
1987 \fB\fBzpool remove\fR \fIpool\fR \fIdevice\fR ...\fR
1991 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.
1997 \fB\fBzpool replace\fR [\fB-f\fR] [\fB-o\fR \fIproperty=value\fR] \fIpool\fR \fIold_device\fR [\fInew_device\fR]\fR
2001 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.
2003 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.
2005 \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.
2012 Forces use of \fInew_device\fR, even if its appears to be in use. Not all devices can be overridden in this manner.
2018 \fB\fB-o\fR \fIproperty=value\fR
2022 Sets the given pool properties. See the "Properties" section for a list of valid properties that can be set. The only property supported at the moment is \fBashift\fR.
2030 \fB\fBzpool scrub\fR [\fB-s\fR] \fIpool\fR ...\fR
2034 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.
2036 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.
2038 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.
2053 \fB\fBzpool set\fR \fIproperty\fR=\fIvalue\fR \fIpool\fR\fR
2057 Sets the given property on the specified pool. See the "Properties" section for more information on what properties can be set and acceptable values.
2063 \fBzpool split\fR [\fB-gLnP\fR] [\fB-R\fR \fIaltroot\fR] [\fB-o\fR \fIproperty=value\fR] \fIpool\fR \fInewpool\fR [\fIdevice\fR ...]
2067 Split devices off \fIpool\fR creating \fInewpool\fR. All \fBvdev\fRs in \fIpool\fR must be mirrors and the pool must not be in the process of resilvering. At the time of the split, \fInewpool\fR will be a replica of \fIpool\fR. By default, the last device in each mirror is split from \fIpool\fR to create \fInewpool\fR.
2069 The optional \fIdevice\fR specification causes the specified device(s) to be included in the new pool and, should any devices remain unspecified, the last device in each mirror is used as would be by default.
2077 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.
2086 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.
2096 Do dry run, do not actually perform the split. Print out the expected configuration of \fInewpool\fR.
2105 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.
2111 \fB\fB-R\fR \fIaltroot\fR \fR
2115 Set \fIaltroot\fR for \fInewpool\fR and automatically import it. This can be useful to avoid mountpoint collisions if \fInewpool\fR is imported on the same filesystem as \fIpool\fR.
2121 \fB\fB-o\fR \fIproperty=value\fR \fR
2125 Sets the specified property for \fInewpool\fR. See the “Properties” section for more information on the available pool properties.
2133 \fBzpool status\fR [\fB-c\fR \fB[SCRIPT1,SCRIPT2,...] \fR] [\fB-gLPvxD\fR] [\fB-T\fR d | u] [\fIpool\fR] ... [\fIinterval\fR [\fIcount\fR]]
2137 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" section.
2139 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.
2144 \fB\fB-c\fR \fB[SCRIPT1,SCRIPT2,...]\fR
2147 Run a script (or scripts) on each vdev and include the output in zpool status
2149 The \fB-c\fR option allows you to run script(s) for each vdev and display the
2150 output in zpool status. For security reasons, a user can only execute scripts
2151 as an unprivileged user. By default, a user may run a script from ~/.zpool.d
2152 or /etc/zfs/zpool.d. The default search path can be overriden by setting
2153 the \fBZPOOL_SCRIPTS_PATH\fR environment variable. A privileged user can run
2154 \fB-c\fR if they have the \fBZPOOL_SCRIPTS_AS_ROOT\fR environment variable set.
2155 If a script requires the use of a privileged command (like \fBsmartctl(8)\fR)
2156 then it's recommended you allow the user access to it in /etc/sudoers or add
2157 the user to the /etc/sudoers.d/zfs file.
2159 If \fB-c\fR is passed without a script name, it prints a list of all scripts.
2161 Script output should be in the form of "name=value". The column name is
2162 set to "name" and the value is set to "value". Multiple lines can be used to
2163 output multiple columns. The first line of output not in the "name=value"
2164 format is displayed without a column title, and no more output after that is
2165 displayed. This can be useful for printing error messages. Blank or NULL
2166 values are printed as a '-' to make output awk-able.
2168 The following environment variables are set before running each command:
2170 \fB$VDEV_PATH\fR: Full path to the vdev.
2172 \fB$VDEV_UPATH\fR: "Underlying path" to the vdev. For device mapper, multipath, or
2173 partitioned vdevs, \fBVDEV_UPATH\fR is the actual underlying /dev/sd* disk.
2174 This can be useful if the command you're running requires a /dev/sd* device.
2176 \fB$VDEV_ENC_SYSFS_PATH\fR: The sysfs path to the vdev's enclosure LEDs (if any).
2185 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.
2194 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.
2203 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.
2212 Displays verbose data error information, printing out a complete list of all data errors since the last complete pool scrub.
2221 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.
2230 Display a histogram of deduplication statistics, showing the allocated (physically present on disk) and
2231 referenced (logically referenced in the pool) block counts and sizes by reference count.
2237 \fB\fB-T\fR \fBd\fR | \fBu\fR\fR
2240 Display a time stamp.
2242 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).
2250 \fB\fBzpool sync\fR\fR [\fBpool\fR] ...
2254 This command forces all in-core dirty data to be written to the primary pool
2255 storage and not the ZIL. It will also update administrative information
2256 including quota reporting.
2257 Without arguments, \fBzpool sync\fR will sync all pools on the system.
2258 Otherwise, it will sync only the specified pool(s).
2264 \fB\fBzpool upgrade\fR\fR
2268 Displays pools which do not have all supported features enabled and pools formatted using a legacy ZFS version number. These pools can continue to be used, but some features may not be available. Use "\fBzpool upgrade -a\fR" to enable all features on all pools.
2274 \fB\fBzpool upgrade\fR \fB-v\fR\fR
2278 Displays legacy \fBZFS\fR versions supported by the current software. See \fBzfs-features\fR(5) for a description of feature flags features supported by the current software.
2284 \fB\fBzpool upgrade\fR [\fB-V\fR \fIversion\fR] \fB-a\fR | \fIpool\fR ...\fR
2288 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.
2295 Enables all supported features on all pools.
2301 \fB\fB-V\fR \fIversion\fR\fR
2304 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.
2311 \fBExample 1 \fRCreating a RAID-Z Storage Pool
2314 The following command creates a pool with a single \fBraidz\fR root \fIvdev\fR that consists of six disks.
2319 # \fBzpool create tank raidz sda sdb sdc sdd sde sdf\fR
2325 \fBExample 2 \fRCreating a Mirrored Storage Pool
2328 The following command creates a pool with two mirrors, where each mirror contains two disks.
2333 # \fBzpool create tank mirror sda sdb mirror sdc sdd\fR
2339 \fBExample 3 \fRCreating a ZFS Storage Pool by Using Partitions
2342 The following command creates an unmirrored pool using two disk partitions.
2347 # \fBzpool create tank sda1 sdb2\fR
2353 \fBExample 4 \fRCreating a ZFS Storage Pool by Using Files
2356 The following command creates an unmirrored pool using files. While not recommended, a pool based on files can be useful for experimental purposes.
2361 # \fBzpool create tank /path/to/file/a /path/to/file/b\fR
2367 \fBExample 5 \fRAdding a Mirror to a ZFS Storage Pool
2370 The following command adds two mirrored disks to the pool \fItank\fR, assuming the pool is already made up of two-way mirrors. The additional space is immediately available to any datasets within the pool.
2375 # \fBzpool add tank mirror sda sdb\fR
2381 \fBExample 6 \fRListing Available ZFS Storage Pools
2384 The following command lists all available pools on the system. In this case, the pool \fIzion\fR is faulted due to a missing device.
2388 The results from this command are similar to the following:
2394 NAME SIZE ALLOC FREE FRAG EXPANDSZ CAP DEDUP HEALTH ALTROOT
2395 rpool 19.9G 8.43G 11.4G 33% - 42% 1.00x ONLINE -
2396 tank 61.5G 20.0G 41.5G 48% - 32% 1.00x ONLINE -
2397 zion - - - - - - - FAULTED -
2403 \fBExample 7 \fRDestroying a ZFS Storage Pool
2406 The following command destroys the pool \fItank\fR and any datasets contained within.
2411 # \fBzpool destroy -f tank\fR
2417 \fBExample 8 \fRExporting a ZFS Storage Pool
2420 The following command exports the devices in pool \fItank\fR so that they can be relocated or later imported.
2425 # \fBzpool export tank\fR
2431 \fBExample 9 \fRImporting a ZFS Storage Pool
2434 The following command displays available pools, and then imports the pool \fItank\fR for use on the system.
2438 The results from this command are similar to the following:
2443 # \fBzpool import\fR
2445 id: 15451357997522795478
2447 action: The pool can be imported using its name or numeric identifier.
2455 # \fBzpool import tank\fR
2461 \fBExample 10 \fRUpgrading All ZFS Storage Pools to the Current Version
2464 The following command upgrades all ZFS Storage pools to the current version of the software.
2469 # \fBzpool upgrade -a\fR
2470 This system is currently running ZFS pool version 28.
2476 \fBExample 11 \fRManaging Hot Spares
2479 The following command creates a new pool with an available hot spare:
2484 # \fBzpool create tank mirror sda sdb spare sdc\fR
2491 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:
2496 # \fBzpool replace tank sda sdd\fR
2503 Once the data has been resilvered, the spare is automatically removed and is made available for use should another device fails. The hot spare can be permanently removed from the pool using the following command:
2508 # \fBzpool remove tank sdc\fR
2514 \fBExample 12 \fRCreating a ZFS Pool with Mirrored Separate Intent Logs
2517 The following command creates a ZFS storage pool consisting of two, two-way mirrors and mirrored log devices:
2522 # \fBzpool create pool mirror sda sdb mirror sdc sdd log mirror \e
2529 \fBExample 13 \fRAdding Cache Devices to a ZFS Pool
2532 The following command adds two disks for use as cache devices to a ZFS storage pool:
2537 # \fBzpool add pool cache sdc sdd\fR
2544 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:
2549 # \fBzpool iostat -v pool 5\fR
2555 \fBExample 14 \fRRemoving a Mirrored Log Device
2558 The following command removes the mirrored log device \fBmirror-2\fR.
2562 Given this configuration:
2569 scrub: none requested
2572 NAME STATE READ WRITE CKSUM
2574 mirror-0 ONLINE 0 0 0
2577 mirror-1 ONLINE 0 0 0
2581 mirror-2 ONLINE 0 0 0
2590 The command to remove the mirrored log \fBmirror-2\fR is:
2595 # \fBzpool remove tank mirror-2\fR
2601 \fBExample 15 \fRDisplaying expanded space on a device
2604 The following command displays the detailed information for the \fIdata\fR
2605 pool. This pool is comprised of a single \fIraidz\fR vdev where one of its
2606 devices increased its capacity by 10GB. In this example, the pool will not
2607 be able to utilized this extra capacity until all the devices under the
2608 \fIraidz\fR vdev have been expanded.
2613 # \fBzpool list -v data\fR
2614 NAME SIZE ALLOC FREE FRAG EXPANDSZ CAP DEDUP HEALTH ALTROOT
2615 data 23.9G 14.6G 9.30G 48% - 61% 1.00x ONLINE -
2616 raidz1 23.9G 14.6G 9.30G 48% -
2625 \fBExample 16 \fRRunning commands in zpool status and zpool iostat with -c
2631 # zpool status -c vendor,model,size,enc
2633 NAME STATE READ WRITE CKSUM vendor model size enc
2635 mirror-0 ONLINE 0 0 0
2636 U1 ONLINE 0 0 0 SEAGATE ST8000NM0075 7.3T 0:0:0:0
2637 U10 ONLINE 0 0 0 SEAGATE ST8000NM0075 7.3T 0:0:0:0
2638 U11 ONLINE 0 0 0 SEAGATE ST8000NM0075 7.3T 0:0:0:0
2639 U12 ONLINE 0 0 0 SEAGATE ST8000NM0075 7.3T 0:0:0:0
2640 U13 ONLINE 0 0 0 SEAGATE ST8000NM0075 7.3T 0:0:0:0
2641 U14 ONLINE 0 0 0 SEAGATE ST8000NM0075 7.3T 0:0:0:0
2648 # zpool iostat -vc slaves,locate_led
2649 capacity operations bandwidth
2650 pool alloc free read write read write slaves locate_led
2651 ---------- ----- ----- ----- ----- ----- ----- --------- ----------
2652 tank 20.4G 7.23T 26 152 20.7M 21.6M
2653 mirror 20.4G 7.23T 26 152 20.7M 21.6M
2654 U1 - - 0 31 1.46K 20.6M sdb sdff 0
2655 U10 - - 0 1 3.77K 13.3K sdas sdgw 0
2656 U11 - - 0 1 288K 13.3K sdat sdgx 1
2657 U12 - - 0 1 78.4K 13.3K sdau sdgy 0
2658 U13 - - 0 1 128K 13.3K sdav sdgz 0
2659 U14 - - 0 1 63.2K 13.3K sdfk sdg 0
2666 The following exit values are returned:
2673 Successful completion.
2691 Invalid command line options were specified.
2694 .SH "ENVIRONMENT VARIABLES"
2697 Cause \fBzpool\fR to dump core on exit for the purposes of running \fB::findleaks\fR.
2699 .B "ZPOOL_IMPORT_PATH"
2700 The search path for devices or files to use with the pool. This is a colon-separated list of directories in which \fBzpool\fR looks for device nodes and files.
2701 Similar to the \fB-d\fR option in \fIzpool import\fR.
2703 .B "ZPOOL_VDEV_NAME_GUID"
2704 Cause \fBzpool\fR subcommands to output vdev guids by default. This behavior
2705 is identical to the \fBzpool status -g\fR command line option.
2707 .B "ZPOOL_VDEV_NAME_FOLLOW_LINKS"
2708 Cause \fBzpool\fR subcommands to follow links for vdev names by default. This behavior is identical to the \fBzpool status -L\fR command line option.
2710 .B "ZPOOL_VDEV_NAME_PATH"
2711 Cause \fBzpool\fR subcommands to output full vdev path names by default. This
2712 behavior is identical to the \fBzpool status -p\fR command line option.
2714 .B "ZFS_VDEV_DEVID_OPT_OUT"
2715 Older ZFS on Linux implementations had issues when attempting to display pool
2716 config VDEV names if a "devid" NVP value is present in the pool's config.
2718 For example, a pool that originated on illumos platform would have a devid
2719 value in the config and \fBzpool status\fR would fail when listing the config.
2720 This would also be true for future Linux based pools.
2722 A pool can be stripped of any "devid" values on import or prevented from adding
2723 them on \fBzpool create\fR or \fBzpool add\fR by setting ZFS_VDEV_DEVID_OPT_OUT.
2725 .B "ZPOOL_SCRIPTS_AS_ROOT"
2726 Allow a privilaged user to run the \fBzpool status/iostat\fR with the \fB-c\fR
2727 option. Normally, only unprivilaged users are allowed to run \fB-c\fR.
2729 .B "ZPOOL_SCRIPTS_PATH"
2730 The search path for scripts when running \fBzpool status/iostat\fR with the \fB-c\fR
2731 option. This is a colon-separated list of directories and overrides the default
2732 ~/.zpool.d and /etc/zfs/zpool.d search paths.
2734 .B "ZPOOL_SCRIPTS_ENABLED"
2735 Allow a user to run \fBzpool status/iostat\fR with the \fB-c\fR option. If
2736 ZPOOL_SCRIPTS_ENABLED is not set, it is assumed that the user is allowed to
2737 run \fBzpool status/iostat -c\fR.
2742 \fBzfs\fR(8), \fBzpool-features\fR(5), \fBzfs-events\fR(5), \fBzfs-module-parameters\fR(5)
projects / mirror_zfs.git / blob