Project

General

Profile

Feature #1801 » zpool.1m-dist-sol11ex.diff

zpool.1m diff between sunosman-20090930 and Solaris Express 11 (10/2010) - Martin Matuška, 2011-11-21 11:07 AM

View differences:

/tmp/zpool.1m 2011-11-21 11:13:42.000000000 +0100
1 1
'\" te
2
.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
3
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
4
.\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the
5
.\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6
.TH zpool 1M "21 Sep 2009" "SunOS 5.11" "System Administration Commands"
2
.\" Copyright (c) 2004, 2010, Oracle and/or its
3
.\" affiliates. All rights reserved.
4
.\" The contents of this file are subject to the
5
.\" terms of the Common Development and Distribution License (the "License").
6
.\" You may not use this file except in compliance with the License. You can obtain
7
.\" a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
8
.\" See the License for the specific language governing permissions and limitations
9
.\" under the License. When distributing Covered Code, include this CDDL HEADER
10
.\" in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.
11
.\" If applicable, add the following below this CDDL HEADER, with the fields enclosed
12
.\" by brackets "[]" replaced with your own identifying information: Portions
13
.\" Copyright [yyyy] [name of copyright owner]
14
.TH zpool 1M "20 Aug 2010" "SunOS 5.11" "System Administration Commands"
7 15
.SH NAME
8 16
zpool \- configures ZFS storage pools
9 17
.SH SYNOPSIS
......
24 32

  
25 33
.LP
26 34
.nf
27
\fBzpool clear\fR \fIpool\fR [\fIdevice\fR]
35
\fBzpool clear\fR [\fB-F\fR [\fB-n\fR]] \fIpool\fR [\fIdevice\fR]
28 36
.fi
29 37

  
30 38
.LP
......
66 74
.LP
67 75
.nf
68 76
\fBzpool import\fR [\fB-o \fImntopts\fR\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR] 
69
     [\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] \fB-a\fR
77
     [\fB-D\fR] [\fB-f\fR] [\fB-m\fR] [\fB-N\fR] [\fB-R\fR \fIroot\fR] [\fB-F\fR [\fB-n\fR]] \fB-a\fR
70 78
.fi
71 79

  
72 80
.LP
73 81
.nf
74 82
\fBzpool import\fR [\fB-o \fImntopts\fR\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR]
75
     [\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] \fIpool\fR |\fIid\fR [\fInewpool\fR]
83
     [\fB-D\fR] [\fB-f\fR] [\fB-m\fR] [\fB-R\fR \fIroot\fR] [\fB-F\fR [\fB-n\fR]] \fIpool\fR |\fIid\fR [\fInewpool\fR]
76 84
.fi
77 85

  
78 86
.LP
79 87
.nf
80
\fBzpool iostat\fR [\fB-T\fR u | d ] [\fB-v\fR] [\fIpool\fR] ... [\fIinterval\fR[\fIcount\fR]]
88
\fBzpool iostat\fR [\fB-T\fR d|u ] [\fB-v\fR] [\fIpool\fR] ... [\fIinterval\fR[\fIcount\fR]]
81 89
.fi
82 90

  
83 91
.LP
84 92
.nf
85
\fBzpool list\fR [\fB-H\fR] [\fB-o\fR \fIproperty\fR[,...]] [\fIpool\fR] ...
93
\fBzpool list\fR [\fB-H\fR] [\fB-o\fR \fIproperty\fR[,...]] [\fB-T\fR d|u ] [\fIpool\fR] ... [\fIinterval\fR[\fIcount\fR]]
86 94
.fi
87 95

  
88 96
.LP
......
117 125

  
118 126
.LP
119 127
.nf
120
\fBzpool status\fR [\fB-xv\fR] [\fIpool\fR] ...
128
\fBzpool split\fR [\fB-R\fR \fIaltroot\fR] [\fB-n\fR] [\fB-o\fR \fImntopts\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] \fIpool\fR
129
     \fInewpool\fR [\fIdevice\fR ...]
