2 .\" Copyright (c) 2011, 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>
31 .Nd configures ZFS storage pools
42 .Ar pool device new_device
51 .Op Fl o Ar property Ns = Ns Ar value
53 .Op Fl O Ar file-system-property Ns = Ns Ar value
55 .Op Fl m Ar mountpoint
71 .Ar all | property Ns Op , Ns Ar ...
80 .Op Fl d Ar dir | Fl c Ar cachefile
85 .Op Fl o Ar property Ns = Ns Ar value
87 .Op Fl d Ar dir | Fl c Ar cachefile
98 .Op Fl o Ar property Ns = Ns Ar value
100 .Op Fl d Ar dir | Fl c Ar cachefile
111 .Op Fl T Cm d Ns | Ns Cm u
122 .Op Fl o Ar property Ns Op , Ns Ar ...
123 .Op Fl T Cm d Ns | Ns Cm u
126 .Op Ar inverval Op Ar count
152 .Ar property Ns = Ns Ar value pool
158 .Op Fl o Ar property Ns = Ns Ar value
164 .Op Fl T Cm d Ns | Ns Cm u
167 .Op Ar interval Op Ar count
180 storage pools. A storage pool is a collection of devices that provides physical
181 storage and data replication for
185 All datasets within a storage pool share the same space. See
187 for information on managing datasets.
188 .Ss Virtual Devices (vdevs)
192 describes a single device or a collection of devices organized according to
193 certain performance and fault characteristics. The following virtual devices
197 A block device, typically located under
200 can use individual slices or partitions, though the recommended mode of
201 operation is to use whole disks. A disk can be specified by a full path to the
204 provider name. When given a whole disk,
206 automatically labels the disk, if necessary.
208 A regular file. The use of files as a backing store is strongly discouraged. It
209 is designed primarily for experimental purposes, as the fault tolerance of a
210 file is only as good the file system of which it is a part. A file must be
211 specified by a full path.
213 A mirror of two or more devices. Data is replicated in an identical fashion
214 across all components of a mirror. A mirror with
220 bytes and can withstand
222 devices failing before data integrity is compromised.
225 .Sy raidz1 raidz2 raidz3 ) .
228 that allows for better distribution of parity and eliminates the
230 write hole (in which data and parity become inconsistent after a power loss).
231 Data and parity is striped across all disks within a
237 group can have single-, double- , or triple parity, meaning that the
239 group can sustain one, two, or three failures, respectively, without
242 type specifies a single-parity
246 type specifies a double-parity
250 type specifies a triple-parity
265 parity disks can hold approximately
270 bytes and can withstand
272 device(s) failing before data integrity is compromised. The minimum number of
275 group is one more than the number of parity disks. The
276 recommended number is between 3 and 9 to help increase performance.
279 .No pseudo- Ns No vdev
280 which keeps track of available hot spares for a pool.
281 For more information, see the
285 A separate-intent log device. If more than one log device is specified, then
286 writes are load-balanced between devices. Log devices can be mirrored. However,
289 types are not supported for the intent log. For more information,
294 A device used to cache storage pool data. A cache device cannot be configured
297 group. For more information, see the
302 Virtual devices cannot be nested, so a mirror or
304 virtual device can only
305 contain files or disks. Mirrors of mirrors (or other combinations) are not
308 A pool can have any number of virtual devices at the top of the configuration
312 Data is dynamically distributed across all top-level devices to balance data
313 among devices. As new virtual devices are added,
315 automatically places data on the newly available devices.
317 Virtual devices are specified one at a time on the command line, separated by
318 whitespace. The keywords
322 are used to distinguish where a group ends and another begins. For example, the
323 following creates two root
325 each a mirror of two disks:
326 .Bd -literal -offset 2n
327 .Li # Ic zpool create mypool mirror da0 da1 mirror da2 da3
329 .Ss Device Failure and Recovery
331 supports a rich set of mechanisms for handling device failure and data
332 corruption. All metadata and data is checksummed, and
334 automatically repairs bad data from a good copy when corruption is detected.
336 In order to take advantage of these features, a pool must make use of some form
337 of redundancy, using either mirrored or
341 supports running in a non-redundant configuration, where each root
343 is simply a disk or file, this is strongly discouraged. A single case of bit
344 corruption can render some or all of your data unavailable.
346 A pool's health status is described by one of three states: online, degraded,
347 or faulted. An online pool has all devices operating normally. A degraded pool
348 is one in which one or more devices have failed, but the data is still
349 available due to a redundant configuration. A faulted pool has corrupted
350 metadata, or one or more faulted devices, and insufficient replicas to continue
353 The health of the top-level
358 potentially impacted by the state of its associated
360 or component devices. A top-level
362 or component device is in one of the following states:
363 .Bl -tag -width "DEGRADED"
365 One or more top-level
367 is in the degraded state because one or more
368 component devices are offline. Sufficient replicas exist to continue
371 One or more component devices is in the degraded or faulted state, but
372 sufficient replicas exist to continue functioning. The underlying conditions
374 .Bl -bullet -offset 2n
376 The number of checksum errors exceeds acceptable levels and the device is
377 degraded as an indication that something may be wrong.
379 continues to use the device as necessary.
383 errors exceeds acceptable levels. The device could not be
384 marked as faulted because there are insufficient replicas to continue
388 One or more top-level
390 is in the faulted state because one or more
391 component devices are offline. Insufficient replicas exist to continue
394 One or more component devices is in the faulted state, and insufficient
395 replicas exist to continue functioning. The underlying conditions are as
397 .Bl -bullet -offset 2n
399 The device could be opened, but the contents did not match expected values.
403 errors exceeds acceptable levels and the device is faulted to
404 prevent further use of the device.
407 The device was explicitly taken offline by the
411 The device is online and functioning.
413 The device was physically removed while the system was running. Device removal
414 detection is hardware-dependent and may not be supported on all platforms.
416 The device could not be opened. If a pool is imported when a device was
417 unavailable, then the device will be identified by a unique identifier instead
418 of its path since the path was never correct in the first place.
421 If a device is removed and later reattached to the system,
423 attempts to put the device online automatically. Device attach detection is
424 hardware-dependent and might not be supported on all platforms.
427 allows devices to be associated with pools as
429 These devices are not actively used in the pool, but when an active device
430 fails, it is automatically replaced by a hot spare. To create a pool with hot
434 with any number of devices. For example,
435 .Bd -literal -offset 2n
436 .Li # Ic zpool create pool mirror da0 da1 spare da2 da3
439 Spares can be shared across multiple pools, and can be added with the
441 command and removed with the
443 command. Once a spare replacement is initiated, a new "spare"
446 within the configuration that will remain there until the original device is
447 replaced. At this point, the hot spare becomes available again if another
450 If a pool has a shared spare that is currently being used, the pool can not be
451 exported since other pools may use this shared spare, which may lead to
452 potential data corruption.
454 An in-progress spare replacement can be cancelled by detaching the hot spare.
455 If the original faulted device is detached, then the hot spare assumes its
456 place in the configuration, and is removed from the spare list of all active
459 Spares cannot replace log devices.
467 requirements for synchronous transactions. For instance, databases often
468 require their transactions to be on stable storage devices when returning from
471 and other applications can also use
473 to ensure data stability. By default, the intent log is allocated from blocks
474 within the main pool. However, it might be possible to get better performance
475 using separate intent log devices such as
477 or a dedicated disk. For example:
478 .Bd -literal -offset 2n
479 .Li # Ic zpool create pool da0 da1 log da2
482 Multiple log devices can also be specified, and they can be mirrored. See the
484 section for an example of mirroring multiple log devices.
486 Log devices can be added, replaced, attached, detached, imported and exported
487 as part of the larger pool. Mirrored log devices can be removed by specifying
488 the top-level mirror for the log.
490 Devices can be added to a storage pool as "cache devices." These devices
491 provide an additional layer of caching between main memory and disk. For
492 read-heavy workloads, where the working set size is much larger than what can
493 be cached in main memory, using cache devices allow much more of this working
494 set to be served from low latency media. Using cache devices provides the
495 greatest performance improvement for random read-workloads of mostly static
498 To create a pool with cache devices, specify a "cache"
500 with any number of devices. For example:
501 .Bd -literal -offset 2n
502 .Li # Ic zpool create pool da0 da1 cache da2 da3
505 Cache devices cannot be mirrored or part of a
507 configuration. If a read
508 error is encountered on a cache device, that read
510 is reissued to the original storage pool device, which might be part of a
515 The content of the cache devices is considered volatile, as is the case with
518 Each pool has several properties associated with it. Some properties are
519 read-only statistics while others are configurable and change the behavior of
520 the pool. The following are read-only properties:
521 .Bl -tag -width "dedupratio"
523 Amount of storage space within the pool that has been physically allocated.
525 Percentage of pool space used. This property can also be referred to by its
526 shortened column name, "cap".
528 A text string consisting of printable ASCII characters that will be stored
529 such that it is available even if the pool becomes faulted. An administrator
530 can provide additional information about a pool using this property.
532 The deduplication ratio specified for a pool, expressed as a multiplier.
535 value of 1.76 indicates that 1.76 units of data were stored but only 1 unit of disk space was actually consumed. See
537 for a description of the deduplication feature.
539 Number of blocks within the pool that are not allocated.
541 A unique identifier for the pool.
543 The current health of the pool. Health can be
552 Total size of the storage pool.
554 Amount of storage space used within the pool.
557 These space usage properties report actual physical space available to the
558 storage pool. The physical space can be different from the total amount of
559 space that any contained datasets can actually use. The amount of space used in
562 configuration depends on the characteristics of the data being written.
565 reserves some space for internal accounting that the
567 command takes into account, but the
569 command does not. For non-full pools of a reasonable size, these effects should
570 be invisible. For small pools, or pools that are close to being completely
571 full, these discrepancies may become more noticeable.
573 The following property can be set at creation time and import time:
576 Alternate root directory. If set, this directory is prepended to any mount
577 points within the pool. This can be used when examining an unknown pool where
578 the mount points cannot be trusted, or in an alternate boot environment, where
579 the typical paths are not valid.
581 is not a persistent property. It is valid only while the system is up.
586 though this may be overridden using an explicit setting.
589 The following property can only be set at import time:
591 .It Sy readonly Ns = Ns Cm on No | Cm off
594 pool will be imported in read-only mode with the following restrictions:
595 .Bl -bullet -offset 2n
597 Synchronous data in the intent log will not be accessible
599 Properties of the pool can not be changed
601 Datasets of this pool can only be mounted read-only
603 To write to a read-only pool, a export and import of the pool is required.
607 The following properties can be set at creation time and import time, and later
612 .It Sy autoexpand Ns = Ns Cm on No | Cm off
613 Controls automatic pool expansion when the underlying LUN is grown. If set to
615 the pool will be resized according to the size of the expanded
616 device. If the device is part of a mirror or
618 then all devices within that
619 .No mirror/ Ns No raidz
620 group must be expanded before the new space is made available to
621 the pool. The default behavior is
623 This property can also be referred to by its shortened column name,
625 .It Sy autoreplace Ns = Ns Cm on No | Cm off
626 Controls automatic device replacement. If set to
628 device replacement must be initiated by the administrator by using the
632 any new device, found in the same
633 physical location as a device that previously belonged to the pool, is
634 automatically formatted and replaced. The default behavior is
636 This property can also be referred to by its shortened column name, "replace".
637 .It Sy bootfs Ns = Ns Ar pool Ns / Ns Ar dataset
638 Identifies the default bootable dataset for the root pool. This property is
639 expected to be set mainly by the installation and upgrade programs.
640 .It Sy cachefile Ns = Ns Ar path No | Cm none
641 Controls the location of where the pool configuration is cached. Discovering
642 all pools on system startup requires a cached copy of the configuration data
643 that is stored on the root file system. All pools in this cache are
644 automatically imported when the system boots. Some environments, such as
645 install and clustering, need to cache this information in a different location
646 so that pools are not automatically imported. Setting this property caches the
647 pool configuration in a different location that can later be imported with
648 .Qq Nm Cm import Fl c .
649 Setting it to the special value
651 creates a temporary pool that is never cached, and the special value
653 (empty string) uses the default location.
654 .It Sy dedupditto Ns = Ns Ar number
655 Threshold for the number of block ditto copies. If the reference count for a
656 deduplicated block increases above this number, a new ditto copy of this block
657 is automatically stored. Deafult setting is
659 .It Sy delegation Ns = Ns Cm on No | Cm off
660 Controls whether a non-privileged user is granted access based on the dataset
661 permissions defined on the dataset. See
663 for more information on
665 delegated administration.
666 .It Sy failmode Ns = Ns Cm wait No | Cm continue No | Cm panic
667 Controls the system behavior in the event of catastrophic pool failure. This
668 condition is typically a result of a loss of connectivity to the underlying
669 storage device(s) or a failure of all devices within the pool. The behavior of
670 such an event is determined as follows:
671 .Bl -tag -width indent
675 access until the device connectivity is recovered and the errors are cleared.
676 This is the default behavior.
682 requests but allows reads to any of the remaining healthy devices. Any write
683 requests that have yet to be committed to disk would be blocked.
685 Prints out a message to the console and generates a system crash dump.
687 .It Sy listsnaps Ns = Ns Cm on No | Cm off
688 Controls whether information about snapshots associated with this pool is
693 option. The default value is
695 .It Sy version Ns = Ns Ar version
696 The current on-disk version of the pool. This can be increased, but never
697 decreased. The preferred method of updating pools is with the
699 command, though this property can be used when a specific version is needed
700 for backwards compatibility. This property can be any number between 1 and the
701 current version reported by
702 .Qo Ic zpool upgrade -v Qc .
705 All subcommands that modify state are logged persistently to the pool in their
710 command provides subcommands to create and destroy storage pools, add capacity
711 to storage pools, and provide information about the storage pools. The following
712 subcommands are supported:
719 Displays a help message.
727 Adds the specified virtual devices to the given pool. The
729 specification is described in the
730 .Qq Sx Virtual Devices
731 section. The behavior of the
733 option, and the device checks performed are described in the
736 .Bl -tag -width indent
740 even if they appear in use or specify a conflicting replication level.
741 Not all devices can be overridden in this manner.
743 Displays the configuration that would be used without actually adding the
745 The actual pool creation can still fail due to insufficient privileges or device
748 Do not add a disk that is currently configured as a quorum device to a zpool.
749 After a disk is in the pool, that disk can then be configured as a quorum
756 .Ar pool device new_device
763 device. The existing device cannot be part of a
767 is not currently part of a mirrored configuration,
769 automatically transforms into a two-way mirror of
770 .Ar device No and Ar new_device .
773 is part of a two-way mirror, attaching
775 creates a three-way mirror, and so on. In either case,
777 begins to resilver immediately.
778 .Bl -tag -width indent
782 even if its appears to be in use. Not all devices can be overridden in this
793 Clears device errors in a pool. If no arguments are specified, all device
794 errors within the pool are cleared. If one or more devices is specified, only
795 those errors associated with the specified device or devices are cleared.
796 .Bl -tag -width indent
798 Initiates recovery mode for an unopenable pool. Attempts to discard the last
799 few transactions in the pool to return it to an openable state. Not all damaged
800 pools can be recovered by using this option. If successful, the data from the
801 discarded transactions is irretrievably lost.
803 Used in combination with the
805 flag. Check whether discarding transactions would make the pool openable, but
806 do not actually discard any transactions.
812 .Op Fl o Ar property Ns = Ns Ar value
814 .Op Fl O Ar file-system-property Ns = Ns Ar value
816 .Op Fl m Ar mountpoint
821 Creates a new storage pool containing the virtual devices specified on the
822 command line. The pool name must begin with a letter, and can only contain
823 alphanumeric characters as well as underscore ("_"), dash ("-"), and period
824 ("."). The pool names "mirror", "raidz", "spare" and "log" are reserved, as are
825 names beginning with the pattern "c[0-9]". The
827 specification is described in the
828 .Qq Sx Virtual Devices
831 The command verifies that each device specified is accessible and not currently
832 in use by another subsystem. There are some uses, such as being currently
833 mounted, or specified as the dedicated dump device, that prevents a device from
836 Other uses, such as having a preexisting
838 file system, can be overridden with the
842 The command also checks that the replication strategy for the pool is
843 consistent. An attempt to combine redundant and non-redundant storage in a
844 single pool, or to mix disks and files, results in an error unless
846 is specified. The use of differently sized devices within a single
848 or mirror group is also flagged as an error unless
854 option is specified, the default mount point is
856 The mount point must not exist or must be empty, or else the
857 root dataset cannot be mounted. This can be overridden with the
860 .Bl -tag -width indent
864 even if they appear in use or specify a conflicting replication level.
865 Not all devices can be overridden in this manner.
867 Displays the configuration that would be used without actually creating the
868 pool. The actual pool creation can still fail due to insufficient privileges or
871 .Fl o Ar property Ns = Ns Ar value
872 .Op Fl o Ar property Ns = Ns Ar value
875 Sets the given pool properties. See the
877 section for a list of valid properties that can be set.
880 .Ar file-system-property Ns = Ns Ar value
881 .Op Fl O Ar file-system-property Ns = Ns Ar value
884 Sets the given file system properties in the root file system of the pool. See
886 for a list of valid properties that
890 .Qq Fl o Cm cachefile=none,altroot= Ns Pa root
891 .It Fl m Ar mountpoint
892 Sets the mount point for the root dataset. The default mount point is
895 .Qq Cm altroot Ns Pa /pool
898 is specified. The mount point must be an absolute path,
902 For more information on dataset mount points, see
912 Destroys the given pool, freeing up any devices for other use. This command
913 tries to unmount any active datasets before destroying the pool.
914 .Bl -tag -width indent
916 Forces any active datasets contained within the pool to be unmounted.
926 from a mirror. The operation is refused if there are no other valid replicas
935 Exports the given pools from the system. All devices are marked as exported,
936 but are still considered in use by other subsystems. The devices can be moved
937 between systems (even those of different endianness) and imported as long as a
938 sufficient number of devices are present.
940 Before exporting the pool, all datasets within the pool are unmounted. A pool
941 can not be exported if it has a shared spare that is currently being used.
943 For pools to be portable, you must give the
945 command whole disks, not just slices, so that
947 can label the disks with portable
949 labels. Otherwise, disk drivers on platforms of different endianness will not
951 .Bl -tag -width indent
953 Forcefully unmount all datasets, using the
957 This command will forcefully export the pool even if it has a shared spare that
958 is currently being used. This may lead to potential data corruption.
963 .Ar all | property Ns Op , Ns Ar ...
967 Retrieves the given list of properties (or all properties if
969 is used) for the specified storage pool(s). These properties are displayed with
970 the following fields:
971 .Bl -column -offset indent "property"
972 .It name Ta Name of storage pool
973 .It property Ta Property name
974 .It value Ta Property value
975 .It source Ta Property source, either 'default' or 'local'.
980 section for more information on the available pool properties.
989 Displays the command history of the specified pools or all pools if no pool is
991 .Bl -tag -width indent
993 Displays internally logged
995 events in addition to user initiated events.
997 Displays log records in long format, which in addition to standard format
998 includes, the user name, the hostname, and the zone in which the operation was
1004 .Op Fl d Ar dir | Fl c Ar cachefile
1008 Lists pools available to import. If the
1010 option is not specified, this command searches for devices in
1014 option can be specified multiple times, and all directories are searched. If
1015 the device appears to be part of an exported pool, this command displays a
1016 summary of the pool with the name of the pool, a numeric identifier, as well as
1019 layout and current health of the device for each device or file.
1020 Destroyed pools, pools that were previously destroyed with the
1022 command, are not listed unless the
1024 option is specified.
1026 The numeric identifier is unique, and can be used instead of the pool name when
1027 multiple exported pools of the same name are available.
1028 .Bl -tag -width indent
1029 .It Fl c Ar cachefile
1030 Reads configuration from the given
1032 that was created with the
1036 is used instead of searching for devices.
1038 Searches for devices or files in
1042 option can be specified multiple times.
1044 Lists destroyed pools only.
1050 .Op Fl o Ar property Ns = Ns Ar value
1052 .Op Fl d Ar dir | Fl c Ar cachefile
1062 Imports all pools found in the search directories. Identical to the previous
1063 command, except that all pools with a sufficient number of devices available
1064 are imported. Destroyed pools, pools that were previously destroyed with the
1066 command, will not be imported unless the
1068 option is specified.
1069 .Bl -tag -width indent
1071 Comma-separated list of mount options to use when mounting datasets within the
1074 for a description of dataset properties and mount options.
1075 .It Fl o Ar property Ns = Ns Ar value
1076 Sets the specified property on the imported pool. See the
1078 section for more information on the available pool properties.
1079 .It Fl c Ar cachefile
1080 Reads configuration from the given
1082 that was created with the
1086 is used instead of searching for devices.
1088 Searches for devices or files in
1092 option can be specified multiple times. This option is incompatible with the
1096 Imports destroyed pools only. The
1098 option is also required.
1100 Forces import, even if the pool appears to be potentially active.
1102 Enables import with missing log devices.
1104 Do not mount any filesystems from the imported pool.
1115 Recovery mode for a non-importable pool. Attempt to return the pool to an
1116 importable state by discarding the last few transactions. Not all damaged pools
1117 can be recovered by using this option. If successful, the data from the
1118 discarded transactions is irretrievably lost. This option is ignored if the
1119 pool is importable or already imported.
1123 recovery option. Determines whether a non-importable pool can be made
1124 importable again, but does not actually perform the pool recovery. For more
1125 details about pool recovery mode, see the
1129 Searches for and imports all pools found.
1135 .Op Fl o Ar property Ns = Ns Ar value
1137 .Op Fl d Ar dir | Fl c Ar cachefile
1148 Imports a specific pool. A pool can be identified by its name or the numeric
1151 is specified, the pool is imported using the name
1153 Otherwise, it is imported with the same name as its exported name.
1155 If a device is removed from a system without running
1157 first, the device appears as potentially active. It cannot be determined if
1158 this was a failed export, or whether the device is really in use from another
1159 host. To import a pool in this state, the
1162 .Bl -tag -width indent
1164 Comma-separated list of mount options to use when mounting datasets within the
1167 for a description of dataset properties and mount options.
1168 .It Fl o Ar property Ns = Ns Ar value
1169 Sets the specified property on the imported pool. See the
1171 section for more information on the available pool properties.
1172 .It Fl c Ar cachefile
1173 Reads configuration from the given
1175 that was created with the
1179 is used instead of searching for devices.
1181 Searches for devices or files in
1185 option can be specified multiple times. This option is incompatible with the
1189 Imports destroyed pools only. The
1191 option is also required.
1193 Forces import, even if the pool appears to be potentially active.
1195 Enables import with missing log devices.
1197 Do not mount any filesystems from the imported pool.
1200 .Qq Fl o Cm cachefile=none,altroot= Ns Pa root
1202 Recovery mode for a non-importable pool. Attempt to return the pool to an
1203 importable state by discarding the last few transactions. Not all damaged pools
1204 can be recovered by using this option. If successful, the data from the
1205 discarded transactions is irretrievably lost. This option is ignored if the
1206 pool is importable or already imported.
1210 recovery option. Determines whether a non-importable pool can be made
1211 importable again, but does not actually perform the pool recovery. For more
1212 details about pool recovery mode, see the
1219 .Op Fl T Cm d Ns | Ns Cm u
1223 .Op Ar interval Op Ar count
1228 statistics for the given pools. When given an interval, the statistics are
1235 are specified, statistics for every pool in the system is shown. If
1237 is specified, the command exits after
1239 reports are printed.
1240 .Bl -tag -width indent
1241 .It Fl T Cm d Ns | Ns Cm u
1246 for standard date format. See
1251 .Pq equals Qq Ic date +%s .
1253 Verbose statistics. Reports usage statistics for individual
1255 within the pool, in addition to the pool-wide statistics.
1266 label information from the specified
1270 must not be part of an active pool configuration.
1271 .Bl -tag -width indent
1273 Treat exported or foreign devices as inactive.
1279 .Op Fl o Ar property Ns Op , Ns Ar ...
1280 .Op Fl T Cm d Ns | Ns Cm u
1283 .Op Ar inverval Op Ar count
1286 Lists the given pools along with a health status and space usage. When given no
1287 arguments, all pools in the system are listed.
1289 When given an interval, the output is printed every
1295 is specified, the command exits after
1297 reports are printed.
1298 .Bl -tag -width indent
1300 Scripted mode. Do not display headers, and separate fields by a single tab
1301 instead of arbitrary space.
1302 .It Fl o Ar property Ns Op , Ns Ar ...
1303 Comma-separated list of properties to display. See the
1305 section for a list of valid properties. The default list is
1313 .It Fl T Cm d Ns | Ns Cm u
1318 for standard date format. See
1323 .Pq equals Qq Ic date +%s .
1332 Takes the specified physical device offline. While the
1334 is offline, no attempt is made to read or write to the device.
1335 .Bl -tag -width indent
1337 Temporary. Upon reboot, the specified physical device reverts to its previous
1347 Brings the specified physical device online.
1349 This command is not applicable to spares or cache devices.
1350 .Bl -tag -width indent
1352 Expand the device to use all available space. If the device is part of a mirror
1355 then all devices must be expanded before the new space will become
1356 available to the pool.
1364 Generates a new unique identifier for the pool. You must ensure that all
1365 devices in this pool are online and healthy before performing this action.
1372 Removes the specified device from the pool. This command currently only
1373 supports removing hot spares, cache, and log devices. A mirrored log device can
1374 be removed by specifying the top-level mirror for the log. Non-log devices that
1375 are part of a mirrored configuration can be removed using the
1377 command. Non-redundant and
1379 devices cannot be removed from a pool.
1392 This is equivalent to attaching
1394 waiting for it to resilver, and then detaching
1399 must be greater than or equal to the minimum size
1400 of all the devices in a mirror or
1405 is required if the pool is not redundant. If
1407 is not specified, it defaults to
1409 This form of replacement is useful after an existing disk has failed and has
1410 been physically replaced. In this case, the new disk may have the same
1412 path as the old device, even though it is actually a different disk.
1415 .Bl -tag -width indent
1419 even if its appears to be in use. Not all devices can be overridden in this
1429 Begins a scrub. The scrub examines all data in the specified pools to verify
1430 that it checksums correctly. For replicated (mirror or
1434 automatically repairs any damage discovered during the scrub. The
1436 command reports the progress of the scrub and summarizes the results of the
1437 scrub upon completion.
1439 Scrubbing and resilvering are very similar operations. The difference is that
1440 resilvering only examines data that
1442 knows to be out of date (for example, when attaching a new device to a mirror
1443 or replacing an existing device), whereas scrubbing examines all data to
1444 discover silent errors due to hardware faults or disk failure.
1446 Because scrubbing and resilvering are
1447 .Tn I/O Ns -intensive
1450 only allows one at a time. If a scrub is already in progress, the
1452 command returns an error. To start a new scrub, you have to stop the old scrub
1454 .Qq Nm Cm scrub Fl s
1455 command first. If a resilver is in progress,
1457 does not allow a scrub to be started until the resilver completes.
1458 .Bl -tag -width indent
1465 .Ar property Ns = Ns Ar value pool
1468 Sets the given property on the specified pool. See the
1470 section for more information on what properties can be set and acceptable
1478 .Op Fl o Ar property Ns = Ns Ar value
1483 Splits off one disk from each mirrored top-level
1485 in a pool and creates a new pool from the split-off disks. The original pool
1486 must be made up of one or more mirrors and must not be in the process of
1489 subcommand chooses the last device in each mirror
1491 unless overridden by a device specification on the command line.
1497 includes the specified device(s) in a new pool and, should any devices remain
1498 unspecified, assigns the last device in each mirror
1500 to that pool, as it does normally. If you are uncertain about the outcome of a
1504 ("dry-run") option to ensure your command will have the effect you intend.
1505 .Bl -tag -width indent
1507 Automatically import the newly created pool after splitting, using the
1510 parameter for the new pool's alternate root. See the
1516 Displays the configuration that would be created without actually splitting the
1517 pool. The actual pool split could still fail due to insufficient privileges or
1520 Comma-separated list of mount options to use when mounting datasets within the
1523 for a description of dataset properties and mount options. Valid only in
1524 conjunction with the
1527 .It Fl o Ar property Ns = Ns Ar value
1528 Sets the specified property on the new pool. See the
1530 section, above, for more information on the available pool properties.
1536 .Op Fl T Cm d Ns | Ns Cm u
1539 .Op Ar interval Op Ar count
1542 Displays the detailed health status for the given pools. If no
1544 is specified, then the status of each pool in the system is displayed. For more
1545 information on pool and device health, see the
1546 .Qq Sx Device Failure and Recovery
1549 When given an interval, the output is printed every
1555 is specified, the command exits after
1557 reports are printed.
1559 If a scrub or resilver is in progress, this command reports the percentage done
1560 and the estimated time to completion. Both of these are only approximate,
1561 because the amount of data in the pool and the other workloads on the system
1563 .Bl -tag -width indent
1565 Only display status for pools that are exhibiting errors or are otherwise
1568 Displays verbose data error information, printing out a complete list of all
1569 data errors since the last complete pool scrub.
1570 .It Fl T Cm d Ns | Ns Cm u
1575 for standard date format. See
1580 .Pq equals Qq Ic date +%s .
1588 Displays all pools formatted using a different
1590 pool on-disk version. Older versions can continue to be used, but some
1591 features may not be available. These pools can be upgraded using
1592 .Qq Nm Cm upgrade Fl a .
1593 Pools that are formatted with a more recent version are also displayed,
1594 although these pools will be inaccessible on the system.
1595 .Bl -tag -width indent
1599 pool versions supported by the current software. The current
1601 pool version and all previous supported versions are displayed, along
1602 with an explanation of the features provided with each version.
1611 Upgrades the given pool to the latest on-disk pool version. Once this is done,
1612 the pool will no longer be accessible on systems running older versions of the
1614 .Bl -tag -width indent
1618 Upgrade to the specified version. If the
1620 flag is not specified, the pool is upgraded to the most recent version. This
1621 option can only be used to increase the version number, and only up to the most
1622 recent version supported by this software.
1627 .It Sy Example 1 No Creating a RAID-Z Storage Pool
1629 The following command creates a pool with a single
1633 that consists of six disks.
1634 .Bd -literal -offset 2n
1635 .Li # Ic zpool create tank raidz da0 da1 da2 da3 da4 da5
1637 .It Sy Example 2 No Creating a Mirrored Storage Pool
1639 The following command creates a pool with two mirrors, where each mirror
1641 .Bd -literal -offset 2n
1642 .Li # Ic zpool create tank mirror da0 da1 mirror da2 da3
1644 .It Sy Example 3 No Creating a Tn ZFS No Storage Pool by Using Partitions
1646 The following command creates an unmirrored pool using two GPT partitions.
1647 .Bd -literal -offset 2n
1648 .Li # Ic zpool create tank da0p3 da1p3
1650 .It Sy Example 4 No Creating a Tn ZFS No Storage Pool by Using Files
1652 The following command creates an unmirrored pool using files. While not
1653 recommended, a pool based on files can be useful for experimental purposes.
1654 .Bd -literal -offset 2n
1655 .Li # Ic zpool create tank /path/to/file/a /path/to/file/b
1657 .It Sy Example 5 No Adding a Mirror to a Tn ZFS No Storage Pool
1659 The following command adds two mirrored disks to the pool
1661 assuming the pool is already made up of two-way mirrors. The additional space
1662 is immediately available to any datasets within the pool.
1663 .Bd -literal -offset 2n
1664 .Li # Ic zpool add tank mirror da2 da3
1666 .It Sy Example 6 No Listing Available Tn ZFS No Storage Pools
1668 The following command lists all available pools on the system.
1669 .Bd -literal -offset 2n
1671 NAME SIZE ALLOC FREE CAP DEDUP HEALTH ALTROOT
1672 pool 2.70T 473G 2.24T 17% 1.00x ONLINE -
1673 test 1.98G 89.5K 1.98G 0% 1.00x ONLINE -
1675 .It Sy Example 7 No Listing All Properties for a Pool
1677 The following command lists all the properties for a pool.
1678 .Bd -literal -offset 2n
1679 .Li # Ic zpool get all pool
1682 pool altroot - default
1683 pool health ONLINE -
1684 pool guid 2501120270416322443 default
1685 pool version 28 default
1686 pool bootfs pool/root local
1687 pool delegation on default
1688 pool autoreplace off default
1689 pool cachefile - default
1690 pool failmode wait default
1691 pool listsnapshots off default
1692 pool autoexpand off default
1693 pool dedupditto 0 default
1694 pool dedupratio 1.00x -
1696 pool allocated 473G -
1699 .It Sy Example 8 No Destroying a Tn ZFS No Storage Pool
1701 The following command destroys the pool
1703 and any datasets contained within.
1704 .Bd -literal -offset 2n
1705 .Li # Ic zpool destroy -f tank
1707 .It Sy Example 9 No Exporting a Tn ZFS No Storage Pool
1709 The following command exports the devices in pool
1711 so that they can be relocated or later imported.
1712 .Bd -literal -offset 2n
1713 .Li # Ic zpool export tank
1715 .It Sy Example 10 No Importing a Tn ZFS No Storage Pool
1717 The following command displays available pools, and then imports the pool
1719 for use on the system.
1721 The results from this command are similar to the following:
1722 .Bd -literal -offset 2n
1723 .Li # Ic zpool import
1726 id: 15451357997522795478
1728 action: The pool can be imported using its name or numeric identifier.
1740 Storage Pools to the Current Version
1743 The following command upgrades all
1745 Storage pools to the current version of
1747 .Bd -literal -offset 2n
1748 .Li # Ic zpool upgrade -a
1749 This system is currently running ZFS pool version 28.
1751 .It Sy Example 12 No Managing Hot Spares
1753 The following command creates a new pool with an available hot spare:
1754 .Bd -literal -offset 2n
1755 .Li # Ic zpool create tank mirror da0 da1 spare da2
1758 If one of the disks were to fail, the pool would be reduced to the degraded
1759 state. The failed device can be replaced using the following command:
1760 .Bd -literal -offset 2n
1761 .Li # Ic zpool replace tank da0 da2
1764 Once the data has been resilvered, the spare is automatically removed and is
1765 made available should another device fails. The hot spare can be permanently
1766 removed from the pool using the following command:
1767 .Bd -literal -offset 2n
1768 .Li # Ic zpool remove tank da2
1774 Pool with Mirrored Separate Intent Logs
1777 The following command creates a
1779 storage pool consisting of two, two-way
1780 mirrors and mirrored log devices:
1781 .Bd -literal -offset 2n
1782 .Li # Ic zpool create pool mirror da0 da1 mirror da2 da3 log mirror da4 da5
1784 .It Sy Example 14 No Adding Cache Devices to a Tn ZFS No Pool
1786 The following command adds two disks for use as cache devices to a
1789 .Bd -literal -offset 2n
1790 .Li # Ic zpool add pool cache da2 da3
1793 Once added, the cache devices gradually fill with content from main memory.
1794 Depending on the size of your cache devices, it could take over an hour for
1795 them to fill. Capacity and reads can be monitored using the
1797 subcommand as follows:
1798 .Bd -literal -offset 2n
1799 .Li # Ic zpool iostat -v pool 5
1801 .It Sy Example 15 No Removing a Mirrored Log Device
1803 The following command removes the mirrored log device
1806 Given this configuration:
1807 .Bd -literal -offset 2n
1810 scrub: none requested
1813 NAME STATE READ WRITE CKSUM
1815 mirror-0 ONLINE 0 0 0
1818 mirror-1 ONLINE 0 0 0
1822 mirror-2 ONLINE 0 0 0
1827 The command to remove the mirrored log
1830 .Bd -literal -offset 2n
1831 .Li # Ic zpool remove tank mirror-2
1833 .It Sy Example 16 No Recovering a Faulted Tn ZFS No Pool
1835 If a pool is faulted but recoverable, a message indicating this state is
1838 if the pool was cached (see the
1840 argument above), or as part of the error output from a failed
1844 Recover a cached pool with the
1847 .Bd -literal -offset 2n
1848 .Li # Ic zpool clear -F data
1849 Pool data returned to its state as of Tue Sep 08 13:23:35 2009.
1850 Discarded approximately 29 seconds of transactions.
1853 If the pool configuration was not cached, use
1855 with the recovery mode flag:
1856 .Bd -literal -offset 2n
1857 .Li # Ic zpool import -F data
1858 Pool data returned to its state as of Tue Sep 08 13:23:35 2009.
1859 Discarded approximately 29 seconds of transactions.
1863 The following exit values are returned:
1864 .Bl -tag -offset 2n -width 2n
1866 Successful completion.
1870 Invalid command line options were specified.
1875 This manual page is a
1877 reimplementation of the
1881 modified and customized for
1883 and licensed under the Common Development and Distribution License
1888 implementation of this manual page was initially written by
1889 .An Martin Matuska Aq mm@FreeBSD.org .
projects / FreeBSD / stable / 9.git / blob