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
207 storage pools. A storage pool is a collection of devices that provides physical
208 storage and data replication for
212 All datasets within a storage pool share the same space. See
214 for information on managing datasets.
215 .Ss Virtual Devices (vdevs)
219 describes a single device or a collection of devices organized according to
220 certain performance and fault characteristics. The following virtual devices
222 .Bl -tag -width "XXXXXX"
224 A block device, typically located under
227 can use individual slices or partitions, though the recommended mode of
228 operation is to use whole disks. A disk can be specified by a full path to the
231 provider name. When given a whole disk,
233 automatically labels the disk, if necessary.
235 A regular file. The use of files as a backing store is strongly discouraged. It
236 is designed primarily for experimental purposes, as the fault tolerance of a
237 file is only as good the file system of which it is a part. A file must be
238 specified by a full path.
240 A mirror of two or more devices. Data is replicated in an identical fashion
241 across all components of a mirror. A mirror with
247 bytes and can withstand
249 devices failing before data integrity is compromised.
252 .Sy raidz1 raidz2 raidz3 ) .
255 that allows for better distribution of parity and eliminates the
257 write hole (in which data and parity become inconsistent after a power loss).
258 Data and parity is striped across all disks within a
264 group can have single-, double- , or triple parity, meaning that the
266 group can sustain one, two, or three failures, respectively, without
269 type specifies a single-parity
273 type specifies a double-parity
277 type specifies a triple-parity
292 parity disks can hold approximately
297 bytes and can withstand
299 device(s) failing before data integrity is compromised. The minimum number of
302 group is one more than the number of parity disks. The
303 recommended number is between 3 and 9 to help increase performance.
306 .No pseudo- Ns No vdev
307 which keeps track of available hot spares for a pool.
308 For more information, see the
312 A separate-intent log device. If more than one log device is specified, then
313 writes are load-balanced between devices. Log devices can be mirrored. However,
316 types are not supported for the intent log. For more information,
321 A device used to cache storage pool data. A cache device cannot be configured
324 group. For more information, see the
329 Virtual devices cannot be nested, so a mirror or
331 virtual device can only
332 contain files or disks. Mirrors of mirrors (or other combinations) are not
335 A pool can have any number of virtual devices at the top of the configuration
339 Data is dynamically distributed across all top-level devices to balance data
340 among devices. As new virtual devices are added,
342 automatically places data on the newly available devices.
344 Virtual devices are specified one at a time on the command line, separated by
345 whitespace. The keywords
349 are used to distinguish where a group ends and another begins. For example, the
350 following creates two root
352 each a mirror of two disks:
353 .Bd -literal -offset 2n
354 .Li # Ic zpool create mypool mirror da0 da1 mirror da2 da3
356 .Ss Device Failure and Recovery
358 supports a rich set of mechanisms for handling device failure and data
359 corruption. All metadata and data is checksummed, and
361 automatically repairs bad data from a good copy when corruption is detected.
363 In order to take advantage of these features, a pool must make use of some form
364 of redundancy, using either mirrored or
368 supports running in a non-redundant configuration, where each root
370 is simply a disk or file, this is strongly discouraged. A single case of bit
371 corruption can render some or all of your data unavailable.
373 A pool's health status is described by one of three states: online, degraded,
374 or faulted. An online pool has all devices operating normally. A degraded pool
375 is one in which one or more devices have failed, but the data is still
376 available due to a redundant configuration. A faulted pool has corrupted
377 metadata, or one or more faulted devices, and insufficient replicas to continue
380 The health of the top-level
385 potentially impacted by the state of its associated
387 or component devices. A top-level
389 or component device is in one of the following states:
390 .Bl -tag -width "DEGRADED"
392 One or more top-level
394 is in the degraded state because one or more
395 component devices are offline. Sufficient replicas exist to continue
398 One or more component devices is in the degraded or faulted state, but
399 sufficient replicas exist to continue functioning. The underlying conditions
401 .Bl -bullet -offset 2n
403 The number of checksum errors exceeds acceptable levels and the device is
404 degraded as an indication that something may be wrong.
406 continues to use the device as necessary.
410 errors exceeds acceptable levels. The device could not be
411 marked as faulted because there are insufficient replicas to continue
415 One or more top-level
417 is in the faulted state because one or more
418 component devices are offline. Insufficient replicas exist to continue
421 One or more component devices is in the faulted state, and insufficient
422 replicas exist to continue functioning. The underlying conditions are as
424 .Bl -bullet -offset 2n
426 The device could be opened, but the contents did not match expected values.
430 errors exceeds acceptable levels and the device is faulted to
431 prevent further use of the device.
434 The device was explicitly taken offline by the
438 The device is online and functioning.
440 The device was physically removed while the system was running. Device removal
441 detection is hardware-dependent and may not be supported on all platforms.
443 The device could not be opened. If a pool is imported when a device was
444 unavailable, then the device will be identified by a unique identifier instead
445 of its path since the path was never correct in the first place.
448 If a device is removed and later reattached to the system,
450 attempts to put the device online automatically. Device attach detection is
451 hardware-dependent and might not be supported on all platforms.
454 allows devices to be associated with pools as
456 These devices are not actively used in the pool, but when an active device
457 fails, it is automatically replaced by a hot spare. To create a pool with hot
461 with any number of devices. For example,
462 .Bd -literal -offset 2n
463 .Li # Ic zpool create pool mirror da0 da1 spare da2 da3
466 Spares can be shared across multiple pools, and can be added with the
468 command and removed with the
470 command. Once a spare replacement is initiated, a new "spare"
473 within the configuration that will remain there until the original device is
474 replaced. At this point, the hot spare becomes available again if another
477 If a pool has a shared spare that is currently being used, the pool can not be
478 exported since other pools may use this shared spare, which may lead to
479 potential data corruption.
481 An in-progress spare replacement can be cancelled by detaching the hot spare.
482 If the original faulted device is detached, then the hot spare assumes its
483 place in the configuration, and is removed from the spare list of all active
486 Spares cannot replace log devices.
488 This feature requires a userland helper.
492 It must be manually enabled by adding
493 .Va zfsd_enable="YES"
503 requirements for synchronous transactions. For instance, databases often
504 require their transactions to be on stable storage devices when returning from
507 and other applications can also use
509 to ensure data stability. By default, the intent log is allocated from blocks
510 within the main pool. However, it might be possible to get better performance
511 using separate intent log devices such as
513 or a dedicated disk. For example:
514 .Bd -literal -offset 2n
515 .Li # Ic zpool create pool da0 da1 log da2
518 Multiple log devices can also be specified, and they can be mirrored. See the
520 section for an example of mirroring multiple log devices.
522 Log devices can be added, replaced, attached, detached, imported and exported
523 as part of the larger pool.
524 Mirrored devices can be removed by specifying the top-level mirror vdev.
526 Devices can be added to a storage pool as "cache devices." These devices
527 provide an additional layer of caching between main memory and disk. For
528 read-heavy workloads, where the working set size is much larger than what can
529 be cached in main memory, using cache devices allow much more of this working
530 set to be served from low latency media. Using cache devices provides the
531 greatest performance improvement for random read-workloads of mostly static
534 To create a pool with cache devices, specify a "cache"
536 with any number of devices. For example:
537 .Bd -literal -offset 2n
538 .Li # Ic zpool create pool da0 da1 cache da2 da3
541 Cache devices cannot be mirrored or part of a
543 configuration. If a read
544 error is encountered on a cache device, that read
546 is reissued to the original storage pool device, which might be part of a
551 The content of the cache devices is considered volatile, as is the case with
554 Before starting critical procedures that include destructive actions (e.g
556 ), an administrator can checkpoint the pool's state and in the case of a
557 mistake or failure, rewind the entire pool back to the checkpoint.
558 Otherwise, the checkpoint can be discarded when the procedure has completed
561 A pool checkpoint can be thought of as a pool-wide snapshot and should be used
562 with care as it contains every part of the pool's state, from properties to vdev
564 Thus, while a pool has a checkpoint certain operations are not allowed.
565 Specifically, vdev removal/attach/detach, mirror splitting, and
566 changing the pool's guid.
567 Adding a new vdev is supported but in the case of a rewind it will have to be
569 Finally, users of this feature should keep in mind that scrubs in a pool that
570 has a checkpoint do not repair checkpointed data.
572 To create a checkpoint for a pool:
574 # zpool checkpoint pool
577 To later rewind to its checkpointed state, you need to first export it and
578 then rewind it during import:
581 # zpool import --rewind-to-checkpoint pool
584 To discard the checkpoint from a pool:
586 # zpool checkpoint -d pool
589 Dataset reservations (controlled by the
593 zfs properties) may be unenforceable while a checkpoint exists, because the
594 checkpoint is allowed to consume the dataset's reservation.
595 Finally, data that is part of the checkpoint but has been freed in the
596 current state of the pool won't be scanned during a scrub.
598 Each pool has several properties associated with it. Some properties are
599 read-only statistics while others are configurable and change the behavior of
600 the pool. The following are read-only properties:
601 .Bl -tag -width "dedupratio"
603 Amount of storage space within the pool that has been physically allocated.
605 Percentage of pool space used. This property can also be referred to by its
606 shortened column name, "cap".
608 A text string consisting of printable ASCII characters that will be stored
609 such that it is available even if the pool becomes faulted. An administrator
610 can provide additional information about a pool using this property.
612 The deduplication ratio specified for a pool, expressed as a multiplier.
615 value of 1.76 indicates that 1.76 units of data were stored but only 1 unit of disk space was actually consumed. See
617 for a description of the deduplication feature.
619 Amount of uninitialized space within the pool or device that can be used to
620 increase the total capacity of the pool.
621 Uninitialized space consists of
622 any space on an EFI labeled vdev which has not been brought online
623 .Pq i.e. zpool online -e .
624 This space occurs when a LUN is dynamically expanded.
626 The amount of fragmentation in the pool.
628 Number of blocks within the pool that are not allocated.
630 After a file system or snapshot is destroyed, the space it was using is
631 returned to the pool asynchronously.
633 is the amount of space remaining to be reclaimed.
640 A unique identifier for the pool.
642 The current health of the pool. Health can be
651 Total size of the storage pool.
652 .It Sy unsupported@ Ns Ar feature_guid
653 Information about unsupported features that are enabled on the pool.
658 Amount of storage space used within the pool.
661 The space usage properties report actual physical space available to the
662 storage pool. The physical space can be different from the total amount of
663 space that any contained datasets can actually use. The amount of space used in
666 configuration depends on the characteristics of the data being written.
669 reserves some space for internal accounting that the
671 command takes into account, but the
673 command does not. For non-full pools of a reasonable size, these effects should
674 be invisible. For small pools, or pools that are close to being completely
675 full, these discrepancies may become more noticeable.
677 The following property can be set at creation time and import time:
680 Alternate root directory. If set, this directory is prepended to any mount
681 points within the pool. This can be used when examining an unknown pool where
682 the mount points cannot be trusted, or in an alternate boot environment, where
683 the typical paths are not valid.
685 is not a persistent property. It is valid only while the system is up.
690 though this may be overridden using an explicit setting.
693 The following property can only be set at import time:
695 .It Sy readonly Ns = Ns Cm on No | Cm off
698 pool will be imported in read-only mode with the following restrictions:
699 .Bl -bullet -offset 2n
701 Synchronous data in the intent log will not be accessible
703 Properties of the pool can not be changed
705 Datasets of this pool can only be mounted read-only
707 To write to a read-only pool, a export and import of the pool is required.
710 This property can also be referred to by its shortened column name,
714 The following properties can be set at creation time and import time, and later
719 .It Sy autoexpand Ns = Ns Cm on No | Cm off
720 Controls automatic pool expansion when the underlying LUN is grown. If set to
722 the pool will be resized according to the size of the expanded
723 device. If the device is part of a mirror or
725 then all devices within that
726 .No mirror/ Ns No raidz
727 group must be expanded before the new space is made available to
728 the pool. The default behavior is
730 This property can also be referred to by its shortened column name,
732 .It Sy autoreplace Ns = Ns Cm on No | Cm off
733 Controls automatic device replacement. If set to
735 device replacement must be initiated by the administrator by using the
739 any new device, found in the same
740 physical location as a device that previously belonged to the pool, is
741 automatically formatted and replaced. The default behavior is
743 This property can also be referred to by its shortened column name, "replace".
744 .It Sy bootfs Ns = Ns Ar pool Ns / Ns Ar dataset
745 Identifies the default bootable dataset for the root pool. This property is
746 expected to be set mainly by the installation and upgrade programs.
747 .It Sy cachefile Ns = Ns Ar path No | Cm none
748 Controls the location of where the pool configuration is cached. Discovering
749 all pools on system startup requires a cached copy of the configuration data
750 that is stored on the root file system. All pools in this cache are
751 automatically imported when the system boots. Some environments, such as
752 install and clustering, need to cache this information in a different location
753 so that pools are not automatically imported. Setting this property caches the
754 pool configuration in a different location that can later be imported with
755 .Qq Nm Cm import Fl c .
756 Setting it to the special value
758 creates a temporary pool that is never cached, and the special value
760 (empty string) uses the default location.
761 .It Sy comment Ns = Ns Ar text
762 A text string consisting of printable ASCII characters that will be stored
763 such that it is available even if the pool becomes faulted.
764 An administrator can provide additional information about a pool using this
766 .It Sy dedupditto Ns = Ns Ar number
767 Threshold for the number of block ditto copies. If the reference count for a
768 deduplicated block increases above this number, a new ditto copy of this block
769 is automatically stored. Default setting is
771 which causes no ditto copies to be created for deduplicated blocks.
772 The miniumum legal nonzero setting is 100.
773 .It Sy delegation Ns = Ns Cm on No | Cm off
774 Controls whether a non-privileged user is granted access based on the dataset
775 permissions defined on the dataset. See
777 for more information on
779 delegated administration.
780 .It Sy failmode Ns = Ns Cm wait No | Cm continue No | Cm panic
781 Controls the system behavior in the event of catastrophic pool failure. This
782 condition is typically a result of a loss of connectivity to the underlying
783 storage device(s) or a failure of all devices within the pool. The behavior of
784 such an event is determined as follows:
785 .Bl -tag -width indent
789 access until the device connectivity is recovered and the errors are cleared.
790 This is the default behavior.
796 requests but allows reads to any of the remaining healthy devices. Any write
797 requests that have yet to be committed to disk would be blocked.
799 Prints out a message to the console and generates a system crash dump.
801 .It Sy feature@ Ns Ar feature_name Ns = Ns Sy enabled
802 The value of this property is the current state of
804 The only valid value when setting this property is
808 to the enabled state.
811 for details on feature states.
812 .It Sy listsnaps Ns = Ns Cm on No | Cm off
813 Controls whether information about snapshots associated with this pool is
818 option. The default value is
820 .It Sy version Ns = Ns Ar version
821 The current on-disk version of the pool. This can be increased, but never
822 decreased. The preferred method of updating pools is with the
824 command, though this property can be used when a specific version is needed
825 for backwards compatibility.
826 Once feature flags is enabled on a pool this property will no longer have a
830 All subcommands that modify state are logged persistently to the pool in their
835 command provides subcommands to create and destroy storage pools, add capacity
836 to storage pools, and provide information about the storage pools. The following
837 subcommands are supported:
844 Displays a help message.
852 Adds the specified virtual devices to the given pool. The
854 specification is described in the
855 .Qq Sx Virtual Devices
856 section. The behavior of the
858 option, and the device checks performed are described in the
861 .Bl -tag -width indent
865 even if they appear in use or specify a conflicting replication level.
866 Not all devices can be overridden in this manner.
868 Displays the configuration that would be used without actually adding the
870 The actual pool creation can still fail due to insufficient privileges or device
873 Do not add a disk that is currently configured as a quorum device to a zpool.
874 After a disk is in the pool, that disk can then be configured as a quorum
881 .Ar pool device new_device
888 device. The existing device cannot be part of a
892 is not currently part of a mirrored configuration,
894 automatically transforms into a two-way mirror of
895 .Ar device No and Ar new_device .
898 is part of a two-way mirror, attaching
900 creates a three-way mirror, and so on. In either case,
902 begins to resilver immediately.
903 .Bl -tag -width indent
907 even if its appears to be in use. Not all devices can be overridden in this
916 Checkpoints the current state of
918 , which can be later restored by
919 .Nm zpool Cm import --rewind-to-checkpoint .
920 The existence of a checkpoint in a pool prohibits the following
929 In addition, it may break reservation boundaries if the pool lacks free
933 command indicates the existence of a checkpoint or the progress of discarding a
934 checkpoint from a pool.
937 command reports how much space the checkpoint takes from the pool.
940 Discards an existing checkpoint from
951 Clears device errors in a pool. If no arguments are specified, all device
952 errors within the pool are cleared. If one or more devices is specified, only
953 those errors associated with the specified device or devices are cleared.
954 .Bl -tag -width indent
956 Initiates recovery mode for an unopenable pool. Attempts to discard the last
957 few transactions in the pool to return it to an openable state. Not all damaged
958 pools can be recovered by using this option. If successful, the data from the
959 discarded transactions is irretrievably lost.
961 Used in combination with the
963 flag. Check whether discarding transactions would make the pool openable, but
964 do not actually discard any transactions.
970 .Op Fl o Ar property Ns = Ns Ar value
972 .Op Fl O Ar file-system-property Ns = Ns Ar value
974 .Op Fl m Ar mountpoint
980 Creates a new storage pool containing the virtual devices specified on the
981 command line. The pool name must begin with a letter, and can only contain
982 alphanumeric characters as well as underscore ("_"), dash ("-"), and period
983 ("."). The pool names "mirror", "raidz", "spare" and "log" are reserved, as are
984 names beginning with the pattern "c[0-9]". The
986 specification is described in the
987 .Qq Sx Virtual Devices
990 The command verifies that each device specified is accessible and not currently
991 in use by another subsystem. There are some uses, such as being currently
992 mounted, or specified as the dedicated dump device, that prevents a device from
995 Other uses, such as having a preexisting
997 file system, can be overridden with the
1001 The command also checks that the replication strategy for the pool is
1002 consistent. An attempt to combine redundant and non-redundant storage in a
1003 single pool, or to mix disks and files, results in an error unless
1005 is specified. The use of differently sized devices within a single
1007 or mirror group is also flagged as an error unless
1013 option is specified, the default mount point is
1015 The mount point must not exist or must be empty, or else the
1016 root dataset cannot be mounted. This can be overridden with the
1020 By default all supported features are enabled on the new pool unless the
1022 option is specified.
1023 .Bl -tag -width indent
1027 even if they appear in use or specify a conflicting replication level.
1028 Not all devices can be overridden in this manner.
1030 Displays the configuration that would be used without actually creating the
1031 pool. The actual pool creation can still fail due to insufficient privileges or
1034 Do not enable any features on the new pool.
1035 Individual features can be enabled by setting their corresponding properties
1042 .Xr zpool-features 7
1043 for details about feature properties.
1045 .Fl o Ar property Ns = Ns Ar value
1046 .Op Fl o Ar property Ns = Ns Ar value
1049 Sets the given pool properties. See the
1051 section for a list of valid properties that can be set.
1054 .Ar file-system-property Ns = Ns Ar value
1055 .Op Fl O Ar file-system-property Ns = Ns Ar value
1058 Sets the given file system properties in the root file system of the pool. See
1059 .Xr zfs 8 Properties
1060 for a list of valid properties that
1064 .Qq Fl o Cm cachefile=none,altroot= Ns Pa root
1065 .It Fl m Ar mountpoint
1066 Sets the mount point for the root dataset. The default mount point is
1069 .Qq Cm altroot Ns Pa /pool
1072 is specified. The mount point must be an absolute path,
1076 For more information on dataset mount points, see
1078 .It Fl t Ar tempname
1079 Sets the in-core pool name to
1081 while the on-disk name will be the name specified as the pool name
1083 This will set the default
1087 This is intended to handle name space collisions when creating pools
1088 for other systems, such as virtual machines or physical machines
1089 whose pools live on network block devices.
1098 Destroys the given pool, freeing up any devices for other use. This command
1099 tries to unmount any active datasets before destroying the pool.
1100 .Bl -tag -width indent
1102 Forces any active datasets contained within the pool to be unmounted.
1112 from a mirror. The operation is refused if there are no other valid replicas
1121 Exports the given pools from the system. All devices are marked as exported,
1122 but are still considered in use by other subsystems. The devices can be moved
1123 between systems (even those of different endianness) and imported as long as a
1124 sufficient number of devices are present.
1126 Before exporting the pool, all datasets within the pool are unmounted. A pool
1127 can not be exported if it has a shared spare that is currently being used.
1129 For pools to be portable, you must give the
1131 command whole disks, not just slices, so that
1133 can label the disks with portable
1135 labels. Otherwise, disk drivers on platforms of different endianness will not
1136 recognize the disks.
1137 .Bl -tag -width indent
1139 Forcefully unmount all datasets, using the
1143 This command will forcefully export the pool even if it has a shared spare that
1144 is currently being used. This may lead to potential data corruption.
1150 .Op Fl o Ar field Ns Op , Ns Ar ...
1151 .Ar all | property Ns Op , Ns Ar ...
1155 Retrieves the given list of properties (or all properties if
1157 is used) for the specified storage pool(s). These properties are displayed with
1158 the following fields:
1159 .Bl -column -offset indent "property"
1160 .It name Ta Name of storage pool
1161 .It property Ta Property name
1162 .It value Ta Property value
1163 .It source Ta Property source, either 'default' or 'local'.
1168 section for more information on the available pool properties.
1170 Scripted mode. Do not display headers, and separate fields by a single tab
1171 instead of arbitrary space.
1173 Display numbers in parsable (exact) values.
1175 A comma-separated list of columns to display.
1177 .Sy property Ns , Ns
1180 is the default value.
1189 Displays the command history of the specified pools or all pools if no pool is
1191 .Bl -tag -width indent
1193 Displays internally logged
1195 events in addition to user initiated events.
1197 Displays log records in long format, which in addition to standard format
1198 includes, the user name, the hostname, and the zone in which the operation was
1204 .Op Fl d Ar dir | Fl c Ar cachefile
1208 Lists pools available to import. If the
1210 option is not specified, this command searches for devices in
1214 option can be specified multiple times, and all directories are searched. If
1215 the device appears to be part of an exported pool, this command displays a
1216 summary of the pool with the name of the pool, a numeric identifier, as well as
1219 layout and current health of the device for each device or file.
1220 Destroyed pools, pools that were previously destroyed with the
1222 command, are not listed unless the
1224 option is specified.
1226 The numeric identifier is unique, and can be used instead of the pool name when
1227 multiple exported pools of the same name are available.
1228 .Bl -tag -width indent
1229 .It Fl c Ar cachefile
1230 Reads configuration from the given
1232 that was created with the
1236 is used instead of searching for devices.
1238 Searches for devices or files in
1242 option can be specified multiple times.
1244 Lists destroyed pools only.
1250 .Op Fl o Ar property Ns = Ns Ar value
1252 .Op Fl d Ar dir | Fl c Ar cachefile
1262 Imports all pools found in the search directories. Identical to the previous
1263 command, except that all pools with a sufficient number of devices available
1264 are imported. Destroyed pools, pools that were previously destroyed with the
1266 command, will not be imported unless the
1268 option is specified.
1269 .Bl -tag -width indent
1271 Comma-separated list of mount options to use when mounting datasets within the
1274 for a description of dataset properties and mount options.
1275 .It Fl o Ar property Ns = Ns Ar value
1276 Sets the specified property on the imported pool. See the
1278 section for more information on the available pool properties.
1279 .It Fl c Ar cachefile
1280 Reads configuration from the given
1282 that was created with the
1286 is used instead of searching for devices.
1288 Searches for devices or files in
1292 option can be specified multiple times. This option is incompatible with the
1296 Imports destroyed pools only. The
1298 option is also required.
1300 Forces import, even if the pool appears to be potentially active.
1302 Allows a pool to import when there is a missing log device. Recent transactions
1303 can be lost because the log device will be discarded.
1305 Import the pool without mounting any file systems.
1316 Recovery mode for a non-importable pool. Attempt to return the pool to an
1317 importable state by discarding the last few transactions. Not all damaged pools
1318 can be recovered by using this option. If successful, the data from the
1319 discarded transactions is irretrievably lost. This option is ignored if the
1320 pool is importable or already imported.
1324 recovery option. Determines whether a non-importable pool can be made
1325 importable again, but does not actually perform the pool recovery. For more
1326 details about pool recovery mode, see the
1330 Searches for and imports all pools found.
1336 .Op Fl o Ar property Ns = Ns Ar value
1338 .Op Fl d Ar dir | Fl c Ar cachefile
1350 Imports a specific pool. A pool can be identified by its name or the numeric
1353 is specified, the pool is imported using the name
1355 Otherwise, it is imported with the same name as its exported name.
1357 If a device is removed from a system without running
1359 first, the device appears as potentially active. It cannot be determined if
1360 this was a failed export, or whether the device is really in use from another
1361 host. To import a pool in this state, the
1364 .Bl -tag -width indent
1366 Comma-separated list of mount options to use when mounting datasets within the
1369 for a description of dataset properties and mount options.
1370 .It Fl o Ar property Ns = Ns Ar value
1371 Sets the specified property on the imported pool. See the
1373 section for more information on the available pool properties.
1374 .It Fl c Ar cachefile
1375 Reads configuration from the given
1377 that was created with the
1381 is used instead of searching for devices.
1383 Searches for devices or files in
1387 option can be specified multiple times. This option is incompatible with the
1391 Imports destroyed pools only. The
1393 option is also required.
1395 Forces import, even if the pool appears to be potentially active.
1397 Allows a pool to import when there is a missing log device. Recent transactions
1398 can be lost because the log device will be discarded.
1400 Import the pool without mounting any file systems.
1403 .Qq Fl o Cm cachefile=none,altroot= Ns Pa root
1410 Temporary pool names last until export.
1411 Ensures that the original pool name will be used in all label updates and
1412 therefore is retained upon export.
1417 when not explicitly specified.
1419 Recovery mode for a non-importable pool. Attempt to return the pool to an
1420 importable state by discarding the last few transactions. Not all damaged pools
1421 can be recovered by using this option. If successful, the data from the
1422 discarded transactions is irretrievably lost. This option is ignored if the
1423 pool is importable or already imported.
1427 recovery option. Determines whether a non-importable pool can be made
1428 importable again, but does not actually perform the pool recovery. For more
1429 details about pool recovery mode, see the
1432 .It Fl -rewind-to-checkpoint
1433 Rewinds pool to the checkpointed state.
1434 Once the pool is imported with this flag there is no way to undo the rewind.
1435 All changes and data that were written after the checkpoint are lost!
1436 The only exception is when the
1438 mounting option is enabled.
1439 In this case, the checkpointed state of the pool is opened and an
1440 administrator can see how the pool would look like if they were
1448 .Op Ar device Ns ...
1450 Begins initializing by writing to all unallocated regions on the specified
1451 devices, or all eligible devices in the pool if no individual devices are
1453 Only leaf data or log devices may be initialized.
1456 Cancel initializing on the specified devices, or all eligible devices if none
1458 If one or more target devices are invalid or are not currently being
1459 initialized, the command will fail and no cancellation will occur on any device.
1461 Suspend initializing on the specified devices, or all eligible devices if none
1463 If one or more target devices are invalid or are not currently being
1464 initialized, the command will fail and no suspension will occur on any device.
1465 Initializing can then be resumed by running
1466 .Nm zpool Cm initialize
1467 with no flags on the relevant target devices.
1472 .Op Fl T Cm d Ns | Ns Cm u
1476 .Op Ar interval Op Ar count
1481 statistics for the given pools. When given an interval, the statistics are
1488 are specified, statistics for every pool in the system is shown. If
1490 is specified, the command exits after
1492 reports are printed.
1493 .Bl -tag -width indent
1494 .It Fl T Cm d Ns | Ns Cm u
1499 for standard date format. See
1504 .Pq equals Qq Ic date +%s .
1506 Verbose statistics. Reports usage statistics for individual
1508 within the pool, in addition to the pool-wide statistics.
1519 label information from the specified
1523 must not be part of an active pool configuration.
1524 .Bl -tag -width indent
1526 Treat exported or foreign devices as inactive.
1532 .Op Fl o Ar property Ns Op , Ns Ar ...
1533 .Op Fl T Cm d Ns | Ns Cm u
1536 .Op Ar inverval Op Ar count
1539 Lists the given pools along with a health status and space usage. If no
1541 are specified, all pools in the system are listed.
1543 When given an interval, the output is printed every
1549 is specified, the command exits after
1551 reports are printed.
1552 .Bl -tag -width indent
1553 .It Fl T Cm d Ns | Ns Cm u
1558 for standard date format. See
1563 .Pq equals Qq Ic date +%s .
1565 Scripted mode. Do not display headers, and separate fields by a single tab
1566 instead of arbitrary space.
1568 Display numbers in parsable (exact) values.
1570 Verbose statistics. Reports usage statistics for individual
1573 the pool, in addition to the pool-wide statistics.
1574 .It Fl o Ar property Ns Op , Ns Ar ...
1575 Comma-separated list of properties to display. See the
1577 section for a list of valid properties. The default list is
1589 .It Fl T Cm d Ns | Ns Cm u
1594 for standard date format. See
1599 .Pq equals Qq Ic date +%s .
1608 Takes the specified physical device offline. While the
1610 is offline, no attempt is made to read or write to the device.
1611 .Bl -tag -width indent
1613 Temporary. Upon reboot, the specified physical device reverts to its previous
1623 Brings the specified physical device online.
1625 This command is not applicable to spares or cache devices.
1626 .Bl -tag -width indent
1628 Expand the device to use all available space. If the device is part of a mirror
1631 then all devices must be expanded before the new space will become
1632 available to the pool.
1640 Generates a new unique identifier for the pool. You must ensure that all
1641 devices in this pool are online and healthy before performing this action.
1649 Removes the specified device from the pool.
1650 This command currently only supports removing hot spares, cache, log
1651 devices and mirrored top-level vdevs (mirror of leaf devices); but not raidz.
1653 Removing a top-level vdev reduces the total amount of space in the storage pool.
1654 The specified device will be evacuated by copying all allocated space from it to
1655 the other devices in the pool.
1658 command initiates the removal and returns, while the evacuation continues in
1660 The removal progress can be monitored with
1661 .Nm zpool Cm status.
1662 This feature must be enabled to be used, see
1663 .Xr zpool-features 5
1665 A mirrored top-level device (log or data) can be removed by specifying the
1666 top-level mirror for the same.
1667 Non-log devices or data devices that are part of a mirrored configuration can
1668 be removed using the
1673 Do not actually perform the removal ("no-op").
1674 Instead, print the estimated amount of memory that will be used by the
1675 mapping table after the removal completes.
1676 This is nonzero only for top-level vdevs.
1680 Used in conjunction with the
1682 flag, displays numbers as parsable (exact) values.
1691 Stops and cancels an in-progress removal of a top-level vdev.
1698 Reopen all the vdevs associated with the pool.
1711 This is equivalent to attaching
1713 waiting for it to resilver, and then detaching
1718 must be greater than or equal to the minimum size
1719 of all the devices in a mirror or
1724 is required if the pool is not redundant. If
1726 is not specified, it defaults to
1728 This form of replacement is useful after an existing disk has failed and has
1729 been physically replaced. In this case, the new disk may have the same
1731 path as the old device, even though it is actually a different disk.
1734 .Bl -tag -width indent
1738 even if its appears to be in use. Not all devices can be overridden in this
1748 Begins a scrub or resumes a paused scrub.
1749 The scrub examines all data in the specified pools to verify that it checksums
1753 devices, ZFS automatically repairs any damage discovered during the scrub.
1756 command reports the progress of the scrub and summarizes the results of the
1757 scrub upon completion.
1759 Scrubbing and resilvering are very similar operations.
1760 The difference is that resilvering only examines data that ZFS knows to be out
1763 for example, when attaching a new device to a mirror or replacing an existing
1766 whereas scrubbing examines all data to discover silent errors due to hardware
1767 faults or disk failure.
1769 Because scrubbing and resilvering are I/O-intensive operations, ZFS only allows
1771 If a scrub is paused, the
1774 If a resilver is in progress, ZFS does not allow a scrub to be started until the
1783 Scrub pause state and progress are periodically synced to disk.
1784 If the system is restarted or pool is exported during a paused scrub,
1785 even after import, scrub will remain paused until it is resumed.
1786 Once resumed the scrub will pick up from the place where it was last
1787 checkpointed to disk.
1788 To resume a paused scrub issue
1795 .Ar property Ns = Ns Ar value pool
1798 Sets the given property on the specified pool. See the
1800 section for more information on what properties can be set and acceptable
1808 .Op Fl o Ar property Ns = Ns Ar value
1813 Splits off one disk from each mirrored top-level
1815 in a pool and creates a new pool from the split-off disks. The original pool
1816 must be made up of one or more mirrors and must not be in the process of
1819 subcommand chooses the last device in each mirror
1821 unless overridden by a device specification on the command line.
1827 includes the specified device(s) in a new pool and, should any devices remain
1828 unspecified, assigns the last device in each mirror
1830 to that pool, as it does normally. If you are uncertain about the outcome of a
1834 ("dry-run") option to ensure your command will have the effect you intend.
1835 .Bl -tag -width indent
1837 Automatically import the newly created pool after splitting, using the
1840 parameter for the new pool's alternate root. See the
1846 Displays the configuration that would be created without actually splitting the
1847 pool. The actual pool split could still fail due to insufficient privileges or
1850 Comma-separated list of mount options to use when mounting datasets within the
1853 for a description of dataset properties and mount options. Valid only in
1854 conjunction with the
1857 .It Fl o Ar property Ns = Ns Ar value
1858 Sets the specified property on the new pool. See the
1860 section, above, for more information on the available pool properties.
1866 .Op Fl T Cm d Ns | Ns Cm u
1869 .Op Ar interval Op Ar count
1872 Displays the detailed health status for the given pools. If no
1874 is specified, then the status of each pool in the system is displayed. For more
1875 information on pool and device health, see the
1876 .Qq Sx Device Failure and Recovery
1879 When given an interval, the output is printed every
1885 is specified, the command exits after
1887 reports are printed.
1889 If a scrub or resilver is in progress, this command reports the percentage
1890 done and the estimated time to completion. Both of these are only approximate,
1891 because the amount of data in the pool and the other workloads on the system
1893 .Bl -tag -width indent
1895 Only display status for pools that are exhibiting errors or are otherwise
1897 Warnings about pools not using the latest on-disk format, having non-native
1898 block size or disabled features will not be included.
1900 Displays verbose data error information, printing out a complete list of all
1901 data errors since the last complete pool scrub.
1902 .It Fl T Cm d Ns | Ns Cm u
1907 for standard date format. See
1912 .Pq equals Qq Ic date +%s .
1920 Displays pools which do not have all supported features enabled and pools
1921 formatted using a legacy
1924 These pools can continue to be used, but some features may not be available.
1927 to enable all features on all pools.
1928 .Bl -tag -width indent
1932 versions supported by the current software.
1934 .Xr zpool-features 7
1935 for a description of feature flags features supported by the current software.
1944 Enables all supported features on the given pool.
1945 Once this is done, the pool will no longer be accessible on systems that do
1946 not support feature flags.
1948 .Xr zpool-features 7
1949 for details on compatibility with systems that support feature flags, but do
1950 not support all features enabled on the pool.
1951 .Bl -tag -width indent
1953 Enables all supported features on all pools.
1955 Upgrade to the specified legacy version. If the
1957 flag is specified, no features will be enabled on the pool.
1958 This option can only be used to increase version number up to the last
1959 supported legacy version number.
1963 The following exit values are returned:
1964 .Bl -tag -offset 2n -width 2n
1966 Successful completion.
1970 Invalid command line options were specified.
1974 .It Sy Example 1 No Creating a RAID-Z Storage Pool
1976 The following command creates a pool with a single
1980 that consists of six disks.
1981 .Bd -literal -offset 2n
1982 .Li # Ic zpool create tank raidz da0 da1 da2 da3 da4 da5
1984 .It Sy Example 2 No Creating a Mirrored Storage Pool
1986 The following command creates a pool with two mirrors, where each mirror
1988 .Bd -literal -offset 2n
1989 .Li # Ic zpool create tank mirror da0 da1 mirror da2 da3
1991 .It Sy Example 3 No Creating a Tn ZFS No Storage Pool by Using Partitions
1993 The following command creates an unmirrored pool using two GPT partitions.
1994 .Bd -literal -offset 2n
1995 .Li # Ic zpool create tank da0p3 da1p3
1997 .It Sy Example 4 No Creating a Tn ZFS No Storage Pool by Using Files
1999 The following command creates an unmirrored pool using files. While not
2000 recommended, a pool based on files can be useful for experimental purposes.
2001 .Bd -literal -offset 2n
2002 .Li # Ic zpool create tank /path/to/file/a /path/to/file/b
2004 .It Sy Example 5 No Adding a Mirror to a Tn ZFS No Storage Pool
2006 The following command adds two mirrored disks to the pool
2008 assuming the pool is already made up of two-way mirrors. The additional space
2009 is immediately available to any datasets within the pool.
2010 .Bd -literal -offset 2n
2011 .Li # Ic zpool add tank mirror da2 da3
2013 .It Sy Example 6 No Listing Available Tn ZFS No Storage Pools
2015 The following command lists all available pools on the system.
2016 .Bd -literal -offset 2n
2018 NAME SIZE ALLOC FREE FRAG EXPANDSZ CAP DEDUP HEALTH ALTROOT
2019 pool 2.70T 473G 2.24T 33% - 17% 1.00x ONLINE -
2020 test 1.98G 89.5K 1.98G 48% - 0% 1.00x ONLINE -
2022 .It Sy Example 7 No Listing All Properties for a Pool
2024 The following command lists all the properties for a pool.
2025 .Bd -literal -offset 2n
2026 .Li # Ic zpool get all pool
2029 pool altroot - default
2030 pool health ONLINE -
2031 pool guid 2501120270416322443 default
2032 pool version 28 default
2033 pool bootfs pool/root local
2034 pool delegation on default
2035 pool autoreplace off default
2036 pool cachefile - default
2037 pool failmode wait default
2038 pool listsnapshots off default
2039 pool autoexpand off default
2040 pool dedupditto 0 default
2041 pool dedupratio 1.00x -
2043 pool allocated 473G -
2046 .It Sy Example 8 No Destroying a Tn ZFS No Storage Pool
2048 The following command destroys the pool
2050 and any datasets contained within.
2051 .Bd -literal -offset 2n
2052 .Li # Ic zpool destroy -f tank
2054 .It Sy Example 9 No Exporting a Tn ZFS No Storage Pool
2056 The following command exports the devices in pool
2058 so that they can be relocated or later imported.
2059 .Bd -literal -offset 2n
2060 .Li # Ic zpool export tank
2062 .It Sy Example 10 No Importing a Tn ZFS No Storage Pool
2064 The following command displays available pools, and then imports the pool
2066 for use on the system.
2068 The results from this command are similar to the following:
2069 .Bd -literal -offset 2n
2070 .Li # Ic zpool import
2073 id: 15451357997522795478
2075 action: The pool can be imported using its name or numeric identifier.
2087 Storage Pools to the Current Version
2090 The following command upgrades all
2092 Storage pools to the current version of
2094 .Bd -literal -offset 2n
2095 .Li # Ic zpool upgrade -a
2096 This system is currently running ZFS pool version 28.
2098 .It Sy Example 12 No Managing Hot Spares
2100 The following command creates a new pool with an available hot spare:
2101 .Bd -literal -offset 2n
2102 .Li # Ic zpool create tank mirror da0 da1 spare da2
2105 If one of the disks were to fail, the pool would be reduced to the degraded
2106 state. The failed device can be replaced using the following command:
2107 .Bd -literal -offset 2n
2108 .Li # Ic zpool replace tank da0 da2
2111 Once the data has been resilvered, the spare is automatically removed and is
2112 made available should another device fails. The hot spare can be permanently
2113 removed from the pool using the following command:
2114 .Bd -literal -offset 2n
2115 .Li # Ic zpool remove tank da2
2121 Pool with Mirrored Separate Intent Logs
2124 The following command creates a
2126 storage pool consisting of two, two-way
2127 mirrors and mirrored log devices:
2128 .Bd -literal -offset 2n
2129 .Li # Ic zpool create pool mirror da0 da1 mirror da2 da3 log mirror da4 da5
2131 .It Sy Example 14 No Adding Cache Devices to a Tn ZFS No Pool
2133 The following command adds two disks for use as cache devices to a
2136 .Bd -literal -offset 2n
2137 .Li # Ic zpool add pool cache da2 da3
2140 Once added, the cache devices gradually fill with content from main memory.
2141 Depending on the size of your cache devices, it could take over an hour for
2142 them to fill. Capacity and reads can be monitored using the
2144 subcommand as follows:
2145 .Bd -literal -offset 2n
2146 .Li # Ic zpool iostat -v pool 5
2150 Displaying expanded space on a device
2153 The following command dipslays the detailed information for the
2156 This pool is comprised of a single
2158 vdev where one of its
2159 devices increased its capacity by 10GB.
2160 In this example, the pool will not
2161 be able to utilized this extra capacity until all the devices under the
2163 vdev have been expanded.
2164 .Bd -literal -offset 2n
2165 .Li # Ic zpool list -v data
2166 NAME SIZE ALLOC FREE FRAG EXPANDSZ CAP DEDUP HEALTH ALTROOT
2167 data 23.9G 14.6G 9.30G 48% - 61% 1.00x ONLINE -
2168 raidz1 23.9G 14.6G 9.30G 48% -
2175 Removing a Mirrored top-level (Log or Data) Device
2178 The following commands remove the mirrored log device
2180 and mirrored top-level data device
2183 Given this configuration:
2184 .Bd -literal -offset 2n
2187 scrub: none requested
2190 NAME STATE READ WRITE CKSUM
2192 mirror-0 ONLINE 0 0 0
2195 mirror-1 ONLINE 0 0 0
2199 mirror-2 ONLINE 0 0 0
2204 The command to remove the mirrored log
2207 .Bd -literal -offset 2n
2208 .Li # Ic zpool remove tank mirror-2
2211 The command to remove the mirrored data
2214 .Bd -literal -offset 2n
2215 .Li # Ic zpool remove tank mirror-1
2219 Recovering a Faulted
2224 If a pool is faulted but recoverable, a message indicating this state is
2227 if the pool was cached (see the
2229 argument above), or as part of the error output from a failed
2233 Recover a cached pool with the
2236 .Bd -literal -offset 2n
2237 .Li # Ic zpool clear -F data
2238 Pool data returned to its state as of Tue Sep 08 13:23:35 2009.
2239 Discarded approximately 29 seconds of transactions.
2242 If the pool configuration was not cached, use
2244 with the recovery mode flag:
2245 .Bd -literal -offset 2n
2246 .Li # Ic zpool import -F data
2247 Pool data returned to its state as of Tue Sep 08 13:23:35 2009.
2248 Discarded approximately 29 seconds of transactions.
2252 .Xr zpool-features 7 ,
2256 This manual page is a
2258 reimplementation of the
2262 modified and customized for
2264 and licensed under the Common Development and Distribution License
2269 implementation of this manual page was initially written by
2270 .An Martin Matuska Aq mm@FreeBSD.org .
projects / FreeBSD / FreeBSD.git / blob