Print this page 
2619 asynchronous destruction of ZFS file systems
2747 SPA versioning with zfs feature flags
Reviewed by: Matt Ahrens <mahrens@delphix.com>
Reviewed by: George Wilson <gwilson@delphix.com>
Reviewed by: Richard Lowe <richlowe@richlowe.net>
Reviewed by: Dan Kruchinin <dan.kruchinin@gmail.com>
Approved by: Dan McDonald <danmcd@nexenta.com>
Split Close
Expand all
Collapse all
          --- old/usr/src/man/man1m/zpool.1m
          +++ new/usr/src/man/man1m/zpool.1m
   1    1  '\" te
   2    2  .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
   3    3  .\" Copyright 2011, Nexenta Systems, Inc. All Rights Reserved.
   4      -.\" Copyright (c) 2012 by Delphix. All Rights Reserved.
   5      -.\" 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.
   6      -.\" 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
   7      -.\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   8      -.TH ZPOOL 1M "Nov 14, 2011"
        4 +.\" Copyright (c) 2012 by Delphix. All rights reserved.
        5 +.\" The contents of this file are subject to the terms of the Common Development
        6 +.\" and Distribution License (the "License"). You may not use this file except
        7 +.\" in compliance with the License. You can obtain a copy of the license at
        8 +.\" usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
        9 +.\"
       10 +.\" See the License for the specific language governing permissions and
       11 +.\" limitations under the License. When distributing Covered Code, include this
       12 +.\" CDDL HEADER in each file and include the License file at
       13 +.\" usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this
       14 +.\" CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your
       15 +.\" own identifying information:
       16 +.\" Portions Copyright [yyyy] [name of copyright owner]
       17 +.TH ZPOOL 1M "Mar 16, 2012"
   9   18  .SH NAME
  10   19  zpool \- configures ZFS storage pools
  11   20  .SH SYNOPSIS
  12   21  .LP
  13   22  .nf
  14   23  \fBzpool\fR [\fB-?\fR]
  15   24  .fi
  16   25  
  17   26  .LP
  18   27  .nf
↓ open down ↓ 5 lines elided ↑ open up ↑ 
  24   33  \fBzpool attach\fR [\fB-f\fR] \fIpool\fR \fIdevice\fR \fInew_device\fR
  25   34  .fi
  26   35  
  27   36  .LP
  28   37  .nf
  29   38  \fBzpool clear\fR \fIpool\fR [\fIdevice\fR]
  30   39  .fi
  31   40  
  32   41  .LP
  33   42  .nf
  34      -\fBzpool create\fR [\fB-fn\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-O\fR \fIfile-system-property=value\fR]
       43 +\fBzpool create\fR [\fB-fnd\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-O\fR \fIfile-system-property=value\fR]
  35   44       ... [\fB-m\fR \fImountpoint\fR] [\fB-R\fR \fIroot\fR] \fIpool\fR \fIvdev\fR ...
  36   45  .fi
  37   46  
  38   47  .LP
  39   48  .nf
  40   49  \fBzpool destroy\fR [\fB-f\fR] \fIpool\fR
  41   50  .fi
  42   51  
  43   52  .LP
  44   53  .nf
