4 .\" The contents of this file are subject to the terms of the
5 .\" Common Development and Distribution License (the "License").
6 .\" You may not use this file except in compliance with the License.
8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 .\" or http://www.opensolaris.org/os/licensing.
10 .\" See the License for the specific language governing permissions
11 .\" and limitations under the License.
13 .\" When distributing Covered Code, include this CDDL HEADER in each
14 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 .\" If applicable, add the following below this CDDL HEADER, with the
16 .\" fields enclosed by brackets "[]" replaced with your own identifying
17 .\" information: Portions Copyright [yyyy] [name of copyright owner]
20 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
21 .TH zpool 1M "13 Nov 2007" "SunOS 5.11" "System Administration Commands"
23 zpool \- configures ZFS storage pools
27 \fBzpool\fR [\fB-?\fR]
32 \fBzpool create\fR [\fB-fn\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-m\fR \fImountpoint\fR] [\fB-R\fR \fIroot\fR]
33 \fIpool\fR \fIvdev\fR ...
38 \fBzpool destroy\fR [\fB-f\fR] \fIpool\fR
43 \fBzpool add\fR [\fB-fn\fR] \fIpool\fR \fIvdev\fR ...
48 \fBzpool remove\fR \fIpool\fR \fIdevice\fR ...
53 \fBzpool list\fR [\fB-H\fR] [\fB-o\fR \fIproperty\fR[,...]] [\fIpool\fR] ...
58 \fBzpool iostat\fR [\fB-v\fR] [\fIpool\fR] ... [\fIinterval\fR[\fIcount\fR]]
63 \fBzpool status\fR [\fB-xv\fR] [\fIpool\fR] ...
68 \fBzpool online\fR \fIpool\fR \fIdevice\fR ...
73 \fBzpool offline\fR [\fB-t\fR] \fIpool\fR \fIdevice\fR ...
78 \fBzpool clear\fR \fIpool\fR [\fIdevice\fR]
83 \fBzpool attach\fR [\fB-f\fR] \fIpool\fR \fIdevice\fR \fInew_device\fR
88 \fBzpool detach\fR \fIpool\fR \fIdevice\fR
93 \fBzpool replace\fR [\fB-f\fR] \fIpool\fR \fIdevice\fR [\fInew_device\fR]
98 \fBzpool scrub\fR [\fB-s\fR] \fIpool\fR ...
103 \fBzpool import\fR [\fB-d\fR \fIdir\fR] [\fB-D\fR]
108 \fBzpool import\fR [\fB-o \fImntopts\fR\fR] [\fB-p\fR \fIproperty=value\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR]
109 [\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] \fB-a\fR
114 \fBzpool import\fR [\fB-o \fImntopts\fR\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR]
115 [\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] \fIpool\fR |\fIid\fR [\fInewpool\fR]
120 \fBzpool export\fR [\fB-f\fR] \fIpool\fR ...
130 \fBzpool upgrade\fR \fB-v\fR
135 \fBzpool upgrade\fR [\fB-V\fR \fIversion\fR] \fB-a\fR | \fIpool\fR ...
140 \fBzpool history\fR [\fB-il\fR] [\fIpool\fR] ...
145 \fBzpool get\fR "\fIall\fR" | \fIproperty\fR[,...] \fIpool\fR ...
150 \fBzpool set\fR \fIproperty\fR=\fIvalue\fR \fIpool\fR
156 The \fBzpool\fR command configures \fBZFS\fR storage pools. A storage pool is a collection of devices that provides physical storage and data replication for \fBZFS\fR datasets.
159 All datasets within a storage pool share the same space. See \fBzfs\fR(1M) for information on managing datasets.
160 .SS "Virtual Devices (vdevs)"
163 A "virtual device" describes a single device or a collection of devices organized according to certain performance and fault characteristics. The following virtual devices are supported:
172 A block device, typically located under "/dev/dsk". \fBZFS\fR can use individual slices or partitions, though the recommended mode of operation is to use whole disks. A disk can be specified by a full path, or it can be a shorthand name (the relative portion
173 of the path under "/dev/dsk"). A whole disk can be specified by omitting the slice or partition designation. For example, "c0t0d0" is equivalent to "/dev/dsk/c0t0d0s2". When given a whole disk, \fBZFS\fR automatically labels the disk, if necessary.
184 A regular file. The use of files as a backing store is strongly discouraged. It is designed primarily for experimental purposes, as the fault tolerance of a file is only as good as the file system of which it is a part. A file must be specified by a full path.
195 A mirror of two or more devices. Data is replicated in an identical fashion across all components of a mirror. A mirror with \fIN\fR disks of size \fIX\fR can hold \fIX\fR bytes and can withstand (\fIN-1\fR)
196 devices failing before data integrity is compromised.
215 A variation on \fBRAID-5\fR that allows for better distribution of parity and eliminates the "\fBRAID-5\fR write hole" (in which data and parity become inconsistent after a power loss). Data and parity is striped across all disks within a \fBraidz\fR group.
217 A \fBraidz\fR group can have either single- or double-parity, meaning that the \fBraidz\fR group can sustain one or two failures respectively without losing any data. The \fBraidz1\fR \fBvdev\fR type specifies a single-parity \fBraidz\fR group
218 and the \fBraidz2\fR \fBvdev\fR type specifies a double-parity \fBraidz\fR group. The \fBraidz\fR \fBvdev\fR type is an alias for \fBraidz1\fR.
220 A \fBraidz\fR group with \fIN\fR disks of size \fIX\fR with \fIP\fR parity disks can hold approximately (\fIN-P\fR)*\fIX\fR bytes and can withstand \fIP\fR device(s)
221 failing before data integrity is compromised. The minimum number of devices in a \fBraidz\fR group is one more than the number of parity disks. The recommended number is between 3 and 9 to help increase performance.
232 A special pseudo-\fBvdev\fR which keeps track of available hot spares for a pool. For more information, see the "Hot Spares" section.
243 A separate intent log device. If more than one log device is specified, then writes are load-balanced between devices. Log devices can be mirrored. However, \fBraidz\fR and \fBraidz2\fR are not supported for the intent log. For more information, see the "Intent
255 A device used to cache storage pool data. A cache device cannot be mirrored or part of a \fBraidz\fR or \fBraidz2\fR configuration. For more information, see the "Cache Devices" section.
260 Virtual devices cannot be nested, so a mirror or \fBraidz\fR virtual device can only contain files or disks. Mirrors of mirrors (or other combinations) are not allowed.
263 A pool can have any number of virtual devices at the top of the configuration (known as "root vdevs"). Data is dynamically distributed across all top-level devices to balance data among devices. As new virtual devices are added, \fBZFS\fR automatically places data
264 on the newly available devices.
267 Virtual devices are specified one at a time on the command line, separated by whitespace. The keywords "mirror" and "raidz" are used to distinguish where a group ends and another begins. For example, the following creates two root vdevs, each a mirror of two disks:
271 \fB# zpool create mypool mirror c0t0d0 c0t1d0 mirror c1t0d0 c1t1d0\fR
276 .SS "Device Failure and Recovery"
279 \fBZFS\fR supports a rich set of mechanisms for handling device failure and data corruption. All metadata and data is checksummed, and \fBZFS\fR automatically repairs bad data from a good copy when corruption is detected.
282 In order to take advantage of these features, a pool must make use of some form of redundancy, using either mirrored or \fBraidz\fR groups. While \fBZFS\fR supports running in a non-redundant configuration, where each root vdev is simply a disk or file, this is
283 strongly discouraged. A single case of bit corruption can render some or all of your data unavailable.
286 A pool's health status is described by one of three states: online, degraded, or faulted. An online pool has all devices operating normally. A degraded pool is one in which one or more devices have failed, but the data is still available due to a redundant configuration. A faulted pool has
287 corrupted metadata, or one or more faulted devices, and insufficient replicas to continue functioning.
290 The health of the top-level vdev, such as mirror or \fBraidz\fR device, is potentially impacted by the state of its associated vdevs, or component devices. A top-level vdev or component device is in one of the following states:
299 One or more top-level vdevs is in the degraded state because one or more component devices are offline. Sufficient replicas exist to continue functioning.
301 One or more component devices is in the degraded or faulted state, but sufficient replicas exist to continue functioning. The underlying conditions are as follows:
306 The number of checksum errors exceeds acceptable levels and the device is degraded as an indication that something may be wrong. \fBZFS\fR continues to use the device as necessary.
312 The number of I/O errors exceeds acceptable levels. The device could not be marked as faulted because there are insufficient replicas to continue functioning.
324 One or more top-level vdevs is in the faulted state because one or more component devices are offline. Insufficient replicas exist to continue functioning.
326 One or more component devices is in the faulted state, and insufficient replicas exist to continue functioning. The underlying conditions are as follows:
331 The device could be opened, but the contents did not match expected values.
337 The number of I/O errors exceeds acceptable levels and the device is faulted to prevent further use of the device.
349 The device was explicitly taken offline by the "\fBzpool offline\fR" command.
360 The device is online and functioning.
371 The device was physically removed while the system was running. Device removal detection is hardware-dependent and may not be supported on all platforms.
382 The device could not be opened. If a pool is imported when a device was unavailable, then the device will be identified by a unique identifier instead of its path since the path was never correct in the first place.
387 If a device is removed and later re-attached to the system, \fBZFS\fR attempts to put the device online automatically. Device attach detection is hardware-dependent and might not be supported on all platforms.
391 \fBZFS\fR allows devices to be associated with pools as "hot spares". These devices are not actively used in the pool, but when an active device fails, it is automatically replaced by a hot spare. To create a pool with hot spares, specify a "spare" \fBvdev\fR with any number of devices. For example,
395 # zpool create pool mirror c0d0 c1d0 spare c2d0 c3d0
402 Spares can be shared across multiple pools, and can be added with the "\fBzpool add\fR" command and removed with the "\fBzpool remove\fR" command. Once a spare replacement is initiated, a new "spare" \fBvdev\fR is
403 created within the configuration that will remain there until the original device is replaced. At this point, the hot spare becomes available again if another device fails.
406 An in-progress spare replacement can be cancelled by detaching the hot spare. If the original faulted device is detached, then the hot spare assumes its place in the configuration, and is removed from the spare list of all active pools.
409 Spares cannot replace log devices.
413 The \fBZFS\fR Intent Log (\fBZIL\fR) satisfies \fBPOSIX\fR requirements for synchronous transactions. For instance, databases often require their transactions to be on stable storage devices when returning from a system call. \fBNFS\fR and
414 other applications can also use \fBfsync\fR() to ensure data stability. By default, the intent log is allocated from blocks within the main pool. However, it might be possible to get better performance using separate intent log devices such as \fBNVRAM\fR or a dedicated
419 \fB# zpool create pool c0d0 c1d0 log c2d0\fR
426 Multiple log devices can also be specified, and they can be mirrored. See the EXAMPLES section for an example of mirroring multiple log devices.
429 Log devices can be added, replaced, attached, detached, and imported and exported as part of the larger pool.
433 Devices can be added to a storage pool as "cache devices." These devices provide an additional layer of caching between main memory and disk. For read-heavy workloads, where the working set size is much larger than what can be cached in main memory, using cache devices allow
434 much more of this working set to be served from low latency media. Using cache devices provides the greatest performance improvement for random read-workloads of mostly static content.
437 To create a pool with cache devices, specify a "cache" \fBvdev\fR with any number of devices. For example:
441 \fB# zpool create pool c0d0 c1d0 cache c2d0 c3d0\fR
448 Cache devices cannot be mirrored or part of a \fBraidz\fR configuration. If a read error is encountered on a cache device, that read \fBI/O\fR is reissued to the original storage pool device, which might be part of a mirrored or \fBraidz\fR configuration.
451 The content of the cache devices is considered volatile, as is the case with other system caches.
455 Each pool has several properties associated with it. Some properties are read-only statistics while others are configurable and change the behavior of the pool. The following are read-only properties:
464 Amount of storage available within the pool. This property can also be referred to by its shortened column name, "avail".
475 Percentage of pool space used. This property can also be referred to by its shortened column name, "cap".
486 The current health of the pool. Health can be "\fBONLINE\fR", "\fBDEGRADED\fR", "\fBFAULTED\fR", " \fBOFFLINE\fR", "\fBREMOVED\fR", or "\fBUNAVAIL\fR".
497 A unique identifier for the pool.
508 Total size of the storage pool.
519 Amount of storage space used within the pool.
524 These space usage properties report actual physical space available to the storage pool. The physical space can be different from the total amount of space that any contained datasets can actually use. The amount of space used in a \fBraidz\fR configuration depends on the characteristics
525 of the data being written. In addition, \fBZFS\fR reserves some space for internal accounting that the \fBzfs\fR(1M) command takes into account, but the \fBzpool\fR command does not. For non-full pools of a reasonable size, these effects should be invisible. For small pools, or pools that are close to being completely full, these discrepancies may become more noticeable.
528 The following property can be set at creation time and import time:
537 Alternate root directory. If set, this directory is prepended to any mount points within the pool. This can be used when examining an unknown pool where the mount points cannot be trusted, or in an alternate boot environment, where the typical paths are not valid. \fBaltroot\fR is
538 not a persistent property. It is valid only while the system is up. Setting \fBaltroot\fR defaults to using \fBcachefile\fR=none, though this may be overridden using an explicit setting.
543 The following properties can be set at creation time and import time, and later changed with the "\fBzpool set\fR" command:
548 \fB\fBautoreplace\fR=on | off\fR
552 Controls automatic device replacement. If set to "\fBoff\fR", device replacement must be initiated by the administrator by using the "\fBzpool replace\fR" command. If set to "\fBon\fR", any new device, found
553 in the same physical location as a device that previously belonged to the pool, is automatically formatted and replaced. The default behavior is "\fBoff\fR". This property can also be referred to by its shortened column name, "replace".
560 \fB\fBbootfs\fR=\fIpool\fR/\fIdataset\fR\fR
564 Identifies the default bootable dataset for the root pool. This property is expected to be set mainly by the installation and upgrade programs.
571 \fB\fBcachefile\fR=\fIpath\fR | "none"\fR
575 Controls the location of where the pool configuration is cached. Discovering all pools on system startup requires a cached copy of the configuration data that is stored on the root file system. All pools in this cache are automatically imported when the system boots. Some environments,
576 such as install and clustering, need to cache this information in a different location so that pools are not automatically imported. Setting this property caches the pool configuration in a different location that can later be imported with "\fBzpool import -c\fR". Setting
577 it to the special value "\fBnone\fR" creates a temporary pool that is never cached, and the special value \fB\&''\fR (empty string) uses the default location.
579 Multiple pools can share the same cache file. Because the kernel destroys and recreates this file when pools are added and removed, care should be taken when attempting to access this file. When the last pool using a \fBcachefile\fR is exported or destroyed, the file is removed.
586 \fB\fBdelegation\fR=\fBon\fR | \fBoff\fR\fR
590 Controls whether a non-privileged user is granted access based on the dataset permissions defined on the dataset. See \fBzfs\fR(1M) for more information
591 on \fBZFS\fR delegated administration.
598 \fB\fBfailmode\fR=\fBwait\fR | \fBcontinue\fR | \fBpanic\fR\fR
602 Controls the system behavior in the event of catastrophic pool failure. This condition is typically a result of a loss of connectivity to the underlying storage device(s) or a failure of all devices within the pool. The behavior of such an event is determined as follows:
611 Blocks all \fBI/O\fR access until the device connectivity is recovered and the errors are cleared. This is the default behavior.
622 Returns \fBEIO\fR to any new write \fBI/O\fR requests but allows reads to any of the remaining healthy devices. Any write requests that have yet to be committed to disk would be blocked.
633 Prints out a message to the console and generates a system crash dump.
642 \fB\fBversion\fR=\fIversion\fR\fR
646 The current on-disk version of the pool. This can be increased, but never decreased. The preferred method of updating pools is with the "\fBzpool upgrade\fR" command, though this property can be used when a specific version is needed for backwards compatibility.
647 This property can be any number between 1 and the current version reported by "\fBzpool upgrade -v\fR". The special value "\fBcurrent\fR" is an alias for the latest supported version.
653 All subcommands that modify state are logged persistently to the pool in their original form.
656 The \fBzpool\fR command provides subcommands to create and destroy storage pools, add capacity to storage pools, and provide information about the storage pools. The following subcommands are supported:
661 \fB\fBzpool\fR \fB-?\fR\fR
665 Displays a help message.
672 \fB\fBzpool create\fR [\fB-fn\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-m\fR \fImountpoint\fR] [\fB-R\fR \fIroot\fR] \fIpool\fR \fIvdev\fR ...\fR
676 Creates a new storage pool containing the virtual devices specified on the command line. The pool name must begin with a letter, and can only contain alphanumeric characters as well as underscore ("_"), dash ("-"), and period ("."). The pool
677 names "mirror", "raidz", "spare" and "log" are reserved, as are names beginning with the pattern "c[0-9]". The \fBvdev\fR specification is described in the "Virtual Devices" section.
679 The command verifies that each device specified is accessible and not currently in use by another subsystem. There are some uses, such as being currently mounted, or specified as the dedicated dump device, that prevents a device from ever being used by \fBZFS\fR. Other uses,
680 such as having a preexisting \fBUFS\fR file system, can be overridden with the \fB-f\fR option.
682 The command also checks that the replication strategy for the pool is consistent. An attempt to combine redundant and non-redundant storage in a single pool, or to mix disks and files, results in an error unless \fB-f\fR is specified. The use of differently sized devices within
683 a single \fBraidz\fR or mirror group is also flagged as an error unless \fB-f\fR is specified.
685 Unless the \fB-R\fR option is specified, the default mount point is "/\fIpool\fR". The mount point must not exist or must be empty, or else the root dataset cannot be mounted. This can be overridden with the \fB-m\fR option.
694 Forces use of \fBvdev\fRs, even if they appear in use or specify a conflicting replication level. Not all devices can be overridden in this manner.
705 Displays the configuration that would be used without actually creating the pool. The actual pool creation can still fail due to insufficient privileges or device sharing.
712 \fB\fB-o\fR \fIproperty=value\fR [\fB-o\fR \fIproperty=value\fR] ...\fR
716 Sets the given pool properties. See the "Properties" section for a list of valid properties that can be set.
723 \fB\fB-R\fR \fIroot\fR\fR
727 Equivalent to "-o cachefile=none,altroot=\fIroot\fR"
734 \fB\fB-m\fR \fImountpoint\fR\fR
738 Sets the mount point for the root dataset. The default mount point is "/\fIpool\fR" or "\fBaltroot\fR/\fIpool\fR" if \fBaltroot\fR is specified. The mount point must be an absolute path, "\fBlegacy\fR", or "\fBnone\fR". For more information on dataset mount points, see \fBzfs\fR(1M).
747 \fB\fBzpool destroy\fR [\fB-f\fR] \fIpool\fR\fR
751 Destroys the given pool, freeing up any devices for other use. This command tries to unmount any active datasets before destroying the pool.
760 Forces any active datasets contained within the pool to be unmounted.
769 \fB\fBzpool add\fR [\fB-fn\fR] \fIpool\fR \fIvdev\fR ...\fR
773 Adds the specified virtual devices to the given pool. The \fIvdev\fR specification is described in the "Virtual Devices" section. The behavior of the \fB-f\fR option, and the device checks performed are described in the "zpool create"
783 Forces use of \fBvdev\fRs, even if they appear in use or specify a conflicting replication level. Not all devices can be overridden in this manner.
794 Displays the configuration that would be used without actually adding the \fBvdev\fRs. The actual pool creation can still fail due to insufficient privileges or device sharing.
797 Do not add a disk that is currently configured as a quorum device to a zpool. After a disk is in the pool, that disk can then be configured as a quorum device.
804 \fB\fBzpool remove\fR \fIpool\fR \fIdevice\fR ...\fR
808 Removes the specified device from the pool. This command currently only supports removing hot spares and cache devices. Devices that are part of a mirrored configuration can be removed using the "\fBzpool detach\fR" command. Non-redundant and \fBraidz\fR devices
809 cannot be removed from a pool.
816 \fB\fBzpool list\fR [\fB-H\fR] [\fB-o\fR \fIprops\fR[,...]] [\fIpool\fR] ...\fR
820 Lists the given pools along with a health status and space usage. When given no arguments, all pools in the system are listed.
829 Scripted mode. Do not display headers, and separate fields by a single tab instead of arbitrary space.
836 \fB\fB-o\fR \fIprops\fR\fR
840 Comma-separated list of properties to display. See the "Properties" section for a list of valid properties. The default list is "name, size, used, available, capacity, health, altroot"
849 \fB\fBzpool iostat\fR [\fB-v\fR] [\fIpool\fR] ... [\fIinterval\fR[\fIcount\fR]]\fR
853 Displays \fBI/O\fR statistics for the given pools. When given an interval, the statistics are printed every \fIinterval\fR seconds until \fBCtrl-C\fR is pressed. If no \fIpools\fR are specified, statistics for
854 every pool in the system is shown. If \fIcount\fR is specified, the command exits after \fIcount\fR reports are printed.
863 Verbose statistics. Reports usage statistics for individual \fIvdevs\fR within the pool, in addition to the pool-wide statistics.
872 \fB\fBzpool status\fR [\fB-xv\fR] [\fIpool\fR] ...\fR
876 Displays the detailed health status for the given pools. If no \fIpool\fR is specified, then the status of each pool in the system is displayed. For more information on pool and device health, see the "Device Failure and Recovery" section.
878 If a scrub or resilver is in progress, this command reports the percentage done and the estimated time to completion. Both of these are only approximate, because the amount of data in the pool and the other workloads on the system can change.
887 Only display status for pools that are exhibiting errors or are otherwise unavailable.
898 Displays verbose data error information, printing out a complete list of all data errors since the last complete pool scrub.
907 \fB\fBzpool online\fR \fIpool\fR \fIdevice\fR ...\fR
911 Brings the specified physical device online.
913 This command is not applicable to spares or cache devices.
920 \fB\fBzpool offline\fR [\fB-t\fR] \fIpool\fR \fIdevice\fR ...\fR
924 Takes the specified physical device offline. While the \fIdevice\fR is offline, no attempt is made to read or write to the device.
926 This command is not applicable to spares or cache devices.
935 Temporary. Upon reboot, the specified physical device reverts to its previous state.
944 \fB\fBzpool clear\fR \fIpool\fR [\fIdevice\fR] ...\fR
948 Clears device errors in a pool. If no arguments are specified, all device errors within the pool are cleared. If one or more devices is specified, only those errors associated with the specified device or devices are cleared.
955 \fB\fBzpool attach\fR [\fB-f\fR] \fIpool\fR \fIdevice\fR \fInew_device\fR\fR
959 Attaches \fInew_device\fR to an existing \fBzpool\fR device. The existing device cannot be part of a \fBraidz\fR configuration. If \fIdevice\fR is not currently part of a mirrored configuration, \fIdevice\fR automatically
960 transforms into a two-way mirror of \fIdevice\fR and \fInew_device\fR. If \fIdevice\fR is part of a two-way mirror, attaching \fInew_device\fR creates a three-way mirror, and so on. In either case, \fInew_device\fR begins to resilver immediately.
969 Forces use of \fInew_device\fR, even if its appears to be in use. Not all devices can be overridden in this manner.
978 \fB\fBzpool detach\fR \fIpool\fR \fIdevice\fR\fR
982 Detaches \fIdevice\fR from a mirror. The operation is refused if there are no other valid replicas of the data.
989 \fB\fBzpool replace\fR [\fB-f\fR] \fIpool\fR \fIold_device\fR [\fInew_device\fR]\fR
993 Replaces \fIold_device\fR with \fInew_device\fR. This is equivalent to attaching \fInew_device\fR, waiting for it to resilver, and then detaching \fIold_device\fR.
995 The size of \fInew_device\fR must be greater than or equal to the minimum size of all the devices in a mirror or \fBraidz\fR configuration.
997 \fInew_device\fR is required if the pool is not redundant. If \fInew_device\fR is not specified, it defaults to \fIold_device\fR. This form of replacement is useful after an existing disk has failed and has been physically replaced.
998 In this case, the new disk may have the same \fB/dev/dsk\fR path as the old device, even though it is actually a different disk. \fBZFS\fR recognizes this.
1007 Forces use of \fInew_device\fR, even if its appears to be in use. Not all devices can be overridden in this manner.
1016 \fB\fBzpool scrub\fR [\fB-s\fR] \fIpool\fR ...\fR
1020 Begins a scrub. The scrub examines all data in the specified pools to verify that it checksums correctly. For replicated (mirror or \fBraidz\fR) devices, \fBZFS\fR automatically repairs any damage discovered during the scrub. The "\fBzpool
1021 status\fR" command reports the progress of the scrub and summarizes the results of the scrub upon completion.
1023 Scrubbing and resilvering are very similar operations. The difference is that resilvering only examines data that \fBZFS\fR knows to be out of date (for example, when attaching a new device to a mirror or replacing an existing device), whereas scrubbing examines all data to
1024 discover silent errors due to hardware faults or disk failure.
1026 Because scrubbing and resilvering are \fBI/O\fR-intensive operations, \fBZFS\fR only allows one at a time. If a scrub is already in progress, the "\fBzpool scrub\fR" command terminates it and starts a new scrub. If a resilver is in progress, \fBZFS\fR does not allow a scrub to be started until the resilver completes.
1044 \fB\fBzpool import\fR [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR] [\fB-D\fR]\fR
1048 Lists pools available to import. If the \fB-d\fR option is not specified, this command searches for devices in "/dev/dsk". The \fB-d\fR option can be specified multiple times, and all directories are searched. If the device appears to be part of
1049 an exported pool, this command displays a summary of the pool with the name of the pool, a numeric identifier, as well as the \fIvdev\fR layout and current health of the device for each device or file. Destroyed pools, pools that were previously destroyed with the "\fBzpool destroy\fR" command, are not listed unless the \fB-D\fR option is specified.
1051 The numeric identifier is unique, and can be used instead of the pool name when multiple exported pools of the same name are available.
1056 \fB\fB-c\fR \fIcachefile\fR\fR
1060 Reads configuration from the given \fBcachefile\fR that was created with the "\fBcachefile\fR" pool property. This \fBcachefile\fR is used instead of searching for devices.
1067 \fB\fB-d\fR \fIdir\fR\fR
1071 Searches for devices or files in \fIdir\fR. The \fB-d\fR option can be specified multiple times.
1082 Lists destroyed pools only.
1091 \fB\fBzpool import\fR [\fB-o\fR \fImntopts\fR] [ \fB-o\fR \fIproperty\fR=\fIvalue\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR]
1092 [\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] \fB-a\fR\fR
1096 Imports all pools found in the search directories. Identical to the previous command, except that all pools with a sufficient number of devices available are imported. Destroyed pools, pools that were previously destroyed with the "\fBzpool destroy\fR"
1097 command, will not be imported unless the \fB-D\fR option is specified.
1102 \fB\fB-o\fR \fImntopts\fR\fR
1106 Comma-separated list of mount options to use when mounting datasets within the pool. See \fBzfs\fR(1M) for a description of dataset properties and mount
1114 \fB\fB-o\fR \fIproperty=value\fR\fR
1118 Sets the specified property on the imported pool. See the "Properties" section for more information on the available pool properties.
1125 \fB\fB-c\fR \fIcachefile\fR\fR
1129 Reads configuration from the given \fBcachefile\fR that was created with the "\fBcachefile\fR" pool property. This \fBcachefile\fR is used instead of searching for devices.
1136 \fB\fB-d\fR \fIdir\fR\fR
1140 Searches for devices or files in \fIdir\fR. The \fB-d\fR option can be specified multiple times. This option is incompatible with the \fB-c\fR option.
1151 Imports destroyed pools only. The \fB-f\fR option is also required.
1162 Forces import, even if the pool appears to be potentially active.
1173 Searches for and imports all pools found.
1180 \fB\fB-R\fR \fIroot\fR\fR
1184 Sets the "\fBcachefile\fR" property to "\fBnone\fR" and the "\fIaltroot\fR" property to "\fIroot\fR".
1193 \fB\fBzpool import\fR [\fB-o\fR \fImntopts\fR] [ \fB-o\fR \fIproperty\fR=\fIvalue\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR]
1194 [\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] \fIpool\fR | \fIid\fR [\fInewpool\fR]\fR
1198 Imports a specific pool. A pool can be identified by its name or the numeric identifier. If \fInewpool\fR is specified, the pool is imported using the name \fInewpool\fR. Otherwise, it is imported with the same name as its exported name.
1200 If a device is removed from a system without running "\fBzpool export\fR" first, the device appears as potentially active. It cannot be determined if this was a failed export, or whether the device is really in use from another host. To import a pool in this state,
1201 the \fB-f\fR option is required.
1206 \fB\fB-o\fR \fImntopts\fR\fR
1210 Comma-separated list of mount options to use when mounting datasets within the pool. See \fBzfs\fR(1M) for a description of dataset properties and mount
1218 \fB\fB-o\fR \fIproperty=value\fR\fR
1222 Sets the specified property on the imported pool. See the "Properties" section for more information on the available pool properties.
1229 \fB\fB-c\fR \fIcachefile\fR\fR
1233 Reads configuration from the given \fBcachefile\fR that was created with the "\fBcachefile\fR" pool property. This \fBcachefile\fR is used instead of searching for devices.
1240 \fB\fB-d\fR \fIdir\fR\fR
1244 Searches for devices or files in \fIdir\fR. The \fB-d\fR option can be specified multiple times. This option is incompatible with the \fB-c\fR option.
1255 Imports destroyed pool. The \fB-f\fR option is also required.
1266 Forces import, even if the pool appears to be potentially active.
1273 \fB\fB-R\fR \fIroot\fR\fR
1277 Sets the "\fBcachefile\fR" property to "\fBnone\fR" and the "\fIaltroot\fR" property to "\fIroot\fR".
1286 \fB\fBzpool export\fR [\fB-f\fR] \fIpool\fR ...\fR
1290 Exports the given pools from the system. All devices are marked as exported, but are still considered in use by other subsystems. The devices can be moved between systems (even those of different endianness) and imported as long as a sufficient number of devices are present.
1292 Before exporting the pool, all datasets within the pool are unmounted.
1294 For pools to be portable, you must give the \fBzpool\fR command whole disks, not just slices, so that \fBZFS\fR can label the disks with portable \fBEFI\fR labels. Otherwise, disk drivers on platforms of different endianness will not recognize the disks.
1303 Forcefully unmount all datasets, using the "\fBunmount -f\fR" command.
1312 \fB\fBzpool upgrade\fR\fR
1316 Displays all pools formatted using a different \fBZFS\fR on-disk version. Older versions can continue to be used, but some features may not be available. These pools can be upgraded using "\fBzpool upgrade -a\fR". Pools that are formatted with
1317 a more recent version are also displayed, although these pools will be inaccessible on the system.
1324 \fB\fBzpool upgrade\fR \fB-v\fR\fR
1328 Displays \fBZFS\fR versions supported by the current software. The current \fBZFS\fR versions and all previous supported versions are displayed, along with an explanation of the features provided with each version.
1335 \fB\fBzpool upgrade\fR [\fB-V\fR \fIversion\fR] \fB-a\fR | \fIpool\fR ...\fR
1339 Upgrades the given pool to the latest on-disk version. Once this is done, the pool will no longer be accessible on systems running older versions of the software.
1355 \fB\fB-V\fR \fIversion\fR\fR
1359 Upgrade to the specified version. If the \fB-V\fR flag is not specified, the pool is upgraded to the most recent version. This option can only be used to increase the version number, and only up to the most recent version supported by this software.
1368 \fB\fBzpool history\fR [\fB-il\fR] [\fIpool\fR] ...\fR
1372 Displays the command history of the specified pools or all pools if no pool is specified.
1381 Displays internally logged \fBZFS\fR events in addition to user initiated events.
1392 Displays log records in long format, which in addition to standard format includes, the user name, the hostname, and the zone in which the operation was performed.
1401 \fB\fBzpool get\fR "\fIall\fR" | \fIproperty\fR[,...] \fIpool\fR ...\fR
1405 Retrieves the given list of properties (or all properties if "\fBall\fR" is used) for the specified storage pool(s). These properties are displayed with the following fields:
1409 name Name of storage pool
1410 property Property name
1411 value Property value
1412 source Property source, either 'default' or 'local'.
1417 See the "Properties" section for more information on the available pool properties.
1424 \fB\fBzpool set\fR \fIproperty\fR=\fIvalue\fR \fIpool\fR \fR
1428 Sets the given property on the specified pool. See the "Properties" section for more information on what properties can be set and acceptable values.
1433 \fBExample 1 \fRCreating a RAID-Z Storage Pool
1436 The following command creates a pool with a single \fBraidz\fR root \fIvdev\fR that consists of six disks.
1441 \fB# zpool create tank raidz c0t0d0 c0t1d0 c0t2d0 c0t3d0 c0t4d0 c0t5d0\fR
1447 \fBExample 2 \fRCreating a Mirrored Storage Pool
1450 The following command creates a pool with two mirrors, where each mirror contains two disks.
1455 \fB# zpool create tank mirror c0t0d0 c0t1d0 mirror c0t2d0 c0t3d0\fR
1461 \fBExample 3 \fRCreating a ZFS Storage Pool by Using Slices
1464 The following command creates an unmirrored pool using two disk slices.
1469 \fB# zpool create tank /dev/dsk/c0t0d0s1 c0t1d0s4\fR
1475 \fBExample 4 \fRCreating a ZFS Storage Pool by Using Files
1478 The following command creates an unmirrored pool using files. While not recommended, a pool based on files can be useful for experimental purposes.
1483 \fB# zpool create tank /path/to/file/a /path/to/file/b\fR
1489 \fBExample 5 \fRAdding a Mirror to a ZFS Storage Pool
1492 The following command adds two mirrored disks to the pool "\fItank\fR", assuming the pool is already made up of two-way mirrors. The additional space is immediately available to any datasets within the pool.
1497 \fB# zpool add tank mirror c1t0d0 c1t1d0\fR
1503 \fBExample 6 \fRListing Available ZFS Storage Pools
1506 The following command lists all available pools on the system. In this case, the pool \fIzion\fR is faulted due to a missing device.
1510 The results from this command are similar to the following:
1516 NAME SIZE USED AVAIL CAP HEALTH ALTROOT
1517 pool 67.5G 2.92M 67.5G 0% ONLINE -
1518 tank 67.5G 2.92M 67.5G 0% ONLINE -
1519 zion - - - 0% FAULTED -
1525 \fBExample 7 \fRDestroying a ZFS Storage Pool
1528 The following command destroys the pool "\fItank\fR" and any datasets contained within.
1533 \fB# zpool destroy -f tank\fR
1539 \fBExample 8 \fRExporting a ZFS Storage Pool
1542 The following command exports the devices in pool \fItank\fR so that they can be relocated or later imported.
1547 \fB# zpool export tank\fR
1553 \fBExample 9 \fRImporting a ZFS Storage Pool
1556 The following command displays available pools, and then imports the pool "tank" for use on the system.
1560 The results from this command are similar to the following:
1565 \fB# zpool import\fR
1567 id: 15451357997522795478
1569 action: The pool can be imported using its name or numeric identifier.
1577 \fB# zpool import tank\fR
1583 \fBExample 10 \fRUpgrading All ZFS Storage Pools to the Current Version
1586 The following command upgrades all ZFS Storage pools to the current version of the software.
1591 \fB# zpool upgrade -a\fR
1592 This system is currently running ZFS version 2.
1598 \fBExample 11 \fRManaging Hot Spares
1601 The following command creates a new pool with an available hot spare:
1606 \fB# zpool create tank mirror c0t0d0 c0t1d0 spare c0t2d0\fR
1613 If one of the disks were to fail, the pool would be reduced to the degraded state. The failed device can be replaced using the following command:
1618 \fB# zpool replace tank c0t0d0 c0t3d0\fR
1625 Once the data has been resilvered, the spare is automatically removed and is made available should another device fails. The hot spare can be permanently removed from the pool using the following command:
1630 \fB# zpool remove tank c0t2d0\fR
1636 \fBExample 12 \fRCreating a ZFS Pool with Mirrored Separate Intent Logs
1639 The following command creates a ZFS storage pool consisting of two, two-way mirrors and mirrored log devices:
1644 \fB# zpool create pool mirror c0d0 c1d0 mirror c2d0 c3d0 log mirror \e
1651 \fBExample 13 \fRAdding Cache Devices to a ZFS Pool
1654 The following command adds two disks for use as cache devices to a ZFS storage pool:
1659 \fB# zpool add pool cache c2d0 c3d0\fR
1666 Once added, the cache devices gradually fill with content from main memory. Depending on the size of your cache devices, it could take over an hour for them to fill. Capacity and reads can be monitored using the \fBiostat\fR option as follows:
1670 \fB# zpool iostat -v pool 5\fR
1678 The following exit values are returned:
1687 Successful completion.
1709 Invalid command line options were specified.
1715 See \fBattributes\fR(5) for descriptions of the following attributes:
1721 cw(2.75i) |cw(2.75i)
1722 lw(2.75i) |lw(2.75i)
1724 ATTRIBUTE TYPE
\aATTRIBUTE VALUE
1726 Availability
\aSUNWzfsu
1728 Interface Stability
\aEvolving
1734 \fBzfs\fR(1M), \fBattributes\fR(5)
projects / FreeBSD / releng / 8.0.git / blob