| blob | 199ee6f727244785e892887d6c693f67f0dacb57 |
1 .\"
2 .\" CDDL HEADER START
3 .\"
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.
7 .\"
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.
12 .\"
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]
18 .\"
19 .\" CDDL HEADER END
20 .\"
21 .\"
22 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
23 .\" Copyright (c) 2013 by Delphix. All rights reserved.
24 .\" Copyright 2017 Nexenta Systems, Inc.
25 .\" Copyright (c) 2017 Datto Inc.
26 .\" Copyright (c) 2017 George Melikov. All Rights Reserved.
27 .\"
28 .Dd August 23, 2017
29 .Dt ZPOOL 8
30 .Os
31 .Sh NAME
32 .Nm zpool
33 .Nd configure ZFS storage pools
34 .Sh SYNOPSIS
35 .Nm
36 .Fl \?
37 .Nm
38 .Cm add
39 .Op Fl fn
40 .Ar pool vdev Ns ...
41 .Nm
42 .Cm attach
43 .Op Fl f
44 .Ar pool device new_device
45 .Nm
46 .Cm clear
47 .Ar pool
48 .Op Ar device
49 .Nm
50 .Cm create
51 .Op Fl dfn
52 .Op Fl B
53 .Op Fl m Ar mountpoint
54 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
55 .Oo Fl O Ar file-system-property Ns = Ns Ar value Oc Ns ...
56 .Op Fl R Ar root
57 .Ar pool vdev Ns ...
58 .Nm
59 .Cm destroy
60 .Op Fl f
61 .Ar pool
62 .Nm
63 .Cm detach
64 .Ar pool device
65 .Nm
66 .Cm export
67 .Op Fl f
68 .Ar pool Ns ...
69 .Nm
70 .Cm get
71 .Op Fl Hp
72 .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
73 .Sy all Ns | Ns Ar property Ns Oo , Ns Ar property Oc Ns ...
74 .Ar pool Ns ...
75 .Nm
76 .Cm history
77 .Op Fl il
78 .Oo Ar pool Oc Ns ...
79 .Nm
80 .Cm import
81 .Op Fl D
82 .Op Fl d Ar dir
83 .Nm
84 .Cm import
85 .Fl a
86 .Op Fl DfmN
87 .Op Fl F Op Fl n
88 .Op Fl c Ar cachefile Ns | Ns Fl d Ar dir
89 .Op Fl o Ar mntopts
90 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
91 .Op Fl R Ar root
92 .Nm
93 .Cm import
94 .Op Fl Dfm
95 .Op Fl F Op Fl n
96 .Op Fl c Ar cachefile Ns | Ns Fl d Ar dir
97 .Op Fl o Ar mntopts
98 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
99 .Op Fl R Ar root
100 .Ar pool Ns | Ns Ar id
101 .Op Ar newpool
102 .Nm
103 .Cm iostat
104 .Op Fl v
105 .Op Fl T Sy u Ns | Ns Sy d
106 .Oo Ar pool Oc Ns ...
107 .Op Ar interval Op Ar count
108 .Nm
109 .Cm labelclear
110 .Op Fl f
111 .Ar device
112 .Nm
113 .Cm list
114 .Op Fl Hpv
115 .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
116 .Op Fl T Sy u Ns | Ns Sy d
117 .Oo Ar pool Oc Ns ...
118 .Op Ar interval Op Ar count
119 .Nm
120 .Cm offline
121 .Op Fl t
122 .Ar pool Ar device Ns ...
123 .Nm
124 .Cm online
125 .Op Fl e
126 .Ar pool Ar device Ns ...
127 .Nm
128 .Cm reguid
129 .Ar pool
130 .Nm
131 .Cm reopen
132 .Ar pool
133 .Nm
134 .Cm remove
135 .Ar pool Ar device Ns ...
136 .Nm
137 .Cm replace
138 .Op Fl f
139 .Ar pool Ar device Op Ar new_device
140 .Nm
141 .Cm scrub
142 .Op Fl s | Fl p
143 .Ar pool Ns ...
144 .Nm
145 .Cm set
146 .Ar property Ns = Ns Ar value
147 .Ar pool
148 .Nm
149 .Cm split
150 .Op Fl n
151 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
152 .Op Fl R Ar root
153 .Ar pool newpool
154 .Nm
155 .Cm status
156 .Op Fl Dvx
157 .Op Fl T Sy u Ns | Ns Sy d
158 .Oo Ar pool Oc Ns ...
159 .Op Ar interval Op Ar count
160 .Nm
161 .Cm upgrade
162 .Nm
163 .Cm upgrade
164 .Fl v
165 .Nm
166 .Cm upgrade
167 .Op Fl V Ar version
168 .Fl a Ns | Ns Ar pool Ns ...
169 .Sh DESCRIPTION
170 The
171 .Nm
172 command configures ZFS storage pools.
173 A storage pool is a collection of devices that provides physical storage and
174 data replication for ZFS datasets.
175 All datasets within a storage pool share the same space.
176 See
177 .Xr zfs 8
178 for information on managing datasets.
179 .Ss Virtual Devices (vdevs)
180 A "virtual device" describes a single device or a collection of devices
181 organized according to certain performance and fault characteristics.
182 The following virtual devices are supported:
183 .Bl -tag -width Ds
184 .It Sy disk
185 A block device, typically located under
186 .Pa /dev/dsk .
187 ZFS can use individual slices or partitions, though the recommended mode of
188 operation is to use whole disks.
189 A disk can be specified by a full path, or it can be a shorthand name
190 .Po the relative portion of the path under
191 .Pa /dev/dsk
192 .Pc .
193 A whole disk can be specified by omitting the slice or partition designation.
194 For example,
195 .Pa c0t0d0
196 is equivalent to
197 .Pa /dev/dsk/c0t0d0s2 .
198 When given a whole disk, ZFS automatically labels the disk, if necessary.
199 .It Sy file
200 A regular file.
201 The use of files as a backing store is strongly discouraged.
202 It is designed primarily for experimental purposes, as the fault tolerance of a
203 file is only as good as the file system of which it is a part.
204 A file must be specified by a full path.
205 .It Sy mirror
206 A mirror of two or more devices.
207 Data is replicated in an identical fashion across all components of a mirror.
208 A mirror with N disks of size X can hold X bytes and can withstand (N-1) devices
209 failing before data integrity is compromised.
210 .It Sy raidz , raidz1 , raidz2 , raidz3
211 A variation on RAID-5 that allows for better distribution of parity and
212 eliminates the RAID-5
213 .Qq write hole
214 .Pq in which data and parity become inconsistent after a power loss .
215 Data and parity is striped across all disks within a raidz group.
216 .Pp
217 A raidz group can have single-, double-, or triple-parity, meaning that the
218 raidz group can sustain one, two, or three failures, respectively, without
219 losing any data.
220 The
221 .Sy raidz1
222 vdev type specifies a single-parity raidz group; the
223 .Sy raidz2
224 vdev type specifies a double-parity raidz group; and the
225 .Sy raidz3
226 vdev type specifies a triple-parity raidz group.
227 The
228 .Sy raidz
229 vdev type is an alias for
230 .Sy raidz1 .
231 .Pp
232 A raidz group with N disks of size X with P parity disks can hold approximately
233 (N-P)*X bytes and can withstand P device(s) failing before data integrity is
234 compromised.
235 The minimum number of devices in a raidz group is one more than the number of
236 parity disks.
237 The recommended number is between 3 and 9 to help increase performance.
238 .It Sy spare
239 A special pseudo-vdev which keeps track of available hot spares for a pool.
240 For more information, see the
241 .Sx Hot Spares
242 section.
243 .It Sy log
244 A separate intent log device.
245 If more than one log device is specified, then writes are load-balanced between
246 devices.
247 Log devices can be mirrored.
248 However, raidz vdev types are not supported for the intent log.
249 For more information, see the
250 .Sx Intent Log
251 section.
252 .It Sy cache
253 A device used to cache storage pool data.
254 A cache device cannot be configured as a mirror or raidz group.
255 For more information, see the
256 .Sx Cache Devices
257 section.
258 .El
259 .Pp
260 Virtual devices cannot be nested, so a mirror or raidz virtual device can only
261 contain files or disks.
262 Mirrors of mirrors
263 .Pq or other combinations
264 are not allowed.
265 .Pp
266 A pool can have any number of virtual devices at the top of the configuration
267 .Po known as
268 .Qq root vdevs
269 .Pc .
270 Data is dynamically distributed across all top-level devices to balance data
271 among devices.
272 As new virtual devices are added, ZFS automatically places data on the newly
273 available devices.
274 .Pp
275 Virtual devices are specified one at a time on the command line, separated by
276 whitespace.
277 The keywords
278 .Sy mirror
279 and
280 .Sy raidz
281 are used to distinguish where a group ends and another begins.
282 For example, the following creates two root vdevs, each a mirror of two disks:
283 .Bd -literal
284 # zpool create mypool mirror c0t0d0 c0t1d0 mirror c1t0d0 c1t1d0
285 .Ed
286 .Ss Device Failure and Recovery
287 ZFS supports a rich set of mechanisms for handling device failure and data
288 corruption.
289 All metadata and data is checksummed, and ZFS automatically repairs bad data
290 from a good copy when corruption is detected.
291 .Pp
292 In order to take advantage of these features, a pool must make use of some form
293 of redundancy, using either mirrored or raidz groups.
294 While ZFS supports running in a non-redundant configuration, where each root
295 vdev is simply a disk or file, this is strongly discouraged.
296 A single case of bit corruption can render some or all of your data unavailable.
297 .Pp
298 A pool's health status is described by one of three states: online, degraded,
299 or faulted.
300 An online pool has all devices operating normally.
301 A degraded pool is one in which one or more devices have failed, but the data is
302 still available due to a redundant configuration.
303 A faulted pool has corrupted metadata, or one or more faulted devices, and
304 insufficient replicas to continue functioning.
305 .Pp
306 The health of the top-level vdev, such as mirror or raidz device, is
307 potentially impacted by the state of its associated vdevs, or component
308 devices.
309 A top-level vdev or component device is in one of the following states:
310 .Bl -tag -width "DEGRADED"
311 .It Sy DEGRADED
312 One or more top-level vdevs is in the degraded state because one or more
313 component devices are offline.
314 Sufficient replicas exist to continue functioning.
315 .Pp
316 One or more component devices is in the degraded or faulted state, but
317 sufficient replicas exist to continue functioning.
318 The underlying conditions are as follows:
319 .Bl -bullet
320 .It
321 The number of checksum errors exceeds acceptable levels and the device is
322 degraded as an indication that something may be wrong.
323 ZFS continues to use the device as necessary.
324 .It
325 The number of I/O errors exceeds acceptable levels.
326 The device could not be marked as faulted because there are insufficient
327 replicas to continue functioning.
328 .El
329 .It Sy FAULTED
330 One or more top-level vdevs is in the faulted state because one or more
331 component devices are offline.
332 Insufficient replicas exist to continue functioning.
333 .Pp
334 One or more component devices is in the faulted state, and insufficient
335 replicas exist to continue functioning.
336 The underlying conditions are as follows:
337 .Bl -bullet
338 .It
339 The device could be opened, but the contents did not match expected values.
340 .It
341 The number of I/O errors exceeds acceptable levels and the device is faulted to
342 prevent further use of the device.
343 .El
344 .It Sy OFFLINE
345 The device was explicitly taken offline by the
346 .Nm zpool Cm offline
347 command.
348 .It Sy ONLINE
349 The device is online and functioning.
350 .It Sy REMOVED
351 The device was physically removed while the system was running.
352 Device removal detection is hardware-dependent and may not be supported on all
353 platforms.
354 .It Sy UNAVAIL
355 The device could not be opened.
356 If a pool is imported when a device was unavailable, then the device will be
357 identified by a unique identifier instead of its path since the path was never
358 correct in the first place.
359 .El
360 .Pp
361 If a device is removed and later re-attached to the system, ZFS attempts
362 to put the device online automatically.
363 Device attach detection is hardware-dependent and might not be supported on all
364 platforms.
365 .Ss Hot Spares
366 ZFS allows devices to be associated with pools as
367 .Qq hot spares .
368 These devices are not actively used in the pool, but when an active device
369 fails, it is automatically replaced by a hot spare.
370 To create a pool with hot spares, specify a
371 .Sy spare
372 vdev with any number of devices.
373 For example,
374 .Bd -literal
375 # zpool create pool mirror c0d0 c1d0 spare c2d0 c3d0
376 .Ed
377 .Pp
378 Spares can be shared across multiple pools, and can be added with the
379 .Nm zpool Cm add
380 command and removed with the
381 .Nm zpool Cm remove
382 command.
383 Once a spare replacement is initiated, a new
384 .Sy spare
385 vdev is created within the configuration that will remain there until the
386 original device is replaced.
387 At this point, the hot spare becomes available again if another device fails.
388 .Pp
389 If a pool has a shared spare that is currently being used, the pool can not be
390 exported since other pools may use this shared spare, which may lead to
391 potential data corruption.
392 .Pp
393 An in-progress spare replacement can be cancelled by detaching the hot spare.
394 If the original faulted device is detached, then the hot spare assumes its
395 place in the configuration, and is removed from the spare list of all active
396 pools.
397 .Pp
398 Spares cannot replace log devices.
399 .Ss Intent Log
400 The ZFS Intent Log (ZIL) satisfies POSIX requirements for synchronous
401 transactions.
402 For instance, databases often require their transactions to be on stable storage
403 devices when returning from a system call.
404 NFS and other applications can also use
405 .Xr fsync 3C
406 to ensure data stability.
407 By default, the intent log is allocated from blocks within the main pool.
408 However, it might be possible to get better performance using separate intent
409 log devices such as NVRAM or a dedicated disk.
410 For example:
411 .Bd -literal
412 # zpool create pool c0d0 c1d0 log c2d0
413 .Ed
414 .Pp
415 Multiple log devices can also be specified, and they can be mirrored.
416 See the
417 .Sx EXAMPLES
418 section for an example of mirroring multiple log devices.
419 .Pp
420 Log devices can be added, replaced, attached, detached, and imported and
421 exported as part of the larger pool.
422 Mirrored log devices can be removed by specifying the top-level mirror for the
423 log.
424 .Ss Cache Devices
425 Devices can be added to a storage pool as
426 .Qq cache devices .
427 These devices provide an additional layer of caching between main memory and
428 disk.
429 For read-heavy workloads, where the working set size is much larger than what
430 can be cached in main memory, using cache devices allow much more of this
431 working set to be served from low latency media.
432 Using cache devices provides the greatest performance improvement for random
433 read-workloads of mostly static content.
434 .Pp
435 To create a pool with cache devices, specify a
436 .Sy cache
437 vdev with any number of devices.
438 For example:
439 .Bd -literal
440 # zpool create pool c0d0 c1d0 cache c2d0 c3d0
441 .Ed
442 .Pp
443 Cache devices cannot be mirrored or part of a raidz configuration.
444 If a read error is encountered on a cache device, that read I/O is reissued to
445 the original storage pool device, which might be part of a mirrored or raidz
446 configuration.
447 .Pp
448 The content of the cache devices is considered volatile, as is the case with
449 other system caches.
450 .Ss Properties
451 Each pool has several properties associated with it.
452 Some properties are read-only statistics while others are configurable and
453 change the behavior of the pool.
454 .Pp
455 The following are read-only properties:
456 .Bl -tag -width Ds
457 .It Sy available
458 Amount of storage available within the pool.
459 This property can also be referred to by its shortened column name,
460 .Sy avail .
461 .It Sy bootsize
462 The size of the system boot partition.
463 This property can only be set at pool creation time and is read-only once pool
464 is created.
465 Setting this property implies using the
466 .Fl B
467 option.
468 .It Sy capacity
469 Percentage of pool space used.
470 This property can also be referred to by its shortened column name,
471 .Sy cap .
472 .It Sy expandsize
473 Amount of uninitialized space within the pool or device that can be used to
474 increase the total capacity of the pool.
475 Uninitialized space consists of any space on an EFI labeled vdev which has not
476 been brought online
477 .Po e.g, using
478 .Nm zpool Cm online Fl e
479 .Pc .
480 This space occurs when a LUN is dynamically expanded.
481 .It Sy fragmentation
482 The amount of fragmentation in the pool.
483 .It Sy free
484 The amount of free space available in the pool.
485 .It Sy freeing
486 After a file system or snapshot is destroyed, the space it was using is
487 returned to the pool asynchronously.
488 .Sy freeing
489 is the amount of space remaining to be reclaimed.
490 Over time
491 .Sy freeing
492 will decrease while
493 .Sy free
494 increases.
495 .It Sy health
496 The current health of the pool.
497 Health can be one of
498 .Sy ONLINE , DEGRADED , FAULTED , OFFLINE, REMOVED , UNAVAIL .
499 .It Sy guid
500 A unique identifier for the pool.
501 .It Sy size
502 Total size of the storage pool.
503 .It Sy unsupported@ Ns Em feature_guid
504 Information about unsupported features that are enabled on the pool.
505 See
506 .Xr zpool-features 5
507 for details.
508 .It Sy used
509 Amount of storage space used within the pool.
510 .El
511 .Pp
512 The space usage properties report actual physical space available to the
513 storage pool.
514 The physical space can be different from the total amount of space that any
515 contained datasets can actually use.
516 The amount of space used in a raidz configuration depends on the characteristics
517 of the data being written.
518 In addition, ZFS reserves some space for internal accounting that the
519 .Xr zfs 8
520 command takes into account, but the
521 .Nm
522 command does not.
523 For non-full pools of a reasonable size, these effects should be invisible.
524 For small pools, or pools that are close to being completely full, these
525 discrepancies may become more noticeable.
526 .Pp
527 The following property can be set at creation time and import time:
528 .Bl -tag -width Ds
529 .It Sy altroot
530 Alternate root directory.
531 If set, this directory is prepended to any mount points within the pool.
532 This can be used when examining an unknown pool where the mount points cannot be
533 trusted, or in an alternate boot environment, where the typical paths are not
534 valid.
535 .Sy altroot
536 is not a persistent property.
537 It is valid only while the system is up.
538 Setting
539 .Sy altroot
540 defaults to using
541 .Sy cachefile Ns = Ns Sy none ,
542 though this may be overridden using an explicit setting.
543 .El
544 .Pp
545 The following property can be set only at import time:
546 .Bl -tag -width Ds
547 .It Sy readonly Ns = Ns Sy on Ns | Ns Sy off
548 If set to
549 .Sy on ,
550 the pool will be imported in read-only mode.
551 This property can also be referred to by its shortened column name,
552 .Sy rdonly .
553 .El
554 .Pp
555 The following properties can be set at creation time and import time, and later
556 changed with the
557 .Nm zpool Cm set
558 command:
559 .Bl -tag -width Ds
560 .It Sy autoexpand Ns = Ns Sy on Ns | Ns Sy off
561 Controls automatic pool expansion when the underlying LUN is grown.
562 If set to
563 .Sy on ,
564 the pool will be resized according to the size of the expanded device.
565 If the device is part of a mirror or raidz then all devices within that
566 mirror/raidz group must be expanded before the new space is made available to
567 the pool.
568 The default behavior is
569 .Sy off .
570 This property can also be referred to by its shortened column name,
571 .Sy expand .
572 .It Sy autoreplace Ns = Ns Sy on Ns | Ns Sy off
573 Controls automatic device replacement.
574 If set to
575 .Sy off ,
576 device replacement must be initiated by the administrator by using the
577 .Nm zpool Cm replace
578 command.
579 If set to
580 .Sy on ,
581 any new device, found in the same physical location as a device that previously
582 belonged to the pool, is automatically formatted and replaced.
583 The default behavior is
584 .Sy off .
585 This property can also be referred to by its shortened column name,
586 .Sy replace .
587 .It Sy bootfs Ns = Ns Ar pool Ns / Ns Ar dataset
588 Identifies the default bootable dataset for the root pool.
589 This property is expected to be set mainly by the installation and upgrade
590 programs.
591 .It Sy cachefile Ns = Ns Ar path Ns | Ns Sy none
592 Controls the location of where the pool configuration is cached.
593 Discovering all pools on system startup requires a cached copy of the
594 configuration data that is stored on the root file system.
595 All pools in this cache are automatically imported when the system boots.
596 Some environments, such as install and clustering, need to cache this
597 information in a different location so that pools are not automatically
598 imported.
599 Setting this property caches the pool configuration in a different location that
600 can later be imported with
601 .Nm zpool Cm import Fl c .
602 Setting it to the special value
603 .Sy none
604 creates a temporary pool that is never cached, and the special value
605 .Qq
606 .Pq empty string
607 uses the default location.
608 .Pp
609 Multiple pools can share the same cache file.
610 Because the kernel destroys and recreates this file when pools are added and
611 removed, care should be taken when attempting to access this file.
612 When the last pool using a
613 .Sy cachefile
614 is exported or destroyed, the file is removed.
615 .It Sy comment Ns = Ns Ar text
616 A text string consisting of printable ASCII characters that will be stored
617 such that it is available even if the pool becomes faulted.
618 An administrator can provide additional information about a pool using this
619 property.
620 .It Sy dedupditto Ns = Ns Ar number
621 Threshold for the number of block ditto copies.
622 If the reference count for a deduplicated block increases above this number, a
623 new ditto copy of this block is automatically stored.
624 The default setting is
625 .Sy 0
626 which causes no ditto copies to be created for deduplicated blocks.
627 The minimum legal nonzero setting is
628 .Sy 100 .
629 .It Sy delegation Ns = Ns Sy on Ns | Ns Sy off
630 Controls whether a non-privileged user is granted access based on the dataset
631 permissions defined on the dataset.
632 See
633 .Xr zfs 8
634 for more information on ZFS delegated administration.
635 .It Sy failmode Ns = Ns Sy wait Ns | Ns Sy continue Ns | Ns Sy panic
636 Controls the system behavior in the event of catastrophic pool failure.
637 This condition is typically a result of a loss of connectivity to the underlying
638 storage device(s) or a failure of all devices within the pool.
639 The behavior of such an event is determined as follows:
640 .Bl -tag -width "continue"
641 .It Sy wait
642 Blocks all I/O access until the device connectivity is recovered and the errors
643 are cleared.
644 This is the default behavior.
645 .It Sy continue
646 Returns
647 .Er EIO
648 to any new write I/O requests but allows reads to any of the remaining healthy
649 devices.
650 Any write requests that have yet to be committed to disk would be blocked.
651 .It Sy panic
652 Prints out a message to the console and generates a system crash dump.
653 .El
654 .It Sy feature@ Ns Ar feature_name Ns = Ns Sy enabled
655 The value of this property is the current state of
656 .Ar feature_name .
657 The only valid value when setting this property is
658 .Sy enabled
659 which moves
660 .Ar feature_name
661 to the enabled state.
662 See
663 .Xr zpool-features 5
664 for details on feature states.
665 .It Sy listsnapshots Ns = Ns Sy on Ns | Ns Sy off
666 Controls whether information about snapshots associated with this pool is
667 output when
668 .Nm zfs Cm list
669 is run without the
670 .Fl t
671 option.
672 The default value is
673 .Sy off .
674 This property can also be referred to by its shortened name,
675 .Sy listsnaps .
676 .It Sy version Ns = Ns Ar version
677 The current on-disk version of the pool.
678 This can be increased, but never decreased.
679 The preferred method of updating pools is with the
680 .Nm zpool Cm upgrade
681 command, though this property can be used when a specific version is needed for
682 backwards compatibility.
683 Once feature flags are enabled on a pool this property will no longer have a
684 value.
685 .El
686 .Ss Subcommands
687 All subcommands that modify state are logged persistently to the pool in their
688 original form.
689 .Pp
690 The
691 .Nm
692 command provides subcommands to create and destroy storage pools, add capacity
693 to storage pools, and provide information about the storage pools.
694 The following subcommands are supported:
695 .Bl -tag -width Ds
696 .It Xo
697 .Nm
698 .Fl \?
699 .Xc
700 Displays a help message.
701 .It Xo
702 .Nm
703 .Cm add
704 .Op Fl fn
705 .Ar pool vdev Ns ...
706 .Xc
707 Adds the specified virtual devices to the given pool.
708 The
709 .Ar vdev
710 specification is described in the
711 .Sx Virtual Devices
712 section.
713 The behavior of the
714 .Fl f
715 option, and the device checks performed are described in the
716 .Nm zpool Cm create
717 subcommand.
718 .Bl -tag -width Ds
719 .It Fl f
720 Forces use of
721 .Ar vdev Ns s ,
722 even if they appear in use or specify a conflicting replication level.
723 Not all devices can be overridden in this manner.
724 .It Fl n
725 Displays the configuration that would be used without actually adding the
726 .Ar vdev Ns s .
727 The actual pool creation can still fail due to insufficient privileges or
728 device sharing.
729 .El
730 .It Xo
731 .Nm
732 .Cm attach
733 .Op Fl f
734 .Ar pool device new_device
735 .Xc
736 Attaches
737 .Ar new_device
738 to the existing
739 .Ar device .
740 The existing device cannot be part of a raidz configuration.
741 If
742 .Ar device
743 is not currently part of a mirrored configuration,
744 .Ar device
745 automatically transforms into a two-way mirror of
746 .Ar device
747 and
748 .Ar new_device .
749 If
750 .Ar device
751 is part of a two-way mirror, attaching
752 .Ar new_device
753 creates a three-way mirror, and so on.
754 In either case,
755 .Ar new_device
756 begins to resilver immediately.
757 .Bl -tag -width Ds
758 .It Fl f
759 Forces use of
760 .Ar new_device ,
761 even if its appears to be in use.
762 Not all devices can be overridden in this manner.
763 .El
764 .It Xo
765 .Nm
766 .Cm clear
767 .Ar pool
768 .Op Ar device
769 .Xc
770 Clears device errors in a pool.
771 If no arguments are specified, all device errors within the pool are cleared.
772 If one or more devices is specified, only those errors associated with the
773 specified device or devices are cleared.
774 .It Xo
775 .Nm
776 .Cm create
777 .Op Fl dfn
778 .Op Fl B
779 .Op Fl m Ar mountpoint
780 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
781 .Oo Fl O Ar file-system-property Ns = Ns Ar value Oc Ns ...
782 .Op Fl R Ar root
783 .Ar pool vdev Ns ...
784 .Xc
785 Creates a new storage pool containing the virtual devices specified on the
786 command line.
787 The pool name must begin with a letter, and can only contain
788 alphanumeric characters as well as underscore
789 .Pq Qq Sy _ ,
790 dash
791 .Pq Qq Sy - ,
792 and period
793 .Pq Qq Sy \&. .
794 The pool names
795 .Sy mirror ,
796 .Sy raidz ,
797 .Sy spare
798 and
799 .Sy log
800 are reserved, as are names beginning with the pattern
801 .Sy c[0-9] .
802 The
803 .Ar vdev
804 specification is described in the
805 .Sx Virtual Devices
806 section.
807 .Pp
808 The command verifies that each device specified is accessible and not currently
809 in use by another subsystem.
810 There are some uses, such as being currently mounted, or specified as the
811 dedicated dump device, that prevents a device from ever being used by ZFS.
812 Other uses, such as having a preexisting UFS file system, can be overridden with
813 the
814 .Fl f
815 option.
816 .Pp
817 The command also checks that the replication strategy for the pool is
818 consistent.
819 An attempt to combine redundant and non-redundant storage in a single pool, or
820 to mix disks and files, results in an error unless
821 .Fl f
822 is specified.
823 The use of differently sized devices within a single raidz or mirror group is
824 also flagged as an error unless
825 .Fl f
826 is specified.
827 .Pp
828 Unless the
829 .Fl R
830 option is specified, the default mount point is
831 .Pa / Ns Ar pool .
832 The mount point must not exist or must be empty, or else the root dataset
833 cannot be mounted.
834 This can be overridden with the
835 .Fl m
836 option.
837 .Pp
838 By default all supported features are enabled on the new pool unless the
839 .Fl d
840 option is specified.
841 .Bl -tag -width Ds
842 .It Fl B
843 Create whole disk pool with EFI System partition to support booting system
844 with UEFI firmware.
845 Default size is 256MB.
846 To create boot partition with custom size, set the
847 .Sy bootsize
848 property with the
849 .Fl o
850 option.
851 See the
852 .Sx Properties
853 section for details.
854 .It Fl d
855 Do not enable any features on the new pool.
856 Individual features can be enabled by setting their corresponding properties to
857 .Sy enabled
858 with the
859 .Fl o
860 option.
861 See
862 .Xr zpool-features 5
863 for details about feature properties.
864 .It Fl f
865 Forces use of
866 .Ar vdev Ns s ,
867 even if they appear in use or specify a conflicting replication level.
868 Not all devices can be overridden in this manner.
869 .It Fl m Ar mountpoint
870 Sets the mount point for the root dataset.
871 The default mount point is
872 .Pa /pool
873 or
874 .Pa altroot/pool
875 if
876 .Ar altroot
877 is specified.
878 The mount point must be an absolute path,
879 .Sy legacy ,
880 or
881 .Sy none .
882 For more information on dataset mount points, see
883 .Xr zfs 8 .
884 .It Fl n
885 Displays the configuration that would be used without actually creating the
886 pool.
887 The actual pool creation can still fail due to insufficient privileges or
888 device sharing.
889 .It Fl o Ar property Ns = Ns Ar value
890 Sets the given pool properties.
891 See the
892 .Sx Properties
893 section for a list of valid properties that can be set.
894 .It Fl O Ar file-system-property Ns = Ns Ar value
895 Sets the given file system properties in the root file system of the pool.
896 See the
897 .Sx Properties
898 section of
899 .Xr zfs 8
900 for a list of valid properties that can be set.
901 .It Fl R Ar root
902 Equivalent to
903 .Fl o Sy cachefile Ns = Ns Sy none Fl o Sy altroot Ns = Ns Ar root
904 .El
905 .It Xo
906 .Nm
907 .Cm destroy
908 .Op Fl f
909 .Ar pool
910 .Xc
911 Destroys the given pool, freeing up any devices for other use.
912 This command tries to unmount any active datasets before destroying the pool.
913 .Bl -tag -width Ds
914 .It Fl f
915 Forces any active datasets contained within the pool to be unmounted.
916 .El
917 .It Xo
918 .Nm
919 .Cm detach
920 .Ar pool device
921 .Xc
922 Detaches
923 .Ar device
924 from a mirror.
925 The operation is refused if there are no other valid replicas of the data.
926 .It Xo
927 .Nm
928 .Cm export
929 .Op Fl f
930 .Ar pool Ns ...
931 .Xc
932 Exports the given pools from the system.
933 All devices are marked as exported, but are still considered in use by other
934 subsystems.
935 The devices can be moved between systems
936 .Pq even those of different endianness
937 and imported as long as a sufficient number of devices are present.
938 .Pp
939 Before exporting the pool, all datasets within the pool are unmounted.
940 A pool can not be exported if it has a shared spare that is currently being
941 used.
942 .Pp
943 For pools to be portable, you must give the
944 .Nm
945 command whole disks, not just slices, so that ZFS can label the disks with
946 portable EFI labels.
947 Otherwise, disk drivers on platforms of different endianness will not recognize
948 the disks.
949 .Bl -tag -width Ds
950 .It Fl f
951 Forcefully unmount all datasets, using the
952 .Nm unmount Fl f
953 command.
954 .Pp
955 This command will forcefully export the pool even if it has a shared spare that
956 is currently being used.
957 This may lead to potential data corruption.
958 .El
959 .It Xo
960 .Nm
961 .Cm get
962 .Op Fl Hp
963 .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
964 .Sy all Ns | Ns Ar property Ns Oo , Ns Ar property Oc Ns ...
965 .Ar pool Ns ...
966 .Xc
967 Retrieves the given list of properties
968 .Po
969 or all properties if
970 .Sy all
971 is used
972 .Pc
973 for the specified storage pool(s).
974 These properties are displayed with the following fields:
975 .Bd -literal
976 name Name of storage pool
977 property Property name
978 value Property value
979 source Property source, either 'default' or 'local'.
980 .Ed
981 .Pp
982 See the
983 .Sx Properties
984 section for more information on the available pool properties.
985 .Bl -tag -width Ds
986 .It Fl H
987 Scripted mode.
988 Do not display headers, and separate fields by a single tab instead of arbitrary
989 space.
990 .It Fl o Ar field
991 A comma-separated list of columns to display.
992 .Sy name Ns , Ns Sy property Ns , Ns Sy value Ns , Ns Sy source
993 is the default value.
994 .It Fl p
995 Display numbers in parsable (exact) values.
996 .El
997 .It Xo
998 .Nm
999 .Cm history
1000 .Op Fl il
1001 .Oo Ar pool Oc Ns ...
1002 .Xc
1003 Displays the command history of the specified pool(s) or all pools if no pool is
1004 specified.
1005 .Bl -tag -width Ds
1006 .It Fl i
1007 Displays internally logged ZFS events in addition to user initiated events.
1008 .It Fl l
1009 Displays log records in long format, which in addition to standard format
1010 includes, the user name, the hostname, and the zone in which the operation was
1011 performed.
1012 .El
1013 .It Xo
1014 .Nm
1015 .Cm import
1016 .Op Fl D
1017 .Op Fl d Ar dir
1018 .Xc
1019 Lists pools available to import.
1020 If the
1021 .Fl d
1022 option is not specified, this command searches for devices in
1023 .Pa /dev/dsk .
1024 The
1025 .Fl d
1026 option can be specified multiple times, and all directories are searched.
1027 If the device appears to be part of an exported pool, this command displays a
1028 summary of the pool with the name of the pool, a numeric identifier, as well as
1029 the vdev layout and current health of the device for each device or file.
1030 Destroyed pools, pools that were previously destroyed with the
1031 .Nm zpool Cm destroy
1032 command, are not listed unless the
1033 .Fl D
1034 option is specified.
1035 .Pp
1036 The numeric identifier is unique, and can be used instead of the pool name when
1037 multiple exported pools of the same name are available.
1038 .Bl -tag -width Ds
1039 .It Fl c Ar cachefile
1040 Reads configuration from the given
1041 .Ar cachefile
1042 that was created with the
1043 .Sy cachefile
1044 pool property.
1045 This
1046 .Ar cachefile
1047 is used instead of searching for devices.
1048 .It Fl d Ar dir
1049 Searches for devices or files in
1050 .Ar dir .
1051 The
1052 .Fl d
1053 option can be specified multiple times.
1054 .It Fl D
1055 Lists destroyed pools only.
1056 .El
1057 .It Xo
1058 .Nm
1059 .Cm import
1060 .Fl a
1061 .Op Fl DfmN
1062 .Op Fl F Op Fl n
1063 .Op Fl c Ar cachefile Ns | Ns Fl d Ar dir
1064 .Op Fl o Ar mntopts
1065 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1066 .Op Fl R Ar root
1067 .Xc
1068 Imports all pools found in the search directories.
1069 Identical to the previous command, except that all pools with a sufficient
1070 number of devices available are imported.
1071 Destroyed pools, pools that were previously destroyed with the
1072 .Nm zpool Cm destroy
1073 command, will not be imported unless the
1074 .Fl D
1075 option is specified.
1076 .Bl -tag -width Ds
1077 .It Fl a
1078 Searches for and imports all pools found.
1079 .It Fl c Ar cachefile
1080 Reads configuration from the given
1081 .Ar cachefile
1082 that was created with the
1083 .Sy cachefile
1084 pool property.
1085 This
1086 .Ar cachefile
1087 is used instead of searching for devices.
1088 .It Fl d Ar dir
1089 Searches for devices or files in
1090 .Ar dir .
1091 The
1092 .Fl d
1093 option can be specified multiple times.
1094 This option is incompatible with the
1095 .Fl c
1096 option.
1097 .It Fl D
1098 Imports destroyed pools only.
1099 The
1100 .Fl f
1101 option is also required.
1102 .It Fl f
1103 Forces import, even if the pool appears to be potentially active.
1104 .It Fl F
1105 Recovery mode for a non-importable pool.
1106 Attempt to return the pool to an importable state by discarding the last few
1107 transactions.
1108 Not all damaged pools can be recovered by using this option.
1109 If successful, the data from the discarded transactions is irretrievably lost.
1110 This option is ignored if the pool is importable or already imported.
1111 .It Fl m
1112 Allows a pool to import when there is a missing log device.
1113 Recent transactions can be lost because the log device will be discarded.
1114 .It Fl n
1115 Used with the
1116 .Fl F
1117 recovery option.
1118 Determines whether a non-importable pool can be made importable again, but does
1119 not actually perform the pool recovery.
1120 For more details about pool recovery mode, see the
1121 .Fl F
1122 option, above.
1123 .It Fl N
1124 Import the pool without mounting any file systems.
1125 .It Fl o Ar mntopts
1126 Comma-separated list of mount options to use when mounting datasets within the
1127 pool.
1128 See
1129 .Xr zfs 8
1130 for a description of dataset properties and mount options.
1131 .It Fl o Ar property Ns = Ns Ar value
1132 Sets the specified property on the imported pool.
1133 See the
1134 .Sx Properties
1135 section for more information on the available pool properties.
1136 .It Fl R Ar root
1137 Sets the
1138 .Sy cachefile
1139 property to
1140 .Sy none
1141 and the
1142 .Sy altroot
1143 property to
1144 .Ar root .
1145 .El
1146 .It Xo
1147 .Nm
1148 .Cm import
1149 .Op Fl Dfm
1150 .Op Fl F Op Fl n
1151 .Op Fl c Ar cachefile Ns | Ns Fl d Ar dir
1152 .Op Fl o Ar mntopts
1153 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1154 .Op Fl R Ar root
1155 .Ar pool Ns | Ns Ar id
1156 .Op Ar newpool
1157 .Xc
1158 Imports a specific pool.
1159 A pool can be identified by its name or the numeric identifier.
1160 If
1161 .Ar newpool
1162 is specified, the pool is imported using the name
1163 .Ar newpool .
1164 Otherwise, it is imported with the same name as its exported name.
1165 .Pp
1166 If a device is removed from a system without running
1167 .Nm zpool Cm export
1168 first, the device appears as potentially active.
1169 It cannot be determined if this was a failed export, or whether the device is
1170 really in use from another host.
1171 To import a pool in this state, the
1172 .Fl f
1173 option is required.
1174 .Bl -tag -width Ds
1175 .It Fl c Ar cachefile
1176 Reads configuration from the given
1177 .Ar cachefile
1178 that was created with the
1179 .Sy cachefile
1180 pool property.
1181 This
1182 .Ar cachefile
1183 is used instead of searching for devices.
1184 .It Fl d Ar dir
1185 Searches for devices or files in
1186 .Ar dir .
1187 The
1188 .Fl d
1189 option can be specified multiple times.
1190 This option is incompatible with the
1191 .Fl c
1192 option.
1193 .It Fl D
1194 Imports destroyed pool.
1195 The
1196 .Fl f
1197 option is also required.
1198 .It Fl f
1199 Forces import, even if the pool appears to be potentially active.
1200 .It Fl F
1201 Recovery mode for a non-importable pool.
1202 Attempt to return the pool to an importable state by discarding the last few
1203 transactions.
1204 Not all damaged pools can be recovered by using this option.
1205 If successful, the data from the discarded transactions is irretrievably lost.
1206 This option is ignored if the pool is importable or already imported.
1207 .It Fl m
1208 Allows a pool to import when there is a missing log device.
1209 Recent transactions can be lost because the log device will be discarded.
1210 .It Fl n
1211 Used with the
1212 .Fl F
1213 recovery option.
1214 Determines whether a non-importable pool can be made importable again, but does
1215 not actually perform the pool recovery.
1216 For more details about pool recovery mode, see the
1217 .Fl F
1218 option, above.
1219 .It Fl o Ar mntopts
1220 Comma-separated list of mount options to use when mounting datasets within the
1221 pool.
1222 See
1223 .Xr zfs 8
1224 for a description of dataset properties and mount options.
1225 .It Fl o Ar property Ns = Ns Ar value
1226 Sets the specified property on the imported pool.
1227 See the
1228 .Sx Properties
1229 section for more information on the available pool properties.
1230 .It Fl R Ar root
1231 Sets the
1232 .Sy cachefile
1233 property to
1234 .Sy none
1235 and the
1236 .Sy altroot
1237 property to
1238 .Ar root .
1239 .El
1240 .It Xo
1241 .Nm
1242 .Cm iostat
1243 .Op Fl v
1244 .Op Fl T Sy u Ns | Ns Sy d
1245 .Oo Ar pool Oc Ns ...
1246 .Op Ar interval Op Ar count
1247 .Xc
1248 Displays I/O statistics for the given pools.
1249 When given an
1250 .Ar interval ,
1251 the statistics are printed every
1252 .Ar interval
1253 seconds until ^C is pressed.
1254 If no
1255 .Ar pool Ns s
1256 are specified, statistics for every pool in the system is shown.
1257 If
1258 .Ar count
1259 is specified, the command exits after
1260 .Ar count
1261 reports are printed.
1262 .Bl -tag -width Ds
1263 .It Fl T Sy u Ns | Ns Sy d
1264 Display a time stamp.
1265 Specify
1266 .Sy u
1267 for a printed representation of the internal representation of time.
1268 See
1269 .Xr time 2 .
1270 Specify
1271 .Sy d
1272 for standard date format.
1273 See
1274 .Xr date 1 .
1275 .It Fl v
1276 Verbose statistics Reports usage statistics for individual vdevs within the
1277 pool, in addition to the pool-wide statistics.
1278 .El
1279 .It Xo
1280 .Nm
1281 .Cm labelclear
1282 .Op Fl f
1283 .Ar device
1284 .Xc
1285 Removes ZFS label information from the specified
1286 .Ar device .
1287 The
1288 .Ar device
1289 must not be part of an active pool configuration.
1290 .Bl -tag -width Ds
1291 .It Fl f
1292 Treat exported or foreign devices as inactive.
1293 .El
1294 .It Xo
1295 .Nm
1296 .Cm list
1297 .Op Fl Hpv
1298 .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
1299 .Op Fl T Sy u Ns | Ns Sy d
1300 .Oo Ar pool Oc Ns ...
1301 .Op Ar interval Op Ar count
1302 .Xc
1303 Lists the given pools along with a health status and space usage.
1304 If no
1305 .Ar pool Ns s
1306 are specified, all pools in the system are listed.
1307 When given an
1308 .Ar interval ,
1309 the information is printed every
1310 .Ar interval
1311 seconds until ^C is pressed.
1312 If
1313 .Ar count
1314 is specified, the command exits after
1315 .Ar count
1316 reports are printed.
1317 .Bl -tag -width Ds
1318 .It Fl H
1319 Scripted mode.
1320 Do not display headers, and separate fields by a single tab instead of arbitrary
1321 space.
1322 .It Fl o Ar property
1323 Comma-separated list of properties to display.
1324 See the
1325 .Sx Properties
1326 section for a list of valid properties.
1327 The default list is
1328 .Sy name , size , used , available , fragmentation , expandsize , capacity ,
1329 .Sy dedupratio , health , altroot .
1330 .It Fl p
1331 Display numbers in parsable
1332 .Pq exact
1333 values.
1334 .It Fl T Sy u Ns | Ns Sy d
1335 Display a time stamp.
1336 Specify
1337 .Fl u
1338 for a printed representation of the internal representation of time.
1339 See
1340 .Xr time 2 .
1341 Specify
1342 .Fl d
1343 for standard date format.
1344 See
1345 .Xr date 1 .
1346 .It Fl v
1347 Verbose statistics.
1348 Reports usage statistics for individual vdevs within the pool, in addition to
1349 the pool-wise statistics.
1350 .El
1351 .It Xo
1352 .Nm
1353 .Cm offline
1354 .Op Fl t
1355 .Ar pool Ar device Ns ...
1356 .Xc
1357 Takes the specified physical device offline.
1358 While the
1359 .Ar device
1360 is offline, no attempt is made to read or write to the device.
1361 This command is not applicable to spares.
1362 .Bl -tag -width Ds
1363 .It Fl t
1364 Temporary.
1365 Upon reboot, the specified physical device reverts to its previous state.
1366 .El
1367 .It Xo
1368 .Nm
1369 .Cm online
1370 .Op Fl e
1371 .Ar pool Ar device Ns ...
1372 .Xc
1373 Brings the specified physical device online.
1374 This command is not applicable to spares.
1375 .Bl -tag -width Ds
1376 .It Fl e
1377 Expand the device to use all available space.
1378 If the device is part of a mirror or raidz then all devices must be expanded
1379 before the new space will become available to the pool.
1380 .El
1381 .It Xo
1382 .Nm
1383 .Cm reguid
1384 .Ar pool
1385 .Xc
1386 Generates a new unique identifier for the pool.
1387 You must ensure that all devices in this pool are online and healthy before
1388 performing this action.
1389 .It Xo
1390 .Nm
1391 .Cm reopen
1392 .Ar pool
1393 .Xc
1394 Reopen all the vdevs associated with the pool.
1395 .It Xo
1396 .Nm
1397 .Cm remove
1398 .Ar pool Ar device Ns ...
1399 .Xc
1400 Removes the specified device from the pool.
1401 This command currently only supports removing hot spares, cache, and log
1402 devices.
1403 A mirrored log device can be removed by specifying the top-level mirror for the
1404 log.
1405 Non-log devices that are part of a mirrored configuration can be removed using
1406 the
1407 .Nm zpool Cm detach
1408 command.
1409 Non-redundant and raidz devices cannot be removed from a pool.
1410 .It Xo
1411 .Nm
1412 .Cm replace
1413 .Op Fl f
1414 .Ar pool Ar device Op Ar new_device
1415 .Xc
1416 Replaces
1417 .Ar old_device
1418 with
1419 .Ar new_device .
1420 This is equivalent to attaching
1421 .Ar new_device ,
1422 waiting for it to resilver, and then detaching
1423 .Ar old_device .
1424 .Pp
1425 The size of
1426 .Ar new_device
1427 must be greater than or equal to the minimum size of all the devices in a mirror
1428 or raidz configuration.
1429 .Pp
1430 .Ar new_device
1431 is required if the pool is not redundant.
1432 If
1433 .Ar new_device
1434 is not specified, it defaults to
1435 .Ar old_device .
1436 This form of replacement is useful after an existing disk has failed and has
1437 been physically replaced.
1438 In this case, the new disk may have the same
1439 .Pa /dev/dsk
1440 path as the old device, even though it is actually a different disk.
1441 ZFS recognizes this.
1442 .Bl -tag -width Ds
1443 .It Fl f
1444 Forces use of
1445 .Ar new_device ,
1446 even if its appears to be in use.
1447 Not all devices can be overridden in this manner.
1448 .El
1449 .It Xo
1450 .Nm
1451 .Cm scrub
1452 .Op Fl s | Fl p
1453 .Ar pool Ns ...
1454 .Xc
1455 Begins a scrub or resumes a paused scrub.
1456 The scrub examines all data in the specified pools to verify that it checksums
1457 correctly.
1458 For replicated
1459 .Pq mirror or raidz
1460 devices, ZFS automatically repairs any damage discovered during the scrub.
1461 The
1462 .Nm zpool Cm status
1463 command reports the progress of the scrub and summarizes the results of the
1464 scrub upon completion.
1465 .Pp
1466 Scrubbing and resilvering are very similar operations.
1467 The difference is that resilvering only examines data that ZFS knows to be out
1468 of date
1469 .Po
1470 for example, when attaching a new device to a mirror or replacing an existing
1471 device
1472 .Pc ,
1473 whereas scrubbing examines all data to discover silent errors due to hardware
1474 faults or disk failure.
1475 .Pp
1476 Because scrubbing and resilvering are I/O-intensive operations, ZFS only allows
1477 one at a time.
1478 If a scrub is paused, the
1479 .Nm zpool Cm scrub
1480 resumes it.
1481 If a resilver is in progress, ZFS does not allow a scrub to be started until the
1482 resilver completes.
1483 .Bl -tag -width Ds
1484 .It Fl s
1485 Stop scrubbing.
1486 .El
1487 .Bl -tag -width Ds
1488 .It Fl p
1489 Pause scrubbing.
1490 Scrub pause state and progress are periodically synced to disk.
1491 If the system is restarted or pool is exported during a paused scrub,
1492 even after import, scrub will remain paused until it is resumed.
1493 Once resumed the scrub will pick up from the place where it was last
1494 checkpointed to disk.
1495 To resume a paused scrub issue
1496 .Nm zpool Cm scrub
1497 again.
1498 .El
1499 .It Xo
1500 .Nm
1501 .Cm set
1502 .Ar property Ns = Ns Ar value
1503 .Ar pool
1504 .Xc
1505 Sets the given property on the specified pool.
1506 See the
1507 .Sx Properties
1508 section for more information on what properties can be set and acceptable
1509 values.
1510 .It Xo
1511 .Nm
1512 .Cm split
1513 .Op Fl n
1514 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1515 .Op Fl R Ar root
1516 .Ar pool newpool
1517 .Xc
1518 Splits devices off
1519 .Ar pool
1520 creating
1521 .Ar newpool .
1522 All vdevs in
1523 .Ar pool
1524 must be mirrors.
1525 At the time of the split,
1526 .Ar newpool
1527 will be a replica of
1528 .Ar pool .
1529 .Bl -tag -width Ds
1530 .It Fl n
1531 Do dry run, do not actually perform the split.
1532 Print out the expected configuration of
1533 .Ar newpool .
1534 .It Fl o Ar property Ns = Ns Ar value
1535 Sets the specified property for
1536 .Ar newpool .
1537 See the
1538 .Sx Properties
1539 section for more information on the available pool properties.
1540 .It Fl R Ar root
1541 Set
1542 .Sy altroot
1543 for
1544 .Ar newpool
1545 to
1546 .Ar root
1547 and automatically import it.
1548 .El
1549 .It Xo
1550 .Nm
1551 .Cm status
1552 .Op Fl Dvx
1553 .Op Fl T Sy u Ns | Ns Sy d
1554 .Oo Ar pool Oc Ns ...
1555 .Op Ar interval Op Ar count
1556 .Xc
1557 Displays the detailed health status for the given pools.
1558 If no
1559 .Ar pool
1560 is specified, then the status of each pool in the system is displayed.
1561 For more information on pool and device health, see the
1562 .Sx Device Failure and Recovery
1563 section.
1564 .Pp
1565 If a scrub or resilver is in progress, this command reports the percentage done
1566 and the estimated time to completion.
1567 Both of these are only approximate, because the amount of data in the pool and
1568 the other workloads on the system can change.
1569 .Bl -tag -width Ds
1570 .It Fl D
1571 Display a histogram of deduplication statistics, showing the allocated
1572 .Pq physically present on disk
1573 and referenced
1574 .Pq logically referenced in the pool
1575 block counts and sizes by reference count.
1576 .It Fl T Sy u Ns | Ns Sy d
1577 Display a time stamp.
1578 Specify
1579 .Fl u
1580 for a printed representation of the internal representation of time.
1581 See
1582 .Xr time 2 .
1583 Specify
1584 .Fl d
1585 for standard date format.
1586 See
1587 .Xr date 1 .
1588 .It Fl v
1589 Displays verbose data error information, printing out a complete list of all
1590 data errors since the last complete pool scrub.
1591 .It Fl x
1592 Only display status for pools that are exhibiting errors or are otherwise
1593 unavailable.
1594 Warnings about pools not using the latest on-disk format will not be included.
1595 .El
1596 .It Xo
1597 .Nm
1598 .Cm upgrade
1599 .Xc
1600 Displays pools which do not have all supported features enabled and pools
1601 formatted using a legacy ZFS version number.
1602 These pools can continue to be used, but some features may not be available.
1603 Use
1604 .Nm zpool Cm upgrade Fl a
1605 to enable all features on all pools.
1606 .It Xo
1607 .Nm
1608 .Cm upgrade
1609 .Fl v
1610 .Xc
1611 Displays legacy ZFS versions supported by the current software.
1612 See
1613 .Xr zpool-features 5
1614 for a description of feature flags features supported by the current software.
1615 .It Xo
1616 .Nm
1617 .Cm upgrade
1618 .Op Fl V Ar version
1619 .Fl a Ns | Ns Ar pool Ns ...
1620 .Xc
1621 Enables all supported features on the given pool.
1622 Once this is done, the pool will no longer be accessible on systems that do not
1623 support feature flags.
1624 See
1625 .Xr zpool-features 5
1626 for details on compatibility with systems that support feature flags, but do not
1627 support all features enabled on the pool.
1628 .Bl -tag -width Ds
1629 .It Fl a
1630 Enables all supported features on all pools.
1631 .It Fl V Ar version
1632 Upgrade to the specified legacy version.
1633 If the
1634 .Fl V
1635 flag is specified, no features will be enabled on the pool.
1636 This option can only be used to increase the version number up to the last
1637 supported legacy version number.
1638 .El
1639 .El
1640 .Sh EXIT STATUS
1641 The following exit values are returned:
1642 .Bl -tag -width Ds
1643 .It Sy 0
1644 Successful completion.
1645 .It Sy 1
1646 An error occurred.
1647 .It Sy 2
1648 Invalid command line options were specified.
1649 .El
1650 .Sh EXAMPLES
1651 .Bl -tag -width Ds
1652 .It Sy Example 1 No Creating a RAID-Z Storage Pool
1653 The following command creates a pool with a single raidz root vdev that
1654 consists of six disks.
1655 .Bd -literal
1656 # zpool create tank raidz c0t0d0 c0t1d0 c0t2d0 c0t3d0 c0t4d0 c0t5d0
1657 .Ed
1658 .It Sy Example 2 No Creating a Mirrored Storage Pool
1659 The following command creates a pool with two mirrors, where each mirror
1660 contains two disks.
1661 .Bd -literal
1662 # zpool create tank mirror c0t0d0 c0t1d0 mirror c0t2d0 c0t3d0
1663 .Ed
1664 .It Sy Example 3 No Creating a ZFS Storage Pool by Using Slices
1665 The following command creates an unmirrored pool using two disk slices.
1666 .Bd -literal
1667 # zpool create tank /dev/dsk/c0t0d0s1 c0t1d0s4
1668 .Ed
1669 .It Sy Example 4 No Creating a ZFS Storage Pool by Using Files
1670 The following command creates an unmirrored pool using files.
1671 While not recommended, a pool based on files can be useful for experimental
1672 purposes.
1673 .Bd -literal
1674 # zpool create tank /path/to/file/a /path/to/file/b
1675 .Ed
1676 .It Sy Example 5 No Adding a Mirror to a ZFS Storage Pool
1677 The following command adds two mirrored disks to the pool
1678 .Em tank ,
1679 assuming the pool is already made up of two-way mirrors.
1680 The additional space is immediately available to any datasets within the pool.
1681 .Bd -literal
1682 # zpool add tank mirror c1t0d0 c1t1d0
1683 .Ed
1684 .It Sy Example 6 No Listing Available ZFS Storage Pools
1685 The following command lists all available pools on the system.
1686 In this case, the pool
1687 .Em zion
1688 is faulted due to a missing device.
1689 The results from this command are similar to the following:
1690 .Bd -literal
1691 # zpool list
1692 NAME SIZE ALLOC FREE FRAG EXPANDSZ CAP DEDUP HEALTH ALTROOT
1693 rpool 19.9G 8.43G 11.4G 33% - 42% 1.00x ONLINE -
1694 tank 61.5G 20.0G 41.5G 48% - 32% 1.00x ONLINE -
1695 zion - - - - - - - FAULTED -
1696 .Ed
1697 .It Sy Example 7 No Destroying a ZFS Storage Pool
1698 The following command destroys the pool
1699 .Em tank
1700 and any datasets contained within.
1701 .Bd -literal
1702 # zpool destroy -f tank
1703 .Ed
1704 .It Sy Example 8 No Exporting a ZFS Storage Pool
1705 The following command exports the devices in pool
1706 .Em tank
1707 so that they can be relocated or later imported.
1708 .Bd -literal
1709 # zpool export tank
1710 .Ed
1711 .It Sy Example 9 No Importing a ZFS Storage Pool
1712 The following command displays available pools, and then imports the pool
1713 .Em tank
1714 for use on the system.
1715 The results from this command are similar to the following:
1716 .Bd -literal
1717 # zpool import
1718 pool: tank
1719 id: 15451357997522795478
1720 state: ONLINE
1721 action: The pool can be imported using its name or numeric identifier.
1722 config:
1724 tank ONLINE
1725 mirror ONLINE
1726 c1t2d0 ONLINE
1727 c1t3d0 ONLINE
1729 # zpool import tank
1730 .Ed
1731 .It Sy Example 10 No Upgrading All ZFS Storage Pools to the Current Version
1732 The following command upgrades all ZFS Storage pools to the current version of
1733 the software.
1734 .Bd -literal
1735 # zpool upgrade -a
1736 This system is currently running ZFS version 2.
1737 .Ed
1738 .It Sy Example 11 No Managing Hot Spares
1739 The following command creates a new pool with an available hot spare:
1740 .Bd -literal
1741 # zpool create tank mirror c0t0d0 c0t1d0 spare c0t2d0
1742 .Ed
1743 .Pp
1744 If one of the disks were to fail, the pool would be reduced to the degraded
1745 state.
1746 The failed device can be replaced using the following command:
1747 .Bd -literal
1748 # zpool replace tank c0t0d0 c0t3d0
1749 .Ed
1750 .Pp
1751 Once the data has been resilvered, the spare is automatically removed and is
1752 made available for use should another device fail.
1753 The hot spare can be permanently removed from the pool using the following
1754 command:
1755 .Bd -literal
1756 # zpool remove tank c0t2d0
1757 .Ed
1758 .It Sy Example 12 No Creating a ZFS Pool with Mirrored Separate Intent Logs
1759 The following command creates a ZFS storage pool consisting of two, two-way
1760 mirrors and mirrored log devices:
1761 .Bd -literal
1762 # zpool create pool mirror c0d0 c1d0 mirror c2d0 c3d0 log mirror \e
1763 c4d0 c5d0
1764 .Ed
1765 .It Sy Example 13 No Adding Cache Devices to a ZFS Pool
1766 The following command adds two disks for use as cache devices to a ZFS storage
1767 pool:
1768 .Bd -literal
1769 # zpool add pool cache c2d0 c3d0
1770 .Ed
1771 .Pp
1772 Once added, the cache devices gradually fill with content from main memory.
1773 Depending on the size of your cache devices, it could take over an hour for
1774 them to fill.
1775 Capacity and reads can be monitored using the
1776 .Cm iostat
1777 option as follows:
1778 .Bd -literal
1779 # zpool iostat -v pool 5
1780 .Ed
1781 .It Sy Example 14 No Removing a Mirrored Log Device
1782 The following command removes the mirrored log device
1783 .Sy mirror-2 .
1784 Given this configuration:
1785 .Bd -literal
1786 pool: tank
1787 state: ONLINE
1788 scrub: none requested
1789 config:
1791 NAME STATE READ WRITE CKSUM
1792 tank ONLINE 0 0 0
1793 mirror-0 ONLINE 0 0 0
1794 c6t0d0 ONLINE 0 0 0
1795 c6t1d0 ONLINE 0 0 0
1796 mirror-1 ONLINE 0 0 0
1797 c6t2d0 ONLINE 0 0 0
1798 c6t3d0 ONLINE 0 0 0
1799 logs
1800 mirror-2 ONLINE 0 0 0
1801 c4t0d0 ONLINE 0 0 0
1802 c4t1d0 ONLINE 0 0 0
1803 .Ed
1804 .Pp
1805 The command to remove the mirrored log
1806 .Sy mirror-2
1807 is:
1808 .Bd -literal
1809 # zpool remove tank mirror-2
1810 .Ed
1811 .It Sy Example 15 No Displaying expanded space on a device
1812 The following command displays the detailed information for the pool
1813 .Em data .
1814 This pool is comprised of a single raidz vdev where one of its devices
1815 increased its capacity by 10GB.
1816 In this example, the pool will not be able to utilize this extra capacity until
1817 all the devices under the raidz vdev have been expanded.
1818 .Bd -literal
1819 # zpool list -v data
1820 NAME SIZE ALLOC FREE FRAG EXPANDSZ CAP DEDUP HEALTH ALTROOT
1821 data 23.9G 14.6G 9.30G 48% - 61% 1.00x ONLINE -
1822 raidz1 23.9G 14.6G 9.30G 48% -
1823 c1t1d0 - - - - -
1824 c1t2d0 - - - - 10G
1825 c1t3d0 - - - - -
1826 .Ed
1827 .El
1828 .Sh INTERFACE STABILITY
1829 .Sy Evolving
1830 .Sh SEE ALSO
1831 .Xr zfs 8 ,
1832 .Xr attributes 5 ,
1833 .Xr zpool-features 5