130
.fi
131

  
132
.LP
133
.nf
134
\fBzpool status\fR [\fB-xv\fR] [\fB-T\fR d|u ] [\fIpool\fR] ... [\fIinterval\fR[\fIcount\fR]]
121 135
.fi
122 136

  
123 137
.LP
......
152 166
.na
153 167
\fB\fBdisk\fR\fR
154 168
.ad
155
.RS 10n
156
.rt  
157
A block device, typically located under \fB/dev/dsk\fR. \fBZFS\fR can use individual slices or partitions, though the recommended mode of operation is to use whole disks. A disk can be specified by a full path, or it can be a shorthand name (the relative portion of the path under "/dev/dsk"). A whole disk can be specified by omitting the slice or partition designation. For example, "c0t0d0" is equivalent to "/dev/dsk/c0t0d0s2". When given a whole disk, \fBZFS\fR automatically labels the disk, if necessary.
169
.sp .6
170
.RS 4n
171
A block device, typically located under \fB/dev/dsk\fR. \fBZFS\fR can use individual slices or partitions, though the recommended mode of operation is to use whole disks. A disk can be specified by a full path, or it can be a shorthand name (the relative portion of the path under "/dev/dsk"). A whole disk can be specified by omitting the slice or partition designation. When given a whole disk, \fBZFS\fR automatically labels the disk, if necessary.
158 172
.RE
159 173

  
160 174
.sp
......
163 177
.na
164 178
\fB\fBfile\fR\fR
165 179
.ad
166
.RS 10n
167
.rt  
180
.sp .6
181
.RS 4n
168 182
A regular file. The use of files as a backing store is strongly discouraged. It is designed primarily for experimental purposes, as the fault tolerance of a file is only as good as the file system of which it is a part. A file must be specified by a full path.
169 183
.RE
170 184

  
......
174 188
.na
175 189
\fB\fBmirror\fR\fR
176 190
.ad
177
.RS 10n
178
.rt  
191
.sp .6
192
.RS 4n
179 193
A mirror of two or more devices. Data is replicated in an identical fashion across all components of a mirror. A mirror with \fIN\fR disks of size \fIX\fR can hold \fIX\fR bytes and can withstand (\fIN-1\fR) devices failing before data integrity is compromised.
180 194
.RE
181 195

  
......
197 211
.na
198 212
\fB\fBraidz3\fR\fR
199 213
.ad
200
.RS 10n
201
.rt  
214
.sp .6
215
.RS 4n
202 216
A variation on \fBRAID-5\fR that allows for better distribution of parity and eliminates the "\fBRAID-5\fR write hole" (in which data and parity become inconsistent after a power loss). Data and parity is striped across all disks within a \fBraidz\fR group.
203 217
.sp
204 218
A \fBraidz\fR group can have single-, double- , or triple parity, meaning that the \fBraidz\fR group can sustain one, two, or three failures, respectively, without losing any data. The \fBraidz1\fR \fBvdev\fR type specifies a single-parity \fBraidz\fR group; the \fBraidz2\fR \fBvdev\fR type specifies a double-parity \fBraidz\fR group; and the \fBraidz3\fR \fBvdev\fR type specifies a triple-parity \fBraidz\fR group. The \fBraidz\fR \fBvdev\fR type is an alias for \fBraidz1\fR.
......
212 226
.na
213 227
\fB\fBspare\fR\fR
214 228
.ad
215
.RS 10n
216
.rt  
229
.sp .6
230
.RS 4n
217 231
A special pseudo-\fBvdev\fR which keeps track of available hot spares for a pool. For more information, see the "Hot Spares" section.
218 232
.RE
219 233

  
......
223 237
.na
224 238
\fB\fBlog\fR\fR
225 239
.ad
226
.RS 10n
227
.rt  
240
.sp .6
241
.RS 4n
228 242
A separate-intent log device. If more than one log device is specified, then writes are load-balanced between devices. Log devices can be mirrored. However, \fBraidz\fR \fBvdev\fR types are not supported for the intent log. For more information, see the "Intent Log" section.
229 243
.RE
230 244

  
......
234 248
.na
235 249
\fB\fBcache\fR\fR
236 250
.ad
237
.RS 10n
238
.rt  
239
A device used to cache storage pool data. A cache device cannot be cannot be configured as a mirror or \fBraidz\fR group. For more information, see the "Cache Devices" section.
251
.sp .6
252
.RS 4n
253
A device used to cache storage pool data. A cache device cannot be configured as a mirror or \fBraidz\fR group. For more information, see the "Cache Devices" section.
240 254
.RE
241 255

  
242 256
.sp
......
275 289
.na
276 290
\fB\fBDEGRADED\fR\fR
277 291
.ad
278
.RS 12n
279
.rt  
292
.sp .6
293
.RS 4n
280 294
One or more top-level vdevs is in the degraded state because one or more component devices are offline. Sufficient replicas exist to continue functioning.
281 295
.sp
282 296
One or more component devices is in the degraded or faulted state, but sufficient replicas exist to continue functioning. The underlying conditions are as follows:
......
300 314
.na
301 315
\fB\fBFAULTED\fR\fR
302 316
.ad
303
.RS 12n
304
.rt  
317
.sp .6
318
.RS 4n
305 319
One or more top-level vdevs is in the faulted state because one or more component devices are offline. Insufficient replicas exist to continue functioning. 
306 320
.sp
307 321
One or more component devices is in the faulted state, and insufficient replicas exist to continue functioning. The underlying conditions are as follows:
......
325 339
.na
326 340
\fB\fBOFFLINE\fR\fR
327 341
.ad
328
.RS 12n
329
.rt  
342
.sp .6
343
.RS 4n
330 344
The device was explicitly taken offline by the "\fBzpool offline\fR" command.
331 345
.RE
332 346

  
......
336 350
.na
337 351
\fB\fBONLINE\fR\fR
338 352
.ad
339
.RS 12n
340
.rt  
353
.sp .6
354
.RS 4n
341 355
The device is online and functioning.
342 356
.RE
343 357

  
......
347 361
.na
348 362
\fB\fBREMOVED\fR\fR
349 363
.ad
350
.RS 12n
351
.rt  
364
.sp .6
365
.RS 4n
352 366
The device was physically removed while the system was running. Device removal detection is hardware-dependent and may not be supported on all platforms.
353 367
.RE
354 368

  
......
358 372
.na
359 373
\fB\fBUNAVAIL\fR\fR
360 374
.ad
361
.RS 12n
362
.rt  
375
.sp .6
376
.RS 4n
363 377
The device could not be opened. If a pool is imported when a device was unavailable, then the device will be identified by a unique identifier instead of its path since the path was never correct in the first place.
364 378
.RE
365 379

  
366 380
.sp
367 381
.LP
368
If a device is removed and later re-attached to the system, \fBZFS\fR attempts to put the device online automatically. Device attach detection is hardware-dependent and might not be supported on all platforms.
382
If a device is removed and later reattached to the system, \fBZFS\fR attempts to put the device online automatically. Device attach detection is hardware-dependent and might not be supported on all platforms.
369 383
.SS "Hot Spares"
370 384
.sp
371 385
.LP
......
373 387
.sp
374 388
.in +2
375 389
.nf
376
# zpool create pool mirror c0d0 c1d0 spare c2d0 c3d0
390
# \fBzpool create pool mirror c0d0 c1d0 spare c2d0 c3d0\fR
377 391
.fi
378 392
.in -2
379 393
.sp
......
397 411
.sp
398 412
.in +2
399 413
.nf
400
\fB# zpool create pool c0d0 c1d0 log c2d0\fR
414
# \fBzpool create pool c0d0 c1d0 log c2d0\fR
401 415
.fi
402 416
.in -2
403 417
.sp
......
407 421
Multiple log devices can also be specified, and they can be mirrored. See the EXAMPLES section for an example of mirroring multiple log devices.
408 422
.sp
409 423
.LP
410
Log devices can be added, replaced, attached, detached, and imported and exported as part of the larger pool. Mirrored log devices can be removed by specifying the top-level mirror for the log.
424
Log devices can be added, replaced, attached, detached, and imported, and exported as part of the larger pool. Mirrored log devices can be removed by specifying the top-level mirror for the log.
411 425
.SS "Cache Devices"
412 426
.sp
413 427
.LP
......
418 432
.sp
419 433
.in +2
420 434
.nf
421
\fB# zpool create pool c0d0 c1d0 cache c2d0 c3d0\fR
435
# \fBzpool create pool c0d0 c1d0 cache c2d0 c3d0\fR
422 436
.fi
423 437
.in -2
424 438
.sp
......
429 443
.sp
430 444
.LP
431 445
The content of the cache devices is considered volatile, as is the case with other system caches.
446
.SS "Processes"
447
.sp
448
.LP
449
Each imported pool has an associated process, named \fBzpool-\fR\fIpoolname\fR. The threads in this process are the pool's I/O processing threads, which handle the compression, checksumming, and other tasks for all I/O associated with the pool. This process exists to provides visibility into the CPU utilization of the system's storage pools. The existence of this process is an unstable interface.
432 450
.SS "Properties"
433 451
.sp
434 452
.LP
......
437 455
.ne 2
438 456
.mk
439 457
.na
440
\fB\fBavailable\fR\fR
458
\fB\fBalloc\fR\fR
441 459
.ad
442
.RS 20n
443
.rt  
444
Amount of storage available within the pool. This property can also be referred to by its shortened column name, "avail".
460
.sp .6
461
.RS 4n
462
Amount of storage space within the pool that has been physically allocated.
445 463
.RE
446 464

  
447 465
.sp
......
450 468
.na
451 469
\fB\fBcapacity\fR\fR
452 470
.ad
453
.RS 20n
454
.rt  
471
.sp .6
472
.RS 4n
455 473
Percentage of pool space used. This property can also be referred to by its shortened column name, "cap".
456 474
.RE
457 475

  
......
459 477
.ne 2
460 478
.mk
461 479
.na
462
\fB\fBhealth\fR\fR
480
\fB\fBdedupratio\fR\fR
463 481
.ad
464
.RS 20n
465
.rt  
466
The current health of the pool. Health can be "\fBONLINE\fR", "\fBDEGRADED\fR", "\fBFAULTED\fR", " \fBOFFLINE\fR", "\fBREMOVED\fR", or "\fBUNAVAIL\fR".
482
.sp .6
483
.RS 4n
484
The deduplication ratio specified for a pool, expressed as a multiplier. This value is expressed as a single decimal number. For example, a \fBdedupratio\fR value of \fB1.76\fR indicates that 1.76 units of data were stored but only 1 unit of disk space was actually consumed. This property can also be referred to by its shortened column name, \fBdedup\fR.
485
.sp
486
Deduplication can be enabled as follows:
487
.sp
488
.in +2
489
.nf
490
# \fBzfs set dedup=on \fIpool\fR/\fIdataset\fR\fR
491
.fi
492
.in -2
493
.sp
494

  
495
The default value is \fBoff\fR.
496
.sp
497
See \fBzfs\fR(1M) for a description of the deduplication feature.
498
.RE
499

  
500
.sp
501
.ne 2
502
.mk
503
.na
504
\fB\fBfree\fR\fR
505
.ad
506
.sp .6
507
.RS 4n
508
Number of blocks within the pool that are not allocated. 
467 509
.RE
468 510

  
469 511
.sp
......
472 514
.na
473 515
\fB\fBguid\fR\fR
474 516
.ad
475
.RS 20n
476
.rt  
517
.sp .6
518
.RS 4n
477 519
A unique identifier for the pool.
478 520
.RE
479 521

  
......
481 523
.ne 2
482 524
.mk
483 525
.na
484
\fB\fBsize\fR\fR
526
\fB\fBhealth\fR\fR
485 527
.ad
486
.RS 20n
487
.rt  
488
Total size of the storage pool.
528
.sp .6
529
.RS 4n
530
The current health of the pool. Health can be "\fBONLINE\fR", "\fBDEGRADED\fR", "\fBFAULTED\fR", " \fBOFFLINE\fR", "\fBREMOVED\fR", or "\fBUNAVAIL\fR".
489 531
.RE
490 532

  
491 533
.sp
492 534
.ne 2
493 535
.mk
494 536
.na
495
\fB\fBused\fR\fR
537
\fB\fBsize\fR\fR
496 538
.ad
497
.RS 20n
498
.rt  
499
Amount of storage space used within the pool.
539
.sp .6
540
.RS 4n
541
Total size of the storage pool.
500 542
.RE
501 543

  
502 544
.sp
......
518 560

  
519 561
.sp
520 562
.LP
563
The following property can be set at import time:
564
.sp
565
.ne 2
566
.mk
567
.na
568
\fB\fBreadonly\fR=\fBon\fR | \fBoff\fR\fR
569
.ad
570
.sp .6
571
.RS 4n
572
Controls whether the pool can be modified. When enabled, any synchronous data that exists only on the intent log will not be accessible until the pool is re-imported in read-write mode.
573
.sp
574
Using read-only imports has the following limitations:
575
.RS +4
576
.TP
577
.ie t \(bu
578
.el o
579
Attempts to set additional zpool-level properties during import are ignored.
580
.RE
581
.RS +4
582
.TP
583
.ie t \(bu
584
.el o
585
All filesystem mounts are converted to include the \fBro\fR mount option.
586
.RE
587
.RS +4
588
.TP
589
.ie t \(bu
590
.el o
591
Additional mount options can be set on a temporary basis.
592
.RE
593
A pool that has been imported read-only can be restored to read-write by exporting and reimporting it.
594
.RE
595

  
596
.sp
597
.LP
521 598
The following properties can be set at creation time and import time, and later changed with the \fBzpool set\fR command:
522 599
.sp
523 600
.ne 2
......
569 646
.ne 2
570 647
.mk
571 648
.na
649
\fB\fBdedupditto\fR=\fInumber\fR\fR
650
.ad
651
.sp .6
652
.RS 4n
653
Sets a threshold for number of copies. If the reference count for a deduplicated block goes above this threshold, another ditto copy of the block is stored automatically. The default value is \fB0\fR.
654
.RE
655

  
656
.sp
657
.ne 2
658
.mk
659
.na
572 660
\fB\fBdelegation\fR=\fBon\fR | \fBoff\fR\fR
573 661
.ad
574 662
.sp .6
......
591 679
.na
592 680
\fB\fBwait\fR\fR
593 681
.ad
594
.RS 12n
595
.rt  
596
Blocks all \fBI/O\fR access until the device connectivity is recovered and the errors are cleared. This is the default behavior.
682
.sp .6
683
.RS 4n
684
Blocks all \fBI/O\fR access to the pool until the device connectivity is recovered and the errors are cleared. A pool remains in the wait state until the device issue is resolved. This is the default behavior.
597 685
.RE
598 686

  
599 687
.sp
......
602 690
.na
603 691
\fB\fBcontinue\fR\fR
604 692
.ad
605
.RS 12n
606
.rt  
693
.sp .6
694
.RS 4n
607 695
Returns \fBEIO\fR to any new write \fBI/O\fR requests but allows reads to any of the remaining healthy devices. Any write requests that have yet to be committed to disk would be blocked.
608 696
.RE
609 697

  
......
613 701
.na
614 702
\fB\fBpanic\fR\fR
615 703
.ad
616
.RS 12n
617
.rt  
704
.sp .6
705
.RS 4n
618 706
Prints out a message to the console and generates a system crash dump.
619 707
.RE
620 708

  
......
639 727
.ad
640 728
.sp .6
641 729
.RS 4n
642
The current on-disk version of the pool. This can be increased, but never decreased. The preferred method of updating pools is with the "\fBzpool upgrade\fR" command, though this property can be used when a specific version is needed for backwards compatibility. This property can be any number between 1 and the current version reported by "\fBzpool upgrade -v\fR".
730
The current on-disk version of the pool. This can be increased, but never decreased. The preferred method of updating pools is with the \fBzpool upgrade\fR command, though this property can be used when a specific version is needed for backwards compatibility. This property can be any number between 1 and the current version reported by \fBzpool upgrade -v\fR.
643 731
.RE
644 732

  
645 733
.SS "Subcommands"
......
675 763
.na
676 764
\fB\fB-f\fR\fR
677 765
.ad
678
.RS 6n
679
.rt  
766
.sp .6
767
.RS 4n
680 768
Forces use of \fBvdev\fRs, even if they appear in use or specify a conflicting replication level. Not all devices can be overridden in this manner.
681 769
.RE
682 770

  
......
686 774
.na
687 775
\fB\fB-n\fR\fR
688 776
.ad
689
.RS 6n
690
.rt  
777
.sp .6
778
.RS 4n
691 779
Displays the configuration that would be used without actually adding the \fBvdev\fRs. The actual pool creation can still fail due to insufficient privileges or device sharing.
692 780
.RE
693 781

  
......
709 797
.na
710 798
\fB\fB-f\fR\fR
711 799
.ad
712
.RS 6n
713
.rt  
800
.sp .6
801
.RS 4n
714 802
Forces use of \fInew_device\fR, even if its appears to be in use. Not all devices can be overridden in this manner.
715 803
.RE
716 804

  
......
720 808
.ne 2
721 809
.mk
722 810
.na
723
\fB\fBzpool clear\fR \fIpool\fR [\fIdevice\fR] ...\fR
811
\fB\fBzpool clear\fR [\fB-F\fR [\fB-n\fR]] \fIpool\fR [\fIdevice\fR] \&...\fR
724 812
.ad
725 813
.sp .6
726 814
.RS 4n
727 815
Clears device errors in a pool. If no arguments are specified, all device errors within the pool are cleared. If one or more devices is specified, only those errors associated with the specified device or devices are cleared.
816
.sp
817
.ne 2
818
.mk
819
.na
820
\fB\fB-F\fR\fR
821
.ad
822
.sp .6
823
.RS 4n
824
Initiates recovery mode for an unopenable pool. Attempts to discard the last few transactions in the pool to return it to an openable state. Not all damaged pools can be recovered by using this option. If successful, the data from the discarded transactions is irretrievably lost.
825
.RE
826

  
827
.sp
828
.ne 2
829
.mk
830
.na
831
\fB\fB-n\fR\fR
832
.ad
833
.sp .6
834
.RS 4n
835
Used in combination with the \fB-F\fR flag. Check whether discarding transactions would make the pool openable, but do not actually discard any transactions.
836
.RE
837

  
728 838
.RE
729 839

  
730 840
.sp
......
735 845
.ad
736 846
.sp .6
737 847
.RS 4n
738
Creates a new storage pool containing the virtual devices specified on the command line. The pool name must begin with a letter, and can only contain alphanumeric characters as well as underscore ("_"), dash ("-"), and period ("."). The pool names "mirror", "raidz", "spare" and "log" are reserved, as are names beginning with the pattern "c[0-9]". The \fBvdev\fR specification is described in the "Virtual Devices" section.
848
Creates a new storage pool containing the virtual devices specified on the command line. The pool name must begin with a letter, and can only contain alphanumeric characters as well as underscore ("_"), dash ("-"), and period ("."). The pool names \fBmirror\fR, \fBraidz\fR, \fBspare\fR, and \fBlog\fR are reserved, as are names beginning with the pattern \fBc\fR[\fB0-9\fR]. The \fBvdev\fR specification is described in the "Virtual Devices" section.
739 849
.sp
740 850
The command verifies that each device specified is accessible and not currently in use by another subsystem. There are some uses, such as being currently mounted, or specified as the dedicated dump device, that prevents a device from ever being used by \fBZFS\fR. Other uses, such as having a preexisting \fBUFS\fR file system, can be overridden with the \fB-f\fR option.
741 851
.sp
......
783 893
.ad
784 894
.br
785 895
.na
786
\fB[\fB-O\fR \fIfile-system-property=value\fR] ...\fR
896
\fB[\fB-O\fR \fIfile-system-property=value\fR] \&...\fR
787 897
.ad
788 898
.sp .6
789 899
.RS 4n
......
829 939
.na
830 940
\fB\fB-f\fR\fR
831 941
.ad
832
.RS 6n
833
.rt  
942
.sp .6
943
.RS 4n
834 944
Forces any active datasets contained within the pool to be unmounted.
835 945
.RE
836 946

  
......
866 976
.na
867 977
\fB\fB-f\fR\fR
868 978
.ad
869
.RS 6n
870
.rt  
979
.sp .6
980
.RS 4n
871 981
Forcefully unmount all datasets, using the "\fBunmount -f\fR" command.
872 982
.sp
873 983
This command will forcefully export the pool even if it has a shared spare that is currently being used. This may lead to potential data corruption.
......
913 1023
.na
914 1024
\fB\fB-i\fR\fR
915 1025
.ad
916
.RS 6n
917
.rt  
1026
.sp .6
1027
.RS 4n
918 1028
Displays internally logged \fBZFS\fR events in addition to user initiated events.
919 1029
.RE
920 1030

  
......
924 1034
.na
925 1035
\fB\fB-l\fR\fR
926 1036
.ad
927
.RS 6n
928
.rt  
1037
.sp .6
1038
.RS 4n
929 1039
Displays log records in long format, which in addition to standard format includes, the user name, the hostname, and the zone in which the operation was performed.
930 1040
.RE
931 1041

  
......
948 1058
.na
949 1059
\fB\fB-c\fR \fIcachefile\fR\fR
950 1060
.ad
951
.RS 16n
952
.rt  
1061
.sp .6
1062
.RS 4n
953 1063
Reads configuration from the given \fBcachefile\fR that was created with the "\fBcachefile\fR" pool property. This \fBcachefile\fR is used instead of searching for devices.
954 1064
.RE
955 1065

  
......
959 1069
.na
960 1070
\fB\fB-d\fR \fIdir\fR\fR
961 1071
.ad
962
.RS 16n
963
.rt  
1072
.sp .6
1073
.RS 4n
964 1074
Searches for devices or files in \fIdir\fR. The \fB-d\fR option can be specified multiple times. 
965 1075
.RE
966 1076

  
......
970 1080
.na
971 1081
\fB\fB-D\fR\fR
972 1082
.ad
973
.RS 16n
974
.rt  
1083
.sp .6
1084
.RS 4n
975 1085
Lists destroyed pools only.
976 1086
.RE
977 1087

  
......
981 1091
.ne 2
982 1092
.mk
983 1093
.na
984
\fB\fBzpool import\fR [\fB-o\fR \fImntopts\fR] [ \fB-o\fR \fIproperty\fR=\fIvalue\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR] [\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] \fB-a\fR\fR
1094
\fB\fBzpool import\fR [\fB-o\fR \fImntopts\fR] [ \fB-o\fR \fIproperty\fR=\fIvalue\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR] [\fB-D\fR] [\fB-f\fR] [\fB-m\fR] [\fB-N\fR] [\fB-R\fR \fIroot\fR] [\fB-F\fR [\fB-n\fR]] \fB-a\fR\fR
985 1095
.ad
986 1096
.sp .6
987 1097
.RS 4n
......
992 1102
.na
993 1103
\fB\fB-o\fR \fImntopts\fR\fR
994 1104
.ad
995
.RS 21n
996
.rt  
1105
.sp .6
1106
.RS 4n
997 1107
Comma-separated list of mount options to use when mounting datasets within the pool. See \fBzfs\fR(1M) for a description of dataset properties and mount options.
998 1108
.RE
999 1109

  
......
1003 1113
.na
1004 1114
\fB\fB-o\fR \fIproperty=value\fR\fR
1005 1115
.ad
1006
.RS 21n
1007
.rt  
1116
.sp .6
1117
.RS 4n
1008 1118
Sets the specified property on the imported pool. See the "Properties" section for more information on the available pool properties.
1009 1119
.RE
1010 1120

  
......
1014 1124
.na
1015 1125
\fB\fB-c\fR \fIcachefile\fR\fR
1016 1126
.ad
1017
.RS 21n
1018
.rt  
1127
.sp .6
1128
.RS 4n
1019 1129
Reads configuration from the given \fBcachefile\fR that was created with the "\fBcachefile\fR" pool property. This \fBcachefile\fR is used instead of searching for devices.
1020 1130
.RE
1021 1131

  
......
1025 1135
.na
1026 1136
\fB\fB-d\fR \fIdir\fR\fR
1027 1137
.ad
1028
.RS 21n
1029
.rt  
1138
.sp .6
1139
.RS 4n
1030 1140
Searches for devices or files in \fIdir\fR. The \fB-d\fR option can be specified multiple times. This option is incompatible with the \fB-c\fR option.
1031 1141
.RE
1032 1142

  
......
1036 1146
.na
1037 1147
\fB\fB-D\fR\fR
1038 1148
.ad
1039
.RS 21n
1040
.rt  
1149
.sp .6
1150
.RS 4n
1041 1151
Imports destroyed pools only. The \fB-f\fR option is also required.
1042 1152
.RE
1043 1153

  
......
1047 1157
.na
1048 1158
\fB\fB-f\fR\fR
1049 1159
.ad
1050
.RS 21n
1051
.rt  
1160
.sp .6
1161
.RS 4n
1052 1162
Forces import, even if the pool appears to be potentially active.
1053 1163
.RE
1054 1164

  
......
1056 1166
.ne 2
1057 1167
.mk
1058 1168
.na
1169
\fB\fB-F\fR\fR
1170
.ad
1171
.sp .6
1172
.RS 4n
1173
Recovery mode for a non-importable pool. Attempt to return the pool to an importable state by discarding the last few transactions. Not all damaged pools can be recovered by using this option. If successful, the data from the discarded transactions is irretrievably lost. This option is ignored if the pool is importable or already imported.
1174
.RE
1175

  
1176
.sp
1177
.ne 2
1178
.mk
1179
.na
1059 1180
\fB\fB-a\fR\fR
1060 1181
.ad
1061
.RS 21n
1062
.rt  
1063
Searches for and imports all pools found. 
1182
.sp .6
1183
.RS 4n
1184
Searches for and imports all pools found.
1185
.RE
1186

  
1187
.sp
1188
.ne 2
1189
.mk
1190
.na
1191
\fB\fB-m\fR\fR
1192
.ad
1193
.sp .6
1194
.RS 4n
1195
Allows a pool to import when there is a missing log device.
1064 1196
.RE
1065 1197

  
1066 1198
.sp
......
1069 1201
.na
1070 1202
\fB\fB-R\fR \fIroot\fR\fR
1071 1203
.ad
1072
.RS 21n
1073
.rt  
1204
.sp .6
1205
.RS 4n
1074 1206
Sets the "\fBcachefile\fR" property to "\fBnone\fR" and the "\fIaltroot\fR" property to "\fIroot\fR".
1075 1207
.RE
1076 1208

  
1209
.sp
1210
.ne 2
1211
.mk
1212
.na
1213
\fB\fB-N\fR\fR
1214
.ad
1215
.sp .6
1216
.RS 4n
1217
Import the pool without mounting any file systems.
1218
.RE
1219

  
1220
.sp
1221
.ne 2
1222
.mk
1223
.na
1224
\fB\fB-n\fR\fR
1225
.ad
1226
.sp .6
1227
.RS 4n
1228
Used with the \fB-F\fR recovery option. Determines whether a non-importable pool can be made importable again, but does not actually perform the pool recovery. For more details about pool recovery mode, see the \fB-F\fR option, above.
1229
.RE
1230

  
1077 1231
.RE
1078 1232

  
1079 1233
.sp
1080 1234
.ne 2
1081 1235
.mk
1082 1236
.na
1083
\fB\fBzpool import\fR [\fB-o\fR \fImntopts\fR] [ \fB-o\fR \fIproperty\fR=\fIvalue\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR] [\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] \fIpool\fR | \fIid\fR [\fInewpool\fR]\fR
1237
\fB\fBzpool import\fR [\fB-o\fR \fImntopts\fR] [ \fB-o\fR \fIproperty\fR=\fIvalue\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR] [\fB-D\fR] [\fB-f\fR] [\fB-m\fR] [\fB-R\fR \fIroot\fR] [\fB-F\fR [\fB-n\fR]] \fIpool\fR | \fIid\fR [\fInewpool\fR]\fR
1084 1238
.ad
1085 1239
.sp .6
1086 1240
.RS 4n
......
1157 1311
.ne 2
1158 1312
.mk
1159 1313
.na
1314
\fB\fB-F\fR\fR
1315
.ad
1316
.sp .6
1317
.RS 4n
1318
Recovery mode for a non-importable pool. Attempt to return the pool to an importable state by discarding the last few transactions. Not all damaged pools can be recovered by using this option. If successful, the data from the discarded transactions is irretrievably lost. This option is ignored if the pool is importable or already imported.
1319
.RE
1320

  
1321
.sp
1322
.ne 2
1323
.mk
1324
.na
1160 1325
\fB\fB-R\fR \fIroot\fR\fR
1161 1326
.ad
1162 1327
.sp .6
......
1164 1329
Sets the "\fBcachefile\fR" property to "\fBnone\fR" and the "\fIaltroot\fR" property to "\fIroot\fR".
1165 1330
.RE
1166 1331

  
1332
.sp
1333
.ne 2
1334
.mk
1335
.na
1336
\fB\fB-n\fR\fR
1337
.ad
1338
.sp .6
1339
.RS 4n
1340
Used with the \fB-F\fR recovery option. Determines whether a non-importable pool can be made importable again, but does not actually perform the pool recovery. For more details about pool recovery mode, see the \fB-F\fR option, above.
1341
.RE
1342

  
1343
.sp
1344
.ne 2
1345
.mk
1346
.na
1347
\fB\fB-m\fR\fR
1348
.ad
1349
.sp .6
1350
.RS 4n
1351
Allows a pool to import when there is a missing log device.
1352
.RE
1353

  
1167 1354
.RE
1168 1355

  
1169 1356
.sp
1170 1357
.ne 2
1171 1358
.mk
1172 1359
.na
1173
\fB\fBzpool iostat\fR [\fB-T\fR \fBu\fR | \fBd\fR] [\fB-v\fR] [\fIpool\fR] ... [\fIinterval\fR[\fIcount\fR]]\fR
1360
\fB\fBzpool iostat\fR [\fB-T\fR \fBd\fR|\fBu\fR] [\fB-v\fR] [\fIpool\fR] \&... [\fIinterval\fR[\fIcount\fR]]\fR
1174 1361
.ad
1175 1362
.sp .6
1176 1363
.RS 4n
......
1179 1366
.ne 2
1180 1367
.mk
1181 1368
.na
1182
\fB\fB-T\fR \fBu\fR | \fBd\fR\fR
1369
\fB\fB-T\fR \fBd\fR|\fBu\fR\fR
1183 1370
.ad
1184
.RS 12n
1185
.rt  
1371
.sp .6
1372
.RS 4n
1186 1373
Display a time stamp.
1187 1374
.sp
1188
Specify \fBu\fR for a printed representation of the internal representation of time. See \fBtime\fR(2). Specify \fBd\fR for standard date format. See \fBdate\fR(1).
1375
Specify \fBd\fR for standard date format. See \fBdate\fR(1). Specify \fBu\fR for a printed representation of the internal representation of time. See \fBtime\fR(2). 
1189 1376
.RE
1190 1377

  
1191 1378
.sp
......
1194 1381
.na
1195 1382
\fB\fB-v\fR\fR
1196 1383
.ad
1197
.RS 12n
1198
.rt  
1384
.sp .6
1385
.RS 4n
1199 1386
Verbose statistics. Reports usage statistics for individual \fIvdevs\fR within the pool, in addition to the pool-wide statistics.
1200 1387
.RE
1201 1388

  
......
1205 1392
.ne 2
1206 1393
.mk
1207 1394
.na
1208
\fB\fBzpool list\fR [\fB-H\fR] [\fB-o\fR \fIprops\fR[,...]] [\fIpool\fR] ...\fR
1395
\fB\fBzpool list\fR [\fB-H\fR] [\fB-o\fR \fIprops\fR[,...]] [\fB-T\fR \fBd\fR|\fBu\fR] [\fIpool\fR] ...\fR
1209 1396
.ad
1210 1397
.sp .6
1211 1398
.RS 4n
1212 1399
Lists the given pools along with a health status and space usage. When given no arguments, all pools in the system are listed.
1213 1400
.sp
1401
When given an interval, the status and space usage are displayed every \fIinterval\fR seconds until Ctrl-C is entered. If \fIcount\fR is specified, the command exits after \fIcount\fR reports are displayed.
1402
.sp
1214 1403
.ne 2
1215 1404
.mk
1216 1405
.na
1217 1406
\fB\fB-H\fR\fR
1218 1407
.ad
1219
.RS 12n
1220
.rt  
1408
.sp .6
1409
.RS 4n
1221 1410
Scripted mode. Do not display headers, and separate fields by a single tab instead of arbitrary space.
1222 1411
.RE
1223 1412

  
......
1227 1416
.na
1228 1417
\fB\fB-o\fR \fIprops\fR\fR
1229 1418
.ad
1230
.RS 12n
1231
.rt  
1232
Comma-separated list of properties to display. See the "Properties" section for a list of valid properties. The default list is "name, size, used, available, capacity, health, altroot"
1419
.sp .6
1420
.RS 4n
1421
Comma-separated list of properties to display. See the "Properties" section for a list of valid properties. The default list is \fBname\fR, \fBsize\fR, \fBallocated\fR, \fBfree\fR, \fBcapacity\fR, \fBhealth\fR, \fBaltroot\fR.
1422
.RE
1423

  
1424
.sp
1425
.ne 2
1426
.mk
1427
.na
1428
\fB\fB-T\fR \fBd\fR|\fBu\fR\fR
1429
.ad
1430
.sp .6
1431
.RS 4n
1432
Display a time stamp.
1433
.sp
1434
Specify \fBd\fR for standard date format. See \fBdate\fR(1). Specify \fBu\fR for a printed representation of the internal representation of time. See \fBtime\fR(2). 
1233 1435
.RE
1234 1436

  
1235 1437
.RE
......
1251 1453
.na
1252 1454
\fB\fB-t\fR\fR
1253 1455
.ad
1254
.RS 6n
1255
.rt  
1456
.sp .6
1457
.RS 4n
1256 1458
Temporary. Upon reboot, the specified physical device reverts to its previous state.
1257 1459
.RE
1258 1460

  
......
1275 1477
.na
1276 1478
\fB\fB-e\fR\fR
1277 1479
.ad
1278
.RS 6n
1279
.rt  
1480
.sp .6
1481
.RS 4n
1280 1482
Expand the device to use all available space. If the device is part of a mirror or \fBraidz\fR then all devices must be expanded before the new space will become available to the pool.
1281 1483
.RE
1282 1484

  
......
1307 1509
.sp
1308 1510
\fInew_device\fR is required if the pool is not redundant. If \fInew_device\fR is not specified, it defaults to \fIold_device\fR. This form of replacement is useful after an existing disk has failed and has been physically replaced. In this case, the new disk may have the same \fB/dev/dsk\fR path as the old device, even though it is actually a different disk. \fBZFS\fR recognizes this.
1309 1511
.sp
1512
In \fBzpool status\fR output, the \fIold_device\fR is shown under the word \fBreplacing\fR with the string \fB/old\fR appended to it. Once the resilver completes, both the \fBreplacing\fR and the \fIold_device\fR are automatically removed.  If the new device fails before the resilver completes and a third device  is installed in its place, then both failed devices will show up with \fB/old\fR appended, and the resilver starts over again. After the resilver completes, both \fB/old\fR devices are removed along with the word \fBreplacing\fR.
1513
.sp
1310 1514
.ne 2
1311 1515
.mk
1312 1516
.na
1313 1517
\fB\fB-f\fR\fR
1314 1518
.ad
1315
.RS 6n
1316
.rt  
1519
.sp .6
1520
.RS 4n
1317 1521
Forces use of \fInew_device\fR, even if its appears to be in use. Not all devices can be overridden in this manner.
1318 1522
.RE
1319 1523

  
......
1331 1535
.sp
1332 1536
Scrubbing and resilvering are very similar operations. The difference is that resilvering only examines data that \fBZFS\fR knows to be out of date (for example, when attaching a new device to a mirror or replacing an existing device), whereas scrubbing examines all data to discover silent errors due to hardware faults or disk failure.
1333 1537
.sp
1334
Because scrubbing and resilvering are \fBI/O\fR-intensive operations, \fBZFS\fR only allows one at a time. If a scrub is already in progress, the "\fBzpool scrub\fR" command terminates it and starts a new scrub. If a resilver is in progress, \fBZFS\fR does not allow a scrub to be started until the resilver completes.
1538
Because scrubbing and resilvering are \fBI/O\fR-intensive operations, \fBZFS\fR allows only one at a time. If a scrub is already in progress, a subsequent "\fBzpool scrub\fR" returns an error, with the advice to use \fBzpool scrub\fR \fB-s\fR to cancel the current scrub. If a resilver is in progress, \fBZFS\fR does not allow a scrub to be started until the resilver completes.
1335 1539
.sp
1336 1540
.ne 2
1337 1541
.mk
1338 1542
.na
1339 1543
\fB\fB-s\fR\fR
1340 1544
.ad
1341
.RS 6n
1342
.rt  
1545
.sp .6
1546
.RS 4n
1343 1547
Stop scrubbing.
1344 1548
.RE
1345 1549

  
......
1360 1564
.ne 2
1361 1565
.mk
1362 1566
.na
1363
\fB\fBzpool status\fR [\fB-xv\fR] [\fIpool\fR] ...\fR
1567
\fB\fBzpool split\fR [\fB-R\fR \fIaltroot\fR] [\fB-n\fR] [\fB-o\fR \fImntopts\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] \fIpool\fR \fInewpool\fR [\fIdevice\fR ...]\fR
1568
.ad
1569
.sp .6
1570
.RS 4n
1571
Splits off one disk from each mirrored top-level vdev in a pool and creates a new pool from the split-off disks. The original pool must be made up of one or more mirrors and must not be in the process of resilvering. The \fBsplit\fR subcommand chooses the last device in each mirror vdev unless overridden by a device specification on the command line.
1572
.sp
1573
When using a \fIdevice\fR argument, \fBsplit\fR includes the specified device(s) in a new pool and, should any devices remain unspecified, assigns the last device in each mirror vdev to that pool, as it does normally. If you are uncertain about the outcome of a \fBsplit\fR command, use the \fB-n\fR ("dry-run") option to ensure your command will have the effect you intend.
1574
.sp
1575
.ne 2
1576
.mk
1577
.na
1578
\fB\fB-R\fR \fIaltroot\fR\fR
1579
.ad
1580
.sp .6
1581
.RS 4n
1582
Automatically import the newly created pool after splitting, using the specified \fIaltroot\fR parameter for the new pool's alternate root. See the \fBaltroot\fR description in the "Properties" section, above.
1583
.RE
1584

  
1585
.sp
1586
.ne 2
1587
.mk
1588
.na
1589
\fB\fB-n\fR\fR
1590
.ad
1591
.sp .6
1592
.RS 4n
1593
Displays the configuration that would be created without actually splitting the pool. The actual pool split could still fail due to insufficient privileges or device status.
1594
.RE
1595

  
1596
.sp
1597
.ne 2
1598
.mk
1599
.na
1600
\fB\fB-o\fR \fImntopts\fR\fR
1601
.ad
1602
.sp .6
1603
.RS 4n
1604
Comma-separated list of mount options to use when mounting datasets within the pool. See \fBzfs\fR(1M) for a description of dataset properties and mount options. Valid only in conjunction with the \fB-R\fR option.
1605
.RE
1606

  
1607
.sp
1608
.ne 2
1609
.mk
1610
.na
1611
\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1612
.ad
1613
.sp .6
1614
.RS 4n
1615
Sets the specified property on the new pool. See the "Properties" section, above, for more information on the available pool properties.
1616
.RE
1617

  
1618
.RE
1619

  
1620
.sp
1621
.ne 2
1622
.mk
1623
.na
1624
\fB\fBzpool status\fR [\fB-xv\fR] [\fB-T\fR \fBd\fR|\fBu\fR] [\fIpool\fR] ...  [\fIinterval\fR[\fIcount\fR]]\fR
1364 1625
.ad
1365 1626
.sp .6
1366 1627
.RS 4n
1367 1628
Displays the detailed health status for the given pools. If no \fIpool\fR is specified, then the status of each pool in the system is displayed. For more information on pool and device health, see the "Device Failure and Recovery" section.
1368 1629
.sp
1630
When given an interval, the status and space usage are displayed every \fIinterval\fR seconds until Ctrl-C is entered. If \fIcount\fR is specified, the command exits after \fIcount\fR reports are displayed.
1631
.sp
1369 1632
If a scrub or resilver is in progress, this command reports the percentage done and the estimated time to completion. Both of these are only approximate, because the amount of data in the pool and the other workloads on the system can change.
1370 1633
.sp
1371 1634
.ne 2
......
1373 1636
.na
1374 1637
\fB\fB-x\fR\fR
1375 1638
.ad
1376
.RS 6n
1377
.rt  
1639
.sp .6
1640
.RS 4n
1378 1641
Only display status for pools that are exhibiting errors or are otherwise unavailable.
1379 1642
.RE
1380 1643

  
......
1384 1647
.na
1385 1648
\fB\fB-v\fR\fR
1386 1649
.ad
1387
.RS 6n
1388
.rt  
1650
.sp .6
1651
.RS 4n
1389 1652
Displays verbose data error information, printing out a complete list of all data errors since the last complete pool scrub.
1390 1653
.RE
1391 1654

  
1655
.sp
1656
.ne 2
1657
.mk
1658
.na
1659
\fB\fB-T\fR \fBd\fR|\fBu\fR\fR
1660
.ad
1661
.sp .6
1662
.RS 4n
1663
Display a time stamp.
1664
.sp
1665
Specify \fBd\fR for standard date format. See \fBdate\fR(1). Specify \fBu\fR for a printed representation of the internal representation of time. See \fBtime\fR(2). 
1666
.RE
1667

  
1392 1668
.RE
1393 1669

  
1394 1670
.sp
......
1399 1675
.ad
1400 1676
.sp .6
1401 1677
.RS 4n
1402
Displays all pools formatted using a different \fBZFS\fR on-disk version. Older versions can continue to be used, but some features may not be available. These pools can be upgraded using "\fBzpool upgrade -a\fR". Pools that are formatted with a more recent version are also displayed, although these pools will be inaccessible on the system.
1678
Identifies a pool's on-disk version, which determines available pool features in the currently running software release. You can continue to use older pool versions, but some features might not be available. A pool can be upgraded by using the \fBzpool upgrade\fR \fB-a\fR command. You will not be able to access a pool of a later version on a system that runs an earlier software version.
1403 1679
.RE
1404 1680

  
1405 1681
.sp
......
1410 1686
.ad
1411 1687
.sp .6
1412 1688
.RS 4n
1413
Displays \fBZFS\fR versions supported by the current software. The current \fBZFS\fR versions and all previous supported versions are displayed, along with an explanation of the features provided with each version.
1689
Displays \fBZFS\fR pool versions supported by the current software. The current \fBZFS\fR pool versions and all previous supported versions are displayed, along with an explanation of the features provided with each version.
1414 1690
.RE
1415 1691

  
1416 1692
.sp
......
1421 1697
.ad
1422 1698
.sp .6
1423 1699
.RS 4n
1424
Upgrades the given pool to the latest on-disk version. Once this is done, the pool will no longer be accessible on systems running older versions of the software.
1700
Upgrades the specified pool to the latest on-disk version. If this command reveals that a pool is out-of-date, the pool can subsequently be upgraded using the \fBzpool upgrade\fR \fB-a\fR command. A pool that is upgraded will not be accessible on a system that runs an earlier software release.
1425 1701
.sp
1426 1702
.ne 2
1427 1703
.mk
1428 1704
.na
1429 1705
\fB\fB-a\fR\fR
1430 1706
.ad
1431
.RS 14n
1432
.rt  
1707
.sp .6
1708
.RS 4n
1433 1709
Upgrades all pools.
1434 1710
.RE
1435 1711

  
......
1439 1715
.na
1440 1716
\fB\fB-V\fR \fIversion\fR\fR
1441 1717
.ad
1442
.RS 14n
1443
.rt  
1444
Upgrade to the specified version. If the \fB-V\fR flag is not specified, the pool is upgraded to the most recent version. This option can only be used to increase the version number, and only up to the most recent version supported by this software.
1718
.sp .6
1719
.RS 4n
1720
Upgrade to the specified version, which must be higher than the current version. If the \fB-V\fR flag is not specified, the pool is upgraded to the most recent version.
1445 1721
.RE
1446 1722

  
1447 1723
.RE
......
1521 1797
\fBExample 6 \fRListing Available ZFS Storage Pools
1522 1798
.sp
1523 1799
.LP
1524
The following command lists all available pools on the system. In this case, the pool \fIzion\fR is faulted due to a missing device.
1800
The following command lists all available pools on the system.
1801

  
1802
.sp
1803
.in +2
1804
.nf
1805
# \fBzpool list\fR
1806
NAME    SIZE  ALLOC   FREE    CAP  DEDUP  HEALTH  ALTROOT
1807
pool    136G   109M   136G     0%  3.00x  ONLINE  -
1808
rpool  67.5G  12.6G  54.9G    18%  1.01x  ONLINE  -
1809
.fi
1810
.in -2
1811
.sp
1525 1812

  
1813
.LP
1814
\fBExample 7 \fRListing All Properties for a Pool
1526 1815
.sp
1527 1816
.LP
1528
The results from this command are similar to the following:
1817
The following command lists all the properties for a pool.
1529 1818

  
1530 1819
.sp
1531 1820
.in +2
1532 1821
.nf
1533
# \fBzpool list\fR
1534
     NAME              SIZE    USED   AVAIL    CAP  HEALTH     ALTROOT
1535
     pool             67.5G   2.92M   67.5G     0%  ONLINE     -
1536
     tank             67.5G   2.92M   67.5G     0%  ONLINE     -
1537
     zion                 -       -       -     0%  FAULTED    -
1822
% \fBzpool get all pool\fR
1823
NAME  PROPERTY       VALUE       SOURCE
1824
pool  size           464G        -
1825
pool  capacity       0%          -
1826
pool  altroot        -           default
1827
pool  health         ONLINE      -
1828
pool  guid           9893442355858802973  default
1829
pool  version        23          default
1830
pool  bootfs         -           default
1831
pool  delegation     on          default
1832
pool  autoreplace    off         default
1833
pool  cachefile      -           default
1834
pool  failmode       wait        default
1835
pool  listsnapshots  off         default
1836
pool  autoexpand     off         default
1837
pool  dedupditto     0           default
1838
pool  dedupratio     1.00x       -
1839
pool  free           464G        -
1840
pool  allocated      130K        -
1538 1841
.fi
1539 1842
.in -2
1540 1843
.sp
1541 1844

  
1542 1845
.LP
1543
\fBExample 7 \fRDestroying a ZFS Storage Pool
1846
\fBExample 8 \fRDestroying a ZFS Storage Pool
1544 1847
.sp
1545 1848
.LP
1546 1849
The following command destroys the pool "\fItank\fR" and any datasets contained within.
......
1554 1857
.sp
1555 1858

  
1556 1859
.LP
1557
\fBExample 8 \fRExporting a ZFS Storage Pool
1860
\fBExample 9 \fRExporting a ZFS Storage Pool
1558 1861
.sp
1559 1862
.LP
1560 1863
The following command exports the devices in pool \fItank\fR so that they can be relocated or later imported.
......
1568 1871
.sp
1569 1872

  
1570 1873
.LP
1571
\fBExample 9 \fRImporting a ZFS Storage Pool
1874
\fBExample 10 \fRImporting a ZFS Storage Pool
1572 1875
.sp
1573 1876
.LP
1574 1877
The following command displays available pools, and then imports the pool "tank" for use on the system.
......
1582 1885
.nf
1583 1886
# \fBzpool import\fR
1584 1887
  pool: tank
1585
    id: 15451357997522795478
1888
    id: 7678868315469843843
1586 1889
 state: ONLINE
1587 1890
action: The pool can be imported using its name or numeric identifier.
1588 1891
config:
1589 1892

  
1590
        tank        ONLINE
1591
          mirror    ONLINE
1893
              tank  ONLINE
1894
          mirror-0  ONLINE
1592 1895
            c1t2d0  ONLINE
1593 1896
            c1t3d0  ONLINE
1594 1897

  
......
1598 1901
.sp
1599 1902

  
1600 1903
.LP
1601
\fBExample 10 \fRUpgrading All ZFS Storage Pools to the Current Version
1904
\fBExample 11 \fRUpgrading All ZFS Storage Pools to the Current Version
1602 1905
.sp
1603 1906
.LP
1604 1907
The following command upgrades all ZFS Storage pools to the current version of the software.
......
1607 1910
.in +2
1608 1911
.nf
1609 1912
# \fBzpool upgrade -a\fR
1610
This system is currently running ZFS version 2.
1913
This system is currently running ZFS pool version 22.
1914

  
1915
All pools are formatted using this version.
1611 1916
.fi
1612 1917
.in -2
1613 1918
.sp
1614 1919

  
1615 1920
.LP
1616
\fBExample 11 \fRManaging Hot Spares
1921
\fBExample 12 \fRManaging Hot Spares
1617 1922
.sp
1618 1923
.LP
1619 1924
The following command creates a new pool with an available hot spare:
......
1640 1945

  
1641 1946
.sp
1642 1947
.LP
1643
Once the data has been resilvered, the spare is automatically removed and is made available should another device fails. The hot spare can be permanently removed from the pool using the following command:
1948
After the device has been resilvered, the spare is automatically detached and is made available should another device fail. The hot spare can be permanently removed from the pool using the following command:
1644 1949

  
1645 1950
.sp
1646 1951
.in +2
......
1651 1956
.sp
1652 1957

  
1653 1958
.LP
1654
\fBExample 12 \fRCreating a ZFS Pool with Mirrored Separate Intent Logs
1959
\fBExample 13 \fRCreating a ZFS Pool with Mirrored Separate Intent Logs
1655 1960
.sp
1656 1961
.LP
1657 1962
The following command creates a ZFS storage pool consisting of two, two-way mirrors and mirrored log devices:
......
1666 1971
.sp
1667 1972

  
1668 1973
.LP
1669
\fBExample 13 \fRAdding Cache Devices to a ZFS Pool
1974
\fBExample 14 \fRAdding Cache Devices to a ZFS Pool
1670 1975
.sp
1671 1976
.LP
1672 1977
The following command adds two disks for use as cache devices to a ZFS storage pool:
......
1692 1997
.sp
1693 1998

  
1694 1999
.LP
1695
\fBExample 14 \fRRemoving a Mirrored Log Device
2000
\fBExample 15 \fRRemoving a Mirrored Log Device
1696 2001
.sp
1697 2002
.LP
1698 2003
The following command removes the mirrored log device \fBmirror-2\fR.
......
1737 2042
.in -2
1738 2043
.sp
1739 2044

  
2045
.LP
2046
\fBExample 16 \fRRecovering a Faulted ZFS Pool
2047
.sp
2048
.LP
2049
If a pool is faulted but recoverable, a message indicating this state is provided by \fBzpool status\fR if the pool was cached (see \fBcachefile\fR above), or as part of the error output from a failed \fBzpool import\fR of the pool.
2050

  
2051
.sp
2052
.LP
2053
Recover a cached pool with the \fBzpool clear\fR command:
2054

  
2055
.sp
2056
.in +2
2057
.nf
2058
# \fBzpool clear -F data\fR
2059
Pool data returned to its state as of Tue Sep 08 13:23:35 2009.
2060
Discarded approximately 29 seconds of transactions.
2061
.fi
2062
.in -2
2063
.sp
2064

  
2065
.sp
2066
.LP
2067
If the pool configuration was not cached, use \fBzpool import\fR with the recovery mode flag:
2068

  
2069
.sp
2070
.in +2
2071
.nf
2072
# \fBzpool import -F data\fR
2073
Pool data returned to its state as of Tue Sep 08 13:23:35 2009.
2074
Discarded approximately 29 seconds of transactions.
2075
.fi
2076
.in -2
2077
.sp
2078

  
2079
.LP
2080
\fBExample 17 \fRImporting with a Single Intent Log Device
2081
.sp
2082
.LP
2083
The following sequence of commands attempts to import a pool with a missing device, then employs the \fB-m\fR option to complete the import operation.
2084

  
2085
.sp
2086
.in +2
2087
.nf
2088
# \fBzpool import\fR
2089
  pool: tank
2090
    id: 429789444028972405
2091
 state: UNAVAIL
2092
status: One or more devices are missing from the system.
2093
action: The pool cannot be imported. Attach the missing
2094
        devices and try again.
2095
   see: http://www.sun.com/msg/ZFS-8000-6X
2096
config:
2097

  
2098
        tank         UNAVAIL  missing device
2099
          c7t0d0     ONLINE
2100
.fi
2101
.in -2
2102
.sp
2103

  
2104
.sp
2105
.LP
2106
Additional devices are known to be part of this pool, though their exact configuration cannot be determined.
2107

  
2108
.sp
2109
.in +2
2110
.nf
2111
# \fBzpool import tank\fR
2112
The devices below are missing, use '-m' to import the pool anyway:
2113
             c5t0d0 [log]
2114

  
2115
cannot import 'tank': one or more devices is currently unavailable
2116

  
2117
# \fBzpool import -m tank\fR
2118
# \fBzpool status tank\fR
2119
   pool: tank
2120
  state: DEGRADED
2121
status: One or more devices could not be opened.  Sufficient replicas
2122
exist for
2123
         the pool to continue functioning in a degraded state.
2124
action: Attach the missing device and online it using 'zpool online'.
2125
    see: http://www.sun.com/msg/ZFS-8000-2Q
2126
   scan: none requested
2127
config:
2128

  
2129
         NAME                   STATE     READ WRITE CKSUM
2130
         tank                   DEGRADED     0     0     0
2131
           c7t0d0               ONLINE       0     0     0
2132
         logs
2133
           1693927398582730352  UNAVAIL      0     0     0  was 
2134
/dev/dsk/c5t0d0
2135

  
2136
errors: No known data errors
2137
.fi
2138
.in -2
2139
.sp
2140

  
2141
.LP
2142
\fBExample 18 \fRImporting with a Mirrored Intent Log Device
2143
.sp
2144
.LP
2145
The following sequence of commands attempts to import a pool when a mirrored log device is unavailable, then employs the \fB-m\fR option to complete the import operation.
2146

  
2147
.sp
2148
.in +2
2149
.nf
2150
# \fBzpool import\fR
2151
  pool: tank
2152
    id: 429789444028972405
2153
 state: UNAVAIL
2154
status: One or more devices are missing from the system.
2155
action: The pool cannot be imported. Attach the missing
2156
        devices and try again.
2157
   see: http://www.sun.com/msg/ZFS-8000-6X
2158
config:
2159

  
2160
        tank         UNAVAIL  missing device
2161
          c7t0d0     ONLINE
2162
.fi
2163
.in -2
2164
.sp
2165

  
2166
.sp
2167
.LP
2168
Additional devices are known to be part of this pool, though their exact configuration cannot be determined.
2169

  
2170
.sp
2171
.in +2
2172
.nf
2173
# \fBzpool import tank\fR
2174
The devices below are missing, use '-m' to import the pool anyway:
2175
             mirror-1 [log]
2176
               c5t0d0
2177
               c5t1d0
2178

  
2179
# \fBzpool import -m tank\fR
2180

  
2181
# \fBzpool status tank\fR
2182
   pool: tank
2183
  state: DEGRADED
2184
status: One or more devices could not be opened.  Sufficient replicas
2185
exist for
2186
         the pool to continue functioning in a degraded state.
2187
action: Attach the missing device and online it using 'zpool online'.
2188
    see: http://www.sun.com/msg/ZFS-8000-2Q
2189
   scan: none requested
2190
config:
2191

  
2192
         NAME                      STATE     READ WRITE CKSUM
2193
         tank                      DEGRADED     0     0     0
2194
           c7t0d0                  ONLINE       0     0     0
2195
         logs
2196
           mirror-1                UNAVAIL      0     0     0
2197
insufficient replicas
2198
             46385995713041169     UNAVAIL      0     0     0  was
2199
/dev/dsk/c5t0d0
2200
             13821442324672734438  UNAVAIL      0     0     0  was
2201
/dev/dsk/c5t1d0
2202

  
2203
errors: No known data errors
2204
.fi
2205
.in -2
2206
.sp
2207

  
1740 2208
.SH EXIT STATUS
1741 2209
.sp
1742 2210
.LP
......
1747 2215
.na
1748 2216
\fB\fB0\fR\fR
1749 2217
.ad
1750
.RS 5n
1751
.rt  
... This diff was truncated because it exceeds the maximum size that can be displayed.
(7-7/8)