↓ open down ↓ 495 lines elided ↑ open up ↑ 
 540  549  \fB\fBcapacity\fR\fR
 541  550  .ad
 542  551  .RS 20n
 543  552  Percentage of pool space used. This property can also be referred to by its
 544  553  shortened column name, "cap".
 545  554  .RE
 546  555  
 547  556  .sp
 548  557  .ne 2
 549  558  .na
 550      -\fB\fBcomment\fR\fR
      559 +\fB\fBexpandsize\fR\fR
 551  560  .ad
 552  561  .RS 20n
 553      -A text string consisting of printable ASCII characters that will be stored
 554      -such that it is available even if the pool becomes faulted.  An administrator
 555      -can provide additional information about a pool using this property.
      562 +Amount of uninitialized space within the pool or device that can be used to
      563 +increase the total capacity of the pool.  Uninitialized space consists of
      564 +any space on an EFI labeled vdev which has not been brought online
      565 +(i.e. zpool online -e).  This space occurs when a LUN is dynamically expanded.
 556  566  .RE
 557  567  
 558  568  .sp
 559  569  .ne 2
 560  570  .na
 561      -\fB\fBexpandsize\fR\fR
      571 +\fB\fBfree\fR\fR
 562  572  .ad
 563  573  .RS 20n
 564      -Amount of uninitialized space within the pool or device that can be used to
 565      -increase the total capacity of the pool.  Uninitialized space consists of 
 566      -any space on an EFI labeled vdev which has not been brought online 
 567      -(i.e. zpool online -e).  This space occurs when a LUN is dynamically expanded.
      574 +The amount of free space available in the pool.
 568  575  .RE
 569  576  
 570  577  .sp
 571  578  .ne 2
 572  579  .na
      580 +\fB\fBfreeing\fR\fR
      581 +.ad
      582 +.RS 20n
      583 +After a file system or snapshot is destroyed, the space it was using is
      584 +returned to the pool asynchronously. \fB\fBfreeing\fR\fR is the amount of
      585 +space remaining to be reclaimed. Over time \fB\fBfreeing\fR\fR will decrease
      586 +while \fB\fBfree\fR\fR increases.
      587 +.RE
      588 +
      589 +.sp
      590 +.ne 2
      591 +.na
 573  592  \fB\fBhealth\fR\fR
 574  593  .ad
 575  594  .RS 20n
 576  595  The current health of the pool. Health can be "\fBONLINE\fR", "\fBDEGRADED\fR",
 577  596  "\fBFAULTED\fR", " \fBOFFLINE\fR", "\fBREMOVED\fR", or "\fBUNAVAIL\fR".
 578  597  .RE
 579  598  
 580  599  .sp
 581  600  .ne 2
 582  601  .na
↓ open down ↓ 8 lines elided ↑ open up ↑ 
 591  610  .na
 592  611  \fB\fBsize\fR\fR
 593  612  .ad
 594  613  .RS 20n
 595  614  Total size of the storage pool.
 596  615  .RE
 597  616  
 598  617  .sp
 599  618  .ne 2
 600  619  .na
      620 +\fB\fBunsupported@\fR\fIfeature_guid\fR\fR
      621 +.ad
      622 +.RS 20n
      623 +Information about unsupported features that are enabled on the pool. See
      624 +\fBzpool-features\fR(5) for details.
      625 +.RE
      626 +
      627 +.sp
      628 +.ne 2
      629 +.na
 601  630  \fB\fBused\fR\fR
 602  631  .ad
 603  632  .RS 20n
 604  633  Amount of storage space used within the pool.
 605  634  .RE
 606  635  
 607  636  .sp
 608  637  .LP
 609      -These space usage properties report actual physical space available to the
      638 +The space usage properties report actual physical space available to the
 610  639  storage pool. The physical space can be different from the total amount of
 611  640  space that any contained datasets can actually use. The amount of space used in
 612  641  a \fBraidz\fR configuration depends on the characteristics of the data being
 613  642  written. In addition, \fBZFS\fR reserves some space for internal accounting
 614  643  that the \fBzfs\fR(1M) command takes into account, but the \fBzpool\fR command
 615  644  does not. For non-full pools of a reasonable size, these effects should be
 616  645  invisible. For small pools, or pools that are close to being completely full,
 617  646  these discrepancies may become more noticeable.
 618  647  .sp
 619  648  .LP
