Project

General

Profile

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

zpool.1m diff between sunosman-20090930 and OpenSolaris snv_134 - Martin Matuška, 2011-11-21 11:07 AM

View differences:

zpool.1m 2011-11-21 10:46:51.037654845 +0100
1 1
'\" te
2
.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
2
.\" Copyright (c) 2010, Sun Microsystems, Inc. All Rights Reserved.
3 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 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 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"
6
.TH zpool 1M "4 Jan 2010" "SunOS 5.11" "System Administration Commands"
7 7
.SH NAME
8 8
zpool \- configures ZFS storage pools
9 9
.SH SYNOPSIS
......
24 24

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

  
30 30
.LP
......
66 66
.LP
67 67
.nf
68 68
\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
69
     [\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] [\fB-F\fR [\fB-n\fR]] \fB-a\fR
70 70
.fi
71 71

  
72 72
.LP
73 73
.nf
74 74
\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]
75
     [\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] [\fB-F\fR [\fB-n\fR]] \fIpool\fR |\fIid\fR [\fInewpool\fR]
76 76
.fi
77 77

  
78 78
.LP
......
117 117

  
118 118
.LP
119 119
.nf
120
\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
121
     \fInewpool\fR [\fIdevice\fR ...]
122
.fi
123

  
124
.LP
125
.nf
120 126
\fBzpool status\fR [\fB-xv\fR] [\fIpool\fR] ...
121 127
.fi
122 128

  
......
152 158
.na
153 159
\fB\fBdisk\fR\fR
154 160
.ad
155
.RS 10n
156
.rt  
161
.sp .6
162
.RS 4n
157 163
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.
158 164
.RE
159 165

  
......
163 169
.na
164 170
\fB\fBfile\fR\fR
165 171
.ad
166
.RS 10n
167
.rt  
172
.sp .6
173
.RS 4n
168 174
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 175
.RE
170 176

  
......
174 180
.na
175 181
\fB\fBmirror\fR\fR
176 182
.ad
177
.RS 10n
178
.rt  
183
.sp .6
184
.RS 4n
179 185
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 186
.RE
181 187

  
......
197 203
.na
198 204
\fB\fBraidz3\fR\fR
199 205
.ad
200
.RS 10n
201
.rt  
206
.sp .6
207
.RS 4n
202 208
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 209
.sp
204 210
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 218
.na
213 219
\fB\fBspare\fR\fR
214 220
.ad
215
.RS 10n
216
.rt  
221
.sp .6
222
.RS 4n
217 223
A special pseudo-\fBvdev\fR which keeps track of available hot spares for a pool. For more information, see the "Hot Spares" section.
218 224
.RE
219 225

  
......
223 229
.na
224 230
\fB\fBlog\fR\fR
225 231
.ad
226
.RS 10n
227
.rt  
232
.sp .6
233
.RS 4n
228 234
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 235
.RE
230 236

  
......
234 240
.na
235 241
\fB\fBcache\fR\fR
236 242
.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.
243
.sp .6
244
.RS 4n
245
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 246
.RE
241 247

  
242 248
.sp
......
275 281
.na
276 282
\fB\fBDEGRADED\fR\fR
277 283
.ad
278
.RS 12n
279
.rt  
284
.sp .6
285
.RS 4n
280 286
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 287
.sp
282 288
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 306
.na
301 307
\fB\fBFAULTED\fR\fR
302 308
.ad
303
.RS 12n
304
.rt  
309
.sp .6
310
.RS 4n
305 311
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 312
.sp
307 313
One or more component devices is in the faulted state, and insufficient replicas exist to continue functioning. The underlying conditions are as follows:
......
325 331
.na
326 332
\fB\fBOFFLINE\fR\fR
327 333
.ad
328
.RS 12n
329
.rt  
334
.sp .6
335
.RS 4n
330 336
The device was explicitly taken offline by the "\fBzpool offline\fR" command.
331 337
.RE
332 338

  
......
336 342
.na
337 343
\fB\fBONLINE\fR\fR
338 344
.ad
339
.RS 12n
340
.rt  
345
.sp .6
346
.RS 4n
341 347
The device is online and functioning.
342 348
.RE
343 349

  
......
347 353
.na
348 354
\fB\fBREMOVED\fR\fR
349 355
.ad
350
.RS 12n
351
.rt  
356
.sp .6
357
.RS 4n
352 358
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 359
.RE
354 360

  
......
358 364
.na
359 365
\fB\fBUNAVAIL\fR\fR
360 366
.ad
361
.RS 12n
362
.rt  
367
.sp .6
368
.RS 4n
363 369
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 370
.RE
365 371

  
366 372
.sp
367 373
.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.
374
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 375
.SS "Hot Spares"
370 376
.sp
371 377
.LP
......
373 379
.sp
374 380
.in +2
375 381
.nf
376
# zpool create pool mirror c0d0 c1d0 spare c2d0 c3d0
382
# \fBzpool create pool mirror c0d0 c1d0 spare c2d0 c3d0\fR
377 383
.fi
378 384
.in -2
379 385
.sp
......
397 403
.sp
398 404
.in +2
399 405
.nf
400
\fB# zpool create pool c0d0 c1d0 log c2d0\fR
406
# \fBzpool create pool c0d0 c1d0 log c2d0\fR
401 407
.fi
402 408
.in -2
403 409
.sp
......
418 424
.sp
419 425
.in +2
420 426
.nf
421
\fB# zpool create pool c0d0 c1d0 cache c2d0 c3d0\fR
427
# \fBzpool create pool c0d0 c1d0 cache c2d0 c3d0\fR
422 428
.fi
423 429
.in -2
424 430
.sp
......
429 435
.sp
430 436
.LP
431 437
The content of the cache devices is considered volatile, as is the case with other system caches.
438
.SS "Processes"
439
.sp
440
.LP
441
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 442
.SS "Properties"
433 443
.sp
434 444
.LP
......
437 447
.ne 2
438 448
.mk
439 449
.na
440
\fB\fBavailable\fR\fR
450
\fB\fBalloc\fR\fR
441 451
.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".
452
.sp .6
453
.RS 4n
454
Amount of storage space within the pool that has been physically allocated.
445 455
.RE
446 456

  
447 457
.sp
......
450 460
.na
451 461
\fB\fBcapacity\fR\fR
452 462
.ad
453
.RS 20n
454
.rt  
463
.sp .6
464
.RS 4n
455 465
Percentage of pool space used. This property can also be referred to by its shortened column name, "cap".
456 466
.RE
457 467

  
......
459 469
.ne 2
460 470
.mk
461 471
.na
462
\fB\fBhealth\fR\fR
472
\fB\fBdedupratio\fR\fR
463 473
.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".
474
.sp .6
475
.RS 4n
476
The deduplication ratio specified for a pool, expressed  as a multiplier. Deduplication can be turned on by entering the command:
477
.sp
478
.in +2
479
.nf
480
# \fBzfs set dedup=on \fIdataset\fR\fR
481
.fi
482
.in -2
483
.sp
484

  
485
The default value is \fBoff\fR.
486
.sp
487
\fBdedupratio\fR is expressed as a single decimal number. For example, a \fBdedupratio\fR value of 1.76 indicates that 1.76 units of data were stored but only 1 unit of disk space was actually consumed.
488
.RE
489

  
490
.sp
491
.ne 2
492
.mk
493
.na
494
\fB\fBfree\fR\fR
495
.ad
496
.sp .6
497
.RS 4n
498
Number of blocks within the pool that are not allocated. 
467 499
.RE
468 500

  
469 501
.sp
......
472 504
.na
473 505
\fB\fBguid\fR\fR
474 506
.ad
475
.RS 20n
476
.rt  
507
.sp .6
508
.RS 4n
477 509
A unique identifier for the pool.
478 510
.RE
479 511

  
......
481 513
.ne 2
482 514
.mk
483 515
.na
484
\fB\fBsize\fR\fR
516
\fB\fBhealth\fR\fR
485 517
.ad
486
.RS 20n
487
.rt  
488
Total size of the storage pool.
518
.sp .6
519
.RS 4n
520
The current health of the pool. Health can be "\fBONLINE\fR", "\fBDEGRADED\fR", "\fBFAULTED\fR", " \fBOFFLINE\fR", "\fBREMOVED\fR", or "\fBUNAVAIL\fR".
489 521
.RE
490 522

  
491 523
.sp
492 524
.ne 2
493 525
.mk
494 526
.na
495
\fB\fBused\fR\fR
527
\fB\fBsize\fR\fR
496 528
.ad
497
.RS 20n
498
.rt  
499
Amount of storage space used within the pool.
529
.sp .6
530
.RS 4n
531
Total size of the storage pool.
500 532
.RE
501 533

  
502 534
.sp
......
591 623
.na
592 624
\fB\fBwait\fR\fR
593 625
.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.
626
.sp .6
627
.RS 4n
628
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 629
.RE
598 630

  
599 631
.sp
......
602 634
.na
603 635
\fB\fBcontinue\fR\fR
604 636
.ad
605
.RS 12n
606
.rt  
637
.sp .6
638
.RS 4n
607 639
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 640
.RE
609 641

  
......
613 645
.na
614 646
\fB\fBpanic\fR\fR
615 647
.ad
616
.RS 12n
617
.rt  
648
.sp .6
649
.RS 4n
618 650
Prints out a message to the console and generates a system crash dump.
619 651
.RE
620 652

  
......
675 707
.na
676 708
\fB\fB-f\fR\fR
677 709
.ad
678
.RS 6n
679
.rt  
710
.sp .6
711
.RS 4n
680 712
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 713
.RE
682 714

  
......
686 718
.na
687 719
\fB\fB-n\fR\fR
688 720
.ad
689
.RS 6n
690
.rt  
721
.sp .6
722
.RS 4n
691 723
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 724
.RE
693 725

  
......
709 741
.na
710 742
\fB\fB-f\fR\fR
711 743
.ad
712
.RS 6n
713
.rt  
744
.sp .6
745
.RS 4n
714 746
Forces use of \fInew_device\fR, even if its appears to be in use. Not all devices can be overridden in this manner.
715 747
.RE
716 748

  
......
720 752
.ne 2
721 753
.mk
722 754
.na
723
\fB\fBzpool clear\fR \fIpool\fR [\fIdevice\fR] ...\fR
755
\fB\fBzpool clear\fR [\fB-F\fR [\fB-n\fR]] \fIpool\fR [\fIdevice\fR] ...\fR
724 756
.ad
725 757
.sp .6
726 758
.RS 4n
727 759
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.
760
.sp
761
.ne 2
762
.mk
763
.na
764
\fB\fB-F\fR\fR
765
.ad
766
.sp .6
767
.RS 4n
768
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.
769
.RE
770

  
771
.sp
772
.ne 2
773
.mk
774
.na
775
\fB\fB-n\fR\fR
776
.ad
777
.sp .6
778
.RS 4n
779
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.
780
.RE
781

  
728 782
.RE
729 783

  
730 784
.sp
......
735 789
.ad
736 790
.sp .6
737 791
.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.
792
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 793
.sp
740 794
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 795
.sp
......
829 883
.na
830 884
\fB\fB-f\fR\fR
831 885
.ad
832
.RS 6n
833
.rt  
886
.sp .6
887
.RS 4n
834 888
Forces any active datasets contained within the pool to be unmounted.
835 889
.RE
836 890

  
......
866 920
.na
867 921
\fB\fB-f\fR\fR
868 922
.ad
869
.RS 6n
870
.rt  
923
.sp .6
924
.RS 4n
871 925
Forcefully unmount all datasets, using the "\fBunmount -f\fR" command.
872 926
.sp
873 927
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 967
.na
914 968
\fB\fB-i\fR\fR
915 969
.ad
916
.RS 6n
917
.rt  
970
.sp .6
971
.RS 4n
918 972
Displays internally logged \fBZFS\fR events in addition to user initiated events.
919 973
.RE
920 974

  
......
924 978
.na
925 979
\fB\fB-l\fR\fR
926 980
.ad
927
.RS 6n
928
.rt  
981
.sp .6
982
.RS 4n
929 983
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 984
.RE
931 985

  
......
948 1002
.na
949 1003
\fB\fB-c\fR \fIcachefile\fR\fR
950 1004
.ad
951
.RS 16n
952
.rt  
1005
.sp .6
1006
.RS 4n
953 1007
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 1008
.RE
955 1009

  
......
959 1013
.na
960 1014
\fB\fB-d\fR \fIdir\fR\fR
961 1015
.ad
962
.RS 16n
963
.rt  
1016
.sp .6
1017
.RS 4n
964 1018
Searches for devices or files in \fIdir\fR. The \fB-d\fR option can be specified multiple times. 
965 1019
.RE
966 1020

  
......
970 1024
.na
971 1025
\fB\fB-D\fR\fR
972 1026
.ad
973
.RS 16n
974
.rt  
1027
.sp .6
1028
.RS 4n
975 1029
Lists destroyed pools only.
976 1030
.RE
977 1031

  
......
981 1035
.ne 2
982 1036
.mk
983 1037
.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
1038
\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-F\fR [\fB-n\fR]] \fB-a\fR\fR
985 1039
.ad
986 1040
.sp .6
987 1041
.RS 4n
......
992 1046
.na
993 1047
\fB\fB-o\fR \fImntopts\fR\fR
994 1048
.ad
995
.RS 21n
996
.rt  
1049
.sp .6
1050
.RS 4n
997 1051
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 1052
.RE
999 1053

  
......
1003 1057
.na
1004 1058
\fB\fB-o\fR \fIproperty=value\fR\fR
1005 1059
.ad
1006
.RS 21n
1007
.rt  
1060
.sp .6
1061
.RS 4n
1008 1062
Sets the specified property on the imported pool. See the "Properties" section for more information on the available pool properties.
1009 1063
.RE
1010 1064

  
......
1014 1068
.na
1015 1069
\fB\fB-c\fR \fIcachefile\fR\fR
1016 1070
.ad
1017
.RS 21n
1018
.rt  
1071
.sp .6
1072
.RS 4n
1019 1073
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 1074
.RE
1021 1075

  
......
1025 1079
.na
1026 1080
\fB\fB-d\fR \fIdir\fR\fR
1027 1081
.ad
1028
.RS 21n
1029
.rt  
1082
.sp .6
1083
.RS 4n
1030 1084
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 1085
.RE
1032 1086

  
......
1036 1090
.na
1037 1091
\fB\fB-D\fR\fR
1038 1092
.ad
1039
.RS 21n
1040
.rt  
1093
.sp .6
1094
.RS 4n
1041 1095
Imports destroyed pools only. The \fB-f\fR option is also required.
1042 1096
.RE
1043 1097

  
......
1047 1101
.na
1048 1102
\fB\fB-f\fR\fR
1049 1103
.ad
1050
.RS 21n
1051
.rt  
1104
.sp .6
1105
.RS 4n
1052 1106
Forces import, even if the pool appears to be potentially active.
1053 1107
.RE
1054 1108

  
......
1056 1110
.ne 2
1057 1111
.mk
1058 1112
.na
1113
\fB\fB-F\fR\fR
1114
.ad
1115
.sp .6
1116
.RS 4n
1117
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.
1118
.RE
1119

  
1120
.sp
1121
.ne 2
1122
.mk
1123
.na
1059 1124
\fB\fB-a\fR\fR
1060 1125
.ad
1061
.RS 21n
1062
.rt  
1126
.sp .6
1127
.RS 4n
1063 1128
Searches for and imports all pools found. 
1064 1129
.RE
1065 1130

  
......
1069 1134
.na
1070 1135
\fB\fB-R\fR \fIroot\fR\fR
1071 1136
.ad
1072
.RS 21n
1073
.rt  
1137
.sp .6
1138
.RS 4n
1074 1139
Sets the "\fBcachefile\fR" property to "\fBnone\fR" and the "\fIaltroot\fR" property to "\fIroot\fR".
1075 1140
.RE
1076 1141

  
1142
.sp
1143
.ne 2
1144
.mk
1145
.na
1146
\fB\fB-n\fR\fR
1147
.ad
1148
.sp .6
1149
.RS 4n
1150
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.
1151
.RE
1152

  
1077 1153
.RE
1078 1154

  
1079 1155
.sp
1080 1156
.ne 2
1081 1157
.mk
1082 1158
.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
1159
\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-F\fR [\fB-n\fR]] \fIpool\fR | \fIid\fR [\fInewpool\fR]\fR
1084 1160
.ad
1085 1161
.sp .6
1086 1162
.RS 4n
......
1157 1233
.ne 2
1158 1234
.mk
1159 1235
.na
1236
\fB\fB-F\fR\fR
1237
.ad
1238
.sp .6
1239
.RS 4n
1240
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.
1241
.RE
1242

  
1243
.sp
1244
.ne 2
1245
.mk
1246
.na
1160 1247
\fB\fB-R\fR \fIroot\fR\fR
1161 1248
.ad
1162 1249
.sp .6
......
1164 1251
Sets the "\fBcachefile\fR" property to "\fBnone\fR" and the "\fIaltroot\fR" property to "\fIroot\fR".
1165 1252
.RE
1166 1253

  
1254
.sp
1255
.ne 2
1256
.mk
1257
.na
1258
\fB\fB-n\fR\fR
1259
.ad
1260
.sp .6
1261
.RS 4n
1262
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.
1263
.RE
1264

  
1167 1265
.RE
1168 1266

  
1169 1267
.sp
......
1181 1279
.na
1182 1280
\fB\fB-T\fR \fBu\fR | \fBd\fR\fR
1183 1281
.ad
1184
.RS 12n
1185
.rt  
1282
.sp .6
1283
.RS 4n
1186 1284
Display a time stamp.
1187 1285
.sp
1188 1286
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).
......
1194 1292
.na
1195 1293
\fB\fB-v\fR\fR
1196 1294
.ad
1197
.RS 12n
1198
.rt  
1295
.sp .6
1296
.RS 4n
1199 1297
Verbose statistics. Reports usage statistics for individual \fIvdevs\fR within the pool, in addition to the pool-wide statistics.
1200 1298
.RE
1201 1299

  
......
1216 1314
.na
1217 1315
\fB\fB-H\fR\fR
1218 1316
.ad
1219
.RS 12n
1220
.rt  
1317
.sp .6
1318
.RS 4n
1221 1319
Scripted mode. Do not display headers, and separate fields by a single tab instead of arbitrary space.
1222 1320
.RE
1223 1321

  
......
1227 1325
.na
1228 1326
\fB\fB-o\fR \fIprops\fR\fR
1229 1327
.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"
1328
.sp .6
1329
.RS 4n
1330
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.
1233 1331
.RE
1234 1332

  
1235 1333
.RE
......
1251 1349
.na
1252 1350
\fB\fB-t\fR\fR
1253 1351
.ad
1254
.RS 6n
1255
.rt  
1352
.sp .6
1353
.RS 4n
1256 1354
Temporary. Upon reboot, the specified physical device reverts to its previous state.
1257 1355
.RE
1258 1356

  
......
1275 1373
.na
1276 1374
\fB\fB-e\fR\fR
1277 1375
.ad
1278
.RS 6n
1279
.rt  
1376
.sp .6
1377
.RS 4n
1280 1378
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 1379
.RE
1282 1380

  
......
1312 1410
.na
1313 1411
\fB\fB-f\fR\fR
1314 1412
.ad
1315
.RS 6n
1316
.rt  
1413
.sp .6
1414
.RS 4n
1317 1415
Forces use of \fInew_device\fR, even if its appears to be in use. Not all devices can be overridden in this manner.
1318 1416
.RE
1319 1417

  
......
1338 1436
.na
1339 1437
\fB\fB-s\fR\fR
1340 1438
.ad
1341
.RS 6n
1342
.rt  
1439
.sp .6
1440
.RS 4n
1343 1441
Stop scrubbing.
1344 1442
.RE
1345 1443

  
......
1360 1458
.ne 2
1361 1459
.mk
1362 1460
.na
1461
\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
1462
.ad
1463
.sp .6
1464
.RS 4n
1465
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.
1466
.sp
1467
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.
1468
.sp
1469
.ne 2
1470
.mk
1471
.na
1472
\fB\fB-R\fR \fIaltroot\fR\fR
1473
.ad
1474
.sp .6
1475
.RS 4n
1476
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.
1477
.RE
1478

  
1479
.sp
1480
.ne 2
1481
.mk
1482
.na
1483
\fB\fB-n\fR\fR
1484
.ad
1485
.sp .6
1486
.RS 4n
1487
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.
1488
.RE
1489

  
1490
.sp
1491
.ne 2
1492
.mk
1493
.na
1494
\fB\fB-o\fR \fImntopts\fR\fR
1495
.ad
1496
.sp .6
1497
.RS 4n
1498
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.
1499
.RE
1500

  
1501
.sp
1502
.ne 2
1503
.mk
1504
.na
1505
\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1506
.ad
1507
.sp .6
1508
.RS 4n
1509
Sets the specified property on the new pool. See the "Properties" section, above, for more information on the available pool properties.
1510
.RE
1511

  
1512
.RE
1513

  
1514
.sp
1515
.ne 2
1516
.mk
1517
.na
1363 1518
\fB\fBzpool status\fR [\fB-xv\fR] [\fIpool\fR] ...\fR
1364 1519
.ad
1365 1520
.sp .6
......
1373 1528
.na
1374 1529
\fB\fB-x\fR\fR
1375 1530
.ad
1376
.RS 6n
1377
.rt  
1531
.sp .6
1532
.RS 4n
1378 1533
Only display status for pools that are exhibiting errors or are otherwise unavailable.
1379 1534
.RE
1380 1535

  
......
1384 1539
.na
1385 1540
\fB\fB-v\fR\fR
1386 1541
.ad
1387
.RS 6n
1388
.rt  
1542
.sp .6
1543
.RS 4n
1389 1544
Displays verbose data error information, printing out a complete list of all data errors since the last complete pool scrub.
1390 1545
.RE
1391 1546

  
......
1428 1583
.na
1429 1584
\fB\fB-a\fR\fR
1430 1585
.ad
1431
.RS 14n
1432
.rt  
1586
.sp .6
1587
.RS 4n
1433 1588
Upgrades all pools.
1434 1589
.RE
1435 1590

  
......
1439 1594
.na
1440 1595
\fB\fB-V\fR \fIversion\fR\fR
1441 1596
.ad
1442
.RS 14n
1443
.rt  
1597
.sp .6
1598
.RS 4n
1444 1599
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.
1445 1600
.RE
1446 1601

  
......
1521 1676
\fBExample 6 \fRListing Available ZFS Storage Pools
1522 1677
.sp
1523 1678
.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.
1679
The following command lists all available pools on the system.
1680

  
1681
.sp
1682
.in +2
1683
.nf
1684
# \fBzpool list\fR
1685
NAME    SIZE  ALLOC   FREE    CAP  DEDUP  HEALTH  ALTROOT
1686
pool    136G   109M   136G     0%  3.00x  ONLINE  -
1687
rpool  67.5G  12.6G  54.9G    18%  1.01x  ONLINE  -
1688
.fi
1689
.in -2
1690
.sp
1525 1691

  
1692
.LP
1693
\fBExample 7 \fRListing All Properties for a Pool
1526 1694
.sp
1527 1695
.LP
1528
The results from this command are similar to the following:
1696
The following command lists all the properties for a pool.
1529 1697

  
1530 1698
.sp
1531 1699
.in +2
1532 1700
.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    -
1701
% \fBzpool get all pool\fR
1702
NAME  PROPERTY       VALUE       SOURCE
1703
pool  size           136G        -
1704
pool  capacity       0%          -
1705
pool  altroot        -           default
1706
pool  health         ONLINE      -
1707
pool  guid           15697759092019394988  default
1708
pool  version        21          default
1709
pool  bootfs         -           default
1710
pool  delegation     on          default
1711
pool  autoreplace    off         default
1712
pool  cachefile      -           default
1713
pool  failmode       wait        default
1714
pool  listsnapshots  off         default
1715
pool  autoexpand     off         default
1716
pool  dedupratio     3.00x       -
1717
pool  free           136G        -
1718
pool  allocated      109M        -
1538 1719
.fi
1539 1720
.in -2
1540 1721
.sp
1541 1722

  
1542 1723
.LP
1543
\fBExample 7 \fRDestroying a ZFS Storage Pool
1724
\fBExample 8 \fRDestroying a ZFS Storage Pool
1544 1725
.sp
1545 1726
.LP
1546 1727
The following command destroys the pool "\fItank\fR" and any datasets contained within.
......
1554 1735
.sp
1555 1736

  
1556 1737
.LP
1557
\fBExample 8 \fRExporting a ZFS Storage Pool
1738
\fBExample 9 \fRExporting a ZFS Storage Pool
1558 1739
.sp
1559 1740
.LP
1560 1741
The following command exports the devices in pool \fItank\fR so that they can be relocated or later imported.
......
1568 1749
.sp
1569 1750

  
1570 1751
.LP
1571
\fBExample 9 \fRImporting a ZFS Storage Pool
1752
\fBExample 10 \fRImporting a ZFS Storage Pool
1572 1753
.sp
1573 1754
.LP
1574 1755
The following command displays available pools, and then imports the pool "tank" for use on the system.
......
1582 1763
.nf
1583 1764
# \fBzpool import\fR
1584 1765
  pool: tank
