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