2 .\" Copyright (c) 2012, Martin Matuska <mm@FreeBSD.org>.
3 .\" Copyright (c) 2013-2014, Xin Li <delphij@FreeBSD.org>.
4 .\" All Rights Reserved.
6 .\" The contents of this file are subject to the terms of the
7 .\" Common Development and Distribution License (the "License").
8 .\" You may not use this file except in compliance with the License.
10 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
11 .\" or http://www.opensolaris.org/os/licensing.
12 .\" See the License for the specific language governing permissions
13 .\" and limitations under the License.
15 .\" When distributing Covered Code, include this CDDL HEADER in each
16 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
17 .\" If applicable, add the following below this CDDL HEADER, with the
18 .\" fields enclosed by brackets "[]" replaced with your own identifying
19 .\" information: Portions Copyright [yyyy] [name of copyright owner]
21 .\" Copyright (c) 2010, Sun Microsystems, Inc. All Rights Reserved.
22 .\" Copyright (c) 2011, Justin T. Gibbs <gibbs@FreeBSD.org>
23 .\" Copyright (c) 2012, Glen Barber <gjb@FreeBSD.org>
24 .\" Copyright (c) 2012, 2017 by Delphix. All Rights Reserved.
25 .\" Copyright 2017 Nexenta Systems, Inc.
26 .\" Copyright (c) 2017 Datto Inc.
35 .Nd configures ZFS storage pools
46 .Ar pool device new_device
59 .Op Fl o Ar property Ns = Ns Ar value
61 .Op Fl O Ar file-system-property Ns = Ns Ar value
63 .Op Fl m Ar mountpoint
81 .Op Fl o Ar field Ns Op , Ns Ar ...
82 .Ar all | property Ns Op , Ns Ar ...
91 .Op Fl d Ar dir | Fl c Ar cachefile
96 .Op Fl o Ar property Ns = Ns Ar value
98 .Op Fl -rewind-to-checkpoint
99 .Op Fl d Ar dir | Fl c Ar cachefile
110 .Op Fl o Ar property Ns = Ns Ar value
112 .Op Fl -rewind-to-checkpoint
113 .Op Fl d Ar dir | Fl c Ar cachefile
130 .Op Fl T Cm d Ns | Ns Cm u
141 .Op Fl o Ar property Ns Op , Ns Ar ...
142 .Op Fl T Cm d Ns | Ns Cm u
145 .Op Ar inverval Op Ar count
179 .Ar property Ns = Ns Ar value pool
185 .Op Fl o Ar property Ns = Ns Ar value
191 .Op Fl T Cm d Ns | Ns Cm u
194 .Op Ar interval Op Ar count
197 .Oo Ar pool Oc Ns ...
210 storage pools. A storage pool is a collection of devices that provides physical
211 storage and data replication for
215 All datasets within a storage pool share the same space. See
217 for information on managing datasets.
218 .Ss Virtual Devices (vdevs)
222 describes a single device or a collection of devices organized according to
223 certain performance and fault characteristics. The following virtual devices
225 .Bl -tag -width "XXXXXX"
227 A block device, typically located under
230 can use individual slices or partitions, though the recommended mode of
231 operation is to use whole disks. A disk can be specified by a full path to the
234 provider name. When given a whole disk,
236 automatically labels the disk, if necessary.
238 A regular file. The use of files as a backing store is strongly discouraged. It
239 is designed primarily for experimental purposes, as the fault tolerance of a
240 file is only as good the file system of which it is a part. A file must be
241 specified by a full path.
243 A mirror of two or more devices. Data is replicated in an identical fashion
244 across all components of a mirror. A mirror with
250 bytes and can withstand
252 devices failing before data integrity is compromised.
255 .Sy raidz1 raidz2 raidz3 ) .
258 that allows for better distribution of parity and eliminates the
260 write hole (in which data and parity become inconsistent after a power loss).
261 Data and parity is striped across all disks within a
267 group can have single-, double- , or triple parity, meaning that the
269 group can sustain one, two, or three failures, respectively, without
272 type specifies a single-parity
276 type specifies a double-parity
280 type specifies a triple-parity
295 parity disks can hold approximately
300 bytes and can withstand
302 device(s) failing before data integrity is compromised. The minimum number of
305 group is one more than the number of parity disks. The
306 recommended number is between 3 and 9 to help increase performance.
309 .No pseudo- Ns No vdev
310 which keeps track of available hot spares for a pool.
311 For more information, see the
315 A separate-intent log device. If more than one log device is specified, then
316 writes are load-balanced between devices. Log devices can be mirrored. However,
319 types are not supported for the intent log. For more information,
324 A device used to cache storage pool data. A cache device cannot be configured
327 group. For more information, see the
332 Virtual devices cannot be nested, so a mirror or
334 virtual device can only
335 contain files or disks. Mirrors of mirrors (or other combinations) are not
338 A pool can have any number of virtual devices at the top of the configuration
342 Data is dynamically distributed across all top-level devices to balance data
343 among devices. As new virtual devices are added,
345 automatically places data on the newly available devices.
347 Virtual devices are specified one at a time on the command line, separated by
348 whitespace. The keywords
352 are used to distinguish where a group ends and another begins. For example, the
353 following creates two root
355 each a mirror of two disks:
356 .Bd -literal -offset 2n
357 .Li # Ic zpool create mypool mirror da0 da1 mirror da2 da3
359 .Ss Device Failure and Recovery
361 supports a rich set of mechanisms for handling device failure and data
362 corruption. All metadata and data is checksummed, and
364 automatically repairs bad data from a good copy when corruption is detected.
366 In order to take advantage of these features, a pool must make use of some form
367 of redundancy, using either mirrored or
371 supports running in a non-redundant configuration, where each root
373 is simply a disk or file, this is strongly discouraged. A single case of bit
374 corruption can render some or all of your data unavailable.
376 A pool's health status is described by one of three states: online, degraded,
377 or faulted. An online pool has all devices operating normally. A degraded pool
378 is one in which one or more devices have failed, but the data is still
379 available due to a redundant configuration. A faulted pool has corrupted
380 metadata, or one or more faulted devices, and insufficient replicas to continue
383 The health of the top-level
388 potentially impacted by the state of its associated
390 or component devices. A top-level
392 or component device is in one of the following states:
393 .Bl -tag -width "DEGRADED"
395 One or more top-level
397 is in the degraded state because one or more
398 component devices are offline. Sufficient replicas exist to continue
401 One or more component devices is in the degraded or faulted state, but
402 sufficient replicas exist to continue functioning. The underlying conditions
404 .Bl -bullet -offset 2n
406 The number of checksum errors exceeds acceptable levels and the device is
407 degraded as an indication that something may be wrong.
409 continues to use the device as necessary.
413 errors exceeds acceptable levels. The device could not be
414 marked as faulted because there are insufficient replicas to continue
418 One or more top-level
420 is in the faulted state because one or more
421 component devices are offline. Insufficient replicas exist to continue
424 One or more component devices is in the faulted state, and insufficient
425 replicas exist to continue functioning. The underlying conditions are as
427 .Bl -bullet -offset 2n
429 The device could be opened, but the contents did not match expected values.
433 errors exceeds acceptable levels and the device is faulted to
434 prevent further use of the device.
437 The device was explicitly taken offline by the
441 The device is online and functioning.
443 The device was physically removed while the system was running. Device removal
444 detection is hardware-dependent and may not be supported on all platforms.
446 The device could not be opened. If a pool is imported when a device was
447 unavailable, then the device will be identified by a unique identifier instead
448 of its path since the path was never correct in the first place.
451 If a device is removed and later reattached to the system,
453 attempts to put the device online automatically. Device attach detection is
454 hardware-dependent and might not be supported on all platforms.
457 allows devices to be associated with pools as
459 These devices are not actively used in the pool, but when an active device
460 fails, it is automatically replaced by a hot spare. To create a pool with hot
464 with any number of devices. For example,
465 .Bd -literal -offset 2n
466 .Li # Ic zpool create pool mirror da0 da1 spare da2 da3
469 Spares can be shared across multiple pools, and can be added with the
471 command and removed with the
473 command. Once a spare replacement is initiated, a new "spare"
476 within the configuration that will remain there until the original device is
477 replaced. At this point, the hot spare becomes available again if another
480 If a pool has a shared spare that is currently being used, the pool can not be
481 exported since other pools may use this shared spare, which may lead to
482 potential data corruption.
484 Shared spares add some risk.
485 If the pools are imported on different hosts, and both pools suffer a device
486 failure at the same time, both could attempt to use the spare at the same time.
487 This may not be detected, resulting in data corruption.
489 An in-progress spare replacement can be cancelled by detaching the hot spare.
490 If the original faulted device is detached, then the hot spare assumes its
491 place in the configuration, and is removed from the spare list of all active
494 Spares cannot replace log devices.
496 This feature requires a userland helper.
500 It must be manually enabled by adding
501 .Va zfsd_enable="YES"
511 requirements for synchronous transactions. For instance, databases often
512 require their transactions to be on stable storage devices when returning from
515 and other applications can also use
517 to ensure data stability. By default, the intent log is allocated from blocks
518 within the main pool. However, it might be possible to get better performance
519 using separate intent log devices such as
521 or a dedicated disk. For example:
522 .Bd -literal -offset 2n
523 .Li # Ic zpool create pool da0 da1 log da2
526 Multiple log devices can also be specified, and they can be mirrored. See the
528 section for an example of mirroring multiple log devices.
530 Log devices can be added, replaced, attached, detached, imported and exported
531 as part of the larger pool.
532 Mirrored devices can be removed by specifying the top-level mirror vdev.
534 Devices can be added to a storage pool as "cache devices." These devices
535 provide an additional layer of caching between main memory and disk. For
536 read-heavy workloads, where the working set size is much larger than what can
537 be cached in main memory, using cache devices allow much more of this working
538 set to be served from low latency media. Using cache devices provides the
539 greatest performance improvement for random read-workloads of mostly static
542 To create a pool with cache devices, specify a "cache"
544 with any number of devices. For example:
545 .Bd -literal -offset 2n
546 .Li # Ic zpool create pool da0 da1 cache da2 da3
549 Cache devices cannot be mirrored or part of a
551 configuration. If a read
552 error is encountered on a cache device, that read
554 is reissued to the original storage pool device, which might be part of a
559 The content of the cache devices is considered volatile, as is the case with
562 Before starting critical procedures that include destructive actions (e.g
564 ), an administrator can checkpoint the pool's state and in the case of a
565 mistake or failure, rewind the entire pool back to the checkpoint.
566 Otherwise, the checkpoint can be discarded when the procedure has completed
569 A pool checkpoint can be thought of as a pool-wide snapshot and should be used
570 with care as it contains every part of the pool's state, from properties to vdev
572 Thus, while a pool has a checkpoint certain operations are not allowed.
573 Specifically, vdev removal/attach/detach, mirror splitting, and
574 changing the pool's guid.
575 Adding a new vdev is supported but in the case of a rewind it will have to be
577 Finally, users of this feature should keep in mind that scrubs in a pool that
578 has a checkpoint do not repair checkpointed data.
580 To create a checkpoint for a pool:
582 # zpool checkpoint pool
585 To later rewind to its checkpointed state, you need to first export it and
586 then rewind it during import:
589 # zpool import --rewind-to-checkpoint pool
592 To discard the checkpoint from a pool:
594 # zpool checkpoint -d pool
597 Dataset reservations (controlled by the
601 zfs properties) may be unenforceable while a checkpoint exists, because the
602 checkpoint is allowed to consume the dataset's reservation.
603 Finally, data that is part of the checkpoint but has been freed in the
604 current state of the pool won't be scanned during a scrub.
606 Each pool has several properties associated with it. Some properties are
607 read-only statistics while others are configurable and change the behavior of
608 the pool. The following are read-only properties:
609 .Bl -tag -width "dedupratio"
611 Amount of storage space used within the pool.
613 Percentage of pool space used. This property can also be referred to by its
614 shortened column name, "cap".
616 The deduplication ratio specified for a pool, expressed as a multiplier.
619 value of 1.76 indicates that 1.76 units of data were stored but only 1 unit of disk space was actually consumed. See
621 for a description of the deduplication feature.
623 Amount of uninitialized space within the pool or device that can be used to
624 increase the total capacity of the pool.
625 Uninitialized space consists of
626 any space on an EFI labeled vdev which has not been brought online
627 .Pq i.e. zpool online -e .
628 This space occurs when a LUN is dynamically expanded.
630 The amount of fragmentation in the pool.
632 Number of blocks within the pool that are not allocated.
634 After a file system or snapshot is destroyed, the space it was using is
635 returned to the pool asynchronously.
637 is the amount of space remaining to be reclaimed.
644 A unique identifier for the pool.
646 The current health of the pool. Health can be
655 Total size of the storage pool.
656 .It Sy unsupported@ Ns Ar feature_guid
657 Information about unsupported features that are enabled on the pool.
663 The space usage properties report actual physical space available to the
664 storage pool. The physical space can be different from the total amount of
665 space that any contained datasets can actually use. The amount of space used in
668 configuration depends on the characteristics of the data being written.
671 reserves some space for internal accounting that the
673 command takes into account, but the
675 command does not. For non-full pools of a reasonable size, these effects should
676 be invisible. For small pools, or pools that are close to being completely
677 full, these discrepancies may become more noticeable.
679 The following property can be set at creation time and import time:
682 Alternate root directory. If set, this directory is prepended to any mount
683 points within the pool. This can be used when examining an unknown pool where
684 the mount points cannot be trusted, or in an alternate boot environment, where
685 the typical paths are not valid.
687 is not a persistent property. It is valid only while the system is up.
692 though this may be overridden using an explicit setting.
695 The following property can only be set at import time:
697 .It Sy readonly Ns = Ns Cm on No | Cm off
700 pool will be imported in read-only mode with the following restrictions:
701 .Bl -bullet -offset 2n
703 Synchronous data in the intent log will not be accessible
705 Properties of the pool can not be changed
707 Datasets of this pool can only be mounted read-only
709 To write to a read-only pool, a export and import of the pool is required.
712 This property can also be referred to by its shortened column name,
716 The following properties can be set at creation time and import time, and later
721 .It Sy autoexpand Ns = Ns Cm on No | Cm off
722 Controls automatic pool expansion when the underlying LUN is grown. If set to
724 the pool will be resized according to the size of the expanded
725 device. If the device is part of a mirror or
727 then all devices within that
728 .No mirror/ Ns No raidz
729 group must be expanded before the new space is made available to
730 the pool. The default behavior is
732 This property can also be referred to by its shortened column name,
734 .It Sy autoreplace Ns = Ns Cm on No | Cm off
735 Controls automatic device replacement. If set to
737 device replacement must be initiated by the administrator by using the
741 any new device, found in the same
742 physical location as a device that previously belonged to the pool, is
743 automatically formatted and replaced. The default behavior is
745 This property can also be referred to by its shortened column name, "replace".
746 .It Sy bootfs Ns = Ns Ar pool Ns / Ns Ar dataset
747 Identifies the default bootable dataset for the root pool. This property is
748 expected to be set mainly by the installation and upgrade programs.
749 .It Sy cachefile Ns = Ns Ar path No | Cm none
750 Controls the location of where the pool configuration is cached. Discovering
751 all pools on system startup requires a cached copy of the configuration data
752 that is stored on the root file system. All pools in this cache are
753 automatically imported when the system boots. Some environments, such as
754 install and clustering, need to cache this information in a different location
755 so that pools are not automatically imported. Setting this property caches the
756 pool configuration in a different location that can later be imported with
757 .Qq Nm Cm import Fl c .
758 Setting it to the special value
760 creates a temporary pool that is never cached, and the special value
762 (empty string) uses the default location.
763 .It Sy comment Ns = Ns Ar text
764 A text string consisting of printable ASCII characters that will be stored
765 such that it is available even if the pool becomes faulted.
766 An administrator can provide additional information about a pool using this
768 .It Sy dedupditto Ns = Ns Ar number
769 Threshold for the number of block ditto copies. If the reference count for a
770 deduplicated block increases above this number, a new ditto copy of this block
771 is automatically stored. Default setting is
773 which causes no ditto copies to be created for deduplicated blocks.
774 The miniumum legal nonzero setting is 100.
775 .It Sy delegation Ns = Ns Cm on No | Cm off
776 Controls whether a non-privileged user is granted access based on the dataset
777 permissions defined on the dataset. See
779 for more information on
781 delegated administration.
782 .It Sy failmode Ns = Ns Cm wait No | Cm continue No | Cm panic
783 Controls the system behavior in the event of catastrophic pool failure. This
784 condition is typically a result of a loss of connectivity to the underlying
785 storage device(s) or a failure of all devices within the pool. The behavior of
786 such an event is determined as follows:
787 .Bl -tag -width indent
791 access until the device connectivity is recovered and the errors are cleared.
792 This is the default behavior.
798 requests but allows reads to any of the remaining healthy devices. Any write
799 requests that have yet to be committed to disk would be blocked.
801 Prints out a message to the console and generates a system crash dump.
803 .It Sy feature@ Ns Ar feature_name Ns = Ns Sy enabled
804 The value of this property is the current state of
806 The only valid value when setting this property is
810 to the enabled state.
813 for details on feature states.
814 .It Sy listsnapshots Ns = Ns Cm on No | Cm off
815 Controls whether information about snapshots associated with this pool is
820 option. The default value is
822 This property can also be referred to by its shortened name,
824 .It Sy multihost Ns = Ns Sy on No | Sy off
825 Controls whether a pool activity check should be performed during
826 .Nm zpool Cm import .
827 When a pool is determined to be active it cannot be imported, even with the
830 This property is intended to be used in failover configurations
831 where multiple hosts have access to a pool on shared storage.
833 Multihost provides protection on import only.
834 It does not protect against an
835 individual device being used in multiple pools, regardless of the type of vdev.
836 See the discussion under
839 When this property is on, periodic writes to storage occur to show the pool is
842 .Sy vfs.zfs.multihost_interval
844 In order to enable this property each host must set a unique hostid.
847 .It Sy version Ns = Ns Ar version
848 The current on-disk version of the pool. This can be increased, but never
849 decreased. The preferred method of updating pools is with the
851 command, though this property can be used when a specific version is needed
852 for backwards compatibility.
853 Once feature flags is enabled on a pool this property will no longer have a
857 All subcommands that modify state are logged persistently to the pool in their
862 command provides subcommands to create and destroy storage pools, add capacity
863 to storage pools, and provide information about the storage pools. The following
864 subcommands are supported:
871 Displays a help message.
879 Adds the specified virtual devices to the given pool. The
881 specification is described in the
882 .Qq Sx Virtual Devices
883 section. The behavior of the
885 option, and the device checks performed are described in the
888 .Bl -tag -width indent
892 even if they appear in use or specify a conflicting replication level.
893 Not all devices can be overridden in this manner.
895 Displays the configuration that would be used without actually adding the
897 The actual pool creation can still fail due to insufficient privileges or device
900 Do not add a disk that is currently configured as a quorum device to a zpool.
901 After a disk is in the pool, that disk can then be configured as a quorum
908 .Ar pool device new_device
915 device. The existing device cannot be part of a
919 is not currently part of a mirrored configuration,
921 automatically transforms into a two-way mirror of
922 .Ar device No and Ar new_device .
925 is part of a two-way mirror, attaching
927 creates a three-way mirror, and so on. In either case,
929 begins to resilver immediately.
930 .Bl -tag -width indent
934 even if its appears to be in use. Not all devices can be overridden in this
943 Checkpoints the current state of
945 , which can be later restored by
946 .Nm zpool Cm import --rewind-to-checkpoint .
947 The existence of a checkpoint in a pool prohibits the following
956 In addition, it may break reservation boundaries if the pool lacks free
960 command indicates the existence of a checkpoint or the progress of discarding a
961 checkpoint from a pool.
964 command reports how much space the checkpoint takes from the pool.
967 Discards an existing checkpoint from
978 Clears device errors in a pool.
979 If no arguments are specified, all device errors within the pool are cleared.
980 If one or more devices is specified, only those errors associated with the
981 specified device or devices are cleared.
982 If multihost is enabled, and the pool has been suspended, this will not
984 While the pool was suspended, it may have been imported on
985 another host, and resuming I/O could result in pool damage.
986 .Bl -tag -width indent
988 Initiates recovery mode for an unopenable pool. Attempts to discard the last
989 few transactions in the pool to return it to an openable state. Not all damaged
990 pools can be recovered by using this option. If successful, the data from the
991 discarded transactions is irretrievably lost.
993 Used in combination with the
995 flag. Check whether discarding transactions would make the pool openable, but
996 do not actually discard any transactions.
1002 .Op Fl o Ar property Ns = Ns Ar value
1004 .Op Fl O Ar file-system-property Ns = Ns Ar value
1006 .Op Fl m Ar mountpoint
1008 .Op Fl t Ar tempname
1012 Creates a new storage pool containing the virtual devices specified on the
1013 command line. The pool name must begin with a letter, and can only contain
1014 alphanumeric characters as well as underscore ("_"), dash ("-"), and period
1015 ("."). The pool names "mirror", "raidz", "spare" and "log" are reserved, as are
1016 names beginning with the pattern "c[0-9]". The
1018 specification is described in the
1019 .Qq Sx Virtual Devices
1022 The command attempts to verify that each device specified is accessible and not
1023 currently in use by another subsystem.
1024 However this check is not robust enough
1025 to detect simultaneous attempts to use a new device in different pools, even if
1030 administrator must ensure that simultaneous invocations of any combination of
1035 .Sy zpool labelclear ,
1036 do not refer to the same device.
1037 Using the same device in two pools will
1038 result in pool corruption.
1040 There are some uses, such as being currently mounted, or specified as the
1041 dedicated dump device, that prevents a device from ever being used by ZFS.
1042 Other uses, such as having a preexisting UFS file system, can be overridden
1047 The command also checks that the replication strategy for the pool is
1048 consistent. An attempt to combine redundant and non-redundant storage in a
1049 single pool, or to mix disks and files, results in an error unless
1051 is specified. The use of differently sized devices within a single
1053 or mirror group is also flagged as an error unless
1059 option is specified, the default mount point is
1061 The mount point must not exist or must be empty, or else the
1062 root dataset cannot be mounted. This can be overridden with the
1066 By default all supported features are enabled on the new pool unless the
1068 option is specified.
1069 .Bl -tag -width indent
1073 even if they appear in use or specify a conflicting replication level.
1074 Not all devices can be overridden in this manner.
1076 Displays the configuration that would be used without actually creating the
1077 pool. The actual pool creation can still fail due to insufficient privileges or
1080 Do not enable any features on the new pool.
1081 Individual features can be enabled by setting their corresponding properties
1088 .Xr zpool-features 7
1089 for details about feature properties.
1091 .Fl o Ar property Ns = Ns Ar value
1092 .Op Fl o Ar property Ns = Ns Ar value
1095 Sets the given pool properties. See the
1097 section for a list of valid properties that can be set.
1100 .Ar file-system-property Ns = Ns Ar value
1101 .Op Fl O Ar file-system-property Ns = Ns Ar value
1104 Sets the given file system properties in the root file system of the pool. See
1105 .Xr zfs 8 Properties
1106 for a list of valid properties that
1110 .Qq Fl o Cm cachefile=none,altroot= Ns Pa root
1111 .It Fl m Ar mountpoint
1112 Sets the mount point for the root dataset. The default mount point is
1115 .Qq Cm altroot Ns Pa /pool
1118 is specified. The mount point must be an absolute path,
1122 For more information on dataset mount points, see
1124 .It Fl t Ar tempname
1125 Sets the in-core pool name to
1127 while the on-disk name will be the name specified as the pool name
1129 This will set the default
1133 This is intended to handle name space collisions when creating pools
1134 for other systems, such as virtual machines or physical machines
1135 whose pools live on network block devices.
1144 Destroys the given pool, freeing up any devices for other use. This command
1145 tries to unmount any active datasets before destroying the pool.
1146 .Bl -tag -width indent
1148 Forces any active datasets contained within the pool to be unmounted.
1158 from a mirror. The operation is refused if there are no other valid replicas
1167 Exports the given pools from the system. All devices are marked as exported,
1168 but are still considered in use by other subsystems. The devices can be moved
1169 between systems (even those of different endianness) and imported as long as a
1170 sufficient number of devices are present.
1172 Before exporting the pool, all datasets within the pool are unmounted. A pool
1173 can not be exported if it has a shared spare that is currently being used.
1175 For pools to be portable, you must give the
1177 command whole disks, not just slices, so that
1179 can label the disks with portable
1181 labels. Otherwise, disk drivers on platforms of different endianness will not
1182 recognize the disks.
1183 .Bl -tag -width indent
1185 Forcefully unmount all datasets, using the
1189 This command will forcefully export the pool even if it has a shared spare that
1190 is currently being used. This may lead to potential data corruption.
1196 .Op Fl o Ar field Ns Op , Ns Ar ...
1197 .Ar all | property Ns Op , Ns Ar ...
1201 Retrieves the given list of properties (or all properties if
1203 is used) for the specified storage pool(s). These properties are displayed with
1204 the following fields:
1205 .Bl -column -offset indent "property"
1206 .It name Ta Name of storage pool
1207 .It property Ta Property name
1208 .It value Ta Property value
1209 .It source Ta Property source, either 'default' or 'local'.
1214 section for more information on the available pool properties.
1216 Scripted mode. Do not display headers, and separate fields by a single tab
1217 instead of arbitrary space.
1219 Display numbers in parsable (exact) values.
1221 A comma-separated list of columns to display.
1223 .Sy property Ns , Ns
1226 is the default value.
1235 Displays the command history of the specified pools or all pools if no pool is
1237 .Bl -tag -width indent
1239 Displays internally logged
1241 events in addition to user initiated events.
1243 Displays log records in long format, which in addition to standard format
1244 includes, the user name, the hostname, and the zone in which the operation was
1250 .Op Fl d Ar dir | Fl c Ar cachefile
1254 Lists pools available to import. If the
1256 option is not specified, this command searches for devices in
1260 option can be specified multiple times, and all directories are searched. If
1261 the device appears to be part of an exported pool, this command displays a
1262 summary of the pool with the name of the pool, a numeric identifier, as well as
1265 layout and current health of the device for each device or file.
1266 Destroyed pools, pools that were previously destroyed with the
1268 command, are not listed unless the
1270 option is specified.
1272 The numeric identifier is unique, and can be used instead of the pool name when
1273 multiple exported pools of the same name are available.
1274 .Bl -tag -width indent
1275 .It Fl c Ar cachefile
1276 Reads configuration from the given
1278 that was created with the
1282 is used instead of searching for devices.
1284 Searches for devices or files in
1288 option can be specified multiple times.
1290 Lists destroyed pools only.
1296 .Op Fl o Ar property Ns = Ns Ar value
1298 .Op Fl d Ar dir | Fl c Ar cachefile
1308 Imports all pools found in the search directories. Identical to the previous
1309 command, except that all pools with a sufficient number of devices available
1310 are imported. Destroyed pools, pools that were previously destroyed with the
1312 command, will not be imported unless the
1314 option is specified.
1315 .Bl -tag -width indent
1317 Comma-separated list of mount options to use when mounting datasets within the
1320 for a description of dataset properties and mount options.
1321 .It Fl o Ar property Ns = Ns Ar value
1322 Sets the specified property on the imported pool. See the
1324 section for more information on the available pool properties.
1325 .It Fl c Ar cachefile
1326 Reads configuration from the given
1328 that was created with the
1332 is used instead of searching for devices.
1334 Searches for devices or files in
1338 option can be specified multiple times. This option is incompatible with the
1342 Imports destroyed pools only. The
1344 option is also required.
1346 Forces import, even if the pool appears to be potentially active.
1348 Allows a pool to import when there is a missing log device. Recent transactions
1349 can be lost because the log device will be discarded.
1351 Import the pool without mounting any file systems.
1362 Recovery mode for a non-importable pool. Attempt to return the pool to an
1363 importable state by discarding the last few transactions. Not all damaged pools
1364 can be recovered by using this option. If successful, the data from the
1365 discarded transactions is irretrievably lost. This option is ignored if the
1366 pool is importable or already imported.
1370 recovery option. Determines whether a non-importable pool can be made
1371 importable again, but does not actually perform the pool recovery. For more
1372 details about pool recovery mode, see the
1376 Searches for and imports all pools found.
1382 .Op Fl o Ar property Ns = Ns Ar value
1384 .Op Fl d Ar dir | Fl c Ar cachefile
1396 Imports a specific pool. A pool can be identified by its name or the numeric
1399 is specified, the pool is imported using the name
1401 Otherwise, it is imported with the same name as its exported name.
1403 If a device is removed from a system without running
1405 first, the device appears as potentially active. It cannot be determined if
1406 this was a failed export, or whether the device is really in use from another
1407 host. To import a pool in this state, the
1410 .Bl -tag -width indent
1412 Comma-separated list of mount options to use when mounting datasets within the
1415 for a description of dataset properties and mount options.
1416 .It Fl o Ar property Ns = Ns Ar value
1417 Sets the specified property on the imported pool. See the
1419 section for more information on the available pool properties.
1420 .It Fl c Ar cachefile
1421 Reads configuration from the given
1423 that was created with the
1427 is used instead of searching for devices.
1429 Searches for devices or files in
1433 option can be specified multiple times. This option is incompatible with the
1437 Imports destroyed pools only. The
1439 option is also required.
1441 Forces import, even if the pool appears to be potentially active.
1443 Allows a pool to import when there is a missing log device. Recent transactions
1444 can be lost because the log device will be discarded.
1446 Import the pool without mounting any file systems.
1449 .Qq Fl o Cm cachefile=none,altroot= Ns Pa root
1456 Temporary pool names last until export.
1457 Ensures that the original pool name will be used in all label updates and
1458 therefore is retained upon export.
1463 when not explicitly specified.
1465 Recovery mode for a non-importable pool. Attempt to return the pool to an
1466 importable state by discarding the last few transactions. Not all damaged pools
1467 can be recovered by using this option. If successful, the data from the
1468 discarded transactions is irretrievably lost. This option is ignored if the
1469 pool is importable or already imported.
1473 recovery option. Determines whether a non-importable pool can be made
1474 importable again, but does not actually perform the pool recovery. For more
1475 details about pool recovery mode, see the
1478 .It Fl -rewind-to-checkpoint
1479 Rewinds pool to the checkpointed state.
1480 Once the pool is imported with this flag there is no way to undo the rewind.
1481 All changes and data that were written after the checkpoint are lost!
1482 The only exception is when the
1484 mounting option is enabled.
1485 In this case, the checkpointed state of the pool is opened and an
1486 administrator can see how the pool would look like if they were
1494 .Op Ar device Ns ...
1496 Begins initializing by writing to all unallocated regions on the specified
1497 devices, or all eligible devices in the pool if no individual devices are
1499 Only leaf data or log devices may be initialized.
1502 Cancel initializing on the specified devices, or all eligible devices if none
1504 If one or more target devices are invalid or are not currently being
1505 initialized, the command will fail and no cancellation will occur on any device.
1507 Suspend initializing on the specified devices, or all eligible devices if none
1509 If one or more target devices are invalid or are not currently being
1510 initialized, the command will fail and no suspension will occur on any device.
1511 Initializing can then be resumed by running
1512 .Nm zpool Cm initialize
1513 with no flags on the relevant target devices.
1518 .Op Fl T Cm d Ns | Ns Cm u
1522 .Op Ar interval Op Ar count
1527 statistics for the given pools. When given an interval, the statistics are
1534 are specified, statistics for every pool in the system is shown. If
1536 is specified, the command exits after
1538 reports are printed.
1539 .Bl -tag -width indent
1540 .It Fl T Cm d Ns | Ns Cm u
1545 for standard date format. See
1550 .Pq equals Qq Ic date +%s .
1552 Verbose statistics. Reports usage statistics for individual
1554 within the pool, in addition to the pool-wide statistics.
1565 label information from the specified
1569 must not be part of an active pool configuration.
1570 .Bl -tag -width indent
1572 Treat exported or foreign devices as inactive.
1578 .Op Fl o Ar property Ns Op , Ns Ar ...
1579 .Op Fl T Cm d Ns | Ns Cm u
1582 .Op Ar inverval Op Ar count
1585 Lists the given pools along with a health status and space usage. If no
1587 are specified, all pools in the system are listed.
1589 When given an interval, the output is printed every
1595 is specified, the command exits after
1597 reports are printed.
1598 .Bl -tag -width indent
1599 .It Fl T Cm d Ns | Ns Cm u
1604 for standard date format. See
1609 .Pq equals Qq Ic date +%s .
1611 Scripted mode. Do not display headers, and separate fields by a single tab
1612 instead of arbitrary space.
1614 Display numbers in parsable (exact) values.
1616 Verbose statistics. Reports usage statistics for individual
1619 the pool, in addition to the pool-wide statistics.
1620 .It Fl o Ar property Ns Op , Ns Ar ...
1621 Comma-separated list of properties to display. See the
1623 section for a list of valid properties. The default list is
1635 .It Fl T Cm d Ns | Ns Cm u
1640 for standard date format. See
1645 .Pq equals Qq Ic date +%s .
1654 Takes the specified physical device offline. While the
1656 is offline, no attempt is made to read or write to the device.
1657 .Bl -tag -width indent
1659 Temporary. Upon reboot, the specified physical device reverts to its previous
1669 Brings the specified physical device online.
1671 This command is not applicable to spares or cache devices.
1672 .Bl -tag -width indent
1674 Expand the device to use all available space. If the device is part of a mirror
1677 then all devices must be expanded before the new space will become
1678 available to the pool.
1686 Generates a new unique identifier for the pool. You must ensure that all
1687 devices in this pool are online and healthy before performing this action.
1695 Removes the specified device from the pool.
1696 This command currently only supports removing hot spares, cache, log
1697 devices and mirrored top-level vdevs (mirror of leaf devices); but not raidz.
1699 Removing a top-level vdev reduces the total amount of space in the storage pool.
1700 The specified device will be evacuated by copying all allocated space from it to
1701 the other devices in the pool.
1704 command initiates the removal and returns, while the evacuation continues in
1706 The removal progress can be monitored with
1707 .Nm zpool Cm status.
1708 This feature must be enabled to be used, see
1709 .Xr zpool-features 5
1711 A mirrored top-level device (log or data) can be removed by specifying the
1712 top-level mirror for the same.
1713 Non-log devices or data devices that are part of a mirrored configuration can
1714 be removed using the
1719 Do not actually perform the removal ("no-op").
1720 Instead, print the estimated amount of memory that will be used by the
1721 mapping table after the removal completes.
1722 This is nonzero only for top-level vdevs.
1726 Used in conjunction with the
1728 flag, displays numbers as parsable (exact) values.
1737 Stops and cancels an in-progress removal of a top-level vdev.
1744 Reopen all the vdevs associated with the pool.
1757 This is equivalent to attaching
1759 waiting for it to resilver, and then detaching
1764 must be greater than or equal to the minimum size
1765 of all the devices in a mirror or
1770 is required if the pool is not redundant. If
1772 is not specified, it defaults to
1774 This form of replacement is useful after an existing disk has failed and has
1775 been physically replaced. In this case, the new disk may have the same
1777 path as the old device, even though it is actually a different disk.
1780 .Bl -tag -width indent
1784 even if its appears to be in use. Not all devices can be overridden in this
1794 Begins a scrub or resumes a paused scrub.
1795 The scrub examines all data in the specified pools to verify that it checksums
1799 devices, ZFS automatically repairs any damage discovered during the scrub.
1802 command reports the progress of the scrub and summarizes the results of the
1803 scrub upon completion.
1805 Scrubbing and resilvering are very similar operations.
1806 The difference is that resilvering only examines data that ZFS knows to be out
1809 for example, when attaching a new device to a mirror or replacing an existing
1812 whereas scrubbing examines all data to discover silent errors due to hardware
1813 faults or disk failure.
1815 Because scrubbing and resilvering are I/O-intensive operations, ZFS only allows
1817 If a scrub is paused, the
1820 If a resilver is in progress, ZFS does not allow a scrub to be started until the
1829 Scrub pause state and progress are periodically synced to disk.
1830 If the system is restarted or pool is exported during a paused scrub,
1831 even after import, scrub will remain paused until it is resumed.
1832 Once resumed the scrub will pick up from the place where it was last
1833 checkpointed to disk.
1834 To resume a paused scrub issue
1841 .Ar property Ns = Ns Ar value pool
1844 Sets the given property on the specified pool. See the
1846 section for more information on what properties can be set and acceptable
1854 .Op Fl o Ar property Ns = Ns Ar value
1859 Splits off one disk from each mirrored top-level
1861 in a pool and creates a new pool from the split-off disks. The original pool
1862 must be made up of one or more mirrors and must not be in the process of
1865 subcommand chooses the last device in each mirror
1867 unless overridden by a device specification on the command line.
1873 includes the specified device(s) in a new pool and, should any devices remain
1874 unspecified, assigns the last device in each mirror
1876 to that pool, as it does normally. If you are uncertain about the outcome of a
1880 ("dry-run") option to ensure your command will have the effect you intend.
1881 .Bl -tag -width indent
1883 Automatically import the newly created pool after splitting, using the
1886 parameter for the new pool's alternate root. See the
1892 Displays the configuration that would be created without actually splitting the
1893 pool. The actual pool split could still fail due to insufficient privileges or
1896 Comma-separated list of mount options to use when mounting datasets within the
1899 for a description of dataset properties and mount options. Valid only in
1900 conjunction with the
1903 .It Fl o Ar property Ns = Ns Ar value
1904 Sets the specified property on the new pool. See the
1906 section, above, for more information on the available pool properties.
1912 .Op Fl T Cm d Ns | Ns Cm u
1915 .Op Ar interval Op Ar count
1918 Displays the detailed health status for the given pools. If no
1920 is specified, then the status of each pool in the system is displayed. For more
1921 information on pool and device health, see the
1922 .Qq Sx Device Failure and Recovery
1925 When given an interval, the output is printed every
1931 is specified, the command exits after
1933 reports are printed.
1935 If a scrub or resilver is in progress, this command reports the percentage
1936 done and the estimated time to completion. Both of these are only approximate,
1937 because the amount of data in the pool and the other workloads on the system
1939 .Bl -tag -width indent
1941 Display a histogram of deduplication statistics, showing the allocated
1942 .Pq physically present on disk
1944 .Pq logically referenced in the pool
1945 block counts and sizes by reference count.
1946 .It Fl T Cm d Ns | Ns Cm u
1951 for standard date format. See
1956 .Pq equals Qq Ic date +%s .
1958 Displays verbose data error information, printing out a complete list of all
1959 data errors since the last complete pool scrub.
1961 Only display status for pools that are exhibiting errors or are otherwise
1963 Warnings about pools not using the latest on-disk format, having non-native
1964 block size or disabled features will not be included.
1969 .Oo Ar pool Oc Ns ...
1971 Forces all in-core dirty data to be written to the primary pool storage and
1973 It will also update administrative information including quota reporting.
1976 will sync all pools on the system.
1977 Otherwise, it will only sync the specified
1985 Displays pools which do not have all supported features enabled and pools
1986 formatted using a legacy
1989 These pools can continue to be used, but some features may not be available.
1992 to enable all features on all pools.
1993 .Bl -tag -width indent
1997 versions supported by the current software.
1999 .Xr zpool-features 7
2000 for a description of feature flags features supported by the current software.
2009 Enables all supported features on the given pool.
2010 Once this is done, the pool will no longer be accessible on systems that do
2011 not support feature flags.
2013 .Xr zpool-features 7
2014 for details on compatibility with systems that support feature flags, but do
2015 not support all features enabled on the pool.
2016 .Bl -tag -width indent
2018 Enables all supported features on all pools.
2020 Upgrade to the specified legacy version. If the
2022 flag is specified, no features will be enabled on the pool.
2023 This option can only be used to increase version number up to the last
2024 supported legacy version number.
2028 The following exit values are returned:
2029 .Bl -tag -offset 2n -width 2n
2031 Successful completion.
2035 Invalid command line options were specified.
2039 .It Sy Example 1 No Creating a RAID-Z Storage Pool
2041 The following command creates a pool with a single
2045 that consists of six disks.
2046 .Bd -literal -offset 2n
2047 .Li # Ic zpool create tank raidz da0 da1 da2 da3 da4 da5
2049 .It Sy Example 2 No Creating a Mirrored Storage Pool
2051 The following command creates a pool with two mirrors, where each mirror
2053 .Bd -literal -offset 2n
2054 .Li # Ic zpool create tank mirror da0 da1 mirror da2 da3
2056 .It Sy Example 3 No Creating a Tn ZFS No Storage Pool by Using Partitions
2058 The following command creates an unmirrored pool using two GPT partitions.
2059 .Bd -literal -offset 2n
2060 .Li # Ic zpool create tank da0p3 da1p3
2062 .It Sy Example 4 No Creating a Tn ZFS No Storage Pool by Using Files
2064 The following command creates an unmirrored pool using files. While not
2065 recommended, a pool based on files can be useful for experimental purposes.
2066 .Bd -literal -offset 2n
2067 .Li # Ic zpool create tank /path/to/file/a /path/to/file/b
2069 .It Sy Example 5 No Adding a Mirror to a Tn ZFS No Storage Pool
2071 The following command adds two mirrored disks to the pool
2073 assuming the pool is already made up of two-way mirrors. The additional space
2074 is immediately available to any datasets within the pool.
2075 .Bd -literal -offset 2n
2076 .Li # Ic zpool add tank mirror da2 da3
2078 .It Sy Example 6 No Listing Available Tn ZFS No Storage Pools
2080 The following command lists all available pools on the system.
2081 .Bd -literal -offset 2n
2083 NAME SIZE ALLOC FREE FRAG EXPANDSZ CAP DEDUP HEALTH ALTROOT
2084 pool 2.70T 473G 2.24T 33% - 17% 1.00x ONLINE -
2085 test 1.98G 89.5K 1.98G 48% - 0% 1.00x ONLINE -
2087 .It Sy Example 7 No Listing All Properties for a Pool
2089 The following command lists all the properties for a pool.
2090 .Bd -literal -offset 2n
2091 .Li # Ic zpool get all pool
2094 pool altroot - default
2095 pool health ONLINE -
2096 pool guid 2501120270416322443 default
2097 pool version 28 default
2098 pool bootfs pool/root local
2099 pool delegation on default
2100 pool autoreplace off default
2101 pool cachefile - default
2102 pool failmode wait default
2103 pool listsnapshots off default
2104 pool autoexpand off default
2105 pool dedupditto 0 default
2106 pool dedupratio 1.00x -
2108 pool allocated 473G -
2111 .It Sy Example 8 No Destroying a Tn ZFS No Storage Pool
2113 The following command destroys the pool
2115 and any datasets contained within.
2116 .Bd -literal -offset 2n
2117 .Li # Ic zpool destroy -f tank
2119 .It Sy Example 9 No Exporting a Tn ZFS No Storage Pool
2121 The following command exports the devices in pool
2123 so that they can be relocated or later imported.
2124 .Bd -literal -offset 2n
2125 .Li # Ic zpool export tank
2127 .It Sy Example 10 No Importing a Tn ZFS No Storage Pool
2129 The following command displays available pools, and then imports the pool
2131 for use on the system.
2133 The results from this command are similar to the following:
2134 .Bd -literal -offset 2n
2135 .Li # Ic zpool import
2138 id: 15451357997522795478
2140 action: The pool can be imported using its name or numeric identifier.
2152 Storage Pools to the Current Version
2155 The following command upgrades all
2157 Storage pools to the current version of
2159 .Bd -literal -offset 2n
2160 .Li # Ic zpool upgrade -a
2161 This system is currently running ZFS pool version 28.
2163 .It Sy Example 12 No Managing Hot Spares
2165 The following command creates a new pool with an available hot spare:
2166 .Bd -literal -offset 2n
2167 .Li # Ic zpool create tank mirror da0 da1 spare da2
2170 If one of the disks were to fail, the pool would be reduced to the degraded
2171 state. The failed device can be replaced using the following command:
2172 .Bd -literal -offset 2n
2173 .Li # Ic zpool replace tank da0 da2
2176 Once the data has been resilvered, the spare is automatically removed and is
2177 made available should another device fails. The hot spare can be permanently
2178 removed from the pool using the following command:
2179 .Bd -literal -offset 2n
2180 .Li # Ic zpool remove tank da2
2186 Pool with Mirrored Separate Intent Logs
2189 The following command creates a
2191 storage pool consisting of two, two-way
2192 mirrors and mirrored log devices:
2193 .Bd -literal -offset 2n
2194 .Li # Ic zpool create pool mirror da0 da1 mirror da2 da3 log mirror da4 da5
2196 .It Sy Example 14 No Adding Cache Devices to a Tn ZFS No Pool
2198 The following command adds two disks for use as cache devices to a
2201 .Bd -literal -offset 2n
2202 .Li # Ic zpool add pool cache da2 da3
2205 Once added, the cache devices gradually fill with content from main memory.
2206 Depending on the size of your cache devices, it could take over an hour for
2207 them to fill. Capacity and reads can be monitored using the
2209 subcommand as follows:
2210 .Bd -literal -offset 2n
2211 .Li # Ic zpool iostat -v pool 5
2215 Displaying expanded space on a device
2218 The following command dipslays the detailed information for the
2221 This pool is comprised of a single
2223 vdev where one of its
2224 devices increased its capacity by 10GB.
2225 In this example, the pool will not
2226 be able to utilized this extra capacity until all the devices under the
2228 vdev have been expanded.
2229 .Bd -literal -offset 2n
2230 .Li # Ic zpool list -v data
2231 NAME SIZE ALLOC FREE FRAG EXPANDSZ CAP DEDUP HEALTH ALTROOT
2232 data 23.9G 14.6G 9.30G 48% - 61% 1.00x ONLINE -
2233 raidz1 23.9G 14.6G 9.30G 48% -
2240 Removing a Mirrored top-level (Log or Data) Device
2243 The following commands remove the mirrored log device
2245 and mirrored top-level data device
2248 Given this configuration:
2249 .Bd -literal -offset 2n
2252 scrub: none requested
2255 NAME STATE READ WRITE CKSUM
2257 mirror-0 ONLINE 0 0 0
2260 mirror-1 ONLINE 0 0 0
2264 mirror-2 ONLINE 0 0 0
2269 The command to remove the mirrored log
2272 .Bd -literal -offset 2n
2273 .Li # Ic zpool remove tank mirror-2
2276 The command to remove the mirrored data
2279 .Bd -literal -offset 2n
2280 .Li # Ic zpool remove tank mirror-1
2284 Recovering a Faulted
2289 If a pool is faulted but recoverable, a message indicating this state is
2292 if the pool was cached (see the
2294 argument above), or as part of the error output from a failed
2298 Recover a cached pool with the
2301 .Bd -literal -offset 2n
2302 .Li # Ic zpool clear -F data
2303 Pool data returned to its state as of Tue Sep 08 13:23:35 2009.
2304 Discarded approximately 29 seconds of transactions.
2307 If the pool configuration was not cached, use
2309 with the recovery mode flag:
2310 .Bd -literal -offset 2n
2311 .Li # Ic zpool import -F data
2312 Pool data returned to its state as of Tue Sep 08 13:23:35 2009.
2313 Discarded approximately 29 seconds of transactions.
2317 .Xr zpool-features 7 ,
2321 This manual page is a
2323 reimplementation of the
2327 modified and customized for
2329 and licensed under the Common Development and Distribution License
2334 implementation of this manual page was initially written by
2335 .An Martin Matuska Aq mm@FreeBSD.org .
projects / FreeBSD / FreeBSD.git / blob