Mercurial Mercurial > upstream > illumos > illumos-gate / comparison
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
usr/src/man/man1m/zpool.1m
changeset 13700 2889e2596bd6
parent 13570 3411fd5f1589
child 13753 2aba784c276b
equal deleted inserted replaced
13699:733714f4dc24 13700:2889e2596bd6 
     1 '\" te
 
     1 '\" te
 
     2 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
 
     2 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
 
     3 .\" Copyright 2011, Nexenta Systems, Inc. All Rights Reserved.
 
     3 .\" Copyright 2011, Nexenta Systems, Inc. All Rights Reserved.
 
     4 .\" Copyright (c) 2012 by Delphix. 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.
 
     5 .\" The contents of this file are subject to the terms of the Common Development
 
     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
 
     6 .\" and Distribution License (the "License"). You may not use this file except
 
     7 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
 
     7 .\" in compliance with the License. You can obtain a copy of the license at
 
     8 .TH ZPOOL 1M "Nov 14, 2011"
 
     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 .SH NAME
 
    18 .SH NAME
 
    10 zpool \- configures ZFS storage pools
 
    19 zpool \- configures ZFS storage pools
 
    11 .SH SYNOPSIS
 
    20 .SH SYNOPSIS
 
    12 .LP
 
    21 .LP
 
    13 .nf
 
    22 .nf
 
    29 \fBzpool clear\fR \fIpool\fR [\fIdevice\fR]
 
    38 \fBzpool clear\fR \fIpool\fR [\fIdevice\fR]
 
    30 .fi
 
    39 .fi
 
    31 
    40 
    32 .LP
 
    41 .LP
 
    33 .nf
 
    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      ... [\fB-m\fR \fImountpoint\fR] [\fB-R\fR \fIroot\fR] \fIpool\fR \fIvdev\fR ...
 
    44      ... [\fB-m\fR \fImountpoint\fR] [\fB-R\fR \fIroot\fR] \fIpool\fR \fIvdev\fR ...
 
    36 .fi
 
    45 .fi
 
    37 
    46 
    38 .LP
 
    47 .LP
 
    39 .nf
 
    48 .nf
 
   545 .RE
 
   554 .RE
 
   546 
   555 
   547 .sp
 
   556 .sp
 
   548 .ne 2
 
   557 .ne 2
 
   549 .na
 
   558 .na
 
   550 \fB\fBcomment\fR\fR
 
       
   551 .ad
 
       
   552 .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.
 
       
   556 .RE
 
       
   557 
       
   558 .sp
 
       
   559 .ne 2
 
       
   560 .na
 
       
   561 \fB\fBexpandsize\fR\fR
 
   559 \fB\fBexpandsize\fR\fR
 
   562 .ad
 
   560 .ad
 
   563 .RS 20n
 
   561 .RS 20n
 
   564 Amount of uninitialized space within the pool or device that can be used to
 
   562 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 
   563 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 
   564 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.
 
   565 (i.e. zpool online -e).  This space occurs when a LUN is dynamically expanded.
 
       
   566 .RE
 
       
   567 
       
   568 .sp
 
       
   569 .ne 2
 
       
   570 .na
 
       
   571 \fB\fBfree\fR\fR
 
       
   572 .ad
 
       
   573 .RS 20n
 
       
   574 The amount of free space available in the pool.
 
       
   575 .RE
 
       
   576 
       
   577 .sp
 
       
   578 .ne 2
 
       
   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.
 
   568 .RE
 
   587 .RE
 
   569 
   588 
   570 .sp
 
   589 .sp
 
   571 .ne 2
 
   590 .ne 2
 
   572 .na
 
   591 .na
 
   596 .RE
 
   615 .RE
 
   597 
   616 
   598 .sp
 
   617 .sp
 
   599 .ne 2
 
   618 .ne 2
 
   600 .na
 
   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 \fB\fBused\fR\fR
 
   630 \fB\fBused\fR\fR
 
   602 .ad
 
   631 .ad
 
   603 .RS 20n
 
   632 .RS 20n
 
   604 Amount of storage space used within the pool.
 
   633 Amount of storage space used within the pool.
 
   605 .RE
 
   634 .RE
 
   606 
   635 
   607 .sp
 
   636 .sp
 
   608 .LP
 
   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 storage pool. The physical space can be different from the total amount of
 
   639 storage pool. The physical space can be different from the total amount of
 
   611 space that any contained datasets can actually use. The amount of space used in
 
   640 space that any contained datasets can actually use. The amount of space used in
 
   612 a \fBraidz\fR configuration depends on the characteristics of the data being
 
   641 a \fBraidz\fR configuration depends on the characteristics of the data being
 
   613 written. In addition, \fBZFS\fR reserves some space for internal accounting
 
   642 written. In addition, \fBZFS\fR reserves some space for internal accounting
 
   614 that the \fBzfs\fR(1M) command takes into account, but the \fBzpool\fR command
 
   643 that the \fBzfs\fR(1M) command takes into account, but the \fBzpool\fR command
 
   703 .RE
 
   732 .RE
 
   704 
   733 
   705 .sp
 
   734 .sp
 
   706 .ne 2
 
   735 .ne 2
 
   707 .na
 
   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 \fB\fBdelegation\fR=\fBon\fR | \fBoff\fR\fR
 
   748 \fB\fBdelegation\fR=\fBon\fR | \fBoff\fR\fR
 
   709 .ad
 
   749 .ad
 
   710 .sp .6
 
   750 .sp .6
 
   711 .RS 4n
 
   751 .RS 4n
 
   712 Controls whether a non-privileged user is granted access based on the dataset
 
   752 Controls whether a non-privileged user is granted access based on the dataset
 
   758 .RE
 
   798 .RE
 
   759 
   799 
   760 .sp
 
   800 .sp
 
   761 .ne 2
 
   801 .ne 2
 
   762 .na
 
   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 \fB\fBlistsnaps\fR=on | off\fR
 
   815 \fB\fBlistsnaps\fR=on | off\fR
 
   764 .ad
 
   816 .ad
 
   765 .sp .6
 
   817 .sp .6
 
   766 .RS 4n
 
   818 .RS 4n
 
   767 Controls whether information about snapshots associated with this pool is
 
   819 Controls whether information about snapshots associated with this pool is
 
   777 .sp .6
 
   829 .sp .6
 
   778 .RS 4n
 
   830 .RS 4n
 
   779 The current on-disk version of the pool. This can be increased, but never
 
   831 The current on-disk version of the pool. This can be increased, but never
 
   780 decreased. The preferred method of updating pools is with the "\fBzpool
 
   832 decreased. The preferred method of updating pools is with the "\fBzpool
 
   781 upgrade\fR" command, though this property can be used when a specific version
 
   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
 
   834 is needed for backwards compatibility. Once feature flags is enabled on a
 
   783 1 and the current version reported by "\fBzpool upgrade -v\fR".
 
   835 pool this property will no longer have a value.
 
   784 .RE
 
   836 .RE
 
   785 
   837 
   786 .SS "Subcommands"
 
   838 .SS "Subcommands"
 
   787 .sp
 
   839 .sp
 
   788 .LP
 
   840 .LP
 
   879 .RE
 
   931 .RE
 
   880 
   932 
   881 .sp
 
   933 .sp
 
   882 .ne 2
 
   934 .ne 2
 
   883 .na
 
   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 \fIfile-system-property=value\fR] ... [\fB-m\fR \fImountpoint\fR] [\fB-R\fR
 
   937 \fIfile-system-property=value\fR] ... [\fB-m\fR \fImountpoint\fR] [\fB-R\fR
 
   886 \fIroot\fR] \fIpool\fR \fIvdev\fR ...\fR
 
   938 \fIroot\fR] \fIpool\fR \fIvdev\fR ...\fR
 
   887 .ad
 
   939 .ad
 
   888 .sp .6
 
   940 .sp .6
 
   889 .RS 4n
 
   941 .RS 4n
 
   909 Unless the \fB-R\fR option is specified, the default mount point is
 
   961 Unless the \fB-R\fR option is specified, the default mount point is
 
   910 "/\fIpool\fR". The mount point must not exist or must be empty, or else the
 
   962 "/\fIpool\fR". The mount point must not exist or must be empty, or else the
 
   911 root dataset cannot be mounted. This can be overridden with the \fB-m\fR
 
   963 root dataset cannot be mounted. This can be overridden with the \fB-m\fR
 
   912 option.
 
   964 option.
 
   913 .sp
 
   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 .ne 2
 
   969 .ne 2
 
   915 .na
 
   970 .na
 
   916 \fB\fB-f\fR\fR
 
   971 \fB\fB-f\fR\fR
 
   917 .ad
 
   972 .ad
 
   918 .sp .6
 
   973 .sp .6
 
   929 .sp .6
 
   984 .sp .6
 
   930 .RS 4n
 
   985 .RS 4n
 
   931 Displays the configuration that would be used without actually creating the
 
   986 Displays the configuration that would be used without actually creating the
 
   932 pool. The actual pool creation can still fail due to insufficient privileges or
 
   987 pool. The actual pool creation can still fail due to insufficient privileges or
 
   933 device sharing.
 
   988 device sharing.
 
       
   989 .RE
 
       
   990 
       
   991 .sp
 
       
   992 .ne 2
 
       
   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.
 
   934 .RE
 
  1001 .RE
 
   935 
  1002 
   936 .sp
 
  1003 .sp
 
   937 .ne 2
 
  1004 .ne 2
 
   938 .na
 
  1005 .na
 
  2057 .TE
 
  2124 .TE
 
  2058 
  2125 
  2059 .SH SEE ALSO
 
  2126 .SH SEE ALSO
 
  2060 .sp
 
  2127 .sp
 
  2061 .LP
 
  2128 .LP
 
  2062 \fBzfs\fR(1M), \fBattributes\fR(5)
 
  2129 \fBzfs\fR(1M), \fBzpool-features\fR(5), \fBattributes\fR(5)
upstream/illumos/illumos-gate