| zpool.8 (236777) | zpool.8 (236884) |
|---|---|
| 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. |
|
| 23.\" | 24.\" |
| 24.\" $FreeBSD: head/cddl/contrib/opensolaris/cmd/zpool/zpool.8 236777 2012-06-09 03:34:34Z gjb $ | 25.\" $FreeBSD: head/cddl/contrib/opensolaris/cmd/zpool/zpool.8 236884 2012-06-11 11:35:22Z 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 | 26.\" 27.Dd November 28, 2011 28.Dt ZPOOL 8 29.Os 30.Sh NAME 31.Nm zpool 32.Nd configures ZFS storage pools 33.Sh SYNOPSIS --- 9 unchanged lines hidden (view full) --- 43.Ar pool device new_device 44.Nm 45.Cm clear 46.Op Fl F Op Fl n 47.Ar pool 48.Op Ar device 49.Nm 50.Cm create |
| 50.Op Fl fn | 51.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 --- 473 unchanged lines hidden (view full) --- 532The deduplication ratio specified for a pool, expressed as a multiplier. 533For example, a 534.S 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. | 52.Op Fl o Ar property Ns = Ns Ar value 53.Ar ... 54.Op Fl O Ar file-system-property Ns = Ns Ar value 55.Ar ... 56.Op Fl m Ar mountpoint 57.Op Fl R Ar root 58.Ar pool vdev ... 59.Nm --- 473 unchanged lines hidden (view full) --- 533The deduplication ratio specified for a pool, expressed as a multiplier. 534For example, a 535.S dedupratio 536value of 1.76 indicates that 1.76 units of data were stored but only 1 unit of disk space was actually consumed. See 537.Xr zfs 8 538for a description of the deduplication feature. 539.It Sy free 540Number of blocks within the pool that are not allocated. |
| 541.It Sy freeing 542After a file system or snapshot is destroyed, the space it was using is 543returned to the pool asynchronously. 544.Sy freeing 545is the amount of space remaining to be reclaimed. 546Over time 547.Sy freeing 548will decrease while 549.Sy free 550increases. |
|
| 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. | 551.It Sy expandsize 552This property has currently no value on FreeBSD. 553.It Sy guid 554A unique identifier for the pool. 555.It Sy health 556The current health of the pool. Health can be 557.Qq Sy ONLINE , 558.Qq Sy DEGRADED , 559.Qq Sy FAULTED , 560.Qq Sy OFFLINE , 561.Qq Sy REMOVED , 562or 563.Qq Sy UNAVAIL . 564.It Sy size 565Total size of the storage pool. |
| 566.It Sy unsupported@ Ns Ar feature_guid 567Information about unsupported features that are enabled on the pool. 568See 569.Xr zpool-features 5 570for details. |
|
| 555.It Sy used 556Amount of storage space used within the pool. 557.El 558.Pp | 571.It Sy used 572Amount of storage space used within the pool. 573.El 574.Pp |
| 559These space usage properties report actual physical space available to the | 575The 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. | 576storage pool. The physical space can be different from the total amount of 577space that any contained datasets can actually use. The amount of space used in 578a 579.No raidz 580configuration depends on the characteristics of the data being written. 581In addition, 582.Tn ZFS 583reserves some space for internal accounting that the --- 80 unchanged lines hidden (view full) --- 664so that pools are not automatically imported. Setting this property caches the 665pool configuration in a different location that can later be imported with 666.Qq Nm Cm import Fl c . 667Setting it to the special value 668.Qq Cm none 669creates a temporary pool that is never cached, and the special value 670.Cm '' 671(empty string) uses the default location. |
| 672.It Sy comment Ns = Ns Ar text 673A text string consisting of printable ASCII characters that will be stored 674such that it is available even if the pool becomes faulted. 675An administrator can provide additional information about a pool using this 676property. |
|
| 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 | 677.It Sy dedupditto Ns = Ns Ar number 678Threshold for the number of block ditto copies. If the reference count for a 679deduplicated block increases above this number, a new ditto copy of this block 680is automatically stored. Default setting is 681.Cm 0 . 682.It Sy delegation Ns = Ns Cm on No | Cm off 683Controls whether a non-privileged user is granted access based on the dataset 684permissions defined on the dataset. See --- 17 unchanged lines hidden (view full) --- 702.Em EIO 703to any new write 704.Tn I/O 705requests but allows reads to any of the remaining healthy devices. Any write 706requests that have yet to be committed to disk would be blocked. 707.It Sy panic 708Prints out a message to the console and generates a system crash dump. 709.El |
| 710.It Sy feature@ Ns Ar feature_name Ns = Ns Sy enabled 711The value of this property is the current state of 712.Ar feature_name . 713The only valid value when setting this property is 714.Sy enabled 715which moves 716.Ar feature_name 717to the enabled state. 718See 719.Xr zpool-features 5 720for 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 | 721.It Sy listsnaps Ns = Ns Cm on No | Cm off 722Controls whether information about snapshots associated with this pool is 723output when 724.Qq Nm zfs Cm list 725is run without the 726.Fl t 727option. The default value is 728.Cm off . 729.It Sy version Ns = Ns Ar version 730The current on-disk version of the pool. This can be increased, but never 731decreased. The preferred method of updating pools is with the 732.Qq Nm Cm upgrade 733command, 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 . | 734for backwards compatibility. 735Once feature flags is enabled on a pool this property will no longer have a 736value. |
| 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 | 737.El 738.Sh SUBCOMMANDS 739All subcommands that modify state are logged persistently to the pool in their 740original form. 741.Pp 742The 743.Nm 744command provides subcommands to create and destroy storage pools, add capacity --- 92 unchanged lines hidden (view full) --- 837Used in combination with the 838.Fl F 839flag. Check whether discarding transactions would make the pool openable, but 840do not actually discard any transactions. 841.El 842.It Xo 843.Nm 844.Cm create |
| 813.Op Fl fn | 845.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. | 846.Op Fl o Ar property Ns = Ns Ar value 847.Ar ... 848.Op Fl O Ar file-system-property Ns = Ns Ar value 849.Ar ... 850.Op Fl m Ar mountpoint 851.Op Fl R Ar root 852.Ar pool vdev ... 853.Xc --- 32 unchanged lines hidden (view full) --- 886Unless the 887.Fl R 888option is specified, the default mount point is 889.Qq Pa /pool . 890The mount point must not exist or must be empty, or else the 891root dataset cannot be mounted. This can be overridden with the 892.Fl m 893option. |
| 894.Pp 895By default all supported features are enabled on the new pool unless the 896.Fl d 897option 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. | 898.Bl -tag -width indent 899.It Fl f 900Forces use of 901.Ar vdev Ns s, 902even if they appear in use or specify a conflicting replication level. 903Not all devices can be overridden in this manner. 904.It Fl n 905Displays the configuration that would be used without actually creating the 906pool. The actual pool creation can still fail due to insufficient privileges or 907device sharing. |
| 908.It Fl d 909Do not enable any features on the new pool. 910Individual features can be enabled by setting their corresponding properties 911to 912.Sy enabled 913with the 914.Fl o 915option. 916See 917.Xr zpool-features 5 918for 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. --- 988 unchanged lines hidden (view full) --- 1868Successful completion. 1869.It 1 1870An error occurred. 1871.It 2 1872Invalid command line options were specified. 1873.El 1874.Sh SEE ALSO 1875.Xr zfs 8 | 919.It Xo 920.Fl o Ar property Ns = Ns Ar value 921.Op Fl o Ar property Ns = Ns Ar value 922.Ar ... 923.Xc 924Sets the given pool properties. See the 925.Qq Sx Properties 926section for a list of valid properties that can be set. --- 988 unchanged lines hidden (view full) --- 1915Successful completion. 1916.It 1 1917An error occurred. 1918.It 2 1919Invalid command line options were specified. 1920.El 1921.Sh SEE ALSO 1922.Xr zfs 8 |
| 1923.Xr zpool-features 5 |
|
| 1876.Sh AUTHORS 1877This manual page is a 1878.Xr mdoc 7 1879reimplementation of the 1880.Tn OpenSolaris 1881manual page 1882.Em zpool(1M) , 1883modified and customized for 1884.Fx 1885and licensed under the Common Development and Distribution License 1886.Pq Tn CDDL . 1887.Pp 1888The 1889.Xr mdoc 7 1890implementation of this manual page was initially written by 1891.An Martin Matuska Aq mm@FreeBSD.org . | 1924.Sh AUTHORS 1925This manual page is a 1926.Xr mdoc 7 1927reimplementation of the 1928.Tn OpenSolaris 1929manual page 1930.Em zpool(1M) , 1931modified and customized for 1932.Fx 1933and licensed under the Common Development and Distribution License 1934.Pq Tn CDDL . 1935.Pp 1936The 1937.Xr mdoc 7 1938implementation of this manual page was initially written by 1939.An Martin Matuska Aq mm@FreeBSD.org . |