Project

General

Profile

Feature #1801 » zfs.1m-dist-osol134.diff

zfs.1m diff between sunosman-20090930 and OpenSolaris snv_134 - Martin Matuška, 2011-11-21 11:07 AM

View differences:

zfs.1m 2011-11-21 10:46:48.851702166 +0100
6 6
.\" 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.
7 7
.\"  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
8 8
.\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
9
.TH zfs 1M "24 Sep 2009" "SunOS 5.11" "System Administration Commands"
9
.TH zfs 1M "21 Dec 2009" "SunOS 5.11" "System Administration Commands"
10 10
.SH NAME
11 11
zfs \- configures ZFS file systems
12 12
.SH SYNOPSIS
......
85 85

  
86 86
.LP
87 87
.nf
88
\fBzfs\fR \fBget\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR][\fB-Hp\fR][\fB-o\fR \fIfield\fR[,...]] [\fB-s\fR \fIsource\fR[,...]]
89
     "\fIall\fR" | \fIproperty\fR[,...] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...
88
\fBzfs\fR \fBget\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR][\fB-Hp\fR][\fB-o\fR all | \fIfield\fR[,...]] [\fB-s\fR \fIsource\fR[,...]]
89
     all | \fIproperty\fR[,...] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...
90 90
.fi
91 91

  
92 92
.LP
93 93
.nf
94
\fBzfs\fR \fBinherit\fR [\fB-r\fR] \fIproperty\fR \fIfilesystem\fR|\fIvolume|snapshot\fR ...
94
\fBzfs\fR \fBinherit\fR [\fB-rS\fR] \fIproperty\fR \fIfilesystem\fR|\fIvolume|snapshot\fR ...
95 95
.fi
96 96

  
97 97
.LP
......
143 143

  
144 144
.LP
145 145
.nf
146
\fBzfs\fR \fBsend\fR [\fB-vR\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR
146
\fBzfs\fR \fBsend\fR [\fB-DvRp\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR
147 147
.fi
148 148

  
149 149
.LP
......
153 153

  
154 154
.LP
155 155
.nf
156
\fBzfs\fR \fBreceive\fR [\fB-vnFu\fR] \fB-d\fR \fIfilesystem\fR
156
\fBzfs\fR \fBreceive\fR [\fB-vnFu\fR] [\fB-d\fR | \fB-e\fR] \fIfilesystem\fR
157 157
.fi
158 158

  
159 159
.LP
......
337 337
.sp
338 338
.LP
339 339
The global administrator can forcibly clear the \fBzoned\fR property, though this should be done with extreme care. The global administrator should verify that all the mount points are acceptable before clearing the property.
340
.SS "Deduplication"
341
.sp
342
.LP
343
Deduplication is the process for removing redundant data at  the block-level, reducing the total amount of data stored. If a file system has the \fBdedup\fR  property enabled, duplicate data blocks are removed synchronously.  The result is that only unique data is stored and common components are shared among files.
340 344
.SS "Native Properties"
341 345
.sp
342 346
.LP
......
660 664
.ad
661 665
.sp .6
662 666
.RS 4n
663
Controls the checksum used to verify data integrity. The default value is \fBon\fR, which automatically selects an appropriate algorithm (currently, \fBfletcher2\fR, but this may change in future releases). The value \fBoff\fR disables integrity checking on user data. Disabling checksums is \fBNOT\fR a recommended practice.
667
Controls the checksum used to verify data integrity. The default value is \fBon\fR, which automatically selects an appropriate algorithm (currently, \fBfletcher4\fR, but this may change in future releases). The value \fBoff\fR disables integrity checking on user data. Disabling checksums is \fBNOT\fR a recommended practice.
664 668
.sp
665 669
Changing this property affects only newly-written data.
666 670
.RE
......
669 673
.ne 2
670 674
.mk
671 675
.na
672
\fB\fBcompression\fR=\fBon\fR | \fBoff\fR | \fBlzjb\fR | \fBgzip\fR | \fBgzip-\fR\fIN\fR\fR
676
\fB\fBcompression\fR=\fBon\fR | \fBoff\fR | \fBlzjb\fR | \fBgzip\fR | \fBgzip-\fR\fIN\fR | \fBzle\fR\fR
673 677
.ad
674 678
.sp .6
675 679
.RS 4n
......
695 699
.ne 2
696 700
.mk
697 701
.na
702
\fB\fBdedup\fR=\fBon\fR | \fBoff\fR | \fBverify\fR | \fBsha256\fR[,\fBverify\fR]\fR
703
.ad
704
.sp .6
705
.RS 4n
706
Controls whether deduplication is in effect for a dataset. The default value is \fBoff\fR. The default checksum used for deduplication is \fBsha256\fR (subject to change). When \fBdedup\fR is enabled, the \fBdedup\fR checksum algorithm overrides the \fBchecksum\fR property. Setting the value to \fBverify\fR is equivalent to specifying \fBsha256,verify\fR.
707
.sp
708
If the property is set to \fBverify\fR, then, whenever two blocks have the same signature, ZFS will do a byte-for-byte comparison with the existing block to ensure that the contents are identical.
709
.RE
710

  
711
.sp
712
.ne 2
713
.mk
714
.na
698 715
\fB\fBdevices\fR=\fBon\fR | \fBoff\fR\fR
699 716
.ad
700 717
.sp .6
......
717 734
.ne 2
718 735
.mk
719 736
.na
737
\fB\fBmlslabel\fR=\fIlabel\fR | \fBnone\fR\fR
738
.ad
739
.sp .6
740
.RS 4n
741
The \fBmlslabel\fR property is a sensitivity label that determines if a dataset  can be mounted in a zone on a system with Trusted Extensions enabled. If the labeled dataset matches the labeled zone, the dataset can be mounted  and accessed from the labeled zone.
742
.sp
743
When the \fBmlslabel\fR property is not set, the default value is \fBnone\fR. Setting the  \fBmlslabel\fR property to \fBnone\fR is equivalent to removing the property.
744
.sp
745
The \fBmlslabel\fR property can be modified only when Trusted Extensions is enabled and only with appropriate privilege. Rights to modify it cannot be delegated. When changing a label to a higher label or setting the initial dataset label, the \fB{PRIV_FILE_UPGRADE_SL}\fR privilege is required. When changing a label to a lower label or the default (\fBnone\fR), the \fB{PRIV_FILE_DOWNGRADE_SL}\fR privilege is required. Changing the dataset to labels other than the default can be done only when the dataset is not mounted. When a dataset with the default label is mounted into a labeled-zone, the mount operation automatically sets the \fBmlslabel\fR property to the label of that zone.
746
.sp
747
When Trusted Extensions is \fBnot\fR enabled, only datasets with the default label (\fBnone\fR) can be mounted.
748
.RE
749

  
750
.sp
751
.ne 2
752
.mk
753
.na
720 754
\fB\fBmountpoint\fR=\fIpath\fR | \fBnone\fR | \fBlegacy\fR\fR
721 755
.ad
722 756
.sp .6
......
769 803
.ad
770 804
.sp .6
771 805
.RS 4n
772
Limits the amount of space consumed by the specified user. User space consumption is identified by the \fBuserspace@\fR\fIuser\fR property.
806
Limits the amount of space consumed by the specified user. Similar to the \fBrefquota\fR property, the \fBuserquota\fR space calculation does not include space that is used by descendent datasets, such as snapshots and clones. User space consumption is identified by the \fBuserspace@\fR\fIuser\fR property.
773 807
.sp
774
Enforcement of user quotas may be delayed by several seconds. This delay means that a user might exceed their quota before the system notices that they are over quota and begins to refuse additional writes with the \fBEDQUOT\fR error message . See the \fBzfs userspace\fR subcommand for more information.
808
Enforcement of user quotas may be delayed by several seconds. This delay means that a user might exceed her quota before the system notices that she is over quota. The system would then begin to refuse additional writes with the \fBEDQUOT\fR error message . See the \fBzfs userspace\fR subcommand for more information.
775 809
.sp
776 810
Unprivileged users can only access their own groups' space usage. The root user, or a user who has been granted the \fBuserquota\fR privilege with \fBzfs allow\fR, can get and set everyone's quota.
777 811
.sp
......
959 993
.ad
960 994
.sp .6
961 995
.RS 4n
962
Provide a hint to ZFS about handling of synchronous requests in this dataset. If \fBlogbias\fR is set to \fBlatency\fR (the default), ZFS will use pool log devices (if configured) to handle the requests at low latency. If \fBlogbias\fR is set to \fBthroughput\fR, ZFS will not use configured pool log devices. ZFS will instead optimize synchronous operations for global pool throughput and efficient use of resources.
996
Provides a hint to ZFS about handling of synchronous requests in this dataset. If \fBlogbias\fR is set to \fBlatency\fR (the default), ZFS uses the pool's log devices (if configured) to handle the requests at low latency. If \fBlogbias\fR is set to \fBthroughput\fR, ZFS does not use the configured pool log devices. Instead, ZFS optimizes synchronous operations for global pool throughput and efficient use of resources.
963 997
.RE
964 998

  
965 999
.sp
......
1628 1662
.ne 2
1629 1663
.mk
1630 1664
.na
1631
\fB\fBzfs get\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR] [\fB-Hp\fR] [\fB-o\fR \fIfield\fR[,...] [\fB-s\fR \fIsource\fR[,...] "\fIall\fR" | \fIproperty\fR[,...] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR
1665
\fB\fBzfs get\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR] [\fB-Hp\fR] [\fB-o\fR \fBall\fR | \fIfield\fR[,...] [\fB-s\fR \fIsource\fR[,...]] \fBall\fR | \fIproperty\fR[,...] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR
1632 1666
.ad
1633 1667
.sp .6
1634 1668
.RS 4n
......
1636 1670
.sp
1637 1671
.in +2
1638 1672
.nf
1639
    name      Dataset name
1673
     name      Dataset name
1640 1674
     property  Property name
1641 1675
     value     Property value
1642 1676
     source    Property source. Can either be local, default,
......
1645 1679
.in -2
1646 1680
.sp
1647 1681

  
1648
All columns are displayed by default, though this can be controlled by using the \fB-o\fR option. This command takes a comma-separated list of properties as described in the "Native Properties" and "User Properties" sections.
1682
All columns except the \fBRECEIVED\fR column are displayed by default; specify particular or all columns, using the \fB-o\fR option. This command takes a comma-separated list of properties as described in the "Native Properties" and "User Properties" sections.
1649 1683
.sp
1650 1684
The special value \fBall\fR can be used to display all properties that apply to the given dataset's type (filesystem, volume, or snapshot).
1651 1685
.sp
......
1689 1723
.ad
1690 1724
.sp .6
1691 1725
.RS 4n
1692
A comma-separated list of columns to display. \fBname,property,value,source\fR is the default value. 
1726
Set of fields to display. One or more of:
1727
.sp
1728
.in +2
1729
.nf
1730
name,property,value,received,source
1731
.fi
1732
.in -2
1733
.sp
1734

  
1735
Present multiple fields as a comma-separated list. The default value is:
1736
.sp
1737
.in +2
1738
.nf
1739
name,property,value,source
1740
.fi
1741
.in -2
1742
.sp
1743

  
1744
The keyword \fBall\fR specifies all sources.
1693 1745
.RE
1694 1746

  
1695 1747
.sp
......
1700 1752
.ad
1701 1753
.sp .6
1702 1754
.RS 4n
1703
A comma-separated list of sources to display. Those properties coming from a source other than those in this list are ignored. Each source must be one of the following: \fBlocal,default,inherited,temporary,none\fR. The default value is all sources.
1755
A comma-separated list of sources to display. Those properties coming from a source other than those in this list are ignored. Each source must be one of the following:
1756
.sp
1757
.in +2
1758
.nf
1759
local,default,inherited,temporary,received,none
1760
.fi
1761
.in -2
1762
.sp
1763

  
1764
The default value is all sources.
1704 1765
.RE
1705 1766

  
1706 1767
.sp
......
1720 1781
.ne 2
1721 1782
.mk
1722 1783
.na
1723
\fB\fBzfs inherit\fR [\fB-r\fR] \fIproperty\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR
1784
\fB\fBzfs inherit\fR [\fB-rS\fR] \fIproperty\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR
1724 1785
.ad
1725 1786
.sp .6
1726 1787
.RS 4n
......
1736 1797
Recursively inherit the given property for all children.
1737 1798
.RE
1738 1799

  
1800
.sp
1801
.ne 2
1802
.mk
1803
.na
1804
\fB\fB-S\fR\fR
1805
.ad
1806
.sp .6
1807
.RS 4n
1808
Revert to the received property value, if any. If the property does not have a received value, the behavior of \fBzfs inherit\fR \fB-S\fR is the same as \fBzfs inherit\fR without \fB-S\fR. If the property does have a received value, \fBzfs inherit\fR masks the received value with the inherited value until \fBzfs inherit\fR \fB-S\fR reverts to the received value.
1809
.RE
1810

  
1739 1811
.RE
1740 1812

  
1741 1813
.sp
......
2121 2193
.ne 2
2122 2194
.mk
2123 2195
.na
2124
\fB\fBzfs send\fR [\fB-vR\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR\fR
2196
\fB\fBzfs send\fR [\fB-DvRp\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR\fR
2125 2197
.ad
2126 2198
.sp .6
2127 2199
.RS 4n
......
2130 2202
.ne 2
2131 2203
.mk
2132 2204
.na
2205
\fB\fB-D\fR\fR
2206
.ad
2207
.sp .6
2208
.RS 4n
2209
Perform \fBdedup\fR processing on the stream. Deduplicated streams cannot be received on systems that do not support the stream deduplication feature.
2210
.RE
2211

  
2212
.sp
2213
.ne 2
2214
.mk
2215
.na
2133 2216
\fB\fB-i\fR \fIsnapshot\fR\fR
2134 2217
.ad
2135 2218
.sp .6
......
2167 2250
.ne 2
2168 2251
.mk
2169 2252
.na
2253
\fB\fB-p\fR\fR
2254
.ad
2255
.sp .6
2256
.RS 4n
2257
Send properties.
2258
.RE
2259

  
2260
.sp
2261
.ne 2
2262
.mk
2263
.na
2170 2264
\fB\fB-v\fR\fR
2171 2265
.ad
2172 2266
.sp .6
......
2185 2279
.ad
2186 2280
.br
2187 2281
.na
2188
\fB\fBzfs receive\fR [\fB-vnFu\fR] \fB-d\fR \fIfilesystem\fR\fR
2282
\fB\fBzfs receive\fR [\fB-vnFu\fR] [\fB-d\fR | \fB-e\fR] \fIfilesystem\fR\fR
2189 2283
.ad
2190 2284
.sp .6
2191 2285
.RS 4n
......
2195 2289
.sp
2196 2290
When a snapshot replication package stream that is generated by using the \fBzfs send\fR \fB-R\fR command is  received, any snapshots that do not exist on the sending location are destroyed by using the \fBzfs destroy\fR \fB-d\fR command.
2197 2291
.sp
2198
The name of the snapshot (and file system, if a full stream is received) that this subcommand creates depends on the argument type and the \fB-d\fR option.
2292
The name of the snapshot (and file system, if a full stream is received) that this subcommand creates depends on the argument type and the \fB-d\fR or \fB-e\fR option.
2199 2293
.sp
2200
If the argument is a snapshot name, the specified \fIsnapshot\fR is created. If the argument is a file system or volume name, a snapshot with the same name as the sent snapshot is created within the specified \fIfilesystem\fR or \fIvolume\fR. If the \fB-d\fR option is specified, the snapshot name is determined by appending the sent snapshot's name to the specified \fIfilesystem\fR. If the \fB-d\fR option is specified, any required file systems within the specified one are created.
2294
If the argument is a snapshot name, the specified \fIsnapshot\fR is created. If the argument is a file system or volume name, a snapshot with the same name as the sent snapshot is created within the specified \fIfilesystem\fR or \fIvolume\fR. If the \fB-d\fR or \fB-e\fR option is specified, the snapshot name is determined by appending the sent snapshot's name to the specified filesystem. If the \fB-d\fR option is specified, all but the pool name of the sent snapshot path is appended (for example, \fBb/c@1\fR appended from sent snapshot \fBa/b/c@1\fR), and if the \fB-e\fR option is specified, only the tail of the sent snapshot path is appended (for example, \fBc@1\fR appended from sent snapshot \fBa/b/c@1\fR). In the case of \fB-d\fR, any file systems needed to replicate the path of the sent snapshot are created within the specified file system.
2201 2295
.sp
2202 2296
.ne 2
2203 2297
.mk
......
2206 2300
.ad
2207 2301
.sp .6
2208 2302
.RS 4n
2209
Use the name of the sent snapshot to determine the name of the new snapshot as described in the paragraph above.
2303
Use all but the first element of the sent snapshot path (all but the pool name) to determine the name of the new snapshot as described in the paragraph above.
2304
.RE
2305

  
2306
.sp
2307
.ne 2
2308
.mk
2309
.na
2310
\fB\fB-e\fR\fR
2311
.ad
2312
.sp .6
2313
.RS 4n
2314
Use the last element of the sent snapshot path to determine the name of the new snapshot as described in the paragraph above.
2210 2315
.RE
2211 2316

  
2212 2317
.sp
......
2321 2426
.in +2
2322 2427
.nf
2323 2428
NAME             TYPE           NOTES
2324
allow            subcommand     Must also have the permission that is being
2325
                                allowed
2326
clone            subcommand     Must also have the 'create' ability and 'mount'
2429
allow            subcommand     Must also have the permission that is
2430
                                being allowed
2431
clone            subcommand     Must also have the 'create' ability and
2432
                                'mount'
2327 2433
                                ability in the origin file system
2328 2434
create           subcommand     Must also have the 'mount' ability
2329 2435
destroy          subcommand     Must also have the 'mount' ability
2436
hold             subcommand     Allows adding a user hold to a snapshot
2330 2437
mount            subcommand     Allows mount/umount of ZFS datasets
2331
promote          subcommand     Must also have the 'mount'
2332
                                and 'promote' ability in the origin file system
2333
receive          subcommand     Must also have the 'mount' and 'create' ability
2438
promote          subcommand     Must also have the 'mount' and 'promote'
2439
                                ability in the origin file system
2440
receive          subcommand     Must also have the 'mount' and 'create'
2441
                                ability
2442
release          subcommand     Allows releasing a user hold which
2443
                                might destroy the snapshot
2334 2444
rename           subcommand     Must also have the 'mount' and 'create'
2335 2445
                                ability in the new parent
2336
rollback         subcommand     Must also have the 'mount' ability
2337
send             subcommand     
2338
share            subcommand     Allows sharing file systems over NFS or SMB
2339
                                protocols
2340
snapshot         subcommand     Must also have the 'mount' ability
2341
groupquota       other          Allows accessing any groupquota@... property
2446
rollback         subcommand
2447
send             subcommand
2448
share            subcommand     Allows sharing file systems over NFS or
2449
                                SMB protocols
2450
snapshot         subcommand
2451
groupquota       other          Allows accessing any groupquota@...
2452
                                property
2342 2453
groupused        other          Allows reading any groupused@... property
2343 2454
userprop         other          Allows changing any user property
2344
userquota        other          Allows accessing any userquota@... property
2455
userquota        other          Allows accessing any userquota@...
2456
                                property
2345 2457
userused         other          Allows reading any userused@... property
2346

  
2347
aclinherit       property       
2348
aclmode          property       
2349
atime            property       
2350
canmount         property       
2351
casesensitivity  property       
2352
checksum         property       
2353
compression      property       
2354
copies           property       
2355
devices          property       
2356
exec             property       
2357
mountpoint       property       
2358
nbmand           property       
2359
normalization    property       
2360
primarycache     property       
2361
quota            property       
2362
readonly         property       
2363
recordsize       property       
2364
refquota         property       
2365
refreservation   property       
2366
reservation      property       
2367
secondarycache   property       
2368
setuid           property       
2369
shareiscsi       property       
2370
sharenfs         property       
2371
sharesmb         property       
2372
snapdir          property       
2373
utf8only         property       
2374
version          property       
2375
volblocksize     property       
2376
volsize          property       
2377
vscan            property       
2378
xattr            property       
2379
zoned            property       
2458
aclinherit       property
2459
aclmode          property
2460
atime            property
2461
canmount         property
2462
casesensitivity  property
2463
checksum         property
2464
compression      property
2465
copies           property
2466
dedup            property
2467
devices          property
2468
exec             property
2469
logbias          property
2470
mlslabel         property
2471
mountpoint       property
2472
nbmand           property
2473
normalization    property
2474
primarycache     property
2475
quota            property
2476
readonly         property
2477
recordsize       property
2478
refquota         property
2479
refreservation   property
2480
reservation      property
2481
secondarycache   property
2482
setuid           property
2483
shareiscsi       property
2484
sharenfs         property
2485
sharesmb         property
2486
snapdir          property
2487
utf8only         property
2488
version          property
2489
volblocksize     property
2490
volsize          property
2491
vscan            property
2492
xattr            property
2493
zoned            property
2380 2494
.fi
2381 2495
.in -2
2382 2496
.sp
......
2628 2742
# \fBzfs get all pool/home/bob\fR
2629 2743
NAME           PROPERTY              VALUE                  SOURCE
2630 2744
pool/home/bob  type                  filesystem             -
2631
pool/home/bob  creation              Tue Jul 21 15:53 2009  -
2632
pool/home/bob  used                  21K                    -
2633
pool/home/bob  available             20.0G                  -
2634
pool/home/bob  referenced            21K                    -
2745
pool/home/bob  creation              Mon Nov  9 15:05 2009  -
2746
pool/home/bob  used                  282M                   -
2747
pool/home/bob  available             134G                   -
2748
pool/home/bob  referenced            282M                   -
2635 2749
pool/home/bob  compressratio         1.00x                  -
2636 2750
pool/home/bob  mounted               yes                    -
2637
pool/home/bob  quota                 20G                    local
2751
pool/home/bob  quota                 none                   default
2638 2752
pool/home/bob  reservation           none                   default
2639 2753
pool/home/bob  recordsize            128K                   default
2640 2754
pool/home/bob  mountpoint            /pool/home/bob         default
......
2666 2780
pool/home/bob  primarycache          all                    default
2667 2781
pool/home/bob  secondarycache        all                    default
2668 2782
pool/home/bob  usedbysnapshots       0                      -
2669
pool/home/bob  usedbydataset         21K                    -
2783
pool/home/bob  usedbydataset         282M                   -
2670 2784
pool/home/bob  usedbychildren        0                      -
2671 2785
pool/home/bob  usedbyrefreservation  0                      -
2786
pool/home/bob  logbias               latency                default
2787
pool/home/bob  dedup                 off                    default
2788
pool/home/bob  mlslabel              none                   default
2672 2789
.fi
2673 2790
.in -2
2674 2791
.sp
(3-3/8)