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 2011, Nexenta Systems, Inc. All Rights Reserved.
23 .\" Copyright (c) 2011, Justin T. Gibbs <gibbs@FreeBSD.org>
24 .\" Copyright (c) 2013 by Delphix. All Rights Reserved.
25 .\" Copyright (c) 2012, Glen Barber <gjb@FreeBSD.org>
34 .Nd configures ZFS storage pools
45 .Ar pool device new_device
54 .Op Fl o Ar property Ns = Ns Ar value
56 .Op Fl O Ar file-system-property Ns = Ns Ar value
58 .Op Fl m Ar mountpoint
75 .Op Fl o Ar field Ns Op , Ns Ar ...
76 .Ar all | property Ns Op , Ns Ar ...
85 .Op Fl d Ar dir | Fl c Ar cachefile
90 .Op Fl o Ar property Ns = Ns Ar value
92 .Op Fl d Ar dir | Fl c Ar cachefile
103 .Op Fl o Ar property Ns = Ns Ar value
105 .Op Fl d Ar dir | Fl c Ar cachefile
116 .Op Fl T Cm d Ns | Ns Cm u
127 .Op Fl o Ar property Ns Op , Ns Ar ...
128 .Op Fl T Cm d Ns | Ns Cm u
131 .Op Ar inverval Op Ar count
160 .Ar property Ns = Ns Ar value pool
166 .Op Fl o Ar property Ns = Ns Ar value
172 .Op Fl T Cm d Ns | Ns Cm u
175 .Op Ar interval Op Ar count
188 storage pools. A storage pool is a collection of devices that provides physical
189 storage and data replication for
193 All datasets within a storage pool share the same space. See
195 for information on managing datasets.
196 .Ss Virtual Devices (vdevs)
200 describes a single device or a collection of devices organized according to
201 certain performance and fault characteristics. The following virtual devices
203 .Bl -tag -width "XXXXXX"
205 A block device, typically located under
208 can use individual slices or partitions, though the recommended mode of
209 operation is to use whole disks. A disk can be specified by a full path to the
212 provider name. When given a whole disk,
214 automatically labels the disk, if necessary.
216 A regular file. The use of files as a backing store is strongly discouraged. It
217 is designed primarily for experimental purposes, as the fault tolerance of a
218 file is only as good the file system of which it is a part. A file must be
219 specified by a full path.
221 A mirror of two or more devices. Data is replicated in an identical fashion
222 across all components of a mirror. A mirror with
228 bytes and can withstand
230 devices failing before data integrity is compromised.
233 .Sy raidz1 raidz2 raidz3 ) .
236 that allows for better distribution of parity and eliminates the
238 write hole (in which data and parity become inconsistent after a power loss).
239 Data and parity is striped across all disks within a
245 group can have single-, double- , or triple parity, meaning that the
247 group can sustain one, two, or three failures, respectively, without
250 type specifies a single-parity
254 type specifies a double-parity
258 type specifies a triple-parity
273 parity disks can hold approximately
278 bytes and can withstand
280 device(s) failing before data integrity is compromised. The minimum number of
283 group is one more than the number of parity disks. The
284 recommended number is between 3 and 9 to help increase performance.
287 .No pseudo- Ns No vdev
288 which keeps track of available hot spares for a pool.
289 For more information, see the
293 A separate-intent log device. If more than one log device is specified, then
294 writes are load-balanced between devices. Log devices can be mirrored. However,
297 types are not supported for the intent log. For more information,
302 A device used to cache storage pool data. A cache device cannot be configured
305 group. For more information, see the
310 Virtual devices cannot be nested, so a mirror or
312 virtual device can only
313 contain files or disks. Mirrors of mirrors (or other combinations) are not
316 A pool can have any number of virtual devices at the top of the configuration
320 Data is dynamically distributed across all top-level devices to balance data
321 among devices. As new virtual devices are added,
323 automatically places data on the newly available devices.
325 Virtual devices are specified one at a time on the command line, separated by
326 whitespace. The keywords
330 are used to distinguish where a group ends and another begins. For example, the
331 following creates two root
333 each a mirror of two disks:
334 .Bd -literal -offset 2n
335 .Li # Ic zpool create mypool mirror da0 da1 mirror da2 da3
337 .Ss Device Failure and Recovery
339 supports a rich set of mechanisms for handling device failure and data
340 corruption. All metadata and data is checksummed, and
342 automatically repairs bad data 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
349 supports running in a non-redundant configuration, where each root
351 is simply a disk or file, this is strongly discouraged. A single case of bit
352 corruption can render some or all of your data unavailable.
354 A pool's health status is described by one of three states: online, degraded,
355 or faulted. An online pool has all devices operating normally. A degraded pool
356 is one in which one or more devices have failed, but the data is still
357 available due to a redundant configuration. A faulted pool has corrupted
358 metadata, or one or more faulted devices, and insufficient replicas to continue
361 The health of the top-level
366 potentially impacted by the state of its associated
368 or component devices. A top-level
370 or component device is in one of the following states:
371 .Bl -tag -width "DEGRADED"
373 One or more top-level
375 is in the degraded state because one or more
376 component devices are offline. Sufficient replicas exist to continue
379 One or more component devices is in the degraded or faulted state, but
380 sufficient replicas exist to continue functioning. The underlying conditions
382 .Bl -bullet -offset 2n
384 The number of checksum errors exceeds acceptable levels and the device is
385 degraded as an indication that something may be wrong.
387 continues to use the device as necessary.
391 errors exceeds acceptable levels. The device could not be
392 marked as faulted because there are insufficient replicas to continue
396 One or more top-level
398 is in the faulted state because one or more
399 component devices are offline. Insufficient replicas exist to continue
402 One or more component devices is in the faulted state, and insufficient
403 replicas exist to continue functioning. The underlying conditions are as
405 .Bl -bullet -offset 2n
407 The device could be opened, but the contents did not match expected values.
411 errors exceeds acceptable levels and the device is faulted to
412 prevent further use of the device.
415 The device was explicitly taken offline by the
419 The device is online and functioning.
421 The device was physically removed while the system was running. Device removal
422 detection is hardware-dependent and may not be supported on all platforms.
424 The device could not be opened. If a pool is imported when a device was
425 unavailable, then the device will be identified by a unique identifier instead
426 of its path since the path was never correct in the first place.
429 If a device is removed and later reattached to the system,
431 attempts to put the device online automatically. Device attach detection is
432 hardware-dependent and might not be supported on all platforms.
435 allows devices to be associated with pools as
437 These devices are not actively used in the pool, but when an active device
438 fails, it is automatically replaced by a hot spare. To create a pool with hot
442 with any number of devices. For example,
443 .Bd -literal -offset 2n
444 .Li # Ic zpool create pool mirror da0 da1 spare da2 da3
447 Spares can be shared across multiple pools, and can be added with the
449 command and removed with the
451 command. Once a spare replacement is initiated, a new "spare"
454 within the configuration that will remain there until the original device is
455 replaced. At this point, the hot spare becomes available again if another
458 If a pool has a shared spare that is currently being used, the pool can not be
459 exported since other pools may use this shared spare, which may lead to
460 potential data corruption.
462 An in-progress spare replacement can be cancelled by detaching the hot spare.
463 If the original faulted device is detached, then the hot spare assumes its
464 place in the configuration, and is removed from the spare list of all active
467 Spares cannot replace log devices.
475 requirements for synchronous transactions. For instance, databases often
476 require their transactions to be on stable storage devices when returning from
479 and other applications can also use
481 to ensure data stability. By default, the intent log is allocated from blocks
482 within the main pool. However, it might be possible to get better performance
483 using separate intent log devices such as
485 or a dedicated disk. For example:
486 .Bd -literal -offset 2n
487 .Li # Ic zpool create pool da0 da1 log da2
490 Multiple log devices can also be specified, and they can be mirrored. See the
492 section for an example of mirroring multiple log devices.
494 Log devices can be added, replaced, attached, detached, imported and exported
495 as part of the larger pool. Mirrored log devices can be removed by specifying
496 the top-level mirror for the log.
498 Devices can be added to a storage pool as "cache devices." These devices
499 provide an additional layer of caching between main memory and disk. For
500 read-heavy workloads, where the working set size is much larger than what can
501 be cached in main memory, using cache devices allow much more of this working
502 set to be served from low latency media. Using cache devices provides the
503 greatest performance improvement for random read-workloads of mostly static
506 To create a pool with cache devices, specify a "cache"
508 with any number of devices. For example:
509 .Bd -literal -offset 2n
510 .Li # Ic zpool create pool da0 da1 cache da2 da3
513 Cache devices cannot be mirrored or part of a
515 configuration. If a read
516 error is encountered on a cache device, that read
518 is reissued to the original storage pool device, which might be part of a
523 The content of the cache devices is considered volatile, as is the case with
526 Each pool has several properties associated with it. Some properties are
527 read-only statistics while others are configurable and change the behavior of
528 the pool. The following are read-only properties:
529 .Bl -tag -width "dedupratio"
531 Amount of storage space within the pool that has been physically allocated.
533 Percentage of pool space used. This property can also be referred to by its
534 shortened column name, "cap".
536 A text string consisting of printable ASCII characters that will be stored
537 such that it is available even if the pool becomes faulted. An administrator
538 can provide additional information about a pool using this property.
540 The deduplication ratio specified for a pool, expressed as a multiplier.
543 value of 1.76 indicates that 1.76 units of data were stored but only 1 unit of disk space was actually consumed. See
545 for a description of the deduplication feature.
547 Amount of uninitialized space within the pool or device that can be used to
548 increase the total capacity of the pool.
549 Uninitialized space consists of
550 any space on an EFI labeled vdev which has not been brought online
551 .Pq i.e. zpool online -e .
552 This space occurs when a LUN is dynamically expanded.
554 The amount of fragmentation in the pool.
556 Number of blocks within the pool that are not allocated.
558 After a file system or snapshot is destroyed, the space it was using is
559 returned to the pool asynchronously.
561 is the amount of space remaining to be reclaimed.
568 A unique identifier for the pool.
570 The current health of the pool. Health can be
579 Total size of the storage pool.
580 .It Sy unsupported@ Ns Ar feature_guid
581 Information about unsupported features that are enabled on the pool.
586 Amount of storage space used within the pool.
589 The space usage properties report actual physical space available to the
590 storage pool. The physical space can be different from the total amount of
591 space that any contained datasets can actually use. The amount of space used in
594 configuration depends on the characteristics of the data being written.
597 reserves some space for internal accounting that the
599 command takes into account, but the
601 command does not. For non-full pools of a reasonable size, these effects should
602 be invisible. For small pools, or pools that are close to being completely
603 full, these discrepancies may become more noticeable.
605 The following property can be set at creation time and import time:
608 Alternate root directory. If set, this directory is prepended to any mount
609 points within the pool. This can be used when examining an unknown pool where
610 the mount points cannot be trusted, or in an alternate boot environment, where
611 the typical paths are not valid.
613 is not a persistent property. It is valid only while the system is up.
618 though this may be overridden using an explicit setting.
621 The following property can only be set at import time:
623 .It Sy readonly Ns = Ns Cm on No | Cm off
626 pool will be imported in read-only mode with the following restrictions:
627 .Bl -bullet -offset 2n
629 Synchronous data in the intent log will not be accessible
631 Properties of the pool can not be changed
633 Datasets of this pool can only be mounted read-only
635 To write to a read-only pool, a export and import of the pool is required.
638 This property can also be referred to by its shortened column name,
642 The following properties can be set at creation time and import time, and later
647 .It Sy autoexpand Ns = Ns Cm on No | Cm off
648 Controls automatic pool expansion when the underlying LUN is grown. If set to
650 the pool will be resized according to the size of the expanded
651 device. If the device is part of a mirror or
653 then all devices within that
654 .No mirror/ Ns No raidz
655 group must be expanded before the new space is made available to
656 the pool. The default behavior is
658 This property can also be referred to by its shortened column name,
660 .It Sy autoreplace Ns = Ns Cm on No | Cm off
661 Controls automatic device replacement. If set to
663 device replacement must be initiated by the administrator by using the
667 any new device, found in the same
668 physical location as a device that previously belonged to the pool, is
669 automatically formatted and replaced. The default behavior is
671 This property can also be referred to by its shortened column name, "replace".
672 .It Sy bootfs Ns = Ns Ar pool Ns / Ns Ar dataset
673 Identifies the default bootable dataset for the root pool. This property is
674 expected to be set mainly by the installation and upgrade programs.
675 .It Sy cachefile Ns = Ns Ar path No | Cm none
676 Controls the location of where the pool configuration is cached. Discovering
677 all pools on system startup requires a cached copy of the configuration data
678 that is stored on the root file system. All pools in this cache are
679 automatically imported when the system boots. Some environments, such as
680 install and clustering, need to cache this information in a different location
681 so that pools are not automatically imported. Setting this property caches the
682 pool configuration in a different location that can later be imported with
683 .Qq Nm Cm import Fl c .
684 Setting it to the special value
686 creates a temporary pool that is never cached, and the special value
688 (empty string) uses the default location.
689 .It Sy comment Ns = Ns Ar text
690 A text string consisting of printable ASCII characters that will be stored
691 such that it is available even if the pool becomes faulted.
692 An administrator can provide additional information about a pool using this
694 .It Sy dedupditto Ns = Ns Ar number
695 Threshold for the number of block ditto copies. If the reference count for a
696 deduplicated block increases above this number, a new ditto copy of this block
697 is automatically stored. Default setting is
699 which causes no ditto copies to be created for deduplicated blocks.
700 The miniumum legal nonzero setting is 100.
701 .It Sy delegation Ns = Ns Cm on No | Cm off
702 Controls whether a non-privileged user is granted access based on the dataset
703 permissions defined on the dataset. See
705 for more information on
707 delegated administration.
708 .It Sy failmode Ns = Ns Cm wait No | Cm continue No | Cm panic
709 Controls the system behavior in the event of catastrophic pool failure. This
710 condition is typically a result of a loss of connectivity to the underlying
711 storage device(s) or a failure of all devices within the pool. The behavior of
712 such an event is determined as follows:
713 .Bl -tag -width indent
717 access until the device connectivity is recovered and the errors are cleared.
718 This is the default behavior.
724 requests but allows reads to any of the remaining healthy devices. Any write
725 requests that have yet to be committed to disk would be blocked.
727 Prints out a message to the console and generates a system crash dump.
729 .It Sy feature@ Ns Ar feature_name Ns = Ns Sy enabled
730 The value of this property is the current state of
732 The only valid value when setting this property is
736 to the enabled state.
739 for details on feature states.
740 .It Sy listsnaps Ns = Ns Cm on No | Cm off
741 Controls whether information about snapshots associated with this pool is
746 option. The default value is
748 .It Sy version Ns = Ns Ar version
749 The current on-disk version of the pool. This can be increased, but never
750 decreased. The preferred method of updating pools is with the
752 command, though this property can be used when a specific version is needed
753 for backwards compatibility.
754 Once feature flags is enabled on a pool this property will no longer have a
758 All subcommands that modify state are logged persistently to the pool in their
763 command provides subcommands to create and destroy storage pools, add capacity
764 to storage pools, and provide information about the storage pools. The following
765 subcommands are supported:
772 Displays a help message.
780 Adds the specified virtual devices to the given pool. The
782 specification is described in the
783 .Qq Sx Virtual Devices
784 section. The behavior of the
786 option, and the device checks performed are described in the
789 .Bl -tag -width indent
793 even if they appear in use or specify a conflicting replication level.
794 Not all devices can be overridden in this manner.
796 Displays the configuration that would be used without actually adding the
798 The actual pool creation can still fail due to insufficient privileges or device
801 Do not add a disk that is currently configured as a quorum device to a zpool.
802 After a disk is in the pool, that disk can then be configured as a quorum
809 .Ar pool device new_device
816 device. The existing device cannot be part of a
820 is not currently part of a mirrored configuration,
822 automatically transforms into a two-way mirror of
823 .Ar device No and Ar new_device .
826 is part of a two-way mirror, attaching
828 creates a three-way mirror, and so on. In either case,
830 begins to resilver immediately.
831 .Bl -tag -width indent
835 even if its appears to be in use. Not all devices can be overridden in this
846 Clears device errors in a pool. If no arguments are specified, all device
847 errors within the pool are cleared. If one or more devices is specified, only
848 those errors associated with the specified device or devices are cleared.
849 .Bl -tag -width indent
851 Initiates recovery mode for an unopenable pool. Attempts to discard the last
852 few transactions in the pool to return it to an openable state. Not all damaged
853 pools can be recovered by using this option. If successful, the data from the
854 discarded transactions is irretrievably lost.
856 Used in combination with the
858 flag. Check whether discarding transactions would make the pool openable, but
859 do not actually discard any transactions.
865 .Op Fl o Ar property Ns = Ns Ar value
867 .Op Fl O Ar file-system-property Ns = Ns Ar value
869 .Op Fl m Ar mountpoint
874 Creates a new storage pool containing the virtual devices specified on the
875 command line. The pool name must begin with a letter, and can only contain
876 alphanumeric characters as well as underscore ("_"), dash ("-"), and period
877 ("."). The pool names "mirror", "raidz", "spare" and "log" are reserved, as are
878 names beginning with the pattern "c[0-9]". The
880 specification is described in the
881 .Qq Sx Virtual Devices
884 The command verifies that each device specified is accessible and not currently
885 in use by another subsystem. There are some uses, such as being currently
886 mounted, or specified as the dedicated dump device, that prevents a device from
889 Other uses, such as having a preexisting
891 file system, can be overridden with the
895 The command also checks that the replication strategy for the pool is
896 consistent. An attempt to combine redundant and non-redundant storage in a
897 single pool, or to mix disks and files, results in an error unless
899 is specified. The use of differently sized devices within a single
901 or mirror group is also flagged as an error unless
907 option is specified, the default mount point is
909 The mount point must not exist or must be empty, or else the
910 root dataset cannot be mounted. This can be overridden with the
914 By default all supported features are enabled on the new pool unless the
917 .Bl -tag -width indent
921 even if they appear in use or specify a conflicting replication level.
922 Not all devices can be overridden in this manner.
924 Displays the configuration that would be used without actually creating the
925 pool. The actual pool creation can still fail due to insufficient privileges or
928 Do not enable any features on the new pool.
929 Individual features can be enabled by setting their corresponding properties
937 for details about feature properties.
939 .Fl o Ar property Ns = Ns Ar value
940 .Op Fl o Ar property Ns = Ns Ar value
943 Sets the given pool properties. See the
945 section for a list of valid properties that can be set.
948 .Ar file-system-property Ns = Ns Ar value
949 .Op Fl O Ar file-system-property Ns = Ns Ar value
952 Sets the given file system properties in the root file system of the pool. See
954 for a list of valid properties that
958 .Qq Fl o Cm cachefile=none,altroot= Ns Pa root
959 .It Fl m Ar mountpoint
960 Sets the mount point for the root dataset. The default mount point is
963 .Qq Cm altroot Ns Pa /pool
966 is specified. The mount point must be an absolute path,
970 For more information on dataset mount points, see
980 Destroys the given pool, freeing up any devices for other use. This command
981 tries to unmount any active datasets before destroying the pool.
982 .Bl -tag -width indent
984 Forces any active datasets contained within the pool to be unmounted.
994 from a mirror. The operation is refused if there are no other valid replicas
1003 Exports the given pools from the system. All devices are marked as exported,
1004 but are still considered in use by other subsystems. The devices can be moved
1005 between systems (even those of different endianness) and imported as long as a
1006 sufficient number of devices are present.
1008 Before exporting the pool, all datasets within the pool are unmounted. A pool
1009 can not be exported if it has a shared spare that is currently being used.
1011 For pools to be portable, you must give the
1013 command whole disks, not just slices, so that
1015 can label the disks with portable
1017 labels. Otherwise, disk drivers on platforms of different endianness will not
1018 recognize the disks.
1019 .Bl -tag -width indent
1021 Forcefully unmount all datasets, using the
1025 This command will forcefully export the pool even if it has a shared spare that
1026 is currently being used. This may lead to potential data corruption.
1032 .Op Fl o Ar field Ns Op , Ns Ar ...
1033 .Ar all | property Ns Op , Ns Ar ...
1037 Retrieves the given list of properties (or all properties if
1039 is used) for the specified storage pool(s). These properties are displayed with
1040 the following fields:
1041 .Bl -column -offset indent "property"
1042 .It name Ta Name of storage pool
1043 .It property Ta Property name
1044 .It value Ta Property value
1045 .It source Ta Property source, either 'default' or 'local'.
1050 section for more information on the available pool properties.
1052 Scripted mode. Do not display headers, and separate fields by a single tab
1053 instead of arbitrary space.
1055 Display numbers in parsable (exact) values.
1057 A comma-separated list of columns to display.
1059 .Sy property Ns , Ns
1062 is the default value.
1071 Displays the command history of the specified pools or all pools if no pool is
1073 .Bl -tag -width indent
1075 Displays internally logged
1077 events in addition to user initiated events.
1079 Displays log records in long format, which in addition to standard format
1080 includes, the user name, the hostname, and the zone in which the operation was
1086 .Op Fl d Ar dir | Fl c Ar cachefile
1090 Lists pools available to import. If the
1092 option is not specified, this command searches for devices in
1096 option can be specified multiple times, and all directories are searched. If
1097 the device appears to be part of an exported pool, this command displays a
1098 summary of the pool with the name of the pool, a numeric identifier, as well as
1101 layout and current health of the device for each device or file.
1102 Destroyed pools, pools that were previously destroyed with the
1104 command, are not listed unless the
1106 option is specified.
1108 The numeric identifier is unique, and can be used instead of the pool name when
1109 multiple exported pools of the same name are available.
1110 .Bl -tag -width indent
1111 .It Fl c Ar cachefile
1112 Reads configuration from the given
1114 that was created with the
1118 is used instead of searching for devices.
1120 Searches for devices or files in
1124 option can be specified multiple times.
1126 Lists destroyed pools only.
1132 .Op Fl o Ar property Ns = Ns Ar value
1134 .Op Fl d Ar dir | Fl c Ar cachefile
1144 Imports all pools found in the search directories. Identical to the previous
1145 command, except that all pools with a sufficient number of devices available
1146 are imported. Destroyed pools, pools that were previously destroyed with the
1148 command, will not be imported unless the
1150 option is specified.
1151 .Bl -tag -width indent
1153 Comma-separated list of mount options to use when mounting datasets within the
1156 for a description of dataset properties and mount options.
1157 .It Fl o Ar property Ns = Ns Ar value
1158 Sets the specified property on the imported pool. See the
1160 section for more information on the available pool properties.
1161 .It Fl c Ar cachefile
1162 Reads configuration from the given
1164 that was created with the
1168 is used instead of searching for devices.
1170 Searches for devices or files in
1174 option can be specified multiple times. This option is incompatible with the
1178 Imports destroyed pools only. The
1180 option is also required.
1182 Forces import, even if the pool appears to be potentially active.
1184 Allows a pool to import when there is a missing log device. Recent transactions
1185 can be lost because the log device will be discarded.
1187 Import the pool without mounting any file systems.
1198 Recovery mode for a non-importable pool. Attempt to return the pool to an
1199 importable state by discarding the last few transactions. Not all damaged pools
1200 can be recovered by using this option. If successful, the data from the
1201 discarded transactions is irretrievably lost. This option is ignored if the
1202 pool is importable or already imported.
1206 recovery option. Determines whether a non-importable pool can be made
1207 importable again, but does not actually perform the pool recovery. For more
1208 details about pool recovery mode, see the
1212 Searches for and imports all pools found.
1218 .Op Fl o Ar property Ns = Ns Ar value
1220 .Op Fl d Ar dir | Fl c Ar cachefile
1231 Imports a specific pool. A pool can be identified by its name or the numeric
1234 is specified, the pool is imported using the name
1236 Otherwise, it is imported with the same name as its exported name.
1238 If a device is removed from a system without running
1240 first, the device appears as potentially active. It cannot be determined if
1241 this was a failed export, or whether the device is really in use from another
1242 host. To import a pool in this state, the
1245 .Bl -tag -width indent
1247 Comma-separated list of mount options to use when mounting datasets within the
1250 for a description of dataset properties and mount options.
1251 .It Fl o Ar property Ns = Ns Ar value
1252 Sets the specified property on the imported pool. See the
1254 section for more information on the available pool properties.
1255 .It Fl c Ar cachefile
1256 Reads configuration from the given
1258 that was created with the
1262 is used instead of searching for devices.
1264 Searches for devices or files in
1268 option can be specified multiple times. This option is incompatible with the
1272 Imports destroyed pools only. The
1274 option is also required.
1276 Forces import, even if the pool appears to be potentially active.
1278 Allows a pool to import when there is a missing log device. Recent transactions
1279 can be lost because the log device will be discarded.
1281 Import the pool without mounting any file systems.
1284 .Qq Fl o Cm cachefile=none,altroot= Ns Pa root
1286 Recovery mode for a non-importable pool. Attempt to return the pool to an
1287 importable state by discarding the last few transactions. Not all damaged pools
1288 can be recovered by using this option. If successful, the data from the
1289 discarded transactions is irretrievably lost. This option is ignored if the
1290 pool is importable or already imported.
1294 recovery option. Determines whether a non-importable pool can be made
1295 importable again, but does not actually perform the pool recovery. For more
1296 details about pool recovery mode, see the
1303 .Op Fl T Cm d Ns | Ns Cm u
1307 .Op Ar interval Op Ar count
1312 statistics for the given pools. When given an interval, the statistics are
1319 are specified, statistics for every pool in the system is shown. If
1321 is specified, the command exits after
1323 reports are printed.
1324 .Bl -tag -width indent
1325 .It Fl T Cm d Ns | Ns Cm u
1330 for standard date format. See
1335 .Pq equals Qq Ic date +%s .
1337 Verbose statistics. Reports usage statistics for individual
1339 within the pool, in addition to the pool-wide statistics.
1350 label information from the specified
1354 must not be part of an active pool configuration.
1355 .Bl -tag -width indent
1357 Treat exported or foreign devices as inactive.
1363 .Op Fl o Ar property Ns Op , Ns Ar ...
1364 .Op Fl T Cm d Ns | Ns Cm u
1367 .Op Ar inverval Op Ar count
1370 Lists the given pools along with a health status and space usage. If no
1372 are specified, all pools in the system are listed.
1374 When given an interval, the output is printed every
1380 is specified, the command exits after
1382 reports are printed.
1383 .Bl -tag -width indent
1384 .It Fl T Cm d Ns | Ns Cm u
1389 for standard date format. See
1394 .Pq equals Qq Ic date +%s .
1396 Scripted mode. Do not display headers, and separate fields by a single tab
1397 instead of arbitrary space.
1399 Display numbers in parsable (exact) values.
1401 Verbose statistics. Reports usage statistics for individual
1404 the pool, in addition to the pool-wide statistics.
1405 .It Fl o Ar property Ns Op , Ns Ar ...
1406 Comma-separated list of properties to display. See the
1408 section for a list of valid properties. The default list is
1418 .It Fl T Cm d Ns | Ns Cm u
1423 for standard date format. See
1428 .Pq equals Qq Ic date +%s .
1437 Takes the specified physical device offline. While the
1439 is offline, no attempt is made to read or write to the device.
1440 .Bl -tag -width indent
1442 Temporary. Upon reboot, the specified physical device reverts to its previous
1452 Brings the specified physical device online.
1454 This command is not applicable to spares or cache devices.
1455 .Bl -tag -width indent
1457 Expand the device to use all available space. If the device is part of a mirror
1460 then all devices must be expanded before the new space will become
1461 available to the pool.
1469 Generates a new unique identifier for the pool. You must ensure that all
1470 devices in this pool are online and healthy before performing this action.
1477 Removes the specified device from the pool. This command currently only
1478 supports removing hot spares, cache, and log devices. A mirrored log device can
1479 be removed by specifying the top-level mirror for the log. Non-log devices that
1480 are part of a mirrored configuration can be removed using the
1482 command. Non-redundant and
1484 devices cannot be removed from a pool.
1491 Reopen all the vdevs associated with the pool.
1504 This is equivalent to attaching
1506 waiting for it to resilver, and then detaching
1511 must be greater than or equal to the minimum size
1512 of all the devices in a mirror or
1517 is required if the pool is not redundant. If
1519 is not specified, it defaults to
1521 This form of replacement is useful after an existing disk has failed and has
1522 been physically replaced. In this case, the new disk may have the same
1524 path as the old device, even though it is actually a different disk.
1527 .Bl -tag -width indent
1531 even if its appears to be in use. Not all devices can be overridden in this
1541 Begins a scrub. The scrub examines all data in the specified pools to verify
1542 that it checksums correctly. For replicated (mirror or
1546 automatically repairs any damage discovered during the scrub. The
1548 command reports the progress of the scrub and summarizes the results of the
1549 scrub upon completion.
1551 Scrubbing and resilvering are very similar operations. The difference is that
1552 resilvering only examines data that
1554 knows to be out of date (for example, when attaching a new device to a mirror
1555 or replacing an existing device), whereas scrubbing examines all data to
1556 discover silent errors due to hardware faults or disk failure.
1558 Because scrubbing and resilvering are
1559 .Tn I/O Ns -intensive
1562 only allows one at a time. If a scrub is already in progress, the
1564 command returns an error. To start a new scrub, you have to stop the old scrub
1566 .Qq Nm Cm scrub Fl s
1567 command first. If a resilver is in progress,
1569 does not allow a scrub to be started until the resilver completes.
1570 .Bl -tag -width indent
1577 .Ar property Ns = Ns Ar value pool
1580 Sets the given property on the specified pool. See the
1582 section for more information on what properties can be set and acceptable
1590 .Op Fl o Ar property Ns = Ns Ar value
1595 Splits off one disk from each mirrored top-level
1597 in a pool and creates a new pool from the split-off disks. The original pool
1598 must be made up of one or more mirrors and must not be in the process of
1601 subcommand chooses the last device in each mirror
1603 unless overridden by a device specification on the command line.
1609 includes the specified device(s) in a new pool and, should any devices remain
1610 unspecified, assigns the last device in each mirror
1612 to that pool, as it does normally. If you are uncertain about the outcome of a
1616 ("dry-run") option to ensure your command will have the effect you intend.
1617 .Bl -tag -width indent
1619 Automatically import the newly created pool after splitting, using the
1622 parameter for the new pool's alternate root. See the
1628 Displays the configuration that would be created without actually splitting the
1629 pool. The actual pool split could still fail due to insufficient privileges or
1632 Comma-separated list of mount options to use when mounting datasets within the
1635 for a description of dataset properties and mount options. Valid only in
1636 conjunction with the
1639 .It Fl o Ar property Ns = Ns Ar value
1640 Sets the specified property on the new pool. See the
1642 section, above, for more information on the available pool properties.
1648 .Op Fl T Cm d Ns | Ns Cm u
1651 .Op Ar interval Op Ar count
1654 Displays the detailed health status for the given pools. If no
1656 is specified, then the status of each pool in the system is displayed. For more
1657 information on pool and device health, see the
1658 .Qq Sx Device Failure and Recovery
1661 When given an interval, the output is printed every
1667 is specified, the command exits after
1669 reports are printed.
1671 If a scrub or resilver is in progress, this command reports the percentage
1672 done and the estimated time to completion. Both of these are only approximate,
1673 because the amount of data in the pool and the other workloads on the system
1675 .Bl -tag -width indent
1677 Only display status for pools that are exhibiting errors or are otherwise
1679 Warnings about pools not using the latest on-disk format, having non-native
1680 block size or disabled features will not be included.
1682 Displays verbose data error information, printing out a complete list of all
1683 data errors since the last complete pool scrub.
1684 .It Fl T Cm d Ns | Ns Cm u
1689 for standard date format. See
1694 .Pq equals Qq Ic date +%s .
1702 Displays pools which do not have all supported features enabled and pools
1703 formatted using a legacy
1706 These pools can continue to be used, but some features may not be available.
1709 to enable all features on all pools.
1710 .Bl -tag -width indent
1714 versions supported by the current software.
1716 .Xr zpool-features 7
1717 for a description of feature flags features supported by the current software.
1726 Enables all supported features on the given pool.
1727 Once this is done, the pool will no longer be accessible on systems that do
1728 not support feature flags.
1730 .Xr zpool-features 7
1731 for details on compatibility with systems that support feature flags, but do
1732 not support all features enabled on the pool.
1733 .Bl -tag -width indent
1735 Enables all supported features on all pools.
1737 Upgrade to the specified legacy version. If the
1739 flag is specified, no features will be enabled on the pool.
1740 This option can only be used to increase version number up to the last
1741 supported legacy version number.
1745 The following exit values are returned:
1746 .Bl -tag -offset 2n -width 2n
1748 Successful completion.
1752 Invalid command line options were specified.
1756 .It Sy Example 1 No Creating a RAID-Z Storage Pool
1758 The following command creates a pool with a single
1762 that consists of six disks.
1763 .Bd -literal -offset 2n
1764 .Li # Ic zpool create tank raidz da0 da1 da2 da3 da4 da5
1766 .It Sy Example 2 No Creating a Mirrored Storage Pool
1768 The following command creates a pool with two mirrors, where each mirror
1770 .Bd -literal -offset 2n
1771 .Li # Ic zpool create tank mirror da0 da1 mirror da2 da3
1773 .It Sy Example 3 No Creating a Tn ZFS No Storage Pool by Using Partitions
1775 The following command creates an unmirrored pool using two GPT partitions.
1776 .Bd -literal -offset 2n
1777 .Li # Ic zpool create tank da0p3 da1p3
1779 .It Sy Example 4 No Creating a Tn ZFS No Storage Pool by Using Files
1781 The following command creates an unmirrored pool using files. While not
1782 recommended, a pool based on files can be useful for experimental purposes.
1783 .Bd -literal -offset 2n
1784 .Li # Ic zpool create tank /path/to/file/a /path/to/file/b
1786 .It Sy Example 5 No Adding a Mirror to a Tn ZFS No Storage Pool
1788 The following command adds two mirrored disks to the pool
1790 assuming the pool is already made up of two-way mirrors. The additional space
1791 is immediately available to any datasets within the pool.
1792 .Bd -literal -offset 2n
1793 .Li # Ic zpool add tank mirror da2 da3
1795 .It Sy Example 6 No Listing Available Tn ZFS No Storage Pools
1797 The following command lists all available pools on the system.
1798 .Bd -literal -offset 2n
1800 NAME SIZE ALLOC FREE FRAG EXPANDSZ CAP DEDUP HEALTH ALTROOT
1801 pool 2.70T 473G 2.24T 33% - 17% 1.00x ONLINE -
1802 test 1.98G 89.5K 1.98G 48% - 0% 1.00x ONLINE -
1804 .It Sy Example 7 No Listing All Properties for a Pool
1806 The following command lists all the properties for a pool.
1807 .Bd -literal -offset 2n
1808 .Li # Ic zpool get all pool
1811 pool altroot - default
1812 pool health ONLINE -
1813 pool guid 2501120270416322443 default
1814 pool version 28 default
1815 pool bootfs pool/root local
1816 pool delegation on default
1817 pool autoreplace off default
1818 pool cachefile - default
1819 pool failmode wait default
1820 pool listsnapshots off default
1821 pool autoexpand off default
1822 pool dedupditto 0 default
1823 pool dedupratio 1.00x -
1825 pool allocated 473G -
1828 .It Sy Example 8 No Destroying a Tn ZFS No Storage Pool
1830 The following command destroys the pool
1832 and any datasets contained within.
1833 .Bd -literal -offset 2n
1834 .Li # Ic zpool destroy -f tank
1836 .It Sy Example 9 No Exporting a Tn ZFS No Storage Pool
1838 The following command exports the devices in pool
1840 so that they can be relocated or later imported.
1841 .Bd -literal -offset 2n
1842 .Li # Ic zpool export tank
1844 .It Sy Example 10 No Importing a Tn ZFS No Storage Pool
1846 The following command displays available pools, and then imports the pool
1848 for use on the system.
1850 The results from this command are similar to the following:
1851 .Bd -literal -offset 2n
1852 .Li # Ic zpool import
1855 id: 15451357997522795478
1857 action: The pool can be imported using its name or numeric identifier.
1869 Storage Pools to the Current Version
1872 The following command upgrades all
1874 Storage pools to the current version of
1876 .Bd -literal -offset 2n
1877 .Li # Ic zpool upgrade -a
1878 This system is currently running ZFS pool version 28.
1880 .It Sy Example 12 No Managing Hot Spares
1882 The following command creates a new pool with an available hot spare:
1883 .Bd -literal -offset 2n
1884 .Li # Ic zpool create tank mirror da0 da1 spare da2
1887 If one of the disks were to fail, the pool would be reduced to the degraded
1888 state. The failed device can be replaced using the following command:
1889 .Bd -literal -offset 2n
1890 .Li # Ic zpool replace tank da0 da2
1893 Once the data has been resilvered, the spare is automatically removed and is
1894 made available should another device fails. The hot spare can be permanently
1895 removed from the pool using the following command:
1896 .Bd -literal -offset 2n
1897 .Li # Ic zpool remove tank da2
1903 Pool with Mirrored Separate Intent Logs
1906 The following command creates a
1908 storage pool consisting of two, two-way
1909 mirrors and mirrored log devices:
1910 .Bd -literal -offset 2n
1911 .Li # Ic zpool create pool mirror da0 da1 mirror da2 da3 log mirror da4 da5
1913 .It Sy Example 14 No Adding Cache Devices to a Tn ZFS No Pool
1915 The following command adds two disks for use as cache devices to a
1918 .Bd -literal -offset 2n
1919 .Li # Ic zpool add pool cache da2 da3
1922 Once added, the cache devices gradually fill with content from main memory.
1923 Depending on the size of your cache devices, it could take over an hour for
1924 them to fill. Capacity and reads can be monitored using the
1926 subcommand as follows:
1927 .Bd -literal -offset 2n
1928 .Li # Ic zpool iostat -v pool 5
1932 Displaying expanded space on a device
1935 The following command dipslays the detailed information for the
1938 This pool is comprised of a single
1940 vdev where one of its
1941 devices increased its capacity by 10GB.
1942 In this example, the pool will not
1943 be able to utilized this extra capacity until all the devices under the
1945 vdev have been expanded.
1946 .Bd -literal -offset 2n
1947 .Li # Ic zpool list -v data
1948 NAME SIZE ALLOC FREE FRAG EXPANDSZ CAP DEDUP HEALTH ALTROOT
1949 data 23.9G 14.6G 9.30G 48% - 61% 1.00x ONLINE -
1950 raidz1 23.9G 14.6G 9.30G 48% -
1957 Removing a Mirrored Log Device
1960 The following command removes the mirrored log device
1963 Given this configuration:
1964 .Bd -literal -offset 2n
1967 scrub: none requested
1970 NAME STATE READ WRITE CKSUM
1972 mirror-0 ONLINE 0 0 0
1975 mirror-1 ONLINE 0 0 0
1979 mirror-2 ONLINE 0 0 0
1984 The command to remove the mirrored log
1987 .Bd -literal -offset 2n
1988 .Li # Ic zpool remove tank mirror-2
1992 Recovering a Faulted
1997 If a pool is faulted but recoverable, a message indicating this state is
2000 if the pool was cached (see the
2002 argument above), or as part of the error output from a failed
2006 Recover a cached pool with the
2009 .Bd -literal -offset 2n
2010 .Li # Ic zpool clear -F data
2011 Pool data returned to its state as of Tue Sep 08 13:23:35 2009.
2012 Discarded approximately 29 seconds of transactions.
2015 If the pool configuration was not cached, use
2017 with the recovery mode flag:
2018 .Bd -literal -offset 2n
2019 .Li # Ic zpool import -F data
2020 Pool data returned to its state as of Tue Sep 08 13:23:35 2009.
2021 Discarded approximately 29 seconds of transactions.
2025 .Xr zpool-features 7 ,
2028 This manual page is a
2030 reimplementation of the
2034 modified and customized for
2036 and licensed under the Common Development and Distribution License
2041 implementation of this manual page was initially written by
2042 .An Martin Matuska Aq mm@FreeBSD.org .
2046 feature requires a utility to detect zpool degradation and initiate
2047 disk replacement within the zpool. FreeBSD does not provide such a
2048 utility at this time.
projects / FreeBSD / releng / 10.2.git / blob