↓ open down ↓ 78 lines elided ↑ open up ↑ 
 698  727  .sp
 699  728  Multiple pools can share the same cache file. Because the kernel destroys and
 700  729  recreates this file when pools are added and removed, care should be taken when
 701  730  attempting to access this file. When the last pool using a \fBcachefile\fR is
 702  731  exported or destroyed, the file is removed.
 703  732  .RE
 704  733  
 705  734  .sp
 706  735  .ne 2
 707  736  .na
      737 +\fB\fBcomment\fR=\fB\fItext\fR\fR
      738 +.ad
      739 +.RS 4n
      740 +A text string consisting of printable ASCII characters that will be stored
      741 +such that it is available even if the pool becomes faulted.  An administrator
      742 +can provide additional information about a pool using this property.
      743 +.RE
      744 +
      745 +.sp
      746 +.ne 2
      747 +.na
 708  748  \fB\fBdelegation\fR=\fBon\fR | \fBoff\fR\fR
 709  749  .ad
 710  750  .sp .6
 711  751  .RS 4n
 712  752  Controls whether a non-privileged user is granted access based on the dataset
 713  753  permissions defined on the dataset. See \fBzfs\fR(1M) for more information on
 714  754  \fBZFS\fR delegated administration.
 715  755  .RE
 716  756  
 717  757  .sp
↓ open down ↓ 35 lines elided ↑ open up ↑ 
 753  793  .ad
 754  794  .RS 12n
 755  795  Prints out a message to the console and generates a system crash dump.
 756  796  .RE
 757  797  
 758  798  .RE
 759  799  
 760  800  .sp
 761  801  .ne 2
 762  802  .na
      803 +\fB\fBfeature@\fR\fIfeature_name\fR=\fBenabled\fR\fR
      804 +.ad
      805 +.RS 4n
      806 +The value of this property is the current state of \fIfeature_name\fR. The
      807 +only valid value when setting this property is \fBenabled\fR which moves
      808 +\fIfeature_name\fR to the enabled state. See \fBzpool-features\fR(5) for
      809 +details on feature states.
      810 +.RE
      811 +
      812 +.sp
      813 +.ne 2
      814 +.na
 763  815  \fB\fBlistsnaps\fR=on | off\fR
 764  816  .ad
 765  817  .sp .6
 766  818  .RS 4n
 767  819  Controls whether information about snapshots associated with this pool is
 768  820  output when "\fBzfs list\fR" is run without the \fB-t\fR option. The default
 769  821  value is "off".
 770  822  .RE
 771  823  
 772  824  .sp
 773  825  .ne 2
 774  826  .na
 775  827  \fB\fBversion\fR=\fIversion\fR\fR
 776  828  .ad
 777  829  .sp .6
 778  830  .RS 4n
 779  831  The current on-disk version of the pool. This can be increased, but never
 780  832  decreased. The preferred method of updating pools is with the "\fBzpool
 781  833  upgrade\fR" command, though this property can be used when a specific version
 782      -is needed for backwards compatibility. This property can be any number between
 783      -1 and the current version reported by "\fBzpool upgrade -v\fR".
      834 +is needed for backwards compatibility. Once feature flags is enabled on a
      835 +pool this property will no longer have a value.
 784  836  .RE
 785  837  
 786  838  .SS "Subcommands"
 787  839  .sp
 788  840  .LP
 789  841  All subcommands that modify state are logged persistently to the pool in their
 790  842  original form.
 791  843  .sp
 792  844  .LP
 793  845  The \fBzpool\fR command provides subcommands to create and destroy storage
