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>
   1 '\" te
   2 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
   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"









   9 .SH NAME
  10 zpool \- configures ZFS storage pools
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBzpool\fR [\fB-?\fR]
  15 .fi
  16 
  17 .LP
  18 .nf
  19 \fBzpool add\fR [\fB-fn\fR] \fIpool\fR \fIvdev\fR ...
  20 .fi
  21 
  22 .LP
  23 .nf
  24 \fBzpool attach\fR [\fB-f\fR] \fIpool\fR \fIdevice\fR \fInew_device\fR
  25 .fi
  26 
  27 .LP
  28 .nf
  29 \fBzpool clear\fR \fIpool\fR [\fIdevice\fR]
  30 .fi
  31 
  32 .LP
  33 .nf
  34 \fBzpool create\fR [\fB-fn\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 ...
  36 .fi
  37 
  38 .LP
  39 .nf
  40 \fBzpool destroy\fR [\fB-f\fR] \fIpool\fR
  41 .fi
  42 
  43 .LP
  44 .nf
  45 \fBzpool detach\fR \fIpool\fR \fIdevice\fR
  46 .fi
  47 
  48 .LP
  49 .nf
  50 \fBzpool export\fR [\fB-f\fR] \fIpool\fR ...
  51 .fi
  52 
  53 .LP
  54 .nf


 530 \fB\fBavailable\fR\fR
 531 .ad
 532 .RS 20n
 533 Amount of storage available within the pool. This property can also be referred
 534 to by its shortened column name, "avail".
 535 .RE
 536 
 537 .sp
 538 .ne 2
 539 .na
 540 \fB\fBcapacity\fR\fR
 541 .ad
 542 .RS 20n
 543 Percentage of pool space used. This property can also be referred to by its
 544 shortened column name, "cap".
 545 .RE
 546 
 547 .sp
 548 .ne 2
 549 .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
 562 .ad
 563 .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.
 568 .RE
 569 
 570 .sp
 571 .ne 2
 572 .na












 573 \fB\fBhealth\fR\fR
 574 .ad
 575 .RS 20n
 576 The current health of the pool. Health can be "\fBONLINE\fR", "\fBDEGRADED\fR",
 577 "\fBFAULTED\fR", " \fBOFFLINE\fR", "\fBREMOVED\fR", or "\fBUNAVAIL\fR".
 578 .RE
 579 
 580 .sp
 581 .ne 2
 582 .na
 583 \fB\fBguid\fR\fR
 584 .ad
 585 .RS 20n
 586 A unique identifier for the pool.
 587 .RE
 588 
 589 .sp
 590 .ne 2
 591 .na
 592 \fB\fBsize\fR\fR
 593 .ad
 594 .RS 20n
 595 Total size of the storage pool.
 596 .RE
 597 
 598 .sp
 599 .ne 2
 600 .na










 601 \fB\fBused\fR\fR
 602 .ad
 603 .RS 20n
 604 Amount of storage space used within the pool.
 605 .RE
 606 
 607 .sp
 608 .LP
 609 These space usage properties report actual physical space available to the
 610 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
 612 a \fBraidz\fR configuration depends on the characteristics of the data being
 613 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
 615 does not. For non-full pools of a reasonable size, these effects should be
 616 invisible. For small pools, or pools that are close to being completely full,
 617 these discrepancies may become more noticeable.
 618 .sp
 619 .LP
 620 The following property can be set at creation time and import time:
 621 .sp
 622 .ne 2
 623 .na
 624 \fB\fBaltroot\fR\fR
 625 .ad
 626 .sp .6
 627 .RS 4n
 628 Alternate root directory. If set, this directory is prepended to any mount
 629 points within the pool. This can be used when examining an unknown pool where


 688 Controls the location of where the pool configuration is cached. Discovering
 689 all pools on system startup requires a cached copy of the configuration data
 690 that is stored on the root file system. All pools in this cache are
 691 automatically imported when the system boots. Some environments, such as
 692 install and clustering, need to cache this information in a different location
 693 so that pools are not automatically imported. Setting this property caches the
 694 pool configuration in a different location that can later be imported with
 695 "\fBzpool import -c\fR". Setting it to the special value "\fBnone\fR" creates a
 696 temporary pool that is never cached, and the special value \fB\&''\fR (empty
 697 string) uses the default location.
 698 .sp
 699 Multiple pools can share the same cache file. Because the kernel destroys and
 700 recreates this file when pools are added and removed, care should be taken when
 701 attempting to access this file. When the last pool using a \fBcachefile\fR is
 702 exported or destroyed, the file is removed.
 703 .RE
 704 
 705 .sp
 706 .ne 2
 707 .na











 708 \fB\fBdelegation\fR=\fBon\fR | \fBoff\fR\fR
 709 .ad
 710 .sp .6
 711 .RS 4n
 712 Controls whether a non-privileged user is granted access based on the dataset
 713 permissions defined on the dataset. See \fBzfs\fR(1M) for more information on
 714 \fBZFS\fR delegated administration.
 715 .RE
 716 
 717 .sp
 718 .ne 2
 719 .na
 720 \fB\fBfailmode\fR=\fBwait\fR | \fBcontinue\fR | \fBpanic\fR\fR
 721 .ad
 722 .sp .6
 723 .RS 4n
 724 Controls the system behavior in the event of catastrophic pool failure. This
 725 condition is typically a result of a loss of connectivity to the underlying
 726 storage device(s) or a failure of all devices within the pool. The behavior of
 727 such an event is determined as follows:


 743 .RS 12n
 744 Returns \fBEIO\fR to any new write \fBI/O\fR requests but allows reads to any
 745 of the remaining healthy devices. Any write requests that have yet to be
 746 committed to disk would be blocked.
 747 .RE
 748 
 749 .sp
 750 .ne 2
 751 .na
 752 \fB\fBpanic\fR\fR
 753 .ad
 754 .RS 12n
 755 Prints out a message to the console and generates a system crash dump.
 756 .RE
 757 
 758 .RE
 759 
 760 .sp
 761 .ne 2
 762 .na












 763 \fB\fBlistsnaps\fR=on | off\fR
 764 .ad
 765 .sp .6
 766 .RS 4n
 767 Controls whether information about snapshots associated with this pool is
 768 output when "\fBzfs list\fR" is run without the \fB-t\fR option. The default
 769 value is "off".
 770 .RE
 771 
 772 .sp
 773 .ne 2
 774 .na
 775 \fB\fBversion\fR=\fIversion\fR\fR
 776 .ad
 777 .sp .6
 778 .RS 4n
 779 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
 781 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".
 784 .RE
 785 
 786 .SS "Subcommands"
 787 .sp
 788 .LP
 789 All subcommands that modify state are logged persistently to the pool in their
 790 original form.
 791 .sp
 792 .LP
 793 The \fBzpool\fR command provides subcommands to create and destroy storage
 794 pools, add capacity to storage pools, and provide information about the storage
 795 pools. The following subcommands are supported:
 796 .sp
 797 .ne 2
 798 .na
 799 \fB\fBzpool\fR \fB-?\fR\fR
 800 .ad
 801 .sp .6
 802 .RS 4n
 803 Displays a help message.


 864 devices can be overridden in this manner.
 865 .RE
 866 
 867 .RE
 868 
 869 .sp
 870 .ne 2
 871 .na
 872 \fB\fBzpool clear\fR \fIpool\fR [\fIdevice\fR] ...\fR
 873 .ad
 874 .sp .6
 875 .RS 4n
 876 Clears device errors in a pool. If no arguments are specified, all device
 877 errors within the pool are cleared. If one or more devices is specified, only
 878 those errors associated with the specified device or devices are cleared.
 879 .RE
 880 
 881 .sp
 882 .ne 2
 883 .na
 884 \fB\fBzpool create\fR [\fB-fn\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-O\fR
 885 \fIfile-system-property=value\fR] ... [\fB-m\fR \fImountpoint\fR] [\fB-R\fR
 886 \fIroot\fR] \fIpool\fR \fIvdev\fR ...\fR
 887 .ad
 888 .sp .6
 889 .RS 4n
 890 Creates a new storage pool containing the virtual devices specified on the
 891 command line. The pool name must begin with a letter, and can only contain
 892 alphanumeric characters as well as underscore ("_"), dash ("-"), and period
 893 ("."). The pool names "mirror", "raidz", "spare" and "log" are reserved, as are
 894 names beginning with the pattern "c[0-9]". The \fBvdev\fR specification is
 895 described in the "Virtual Devices" section.
 896 .sp
 897 The command verifies that each device specified is accessible and not currently
 898 in use by another subsystem. There are some uses, such as being currently
 899 mounted, or specified as the dedicated dump device, that prevents a device from
 900 ever being used by \fBZFS\fR. Other uses, such as having a preexisting
 901 \fBUFS\fR file system, can be overridden with the \fB-f\fR option.
 902 .sp
 903 The command also checks that the replication strategy for the pool is
 904 consistent. An attempt to combine redundant and non-redundant storage in a
 905 single pool, or to mix disks and files, results in an error unless \fB-f\fR is
 906 specified. The use of differently sized devices within a single \fBraidz\fR or
 907 mirror group is also flagged as an error unless \fB-f\fR is specified.
 908 .sp
 909 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
 911 root dataset cannot be mounted. This can be overridden with the \fB-m\fR
 912 option.
 913 .sp



 914 .ne 2
 915 .na
 916 \fB\fB-f\fR\fR
 917 .ad
 918 .sp .6
 919 .RS 4n
 920 Forces use of \fBvdev\fRs, even if they appear in use or specify a conflicting
 921 replication level. Not all devices can be overridden in this manner.
 922 .RE
 923 
 924 .sp
 925 .ne 2
 926 .na
 927 \fB\fB-n\fR\fR
 928 .ad
 929 .sp .6
 930 .RS 4n
 931 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
 933 device sharing.
 934 .RE
 935 
 936 .sp
 937 .ne 2
 938 .na












 939 \fB\fB-o\fR \fIproperty=value\fR [\fB-o\fR \fIproperty=value\fR] ...\fR
 940 .ad
 941 .sp .6
 942 .RS 4n
 943 Sets the given pool properties. See the "Properties" section for a list of
 944 valid properties that can be set.
 945 .RE
 946 
 947 .sp
 948 .ne 2
 949 .na
 950 \fB\fB-O\fR \fIfile-system-property=value\fR\fR
 951 .ad
 952 .br
 953 .na
 954 \fB[\fB-O\fR \fIfile-system-property=value\fR] ...\fR
 955 .ad
 956 .sp .6
 957 .RS 4n
 958 Sets the given file system properties in the root file system of the pool. See


2042 
2043 .SH ATTRIBUTES
2044 .sp
2045 .LP
2046 See \fBattributes\fR(5) for descriptions of the following attributes:
2047 .sp
2048 
2049 .sp
2050 .TS
2051 box;
2052 c | c
2053 l | l .
2054 ATTRIBUTE TYPE  ATTRIBUTE VALUE
2055 _
2056 Interface Stability     Evolving
2057 .TE
2058 
2059 .SH SEE ALSO
2060 .sp
2061 .LP
2062 \fBzfs\fR(1M), \fBattributes\fR(5)
   1 '\" te
   2 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
   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
   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"
  18 .SH NAME
  19 zpool \- configures ZFS storage pools
  20 .SH SYNOPSIS
  21 .LP
  22 .nf
  23 \fBzpool\fR [\fB-?\fR]
  24 .fi
  25 
  26 .LP
  27 .nf
  28 \fBzpool add\fR [\fB-fn\fR] \fIpool\fR \fIvdev\fR ...
  29 .fi
  30 
  31 .LP
  32 .nf
  33 \fBzpool attach\fR [\fB-f\fR] \fIpool\fR \fIdevice\fR \fInew_device\fR
  34 .fi
  35 
  36 .LP
  37 .nf
  38 \fBzpool clear\fR \fIpool\fR [\fIdevice\fR]
  39 .fi
  40 
  41 .LP
  42 .nf
  43 \fBzpool create\fR [\fB-fnd\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-O\fR \fIfile-system-property=value\fR]
  44      ... [\fB-m\fR \fImountpoint\fR] [\fB-R\fR \fIroot\fR] \fIpool\fR \fIvdev\fR ...
  45 .fi
  46 
  47 .LP
  48 .nf
  49 \fBzpool destroy\fR [\fB-f\fR] \fIpool\fR
  50 .fi
  51 
  52 .LP
  53 .nf
  54 \fBzpool detach\fR \fIpool\fR \fIdevice\fR
  55 .fi
  56 
  57 .LP
  58 .nf
  59 \fBzpool export\fR [\fB-f\fR] \fIpool\fR ...
  60 .fi
  61 
  62 .LP
  63 .nf


 539 \fB\fBavailable\fR\fR
 540 .ad
 541 .RS 20n
 542 Amount of storage available within the pool. This property can also be referred
 543 to by its shortened column name, "avail".
 544 .RE
 545 
 546 .sp
 547 .ne 2
 548 .na
 549 \fB\fBcapacity\fR\fR
 550 .ad
 551 .RS 20n
 552 Percentage of pool space used. This property can also be referred to by its
 553 shortened column name, "cap".
 554 .RE
 555 
 556 .sp
 557 .ne 2
 558 .na
 559 \fB\fBexpandsize\fR\fR
 560 .ad
 561 .RS 20n
 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.
 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.
 587 .RE
 588 
 589 .sp
 590 .ne 2
 591 .na
 592 \fB\fBhealth\fR\fR
 593 .ad
 594 .RS 20n
 595 The current health of the pool. Health can be "\fBONLINE\fR", "\fBDEGRADED\fR",
 596 "\fBFAULTED\fR", " \fBOFFLINE\fR", "\fBREMOVED\fR", or "\fBUNAVAIL\fR".
 597 .RE
 598 
 599 .sp
 600 .ne 2
 601 .na
 602 \fB\fBguid\fR\fR
 603 .ad
 604 .RS 20n
 605 A unique identifier for the pool.
 606 .RE
 607 
 608 .sp
 609 .ne 2
 610 .na
 611 \fB\fBsize\fR\fR
 612 .ad
 613 .RS 20n
 614 Total size of the storage pool.
 615 .RE
 616 
 617 .sp
 618 .ne 2
 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
 630 \fB\fBused\fR\fR
 631 .ad
 632 .RS 20n
 633 Amount of storage space used within the pool.
 634 .RE
 635 
 636 .sp
 637 .LP
 638 The space usage properties report actual physical space available to the
 639 storage pool. The physical space can be different from the total amount of
 640 space that any contained datasets can actually use. The amount of space used in
 641 a \fBraidz\fR configuration depends on the characteristics of the data being
 642 written. In addition, \fBZFS\fR reserves some space for internal accounting
 643 that the \fBzfs\fR(1M) command takes into account, but the \fBzpool\fR command
 644 does not. For non-full pools of a reasonable size, these effects should be
 645 invisible. For small pools, or pools that are close to being completely full,
 646 these discrepancies may become more noticeable.
 647 .sp
 648 .LP
 649 The following property can be set at creation time and import time:
 650 .sp
 651 .ne 2
 652 .na
 653 \fB\fBaltroot\fR\fR
 654 .ad
 655 .sp .6
 656 .RS 4n
 657 Alternate root directory. If set, this directory is prepended to any mount
 658 points within the pool. This can be used when examining an unknown pool where


 717 Controls the location of where the pool configuration is cached. Discovering
 718 all pools on system startup requires a cached copy of the configuration data
 719 that is stored on the root file system. All pools in this cache are
 720 automatically imported when the system boots. Some environments, such as
 721 install and clustering, need to cache this information in a different location
 722 so that pools are not automatically imported. Setting this property caches the
 723 pool configuration in a different location that can later be imported with
 724 "\fBzpool import -c\fR". Setting it to the special value "\fBnone\fR" creates a
 725 temporary pool that is never cached, and the special value \fB\&''\fR (empty
 726 string) uses the default location.
 727 .sp
 728 Multiple pools can share the same cache file. Because the kernel destroys and
 729 recreates this file when pools are added and removed, care should be taken when
 730 attempting to access this file. When the last pool using a \fBcachefile\fR is
 731 exported or destroyed, the file is removed.
 732 .RE
 733 
 734 .sp
 735 .ne 2
 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
 748 \fB\fBdelegation\fR=\fBon\fR | \fBoff\fR\fR
 749 .ad
 750 .sp .6
 751 .RS 4n
 752 Controls whether a non-privileged user is granted access based on the dataset
 753 permissions defined on the dataset. See \fBzfs\fR(1M) for more information on
 754 \fBZFS\fR delegated administration.
 755 .RE
 756 
 757 .sp
 758 .ne 2
 759 .na
 760 \fB\fBfailmode\fR=\fBwait\fR | \fBcontinue\fR | \fBpanic\fR\fR
 761 .ad
 762 .sp .6
 763 .RS 4n
 764 Controls the system behavior in the event of catastrophic pool failure. This
 765 condition is typically a result of a loss of connectivity to the underlying
 766 storage device(s) or a failure of all devices within the pool. The behavior of
 767 such an event is determined as follows:


 783 .RS 12n
 784 Returns \fBEIO\fR to any new write \fBI/O\fR requests but allows reads to any
 785 of the remaining healthy devices. Any write requests that have yet to be
 786 committed to disk would be blocked.
 787 .RE
 788 
 789 .sp
 790 .ne 2
 791 .na
 792 \fB\fBpanic\fR\fR
 793 .ad
 794 .RS 12n
 795 Prints out a message to the console and generates a system crash dump.
 796 .RE
 797 
 798 .RE
 799 
 800 .sp
 801 .ne 2
 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
 815 \fB\fBlistsnaps\fR=on | off\fR
 816 .ad
 817 .sp .6
 818 .RS 4n
 819 Controls whether information about snapshots associated with this pool is
 820 output when "\fBzfs list\fR" is run without the \fB-t\fR option. The default
 821 value is "off".
 822 .RE
 823 
 824 .sp
 825 .ne 2
 826 .na
 827 \fB\fBversion\fR=\fIversion\fR\fR
 828 .ad
 829 .sp .6
 830 .RS 4n
 831 The current on-disk version of the pool. This can be increased, but never
 832 decreased. The preferred method of updating pools is with the "\fBzpool
 833 upgrade\fR" command, though this property can be used when a specific version
 834 is needed for backwards compatibility. Once feature flags is enabled on a
 835 pool this property will no longer have a value.
 836 .RE
 837 
 838 .SS "Subcommands"
 839 .sp
 840 .LP
 841 All subcommands that modify state are logged persistently to the pool in their
 842 original form.
 843 .sp
 844 .LP
 845 The \fBzpool\fR command provides subcommands to create and destroy storage
 846 pools, add capacity to storage pools, and provide information about the storage
 847 pools. The following subcommands are supported:
 848 .sp
 849 .ne 2
 850 .na
 851 \fB\fBzpool\fR \fB-?\fR\fR
 852 .ad
 853 .sp .6
 854 .RS 4n
 855 Displays a help message.


 916 devices can be overridden in this manner.
 917 .RE
 918 
 919 .RE
 920 
 921 .sp
 922 .ne 2
 923 .na
 924 \fB\fBzpool clear\fR \fIpool\fR [\fIdevice\fR] ...\fR
 925 .ad
 926 .sp .6
 927 .RS 4n
 928 Clears device errors in a pool. If no arguments are specified, all device
 929 errors within the pool are cleared. If one or more devices is specified, only
 930 those errors associated with the specified device or devices are cleared.
 931 .RE
 932 
 933 .sp
 934 .ne 2
 935 .na
 936 \fB\fBzpool create\fR [\fB-fnd\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-O\fR
 937 \fIfile-system-property=value\fR] ... [\fB-m\fR \fImountpoint\fR] [\fB-R\fR
 938 \fIroot\fR] \fIpool\fR \fIvdev\fR ...\fR
 939 .ad
 940 .sp .6
 941 .RS 4n
 942 Creates a new storage pool containing the virtual devices specified on the
 943 command line. The pool name must begin with a letter, and can only contain
 944 alphanumeric characters as well as underscore ("_"), dash ("-"), and period
 945 ("."). The pool names "mirror", "raidz", "spare" and "log" are reserved, as are
 946 names beginning with the pattern "c[0-9]". The \fBvdev\fR specification is
 947 described in the "Virtual Devices" section.
 948 .sp
 949 The command verifies that each device specified is accessible and not currently
 950 in use by another subsystem. There are some uses, such as being currently
 951 mounted, or specified as the dedicated dump device, that prevents a device from
 952 ever being used by \fBZFS\fR. Other uses, such as having a preexisting
 953 \fBUFS\fR file system, can be overridden with the \fB-f\fR option.
 954 .sp
 955 The command also checks that the replication strategy for the pool is
 956 consistent. An attempt to combine redundant and non-redundant storage in a
 957 single pool, or to mix disks and files, results in an error unless \fB-f\fR is
 958 specified. The use of differently sized devices within a single \fBraidz\fR or
 959 mirror group is also flagged as an error unless \fB-f\fR is specified.
 960 .sp
 961 Unless the \fB-R\fR option is specified, the default mount point is
 962 "/\fIpool\fR". The mount point must not exist or must be empty, or else the
 963 root dataset cannot be mounted. This can be overridden with the \fB-m\fR
 964 option.
 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
 969 .ne 2
 970 .na
 971 \fB\fB-f\fR\fR
 972 .ad
 973 .sp .6
 974 .RS 4n
 975 Forces use of \fBvdev\fRs, even if they appear in use or specify a conflicting
 976 replication level. Not all devices can be overridden in this manner.
 977 .RE
 978 
 979 .sp
 980 .ne 2
 981 .na
 982 \fB\fB-n\fR\fR
 983 .ad
 984 .sp .6
 985 .RS 4n
 986 Displays the configuration that would be used without actually creating the
 987 pool. The actual pool creation can still fail due to insufficient privileges or
 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.
1001 .RE
1002 
1003 .sp
1004 .ne 2
1005 .na
1006 \fB\fB-o\fR \fIproperty=value\fR [\fB-o\fR \fIproperty=value\fR] ...\fR
1007 .ad
1008 .sp .6
1009 .RS 4n
1010 Sets the given pool properties. See the "Properties" section for a list of
1011 valid properties that can be set.
1012 .RE
1013 
1014 .sp
1015 .ne 2
1016 .na
1017 \fB\fB-O\fR \fIfile-system-property=value\fR\fR
1018 .ad
1019 .br
1020 .na
1021 \fB[\fB-O\fR \fIfile-system-property=value\fR] ...\fR
1022 .ad
1023 .sp .6
1024 .RS 4n
1025 Sets the given file system properties in the root file system of the pool. See


2109 
2110 .SH ATTRIBUTES
2111 .sp
2112 .LP
2113 See \fBattributes\fR(5) for descriptions of the following attributes:
2114 .sp
2115 
2116 .sp
2117 .TS
2118 box;
2119 c | c
2120 l | l .
2121 ATTRIBUTE TYPE  ATTRIBUTE VALUE
2122 _
2123 Interface Stability     Evolving
2124 .TE
2125 
2126 .SH SEE ALSO
2127 .sp
2128 .LP
2129 \fBzfs\fR(1M), \fBzpool-features\fR(5), \fBattributes\fR(5)