1585
    id: 15451357997522795478
1766
    id: 7678868315469843843
1586 1767
 state: ONLINE
1587 1768
action: The pool can be imported using its name or numeric identifier.
1588 1769
config:
1589 1770

  
1590 1771
        tank        ONLINE
1591
          mirror    ONLINE
1772
          mirror-0  ONLINE
1592 1773
            c1t2d0  ONLINE
1593 1774
            c1t3d0  ONLINE
1594 1775

  
......
1598 1779
.sp
1599 1780

  
1600 1781
.LP
1601
\fBExample 10 \fRUpgrading All ZFS Storage Pools to the Current Version
1782
\fBExample 11 \fRUpgrading All ZFS Storage Pools to the Current Version
1602 1783
.sp
1603 1784
.LP
1604 1785
The following command upgrades all ZFS Storage pools to the current version of the software.
......
1607 1788
.in +2
1608 1789
.nf
1609 1790
# \fBzpool upgrade -a\fR
1610
This system is currently running ZFS version 2.
1791
This system is currently running ZFS pool version 19.
1792

  
1793
All pools are formatted using this version.
1611 1794
.fi
1612 1795
.in -2
1613 1796
.sp
1614 1797

  
1615 1798
.LP
1616
\fBExample 11 \fRManaging Hot Spares
1799
\fBExample 12 \fRManaging Hot Spares
1617 1800
.sp
1618 1801
.LP
1619 1802
The following command creates a new pool with an available hot spare:
......
1651 1834
.sp
1652 1835

  
1653 1836
.LP
1654
\fBExample 12 \fRCreating a ZFS Pool with Mirrored Separate Intent Logs
1837
\fBExample 13 \fRCreating a ZFS Pool with Mirrored Separate Intent Logs
1655 1838
.sp
1656 1839
.LP
1657 1840
The following command creates a ZFS storage pool consisting of two, two-way mirrors and mirrored log devices:
......
1666 1849
.sp
1667 1850

  
1668 1851
.LP
1669
\fBExample 13 \fRAdding Cache Devices to a ZFS Pool
1852
\fBExample 14 \fRAdding Cache Devices to a ZFS Pool
1670 1853
.sp
1671 1854
.LP
1672 1855
The following command adds two disks for use as cache devices to a ZFS storage pool:
......
1692 1875
.sp
1693 1876

  
1694 1877
.LP
1695
\fBExample 14 \fRRemoving a Mirrored Log Device
1878
\fBExample 15 \fRRemoving a Mirrored Log Device
1696 1879
.sp
1697 1880
.LP
1698 1881
The following command removes the mirrored log device \fBmirror-2\fR.
......
1737 1920
.in -2
1738 1921
.sp
1739 1922

  
1923
.LP
1924
\fBExample 16 \fRRecovering a Faulted ZFS Pool
1925
.sp
1926
.LP
1927
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.
1928

  
1929
.sp
1930
.LP
1931
Recover a cached pool with the \fBzpool clear\fR command:
1932

  
1933
.sp
1934
.in +2
1935
.nf
1936
# \fBzpool clear -F data\fR
1937
Pool data returned to its state as of Tue Sep 08 13:23:35 2009.
1938
Discarded approximately 29 seconds of transactions.
1939
.fi
1940
.in -2
1941
.sp
1942

  
1943
.sp
1944
.LP
1945
If the pool configuration was not cached, use \fBzpool import\fR with the recovery mode flag:
1946

  
1947
.sp
1948
.in +2
1949
.nf
1950
# \fBzpool import -F data\fR
1951
Pool data returned to its state as of Tue Sep 08 13:23:35 2009.
1952
Discarded approximately 29 seconds of transactions.
1953
.fi
1954
.in -2
1955
.sp
1956

  
1740 1957
.SH EXIT STATUS
1741 1958
.sp
1742 1959
.LP
......
1747 1964
.na
1748 1965
\fB\fB0\fR\fR
1749 1966
.ad
1750
.RS 5n
1751
.rt  
1967
.sp .6
1968
.RS 4n
1752 1969
Successful completion. 
1753 1970
.RE
1754 1971

  
......
1758 1975
.na
1759 1976
\fB\fB1\fR\fR
1760 1977
.ad
1761
.RS 5n
1762
.rt  
1978
.sp .6
1979
.RS 4n
1763 1980
An error occurred.
1764 1981
.RE
1765 1982

  
......
1769 1986
.na
1770 1987
\fB\fB2\fR\fR
1771 1988
.ad
1772
.RS 5n
1773
.rt  
1989
.sp .6
1990
.RS 4n
1774 1991
Invalid command line options were specified.
1775 1992
.RE
1776 1993

  
......
1790 2007
_
1791 2008
AvailabilitySUNWzfsu
1792 2009
_
1793
Interface StabilityEvolving
2010
Interface StabilityCommitted
1794 2011
.TE
1795 2012

  
1796 2013
.SH SEE ALSO
(6-6/8)