↓ open down ↓ 80 lines elided ↑ open up ↑ 
 874  926  .sp .6
 875  927  .RS 4n
 876  928  Clears device errors in a pool. If no arguments are specified, all device
 877  929  errors within the pool are cleared. If one or more devices is specified, only
 878  930  those errors associated with the specified device or devices are cleared.
 879  931  .RE
 880  932  
 881  933  .sp
 882  934  .ne 2
 883  935  .na
 884      -\fB\fBzpool create\fR [\fB-fn\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-O\fR
      936 +\fB\fBzpool create\fR [\fB-fnd\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-O\fR
 885  937  \fIfile-system-property=value\fR] ... [\fB-m\fR \fImountpoint\fR] [\fB-R\fR
 886  938  \fIroot\fR] \fIpool\fR \fIvdev\fR ...\fR
 887  939  .ad
 888  940  .sp .6
 889  941  .RS 4n
 890  942  Creates a new storage pool containing the virtual devices specified on the
 891  943  command line. The pool name must begin with a letter, and can only contain
 892  944  alphanumeric characters as well as underscore ("_"), dash ("-"), and period
 893  945  ("."). The pool names "mirror", "raidz", "spare" and "log" are reserved, as are
 894  946  names beginning with the pattern "c[0-9]". The \fBvdev\fR specification is
↓ open down ↓ 9 lines elided ↑ open up ↑ 
 904  956  consistent. An attempt to combine redundant and non-redundant storage in a
 905  957  single pool, or to mix disks and files, results in an error unless \fB-f\fR is
 906  958  specified. The use of differently sized devices within a single \fBraidz\fR or
 907  959  mirror group is also flagged as an error unless \fB-f\fR is specified.
 908  960  .sp
 909  961  Unless the \fB-R\fR option is specified, the default mount point is
 910  962  "/\fIpool\fR". The mount point must not exist or must be empty, or else the
 911  963  root dataset cannot be mounted. This can be overridden with the \fB-m\fR
 912  964  option.
 913  965  .sp
      966 +By default all supported features are enabled on the new pool unless the
      967 +\fB-d\fR option is specified.
      968 +.sp
 914  969  .ne 2
 915  970  .na
 916  971  \fB\fB-f\fR\fR
 917  972  .ad
 918  973  .sp .6
 919  974  .RS 4n
 920  975  Forces use of \fBvdev\fRs, even if they appear in use or specify a conflicting
 921  976  replication level. Not all devices can be overridden in this manner.
 922  977  .RE
 923  978
↓ open down ↓ 5 lines elided ↑ open up ↑ 
 929  984  .sp .6
 930  985  .RS 4n
 931  986  Displays the configuration that would be used without actually creating the
 932  987  pool. The actual pool creation can still fail due to insufficient privileges or
 933  988  device sharing.
 934  989  .RE
 935  990  
 936  991  .sp
 937  992  .ne 2
 938  993  .na
      994 +\fB\fB-d\fR\fR
      995 +.ad
      996 +.sp .6
      997 +.RS 4n
      998 +Do not enable any features on the new pool. Individual features can be enabled
      999 +by setting their corresponding properties to \fBenabled\fR with the \fB-o\fR
     1000 +option. See \fBzpool-features\fR(5) for details about feature properties.
     1001 +.RE
     1002 +
     1003 +.sp
     1004 +.ne 2
     1005 +.na
 939 1006  \fB\fB-o\fR \fIproperty=value\fR [\fB-o\fR \fIproperty=value\fR] ...\fR
 940 1007  .ad
 941 1008  .sp .6
 942 1009  .RS 4n
 943 1010  Sets the given pool properties. See the "Properties" section for a list of
 944 1011  valid properties that can be set.
 945 1012  .RE
 946 1013  
 947 1014  .sp
 948 1015  .ne 2
↓ open down ↓ 1103 lines elided ↑ open up ↑ 
2052 2119  c | c
2053 2120  l | l .
2054 2121  ATTRIBUTE TYPE  ATTRIBUTE VALUE
2055 2122  _
2056 2123  Interface Stability     Evolving
2057 2124  .TE
2058 2125  
2059 2126  .SH SEE ALSO
2060 2127  .sp
2061 2128  .LP
2062      -\fBzfs\fR(1M), \fBattributes\fR(5)
     2129 +\fBzfs\fR(1M), \fBzpool-features\fR(5), \fBattributes\fR(5)
    
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX