4 .\" The contents of this file are subject to the terms of the
5 .\" Common Development and Distribution License (the "License").
6 .\" You may not use this file except in compliance with the License.
8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 .\" or http://www.opensolaris.org/os/licensing.
10 .\" See the License for the specific language governing permissions
11 .\" and limitations under the License.
13 .\" When distributing Covered Code, include this CDDL HEADER in each
14 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 .\" If applicable, add the following below this CDDL HEADER, with the
16 .\" fields enclosed by brackets "[]" replaced with your own identifying
17 .\" information: Portions Copyright [yyyy] [name of copyright owner]
22 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
23 .\" Copyright (c) 2012, 2018 by Delphix. All rights reserved.
24 .\" Copyright (c) 2012 Cyril Plisko. All Rights Reserved.
25 .\" Copyright (c) 2017 Datto Inc.
26 .\" Copyright (c) 2018 George Melikov. All Rights Reserved.
27 .\" Copyright 2017 Nexenta Systems, Inc.
28 .\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
35 .Nd configure ZFS storage pools
42 .Oo Fl o Ar property Ns = Ns Ar value Oc
47 .Oo Fl o Ar property Ns = Ns Ar value Oc
48 .Ar pool device new_device
60 .Op Fl m Ar mountpoint
61 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
62 .Oo Fl o Ar feature@feature Ns = Ns Ar value Oc
63 .Oo Fl O Ar file-system-property Ns = Ns Ar value Oc Ns ...
75 .Op Fl vHf Oo Ar pool Oc | Fl c
84 .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
85 .Sy all Ns | Ns Ar property Ns Oo , Ns Ar property Oc Ns ...
94 .Op Fl d Ar dir Ns | Ns device
99 .Op Fl F Oo Fl n Oc Oo Fl T Oc Oo Fl X Oc
100 .Op Fl -rewind-to-checkpoint
101 .Op Fl c Ar cachefile Ns | Ns Fl d Ar dir Ns | Ns device
103 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
108 .Op Fl F Oo Fl n Oc Oo Fl T Oc Oo Fl X Oc
109 .Op Fl -rewind-to-checkpoint
110 .Op Fl c Ar cachefile Ns | Ns Fl d Ar dir Ns | Ns device
112 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
115 .Ar pool Ns | Ns Ar id
116 .Op Ar newpool Oo Fl t Oc
124 .Op Oo Oo Fl c Ar SCRIPT Oc Oo Fl lq Oc Oc Ns | Ns Fl rw
125 .Op Fl T Sy u Ns | Ns Sy d
127 .Oo Oo Ar pool Ns ... Oc Ns | Ns Oo Ar pool vdev Ns ... Oc Ns | Ns Oo Ar vdev Ns ... Oc Oc
128 .Op Ar interval Op Ar count
136 .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
137 .Op Fl T Sy u Ns | Ns Sy d
138 .Oo Ar pool Oc Ns ...
139 .Op Ar interval Op Ar count
144 .Ar pool Ar device Ns ...
148 .Ar pool Ar device Ns ...
159 .Ar pool Ar device Ns ...
167 .Oo Fl o Ar property Ns = Ns Ar value Oc
168 .Ar pool Ar device Op Ar new_device
178 .Ar property Ns = Ns Ar value
183 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
186 .Oo Ar device Oc Ns ...
189 .Oo Fl c Ar SCRIPT Oc
191 .Op Fl T Sy u Ns | Ns Sy d
192 .Oo Ar pool Oc Ns ...
193 .Op Ar interval Op Ar count
196 .Oo Ar pool Oc Ns ...
205 .Fl a Ns | Ns Ar pool Ns ...
209 command configures ZFS storage pools.
210 A storage pool is a collection of devices that provides physical storage and
211 data replication for ZFS datasets.
212 All datasets within a storage pool share the same space.
215 for information on managing datasets.
216 .Ss Virtual Devices (vdevs)
217 A "virtual device" describes a single device or a collection of devices
218 organized according to certain performance and fault characteristics.
219 The following virtual devices are supported:
222 A block device, typically located under
224 ZFS can use individual slices or partitions, though the recommended mode of
225 operation is to use whole disks.
226 A disk can be specified by a full path, or it can be a shorthand name
227 .Po the relative portion of the path under
230 A whole disk can be specified by omitting the slice or partition designation.
235 When given a whole disk, ZFS automatically labels the disk, if necessary.
238 The use of files as a backing store is strongly discouraged.
239 It is designed primarily for experimental purposes, as the fault tolerance of a
240 file is only as good as the file system of which it is a part.
241 A file must be specified by a full path.
243 A mirror of two or more devices.
244 Data is replicated in an identical fashion across all components of a mirror.
245 A mirror with N disks of size X can hold X bytes and can withstand (N-1) devices
246 failing before data integrity is compromised.
247 .It Sy raidz , raidz1 , raidz2 , raidz3
248 A variation on RAID-5 that allows for better distribution of parity and
249 eliminates the RAID-5
251 .Pq in which data and parity become inconsistent after a power loss .
252 Data and parity is striped across all disks within a raidz group.
254 A raidz group can have single-, double-, or triple-parity, meaning that the
255 raidz group can sustain one, two, or three failures, respectively, without
259 vdev type specifies a single-parity raidz group; the
261 vdev type specifies a double-parity raidz group; and the
263 vdev type specifies a triple-parity raidz group.
266 vdev type is an alias for
269 A raidz group with N disks of size X with P parity disks can hold approximately
270 (N-P)*X bytes and can withstand P device(s) failing before data integrity is
272 The minimum number of devices in a raidz group is one more than the number of
274 The recommended number is between 3 and 9 to help increase performance.
276 A special pseudo-vdev which keeps track of available hot spares for a pool.
277 For more information, see the
281 A separate intent log device.
282 If more than one log device is specified, then writes are load-balanced between
284 Log devices can be mirrored.
285 However, raidz vdev types are not supported for the intent log.
286 For more information, see the
290 A device dedicated solely for allocating dedup data.
291 The redundancy of this device should match the redundancy of the other normal
292 devices in the pool. If more than one dedup device is specified, then
293 allocations are load-balanced between devices.
295 A device dedicated solely for allocating various kinds of internal metadata,
296 and optionally small file data.
297 The redundancy of this device should match the redundancy of the other normal
298 devices in the pool. If more than one special device is specified, then
299 allocations are load-balanced between devices.
301 For more information on special allocations, see the
302 .Sx Special Allocation Class
305 A device used to cache storage pool data.
306 A cache device cannot be configured as a mirror or raidz group.
307 For more information, see the
312 Virtual devices cannot be nested, so a mirror or raidz virtual device can only
313 contain files or disks.
315 .Pq or other combinations
318 A pool can have any number of virtual devices at the top of the configuration
322 Data is dynamically distributed across all top-level devices to balance data
324 As new virtual devices are added, ZFS automatically places data on the newly
327 Virtual devices are specified one at a time on the command line, separated by
333 are used to distinguish where a group ends and another begins.
334 For example, the following creates two root vdevs, each a mirror of two disks:
336 # zpool create mypool mirror sda sdb mirror sdc sdd
338 .Ss Device Failure and Recovery
339 ZFS supports a rich set of mechanisms for handling device failure and data
341 All metadata and data is checksummed, and ZFS automatically repairs bad data
342 from a good copy when corruption is detected.
344 In order to take advantage of these features, a pool must make use of some form
345 of redundancy, using either mirrored or raidz groups.
346 While ZFS supports running in a non-redundant configuration, where each root
347 vdev is simply a disk or file, this is strongly discouraged.
348 A single case of bit corruption can render some or all of your data unavailable.
350 A pool's health status is described by one of three states: online, degraded,
352 An online pool has all devices operating normally.
353 A degraded pool is one in which one or more devices have failed, but the data is
354 still available due to a redundant configuration.
355 A faulted pool has corrupted metadata, or one or more faulted devices, and
356 insufficient replicas to continue functioning.
358 The health of the top-level vdev, such as mirror or raidz device, is
359 potentially impacted by the state of its associated vdevs, or component
361 A top-level vdev or component device is in one of the following states:
362 .Bl -tag -width "DEGRADED"
364 One or more top-level vdevs is in the degraded state because one or more
365 component devices are offline.
366 Sufficient replicas exist to continue functioning.
368 One or more component devices is in the degraded or faulted state, but
369 sufficient replicas exist to continue functioning.
370 The underlying conditions are as follows:
373 The number of checksum errors exceeds acceptable levels and the device is
374 degraded as an indication that something may be wrong.
375 ZFS continues to use the device as necessary.
377 The number of I/O errors exceeds acceptable levels.
378 The device could not be marked as faulted because there are insufficient
379 replicas to continue functioning.
382 One or more top-level vdevs is in the faulted state because one or more
383 component devices are offline.
384 Insufficient replicas exist to continue functioning.
386 One or more component devices is in the faulted state, and insufficient
387 replicas exist to continue functioning.
388 The underlying conditions are as follows:
391 The device could be opened, but the contents did not match expected values.
393 The number of I/O errors exceeds acceptable levels and the device is faulted to
394 prevent further use of the device.
397 The device was explicitly taken offline by the
401 The device is online and functioning.
403 The device was physically removed while the system was running.
404 Device removal detection is hardware-dependent and may not be supported on all
407 The device could not be opened.
408 If a pool is imported when a device was unavailable, then the device will be
409 identified by a unique identifier instead of its path since the path was never
410 correct in the first place.
413 If a device is removed and later re-attached to the system, ZFS attempts
414 to put the device online automatically.
415 Device attach detection is hardware-dependent and might not be supported on all
418 ZFS allows devices to be associated with pools as
420 These devices are not actively used in the pool, but when an active device
421 fails, it is automatically replaced by a hot spare.
422 To create a pool with hot spares, specify a
424 vdev with any number of devices.
427 # zpool create pool mirror sda sdb spare sdc sdd
430 Spares can be shared across multiple pools, and can be added with the
432 command and removed with the
435 Once a spare replacement is initiated, a new
437 vdev is created within the configuration that will remain there until the
438 original device is replaced.
439 At this point, the hot spare becomes available again if another device fails.
441 If a pool has a shared spare that is currently being used, the pool can not be
442 exported since other pools may use this shared spare, which may lead to
443 potential data corruption.
445 An in-progress spare replacement can be cancelled by detaching the hot spare.
446 If the original faulted device is detached, then the hot spare assumes its
447 place in the configuration, and is removed from the spare list of all active
450 Spares cannot replace log devices.
452 The ZFS Intent Log (ZIL) satisfies POSIX requirements for synchronous
454 For instance, databases often require their transactions to be on stable storage
455 devices when returning from a system call.
456 NFS and other applications can also use
458 to ensure data stability.
459 By default, the intent log is allocated from blocks within the main pool.
460 However, it might be possible to get better performance using separate intent
461 log devices such as NVRAM or a dedicated disk.
464 # zpool create pool sda sdb log sdc
467 Multiple log devices can also be specified, and they can be mirrored.
470 section for an example of mirroring multiple log devices.
472 Log devices can be added, replaced, attached, detached and removed. In
473 addition, log devices are imported and exported as part of the pool
475 Mirrored devices can be removed by specifying the top-level mirror vdev.
477 Devices can be added to a storage pool as
479 These devices provide an additional layer of caching between main memory and
481 For read-heavy workloads, where the working set size is much larger than what
482 can be cached in main memory, using cache devices allow much more of this
483 working set to be served from low latency media.
484 Using cache devices provides the greatest performance improvement for random
485 read-workloads of mostly static content.
487 To create a pool with cache devices, specify a
489 vdev with any number of devices.
492 # zpool create pool sda sdb cache sdc sdd
495 Cache devices cannot be mirrored or part of a raidz configuration.
496 If a read error is encountered on a cache device, that read I/O is reissued to
497 the original storage pool device, which might be part of a mirrored or raidz
500 The content of the cache devices is considered volatile, as is the case with
503 Before starting critical procedures that include destructive actions (e.g
505 ), an administrator can checkpoint the pool's state and in the case of a
506 mistake or failure, rewind the entire pool back to the checkpoint.
507 Otherwise, the checkpoint can be discarded when the procedure has completed
510 A pool checkpoint can be thought of as a pool-wide snapshot and should be used
511 with care as it contains every part of the pool's state, from properties to vdev
513 Thus, while a pool has a checkpoint certain operations are not allowed.
514 Specifically, vdev removal/attach/detach, mirror splitting, and
515 changing the pool's guid.
516 Adding a new vdev is supported but in the case of a rewind it will have to be
518 Finally, users of this feature should keep in mind that scrubs in a pool that
519 has a checkpoint do not repair checkpointed data.
521 To create a checkpoint for a pool:
523 # zpool checkpoint pool
526 To later rewind to its checkpointed state, you need to first export it and
527 then rewind it during import:
530 # zpool import --rewind-to-checkpoint pool
533 To discard the checkpoint from a pool:
535 # zpool checkpoint -d pool
538 Dataset reservations (controlled by the
542 zfs properties) may be unenforceable while a checkpoint exists, because the
543 checkpoint is allowed to consume the dataset's reservation.
544 Finally, data that is part of the checkpoint but has been freed in the
545 current state of the pool won't be scanned during a scrub.
546 .Ss Special Allocation Class
547 The allocations in the special class are dedicated to specific block types.
548 By default this includes all metadata, the indirect blocks of user data, and
549 any dedup data. The class can also be provisioned to accept a limited
550 percentage of small file data blocks.
552 A pool must always have at least one general (non-specified) vdev before
553 other devices can be assigned to the special class. If the special class
554 becomes full, then allocations intended for it will spill back into the
557 Dedup data can be excluded from the special class by setting the
558 .Sy zfs_ddt_data_is_special
559 zfs module parameter to false (0).
561 Inclusion of small file blocks in the special class is opt-in. Each dataset
562 can control the size of small file blocks allowed in the special class by
564 .Sy special_small_blocks
565 dataset property. It defaults to zero so you must opt-in by setting it to a
568 for more info on setting this property.
570 Each pool has several properties associated with it.
571 Some properties are read-only statistics while others are configurable and
572 change the behavior of the pool.
574 The following are read-only properties:
577 Amount of storage used within the pool.
579 Percentage of pool space used.
580 This property can also be referred to by its shortened column name,
583 Amount of uninitialized space within the pool or device that can be used to
584 increase the total capacity of the pool.
585 Uninitialized space consists of any space on an EFI labeled vdev which has not
588 .Nm zpool Cm online Fl e
590 This space occurs when a LUN is dynamically expanded.
592 The amount of fragmentation in the pool.
594 The amount of free space available in the pool.
596 After a file system or snapshot is destroyed, the space it was using is
597 returned to the pool asynchronously.
599 is the amount of space remaining to be reclaimed.
606 The current health of the pool.
608 .Sy ONLINE , DEGRADED , FAULTED , OFFLINE, REMOVED , UNAVAIL .
610 A unique identifier for the pool.
612 A unique identifier for the pool.
615 property, this identifier is generated every time we load the pool (e.g. does
616 not persist across imports/exports) and never changes while the pool is loaded
619 operation takes place).
621 Total size of the storage pool.
622 .It Sy unsupported@ Ns Em feature_guid
623 Information about unsupported features that are enabled on the pool.
629 The space usage properties report actual physical space available to the
631 The physical space can be different from the total amount of space that any
632 contained datasets can actually use.
633 The amount of space used in a raidz configuration depends on the characteristics
634 of the data being written.
635 In addition, ZFS reserves some space for internal accounting that the
637 command takes into account, but the
640 For non-full pools of a reasonable size, these effects should be invisible.
641 For small pools, or pools that are close to being completely full, these
642 discrepancies may become more noticeable.
644 The following property can be set at creation time and import time:
647 Alternate root directory.
648 If set, this directory is prepended to any mount points within the pool.
649 This can be used when examining an unknown pool where the mount points cannot be
650 trusted, or in an alternate boot environment, where the typical paths are not
653 is not a persistent property.
654 It is valid only while the system is up.
658 .Sy cachefile Ns = Ns Sy none ,
659 though this may be overridden using an explicit setting.
662 The following property can be set only at import time:
664 .It Sy readonly Ns = Ns Sy on Ns | Ns Sy off
667 the pool will be imported in read-only mode.
668 This property can also be referred to by its shortened column name,
672 The following properties can be set at creation time and import time, and later
677 .It Sy ashift Ns = Ns Sy ashift
678 Pool sector size exponent, to the power of
680 (internally referred to as
682 ). Values from 9 to 16, inclusive, are valid; also, the special
683 value 0 (the default) means to auto-detect using the kernel's block
684 layer and a ZFS internal exception list. I/O operations will be aligned
685 to the specified size boundaries. Additionally, the minimum (disk)
686 write size will be set to the specified size, so this represents a
687 space vs. performance trade-off. For optimal performance, the pool
688 sector size should be greater than or equal to the sector size of the
689 underlying disks. The typical case for setting this property is when
690 performance is important and the underlying disks use 4KiB sectors but
691 report 512B sectors to the OS (for compatibility reasons); in that
694 (which is 1<<12 = 4096). When set, this property is
695 used as the default hint value in subsequent vdev operations (add,
696 attach and replace). Changing this value will not modify any existing
697 vdev, not even on disk replacement; however it can be used, for
698 instance, to replace a dying 512B sectors disk with a newer 4KiB
699 sectors device: this will probably result in bad performance but at the
700 same time could prevent loss of data.
701 .It Sy autoexpand Ns = Ns Sy on Ns | Ns Sy off
702 Controls automatic pool expansion when the underlying LUN is grown.
705 the pool will be resized according to the size of the expanded device.
706 If the device is part of a mirror or raidz then all devices within that
707 mirror/raidz group must be expanded before the new space is made available to
709 The default behavior is
711 This property can also be referred to by its shortened column name,
713 .It Sy autoreplace Ns = Ns Sy on Ns | Ns Sy off
714 Controls automatic device replacement.
717 device replacement must be initiated by the administrator by using the
722 any new device, found in the same physical location as a device that previously
723 belonged to the pool, is automatically formatted and replaced.
724 The default behavior is
726 This property can also be referred to by its shortened column name,
728 Autoreplace can also be used with virtual disks (like device
729 mapper) provided that you use the /dev/disk/by-vdev paths setup by
730 vdev_id.conf. See the
732 man page for more details.
733 Autoreplace and autoonline require the ZFS Event Daemon be configured and
736 man page for more details.
737 .It Sy bootfs Ns = Ns Sy (unset) Ns | Ns Ar pool Ns / Ns Ar dataset
738 Identifies the default bootable dataset for the root pool. This property is
739 expected to be set mainly by the installation and upgrade programs.
740 Not all Linux distribution boot processes use the bootfs property.
741 .It Sy cachefile Ns = Ns Ar path Ns | Ns Sy none
742 Controls the location of where the pool configuration is cached.
743 Discovering all pools on system startup requires a cached copy of the
744 configuration data that is stored on the root file system.
745 All pools in this cache are automatically imported when the system boots.
746 Some environments, such as install and clustering, need to cache this
747 information in a different location so that pools are not automatically
749 Setting this property caches the pool configuration in a different location that
750 can later be imported with
751 .Nm zpool Cm import Fl c .
752 Setting it to the special value
754 creates a temporary pool that is never cached, and the special value
757 uses the default location.
759 Multiple pools can share the same cache file.
760 Because the kernel destroys and recreates this file when pools are added and
761 removed, care should be taken when attempting to access this file.
762 When the last pool using a
764 is exported or destroyed, the file will be empty.
765 .It Sy comment Ns = Ns Ar text
766 A text string consisting of printable ASCII characters that will be stored
767 such that it is available even if the pool becomes faulted.
768 An administrator can provide additional information about a pool using this
770 .It Sy dedupditto Ns = Ns Ar number
771 Threshold for the number of block ditto copies.
772 If the reference count for a deduplicated block increases above this number, a
773 new ditto copy of this block is automatically stored.
774 The default setting is
776 which causes no ditto copies to be created for deduplicated blocks.
777 The minimum legal nonzero setting is
779 .It Sy delegation Ns = Ns Sy on Ns | Ns Sy off
780 Controls whether a non-privileged user is granted access based on the dataset
781 permissions defined on the dataset.
784 for more information on ZFS delegated administration.
785 .It Sy failmode Ns = Ns Sy wait Ns | Ns Sy continue Ns | Ns Sy panic
786 Controls the system behavior in the event of catastrophic pool failure.
787 This condition is typically a result of a loss of connectivity to the underlying
788 storage device(s) or a failure of all devices within the pool.
789 The behavior of such an event is determined as follows:
790 .Bl -tag -width "continue"
792 Blocks all I/O access until the device connectivity is recovered and the errors
794 This is the default behavior.
798 to any new write I/O requests but allows reads to any of the remaining healthy
800 Any write requests that have yet to be committed to disk would be blocked.
802 Prints out a message to the console and generates a system crash dump.
804 .It Sy feature@ Ns Ar feature_name Ns = Ns Sy enabled
805 The value of this property is the current state of
807 The only valid value when setting this property is
811 to the enabled state.
814 for details on feature states.
815 .It Sy listsnapshots Ns = Ns Sy on Ns | Ns Sy off
816 Controls whether information about snapshots associated with this pool is
824 This property can also be referred to by its shortened name,
826 .It Sy multihost Ns = Ns Sy on Ns | Ns Sy off
827 Controls whether a pool activity check should be performed during
828 .Nm zpool Cm import .
829 When a pool is determined to be active it cannot be imported, even with the
831 option. This property is intended to be used in failover configurations
832 where multiple hosts have access to a pool on shared storage. When this
833 property is on, periodic writes to storage occur to show the pool is in use.
835 .Sy zfs_multihost_interval
837 .Xr zfs-module-parameters 5
838 man page. In order to enable this property each host must set a unique hostid.
842 .Xr spl-module-parameters 5
843 for additional details. The default value is
845 .It Sy version Ns = Ns Ar version
846 The current on-disk version of the pool.
847 This can be increased, but never decreased.
848 The preferred method of updating pools is with the
850 command, though this property can be used when a specific version is needed for
851 backwards compatibility.
852 Once feature flags are enabled on a pool this property will no longer have a
856 All subcommands that modify state are logged persistently to the pool in their
861 command provides subcommands to create and destroy storage pools, add capacity
862 to storage pools, and provide information about the storage pools.
863 The following subcommands are supported:
869 Displays a help message.
874 .Oo Fl o Ar property Ns = Ns Ar value Oc
877 Adds the specified virtual devices to the given pool.
880 specification is described in the
885 option, and the device checks performed are described in the
892 even if they appear in use or specify a conflicting replication level.
893 Not all devices can be overridden in this manner.
897 GUIDs instead of the normal device names. These GUIDs can be used in place of
898 device names for the zpool detach/offline/remove/replace commands.
900 Display real paths for
902 resolving all symbolic links. This can be used to look up the current block
903 device name regardless of the /dev/disk/ path used to open it.
905 Displays the configuration that would be used without actually adding the
907 The actual pool creation can still fail due to insufficient privileges or
910 Display real paths for
912 instead of only the last component of the path. This can be used in
916 .It Fl o Ar property Ns = Ns Ar value
917 Sets the given pool properties. See the
919 section for a list of valid properties that can be set. The only property
920 supported at the moment is ashift.
926 .Oo Fl o Ar property Ns = Ns Ar value Oc
927 .Ar pool device new_device
933 The existing device cannot be part of a raidz configuration.
936 is not currently part of a mirrored configuration,
938 automatically transforms into a two-way mirror of
944 is part of a two-way mirror, attaching
946 creates a three-way mirror, and so on.
949 begins to resilver immediately.
954 even if its appears to be in use.
955 Not all devices can be overridden in this manner.
956 .It Fl o Ar property Ns = Ns Ar value
957 Sets the given pool properties. See the
959 section for a list of valid properties that can be set. The only property
960 supported at the moment is ashift.
968 Checkpoints the current state of
970 , which can be later restored by
971 .Nm zpool Cm import --rewind-to-checkpoint .
972 The existence of a checkpoint in a pool prohibits the following
981 In addition, it may break reservation boundaries if the pool lacks free
985 command indicates the existence of a checkpoint or the progress of discarding a
986 checkpoint from a pool.
989 command reports how much space the checkpoint takes from the pool.
992 Discards an existing checkpoint from
1001 Clears device errors in a pool.
1002 If no arguments are specified, all device errors within the pool are cleared.
1003 If one or more devices is specified, only those errors associated with the
1004 specified device or devices are cleared.
1009 .Op Fl m Ar mountpoint
1010 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1011 .Oo Fl o Ar feature@feature Ns = Ns Ar value Oc Ns ...
1012 .Oo Fl O Ar file-system-property Ns = Ns Ar value Oc Ns ...
1015 .Ar pool vdev Ns ...
1017 Creates a new storage pool containing the virtual devices specified on the
1019 The pool name must begin with a letter, and can only contain
1020 alphanumeric characters as well as underscore
1036 are reserved, as are names beginning with
1044 specification is described in the
1048 The command verifies that each device specified is accessible and not currently
1049 in use by another subsystem.
1050 There are some uses, such as being currently mounted, or specified as the
1051 dedicated dump device, that prevents a device from ever being used by ZFS.
1052 Other uses, such as having a preexisting UFS file system, can be overridden with
1057 The command also checks that the replication strategy for the pool is
1059 An attempt to combine redundant and non-redundant storage in a single pool, or
1060 to mix disks and files, results in an error unless
1063 The use of differently sized devices within a single raidz or mirror group is
1064 also flagged as an error unless
1070 option is specified, the default mount point is
1072 The mount point must not exist or must be empty, or else the root dataset
1074 This can be overridden with the
1078 By default all supported features are enabled on the new pool unless the
1080 option is specified.
1083 Do not enable any features on the new pool.
1084 Individual features can be enabled by setting their corresponding properties to
1090 .Xr zpool-features 5
1091 for details about feature properties.
1095 even if they appear in use or specify a conflicting replication level.
1096 Not all devices can be overridden in this manner.
1097 .It Fl m Ar mountpoint
1098 Sets the mount point for the root dataset.
1099 The default mount point is
1106 The mount point must be an absolute path,
1110 For more information on dataset mount points, see
1113 Displays the configuration that would be used without actually creating the
1115 The actual pool creation can still fail due to insufficient privileges or
1117 .It Fl o Ar property Ns = Ns Ar value
1118 Sets the given pool properties.
1121 section for a list of valid properties that can be set.
1122 .It Fl o Ar feature@feature Ns = Ns Ar value
1123 Sets the given pool feature. See the
1124 .Xr zpool-features 5
1125 section for a list of valid features that can be set.
1126 Value can be either disabled or enabled.
1127 .It Fl O Ar file-system-property Ns = Ns Ar value
1128 Sets the given file system properties in the root file system of the pool.
1133 for a list of valid properties that can be set.
1136 .Fl o Sy cachefile Ns = Ns Sy none Fl o Sy altroot Ns = Ns Ar root
1138 Sets the in-core pool name to
1140 while the on-disk name will be the name specified as the pool name
1142 This will set the default cachefile property to none. This is intended
1143 to handle name space collisions when creating pools for other systems,
1144 such as virtual machines or physical machines whose pools live on network
1153 Destroys the given pool, freeing up any devices for other use.
1154 This command tries to unmount any active datasets before destroying the pool.
1157 Forces any active datasets contained within the pool to be unmounted.
1167 The operation is refused if there are no other valid replicas of the data.
1168 If device may be re-added to the pool later on then consider the
1174 .Op Fl vHf Oo Ar pool Oc | Fl c
1176 Lists all recent events generated by the ZFS kernel modules. These events
1179 and used to automate administrative tasks such as replacing a failed device
1180 with a hot spare. For more information about the subclasses and event payloads
1181 that can be generated see the
1186 Clear all previous events.
1190 Scripted mode. Do not display headers, and separate fields by a
1191 single tab instead of arbitrary space.
1193 Print the entire payload for each event.
1202 Exports the given pools from the system.
1203 All devices are marked as exported, but are still considered in use by other
1205 The devices can be moved between systems
1206 .Pq even those of different endianness
1207 and imported as long as a sufficient number of devices are present.
1209 Before exporting the pool, all datasets within the pool are unmounted.
1210 A pool can not be exported if it has a shared spare that is currently being
1213 For pools to be portable, you must give the
1215 command whole disks, not just partitions, so that ZFS can label the disks with
1216 portable EFI labels.
1217 Otherwise, disk drivers on platforms of different endianness will not recognize
1221 Exports all pools imported on the system.
1223 Forcefully unmount all datasets, using the
1227 This command will forcefully export the pool even if it has a shared spare that
1228 is currently being used.
1229 This may lead to potential data corruption.
1235 .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
1236 .Sy all Ns | Ns Ar property Ns Oo , Ns Ar property Oc Ns ...
1237 .Oo Ar pool Oc Ns ...
1239 Retrieves the given list of properties
1241 or all properties if
1245 for the specified storage pool(s).
1246 These properties are displayed with the following fields:
1248 name Name of storage pool
1249 property Property name
1250 value Property value
1251 source Property source, either 'default' or 'local'.
1256 section for more information on the available pool properties.
1260 Do not display headers, and separate fields by a single tab instead of arbitrary
1263 A comma-separated list of columns to display.
1264 .Sy name Ns \&, Ns Sy property Ns \&, Ns Sy value Ns \&, Ns Sy source
1265 is the default value.
1267 Display numbers in parsable (exact) values.
1273 .Oo Ar pool Oc Ns ...
1275 Displays the command history of the specified pool(s) or all pools if no pool is
1279 Displays internally logged ZFS events in addition to user initiated events.
1281 Displays log records in long format, which in addition to standard format
1282 includes, the user name, the hostname, and the zone in which the operation was
1289 .Op Fl d Ar dir Ns | Ns device
1291 Lists pools available to import.
1294 option is not specified, this command searches for devices in
1298 option can be specified multiple times, and all directories are searched.
1299 If the device appears to be part of an exported pool, this command displays a
1300 summary of the pool with the name of the pool, a numeric identifier, as well as
1301 the vdev layout and current health of the device for each device or file.
1302 Destroyed pools, pools that were previously destroyed with the
1303 .Nm zpool Cm destroy
1304 command, are not listed unless the
1306 option is specified.
1308 The numeric identifier is unique, and can be used instead of the pool name when
1309 multiple exported pools of the same name are available.
1311 .It Fl c Ar cachefile
1312 Reads configuration from the given
1314 that was created with the
1319 is used instead of searching for devices.
1320 .It Fl d Ar dir Ns | Ns Ar device
1323 or searches for devices or files in
1327 option can be specified multiple times.
1329 Lists destroyed pools only.
1336 .Op Fl F Oo Fl n Oc Oo Fl T Oc Oo Fl X Oc
1337 .Op Fl c Ar cachefile Ns | Ns Fl d Ar dir Ns | Ns device
1339 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1343 Imports all pools found in the search directories.
1344 Identical to the previous command, except that all pools with a sufficient
1345 number of devices available are imported.
1346 Destroyed pools, pools that were previously destroyed with the
1347 .Nm zpool Cm destroy
1348 command, will not be imported unless the
1350 option is specified.
1353 Searches for and imports all pools found.
1354 .It Fl c Ar cachefile
1355 Reads configuration from the given
1357 that was created with the
1362 is used instead of searching for devices.
1363 .It Fl d Ar dir Ns | Ns Ar device
1366 or searches for devices or files in
1370 option can be specified multiple times.
1371 This option is incompatible with the
1375 Imports destroyed pools only.
1378 option is also required.
1380 Forces import, even if the pool appears to be potentially active.
1382 Recovery mode for a non-importable pool.
1383 Attempt to return the pool to an importable state by discarding the last few
1385 Not all damaged pools can be recovered by using this option.
1386 If successful, the data from the discarded transactions is irretrievably lost.
1387 This option is ignored if the pool is importable or already imported.
1389 Indicates that this command will request encryption keys for all encrypted
1390 datasets it attempts to mount as it is bringing the pool online. Note that if
1395 this command will block waiting for the keys to be entered. Without this flag
1396 encrypted datasets will be left unavailable until the keys are loaded.
1398 Allows a pool to import when there is a missing log device.
1399 Recent transactions can be lost because the log device will be discarded.
1404 Determines whether a non-importable pool can be made importable again, but does
1405 not actually perform the pool recovery.
1406 For more details about pool recovery mode, see the
1410 Import the pool without mounting any file systems.
1412 Comma-separated list of mount options to use when mounting datasets within the
1416 for a description of dataset properties and mount options.
1417 .It Fl o Ar property Ns = Ns Ar value
1418 Sets the specified property on the imported pool.
1421 section for more information on the available pool properties.
1431 .It Fl -rewind-to-checkpoint
1432 Rewinds pool to the checkpointed state.
1433 Once the pool is imported with this flag there is no way to undo the rewind.
1434 All changes and data that were written after the checkpoint are lost!
1435 The only exception is when the
1437 mounting option is enabled.
1438 In this case, the checkpointed state of the pool is opened and an
1439 administrator can see how the pool would look like if they were
1442 Scan using the default search path, the libblkid cache will not be
1443 consulted. A custom search path may be specified by setting the
1444 ZPOOL_IMPORT_PATH environment variable.
1448 recovery option. Determines whether extreme
1449 measures to find a valid txg should take place. This allows the pool to
1450 be rolled back to a txg which is no longer guaranteed to be consistent.
1451 Pools imported at an inconsistent txg may contain uncorrectable
1452 checksum errors. For more details about pool recovery mode, see the
1454 option, above. WARNING: This option can be extremely hazardous to the
1455 health of your pool and should only be used as a last resort.
1457 Specify the txg to use for rollback. Implies
1460 about pool recovery mode, see the
1462 option, above. WARNING: This option can be extremely hazardous to the
1463 health of your pool and should only be used as a last resort.
1469 .Op Fl F Oo Fl n Oc Oo Fl t Oc Oo Fl T Oc Oo Fl X Oc
1470 .Op Fl c Ar cachefile Ns | Ns Fl d Ar dir Ns | Ns device
1472 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1475 .Ar pool Ns | Ns Ar id
1478 Imports a specific pool.
1479 A pool can be identified by its name or the numeric identifier.
1482 is specified, the pool is imported using the name
1484 Otherwise, it is imported with the same name as its exported name.
1486 If a device is removed from a system without running
1488 first, the device appears as potentially active.
1489 It cannot be determined if this was a failed export, or whether the device is
1490 really in use from another host.
1491 To import a pool in this state, the
1495 .It Fl c Ar cachefile
1496 Reads configuration from the given
1498 that was created with the
1503 is used instead of searching for devices.
1504 .It Fl d Ar dir Ns | Ns Ar device
1507 or searches for devices or files in
1511 option can be specified multiple times.
1512 This option is incompatible with the
1516 Imports destroyed pool.
1519 option is also required.
1521 Forces import, even if the pool appears to be potentially active.
1523 Recovery mode for a non-importable pool.
1524 Attempt to return the pool to an importable state by discarding the last few
1526 Not all damaged pools can be recovered by using this option.
1527 If successful, the data from the discarded transactions is irretrievably lost.
1528 This option is ignored if the pool is importable or already imported.
1530 Indicates that this command will request encryption keys for all encrypted
1531 datasets it attempts to mount as it is bringing the pool online. Note that if
1536 this command will block waiting for the keys to be entered. Without this flag
1537 encrypted datasets will be left unavailable until the keys are loaded.
1539 Allows a pool to import when there is a missing log device.
1540 Recent transactions can be lost because the log device will be discarded.
1545 Determines whether a non-importable pool can be made importable again, but does
1546 not actually perform the pool recovery.
1547 For more details about pool recovery mode, see the
1551 Comma-separated list of mount options to use when mounting datasets within the
1555 for a description of dataset properties and mount options.
1556 .It Fl o Ar property Ns = Ns Ar value
1557 Sets the specified property on the imported pool.
1560 section for more information on the available pool properties.
1571 Scan using the default search path, the libblkid cache will not be
1572 consulted. A custom search path may be specified by setting the
1573 ZPOOL_IMPORT_PATH environment variable.
1577 recovery option. Determines whether extreme
1578 measures to find a valid txg should take place. This allows the pool to
1579 be rolled back to a txg which is no longer guaranteed to be consistent.
1580 Pools imported at an inconsistent txg may contain uncorrectable
1581 checksum errors. For more details about pool recovery mode, see the
1583 option, above. WARNING: This option can be extremely hazardous to the
1584 health of your pool and should only be used as a last resort.
1586 Specify the txg to use for rollback. Implies
1589 about pool recovery mode, see the
1591 option, above. WARNING: This option can be extremely hazardous to the
1592 health of your pool and should only be used as a last resort.
1598 is temporary. Temporary pool names last until export. Ensures that
1599 the original pool name will be used in all label updates and therefore
1600 is retained upon export.
1601 Will also set -o cachefile=none when not explicitly specified.
1608 .Op Ar device Ns ...
1610 Begins initializing by writing to all unallocated regions on the specified
1611 devices, or all eligible devices in the pool if no individual devices are
1613 Only leaf data or log devices may be initialized.
1616 Cancel initializing on the specified devices, or all eligible devices if none
1618 If one or more target devices are invalid or are not currently being
1619 initialized, the command will fail and no cancellation will occur on any device.
1621 Suspend initializing on the specified devices, or all eligible devices if none
1623 If one or more target devices are invalid or are not currently being
1624 initialized, the command will fail and no suspension will occur on any device.
1625 Initializing can then be resumed by running
1626 .Nm zpool Cm initialize
1627 with no flags on the relevant target devices.
1632 .Op Oo Oo Fl c Ar SCRIPT Oc Oo Fl lq Oc Oc Ns | Ns Fl rw
1633 .Op Fl T Sy u Ns | Ns Sy d
1635 .Oo Oo Ar pool Ns ... Oc Ns | Ns Oo Ar pool vdev Ns ... Oc Ns | Ns Oo Ar vdev Ns ... Oc Oc
1636 .Op Ar interval Op Ar count
1638 Displays I/O statistics for the given pools/vdevs. You can pass in a
1639 list of pools, a pool and list of vdevs in that pool, or a list of any
1640 vdevs from any pool. If no items are specified, statistics for every
1641 pool in the system are shown.
1644 the statistics are printed every
1646 seconds until ^C is pressed. If
1648 flag is specified the headers are displayed only once, otherwise they are
1649 displayed periodically. If count is specified, the command exits
1650 after count reports are printed. The first report printed is always
1651 the statistics since boot regardless of whether
1655 are passed. However, this behavior can be suppressed with the
1657 flag. Also note that the units of
1661 that are printed in the report are in base 1024. To get the raw
1666 .It Fl c Op Ar SCRIPT1 Ns Oo , Ns Ar SCRIPT2 Oc Ns ...
1667 Run a script (or scripts) on each vdev and include the output as a new column
1670 output. Users can run any script found in their
1672 directory or from the system
1673 .Pa /etc/zfs/zpool.d
1674 directory. Script names containing the slash (/) character are not allowed.
1675 The default search path can be overridden by setting the
1676 ZPOOL_SCRIPTS_PATH environment variable. A privileged user can run
1678 if they have the ZPOOL_SCRIPTS_AS_ROOT
1679 environment variable set. If a script requires the use of a privileged
1682 then it's recommended you allow the user access to it in
1684 or add the user to the
1685 .Pa /etc/sudoers.d/zfs
1690 is passed without a script name, it prints a list of all scripts.
1692 also sets verbose mode
1693 .No \&( Ns Fl v Ns No \&).
1695 Script output should be in the form of "name=value". The column name is
1696 set to "name" and the value is set to "value". Multiple lines can be
1697 used to output multiple columns. The first line of output not in the
1698 "name=value" format is displayed without a column title, and no more
1699 output after that is displayed. This can be useful for printing error
1700 messages. Blank or NULL values are printed as a '-' to make output
1703 The following environment variables are set before running each script:
1704 .Bl -tag -width "VDEV_PATH"
1706 Full path to the vdev
1708 .Bl -tag -width "VDEV_UPATH"
1710 Underlying path to the vdev (/dev/sd*). For use with device mapper,
1711 multipath, or partitioned vdevs.
1713 .Bl -tag -width "VDEV_ENC_SYSFS_PATH"
1714 .It Sy VDEV_ENC_SYSFS_PATH
1715 The sysfs path to the enclosure for the vdev (if any).
1717 .It Fl T Sy u Ns | Ns Sy d
1718 Display a time stamp.
1721 for a printed representation of the internal representation of time.
1726 for standard date format.
1730 Display vdev GUIDs instead of the normal device names. These GUIDs
1731 can be used in place of device names for the zpool
1732 detach/offline/remove/replace commands.
1734 Scripted mode. Do not display headers, and separate fields by a
1735 single tab instead of arbitrary space.
1737 Display real paths for vdevs resolving all symbolic links. This can
1738 be used to look up the current block device name regardless of the
1740 path used to open it.
1742 Print headers only once when passed
1744 Display numbers in parsable (exact) values. Time values are in
1747 Display full paths for vdevs instead of only the last component of
1748 the path. This can be used in conjunction with the
1752 Print request size histograms for the leaf ZIOs. This includes
1753 histograms of individual ZIOs (
1755 and aggregate ZIOs (
1757 These stats can be useful for seeing how well the ZFS IO aggregator is
1758 working. Do not confuse these request size stats with the block layer
1759 requests; it's possible ZIOs can be broken up before being sent to the
1762 Verbose statistics Reports usage statistics for individual vdevs within the
1763 pool, in addition to the pool-wide statistics.
1765 Omit statistics since boot.
1766 Normally the first line of output reports the statistics since boot.
1767 This option suppresses that first line of output.
1770 Display latency histograms:
1773 Total IO time (queuing + disk IO time).
1775 Disk IO time (time reading/writing the disk).
1777 Amount of time IO spent in synchronous priority queues. Does not include
1780 Amount of time IO spent in asynchronous priority queues. Does not include
1783 Amount of time IO spent in scrub queue. Does not include disk time.
1785 Include average latency statistics:
1788 Average total IO time (queuing + disk IO time).
1790 Average disk IO time (time reading/writing the disk).
1792 Average amount of time IO spent in synchronous priority queues. Does
1793 not include disk time.
1795 Average amount of time IO spent in asynchronous priority queues.
1796 Does not include disk time.
1798 Average queuing time in scrub queue. Does not include disk time.
1800 Include active queue statistics. Each priority queue has both
1805 IOs. Pending IOs are waiting to
1806 be issued to the disk, and active IOs have been issued to disk and are
1807 waiting for completion. These stats are broken out by priority queue:
1809 .Ar syncq_read/write :
1810 Current number of entries in synchronous priority
1812 .Ar asyncq_read/write :
1813 Current number of entries in asynchronous priority queues.
1815 Current number of entries in scrub queue.
1817 All queue statistics are instantaneous measurements of the number of
1818 entries in the queues. If you specify an interval, the measurements
1819 will be sampled from the end of the interval.
1827 Removes ZFS label information from the specified
1831 must not be part of an active pool configuration.
1834 Treat exported or foreign devices as inactive.
1840 .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
1841 .Op Fl T Sy u Ns | Ns Sy d
1842 .Oo Ar pool Oc Ns ...
1843 .Op Ar interval Op Ar count
1845 Lists the given pools along with a health status and space usage.
1848 are specified, all pools in the system are listed.
1851 the information is printed every
1853 seconds until ^C is pressed.
1856 is specified, the command exits after
1858 reports are printed.
1861 Display vdev GUIDs instead of the normal device names. These GUIDs
1862 can be used in place of device names for the zpool
1863 detach/offline/remove/replace commands.
1866 Do not display headers, and separate fields by a single tab instead of arbitrary
1868 .It Fl o Ar property
1869 Comma-separated list of properties to display.
1872 section for a list of valid properties.
1874 .Cm name , size , allocated , free , checkpoint, expandsize , fragmentation ,
1875 .Cm capacity , dedupratio , health , altroot .
1877 Display real paths for vdevs resolving all symbolic links. This can
1878 be used to look up the current block device name regardless of the
1879 /dev/disk/ path used to open it.
1881 Display numbers in parsable
1885 Display full paths for vdevs instead of only the last component of
1886 the path. This can be used in conjunction with the
1889 .It Fl T Sy u Ns | Ns Sy d
1890 Display a time stamp.
1893 for a printed representation of the internal representation of time.
1898 for standard date format.
1903 Reports usage statistics for individual vdevs within the pool, in addition to
1904 the pool-wise statistics.
1911 .Ar pool Ar device Ns ...
1913 Takes the specified physical device offline.
1916 is offline, no attempt is made to read or write to the device.
1917 This command is not applicable to spares.
1920 Force fault. Instead of offlining the disk, put it into a faulted
1921 state. The fault will persist across imports unless the
1926 Upon reboot, the specified physical device reverts to its previous state.
1932 .Ar pool Ar device Ns ...
1934 Brings the specified physical device online.
1935 This command is not applicable to spares.
1938 Expand the device to use all available space.
1939 If the device is part of a mirror or raidz then all devices must be expanded
1940 before the new space will become available to the pool.
1947 Generates a new unique identifier for the pool.
1948 You must ensure that all devices in this pool are online and healthy before
1949 performing this action.
1956 Reopen all the vdevs associated with the pool.
1959 Do not restart an in-progress scrub operation. This is not recommended and can
1960 result in partially resilvered devices unless a second scrub is performed.
1966 .Ar pool Ar device Ns ...
1968 Removes the specified device from the pool.
1969 This command supports removing hot spare, cache, log, and both mirrored and
1970 non-redundant primary top-level vdevs, including dedup and special vdevs.
1971 When the primary pool storage includes a top-level raidz vdev only hot spare,
1972 cache, and log devices can be removed.
1974 Removing a top-level vdev reduces the total amount of space in the storage pool.
1975 The specified device will be evacuated by copying all allocated space from it to
1976 the other devices in the pool.
1979 command initiates the removal and returns, while the evacuation continues in
1981 The removal progress can be monitored with
1982 .Nm zpool Cm status .
1983 If an IO error is encountered during the removal process it will be
1986 feature flag must be enabled to remove a top-level vdev, see
1987 .Xr zpool-features 5 .
1989 A mirrored top-level device (log or data) can be removed by specifying the top-level mirror for the
1991 Non-log devices or data devices that are part of a mirrored configuration can be removed using
1997 Do not actually perform the removal ("no-op").
1998 Instead, print the estimated amount of memory that will be used by the
1999 mapping table after the removal completes.
2000 This is nonzero only for top-level vdevs.
2004 Used in conjunction with the
2006 flag, displays numbers as parsable (exact) values.
2014 Stops and cancels an in-progress removal of a top-level vdev.
2019 .Op Fl o Ar property Ns = Ns Ar value
2020 .Ar pool Ar device Op Ar new_device
2026 This is equivalent to attaching
2028 waiting for it to resilver, and then detaching
2033 must be greater than or equal to the minimum size of all the devices in a mirror
2034 or raidz configuration.
2037 is required if the pool is not redundant.
2040 is not specified, it defaults to
2042 This form of replacement is useful after an existing disk has failed and has
2043 been physically replaced.
2044 In this case, the new disk may have the same
2046 path as the old device, even though it is actually a different disk.
2047 ZFS recognizes this.
2052 even if its appears to be in use.
2053 Not all devices can be overridden in this manner.
2054 .It Fl o Ar property Ns = Ns Ar value
2055 Sets the given pool properties. See the
2057 section for a list of valid properties that can be set.
2058 The only property supported at the moment is
2067 Begins a scrub or resumes a paused scrub.
2068 The scrub examines all data in the specified pools to verify that it checksums
2072 devices, ZFS automatically repairs any damage discovered during the scrub.
2075 command reports the progress of the scrub and summarizes the results of the
2076 scrub upon completion.
2078 Scrubbing and resilvering are very similar operations.
2079 The difference is that resilvering only examines data that ZFS knows to be out
2082 for example, when attaching a new device to a mirror or replacing an existing
2085 whereas scrubbing examines all data to discover silent errors due to hardware
2086 faults or disk failure.
2088 Because scrubbing and resilvering are I/O-intensive operations, ZFS only allows
2090 If a scrub is paused, the
2093 If a resilver is in progress, ZFS does not allow a scrub to be started until the
2102 Scrub pause state and progress are periodically synced to disk.
2103 If the system is restarted or pool is exported during a paused scrub,
2104 even after import, scrub will remain paused until it is resumed.
2105 Once resumed the scrub will pick up from the place where it was last
2106 checkpointed to disk.
2107 To resume a paused scrub issue
2116 Starts a resilver. If an existing resilver is already running it will be
2117 restarted from the beginning. Any drives that were scheduled for a deferred
2118 resilver will be added to the new one.
2122 .Ar property Ns = Ns Ar value
2125 Sets the given property on the specified pool.
2128 section for more information on what properties can be set and acceptable
2134 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
2145 must be mirrors and the pool must not be in the process of resilvering.
2146 At the time of the split,
2148 will be a replica of
2151 last device in each mirror is split from
2156 The optional device specification causes the specified device(s) to be
2159 and, should any devices remain unspecified,
2160 the last device in each mirror is used as would be by default.
2163 Display vdev GUIDs instead of the normal device names. These GUIDs
2164 can be used in place of device names for the zpool
2165 detach/offline/remove/replace commands.
2167 Display real paths for vdevs resolving all symbolic links. This can
2168 be used to look up the current block device name regardless of the
2170 path used to open it.
2172 Indicates that this command will request encryption keys for all encrypted
2173 datasets it attempts to mount as it is bringing the new pool online. Note that
2174 if any datasets have a
2178 this command will block waiting for the keys to be entered. Without this flag
2179 encrypted datasets will be left unavailable until the keys are loaded.
2181 Do dry run, do not actually perform the split.
2182 Print out the expected configuration of
2185 Display full paths for vdevs instead of only the last component of
2186 the path. This can be used in conjunction with the
2189 .It Fl o Ar property Ns = Ns Ar value
2190 Sets the specified property for
2194 section for more information on the available pool properties.
2202 and automatically import it.
2207 .Op Fl c Op Ar SCRIPT1 Ns Oo , Ns Ar SCRIPT2 Oc Ns ...
2209 .Op Fl T Sy u Ns | Ns Sy d
2210 .Oo Ar pool Oc Ns ...
2211 .Op Ar interval Op Ar count
2213 Displays the detailed health status for the given pools.
2216 is specified, then the status of each pool in the system is displayed.
2217 For more information on pool and device health, see the
2218 .Sx Device Failure and Recovery
2221 If a scrub or resilver is in progress, this command reports the percentage done
2222 and the estimated time to completion.
2223 Both of these are only approximate, because the amount of data in the pool and
2224 the other workloads on the system can change.
2226 .It Fl c Op Ar SCRIPT1 Ns Oo , Ns Ar SCRIPT2 Oc Ns ...
2227 Run a script (or scripts) on each vdev and include the output as a new column
2234 for complete details.
2236 Display vdev initialization status.
2238 Display vdev GUIDs instead of the normal device names. These GUIDs
2239 can be used in place of device names for the zpool
2240 detach/offline/remove/replace commands.
2242 Display real paths for vdevs resolving all symbolic links. This can
2243 be used to look up the current block device name regardless of the
2245 path used to open it.
2247 Display numbers in parsable (exact) values.
2249 Display full paths for vdevs instead of only the last component of
2250 the path. This can be used in conjunction with the
2254 Display a histogram of deduplication statistics, showing the allocated
2255 .Pq physically present on disk
2257 .Pq logically referenced in the pool
2258 block counts and sizes by reference count.
2260 Display the number of leaf VDEV slow IOs. This is the number of IOs that
2261 didn't complete in \fBzio_slow_io_ms\fR milliseconds (default 30 seconds).
2262 This does not necessarily mean the IOs failed to complete, just took an
2263 unreasonably long amount of time. This may indicate a problem with the
2265 .It Fl T Sy u Ns | Ns Sy d
2266 Display a time stamp.
2269 for a printed representation of the internal representation of time.
2274 for standard date format.
2278 Displays verbose data error information, printing out a complete list of all
2279 data errors since the last complete pool scrub.
2281 Only display status for pools that are exhibiting errors or are otherwise
2283 Warnings about pools not using the latest on-disk format will not be included.
2290 This command forces all in-core dirty data to be written to the primary
2291 pool storage and not the ZIL. It will also update administrative
2292 information including quota reporting. Without arguments,
2294 will sync all pools on the system. Otherwise, it will sync only the
2300 Displays pools which do not have all supported features enabled and pools
2301 formatted using a legacy ZFS version number.
2302 These pools can continue to be used, but some features may not be available.
2304 .Nm zpool Cm upgrade Fl a
2305 to enable all features on all pools.
2311 Displays legacy ZFS versions supported by the current software.
2313 .Xr zpool-features 5
2314 for a description of feature flags features supported by the current software.
2319 .Fl a Ns | Ns Ar pool Ns ...
2321 Enables all supported features on the given pool.
2322 Once this is done, the pool will no longer be accessible on systems that do not
2323 support feature flags.
2325 .Xr zpool-features 5
2326 for details on compatibility with systems that support feature flags, but do not
2327 support all features enabled on the pool.
2330 Enables all supported features on all pools.
2332 Upgrade to the specified legacy version.
2335 flag is specified, no features will be enabled on the pool.
2336 This option can only be used to increase the version number up to the last
2337 supported legacy version number.
2341 The following exit values are returned:
2344 Successful completion.
2348 Invalid command line options were specified.
2352 .It Sy Example 1 No Creating a RAID-Z Storage Pool
2353 The following command creates a pool with a single raidz root vdev that
2354 consists of six disks.
2356 # zpool create tank raidz sda sdb sdc sdd sde sdf
2358 .It Sy Example 2 No Creating a Mirrored Storage Pool
2359 The following command creates a pool with two mirrors, where each mirror
2362 # zpool create tank mirror sda sdb mirror sdc sdd
2364 .It Sy Example 3 No Creating a ZFS Storage Pool by Using Partitions
2365 The following command creates an unmirrored pool using two disk partitions.
2367 # zpool create tank sda1 sdb2
2369 .It Sy Example 4 No Creating a ZFS Storage Pool by Using Files
2370 The following command creates an unmirrored pool using files.
2371 While not recommended, a pool based on files can be useful for experimental
2374 # zpool create tank /path/to/file/a /path/to/file/b
2376 .It Sy Example 5 No Adding a Mirror to a ZFS Storage Pool
2377 The following command adds two mirrored disks to the pool
2379 assuming the pool is already made up of two-way mirrors.
2380 The additional space is immediately available to any datasets within the pool.
2382 # zpool add tank mirror sda sdb
2384 .It Sy Example 6 No Listing Available ZFS Storage Pools
2385 The following command lists all available pools on the system.
2386 In this case, the pool
2388 is faulted due to a missing device.
2389 The results from this command are similar to the following:
2392 NAME SIZE ALLOC FREE EXPANDSZ FRAG CAP DEDUP HEALTH ALTROOT
2393 rpool 19.9G 8.43G 11.4G - 33% 42% 1.00x ONLINE -
2394 tank 61.5G 20.0G 41.5G - 48% 32% 1.00x ONLINE -
2395 zion - - - - - - - FAULTED -
2397 .It Sy Example 7 No Destroying a ZFS Storage Pool
2398 The following command destroys the pool
2400 and any datasets contained within.
2402 # zpool destroy -f tank
2404 .It Sy Example 8 No Exporting a ZFS Storage Pool
2405 The following command exports the devices in pool
2407 so that they can be relocated or later imported.
2411 .It Sy Example 9 No Importing a ZFS Storage Pool
2412 The following command displays available pools, and then imports the pool
2414 for use on the system.
2415 The results from this command are similar to the following:
2419 id: 15451357997522795478
2421 action: The pool can be imported using its name or numeric identifier.
2431 .It Sy Example 10 No Upgrading All ZFS Storage Pools to the Current Version
2432 The following command upgrades all ZFS Storage pools to the current version of
2436 This system is currently running ZFS version 2.
2438 .It Sy Example 11 No Managing Hot Spares
2439 The following command creates a new pool with an available hot spare:
2441 # zpool create tank mirror sda sdb spare sdc
2444 If one of the disks were to fail, the pool would be reduced to the degraded
2446 The failed device can be replaced using the following command:
2448 # zpool replace tank sda sdd
2451 Once the data has been resilvered, the spare is automatically removed and is
2452 made available for use should another device fail.
2453 The hot spare can be permanently removed from the pool using the following
2456 # zpool remove tank sdc
2458 .It Sy Example 12 No Creating a ZFS Pool with Mirrored Separate Intent Logs
2459 The following command creates a ZFS storage pool consisting of two, two-way
2460 mirrors and mirrored log devices:
2462 # zpool create pool mirror sda sdb mirror sdc sdd log mirror \\
2465 .It Sy Example 13 No Adding Cache Devices to a ZFS Pool
2466 The following command adds two disks for use as cache devices to a ZFS storage
2469 # zpool add pool cache sdc sdd
2472 Once added, the cache devices gradually fill with content from main memory.
2473 Depending on the size of your cache devices, it could take over an hour for
2475 Capacity and reads can be monitored using the
2479 # zpool iostat -v pool 5
2481 .It Sy Example 14 No Removing a Mirrored top-level (Log or Data) Device
2482 The following commands remove the mirrored log device
2484 and mirrored top-level data device
2487 Given this configuration:
2491 scrub: none requested
2494 NAME STATE READ WRITE CKSUM
2496 mirror-0 ONLINE 0 0 0
2499 mirror-1 ONLINE 0 0 0
2503 mirror-2 ONLINE 0 0 0
2508 The command to remove the mirrored log
2512 # zpool remove tank mirror-2
2515 The command to remove the mirrored data
2519 # zpool remove tank mirror-1
2521 .It Sy Example 15 No Displaying expanded space on a device
2522 The following command displays the detailed information for the pool
2524 This pool is comprised of a single raidz vdev where one of its devices
2525 increased its capacity by 10GB.
2526 In this example, the pool will not be able to utilize this extra capacity until
2527 all the devices under the raidz vdev have been expanded.
2529 # zpool list -v data
2530 NAME SIZE ALLOC FREE EXPANDSZ FRAG CAP DEDUP HEALTH ALTROOT
2531 data 23.9G 14.6G 9.30G - 48% 61% 1.00x ONLINE -
2532 raidz1 23.9G 14.6G 9.30G - 48%
2537 .It Sy Example 16 No Adding output columns
2538 Additional columns can be added to the
2546 # zpool status -c vendor,model,size
2547 NAME STATE READ WRITE CKSUM vendor model size
2549 mirror-0 ONLINE 0 0 0
2550 U1 ONLINE 0 0 0 SEAGATE ST8000NM0075 7.3T
2551 U10 ONLINE 0 0 0 SEAGATE ST8000NM0075 7.3T
2552 U11 ONLINE 0 0 0 SEAGATE ST8000NM0075 7.3T
2553 U12 ONLINE 0 0 0 SEAGATE ST8000NM0075 7.3T
2554 U13 ONLINE 0 0 0 SEAGATE ST8000NM0075 7.3T
2555 U14 ONLINE 0 0 0 SEAGATE ST8000NM0075 7.3T
2557 # zpool iostat -vc slaves
2558 capacity operations bandwidth
2559 pool alloc free read write read write slaves
2560 ---------- ----- ----- ----- ----- ----- ----- ---------
2561 tank 20.4G 7.23T 26 152 20.7M 21.6M
2562 mirror 20.4G 7.23T 26 152 20.7M 21.6M
2563 U1 - - 0 31 1.46K 20.6M sdb sdff
2564 U10 - - 0 1 3.77K 13.3K sdas sdgw
2565 U11 - - 0 1 288K 13.3K sdat sdgx
2566 U12 - - 0 1 78.4K 13.3K sdau sdgy
2567 U13 - - 0 1 128K 13.3K sdav sdgz
2568 U14 - - 0 1 63.2K 13.3K sdfk sdg
2571 .Sh ENVIRONMENT VARIABLES
2572 .Bl -tag -width "ZFS_ABORT"
2576 to dump core on exit for the purposes of running
2579 .Bl -tag -width "ZPOOL_IMPORT_PATH"
2580 .It Ev ZPOOL_IMPORT_PATH
2581 The search path for devices or files to use with the pool. This is a colon-separated list of directories in which
2583 looks for device nodes and files.
2589 .Bl -tag -width "ZPOOL_VDEV_NAME_GUID"
2590 .It Ev ZPOOL_VDEV_NAME_GUID
2592 .Nm zpool subcommands to output vdev guids by default. This behavior
2595 command line option.
2597 .Bl -tag -width "ZPOOL_VDEV_NAME_FOLLOW_LINKS"
2598 .It Ev ZPOOL_VDEV_NAME_FOLLOW_LINKS
2601 subcommands to follow links for vdev names by default. This behavior is identical to the
2603 command line option.
2605 .Bl -tag -width "ZPOOL_VDEV_NAME_PATH"
2606 .It Ev ZPOOL_VDEV_NAME_PATH
2609 subcommands to output full vdev path names by default. This
2610 behavior is identical to the
2612 command line option.
2614 .Bl -tag -width "ZFS_VDEV_DEVID_OPT_OUT"
2615 .It Ev ZFS_VDEV_DEVID_OPT_OUT
2616 Older ZFS on Linux implementations had issues when attempting to display pool
2617 config VDEV names if a
2619 NVP value is present in the pool's config.
2621 For example, a pool that originated on illumos platform would have a devid
2622 value in the config and
2624 would fail when listing the config.
2625 This would also be true for future Linux based pools.
2627 A pool can be stripped of any
2629 values on import or prevented from adding
2635 .Sy ZFS_VDEV_DEVID_OPT_OUT .
2637 .Bl -tag -width "ZPOOL_SCRIPTS_AS_ROOT"
2638 .It Ev ZPOOL_SCRIPTS_AS_ROOT
2639 Allow a privileged user to run the
2640 .Nm zpool status/iostat
2643 option. Normally, only unprivileged users are allowed to run
2646 .Bl -tag -width "ZPOOL_SCRIPTS_PATH"
2647 .It Ev ZPOOL_SCRIPTS_PATH
2648 The search path for scripts when running
2649 .Nm zpool status/iostat
2652 option. This is a colon-separated list of directories and overrides the default
2655 .Pa /etc/zfs/zpool.d
2658 .Bl -tag -width "ZPOOL_SCRIPTS_ENABLED"
2659 .It Ev ZPOOL_SCRIPTS_ENABLED
2661 .Nm zpool status/iostat
2665 .Sy ZPOOL_SCRIPTS_ENABLED
2666 is not set, it is assumed that the user is allowed to run
2667 .Nm zpool status/iostat -c .
2669 .Sh INTERFACE STABILITY
2673 .Xr zfs-module-parameters 5 ,
2674 .Xr zpool-features 5 ,
projects / mirror_zfs.git / blob