2 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
3 .\" Copyright 2011 Nexenta Systems, Inc. All rights reserved.
4 .\" Copyright (c) 2012 by Delphix. All Rights Reserved.
5 .\" Copyright (c) 2012 Cyril Plisko. All Rights Reserved.
6 .\" The contents of this file are subject to the terms of the Common Development
7 .\" and Distribution License (the "License"). You may not use this file except
8 .\" in compliance with the License. You can obtain a copy of the license at
9 .\" usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
11 .\" See the License for the specific language governing permissions and
12 .\" limitations under the License. When distributing Covered Code, include this
13 .\" CDDL HEADER in each file and include the License file at
14 .\" usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this
15 .\" CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your
16 .\" own identifying information:
17 .\" Portions Copyright [yyyy] [name of copyright owner]
18 .TH zpool 8 "14 December 2012" "ZFS pool 28, filesystem 5" "System Administration Commands"
20 zpool \- configures ZFS storage pools
24 \fBzpool\fR [\fB-?\fR]
29 \fBzpool add\fR [\fB-fn\fR] [\fB-o\fR \fIproperty=value\fR] \fIpool\fR \fIvdev\fR ...
34 \fBzpool attach\fR [\fB-f\fR] [\fB-o\fR \fIproperty=value\fR] \fIpool\fR \fIdevice\fR \fInew_device\fR
39 \fBzpool clear\fR \fIpool\fR [\fIdevice\fR]
44 \fBzpool create\fR [\fB-fnd\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-O\fR \fIfile-system-property=value\fR]
45 ... [\fB-m\fR \fImountpoint\fR] [\fB-R\fR \fIroot\fR] \fIpool\fR \fIvdev\fR ...
50 \fBzpool destroy\fR [\fB-f\fR] \fIpool\fR
55 \fBzpool detach\fR \fIpool\fR \fIdevice\fR
60 \fBzpool export\fR [\fB-f\fR] \fIpool\fR ...
65 \fBzpool get\fR "\fIall\fR" | \fIproperty\fR[,...] \fIpool\fR ...
70 \fBzpool history\fR [\fB-il\fR] [\fIpool\fR] ...
75 \fBzpool import\fR [\fB-d\fR \fIdir\fR] [\fB-D\fR]
80 \fBzpool import\fR [\fB-o \fImntopts\fR\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR]
81 [\fB-D\fR] [\fB-f\fR] [\fB-m\fR] [\fB-N\fR] [\fB-R\fR \fIroot\fR] [\fB-F\fR [\fB-n\fR]] \fB-a\fR
86 \fBzpool import\fR [\fB-o \fImntopts\fR\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR]
87 [\fB-D\fR] [\fB-f\fR] [\fB-m\fR] [\fB-R\fR \fIroot\fR] [\fB-F\fR [\fB-n\fR]] \fIpool\fR |\fIid\fR [\fInewpool\fR]
92 \fBzpool iostat\fR [\fB-T\fR d | u ] [\fB-v\fR] [\fIpool\fR] ... [\fIinterval\fR[\fIcount\fR]]
97 \fBzpool labelclear\fR [\fB-f\fR] \fIdevice\fR
102 \fBzpool list\fR [\fB-T\fR d | u ] [\fB-Hv\fR] [\fB-o\fR \fIproperty\fR[,...]] [\fIpool\fR] ...
103 [\fIinterval\fR[\fIcount\fR]]
108 \fBzpool offline\fR [\fB-t\fR] \fIpool\fR \fIdevice\fR ...
113 \fBzpool online\fR \fIpool\fR \fIdevice\fR ...
118 \fBzpool reguid\fR \fIpool\fR
123 \fBzpool reopen\fR \fIpool\fR
128 \fBzpool remove\fR \fIpool\fR \fIdevice\fR ...
133 \fBzpool replace\fR [\fB-f\fR] \fIpool\fR \fIdevice\fR [\fInew_device\fR]
138 \fBzpool scrub\fR [\fB-s\fR] \fIpool\fR ...
143 \fBzpool set\fR \fIproperty\fR=\fIvalue\fR \fIpool\fR
148 \fBzpool split\fR [\fB-n\fR] [\fB-R\fR \fIaltroot\fR] [\fB-o\fR \fIproperty=value\fR] \fIpool\fR \fInewpool\fR
153 \fBzpool status\fR [\fB-xvD\fR] [\fB-T\fR d | u] [\fIpool\fR] ... [\fIinterval\fR [\fIcount\fR]]
163 \fBzpool upgrade\fR \fB-v\fR
168 \fBzpool upgrade\fR [\fB-V\fR \fIversion\fR] \fB-a\fR | \fIpool\fR ...
174 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.
177 All datasets within a storage pool share the same space. See \fBzfs\fR(8) for information on managing datasets.
178 .SS "Virtual Devices (\fBvdev\fRs)"
181 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:
190 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.
201 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.
212 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.
235 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.
237 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.
239 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.
250 A special pseudo-\fBvdev\fR which keeps track of available hot spares for a pool. For more information, see the "Hot Spares" section.
261 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.
272 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.
277 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.
280 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.
283 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:
287 # \fBzpool create mypool mirror sda sdb mirror sdc sdd\fR
292 .SS "Device Failure and Recovery"
295 \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.
298 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.
301 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.
304 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:
313 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.
315 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:
320 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.
326 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.
338 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.
340 One or more component devices is in the faulted state, and insufficient replicas exist to continue functioning. The underlying conditions are as follows:
345 The device could be opened, but the contents did not match expected values.
351 The number of I/O errors exceeds acceptable levels and the device is faulted to prevent further use of the device.
363 The device was explicitly taken offline by the "\fBzpool offline\fR" command.
374 The device is online and functioning.
385 The device was physically removed while the system was running. Device removal detection is hardware-dependent and may not be supported on all platforms.
396 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.
401 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.
405 \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,
409 # zpool create pool mirror sda sdb spare sdc sdd
416 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.
419 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.
422 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.
425 Spares cannot replace log devices.
429 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:
433 \fB# zpool create pool sda sdb log sdc\fR
440 Multiple log devices can also be specified, and they can be mirrored. See the EXAMPLES section for an example of mirroring multiple log devices.
443 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.
447 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.
450 To create a pool with cache devices, specify a "cache" \fBvdev\fR with any number of devices. For example:
454 \fB# zpool create pool sda sdb cache sdc sdd\fR
461 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.
464 The content of the cache devices is considered volatile, as is the case with other system caches.
468 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:
473 \fB\fBavailable\fR\fR
477 Amount of storage available within the pool. This property can also be referred to by its shortened column name, "avail".
488 Percentage of pool space used. This property can also be referred to by its shortened column name, "cap".
495 \fB\fBexpandsize\fR\fR
499 Amount of uninitialized space within the pool or device that can be used to
500 increase the total capacity of the pool. Uninitialized space consists of
501 any space on an EFI labeled vdev which has not been brought online
502 (i.e. zpool online -e). This space occurs when a LUN is dynamically expanded.
513 The amount of free space available in the pool.
524 After a file system or snapshot is destroyed, the space it was using is
525 returned to the pool asynchronously. \fB\fBfreeing\fR\fR is the amount of
526 space remaining to be reclaimed. Over time \fB\fBfreeing\fR\fR will decrease
527 while \fB\fBfree\fR\fR increases.
538 The current health of the pool. Health can be "\fBONLINE\fR", "\fBDEGRADED\fR", "\fBFAULTED\fR", " \fBOFFLINE\fR", "\fBREMOVED\fR", or "\fBUNAVAIL\fR".
549 A unique identifier for the pool.
560 Total size of the storage pool.
567 \fB\fBunsupported@\fR\fIfeature_guid\fR\fR
571 Information about unsupported features that are enabled on the pool. See
572 \fBzpool-features\fR(5) for details.
583 Amount of storage space used within the pool.
588 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.
592 The following property can be set at creation time:
601 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).
603 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.
608 The following property can be set at creation time and import time:
617 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.
622 The following properties can be set at creation time and import time, and later changed with the \fBzpool set\fR command:
627 \fB\fBautoexpand\fR=\fBon\fR | \fBoff\fR\fR
631 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.
638 \fB\fBautoreplace\fR=\fBon\fR | \fBoff\fR\fR
642 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".
649 \fB\fBbootfs\fR=\fIpool\fR/\fIdataset\fR\fR
653 Identifies the default bootable dataset for the root pool. This property is expected to be set mainly by the installation and upgrade programs.
660 \fB\fBcachefile\fR=\fIpath\fR | \fBnone\fR\fR
664 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.
666 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.
673 \fB\fBcomment\fR=\fB\fItext\fR\fR
677 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.
684 \fB\fBdelegation\fR=\fBon\fR | \fBoff\fR\fR
688 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.
695 \fB\fBfailmode\fR=\fBwait\fR | \fBcontinue\fR | \fBpanic\fR\fR
699 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:
708 Blocks all \fBI/O\fR access until the device connectivity is recovered and the errors are cleared. This is the default behavior.
719 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.
730 Prints out a message to the console and generates a system crash dump.
738 \fB\fBfeature@\fR\fIfeature_name\fR=\fBenabled\fR\fR
741 The value of this property is the current state of \fIfeature_name\fR. The
742 only valid value when setting this property is \fBenabled\fR which moves
743 \fIfeature_name\fR to the enabled state. See \fBzpool-features\fR(5) for
744 details on feature states.
751 \fB\fBlistsnaps\fR=on | off\fR
755 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".
762 \fB\fBversion\fR=\fIversion\fR\fR
766 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.
772 All subcommands that modify state are logged persistently to the pool in their original form.
775 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:
780 \fB\fBzpool\fR \fB-?\fR\fR
784 Displays a help message.
791 \fB\fBzpool add\fR [\fB-fn\fR] [\fB-o\fR \fIproperty=value\fR] \fIpool\fR \fIvdev\fR ...\fR
795 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.
804 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.
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.
822 \fB\fB-o\fR \fIproperty=value\fR
826 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 "ashift".
829 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.
836 \fB\fBzpool attach\fR [\fB-f\fR] [\fB-o\fR \fIproperty=value\fR] \fIpool\fR \fIdevice\fR \fInew_device\fR\fR
840 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.
849 Forces use of \fInew_device\fR, even if its appears to be in use. Not all devices can be overridden in this manner.
856 \fB\fB-o\fR \fIproperty=value\fR
860 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 "ashift".
869 \fB\fBzpool clear\fR \fIpool\fR [\fIdevice\fR] ...\fR
873 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.
880 \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] \fIpool\fR \fIvdev\fR ...\fR
884 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.
886 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.
888 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.
890 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.
892 By default all supported features are enabled on the new pool unless the \fB-d\fR option is specified.
901 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.
923 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.
929 \fB\fB-o\fR \fIproperty=value\fR [\fB-o\fR \fIproperty=value\fR] ...\fR
933 Sets the given pool properties. See the "Properties" section for a list of valid properties that can be set.
940 \fB\fB-O\fR \fIfile-system-property=value\fR\fR
944 \fB[\fB-O\fR \fIfile-system-property=value\fR] ...\fR
948 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.
955 \fB\fB-R\fR \fIroot\fR\fR
959 Equivalent to "-o cachefile=none,altroot=\fIroot\fR"
966 \fB\fB-m\fR \fImountpoint\fR\fR
970 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).
979 \fB\fBzpool destroy\fR [\fB-f\fR] \fIpool\fR\fR
983 Destroys the given pool, freeing up any devices for other use. This command tries to unmount any active datasets before destroying the pool.
992 Forces any active datasets contained within the pool to be unmounted.
1001 \fB\fBzpool detach\fR \fIpool\fR \fIdevice\fR\fR
1005 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.
1012 \fB\fBzpool export\fR [\fB-f\fR] \fIpool\fR ...\fR
1016 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.
1018 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.
1020 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.
1029 Forcefully unmount all datasets, using the "\fBunmount -f\fR" command.
1031 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.
1040 \fB\fBzpool get\fR "\fIall\fR" | \fIproperty\fR[,...] \fIpool\fR ...\fR
1044 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:
1048 name Name of storage pool
1049 property Property name
1050 value Property value
1051 source Property source, either 'default' or 'local'.
1056 See the "Properties" section for more information on the available pool properties.
1063 \fB\fBzpool history\fR [\fB-il\fR] [\fIpool\fR] ...\fR
1067 Displays the command history of the specified pools or all pools if no pool is specified.
1076 Displays internally logged \fBZFS\fR events in addition to user initiated events.
1087 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.
1096 \fB\fBzpool import\fR [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR] [\fB-D\fR]\fR
1100 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.
1102 The numeric identifier is unique, and can be used instead of the pool name when multiple exported pools of the same name are available.
1107 \fB\fB-c\fR \fIcachefile\fR\fR
1111 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.
1118 \fB\fB-d\fR \fIdir\fR\fR
1122 Searches for devices or files in \fIdir\fR. The \fB-d\fR option can be specified multiple times.
1133 Lists destroyed pools only.
1142 \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-a\fR\fR
1146 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.
1151 \fB\fB-o\fR \fImntopts\fR\fR
1155 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.
1162 \fB\fB-o\fR \fIproperty=value\fR\fR
1166 Sets the specified property on the imported pool. See the "Properties" section for more information on the available pool properties.
1173 \fB\fB-c\fR \fIcachefile\fR\fR
1177 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.
1184 \fB\fB-d\fR \fIdir\fR\fR
1188 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.
1199 Imports destroyed pools only. The \fB-f\fR option is also required.
1210 Forces import, even if the pool appears to be potentially active.
1220 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.
1231 Searches for and imports all pools found.
1241 Allows a pool to import when there is a missing log device.
1248 \fB\fB-R\fR \fIroot\fR\fR
1252 Sets the "\fBcachefile\fR" property to "\fBnone\fR" and the "\fIaltroot\fR" property to "\fIroot\fR".
1262 Import the pool without mounting any file systems.
1272 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.
1281 \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]] \fIpool\fR | \fIid\fR [\fInewpool\fR]\fR
1285 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.
1287 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.
1292 \fB\fB-o\fR \fImntopts\fR\fR
1296 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.
1303 \fB\fB-o\fR \fIproperty=value\fR\fR
1307 Sets the specified property on the imported pool. See the "Properties" section for more information on the available pool properties.
1314 \fB\fB-c\fR \fIcachefile\fR\fR
1318 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.
1325 \fB\fB-d\fR \fIdir\fR\fR
1329 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.
1340 Imports destroyed pool. The \fB-f\fR option is also required.
1351 Forces import, even if the pool appears to be potentially active.
1362 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.
1369 \fB\fB-R\fR \fIroot\fR\fR
1373 Sets the "\fBcachefile\fR" property to "\fBnone\fR" and the "\fIaltroot\fR" property to "\fIroot\fR".
1384 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.
1395 Allows a pool to import when there is a missing log device.
1404 \fB\fBzpool iostat\fR [\fB-T\fR \fBd\fR | \fBu\fR] [\fB-v\fR] [\fIpool\fR] ... [\fIinterval\fR[\fIcount\fR]]\fR
1408 Displays \fBI/O\fR statistics for the given pools. When given an interval, the statistics are printed every \fIinterval\fR seconds until \fBCtrl-C\fR is pressed. If no \fIpools\fR are specified, statistics for every pool in the system is shown. If \fIcount\fR is specified, the command exits after \fIcount\fR reports are printed.
1413 \fB\fB-T\fR \fBu\fR | \fBd\fR\fR
1417 Display a time stamp.
1419 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).
1430 Verbose statistics. Reports usage statistics for individual \fIvdevs\fR within the pool, in addition to the pool-wide statistics.
1439 \fB\fBzpool labelclear\fR [\fB-f\fR] \fIdevice\fR
1443 Removes ZFS label information from the specified device. The device must not be part of an active pool configuration.
1452 Treat exported or foreign devices as inactive.
1461 \fB\fBzpool list\fR [\fB-T\fR \fBd\fR | \fBu\fR] [\fB-Hv\fR] [\fB-o\fR \fIprops\fR[,...]] [\fIpool\fR] ... [\fIinterval\fR[\fIcount\fR]]\fR
1465 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.
1474 Scripted mode. Do not display headers, and separate fields by a single tab instead of arbitrary space.
1480 \fB\fB-T\fR \fBd\fR | \fBu\fR\fR
1484 Display a time stamp.
1486 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).
1493 \fB\fB-o\fR \fIprops\fR\fR
1497 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, expandsize, capacity, dedupratio, health, altroot"
1508 Verbose statistics. Reports usage statistics for individual \fIvdevs\fR within the pool, in addition to the pool-wise statistics.
1517 \fB\fBzpool offline\fR [\fB-t\fR] \fIpool\fR \fIdevice\fR ...\fR
1521 Takes the specified physical device offline. While the \fIdevice\fR is offline, no attempt is made to read or write to the device.
1523 This command is not applicable to spares or cache devices.
1532 Temporary. Upon reboot, the specified physical device reverts to its previous state.
1541 \fB\fBzpool online\fR [\fB-e\fR] \fIpool\fR \fIdevice\fR...\fR
1545 Brings the specified physical device online.
1547 This command is not applicable to spares or cache devices.
1556 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.
1565 \fB\fBzpool reguid\fR \fIpool\fR
1569 Generates a new unique identifier for the pool. You must ensure that all
1570 devices in this pool are online and healthy before performing this action.
1576 \fB\fBzpool reopen\fR \fIpool\fR
1580 Reopen all the vdevs associated with the pool.
1586 \fB\fBzpool remove\fR \fIpool\fR \fIdevice\fR ...\fR
1590 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.
1597 \fB\fBzpool replace\fR [\fB-f\fR] \fIpool\fR \fIold_device\fR [\fInew_device\fR]\fR
1601 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.
1603 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.
1605 \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.
1614 Forces use of \fInew_device\fR, even if its appears to be in use. Not all devices can be overridden in this manner.
1623 \fB\fBzpool scrub\fR [\fB-s\fR] \fIpool\fR ...\fR
1627 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.
1629 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.
1631 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.
1649 \fB\fBzpool set\fR \fIproperty\fR=\fIvalue\fR \fIpool\fR\fR
1653 Sets the given property on the specified pool. See the "Properties" section for more information on what properties can be set and acceptable values.
1660 \fBzpool split\fR [\fB-n\fR] [\fB-R\fR \fIaltroot\fR] [\fB-o\fR \fIproperty=value\fR] \fIpool\fR \fInewpool\fR
1664 Split devices off \fIpool\fR creating \fInewpool\fR. All \fBvdev\fRs in \fIpool\fR must be mirrors. At the time of the split, \fInewpool\fR will be a replica of \fIpool\fR.
1674 Do dry run, do not actually perform the split. Print out the expected configuration of \fInewpool\fR.
1681 \fB\fB-R\fR \fIaltroot\fR \fR
1685 Set \fIaltroot\fR for \fInewpool\fR and automaticaly import it. This can be useful to avoid mountpoint collisions if \fInewpool\fR is imported on the same filesystem as \fIpool\fR.
1692 \fB\fB-o\fR \fIproperty=value\fR \fR
1696 Sets the specified property for \fInewpool\fR. See the “Properties” section for more information on the available pool properties.
1705 \fBzpool status\fR [\fB-xvD\fR] [\fB-T\fR d | u] [\fIpool\fR] ... [\fIinterval\fR [\fIcount\fR]]
1709 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.
1711 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.
1720 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.
1731 Displays verbose data error information, printing out a complete list of all data errors since the last complete pool scrub.
1742 Display a histogram of deduplication statistics, showing the allocated (physically present on disk) and
1743 referenced (logically referenced in the pool) block counts and sizes by reference count.
1750 \fB\fB-T\fR \fBd\fR | \fBu\fR\fR
1754 Display a time stamp.
1756 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).
1763 \fB\fBzpool upgrade\fR\fR
1767 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.
1774 \fB\fBzpool upgrade\fR \fB-v\fR\fR
1778 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.
1785 \fB\fBzpool upgrade\fR [\fB-V\fR \fIversion\fR] \fB-a\fR | \fIpool\fR ...\fR
1789 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 compatability with systems that support feature flags, but do not support all features enabled on the pool.
1798 Enables all supported features on all pools.
1805 \fB\fB-V\fR \fIversion\fR\fR
1809 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.
1816 \fBExample 1 \fRCreating a RAID-Z Storage Pool
1819 The following command creates a pool with a single \fBraidz\fR root \fIvdev\fR that consists of six disks.
1824 # \fBzpool create tank raidz sda sdb sdc sdd sde sdf\fR
1830 \fBExample 2 \fRCreating a Mirrored Storage Pool
1833 The following command creates a pool with two mirrors, where each mirror contains two disks.
1838 # \fBzpool create tank mirror sda sdb mirror sdc sdd\fR
1844 \fBExample 3 \fRCreating a ZFS Storage Pool by Using Partitions
1847 The following command creates an unmirrored pool using two disk partitions.
1852 # \fBzpool create tank sda1 sdb2\fR
1858 \fBExample 4 \fRCreating a ZFS Storage Pool by Using Files
1861 The following command creates an unmirrored pool using files. While not recommended, a pool based on files can be useful for experimental purposes.
1866 # \fBzpool create tank /path/to/file/a /path/to/file/b\fR
1872 \fBExample 5 \fRAdding a Mirror to a ZFS Storage Pool
1875 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.
1880 # \fBzpool add tank mirror sda sdb\fR
1886 \fBExample 6 \fRListing Available ZFS Storage Pools
1889 The following command lists all available pools on the system. In this case, the pool \fIzion\fR is faulted due to a missing device.
1893 The results from this command are similar to the following:
1899 NAME SIZE ALLOC FREE EXPANDSZ CAP DEDUP HEALTH ALTROOT
1900 rpool 19.9G 8.43G 11.4G - 42% 1.00x ONLINE -
1901 tank 61.5G 20.0G 41.5G - 32% 1.00x ONLINE -
1902 zion - - - - - - FAULTED -
1908 \fBExample 7 \fRDestroying a ZFS Storage Pool
1911 The following command destroys the pool \fItank\fR and any datasets contained within.
1916 # \fBzpool destroy -f tank\fR
1922 \fBExample 8 \fRExporting a ZFS Storage Pool
1925 The following command exports the devices in pool \fItank\fR so that they can be relocated or later imported.
1930 # \fBzpool export tank\fR
1936 \fBExample 9 \fRImporting a ZFS Storage Pool
1939 The following command displays available pools, and then imports the pool \fItank\fR for use on the system.
1943 The results from this command are similar to the following:
1948 # \fBzpool import\fR
1950 id: 15451357997522795478
1952 action: The pool can be imported using its name or numeric identifier.
1960 # \fBzpool import tank\fR
1966 \fBExample 10 \fRUpgrading All ZFS Storage Pools to the Current Version
1969 The following command upgrades all ZFS Storage pools to the current version of the software.
1974 # \fBzpool upgrade -a\fR
1975 This system is currently running ZFS pool version 28.
1981 \fBExample 11 \fRManaging Hot Spares
1984 The following command creates a new pool with an available hot spare:
1989 # \fBzpool create tank mirror sda sdb spare sdc\fR
1996 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:
2001 # \fBzpool replace tank sda sdd\fR
2008 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:
2013 # \fBzpool remove tank sdc\fR
2019 \fBExample 12 \fRCreating a ZFS Pool with Mirrored Separate Intent Logs
2022 The following command creates a ZFS storage pool consisting of two, two-way mirrors and mirrored log devices:
2027 # \fBzpool create pool mirror sda sdb mirror sdc sdd log mirror \e
2034 \fBExample 13 \fRAdding Cache Devices to a ZFS Pool
2037 The following command adds two disks for use as cache devices to a ZFS storage pool:
2042 # \fBzpool add pool cache sdc sdd\fR
2049 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:
2054 # \fBzpool iostat -v pool 5\fR
2060 \fBExample 14 \fRRemoving a Mirrored Log Device
2063 The following command removes the mirrored log device \fBmirror-2\fR.
2067 Given this configuration:
2074 scrub: none requested
2077 NAME STATE READ WRITE CKSUM
2079 mirror-0 ONLINE 0 0 0
2082 mirror-1 ONLINE 0 0 0
2086 mirror-2 ONLINE 0 0 0
2095 The command to remove the mirrored log \fBmirror-2\fR is:
2100 # \fBzpool remove tank mirror-2\fR
2106 \fBExample 15 \fRDisplaying expanded space on a device
2109 The following command dipslays the detailed information for the \fIdata\fR
2110 pool. This pool is comprised of a single \fIraidz\fR vdev where one of its
2111 devices increased its capacity by 1GB. In this example, the pool will not
2112 be able to utilized this extra capacity until all the devices under the
2113 \fIraidz\fR vdev have been expanded.
2118 # \fBzpool list -v data\fR
2119 NAME SIZE ALLOC FREE EXPANDSZ CAP DEDUP HEALTH ALTROOT
2120 data 17.9G 174K 17.9G - 0% 1.00x ONLINE -
2121 raidz1 17.9G 174K 17.9G -
2131 The following exit values are returned:
2140 Successful completion.
2162 Invalid command line options were specified.
2168 \fBzfs\fR(8), \fBzpool-features\fR(5)
projects / mirror_zfs.git / blob