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
149 .Ar property Ns = Ns Ar value pool
155 .Op Fl o Ar property Ns = Ns Ar value
161 .Op Fl T Cm d Ns | Ns Cm u
164 .Op Ar interval Op Ar count
177 storage pools. A storage pool is a collection of devices that provides physical
178 storage and data replication for
182 All datasets within a storage pool share the same space. See
184 for information on managing datasets.
185 .Ss Virtual Devices (vdevs)
189 describes a single device or a collection of devices organized according to
190 certain performance and fault characteristics. The following virtual devices
194 A block device, typically located under
197 can use individual slices or partitions, though the recommended mode of
198 operation is to use whole disks. A disk can be specified by a full path to the
201 provider name. When given a whole disk,
203 automatically labels the disk, if necessary.
205 A regular file. The use of files as a backing store is strongly discouraged. It
206 is designed primarily for experimental purposes, as the fault tolerance of a
207 file is only as good the file system of which it is a part. A file must be
208 specified by a full path.
210 A mirror of two or more devices. Data is replicated in an identical fashion
211 across all components of a mirror. A mirror with
217 bytes and can withstand
219 devices failing before data integrity is compromised.
221 .No ( or Sy raidz1 raidz2 raidz3 Ns ).
224 that allows for better distribution of parity and eliminates the
225 .Qq Sy RAID-5 No write hole
226 (in which data and parity become inconsistent after a power loss). Data and
227 parity is striped across all disks within a
233 group can have single-, double- , or triple parity, meaning that the
235 group can sustain one, two, or three failures, respectively, without
238 type specifies a single-parity
242 type specifies a double-parity
246 type specifies a triple-parity
261 parity disks can hold approximately
266 bytes and can withstand
268 device(s) failing before data integrity is compromised. The minimum number of
271 group is one more than the number of parity disks. The
272 recommended number is between 3 and 9 to help increase performance.
275 .No pseudo- Ns No vdev
276 which keeps track of available hot spares for a pool.
277 For more information, see the
281 A separate-intent log device. If more than one log device is specified, then
282 writes are load-balanced between devices. Log devices can be mirrored. However,
285 types are not supported for the intent log. For more information,
290 A device used to cache storage pool data. A cache device cannot be configured
293 group. For more information, see the
298 Virtual devices cannot be nested, so a mirror or
300 virtual device can only
301 contain files or disks. Mirrors of mirrors (or other combinations) are not
304 A pool can have any number of virtual devices at the top of the configuration
308 Data is dynamically distributed across all top-level devices to balance data
309 among devices. As new virtual devices are added,
311 automatically places data on the newly available devices.
313 Virtual devices are specified one at a time on the command line, separated by
314 whitespace. The keywords
318 are used to distinguish where a group ends and another begins. For example, the
319 following creates two root
321 each a mirror of two disks:
322 .Ss Device Failure and Recovery
324 supports a rich set of mechanisms for handling device failure and data
325 corruption. All metadata and data is checksummed, and
327 automatically repairs bad data from a good copy when corruption is detected.
329 In order to take advantage of these features, a pool must make use of some form
330 of redundancy, using either mirrored or
334 supports running in a non-redundant configuration, where each root
336 is simply a disk or file, this is strongly discouraged. A single case of bit
337 corruption can render some or all of your data unavailable.
339 A pool's health status is described by one of three states: online, degraded,
340 or faulted. An online pool has all devices operating normally. A degraded pool
341 is one in which one or more devices have failed, but the data is still
342 available due to a redundant configuration. A faulted pool has corrupted
343 metadata, or one or more faulted devices, and insufficient replicas to continue
346 The health of the top-level
351 potentially impacted by the state of its associated
353 or component devices. A top-level
355 or component device is in one of the following states:
356 .Bl -tag -width "DEGRADED"
358 One or more top-level
360 is in the degraded state because one or more
361 component devices are offline. Sufficient replicas exist to continue
364 One or more component devices is in the degraded or faulted state, but
365 sufficient replicas exist to continue functioning. The underlying conditions
367 .Bl -bullet -offset 2n
369 The number of checksum errors exceeds acceptable levels and the device is
370 degraded as an indication that something may be wrong.
372 continues to use the device as necessary.
376 errors exceeds acceptable levels. The device could not be
377 marked as faulted because there are insufficient replicas to continue
381 One or more top-level
383 is in the faulted state because one or more
384 component devices are offline. Insufficient replicas exist to continue
387 One or more component devices is in the faulted state, and insufficient
388 replicas exist to continue functioning. The underlying conditions are as
390 .Bl -bullet -offset 2n
392 The device could be opened, but the contents did not match expected values.
396 errors exceeds acceptable levels and the device is faulted to
397 prevent further use of the device.
400 The device was explicitly taken offline by the
404 The device is online and functioning.
406 The device was physically removed while the system was running. Device removal
407 detection is hardware-dependent and may not be supported on all platforms.
409 The device could not be opened. If a pool is imported when a device was
410 unavailable, then the device will be identified by a unique identifier instead
411 of its path since the path was never correct in the first place.
414 If a device is removed and later reattached to the system,
416 attempts to put the device online automatically. Device attach detection is
417 hardware-dependent and might not be supported on all platforms.
420 allows devices to be associated with pools as
422 These devices are not actively used in the pool, but when an active device
423 fails, it is automatically replaced by a hot spare. To create a pool with hot
427 with any number of devices. For example,
428 .Bd -literal -offset 2n
429 .Li # Ic zpool create pool mirror da0 da1 spare da2 da3
432 Spares can be shared across multiple pools, and can be added with the
434 command and removed with the
436 command. Once a spare replacement is initiated, a new "spare"
439 within the configuration that will remain there until the original device is
440 replaced. At this point, the hot spare becomes available again if another
443 If a pool has a shared spare that is currently being used, the pool can not be
444 exported since other pools may use this shared spare, which may lead to
445 potential data corruption.
447 An in-progress spare replacement can be cancelled by detaching the hot spare.
448 If the original faulted device is detached, then the hot spare assumes its
449 place in the configuration, and is removed from the spare list of all active
452 Spares cannot replace log devices.
460 requirements for synchronous transactions. For instance, databases often
461 require their transactions to be on stable storage devices when returning from
464 and other applications can also use
466 to ensure data stability. By default, the intent log is allocated from blocks
467 within the main pool. However, it might be possible to get better performance
468 using separate intent log devices such as
470 or a dedicated disk. For example:
471 .Bd -literal -offset 2n
472 .Li # Ic zpool create pool da0 da1 log da2
475 Multiple log devices can also be specified, and they can be mirrored. See the
477 section for an example of mirroring multiple log devices.
479 Log devices can be added, replaced, attached, detached, imported and exported
480 as part of the larger pool. Mirrored log devices can be removed by specifying
481 the top-level mirror for the log.
483 Devices can be added to a storage pool as "cache devices." These devices
484 provide an additional layer of caching between main memory and disk. For
485 read-heavy workloads, where the working set size is much larger than what can
486 be cached in main memory, using cache devices allow much more of this working
487 set to be served from low latency media. Using cache devices provides the
488 greatest performance improvement for random read-workloads of mostly static
491 To create a pool with cache devices, specify a "cache"
493 with any number of devices. For example:
494 .Bd -literal -offset 2n
495 .Li # Ic zpool create pool da0 da1 cache da2 da3
498 Cache devices cannot be mirrored or part of a
500 configuration. If a read
501 error is encountered on a cache device, that read
503 is reissued to the original storage pool device, which might be part of a
508 The content of the cache devices is considered volatile, as is the case with
511 Each pool has several properties associated with it. Some properties are
512 read-only statistics while others are configurable and change the behavior of
513 the pool. The following are read-only properties:
514 .Bl -tag -width "dedupratio"
516 Amount of storage space within the pool that has been physically allocated.
518 Percentage of pool space used. This property can also be referred to by its
519 shortened column name, "cap".
521 A text string consisting of printable ASCII characters that will be stored
522 such that it is available even if the pool becomes faulted. An administrator
523 can provide additional information about a pool using this property.
525 The deduplication ratio specified for a pool, expressed as a multiplier.
528 value of 1.76 indicates that 1.76 units of data were stored but only 1 unit of disk space was actually consumed. See
530 for a description of the deduplication feature.
532 Number of blocks within the pool that are not allocated.
534 A unique identifier for the pool.
536 The current health of the pool. Health can be
541 .Qq Sy REMOVED Ns , or
544 Total size of the storage pool.
546 Amount of storage space used within the pool.
549 These space usage properties report actual physical space available to the
550 storage pool. The physical space can be different from the total amount of
551 space that any contained datasets can actually use. The amount of space used in
554 configuration depends on the characteristics of the data being written.
557 reserves some space for internal accounting that the
559 command takes into account, but the
561 command does not. For non-full pools of a reasonable size, these effects should
562 be invisible. For small pools, or pools that are close to being completely
563 full, these discrepancies may become more noticeable.
565 The following property can be set at creation time and import time:
568 Alternate root directory. If set, this directory is prepended to any mount
569 points within the pool. This can be used when examining an unknown pool where
570 the mount points cannot be trusted, or in an alternate boot environment, where
571 the typical paths are not valid.
573 is not a persistent property. It is valid only while the system is up.
577 .Cm cachefile=none Ns ,
578 though this may be overridden using an explicit setting.
581 The following property can only be set at import time:
583 .It Sy readonly Ns = Ns Cm on No | Cm off
586 pool will be imported in read-only mode with the following restrictions:
587 .Bl -bullet -offset 2n
589 Synchronous data in the intent log will not be accessible
591 Properties of the pool can not be changed
593 Datasets of this pool can only be mounted read-only
595 To write to a read-only pool, a export and import of the pool is required.
599 The following properties can be set at creation time and import time, and later
604 .It Sy autoexpand Ns = Ns Cm on No | Cm off
605 Controls automatic pool expansion when the underlying LUN is grown. If set to
607 the pool will be resized according to the size of the expanded
608 device. If the device is part of a mirror or
610 then all devices within that
611 .No mirror/ Ns No raidz
612 group must be expanded before the new space is made available to
613 the pool. The default behavior is
615 This property can also be referred to by its shortened column name,
617 .It Sy autoreplace Ns = Ns Cm on No | Cm off
618 Controls automatic device replacement. If set to
620 device replacement must be initiated by the administrator by using the
624 any new device, found in the same
625 physical location as a device that previously belonged to the pool, is
626 automatically formatted and replaced. The default behavior is
628 This property can also be referred to by its shortened column name, "replace".
629 .It Sy bootfs Ns = Ns Ar pool Ns / Ns Ar dataset
630 Identifies the default bootable dataset for the root pool. This property is
631 expected to be set mainly by the installation and upgrade programs.
632 .It Sy cachefile Ns = Ns Ar path No | Cm none
633 Controls the location of where the pool configuration is cached. Discovering
634 all pools on system startup requires a cached copy of the configuration data
635 that is stored on the root file system. All pools in this cache are
636 automatically imported when the system boots. Some environments, such as
637 install and clustering, need to cache this information in a different location
638 so that pools are not automatically imported. Setting this property caches the
639 pool configuration in a different location that can later be imported with
640 .Qq Nm Cm import Fl c .
641 Setting it to the special value
643 creates a temporary pool that is never cached, and the special value
645 (empty string) uses the default location.
646 .It Sy dedupditto Ns = Ns Ar number
647 Threshold for the number of block ditto copies. If the reference count for a
648 deduplicated block increases above this number, a new ditto copy of this block
649 is automatically stored. Deafult setting is
651 .It Sy delegation Ns = Ns Cm on No | Cm off
652 Controls whether a non-privileged user is granted access based on the dataset
653 permissions defined on the dataset. See
655 for more information on
657 delegated administration.
658 .It Sy failmode Ns = Ns Cm wait No | Cm continue No | Cm panic
659 Controls the system behavior in the event of catastrophic pool failure. This
660 condition is typically a result of a loss of connectivity to the underlying
661 storage device(s) or a failure of all devices within the pool. The behavior of
662 such an event is determined as follows:
663 .Bl -tag -width indent
667 access until the device connectivity is recovered and the errors are cleared.
668 This is the default behavior.
674 requests but allows reads to any of the remaining healthy devices. Any write
675 requests that have yet to be committed to disk would be blocked.
677 Prints out a message to the console and generates a system crash dump.
679 .It Sy listsnaps Ns = Ns Cm on No | Cm off
680 Controls whether information about snapshots associated with this pool is
685 option. The default value is
687 .It Sy version Ns = Ns Ar version
688 The current on-disk version of the pool. This can be increased, but never
689 decreased. The preferred method of updating pools is with the
691 command, though this property can be used when a specific version is needed
692 for backwards compatibility. This property can be any number between 1 and the
693 current version reported by
694 .Qo Ic zpool upgrade -v Qc Ns .
697 All subcommands that modify state are logged persistently to the pool in their
702 command provides subcommands to create and destroy storage pools, add capacity
703 to storage pools, and provide information about the storage pools. The following
704 subcommands are supported:
711 Displays a help message.
719 Adds the specified virtual devices to the given pool. The
721 specification is described in the
722 .Qq Sx Virtual Devices
723 section. The behavior of the
725 option, and the device checks performed are described in the
728 .Bl -tag -width indent
732 even if they appear in use or specify a conflicting replication level.
733 Not all devices can be overridden in this manner.
735 Displays the configuration that would be used without actually adding the
737 The actual pool creation can still fail due to insufficient privileges or device
740 Do not add a disk that is currently configured as a quorum device to a zpool.
741 After a disk is in the pool, that disk can then be configured as a quorum
748 .Ar pool device new_device
755 device. The existing device cannot be part of a
759 is not currently part of a mirrored configuration,
761 automatically transforms into a two-way mirror of
762 .Ar device No and Ar new_device Ns . If
764 is part of a two-way mirror, attaching
766 creates a three-way mirror, and so on. In either case,
768 begins to resilver immediately.
769 .Bl -tag -width indent
773 even if its appears to be in use. Not all devices can be overridden in this
784 Clears device errors in a pool. If no arguments are specified, all device
785 errors within the pool are cleared. If one or more devices is specified, only
786 those errors associated with the specified device or devices are cleared.
787 .Bl -tag -width indent
789 Initiates recovery mode for an unopenable pool. Attempts to discard the last
790 few transactions in the pool to return it to an openable state. Not all damaged
791 pools can be recovered by using this option. If successful, the data from the
792 discarded transactions is irretrievably lost.
794 Used in combination with the
796 flag. Check whether discarding transactions would make the pool openable, but
797 do not actually discard any transactions.
803 .Op Fl o Ar property Ns = Ns Ar value
805 .Op Fl O Ar file-system-property Ns = Ns Ar value
807 .Op Fl m Ar mountpoint
812 Creates a new storage pool containing the virtual devices specified on the
813 command line. The pool name must begin with a letter, and can only contain
814 alphanumeric characters as well as underscore ("_"), dash ("-"), and period
815 ("."). The pool names "mirror", "raidz", "spare" and "log" are reserved, as are
816 names beginning with the pattern "c[0-9]". The
818 specification is described in the
819 .Qq Sx Virtual Devices
822 The command verifies that each device specified is accessible and not currently
823 in use by another subsystem. There are some uses, such as being currently
824 mounted, or specified as the dedicated dump device, that prevents a device from
827 Other uses, such as having a preexisting
829 file system, can be overridden with the
833 The command also checks that the replication strategy for the pool is
834 consistent. An attempt to combine redundant and non-redundant storage in a
835 single pool, or to mix disks and files, results in an error unless
837 is specified. The use of differently sized devices within a single
839 or mirror group is also flagged as an error unless
845 option is specified, the default mount point is
847 The mount point must not exist or must be empty, or else the
848 root dataset cannot be mounted. This can be overridden with the
851 .Bl -tag -width indent
855 even if they appear in use or specify a conflicting replication level.
856 Not all devices can be overridden in this manner.
858 Displays the configuration that would be used without actually creating the
859 pool. The actual pool creation can still fail due to insufficient privileges or
862 .Fl o Ar property Ns = Ns Ar value
863 .Op Fl o Ar property Ns = Ns Ar value
866 Sets the given pool properties. See the
868 section for a list of valid properties that can be set.
871 .Ar file-system-property Ns = Ns Ar value
872 .Op Fl O Ar file-system-property Ns = Ns Ar value
875 Sets the given file system properties in the root file system of the pool. See
877 for a list of valid properties that
881 .Qq Fl o Cm cachefile=none,altroot= Ns Pa root
882 .It Fl m Ar mountpoint
883 Sets the mount point for the root dataset. The default mount point is
886 .Qq Cm altroot Ns Pa /pool
889 is specified. The mount point must be an absolute path,
890 .Qq Cm legacy Ns , or Qq Cm none Ns .
891 For more information on dataset mount points, see
901 Destroys the given pool, freeing up any devices for other use. This command
902 tries to unmount any active datasets before destroying the pool.
903 .Bl -tag -width indent
905 Forces any active datasets contained within the pool to be unmounted.
915 from a mirror. The operation is refused if there are no other valid replicas
924 Exports the given pools from the system. All devices are marked as exported,
925 but are still considered in use by other subsystems. The devices can be moved
926 between systems (even those of different endianness) and imported as long as a
927 sufficient number of devices are present.
929 Before exporting the pool, all datasets within the pool are unmounted. A pool
930 can not be exported if it has a shared spare that is currently being used.
932 For pools to be portable, you must give the
934 command whole disks, not just slices, so that
936 can label the disks with portable
938 labels. Otherwise, disk drivers on platforms of different endianness will not
940 .Bl -tag -width indent
942 Forcefully unmount all datasets, using the
946 This command will forcefully export the pool even if it has a shared spare that
947 is currently being used. This may lead to potential data corruption.
952 .Ar all | property Ns Op , Ns Ar ...
956 Retrieves the given list of properties (or all properties if
958 is used) for the specified storage pool(s). These properties are displayed with
959 the following fields:
960 .Bl -column -offset indent "property"
961 .It name Ta Name of storage pool
962 .It property Ta Property name
963 .It value Ta Property value
964 .It source Ta Property source, either 'default' or 'local'.
969 section for more information on the available pool properties.
978 Displays the command history of the specified pools or all pools if no pool is
980 .Bl -tag -width indent
982 Displays internally logged
984 events in addition to user initiated events.
986 Displays log records in long format, which in addition to standard format
987 includes, the user name, the hostname, and the zone in which the operation was
993 .Op Fl d Ar dir | Fl c Ar cachefile
997 Lists pools available to import. If the
999 option is not specified, this command searches for devices in
1003 option can be specified multiple times, and all directories are searched. If
1004 the device appears to be part of an exported pool, this command displays a
1005 summary of the pool with the name of the pool, a numeric identifier, as well as
1008 layout and current health of the device for each device or file.
1009 Destroyed pools, pools that were previously destroyed with the
1011 command, are not listed unless the
1013 option is specified.
1015 The numeric identifier is unique, and can be used instead of the pool name when
1016 multiple exported pools of the same name are available.
1017 .Bl -tag -width indent
1018 .It Fl c Ar cachefile
1019 Reads configuration from the given
1021 that was created with the
1025 is used instead of searching for devices.
1027 Searches for devices or files in
1031 option can be specified multiple times.
1033 Lists destroyed pools only.
1039 .Op Fl o Ar property Ns = Ns Ar value
1041 .Op Fl d Ar dir | Fl c Ar cachefile
1051 Imports all pools found in the search directories. Identical to the previous
1052 command, except that all pools with a sufficient number of devices available
1053 are imported. Destroyed pools, pools that were previously destroyed with the
1055 command, will not be imported unless the
1057 option is specified.
1058 .Bl -tag -width indent
1060 Comma-separated list of mount options to use when mounting datasets within the
1063 for a description of dataset properties and mount options.
1064 .It Fl o Ar property Ns = Ns Ar value
1065 Sets the specified property on the imported pool. See the
1067 section for more information on the available pool properties.
1068 .It Fl c Ar cachefile
1069 Reads configuration from the given
1071 that was created with the
1075 is used instead of searching for devices.
1077 Searches for devices or files in
1081 option can be specified multiple times. This option is incompatible with the
1085 Imports destroyed pools only. The
1087 option is also required.
1089 Forces import, even if the pool appears to be potentially active.
1091 Enables import with missing log devices.
1093 Do not mount any filesystems from the imported pool.
1104 Recovery mode for a non-importable pool. Attempt to return the pool to an
1105 importable state by discarding the last few transactions. Not all damaged pools
1106 can be recovered by using this option. If successful, the data from the
1107 discarded transactions is irretrievably lost. This option is ignored if the
1108 pool is importable or already imported.
1112 recovery option. Determines whether a non-importable pool can be made
1113 importable again, but does not actually perform the pool recovery. For more
1114 details about pool recovery mode, see the
1118 Searches for and imports all pools found.
1124 .Op Fl o Ar property Ns = Ns Ar value
1126 .Op Fl d Ar dir | Fl c Ar cachefile
1137 Imports a specific pool. A pool can be identified by its name or the numeric
1140 is specified, the pool is imported using the name
1142 Otherwise, it is imported with the same name as its exported name.
1144 If a device is removed from a system without running
1146 first, the device appears as potentially active. It cannot be determined if
1147 this was a failed export, or whether the device is really in use from another
1148 host. To import a pool in this state, the
1151 .Bl -tag -width indent
1153 Comma-separated list of mount options to use when mounting datasets within the
1156 for a description of dataset properties and mount options.
1157 .It Fl o Ar property Ns = Ns Ar value
1158 Sets the specified property on the imported pool. See the
1160 section for more information on the available pool properties.
1161 .It Fl c Ar cachefile
1162 Reads configuration from the given
1164 that was created with the
1168 is used instead of searching for devices.
1170 Searches for devices or files in
1174 option can be specified multiple times. This option is incompatible with the
1178 Imports destroyed pools only. The
1180 option is also required.
1182 Forces import, even if the pool appears to be potentially active.
1184 Enables import with missing log devices.
1186 Do not mount any filesystems from the imported pool.
1189 .Qq Fl o Cm cachefile=none,altroot= Ns Pa root
1191 Recovery mode for a non-importable pool. Attempt to return the pool to an
1192 importable state by discarding the last few transactions. Not all damaged pools
1193 can be recovered by using this option. If successful, the data from the
1194 discarded transactions is irretrievably lost. This option is ignored if the
1195 pool is importable or already imported.
1199 recovery option. Determines whether a non-importable pool can be made
1200 importable again, but does not actually perform the pool recovery. For more
1201 details about pool recovery mode, see the
1208 .Op Fl T Cm d Ns | Ns Cm u
1212 .Op Ar interval Op Ar count
1217 statistics for the given pools. When given an interval, the statistics are
1224 are specified, statistics for every pool in the system is shown. If
1226 is specified, the command exits after
1228 reports are printed.
1229 .Bl -tag -width indent
1230 .It Fl T Cm d Ns | Ns Cm u
1235 for standard date format. See
1240 .Pq equals Qq Ic date +%s Ns .
1242 Verbose statistics. Reports usage statistics for individual
1244 within the pool, in addition to the pool-wide statistics.
1255 label information from the specified
1259 must not be part of an active pool configuration.
1260 .Bl -tag -width indent
1262 Treat exported or foreign devices as inactive.
1268 .Op Fl o Ar property Ns Op , Ns Ar ...
1269 .Op Fl T Cm d Ns | Ns Cm u
1272 .Op Ar inverval Op Ar count
1275 Lists the given pools along with a health status and space usage. When given no
1276 arguments, all pools in the system are listed.
1278 When given an interval, the output is printed every
1284 is specified, the command exits after
1286 reports are printed.
1287 .Bl -tag -width indent
1289 Scripted mode. Do not display headers, and separate fields by a single tab
1290 instead of arbitrary space.
1291 .It Fl o Ar property Ns Op , Ns Ar ...
1292 Comma-separated list of properties to display. See the
1294 section for a list of valid properties. The default list is
1302 .It Fl T Cm d Ns | Ns Cm u
1307 for standard date format. See
1312 .Pq equals Qq Ic date +%s Ns .
1321 Takes the specified physical device offline. While the
1323 is offline, no attempt is made to read or write to the device.
1324 .Bl -tag -width indent
1326 Temporary. Upon reboot, the specified physical device reverts to its previous
1336 Brings the specified physical device online.
1338 This command is not applicable to spares or cache devices.
1339 .Bl -tag -width indent
1341 Expand the device to use all available space. If the device is part of a mirror
1344 then all devices must be expanded before the new space will become
1345 available to the pool.
1353 Removes the specified device from the pool. This command currently only
1354 supports removing hot spares, cache, and log devices. A mirrored log device can
1355 be removed by specifying the top-level mirror for the log. Non-log devices that
1356 are part of a mirrored configuration can be removed using the
1358 command. Non-redundant and
1360 devices cannot be removed from a pool.
1373 This is equivalent to attaching
1375 waiting for it to resilver, and then detaching
1380 must be greater than or equal to the minimum size
1381 of all the devices in a mirror or
1386 is required if the pool is not redundant. If
1388 is not specified, it defaults to
1390 This form of replacement is useful after an existing disk has failed and has
1391 been physically replaced. In this case, the new disk may have the same
1393 path as the old device, even though it is actually a different disk.
1396 .Bl -tag -width indent
1400 even if its appears to be in use. Not all devices can be overridden in this
1410 Begins a scrub. The scrub examines all data in the specified pools to verify
1411 that it checksums correctly. For replicated (mirror or
1415 automatically repairs any damage discovered during the scrub. The
1417 command reports the progress of the scrub and summarizes the results of the
1418 scrub upon completion.
1420 Scrubbing and resilvering are very similar operations. The difference is that
1421 resilvering only examines data that
1423 knows to be out of date (for example, when attaching a new device to a mirror
1424 or replacing an existing device), whereas scrubbing examines all data to
1425 discover silent errors due to hardware faults or disk failure.
1427 Because scrubbing and resilvering are
1428 .Tn I/O Ns -intensive
1431 only allows one at a time. If a scrub is already in progress, the
1433 command returns an error. To start a new scrub, you have to stop the old scrub
1435 .Qq Nm Cm scrub Fl s
1436 command first. If a resilver is in progress,
1438 does not allow a scrub to be started until the resilver completes.
1439 .Bl -tag -width indent
1446 .Ar property Ns = Ns Ar value pool
1449 Sets the given property on the specified pool. See the
1451 section for more information on what properties can be set and acceptable
1459 .Op Fl o Ar property Ns = Ns Ar value
1464 Splits off one disk from each mirrored top-level
1466 in a pool and creates a new pool from the split-off disks. The original pool
1467 must be made up of one or more mirrors and must not be in the process of
1470 subcommand chooses the last device in each mirror
1472 unless overridden by a device specification on the command line.
1478 includes the specified device(s) in a new pool and, should any devices remain
1479 unspecified, assigns the last device in each mirror
1481 to that pool, as it does normally. If you are uncertain about the outcome of a
1485 ("dry-run") option to ensure your command will have the effect you intend.
1486 .Bl -tag -width indent
1488 Automatically import the newly created pool after splitting, using the
1491 parameter for the new pool's alternate root. See the
1497 Displays the configuration that would be created without actually splitting the
1498 pool. The actual pool split could still fail due to insufficient privileges or
1501 Comma-separated list of mount options to use when mounting datasets within the
1504 for a description of dataset properties and mount options. Valid only in
1505 conjunction with the
1508 .It Fl o Ar property Ns = Ns Ar value
1509 Sets the specified property on the new pool. See the
1511 section, above, for more information on the available pool properties.
1517 .Op Fl T Cm d Ns | Ns Cm u
1520 .Op Ar interval Op Ar count
1523 Displays the detailed health status for the given pools. If no
1525 is specified, then the status of each pool in the system is displayed. For more
1526 information on pool and device health, see the
1527 .Qq Sx Device Failure and Recovery
1530 When given an interval, the output is printed every
1536 is specified, the command exits after
1538 reports are printed.
1540 If a scrub or resilver is in progress, this command reports the percentage done
1541 and the estimated time to completion. Both of these are only approximate,
1542 because the amount of data in the pool and the other workloads on the system
1544 .Bl -tag -width indent
1546 Only display status for pools that are exhibiting errors or are otherwise
1549 Displays verbose data error information, printing out a complete list of all
1550 data errors since the last complete pool scrub.
1551 .It Fl T Cm d Ns | Ns Cm u
1556 for standard date format. See
1561 .Pq equals Qq Ic date +%s Ns .
1569 Displays all pools formatted using a different
1571 pool on-disk version. Older versions can continue to be used, but some
1572 features may not be available. These pools can be upgraded using
1573 .Qq Nm Cm upgrade Fl a .
1574 Pools that are formatted with a more recent version are also displayed,
1575 although these pools will be inaccessible on the system.
1576 .Bl -tag -width indent
1580 pool versions supported by the current software. The current
1582 pool version and all previous supported versions are displayed, along
1583 with an explanation of the features provided with each version.
1592 Upgrades the given pool to the latest on-disk pool version. Once this is done,
1593 the pool will no longer be accessible on systems running older versions of the
1595 .Bl -tag -width indent
1599 Upgrade to the specified version. If the
1601 flag is not specified, the pool is upgraded to the most recent version. This
1602 option can only be used to increase the version number, and only up to the most
1603 recent version supported by this software.
1608 .It Sy Example 1 No Creating a RAID-Z Storage Pool
1610 The following command creates a pool with a single
1614 that consists of six disks.
1615 .Bd -literal -offset 2n
1616 .Li # Ic zpool create tank raidz da0 da1 da2 da3 da4 da5
1618 .It Sy Example 2 No Creating a Mirrored Storage Pool
1620 The following command creates a pool with two mirrors, where each mirror
1622 .Bd -literal -offset 2n
1623 .Li # Ic zpool create tank mirror da0 da1 mirror da2 da3
1625 .It Sy Example 3 No Creating a Tn ZFS No Storage Pool by Using Partitions
1627 The following command creates an unmirrored pool using two GPT partitions.
1628 .Bd -literal -offset 2n
1629 .Li # Ic zpool create tank da0p3 da1p3
1631 .It Sy Example 4 No Creating a Tn ZFS No Storage Pool by Using Files
1633 The following command creates an unmirrored pool using files. While not
1634 recommended, a pool based on files can be useful for experimental purposes.
1635 .Bd -literal -offset 2n
1636 .Li # Ic zpool create tank /path/to/file/a /path/to/file/b
1638 .It Sy Example 5 No Adding a Mirror to a Tn ZFS No Storage Pool
1640 The following command adds two mirrored disks to the pool
1642 assuming the pool is already made up of two-way mirrors. The additional space
1643 is immediately available to any datasets within the pool.
1644 .Bd -literal -offset 2n
1645 .Li # Ic zpool add tank mirror da2 da3
1647 .It Sy Example 6 No Listing Available Tn ZFS No Storage Pools
1649 The following command lists all available pools on the system.
1650 .Bd -literal -offset 2n
1652 NAME SIZE ALLOC FREE CAP DEDUP HEALTH ALTROOT
1653 pool 2.70T 473G 2.24T 17% 1.00x ONLINE -
1654 test 1.98G 89.5K 1.98G 0% 1.00x ONLINE -
1656 .It Sy Example 7 No Listing All Properties for a Pool
1658 The following command lists all the properties for a pool.
1659 .Bd -literal -offset 2n
1660 .Li # Ic zpool get all pool
1663 pool altroot - default
1664 pool health ONLINE -
1665 pool guid 2501120270416322443 default
1666 pool version 28 default
1667 pool bootfs pool/root local
1668 pool delegation on default
1669 pool autoreplace off default
1670 pool cachefile - default
1671 pool failmode wait default
1672 pool listsnapshots off default
1673 pool autoexpand off default
1674 pool dedupditto 0 default
1675 pool dedupratio 1.00x -
1677 pool allocated 473G -
1680 .It Sy Example 8 No Destroying a Tn ZFS No Storage Pool
1682 The following command destroys the pool
1684 and any datasets contained within.
1685 .Bd -literal -offset 2n
1686 .Li # Ic zpool destroy -f tank
1688 .It Sy Example 9 No Exporting a Tn ZFS No Storage Pool
1690 The following command exports the devices in pool
1692 so that they can be relocated or later imported.
1693 .Bd -literal -offset 2n
1694 .Li # Ic zpool export tank
1696 .It Sy Example 10 No Importing a Tn ZFS No Storage Pool
1698 The following command displays available pools, and then imports the pool
1700 for use on the system.
1702 The results from this command are similar to the following:
1703 .Bd -literal -offset 2n
1704 .Li # Ic zpool import
1707 id: 15451357997522795478
1709 action: The pool can be imported using its name or numeric identifier.
1721 Storage Pools to the Current Version
1724 The following command upgrades all
1726 Storage pools to the current version of
1728 .Bd -literal -offset 2n
1729 .Li # Ic zpool upgrade -a
1730 This system is currently running ZFS pool version 28.
1732 .It Sy Example 12 No Managing Hot Spares
1734 The following command creates a new pool with an available hot spare:
1735 .Bd -literal -offset 2n
1736 .Li # Ic zpool create tank mirror da0 da1 spare da2
1739 If one of the disks were to fail, the pool would be reduced to the degraded
1740 state. The failed device can be replaced using the following command:
1741 .Bd -literal -offset 2n
1742 .Li # Ic zpool replace tank da0 da2
1745 Once the data has been resilvered, the spare is automatically removed and is
1746 made available should another device fails. The hot spare can be permanently
1747 removed from the pool using the following command:
1748 .Bd -literal -offset 2n
1749 .Li # Ic zpool remove tank da2
1755 Pool with Mirrored Separate Intent Logs
1758 The following command creates a
1760 storage pool consisting of two, two-way
1761 mirrors and mirrored log devices:
1762 .Bd -literal -offset 2n
1763 .Li # Ic zpool create pool mirror da0 da1 mirror da2 da3 log miror da4 da5
1765 .It Sy Example 14 No Adding Cache Devices to a Tn ZFS No Pool
1767 The following command adds two disks for use as cache devices to a
1770 .Bd -literal -offset 2n
1771 .Li # Ic zpool add pool cache da2 da3
1774 Once added, the cache devices gradually fill with content from main memory.
1775 Depending on the size of your cache devices, it could take over an hour for
1776 them to fill. Capacity and reads can be monitored using the
1778 subcommand as follows:
1779 .Bd -literal -offset 2n
1780 .Li # Ic zpool iostat -v pool 5
1782 .It Sy Example 15 No Removing a Mirrored Log Device
1784 The following command removes the mirrored log device
1787 Given this configuration:
1788 .Bd -literal -offset 2n
1791 scrub: none requested
1794 NAME STATE READ WRITE CKSUM
1796 mirror-0 ONLINE 0 0 0
1799 mirror-1 ONLINE 0 0 0
1803 mirror-2 ONLINE 0 0 0
1808 The command to remove the mirrored log
1811 .Bd -literal -offset 2n
1812 .Li # Ic zpool remove tank mirror-2
1814 .It Sy Example 16 No Recovering a Faulted Tn ZFS No Pool
1816 If a pool is faulted but recoverable, a message indicating this state is
1819 if the pool was cached (see the
1821 argument above), or as part of the error output from a failed
1825 Recover a cached pool with the
1828 .Bd -literal -offset 2n
1829 .Li # Ic zpool clear -F data
1830 Pool data returned to its state as of Tue Sep 08 13:23:35 2009.
1831 Discarded approximately 29 seconds of transactions.
1834 If the pool configuration was not cached, use
1836 with the recovery mode flag:
1837 .Bd -literal -offset 2n
1838 .Li # Ic zpool import -F data
1839 Pool data returned to its state as of Tue Sep 08 13:23:35 2009.
1840 Discarded approximately 29 seconds of transactions.
1844 The following exit values are returned:
1845 .Bl -tag -offset 2n -width 2n
1847 Successful completion.
1851 Invalid command line options were specified.
1856 This manual page is a
1858 reimplementation of the
1862 modified and customized for
1864 and licensed under the Common Development and Distribution License
1869 implementation of this manual page was initially written by
1870 .An Martin Matuska Aq mm@FreeBSD.org .
projects / FreeBSD / stable / 9.git / blob