| zpool.8 (237148) | zpool.8 (243674) |
|---|---|
| 1'\" te | 1'\" te |
| 2.\" Copyright (c) 2011, Martin Matuska <mm@FreeBSD.org>. | 2.\" Copyright (c) 2012, Martin Matuska <mm@FreeBSD.org>. |
| 3.\" All Rights Reserved. 4.\" 5.\" The contents of this file are subject to the terms of the 6.\" Common Development and Distribution License (the "License"). 7.\" You may not use this file except in compliance with the License. 8.\" 9.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10.\" or http://www.opensolaris.org/os/licensing. --- 4 unchanged lines hidden (view full) --- 15.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16.\" If applicable, add the following below this CDDL HEADER, with the 17.\" fields enclosed by brackets "[]" replaced with your own identifying 18.\" information: Portions Copyright [yyyy] [name of copyright owner] 19.\" 20.\" Copyright (c) 2010, Sun Microsystems, Inc. All Rights Reserved. 21.\" Copyright 2011, Nexenta Systems, Inc. All Rights Reserved. 22.\" Copyright (c) 2011, Justin T. Gibbs <gibbs@FreeBSD.org> | 3.\" All Rights Reserved. 4.\" 5.\" The contents of this file are subject to the terms of the 6.\" Common Development and Distribution License (the "License"). 7.\" You may not use this file except in compliance with the License. 8.\" 9.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10.\" or http://www.opensolaris.org/os/licensing. --- 4 unchanged lines hidden (view full) --- 15.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16.\" If applicable, add the following below this CDDL HEADER, with the 17.\" fields enclosed by brackets "[]" replaced with your own identifying 18.\" information: Portions Copyright [yyyy] [name of copyright owner] 19.\" 20.\" Copyright (c) 2010, Sun Microsystems, Inc. All Rights Reserved. 21.\" Copyright 2011, Nexenta Systems, Inc. All Rights Reserved. 22.\" Copyright (c) 2011, Justin T. Gibbs <gibbs@FreeBSD.org> |
| 23.\" Copyright (c) 2012 by Delphix. All Rights Reserved. 24.\" Copyright (c) 2012, Glen Barber <gjb@FreeBSD.org> |
|
| 23.\" | 25.\" |
| 24.\" $FreeBSD: stable/9/cddl/contrib/opensolaris/cmd/zpool/zpool.8 237148 2012-06-15 22:56:15Z gjb $ | 26.\" $FreeBSD: stable/9/cddl/contrib/opensolaris/cmd/zpool/zpool.8 243674 2012-11-29 14:05:04Z mm $ |
| 25.\" 26.Dd November 28, 2011 27.Dt ZPOOL 8 28.Os 29.Sh NAME 30.Nm zpool 31.Nd configures ZFS storage pools 32.Sh SYNOPSIS --- 9 unchanged lines hidden (view full) --- 42.Ar pool device new_device 43.Nm 44.Cm clear 45.Op Fl F Op Fl n 46.Ar pool 47.Op Ar device 48.Nm 49.Cm create | 27.\" 28.Dd November 28, 2011 29.Dt ZPOOL 8 30.Os 31.Sh NAME 32.Nm zpool 33.Nd configures ZFS storage pools 34.Sh SYNOPSIS --- 9 unchanged lines hidden (view full) --- 44.Ar pool device new_device 45.Nm 46.Cm clear 47.Op Fl F Op Fl n 48.Ar pool 49.Op Ar device 50.Nm 51.Cm create |
| 50.Op Fl fn | 52.Op Fl fnd |
| 51.Op Fl o Ar property Ns = Ns Ar value 52.Ar ... 53.Op Fl O Ar file-system-property Ns = Ns Ar value 54.Ar ... 55.Op Fl m Ar mountpoint 56.Op Fl R Ar root 57.Ar pool vdev ... 58.Nm --- 128 unchanged lines hidden (view full) --- 187for information on managing datasets. 188.Ss Virtual Devices (vdevs) 189A 190.Qq virtual device 191.Pq No vdev 192describes a single device or a collection of devices organized according to 193certain performance and fault characteristics. The following virtual devices 194are supported: | 53.Op Fl o Ar property Ns = Ns Ar value 54.Ar ... 55.Op Fl O Ar file-system-property Ns = Ns Ar value 56.Ar ... 57.Op Fl m Ar mountpoint 58.Op Fl R Ar root 59.Ar pool vdev ... 60.Nm --- 128 unchanged lines hidden (view full) --- 189for information on managing datasets. 190.Ss Virtual Devices (vdevs) 191A 192.Qq virtual device 193.Pq No vdev 194describes a single device or a collection of devices organized according to 195certain performance and fault characteristics. The following virtual devices 196are supported: |
| 195.Bl -tag | 197.Bl -tag -width "XXXXXX" |
| 196.It Sy disk 197A block device, typically located under 198.Pa /dev . 199.Tn ZFS 200can use individual slices or partitions, though the recommended mode of 201operation is to use whole disks. A disk can be specified by a full path to the 202device or the 203.Xr geom 4 --- 322 unchanged lines hidden (view full) --- 526shortened column name, "cap". 527.It Sy comment 528A text string consisting of printable ASCII characters that will be stored 529such that it is available even if the pool becomes faulted. An administrator 530can provide additional information about a pool using this property. 531.It Sy dedupratio 532The deduplication ratio specified for a pool, expressed as a multiplier. 533For example, a | 198.It Sy disk 199A block device, typically located under 200.Pa /dev . 201.Tn ZFS 202can use individual slices or partitions, though the recommended mode of 203operation is to use whole disks. A disk can be specified by a full path to the 204device or the 205.Xr geom 4 --- 322 unchanged lines hidden (view full) --- 528shortened column name, "cap". 529.It Sy comment 530A text string consisting of printable ASCII characters that will be stored 531such that it is available even if the pool becomes faulted. An administrator 532can provide additional information about a pool using this property. 533.It Sy dedupratio 534The deduplication ratio specified for a pool, expressed as a multiplier. 535For example, a |
| 534.S dedupratio | 536.Sy dedupratio |
| 535value of 1.76 indicates that 1.76 units of data were stored but only 1 unit of disk space was actually consumed. See 536.Xr zfs 8 537for a description of the deduplication feature. 538.It Sy free 539Number of blocks within the pool that are not allocated. | 537value of 1.76 indicates that 1.76 units of data were stored but only 1 unit of disk space was actually consumed. See 538.Xr zfs 8 539for a description of the deduplication feature. 540.It Sy free 541Number of blocks within the pool that are not allocated. |
| 542.It Sy freeing 543After a file system or snapshot is destroyed, the space it was using is 544returned to the pool asynchronously. 545.Sy freeing 546is the amount of space remaining to be reclaimed. 547Over time 548.Sy freeing 549will decrease while 550.Sy free 551increases. |
|
| 540.It Sy expandsize 541This property has currently no value on FreeBSD. 542.It Sy guid 543A unique identifier for the pool. 544.It Sy health 545The current health of the pool. Health can be 546.Qq Sy ONLINE , 547.Qq Sy DEGRADED , 548.Qq Sy FAULTED , 549.Qq Sy OFFLINE , 550.Qq Sy REMOVED , 551or 552.Qq Sy UNAVAIL . 553.It Sy size 554Total size of the storage pool. | 552.It Sy expandsize 553This property has currently no value on FreeBSD. 554.It Sy guid 555A unique identifier for the pool. 556.It Sy health 557The current health of the pool. Health can be 558.Qq Sy ONLINE , 559.Qq Sy DEGRADED , 560.Qq Sy FAULTED , 561.Qq Sy OFFLINE , 562.Qq Sy REMOVED , 563or 564.Qq Sy UNAVAIL . 565.It Sy size 566Total size of the storage pool. |
| 567.It Sy unsupported@ Ns Ar feature_guid 568Information about unsupported features that are enabled on the pool. 569See 570.Xr zpool-features 7 571for details. |
|
| 555.It Sy used 556Amount of storage space used within the pool. 557.El 558.Pp | 572.It Sy used 573Amount of storage space used within the pool. 574.El 575.Pp |
| 559These space usage properties report actual physical space available to the | 576The space usage properties report actual physical space available to the |
| 560storage pool. The physical space can be different from the total amount of 561space that any contained datasets can actually use. The amount of space used in 562a 563.No raidz 564configuration depends on the characteristics of the data being written. 565In addition, 566.Tn ZFS 567reserves some space for internal accounting that the --- 80 unchanged lines hidden (view full) --- 648so that pools are not automatically imported. Setting this property caches the 649pool configuration in a different location that can later be imported with 650.Qq Nm Cm import Fl c . 651Setting it to the special value 652.Qq Cm none 653creates a temporary pool that is never cached, and the special value 654.Cm '' 655(empty string) uses the default location. | 577storage pool. The physical space can be different from the total amount of 578space that any contained datasets can actually use. The amount of space used in 579a 580.No raidz 581configuration depends on the characteristics of the data being written. 582In addition, 583.Tn ZFS 584reserves some space for internal accounting that the --- 80 unchanged lines hidden (view full) --- 665so that pools are not automatically imported. Setting this property caches the 666pool configuration in a different location that can later be imported with 667.Qq Nm Cm import Fl c . 668Setting it to the special value 669.Qq Cm none 670creates a temporary pool that is never cached, and the special value 671.Cm '' 672(empty string) uses the default location. |
| 673.It Sy comment Ns = Ns Ar text 674A text string consisting of printable ASCII characters that will be stored 675such that it is available even if the pool becomes faulted. 676An administrator can provide additional information about a pool using this 677property. |
|
| 656.It Sy dedupditto Ns = Ns Ar number 657Threshold for the number of block ditto copies. If the reference count for a 658deduplicated block increases above this number, a new ditto copy of this block 659is automatically stored. Default setting is 660.Cm 0 . 661.It Sy delegation Ns = Ns Cm on No | Cm off 662Controls whether a non-privileged user is granted access based on the dataset 663permissions defined on the dataset. See --- 17 unchanged lines hidden (view full) --- 681.Em EIO 682to any new write 683.Tn I/O 684requests but allows reads to any of the remaining healthy devices. Any write 685requests that have yet to be committed to disk would be blocked. 686.It Sy panic 687Prints out a message to the console and generates a system crash dump. 688.El | 678.It Sy dedupditto Ns = Ns Ar number 679Threshold for the number of block ditto copies. If the reference count for a 680deduplicated block increases above this number, a new ditto copy of this block 681is automatically stored. Default setting is 682.Cm 0 . 683.It Sy delegation Ns = Ns Cm on No | Cm off 684Controls whether a non-privileged user is granted access based on the dataset 685permissions defined on the dataset. See --- 17 unchanged lines hidden (view full) --- 703.Em EIO 704to any new write 705.Tn I/O 706requests but allows reads to any of the remaining healthy devices. Any write 707requests that have yet to be committed to disk would be blocked. 708.It Sy panic 709Prints out a message to the console and generates a system crash dump. 710.El |
| 711.It Sy feature@ Ns Ar feature_name Ns = Ns Sy enabled 712The value of this property is the current state of 713.Ar feature_name . 714The only valid value when setting this property is 715.Sy enabled 716which moves 717.Ar feature_name 718to the enabled state. 719See 720.Xr zpool-features 7 721for details on feature states. |
|
| 689.It Sy listsnaps Ns = Ns Cm on No | Cm off 690Controls whether information about snapshots associated with this pool is 691output when 692.Qq Nm zfs Cm list 693is run without the 694.Fl t 695option. The default value is 696.Cm off . 697.It Sy version Ns = Ns Ar version 698The current on-disk version of the pool. This can be increased, but never 699decreased. The preferred method of updating pools is with the 700.Qq Nm Cm upgrade 701command, though this property can be used when a specific version is needed | 722.It Sy listsnaps Ns = Ns Cm on No | Cm off 723Controls whether information about snapshots associated with this pool is 724output when 725.Qq Nm zfs Cm list 726is run without the 727.Fl t 728option. The default value is 729.Cm off . 730.It Sy version Ns = Ns Ar version 731The current on-disk version of the pool. This can be increased, but never 732decreased. The preferred method of updating pools is with the 733.Qq Nm Cm upgrade 734command, though this property can be used when a specific version is needed |
| 702for backwards compatibility. This property can be any number between 1 and the 703current version reported by 704.Qo Ic zpool upgrade -v Qc . | 735for backwards compatibility. 736Once feature flags is enabled on a pool this property will no longer have a 737value. |
| 705.El 706.Sh SUBCOMMANDS 707All subcommands that modify state are logged persistently to the pool in their 708original form. 709.Pp 710The 711.Nm 712command provides subcommands to create and destroy storage pools, add capacity --- 92 unchanged lines hidden (view full) --- 805Used in combination with the 806.Fl F 807flag. Check whether discarding transactions would make the pool openable, but 808do not actually discard any transactions. 809.El 810.It Xo 811.Nm 812.Cm create | 738.El 739.Sh SUBCOMMANDS 740All subcommands that modify state are logged persistently to the pool in their 741original form. 742.Pp 743The 744.Nm 745command provides subcommands to create and destroy storage pools, add capacity --- 92 unchanged lines hidden (view full) --- 838Used in combination with the 839.Fl F 840flag. Check whether discarding transactions would make the pool openable, but 841do not actually discard any transactions. 842.El 843.It Xo 844.Nm 845.Cm create |
| 813.Op Fl fn | 846.Op Fl fnd |
| 814.Op Fl o Ar property Ns = Ns Ar value 815.Ar ... 816.Op Fl O Ar file-system-property Ns = Ns Ar value 817.Ar ... 818.Op Fl m Ar mountpoint 819.Op Fl R Ar root 820.Ar pool vdev ... 821.Xc --- 32 unchanged lines hidden (view full) --- 854Unless the 855.Fl R 856option is specified, the default mount point is 857.Qq Pa /pool . 858The mount point must not exist or must be empty, or else the 859root dataset cannot be mounted. This can be overridden with the 860.Fl m 861option. | 847.Op Fl o Ar property Ns = Ns Ar value 848.Ar ... 849.Op Fl O Ar file-system-property Ns = Ns Ar value 850.Ar ... 851.Op Fl m Ar mountpoint 852.Op Fl R Ar root 853.Ar pool vdev ... 854.Xc --- 32 unchanged lines hidden (view full) --- 887Unless the 888.Fl R 889option is specified, the default mount point is 890.Qq Pa /pool . 891The mount point must not exist or must be empty, or else the 892root dataset cannot be mounted. This can be overridden with the 893.Fl m 894option. |
| 895.Pp 896By default all supported features are enabled on the new pool unless the 897.Fl d 898option is specified. |
|
| 862.Bl -tag -width indent 863.It Fl f 864Forces use of 865.Ar vdev Ns s, 866even if they appear in use or specify a conflicting replication level. 867Not all devices can be overridden in this manner. 868.It Fl n 869Displays the configuration that would be used without actually creating the 870pool. The actual pool creation can still fail due to insufficient privileges or 871device sharing. | 899.Bl -tag -width indent 900.It Fl f 901Forces use of 902.Ar vdev Ns s, 903even if they appear in use or specify a conflicting replication level. 904Not all devices can be overridden in this manner. 905.It Fl n 906Displays the configuration that would be used without actually creating the 907pool. The actual pool creation can still fail due to insufficient privileges or 908device sharing. |
| 909.It Fl d 910Do not enable any features on the new pool. 911Individual features can be enabled by setting their corresponding properties 912to 913.Sy enabled 914with the 915.Fl o 916option. 917See 918.Xr zpool-features 7 919for details about feature properties. |
|
| 872.It Xo 873.Fl o Ar property Ns = Ns Ar value 874.Op Fl o Ar property Ns = Ns Ar value 875.Ar ... 876.Xc 877Sets the given pool properties. See the 878.Qq Sx Properties 879section for a list of valid properties that can be set. --- 704 unchanged lines hidden (view full) --- 1584.Pq equals Qq Ic date +%s . 1585.El 1586.It Xo 1587.Nm 1588.Cm upgrade 1589.Op Fl v 1590.Xc 1591.Pp | 920.It Xo 921.Fl o Ar property Ns = Ns Ar value 922.Op Fl o Ar property Ns = Ns Ar value 923.Ar ... 924.Xc 925Sets the given pool properties. See the 926.Qq Sx Properties 927section for a list of valid properties that can be set. --- 704 unchanged lines hidden (view full) --- 1632.Pq equals Qq Ic date +%s . 1633.El 1634.It Xo 1635.Nm 1636.Cm upgrade 1637.Op Fl v 1638.Xc 1639.Pp |
| 1592Displays all pools formatted using a different | 1640Displays pools which do not have all supported features enabled and pools 1641formatted using a legacy |
| 1593.Tn ZFS | 1642.Tn ZFS |
| 1594pool on-disk version. Older versions can continue to be used, but some 1595features may not be available. These pools can be upgraded using 1596.Qq Nm Cm upgrade Fl a . 1597Pools that are formatted with a more recent version are also displayed, 1598although these pools will be inaccessible on the system. | 1643version number. 1644These pools can continue to be used, but some features may not be available. 1645Use 1646.Nm Cm upgrade Fl a 1647to enable all features on all pools. |
| 1599.Bl -tag -width indent 1600.It Fl v | 1648.Bl -tag -width indent 1649.It Fl v |
| 1601Displays | 1650Displays legacy |
| 1602.Tn ZFS | 1651.Tn ZFS |
| 1603pool versions supported by the current software. The current 1604.Tn ZFS 1605pool version and all previous supported versions are displayed, along 1606with an explanation of the features provided with each version. | 1652versions supported by the current software. 1653See 1654.Xr zpool-features 7 1655for a description of feature flags features supported by the current software. |
| 1607.El 1608.It Xo 1609.Nm 1610.Cm upgrade 1611.Op Fl V Ar version 1612.Fl a | Ar pool ... 1613.Xc 1614.Pp | 1656.El 1657.It Xo 1658.Nm 1659.Cm upgrade 1660.Op Fl V Ar version 1661.Fl a | Ar pool ... 1662.Xc 1663.Pp |
| 1615Upgrades the given pool to the latest on-disk pool version. Once this is done, 1616the pool will no longer be accessible on systems running older versions of the 1617software. | 1664Enables all supported features on the given pool. 1665Once this is done, the pool will no longer be accessible on systems that do 1666not support feature flags. 1667See 1668.Xr zpool-features 7 1669for details on compatability with system sthat support feature flags, but do 1670not support all features enabled on the pool. |
| 1618.Bl -tag -width indent 1619.It Fl a | 1671.Bl -tag -width indent 1672.It Fl a |
| 1620Upgrades all pools. | 1673Enables all supported features on all pools. |
| 1621.It Fl V Ar version | 1674.It Fl V Ar version |
| 1622Upgrade to the specified version. If the | 1675Upgrade to the specified legacy version. If the |
| 1623.Fl V | 1676.Fl V |
| 1624flag is not specified, the pool is upgraded to the most recent version. This 1625option can only be used to increase the version number, and only up to the most 1626recent version supported by this software. | 1677flag is specified, no features will be enabled on the pool. 1678This option can only be used to increase version number up to the last 1679supported legacy version number. |
| 1627.El 1628.El | 1680.El 1681.El |
| 1682.Sh EXIT STATUS 1683The following exit values are returned: 1684.Bl -tag -offset 2n -width 2n 1685.It 0 1686Successful completion. 1687.It 1 1688An error occurred. 1689.It 2 1690Invalid command line options were specified. 1691.El |
|
| 1629.Sh EXAMPLES 1630.Bl -tag -width 0n 1631.It Sy Example 1 No Creating a RAID-Z Storage Pool 1632.Pp 1633The following command creates a pool with a single 1634.No raidz 1635root 1636.No vdev --- 221 unchanged lines hidden (view full) --- 1858.Qq Nm Cm import 1859with the recovery mode flag: 1860.Bd -literal -offset 2n 1861.Li # Ic zpool import -F data 1862Pool data returned to its state as of Tue Sep 08 13:23:35 2009. 1863Discarded approximately 29 seconds of transactions. 1864.Ed 1865.El | 1692.Sh EXAMPLES 1693.Bl -tag -width 0n 1694.It Sy Example 1 No Creating a RAID-Z Storage Pool 1695.Pp 1696The following command creates a pool with a single 1697.No raidz 1698root 1699.No vdev --- 221 unchanged lines hidden (view full) --- 1921.Qq Nm Cm import 1922with the recovery mode flag: 1923.Bd -literal -offset 2n 1924.Li # Ic zpool import -F data 1925Pool data returned to its state as of Tue Sep 08 13:23:35 2009. 1926Discarded approximately 29 seconds of transactions. 1927.Ed 1928.El |
| 1866.Sh EXIT STATUS 1867The following exit values are returned: 1868.Bl -tag -offset 2n -width 2n 1869.It 0 1870Successful completion. 1871.It 1 1872An error occurred. 1873.It 2 1874Invalid command line options were specified. 1875.El | |
| 1876.Sh SEE ALSO 1877.Xr zfs 8 | 1929.Sh SEE ALSO 1930.Xr zfs 8 |
| 1931.Xr zpool-features 7 |
|
| 1878.Sh AUTHORS 1879This manual page is a 1880.Xr mdoc 7 1881reimplementation of the 1882.Tn OpenSolaris 1883manual page 1884.Em zpool(1M) , 1885modified and customized for 1886.Fx 1887and licensed under the Common Development and Distribution License 1888.Pq Tn CDDL . 1889.Pp 1890The 1891.Xr mdoc 7 1892implementation of this manual page was initially written by 1893.An Martin Matuska Aq mm@FreeBSD.org . | 1932.Sh AUTHORS 1933This manual page is a 1934.Xr mdoc 7 1935reimplementation of the 1936.Tn OpenSolaris 1937manual page 1938.Em zpool(1M) , 1939modified and customized for 1940.Fx 1941and licensed under the Common Development and Distribution License 1942.Pq Tn CDDL . 1943.Pp 1944The 1945.Xr mdoc 7 1946implementation of this manual page was initially written by 1947.An Martin Matuska Aq mm@FreeBSD.org . |