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.
629 The following properties can be set at creation time and import time, and later
634 .It Sy autoexpand Ns = Ns Cm on No | Cm off
635 Controls automatic pool expansion when the underlying LUN is grown. If set to
637 the pool will be resized according to the size of the expanded
638 device. If the device is part of a mirror or
640 then all devices within that
641 .No mirror/ Ns No raidz
642 group must be expanded before the new space is made available to
643 the pool. The default behavior is
645 This property can also be referred to by its shortened column name,
647 .It Sy autoreplace Ns = Ns Cm on No | Cm off
648 Controls automatic device replacement. If set to
650 device replacement must be initiated by the administrator by using the
654 any new device, found in the same
655 physical location as a device that previously belonged to the pool, is
656 automatically formatted and replaced. The default behavior is
658 This property can also be referred to by its shortened column name, "replace".
659 .It Sy bootfs Ns = Ns Ar pool Ns / Ns Ar dataset
660 Identifies the default bootable dataset for the root pool. This property is
661 expected to be set mainly by the installation and upgrade programs.
662 .It Sy cachefile Ns = Ns Ar path No | Cm none
663 Controls the location of where the pool configuration is cached. Discovering
664 all pools on system startup requires a cached copy of the configuration data
665 that is stored on the root file system. All pools in this cache are
666 automatically imported when the system boots. Some environments, such as
667 install and clustering, need to cache this information in a different location
668 so that pools are not automatically imported. Setting this property caches the
669 pool configuration in a different location that can later be imported with
670 .Qq Nm Cm import Fl c .
671 Setting it to the special value
673 creates a temporary pool that is never cached, and the special value
675 (empty string) uses the default location.
676 .It Sy comment Ns = Ns Ar text
677 A text string consisting of printable ASCII characters that will be stored
678 such that it is available even if the pool becomes faulted.
679 An administrator can provide additional information about a pool using this
681 .It Sy dedupditto Ns = Ns Ar number
682 Threshold for the number of block ditto copies. If the reference count for a
683 deduplicated block increases above this number, a new ditto copy of this block
684 is automatically stored. Default setting is
686 .It Sy delegation Ns = Ns Cm on No | Cm off
687 Controls whether a non-privileged user is granted access based on the dataset
688 permissions defined on the dataset. See
690 for more information on
692 delegated administration.
693 .It Sy failmode Ns = Ns Cm wait No | Cm continue No | Cm panic
694 Controls the system behavior in the event of catastrophic pool failure. This
695 condition is typically a result of a loss of connectivity to the underlying
696 storage device(s) or a failure of all devices within the pool. The behavior of
697 such an event is determined as follows:
698 .Bl -tag -width indent
702 access until the device connectivity is recovered and the errors are cleared.
703 This is the default behavior.
709 requests but allows reads to any of the remaining healthy devices. Any write
710 requests that have yet to be committed to disk would be blocked.
712 Prints out a message to the console and generates a system crash dump.
714 .It Sy feature@ Ns Ar feature_name Ns = Ns Sy enabled
715 The value of this property is the current state of
717 The only valid value when setting this property is
721 to the enabled state.
724 for details on feature states.
725 .It Sy listsnaps Ns = Ns Cm on No | Cm off
726 Controls whether information about snapshots associated with this pool is
731 option. The default value is
733 .It Sy version Ns = Ns Ar version
734 The current on-disk version of the pool. This can be increased, but never
735 decreased. The preferred method of updating pools is with the
737 command, though this property can be used when a specific version is needed
738 for backwards compatibility.
739 Once feature flags is enabled on a pool this property will no longer have a
743 All subcommands that modify state are logged persistently to the pool in their
748 command provides subcommands to create and destroy storage pools, add capacity
749 to storage pools, and provide information about the storage pools. The following
750 subcommands are supported:
757 Displays a help message.
765 Adds the specified virtual devices to the given pool. The
767 specification is described in the
768 .Qq Sx Virtual Devices
769 section. The behavior of the
771 option, and the device checks performed are described in the
774 .Bl -tag -width indent
778 even if they appear in use or specify a conflicting replication level.
779 Not all devices can be overridden in this manner.
781 Displays the configuration that would be used without actually adding the
783 The actual pool creation can still fail due to insufficient privileges or device
786 Do not add a disk that is currently configured as a quorum device to a zpool.
787 After a disk is in the pool, that disk can then be configured as a quorum
794 .Ar pool device new_device
801 device. The existing device cannot be part of a
805 is not currently part of a mirrored configuration,
807 automatically transforms into a two-way mirror of
808 .Ar device No and Ar new_device .
811 is part of a two-way mirror, attaching
813 creates a three-way mirror, and so on. In either case,
815 begins to resilver immediately.
816 .Bl -tag -width indent
820 even if its appears to be in use. Not all devices can be overridden in this
831 Clears device errors in a pool. If no arguments are specified, all device
832 errors within the pool are cleared. If one or more devices is specified, only
833 those errors associated with the specified device or devices are cleared.
834 .Bl -tag -width indent
836 Initiates recovery mode for an unopenable pool. Attempts to discard the last
837 few transactions in the pool to return it to an openable state. Not all damaged
838 pools can be recovered by using this option. If successful, the data from the
839 discarded transactions is irretrievably lost.
841 Used in combination with the
843 flag. Check whether discarding transactions would make the pool openable, but
844 do not actually discard any transactions.
850 .Op Fl o Ar property Ns = Ns Ar value
852 .Op Fl O Ar file-system-property Ns = Ns Ar value
854 .Op Fl m Ar mountpoint
859 Creates a new storage pool containing the virtual devices specified on the
860 command line. The pool name must begin with a letter, and can only contain
861 alphanumeric characters as well as underscore ("_"), dash ("-"), and period
862 ("."). The pool names "mirror", "raidz", "spare" and "log" are reserved, as are
863 names beginning with the pattern "c[0-9]". The
865 specification is described in the
866 .Qq Sx Virtual Devices
869 The command verifies that each device specified is accessible and not currently
870 in use by another subsystem. There are some uses, such as being currently
871 mounted, or specified as the dedicated dump device, that prevents a device from
874 Other uses, such as having a preexisting
876 file system, can be overridden with the
880 The command also checks that the replication strategy for the pool is
881 consistent. An attempt to combine redundant and non-redundant storage in a
882 single pool, or to mix disks and files, results in an error unless
884 is specified. The use of differently sized devices within a single
886 or mirror group is also flagged as an error unless
892 option is specified, the default mount point is
894 The mount point must not exist or must be empty, or else the
895 root dataset cannot be mounted. This can be overridden with the
899 By default all supported features are enabled on the new pool unless the
902 .Bl -tag -width indent
906 even if they appear in use or specify a conflicting replication level.
907 Not all devices can be overridden in this manner.
909 Displays the configuration that would be used without actually creating the
910 pool. The actual pool creation can still fail due to insufficient privileges or
913 Do not enable any features on the new pool.
914 Individual features can be enabled by setting their corresponding properties
922 for details about feature properties.
924 .Fl o Ar property Ns = Ns Ar value
925 .Op Fl o Ar property Ns = Ns Ar value
928 Sets the given pool properties. See the
930 section for a list of valid properties that can be set.
933 .Ar file-system-property Ns = Ns Ar value
934 .Op Fl O Ar file-system-property Ns = Ns Ar value
937 Sets the given file system properties in the root file system of the pool. See
939 for a list of valid properties that
943 .Qq Fl o Cm cachefile=none,altroot= Ns Pa root
944 .It Fl m Ar mountpoint
945 Sets the mount point for the root dataset. The default mount point is
948 .Qq Cm altroot Ns Pa /pool
951 is specified. The mount point must be an absolute path,
955 For more information on dataset mount points, see
965 Destroys the given pool, freeing up any devices for other use. This command
966 tries to unmount any active datasets before destroying the pool.
967 .Bl -tag -width indent
969 Forces any active datasets contained within the pool to be unmounted.
979 from a mirror. The operation is refused if there are no other valid replicas
988 Exports the given pools from the system. All devices are marked as exported,
989 but are still considered in use by other subsystems. The devices can be moved
990 between systems (even those of different endianness) and imported as long as a
991 sufficient number of devices are present.
993 Before exporting the pool, all datasets within the pool are unmounted. A pool
994 can not be exported if it has a shared spare that is currently being used.
996 For pools to be portable, you must give the
998 command whole disks, not just slices, so that
1000 can label the disks with portable
1002 labels. Otherwise, disk drivers on platforms of different endianness will not
1003 recognize the disks.
1004 .Bl -tag -width indent
1006 Forcefully unmount all datasets, using the
1010 This command will forcefully export the pool even if it has a shared spare that
1011 is currently being used. This may lead to potential data corruption.
1016 .Ar all | property Ns Op , Ns Ar ...
1020 Retrieves the given list of properties (or all properties if
1022 is used) for the specified storage pool(s). These properties are displayed with
1023 the following fields:
1024 .Bl -column -offset indent "property"
1025 .It name Ta Name of storage pool
1026 .It property Ta Property name
1027 .It value Ta Property value
1028 .It source Ta Property source, either 'default' or 'local'.
1033 section for more information on the available pool properties.
1042 Displays the command history of the specified pools or all pools if no pool is
1044 .Bl -tag -width indent
1046 Displays internally logged
1048 events in addition to user initiated events.
1050 Displays log records in long format, which in addition to standard format
1051 includes, the user name, the hostname, and the zone in which the operation was
1057 .Op Fl d Ar dir | Fl c Ar cachefile
1061 Lists pools available to import. If the
1063 option is not specified, this command searches for devices in
1067 option can be specified multiple times, and all directories are searched. If
1068 the device appears to be part of an exported pool, this command displays a
1069 summary of the pool with the name of the pool, a numeric identifier, as well as
1072 layout and current health of the device for each device or file.
1073 Destroyed pools, pools that were previously destroyed with the
1075 command, are not listed unless the
1077 option is specified.
1079 The numeric identifier is unique, and can be used instead of the pool name when
1080 multiple exported pools of the same name are available.
1081 .Bl -tag -width indent
1082 .It Fl c Ar cachefile
1083 Reads configuration from the given
1085 that was created with the
1089 is used instead of searching for devices.
1091 Searches for devices or files in
1095 option can be specified multiple times.
1097 Lists destroyed pools only.
1103 .Op Fl o Ar property Ns = Ns Ar value
1105 .Op Fl d Ar dir | Fl c Ar cachefile
1115 Imports all pools found in the search directories. Identical to the previous
1116 command, except that all pools with a sufficient number of devices available
1117 are imported. Destroyed pools, pools that were previously destroyed with the
1119 command, will not be imported unless the
1121 option is specified.
1122 .Bl -tag -width indent
1124 Comma-separated list of mount options to use when mounting datasets within the
1127 for a description of dataset properties and mount options.
1128 .It Fl o Ar property Ns = Ns Ar value
1129 Sets the specified property on the imported pool. See the
1131 section for more information on the available pool properties.
1132 .It Fl c Ar cachefile
1133 Reads configuration from the given
1135 that was created with the
1139 is used instead of searching for devices.
1141 Searches for devices or files in
1145 option can be specified multiple times. This option is incompatible with the
1149 Imports destroyed pools only. The
1151 option is also required.
1153 Forces import, even if the pool appears to be potentially active.
1155 Enables import with missing log devices.
1157 Do not mount any filesystems from the imported pool.
1168 Recovery mode for a non-importable pool. Attempt to return the pool to an
1169 importable state by discarding the last few transactions. Not all damaged pools
1170 can be recovered by using this option. If successful, the data from the
1171 discarded transactions is irretrievably lost. This option is ignored if the
1172 pool is importable or already imported.
1176 recovery option. Determines whether a non-importable pool can be made
1177 importable again, but does not actually perform the pool recovery. For more
1178 details about pool recovery mode, see the
1182 Searches for and imports all pools found.
1188 .Op Fl o Ar property Ns = Ns Ar value
1190 .Op Fl d Ar dir | Fl c Ar cachefile
1201 Imports a specific pool. A pool can be identified by its name or the numeric
1204 is specified, the pool is imported using the name
1206 Otherwise, it is imported with the same name as its exported name.
1208 If a device is removed from a system without running
1210 first, the device appears as potentially active. It cannot be determined if
1211 this was a failed export, or whether the device is really in use from another
1212 host. To import a pool in this state, the
1215 .Bl -tag -width indent
1217 Comma-separated list of mount options to use when mounting datasets within the
1220 for a description of dataset properties and mount options.
1221 .It Fl o Ar property Ns = Ns Ar value
1222 Sets the specified property on the imported pool. See the
1224 section for more information on the available pool properties.
1225 .It Fl c Ar cachefile
1226 Reads configuration from the given
1228 that was created with the
1232 is used instead of searching for devices.
1234 Searches for devices or files in
1238 option can be specified multiple times. This option is incompatible with the
1242 Imports destroyed pools only. The
1244 option is also required.
1246 Forces import, even if the pool appears to be potentially active.
1248 Enables import with missing log devices.
1250 Do not mount any filesystems from the imported pool.
1253 .Qq Fl o Cm cachefile=none,altroot= Ns Pa root
1255 Recovery mode for a non-importable pool. Attempt to return the pool to an
1256 importable state by discarding the last few transactions. Not all damaged pools
1257 can be recovered by using this option. If successful, the data from the
1258 discarded transactions is irretrievably lost. This option is ignored if the
1259 pool is importable or already imported.
1263 recovery option. Determines whether a non-importable pool can be made
1264 importable again, but does not actually perform the pool recovery. For more
1265 details about pool recovery mode, see the
1272 .Op Fl T Cm d Ns | Ns Cm u
1276 .Op Ar interval Op Ar count
1281 statistics for the given pools. When given an interval, the statistics are
1288 are specified, statistics for every pool in the system is shown. If
1290 is specified, the command exits after
1292 reports are printed.
1293 .Bl -tag -width indent
1294 .It Fl T Cm d Ns | Ns Cm u
1299 for standard date format. See
1304 .Pq equals Qq Ic date +%s .
1306 Verbose statistics. Reports usage statistics for individual
1308 within the pool, in addition to the pool-wide statistics.
1319 label information from the specified
1323 must not be part of an active pool configuration.
1324 .Bl -tag -width indent
1326 Treat exported or foreign devices as inactive.
1332 .Op Fl o Ar property Ns Op , Ns Ar ...
1333 .Op Fl T Cm d Ns | Ns Cm u
1336 .Op Ar inverval Op Ar count
1339 Lists the given pools along with a health status and space usage. When given no
1340 arguments, all pools in the system are listed.
1342 When given an interval, the output is printed every
1348 is specified, the command exits after
1350 reports are printed.
1351 .Bl -tag -width indent
1353 Scripted mode. Do not display headers, and separate fields by a single tab
1354 instead of arbitrary space.
1356 Show more detailed information.
1357 .It Fl o Ar property Ns Op , Ns Ar ...
1358 Comma-separated list of properties to display. See the
1360 section for a list of valid properties. The default list is
1368 .It Fl T Cm d Ns | Ns Cm u
1373 for standard date format. See
1378 .Pq equals Qq Ic date +%s .
1387 Takes the specified physical device offline. While the
1389 is offline, no attempt is made to read or write to the device.
1390 .Bl -tag -width indent
1392 Temporary. Upon reboot, the specified physical device reverts to its previous
1402 Brings the specified physical device online.
1404 This command is not applicable to spares or cache devices.
1405 .Bl -tag -width indent
1407 Expand the device to use all available space. If the device is part of a mirror
1410 then all devices must be expanded before the new space will become
1411 available to the pool.
1419 Generates a new unique identifier for the pool. You must ensure that all
1420 devices in this pool are online and healthy before performing this action.
1427 Removes the specified device from the pool. This command currently only
1428 supports removing hot spares, cache, and log devices. A mirrored log device can
1429 be removed by specifying the top-level mirror for the log. Non-log devices that
1430 are part of a mirrored configuration can be removed using the
1432 command. Non-redundant and
1434 devices cannot be removed from a pool.
1441 Reopen all the vdevs associated with the pool.
1454 This is equivalent to attaching
1456 waiting for it to resilver, and then detaching
1461 must be greater than or equal to the minimum size
1462 of all the devices in a mirror or
1467 is required if the pool is not redundant. If
1469 is not specified, it defaults to
1471 This form of replacement is useful after an existing disk has failed and has
1472 been physically replaced. In this case, the new disk may have the same
1474 path as the old device, even though it is actually a different disk.
1477 .Bl -tag -width indent
1481 even if its appears to be in use. Not all devices can be overridden in this
1491 Begins a scrub. The scrub examines all data in the specified pools to verify
1492 that it checksums correctly. For replicated (mirror or
1496 automatically repairs any damage discovered during the scrub. The
1498 command reports the progress of the scrub and summarizes the results of the
1499 scrub upon completion.
1501 Scrubbing and resilvering are very similar operations. The difference is that
1502 resilvering only examines data that
1504 knows to be out of date (for example, when attaching a new device to a mirror
1505 or replacing an existing device), whereas scrubbing examines all data to
1506 discover silent errors due to hardware faults or disk failure.
1508 Because scrubbing and resilvering are
1509 .Tn I/O Ns -intensive
1512 only allows one at a time. If a scrub is already in progress, the
1514 command returns an error. To start a new scrub, you have to stop the old scrub
1516 .Qq Nm Cm scrub Fl s
1517 command first. If a resilver is in progress,
1519 does not allow a scrub to be started until the resilver completes.
1520 .Bl -tag -width indent
1527 .Ar property Ns = Ns Ar value pool
1530 Sets the given property on the specified pool. See the
1532 section for more information on what properties can be set and acceptable
1540 .Op Fl o Ar property Ns = Ns Ar value
1545 Splits off one disk from each mirrored top-level
1547 in a pool and creates a new pool from the split-off disks. The original pool
1548 must be made up of one or more mirrors and must not be in the process of
1551 subcommand chooses the last device in each mirror
1553 unless overridden by a device specification on the command line.
1559 includes the specified device(s) in a new pool and, should any devices remain
1560 unspecified, assigns the last device in each mirror
1562 to that pool, as it does normally. If you are uncertain about the outcome of a
1566 ("dry-run") option to ensure your command will have the effect you intend.
1567 .Bl -tag -width indent
1569 Automatically import the newly created pool after splitting, using the
1572 parameter for the new pool's alternate root. See the
1578 Displays the configuration that would be created without actually splitting the
1579 pool. The actual pool split could still fail due to insufficient privileges or
1582 Comma-separated list of mount options to use when mounting datasets within the
1585 for a description of dataset properties and mount options. Valid only in
1586 conjunction with the
1589 .It Fl o Ar property Ns = Ns Ar value
1590 Sets the specified property on the new pool. See the
1592 section, above, for more information on the available pool properties.
1598 .Op Fl T Cm d Ns | Ns Cm u
1601 .Op Ar interval Op Ar count
1604 Displays the detailed health status for the given pools. If no
1606 is specified, then the status of each pool in the system is displayed. For more
1607 information on pool and device health, see the
1608 .Qq Sx Device Failure and Recovery
1611 When given an interval, the output is printed every
1617 is specified, the command exits after
1619 reports are printed.
1621 If a scrub or resilver is in progress, this command reports the percentage
1622 done and the estimated time to completion. Both of these are only approximate,
1623 because the amount of data in the pool and the other workloads on the system
1625 .Bl -tag -width indent
1627 Only display status for pools that are exhibiting errors or are otherwise
1629 Warnings about pools not using the latest on-disk format will not be included.
1631 Displays verbose data error information, printing out a complete list of all
1632 data errors since the last complete pool scrub.
1633 .It Fl T Cm d Ns | Ns Cm u
1638 for standard date format. See
1643 .Pq equals Qq Ic date +%s .
1651 Displays pools which do not have all supported features enabled and pools
1652 formatted using a legacy
1655 These pools can continue to be used, but some features may not be available.
1658 to enable all features on all pools.
1659 .Bl -tag -width indent
1663 versions supported by the current software.
1665 .Xr zpool-features 7
1666 for a description of feature flags features supported by the current software.
1675 Enables all supported features on the given pool.
1676 Once this is done, the pool will no longer be accessible on systems that do
1677 not support feature flags.
1679 .Xr zpool-features 7
1680 for details on compatability with system sthat support feature flags, but do
1681 not support all features enabled on the pool.
1682 .Bl -tag -width indent
1684 Enables all supported features on all pools.
1686 Upgrade to the specified legacy version. If the
1688 flag is specified, no features will be enabled on the pool.
1689 This option can only be used to increase version number up to the last
1690 supported legacy version number.
1694 The following exit values are returned:
1695 .Bl -tag -offset 2n -width 2n
1697 Successful completion.
1701 Invalid command line options were specified.
1705 .It Sy Example 1 No Creating a RAID-Z Storage Pool
1707 The following command creates a pool with a single
1711 that consists of six disks.
1712 .Bd -literal -offset 2n
1713 .Li # Ic zpool create tank raidz da0 da1 da2 da3 da4 da5
1715 .It Sy Example 2 No Creating a Mirrored Storage Pool
1717 The following command creates a pool with two mirrors, where each mirror
1719 .Bd -literal -offset 2n
1720 .Li # Ic zpool create tank mirror da0 da1 mirror da2 da3
1722 .It Sy Example 3 No Creating a Tn ZFS No Storage Pool by Using Partitions
1724 The following command creates an unmirrored pool using two GPT partitions.
1725 .Bd -literal -offset 2n
1726 .Li # Ic zpool create tank da0p3 da1p3
1728 .It Sy Example 4 No Creating a Tn ZFS No Storage Pool by Using Files
1730 The following command creates an unmirrored pool using files. While not
1731 recommended, a pool based on files can be useful for experimental purposes.
1732 .Bd -literal -offset 2n
1733 .Li # Ic zpool create tank /path/to/file/a /path/to/file/b
1735 .It Sy Example 5 No Adding a Mirror to a Tn ZFS No Storage Pool
1737 The following command adds two mirrored disks to the pool
1739 assuming the pool is already made up of two-way mirrors. The additional space
1740 is immediately available to any datasets within the pool.
1741 .Bd -literal -offset 2n
1742 .Li # Ic zpool add tank mirror da2 da3
1744 .It Sy Example 6 No Listing Available Tn ZFS No Storage Pools
1746 The following command lists all available pools on the system.
1747 .Bd -literal -offset 2n
1749 NAME SIZE ALLOC FREE CAP DEDUP HEALTH ALTROOT
1750 pool 2.70T 473G 2.24T 17% 1.00x ONLINE -
1751 test 1.98G 89.5K 1.98G 0% 1.00x ONLINE -
1753 .It Sy Example 7 No Listing All Properties for a Pool
1755 The following command lists all the properties for a pool.
1756 .Bd -literal -offset 2n
1757 .Li # Ic zpool get all pool
1760 pool altroot - default
1761 pool health ONLINE -
1762 pool guid 2501120270416322443 default
1763 pool version 28 default
1764 pool bootfs pool/root local
1765 pool delegation on default
1766 pool autoreplace off default
1767 pool cachefile - default
1768 pool failmode wait default
1769 pool listsnapshots off default
1770 pool autoexpand off default
1771 pool dedupditto 0 default
1772 pool dedupratio 1.00x -
1774 pool allocated 473G -
1777 .It Sy Example 8 No Destroying a Tn ZFS No Storage Pool
1779 The following command destroys the pool
1781 and any datasets contained within.
1782 .Bd -literal -offset 2n
1783 .Li # Ic zpool destroy -f tank
1785 .It Sy Example 9 No Exporting a Tn ZFS No Storage Pool
1787 The following command exports the devices in pool
1789 so that they can be relocated or later imported.
1790 .Bd -literal -offset 2n
1791 .Li # Ic zpool export tank
1793 .It Sy Example 10 No Importing a Tn ZFS No Storage Pool
1795 The following command displays available pools, and then imports the pool
1797 for use on the system.
1799 The results from this command are similar to the following:
1800 .Bd -literal -offset 2n
1801 .Li # Ic zpool import
1804 id: 15451357997522795478
1806 action: The pool can be imported using its name or numeric identifier.
1818 Storage Pools to the Current Version
1821 The following command upgrades all
1823 Storage pools to the current version of
1825 .Bd -literal -offset 2n
1826 .Li # Ic zpool upgrade -a
1827 This system is currently running ZFS pool version 28.
1829 .It Sy Example 12 No Managing Hot Spares
1831 The following command creates a new pool with an available hot spare:
1832 .Bd -literal -offset 2n
1833 .Li # Ic zpool create tank mirror da0 da1 spare da2
1836 If one of the disks were to fail, the pool would be reduced to the degraded
1837 state. The failed device can be replaced using the following command:
1838 .Bd -literal -offset 2n
1839 .Li # Ic zpool replace tank da0 da2
1842 Once the data has been resilvered, the spare is automatically removed and is
1843 made available should another device fails. The hot spare can be permanently
1844 removed from the pool using the following command:
1845 .Bd -literal -offset 2n
1846 .Li # Ic zpool remove tank da2
1852 Pool with Mirrored Separate Intent Logs
1855 The following command creates a
1857 storage pool consisting of two, two-way
1858 mirrors and mirrored log devices:
1859 .Bd -literal -offset 2n
1860 .Li # Ic zpool create pool mirror da0 da1 mirror da2 da3 log mirror da4 da5
1862 .It Sy Example 14 No Adding Cache Devices to a Tn ZFS No Pool
1864 The following command adds two disks for use as cache devices to a
1867 .Bd -literal -offset 2n
1868 .Li # Ic zpool add pool cache da2 da3
1871 Once added, the cache devices gradually fill with content from main memory.
1872 Depending on the size of your cache devices, it could take over an hour for
1873 them to fill. Capacity and reads can be monitored using the
1875 subcommand as follows:
1876 .Bd -literal -offset 2n
1877 .Li # Ic zpool iostat -v pool 5
1879 .It Sy Example 15 No Removing a Mirrored Log Device
1881 The following command removes the mirrored log device
1884 Given this configuration:
1885 .Bd -literal -offset 2n
1888 scrub: none requested
1891 NAME STATE READ WRITE CKSUM
1893 mirror-0 ONLINE 0 0 0
1896 mirror-1 ONLINE 0 0 0
1900 mirror-2 ONLINE 0 0 0
1905 The command to remove the mirrored log
1908 .Bd -literal -offset 2n
1909 .Li # Ic zpool remove tank mirror-2
1911 .It Sy Example 16 No Recovering a Faulted Tn ZFS No Pool
1913 If a pool is faulted but recoverable, a message indicating this state is
1916 if the pool was cached (see the
1918 argument above), or as part of the error output from a failed
1922 Recover a cached pool with the
1925 .Bd -literal -offset 2n
1926 .Li # Ic zpool clear -F data
1927 Pool data returned to its state as of Tue Sep 08 13:23:35 2009.
1928 Discarded approximately 29 seconds of transactions.
1931 If the pool configuration was not cached, use
1933 with the recovery mode flag:
1934 .Bd -literal -offset 2n
1935 .Li # Ic zpool import -F data
1936 Pool data returned to its state as of Tue Sep 08 13:23:35 2009.
1937 Discarded approximately 29 seconds of transactions.
1941 .Xr zpool-features 7 ,
1944 This manual page is a
1946 reimplementation of the
1950 modified and customized for
1952 and licensed under the Common Development and Distribution License
1957 implementation of this manual page was initially written by
1958 .An Martin Matuska Aq mm@FreeBSD.org .
1962 feature requires a utility to detect zpool degradation and initiate
1963 disk replacement within the zpool. FreeBSD does not provide such a
1964 utility at this time.
projects / FreeBSD / stable / 9.git / blob