2 .\" Copyright (c) 2012, Martin Matuska <mm@FreeBSD.org>.
3 .\" All Rights Reserved.
5 .\" The contents of this file are subject to the terms of the
6 .\" Common Development and Distribution License (the "License").
7 .\" You may not use this file except in compliance with the License.
9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10 .\" or http://www.opensolaris.org/os/licensing.
11 .\" See the License for the specific language governing permissions
12 .\" and limitations under the License.
14 .\" When distributing Covered Code, include this CDDL HEADER in each
15 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16 .\" If applicable, add the following below this CDDL HEADER, with the
17 .\" fields enclosed by brackets "[]" replaced with your own identifying
18 .\" information: Portions Copyright [yyyy] [name of copyright owner]
20 .\" Copyright (c) 2010, Sun Microsystems, Inc. All Rights Reserved.
21 .\" Copyright 2011, Nexenta Systems, Inc. All Rights Reserved.
22 .\" Copyright (c) 2011, Justin T. Gibbs <gibbs@FreeBSD.org>
23 .\" Copyright (c) 2012 by Delphix. All Rights Reserved.
24 .\" Copyright (c) 2012, Glen Barber <gjb@FreeBSD.org>
33 .Nd configures ZFS storage pools
44 .Ar pool device new_device
53 .Op Fl o Ar property Ns = Ns Ar value
55 .Op Fl O Ar file-system-property Ns = Ns Ar value
57 .Op Fl m Ar mountpoint
73 .Ar all | property Ns Op , Ns Ar ...
82 .Op Fl d Ar dir | Fl c Ar cachefile
87 .Op Fl o Ar property Ns = Ns Ar value
89 .Op Fl d Ar dir | Fl c Ar cachefile
100 .Op Fl o Ar property Ns = Ns Ar value
102 .Op Fl d Ar dir | Fl c Ar cachefile
113 .Op Fl T Cm d Ns | Ns Cm u
124 .Op Fl o Ar property Ns Op , Ns Ar ...
125 .Op Fl T Cm d Ns | Ns Cm u
128 .Op Ar inverval Op Ar count
157 .Ar property Ns = Ns Ar value pool
163 .Op Fl o Ar property Ns = Ns Ar value
169 .Op Fl T Cm d Ns | Ns Cm u
172 .Op Ar interval Op Ar count
185 storage pools. A storage pool is a collection of devices that provides physical
186 storage and data replication for
190 All datasets within a storage pool share the same space. See
192 for information on managing datasets.
193 .Ss Virtual Devices (vdevs)
197 describes a single device or a collection of devices organized according to
198 certain performance and fault characteristics. The following virtual devices
200 .Bl -tag -width "XXXXXX"
202 A block device, typically located under
205 can use individual slices or partitions, though the recommended mode of
206 operation is to use whole disks. A disk can be specified by a full path to the
209 provider name. When given a whole disk,
211 automatically labels the disk, if necessary.
213 A regular file. The use of files as a backing store is strongly discouraged. It
214 is designed primarily for experimental purposes, as the fault tolerance of a
215 file is only as good the file system of which it is a part. A file must be
216 specified by a full path.
218 A mirror of two or more devices. Data is replicated in an identical fashion
219 across all components of a mirror. A mirror with
225 bytes and can withstand
227 devices failing before data integrity is compromised.
230 .Sy raidz1 raidz2 raidz3 ) .
233 that allows for better distribution of parity and eliminates the
235 write hole (in which data and parity become inconsistent after a power loss).
236 Data and parity is striped across all disks within a
242 group can have single-, double- , or triple parity, meaning that the
244 group can sustain one, two, or three failures, respectively, without
247 type specifies a single-parity
251 type specifies a double-parity
255 type specifies a triple-parity
270 parity disks can hold approximately
275 bytes and can withstand
277 device(s) failing before data integrity is compromised. The minimum number of
280 group is one more than the number of parity disks. The
281 recommended number is between 3 and 9 to help increase performance.
284 .No pseudo- Ns No vdev
285 which keeps track of available hot spares for a pool.
286 For more information, see the
290 A separate-intent log device. If more than one log device is specified, then
291 writes are load-balanced between devices. Log devices can be mirrored. However,
294 types are not supported for the intent log. For more information,
299 A device used to cache storage pool data. A cache device cannot be configured
302 group. For more information, see the
307 Virtual devices cannot be nested, so a mirror or
309 virtual device can only
310 contain files or disks. Mirrors of mirrors (or other combinations) are not
313 A pool can have any number of virtual devices at the top of the configuration
317 Data is dynamically distributed across all top-level devices to balance data
318 among devices. As new virtual devices are added,
320 automatically places data on the newly available devices.
322 Virtual devices are specified one at a time on the command line, separated by
323 whitespace. The keywords
327 are used to distinguish where a group ends and another begins. For example, the
328 following creates two root
330 each a mirror of two disks:
331 .Bd -literal -offset 2n
332 .Li # Ic zpool create mypool mirror da0 da1 mirror da2 da3
334 .Ss Device Failure and Recovery
336 supports a rich set of mechanisms for handling device failure and data
337 corruption. All metadata and data is checksummed, and
339 automatically repairs bad data from a good copy when corruption is detected.
341 In order to take advantage of these features, a pool must make use of some form
342 of redundancy, using either mirrored or
346 supports running in a non-redundant configuration, where each root
348 is simply a disk or file, this is strongly discouraged. A single case of bit
349 corruption can render some or all of your data unavailable.
351 A pool's health status is described by one of three states: online, degraded,
352 or faulted. An online pool has all devices operating normally. A degraded pool
353 is one in which one or more devices have failed, but the data is still
354 available due to a redundant configuration. A faulted pool has corrupted
355 metadata, or one or more faulted devices, and insufficient replicas to continue
358 The health of the top-level
363 potentially impacted by the state of its associated
365 or component devices. A top-level
367 or component device is in one of the following states:
368 .Bl -tag -width "DEGRADED"
370 One or more top-level
372 is in the degraded state because one or more
373 component devices are offline. Sufficient replicas exist to continue
376 One or more component devices is in the degraded or faulted state, but
377 sufficient replicas exist to continue functioning. The underlying conditions
379 .Bl -bullet -offset 2n
381 The number of checksum errors exceeds acceptable levels and the device is
382 degraded as an indication that something may be wrong.
384 continues to use the device as necessary.
388 errors exceeds acceptable levels. The device could not be
389 marked as faulted because there are insufficient replicas to continue
393 One or more top-level
395 is in the faulted state because one or more
396 component devices are offline. Insufficient replicas exist to continue
399 One or more component devices is in the faulted state, and insufficient
400 replicas exist to continue functioning. The underlying conditions are as
402 .Bl -bullet -offset 2n
404 The device could be opened, but the contents did not match expected values.
408 errors exceeds acceptable levels and the device is faulted to
409 prevent further use of the device.
412 The device was explicitly taken offline by the
416 The device is online and functioning.
418 The device was physically removed while the system was running. Device removal
419 detection is hardware-dependent and may not be supported on all platforms.
421 The device could not be opened. If a pool is imported when a device was
422 unavailable, then the device will be identified by a unique identifier instead
423 of its path since the path was never correct in the first place.
426 If a device is removed and later reattached to the system,
428 attempts to put the device online automatically. Device attach detection is
429 hardware-dependent and might not be supported on all platforms.
432 allows devices to be associated with pools as
434 These devices are not actively used in the pool, but when an active device
435 fails, it is automatically replaced by a hot spare. To create a pool with hot
439 with any number of devices. For example,
440 .Bd -literal -offset 2n
441 .Li # Ic zpool create pool mirror da0 da1 spare da2 da3
444 Spares can be shared across multiple pools, and can be added with the
446 command and removed with the
448 command. Once a spare replacement is initiated, a new "spare"
451 within the configuration that will remain there until the original device is
452 replaced. At this point, the hot spare becomes available again if another
455 If a pool has a shared spare that is currently being used, the pool can not be
456 exported since other pools may use this shared spare, which may lead to
457 potential data corruption.
459 An in-progress spare replacement can be cancelled by detaching the hot spare.
460 If the original faulted device is detached, then the hot spare assumes its
461 place in the configuration, and is removed from the spare list of all active
464 Spares cannot replace log devices.
472 requirements for synchronous transactions. For instance, databases often
473 require their transactions to be on stable storage devices when returning from
476 and other applications can also use
478 to ensure data stability. By default, the intent log is allocated from blocks
479 within the main pool. However, it might be possible to get better performance
480 using separate intent log devices such as
482 or a dedicated disk. For example:
483 .Bd -literal -offset 2n
484 .Li # Ic zpool create pool da0 da1 log da2
487 Multiple log devices can also be specified, and they can be mirrored. See the
489 section for an example of mirroring multiple log devices.
491 Log devices can be added, replaced, attached, detached, imported and exported
492 as part of the larger pool. Mirrored log devices can be removed by specifying
493 the top-level mirror for the log.
495 Devices can be added to a storage pool as "cache devices." These devices
496 provide an additional layer of caching between main memory and disk. For
497 read-heavy workloads, where the working set size is much larger than what can
498 be cached in main memory, using cache devices allow much more of this working
499 set to be served from low latency media. Using cache devices provides the
500 greatest performance improvement for random read-workloads of mostly static
503 To create a pool with cache devices, specify a "cache"
505 with any number of devices. For example:
506 .Bd -literal -offset 2n
507 .Li # Ic zpool create pool da0 da1 cache da2 da3
510 Cache devices cannot be mirrored or part of a
512 configuration. If a read
513 error is encountered on a cache device, that read
515 is reissued to the original storage pool device, which might be part of a
520 The content of the cache devices is considered volatile, as is the case with
523 Each pool has several properties associated with it. Some properties are
524 read-only statistics while others are configurable and change the behavior of
525 the pool. The following are read-only properties:
526 .Bl -tag -width "dedupratio"
528 Amount of storage space within the pool that has been physically allocated.
530 Percentage of pool space used. This property can also be referred to by its
531 shortened column name, "cap".
533 A text string consisting of printable ASCII characters that will be stored
534 such that it is available even if the pool becomes faulted. An administrator
535 can provide additional information about a pool using this property.
537 The deduplication ratio specified for a pool, expressed as a multiplier.
540 value of 1.76 indicates that 1.76 units of data were stored but only 1 unit of disk space was actually consumed. See
542 for a description of the deduplication feature.
544 Number of blocks within the pool that are not allocated.
546 After a file system or snapshot is destroyed, the space it was using is
547 returned to the pool asynchronously.
549 is the amount of space remaining to be reclaimed.
556 This property has currently no value on FreeBSD.
558 A unique identifier for the pool.
560 The current health of the pool. Health can be
569 Total size of the storage pool.
570 .It Sy unsupported@ Ns Ar feature_guid
571 Information about unsupported features that are enabled on the pool.
576 Amount of storage space used within the pool.
579 The space usage properties report actual physical space available to the
580 storage pool. The physical space can be different from the total amount of
581 space that any contained datasets can actually use. The amount of space used in
584 configuration depends on the characteristics of the data being written.
587 reserves some space for internal accounting that the
589 command takes into account, but the
591 command does not. For non-full pools of a reasonable size, these effects should
592 be invisible. For small pools, or pools that are close to being completely
593 full, these discrepancies may become more noticeable.
595 The following property can be set at creation time and import time:
598 Alternate root directory. If set, this directory is prepended to any mount
599 points within the pool. This can be used when examining an unknown pool where
600 the mount points cannot be trusted, or in an alternate boot environment, where
601 the typical paths are not valid.
603 is not a persistent property. It is valid only while the system is up.
608 though this may be overridden using an explicit setting.
611 The following property can only be set at import time:
613 .It Sy readonly Ns = Ns Cm on No | Cm off
616 pool will be imported in read-only mode with the following restrictions:
617 .Bl -bullet -offset 2n
619 Synchronous data in the intent log will not be accessible
621 Properties of the pool can not be changed
623 Datasets of this pool can only be mounted read-only
625 To write to a read-only pool, a export and import of the pool is required.
628 This property can also be referred to by its shortened column name,
632 The following properties can be set at creation time and import time, and later
637 .It Sy autoexpand Ns = Ns Cm on No | Cm off
638 Controls automatic pool expansion when the underlying LUN is grown. If set to
640 the pool will be resized according to the size of the expanded
641 device. If the device is part of a mirror or
643 then all devices within that
644 .No mirror/ Ns No raidz
645 group must be expanded before the new space is made available to
646 the pool. The default behavior is
648 This property can also be referred to by its shortened column name,
650 .It Sy autoreplace Ns = Ns Cm on No | Cm off
651 Controls automatic device replacement. If set to
653 device replacement must be initiated by the administrator by using the
657 any new device, found in the same
658 physical location as a device that previously belonged to the pool, is
659 automatically formatted and replaced. The default behavior is
661 This property can also be referred to by its shortened column name, "replace".
662 .It Sy bootfs Ns = Ns Ar pool Ns / Ns Ar dataset
663 Identifies the default bootable dataset for the root pool. This property is
664 expected to be set mainly by the installation and upgrade programs.
665 .It Sy cachefile Ns = Ns Ar path No | Cm none
666 Controls the location of where the pool configuration is cached. Discovering
667 all pools on system startup requires a cached copy of the configuration data
668 that is stored on the root file system. All pools in this cache are
669 automatically imported when the system boots. Some environments, such as
670 install and clustering, need to cache this information in a different location
671 so that pools are not automatically imported. Setting this property caches the
672 pool configuration in a different location that can later be imported with
673 .Qq Nm Cm import Fl c .
674 Setting it to the special value
676 creates a temporary pool that is never cached, and the special value
678 (empty string) uses the default location.
679 .It Sy comment Ns = Ns Ar text
680 A text string consisting of printable ASCII characters that will be stored
681 such that it is available even if the pool becomes faulted.
682 An administrator can provide additional information about a pool using this
684 .It Sy dedupditto Ns = Ns Ar number
685 Threshold for the number of block ditto copies. If the reference count for a
686 deduplicated block increases above this number, a new ditto copy of this block
687 is automatically stored. Default setting is
689 which causes no ditto copies to be created for deduplicated blocks.
690 The miniumum legal nonzero setting is 100.
691 .It Sy delegation Ns = Ns Cm on No | Cm off
692 Controls whether a non-privileged user is granted access based on the dataset
693 permissions defined on the dataset. See
695 for more information on
697 delegated administration.
698 .It Sy failmode Ns = Ns Cm wait No | Cm continue No | Cm panic
699 Controls the system behavior in the event of catastrophic pool failure. This
700 condition is typically a result of a loss of connectivity to the underlying
701 storage device(s) or a failure of all devices within the pool. The behavior of
702 such an event is determined as follows:
703 .Bl -tag -width indent
707 access until the device connectivity is recovered and the errors are cleared.
708 This is the default behavior.
714 requests but allows reads to any of the remaining healthy devices. Any write
715 requests that have yet to be committed to disk would be blocked.
717 Prints out a message to the console and generates a system crash dump.
719 .It Sy feature@ Ns Ar feature_name Ns = Ns Sy enabled
720 The value of this property is the current state of
722 The only valid value when setting this property is
726 to the enabled state.
729 for details on feature states.
730 .It Sy listsnaps Ns = Ns Cm on No | Cm off
731 Controls whether information about snapshots associated with this pool is
736 option. The default value is
738 .It Sy version Ns = Ns Ar version
739 The current on-disk version of the pool. This can be increased, but never
740 decreased. The preferred method of updating pools is with the
742 command, though this property can be used when a specific version is needed
743 for backwards compatibility.
744 Once feature flags is enabled on a pool this property will no longer have a
748 All subcommands that modify state are logged persistently to the pool in their
753 command provides subcommands to create and destroy storage pools, add capacity
754 to storage pools, and provide information about the storage pools. The following
755 subcommands are supported:
762 Displays a help message.
770 Adds the specified virtual devices to the given pool. The
772 specification is described in the
773 .Qq Sx Virtual Devices
774 section. The behavior of the
776 option, and the device checks performed are described in the
779 .Bl -tag -width indent
783 even if they appear in use or specify a conflicting replication level.
784 Not all devices can be overridden in this manner.
786 Displays the configuration that would be used without actually adding the
788 The actual pool creation can still fail due to insufficient privileges or device
791 Do not add a disk that is currently configured as a quorum device to a zpool.
792 After a disk is in the pool, that disk can then be configured as a quorum
799 .Ar pool device new_device
806 device. The existing device cannot be part of a
810 is not currently part of a mirrored configuration,
812 automatically transforms into a two-way mirror of
813 .Ar device No and Ar new_device .
816 is part of a two-way mirror, attaching
818 creates a three-way mirror, and so on. In either case,
820 begins to resilver immediately.
821 .Bl -tag -width indent
825 even if its appears to be in use. Not all devices can be overridden in this
836 Clears device errors in a pool. If no arguments are specified, all device
837 errors within the pool are cleared. If one or more devices is specified, only
838 those errors associated with the specified device or devices are cleared.
839 .Bl -tag -width indent
841 Initiates recovery mode for an unopenable pool. Attempts to discard the last
842 few transactions in the pool to return it to an openable state. Not all damaged
843 pools can be recovered by using this option. If successful, the data from the
844 discarded transactions is irretrievably lost.
846 Used in combination with the
848 flag. Check whether discarding transactions would make the pool openable, but
849 do not actually discard any transactions.
855 .Op Fl o Ar property Ns = Ns Ar value
857 .Op Fl O Ar file-system-property Ns = Ns Ar value
859 .Op Fl m Ar mountpoint
864 Creates a new storage pool containing the virtual devices specified on the
865 command line. The pool name must begin with a letter, and can only contain
866 alphanumeric characters as well as underscore ("_"), dash ("-"), and period
867 ("."). The pool names "mirror", "raidz", "spare" and "log" are reserved, as are
868 names beginning with the pattern "c[0-9]". The
870 specification is described in the
871 .Qq Sx Virtual Devices
874 The command verifies that each device specified is accessible and not currently
875 in use by another subsystem. There are some uses, such as being currently
876 mounted, or specified as the dedicated dump device, that prevents a device from
879 Other uses, such as having a preexisting
881 file system, can be overridden with the
885 The command also checks that the replication strategy for the pool is
886 consistent. An attempt to combine redundant and non-redundant storage in a
887 single pool, or to mix disks and files, results in an error unless
889 is specified. The use of differently sized devices within a single
891 or mirror group is also flagged as an error unless
897 option is specified, the default mount point is
899 The mount point must not exist or must be empty, or else the
900 root dataset cannot be mounted. This can be overridden with the
904 By default all supported features are enabled on the new pool unless the
907 .Bl -tag -width indent
911 even if they appear in use or specify a conflicting replication level.
912 Not all devices can be overridden in this manner.
914 Displays the configuration that would be used without actually creating the
915 pool. The actual pool creation can still fail due to insufficient privileges or
918 Do not enable any features on the new pool.
919 Individual features can be enabled by setting their corresponding properties
927 for details about feature properties.
929 .Fl o Ar property Ns = Ns Ar value
930 .Op Fl o Ar property Ns = Ns Ar value
933 Sets the given pool properties. See the
935 section for a list of valid properties that can be set.
938 .Ar file-system-property Ns = Ns Ar value
939 .Op Fl O Ar file-system-property Ns = Ns Ar value
942 Sets the given file system properties in the root file system of the pool. See
944 for a list of valid properties that
948 .Qq Fl o Cm cachefile=none,altroot= Ns Pa root
949 .It Fl m Ar mountpoint
950 Sets the mount point for the root dataset. The default mount point is
953 .Qq Cm altroot Ns Pa /pool
956 is specified. The mount point must be an absolute path,
960 For more information on dataset mount points, see
970 Destroys the given pool, freeing up any devices for other use. This command
971 tries to unmount any active datasets before destroying the pool.
972 .Bl -tag -width indent
974 Forces any active datasets contained within the pool to be unmounted.
984 from a mirror. The operation is refused if there are no other valid replicas
993 Exports the given pools from the system. All devices are marked as exported,
994 but are still considered in use by other subsystems. The devices can be moved
995 between systems (even those of different endianness) and imported as long as a
996 sufficient number of devices are present.
998 Before exporting the pool, all datasets within the pool are unmounted. A pool
999 can not be exported if it has a shared spare that is currently being used.
1001 For pools to be portable, you must give the
1003 command whole disks, not just slices, so that
1005 can label the disks with portable
1007 labels. Otherwise, disk drivers on platforms of different endianness will not
1008 recognize the disks.
1009 .Bl -tag -width indent
1011 Forcefully unmount all datasets, using the
1015 This command will forcefully export the pool even if it has a shared spare that
1016 is currently being used. This may lead to potential data corruption.
1021 .Ar all | property Ns Op , Ns Ar ...
1025 Retrieves the given list of properties (or all properties if
1027 is used) for the specified storage pool(s). These properties are displayed with
1028 the following fields:
1029 .Bl -column -offset indent "property"
1030 .It name Ta Name of storage pool
1031 .It property Ta Property name
1032 .It value Ta Property value
1033 .It source Ta Property source, either 'default' or 'local'.
1038 section for more information on the available pool properties.
1047 Displays the command history of the specified pools or all pools if no pool is
1049 .Bl -tag -width indent
1051 Displays internally logged
1053 events in addition to user initiated events.
1055 Displays log records in long format, which in addition to standard format
1056 includes, the user name, the hostname, and the zone in which the operation was
1062 .Op Fl d Ar dir | Fl c Ar cachefile
1066 Lists pools available to import. If the
1068 option is not specified, this command searches for devices in
1072 option can be specified multiple times, and all directories are searched. If
1073 the device appears to be part of an exported pool, this command displays a
1074 summary of the pool with the name of the pool, a numeric identifier, as well as
1077 layout and current health of the device for each device or file.
1078 Destroyed pools, pools that were previously destroyed with the
1080 command, are not listed unless the
1082 option is specified.
1084 The numeric identifier is unique, and can be used instead of the pool name when
1085 multiple exported pools of the same name are available.
1086 .Bl -tag -width indent
1087 .It Fl c Ar cachefile
1088 Reads configuration from the given
1090 that was created with the
1094 is used instead of searching for devices.
1096 Searches for devices or files in
1100 option can be specified multiple times.
1102 Lists destroyed pools only.
1108 .Op Fl o Ar property Ns = Ns Ar value
1110 .Op Fl d Ar dir | Fl c Ar cachefile
1120 Imports all pools found in the search directories. Identical to the previous
1121 command, except that all pools with a sufficient number of devices available
1122 are imported. Destroyed pools, pools that were previously destroyed with the
1124 command, will not be imported unless the
1126 option is specified.
1127 .Bl -tag -width indent
1129 Comma-separated list of mount options to use when mounting datasets within the
1132 for a description of dataset properties and mount options.
1133 .It Fl o Ar property Ns = Ns Ar value
1134 Sets the specified property on the imported pool. See the
1136 section for more information on the available pool properties.
1137 .It Fl c Ar cachefile
1138 Reads configuration from the given
1140 that was created with the
1144 is used instead of searching for devices.
1146 Searches for devices or files in
1150 option can be specified multiple times. This option is incompatible with the
1154 Imports destroyed pools only. The
1156 option is also required.
1158 Forces import, even if the pool appears to be potentially active.
1160 Allows a pool to import when there is a missing log device. Recent transactions
1161 can be lost because the log device will be discarded.
1163 Import the pool without mounting any file systems.
1174 Recovery mode for a non-importable pool. Attempt to return the pool to an
1175 importable state by discarding the last few transactions. Not all damaged pools
1176 can be recovered by using this option. If successful, the data from the
1177 discarded transactions is irretrievably lost. This option is ignored if the
1178 pool is importable or already imported.
1182 recovery option. Determines whether a non-importable pool can be made
1183 importable again, but does not actually perform the pool recovery. For more
1184 details about pool recovery mode, see the
1188 Searches for and imports all pools found.
1194 .Op Fl o Ar property Ns = Ns Ar value
1196 .Op Fl d Ar dir | Fl c Ar cachefile
1207 Imports a specific pool. A pool can be identified by its name or the numeric
1210 is specified, the pool is imported using the name
1212 Otherwise, it is imported with the same name as its exported name.
1214 If a device is removed from a system without running
1216 first, the device appears as potentially active. It cannot be determined if
1217 this was a failed export, or whether the device is really in use from another
1218 host. To import a pool in this state, the
1221 .Bl -tag -width indent
1223 Comma-separated list of mount options to use when mounting datasets within the
1226 for a description of dataset properties and mount options.
1227 .It Fl o Ar property Ns = Ns Ar value
1228 Sets the specified property on the imported pool. See the
1230 section for more information on the available pool properties.
1231 .It Fl c Ar cachefile
1232 Reads configuration from the given
1234 that was created with the
1238 is used instead of searching for devices.
1240 Searches for devices or files in
1244 option can be specified multiple times. This option is incompatible with the
1248 Imports destroyed pools only. The
1250 option is also required.
1252 Forces import, even if the pool appears to be potentially active.
1254 Allows a pool to import when there is a missing log device. Recent transactions
1255 can be lost because the log device will be discarded.
1257 Import the pool without mounting any file systems.
1260 .Qq Fl o Cm cachefile=none,altroot= Ns Pa root
1262 Recovery mode for a non-importable pool. Attempt to return the pool to an
1263 importable state by discarding the last few transactions. Not all damaged pools
1264 can be recovered by using this option. If successful, the data from the
1265 discarded transactions is irretrievably lost. This option is ignored if the
1266 pool is importable or already imported.
1270 recovery option. Determines whether a non-importable pool can be made
1271 importable again, but does not actually perform the pool recovery. For more
1272 details about pool recovery mode, see the
1279 .Op Fl T Cm d Ns | Ns Cm u
1283 .Op Ar interval Op Ar count
1288 statistics for the given pools. When given an interval, the statistics are
1295 are specified, statistics for every pool in the system is shown. If
1297 is specified, the command exits after
1299 reports are printed.
1300 .Bl -tag -width indent
1301 .It Fl T Cm d Ns | Ns Cm u
1306 for standard date format. See
1311 .Pq equals Qq Ic date +%s .
1313 Verbose statistics. Reports usage statistics for individual
1315 within the pool, in addition to the pool-wide statistics.
1326 label information from the specified
1330 must not be part of an active pool configuration.
1331 .Bl -tag -width indent
1333 Treat exported or foreign devices as inactive.
1339 .Op Fl o Ar property Ns Op , Ns Ar ...
1340 .Op Fl T Cm d Ns | Ns Cm u
1343 .Op Ar inverval Op Ar count
1346 Lists the given pools along with a health status and space usage. If no
1348 are specified, all pools in the system are listed.
1350 When given an interval, the output is printed every
1356 is specified, the command exits after
1358 reports are printed.
1359 .Bl -tag -width indent
1360 .It Fl T Cm d Ns | Ns Cm u
1365 for standard date format. See
1370 .Pq equals Qq Ic date +%s .
1372 Scripted mode. Do not display headers, and separate fields by a single tab
1373 instead of arbitrary space.
1375 Show more detailed information.
1376 .It Fl o Ar property Ns Op , Ns Ar ...
1377 Comma-separated list of properties to display. See the
1379 section for a list of valid properties. The default list is
1387 .It Fl T Cm d Ns | Ns Cm u
1392 for standard date format. See
1397 .Pq equals Qq Ic date +%s .
1406 Takes the specified physical device offline. While the
1408 is offline, no attempt is made to read or write to the device.
1409 .Bl -tag -width indent
1411 Temporary. Upon reboot, the specified physical device reverts to its previous
1421 Brings the specified physical device online.
1423 This command is not applicable to spares or cache devices.
1424 .Bl -tag -width indent
1426 Expand the device to use all available space. If the device is part of a mirror
1429 then all devices must be expanded before the new space will become
1430 available to the pool.
1438 Generates a new unique identifier for the pool. You must ensure that all
1439 devices in this pool are online and healthy before performing this action.
1446 Removes the specified device from the pool. This command currently only
1447 supports removing hot spares, cache, and log devices. A mirrored log device can
1448 be removed by specifying the top-level mirror for the log. Non-log devices that
1449 are part of a mirrored configuration can be removed using the
1451 command. Non-redundant and
1453 devices cannot be removed from a pool.
1460 Reopen all the vdevs associated with the pool.
1473 This is equivalent to attaching
1475 waiting for it to resilver, and then detaching
1480 must be greater than or equal to the minimum size
1481 of all the devices in a mirror or
1486 is required if the pool is not redundant. If
1488 is not specified, it defaults to
1490 This form of replacement is useful after an existing disk has failed and has
1491 been physically replaced. In this case, the new disk may have the same
1493 path as the old device, even though it is actually a different disk.
1496 .Bl -tag -width indent
1500 even if its appears to be in use. Not all devices can be overridden in this
1510 Begins a scrub. The scrub examines all data in the specified pools to verify
1511 that it checksums correctly. For replicated (mirror or
1515 automatically repairs any damage discovered during the scrub. The
1517 command reports the progress of the scrub and summarizes the results of the
1518 scrub upon completion.
1520 Scrubbing and resilvering are very similar operations. The difference is that
1521 resilvering only examines data that
1523 knows to be out of date (for example, when attaching a new device to a mirror
1524 or replacing an existing device), whereas scrubbing examines all data to
1525 discover silent errors due to hardware faults or disk failure.
1527 Because scrubbing and resilvering are
1528 .Tn I/O Ns -intensive
1531 only allows one at a time. If a scrub is already in progress, the
1533 command returns an error. To start a new scrub, you have to stop the old scrub
1535 .Qq Nm Cm scrub Fl s
1536 command first. If a resilver is in progress,
1538 does not allow a scrub to be started until the resilver completes.
1539 .Bl -tag -width indent
1546 .Ar property Ns = Ns Ar value pool
1549 Sets the given property on the specified pool. See the
1551 section for more information on what properties can be set and acceptable
1559 .Op Fl o Ar property Ns = Ns Ar value
1564 Splits off one disk from each mirrored top-level
1566 in a pool and creates a new pool from the split-off disks. The original pool
1567 must be made up of one or more mirrors and must not be in the process of
1570 subcommand chooses the last device in each mirror
1572 unless overridden by a device specification on the command line.
1578 includes the specified device(s) in a new pool and, should any devices remain
1579 unspecified, assigns the last device in each mirror
1581 to that pool, as it does normally. If you are uncertain about the outcome of a
1585 ("dry-run") option to ensure your command will have the effect you intend.
1586 .Bl -tag -width indent
1588 Automatically import the newly created pool after splitting, using the
1591 parameter for the new pool's alternate root. See the
1597 Displays the configuration that would be created without actually splitting the
1598 pool. The actual pool split could still fail due to insufficient privileges or
1601 Comma-separated list of mount options to use when mounting datasets within the
1604 for a description of dataset properties and mount options. Valid only in
1605 conjunction with the
1608 .It Fl o Ar property Ns = Ns Ar value
1609 Sets the specified property on the new pool. See the
1611 section, above, for more information on the available pool properties.
1617 .Op Fl T Cm d Ns | Ns Cm u
1620 .Op Ar interval Op Ar count
1623 Displays the detailed health status for the given pools. If no
1625 is specified, then the status of each pool in the system is displayed. For more
1626 information on pool and device health, see the
1627 .Qq Sx Device Failure and Recovery
1630 When given an interval, the output is printed every
1636 is specified, the command exits after
1638 reports are printed.
1640 If a scrub or resilver is in progress, this command reports the percentage
1641 done and the estimated time to completion. Both of these are only approximate,
1642 because the amount of data in the pool and the other workloads on the system
1644 .Bl -tag -width indent
1646 Only display status for pools that are exhibiting errors or are otherwise
1648 Warnings about pools not using the latest on-disk format will not be included.
1650 Displays verbose data error information, printing out a complete list of all
1651 data errors since the last complete pool scrub.
1652 .It Fl T Cm d Ns | Ns Cm u
1657 for standard date format. See
1662 .Pq equals Qq Ic date +%s .
1670 Displays pools which do not have all supported features enabled and pools
1671 formatted using a legacy
1674 These pools can continue to be used, but some features may not be available.
1677 to enable all features on all pools.
1678 .Bl -tag -width indent
1682 versions supported by the current software.
1684 .Xr zpool-features 7
1685 for a description of feature flags features supported by the current software.
1694 Enables all supported features on the given pool.
1695 Once this is done, the pool will no longer be accessible on systems that do
1696 not support feature flags.
1698 .Xr zpool-features 7
1699 for details on compatibility with systems that support feature flags, but do
1700 not support all features enabled on the pool.
1701 .Bl -tag -width indent
1703 Enables all supported features on all pools.
1705 Upgrade to the specified legacy version. If the
1707 flag is specified, no features will be enabled on the pool.
1708 This option can only be used to increase version number up to the last
1709 supported legacy version number.
1713 The following exit values are returned:
1714 .Bl -tag -offset 2n -width 2n
1716 Successful completion.
1720 Invalid command line options were specified.
1724 .It Sy Example 1 No Creating a RAID-Z Storage Pool
1726 The following command creates a pool with a single
1730 that consists of six disks.
1731 .Bd -literal -offset 2n
1732 .Li # Ic zpool create tank raidz da0 da1 da2 da3 da4 da5
1734 .It Sy Example 2 No Creating a Mirrored Storage Pool
1736 The following command creates a pool with two mirrors, where each mirror
1738 .Bd -literal -offset 2n
1739 .Li # Ic zpool create tank mirror da0 da1 mirror da2 da3
1741 .It Sy Example 3 No Creating a Tn ZFS No Storage Pool by Using Partitions
1743 The following command creates an unmirrored pool using two GPT partitions.
1744 .Bd -literal -offset 2n
1745 .Li # Ic zpool create tank da0p3 da1p3
1747 .It Sy Example 4 No Creating a Tn ZFS No Storage Pool by Using Files
1749 The following command creates an unmirrored pool using files. While not
1750 recommended, a pool based on files can be useful for experimental purposes.
1751 .Bd -literal -offset 2n
1752 .Li # Ic zpool create tank /path/to/file/a /path/to/file/b
1754 .It Sy Example 5 No Adding a Mirror to a Tn ZFS No Storage Pool
1756 The following command adds two mirrored disks to the pool
1758 assuming the pool is already made up of two-way mirrors. The additional space
1759 is immediately available to any datasets within the pool.
1760 .Bd -literal -offset 2n
1761 .Li # Ic zpool add tank mirror da2 da3
1763 .It Sy Example 6 No Listing Available Tn ZFS No Storage Pools
1765 The following command lists all available pools on the system.
1766 .Bd -literal -offset 2n
1768 NAME SIZE ALLOC FREE CAP DEDUP HEALTH ALTROOT
1769 pool 2.70T 473G 2.24T 17% 1.00x ONLINE -
1770 test 1.98G 89.5K 1.98G 0% 1.00x ONLINE -
1772 .It Sy Example 7 No Listing All Properties for a Pool
1774 The following command lists all the properties for a pool.
1775 .Bd -literal -offset 2n
1776 .Li # Ic zpool get all pool
1779 pool altroot - default
1780 pool health ONLINE -
1781 pool guid 2501120270416322443 default
1782 pool version 28 default
1783 pool bootfs pool/root local
1784 pool delegation on default
1785 pool autoreplace off default
1786 pool cachefile - default
1787 pool failmode wait default
1788 pool listsnapshots off default
1789 pool autoexpand off default
1790 pool dedupditto 0 default
1791 pool dedupratio 1.00x -
1793 pool allocated 473G -
1796 .It Sy Example 8 No Destroying a Tn ZFS No Storage Pool
1798 The following command destroys the pool
1800 and any datasets contained within.
1801 .Bd -literal -offset 2n
1802 .Li # Ic zpool destroy -f tank
1804 .It Sy Example 9 No Exporting a Tn ZFS No Storage Pool
1806 The following command exports the devices in pool
1808 so that they can be relocated or later imported.
1809 .Bd -literal -offset 2n
1810 .Li # Ic zpool export tank
1812 .It Sy Example 10 No Importing a Tn ZFS No Storage Pool
1814 The following command displays available pools, and then imports the pool
1816 for use on the system.
1818 The results from this command are similar to the following:
1819 .Bd -literal -offset 2n
1820 .Li # Ic zpool import
1823 id: 15451357997522795478
1825 action: The pool can be imported using its name or numeric identifier.
1837 Storage Pools to the Current Version
1840 The following command upgrades all
1842 Storage pools to the current version of
1844 .Bd -literal -offset 2n
1845 .Li # Ic zpool upgrade -a
1846 This system is currently running ZFS pool version 28.
1848 .It Sy Example 12 No Managing Hot Spares
1850 The following command creates a new pool with an available hot spare:
1851 .Bd -literal -offset 2n
1852 .Li # Ic zpool create tank mirror da0 da1 spare da2
1855 If one of the disks were to fail, the pool would be reduced to the degraded
1856 state. The failed device can be replaced using the following command:
1857 .Bd -literal -offset 2n
1858 .Li # Ic zpool replace tank da0 da2
1861 Once the data has been resilvered, the spare is automatically removed and is
1862 made available should another device fails. The hot spare can be permanently
1863 removed from the pool using the following command:
1864 .Bd -literal -offset 2n
1865 .Li # Ic zpool remove tank da2
1871 Pool with Mirrored Separate Intent Logs
1874 The following command creates a
1876 storage pool consisting of two, two-way
1877 mirrors and mirrored log devices:
1878 .Bd -literal -offset 2n
1879 .Li # Ic zpool create pool mirror da0 da1 mirror da2 da3 log mirror da4 da5
1881 .It Sy Example 14 No Adding Cache Devices to a Tn ZFS No Pool
1883 The following command adds two disks for use as cache devices to a
1886 .Bd -literal -offset 2n
1887 .Li # Ic zpool add pool cache da2 da3
1890 Once added, the cache devices gradually fill with content from main memory.
1891 Depending on the size of your cache devices, it could take over an hour for
1892 them to fill. Capacity and reads can be monitored using the
1894 subcommand as follows:
1895 .Bd -literal -offset 2n
1896 .Li # Ic zpool iostat -v pool 5
1898 .It Sy Example 15 No Removing a Mirrored Log Device
1900 The following command removes the mirrored log device
1903 Given this configuration:
1904 .Bd -literal -offset 2n
1907 scrub: none requested
1910 NAME STATE READ WRITE CKSUM
1912 mirror-0 ONLINE 0 0 0
1915 mirror-1 ONLINE 0 0 0
1919 mirror-2 ONLINE 0 0 0
1924 The command to remove the mirrored log
1927 .Bd -literal -offset 2n
1928 .Li # Ic zpool remove tank mirror-2
1930 .It Sy Example 16 No Recovering a Faulted Tn ZFS No Pool
1932 If a pool is faulted but recoverable, a message indicating this state is
1935 if the pool was cached (see the
1937 argument above), or as part of the error output from a failed
1941 Recover a cached pool with the
1944 .Bd -literal -offset 2n
1945 .Li # Ic zpool clear -F data
1946 Pool data returned to its state as of Tue Sep 08 13:23:35 2009.
1947 Discarded approximately 29 seconds of transactions.
1950 If the pool configuration was not cached, use
1952 with the recovery mode flag:
1953 .Bd -literal -offset 2n
1954 .Li # Ic zpool import -F data
1955 Pool data returned to its state as of Tue Sep 08 13:23:35 2009.
1956 Discarded approximately 29 seconds of transactions.
1960 .Xr zpool-features 7 ,
1963 This manual page is a
1965 reimplementation of the
1969 modified and customized for
1971 and licensed under the Common Development and Distribution License
1976 implementation of this manual page was initially written by
1977 .An Martin Matuska Aq mm@FreeBSD.org .
1981 feature requires a utility to detect zpool degradation and initiate
1982 disk replacement within the zpool. FreeBSD does not provide such a
1983 utility at this time.
projects / FreeBSD / stable / 9.git / blob