1'\" te 2.\" Copyright (c) 2013, 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. 11.\" See the License for the specific language governing permissions 12.\" and limitations under the License. 13.\" 14.\" When distributing Covered Code, include this CDDL HEADER in each 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 (c) 2011, 2014 by Delphix. All rights reserved. 22.\" Copyright (c) 2011, Pawel Jakub Dawidek <pjd@FreeBSD.org> 23.\" Copyright (c) 2012, Glen Barber <gjb@FreeBSD.org> 24.\" Copyright (c) 2012, Bryan Drewery <bdrewery@FreeBSD.org> 25.\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved. 26.\" Copyright (c) 2014, Joyent, Inc. All rights reserved. 27.\" Copyright (c) 2013, Steven Hartland <smh@FreeBSD.org> 28.\" Copyright (c) 2014 Nexenta Systems, Inc. All Rights Reserved. 29.\" Copyright (c) 2014, Xin LI <delphij@FreeBSD.org> 30.\" Copyright (c) 2014-2015, The FreeBSD Foundation, All Rights Reserved. 31.\" 32.\" $FreeBSD: head/cddl/contrib/opensolaris/cmd/zfs/zfs.8 301096 2016-06-01 03:36:31Z allanjude $ 33.\" 34.Dd May 31, 2016 35.Dt ZFS 8 36.Os 37.Sh NAME 38.Nm zfs 39.Nd configures ZFS file systems 40.Sh SYNOPSIS 41.Nm 42.Op Fl \&? 43.Nm 44.Cm create 45.Op Fl pu 46.Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... Ar filesystem 47.Nm 48.Cm create 49.Op Fl ps 50.Op Fl b Ar blocksize 51.Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... 52.Fl V 53.Ar size volume 54.Nm 55.Cm destroy 56.Op Fl fnpRrv 57.Ar filesystem Ns | Ns Ar volume 58.Nm 59.Cm destroy 60.Op Fl dnpRrv 61.Sm off 62.Ar filesystem Ns | Ns volume 63.Ns @snap 64.Op % Ns Ar snap 65.Op , Ns Ar snap Op % Ns Ar snap 66.Op , Ns ... 67.Sm on 68.Nm 69.Cm destroy 70.Ar filesystem Ns | Ns Ar volume Ns # Ns Ar bookmark 71.Nm 72.Cm snapshot Ns | Ns Cm snap 73.Op Fl r 74.Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... 75.Ar filesystem@snapname Ns | Ns Ar volume@snapname 76.Ar filesystem@snapname Ns | Ns Ar volume@snapname Ns ... 77.Nm 78.Cm rollback 79.Op Fl rRf 80.Ar snapshot 81.Nm 82.Cm clone 83.Op Fl p 84.Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... 85.Ar snapshot filesystem Ns | Ns Ar volume 86.Nm 87.Cm promote 88.Ar clone-filesystem 89.Nm 90.Cm rename 91.Op Fl f 92.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot 93.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot 94.Nm 95.Cm rename 96.Op Fl f 97.Fl p 98.Ar filesystem Ns | Ns Ar volume 99.Ar filesystem Ns | Ns Ar volume 100.Nm 101.Cm rename 102.Fl r 103.Ar snapshot snapshot 104.Nm 105.Cm rename 106.Fl u 107.Op Fl p 108.Ar filesystem filesystem 109.Nm 110.Cm list 111.Op Fl r Ns | Ns Fl d Ar depth 112.Op Fl Hp 113.Op Fl o Ar property Ns Oo , Ns property Ns Oc Ns ... 114.Op Fl t Ar type Ns Oo , Ns type Ns Oc Ns ... 115.Oo Fl s Ar property Oc Ns ... 116.Oo Fl S Ar property Oc Ns ... 117.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot 118.Nm 119.Cm set 120.Ar property Ns = Ns Ar value Oo Ar property Ns = Ns Ar value Oc Ns ... 121.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ... 122.Nm 123.Cm get 124.Op Fl r Ns | Ns Fl d Ar depth 125.Op Fl Hp 126.Op Fl o Ar all | field Ns Oo , Ns Ar field Oc Ns ... 127.Op Fl t Ar type Ns Oo Ns , Ar type Oc Ns ... 128.Op Fl s Ar source Ns Oo Ns , Ns Ar source Oc Ns ... 129.Ar all | property Ns Oo Ns , Ns Ar property Oc Ns ... 130.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ... 131.Nm 132.Cm inherit 133.Op Fl rS 134.Ar property 135.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ... 136.Nm 137.Cm upgrade 138.Op Fl v 139.Nm 140.Cm upgrade 141.Op Fl r 142.Op Fl V Ar version 143.Fl a | Ar filesystem 144.Nm 145.Cm userspace 146.Op Fl Hinp 147.Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... 148.Oo Fl s Ar field Oc Ns ... 149.Oo Fl S Ar field Oc Ns ... 150.Op Fl t Ar type Ns Oo Ns , Ns Ar type Oc Ns ... 151.Ar filesystem Ns | Ns Ar snapshot 152.Nm 153.Cm groupspace 154.Op Fl Hinp 155.Op Fl o Ar field Ns Oo , Ns field Oc Ns ... 156.Oo Fl s Ar field Oc Ns ... 157.Oo Fl S Ar field Oc Ns ... 158.Op Fl t Ar type Ns Oo Ns , Ns Ar type Oc Ns ... 159.Ar filesystem Ns | Ns Ar snapshot 160.Nm 161.Cm mount 162.Nm 163.Cm mount 164.Op Fl vO 165.Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ... 166.Fl a | Ar filesystem 167.Nm 168.Cm unmount Ns | Ns Cm umount 169.Op Fl f 170.Fl a | Ar filesystem Ns | Ns Ar mountpoint 171.Nm 172.Cm share 173.Fl a | Ar filesystem 174.Nm 175.Cm unshare 176.Fl a | Ar filesystem Ns | Ns Ar mountpoint 177.Nm 178.Cm bookmark 179.Ar snapshot 180.Ar bookmark 181.Nm 182.Cm send 183.Op Fl DnPpRveL 184.Op Fl i Ar snapshot | Fl I Ar snapshot 185.Ar snapshot 186.Nm 187.Cm send 188.Op Fl eL 189.Op Fl i Ar snapshot Ns | Ns bookmark 190.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot 191.Nm 192.Cm send 193.Op Fl Penv 194.Fl t Ar receive_resume_token 195.Nm 196.Cm receive Ns | Ns Cm recv 197.Op Fl vnsFu 198.Op Fl o Sy origin Ns = Ns Ar snapshot 199.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot 200.Nm 201.Cm receive Ns | Ns Cm recv 202.Op Fl vnsFu 203.Op Fl d | e 204.Op Fl o Sy origin Ns = Ns Ar snapshot 205.Ar filesystem 206.Nm 207.Cm receive Ns | Ns Cm recv 208.Fl A 209.Ar filesystem Ns | Ns Ar volume 210.Nm 211.Cm allow 212.Ar filesystem Ns | Ns Ar volume 213.Nm 214.Cm allow 215.Op Fl ldug 216.Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ... 217.Ar perm Ns | Ns Ar @setname Ns 218.Oo Ns , Ns Ar perm Ns | Ns Ar @setname Oc Ns ... 219.Ar filesystem Ns | Ns Ar volume 220.Nm 221.Cm allow 222.Op Fl ld 223.Fl e Ns | Ns Cm everyone 224.Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns 225.Ns ... 226.Ar filesystem Ns | Ns Ar volume 227.Nm 228.Cm allow 229.Fl c 230.Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns 231.Ns ... 232.Ar filesystem Ns | Ns Ar volume 233.Nm 234.Cm allow 235.Fl s 236.Ar @setname 237.Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns 238.Ns ... 239.Ar filesystem Ns | Ns Ar volume 240.Nm 241.Cm unallow 242.Op Fl rldug 243.Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ... 244.Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns 245.Ns ... Oc 246.Ar filesystem Ns | Ns Ar volume 247.Nm 248.Cm unallow 249.Op Fl rld 250.Fl e Ns | Ns Cm everyone 251.Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns 252.Ns ... Oc 253.Ar filesystem Ns | Ns Ar volume 254.Nm 255.Cm unallow 256.Op Fl r 257.Fl c 258.Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns 259.Ns ... Oc 260.Ar filesystem Ns | Ns Ar volume 261.Nm 262.Cm unallow 263.Op Fl r 264.Fl s 265.Ar @setname 266.Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns 267.Ns ... Oc 268.Ar filesystem Ns | Ns Ar volume 269.Nm 270.Cm hold 271.Op Fl r 272.Ar tag snapshot Ns ... 273.Nm 274.Cm holds 275.Op Fl Hp 276.Op Fl r Ns | Ns Fl d Ar depth 277.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns 278.Ns ... 279.Nm 280.Cm release 281.Op Fl r 282.Ar tag snapshot Ns ... 283.Nm 284.Cm diff 285.Op Fl FHt 286.Ar snapshot 287.Op Ar snapshot Ns | Ns Ar filesystem 288.Sh DESCRIPTION 289The 290.Nm 291command configures 292.Tn ZFS 293datasets within a 294.Tn ZFS 295storage pool, as described in 296.Xr zpool 8 . 297A dataset is identified by a unique path within the 298.Tn ZFS 299namespace. For example: 300.Bd -ragged -offset 4n 301.No pool/ Ns Brq filesystem,volume,snapshot 302.Ed 303.Pp 304where the maximum length of a dataset name is 305.Dv MAXNAMELEN 306(256 bytes). 307.Pp 308A dataset can be one of the following: 309.Bl -hang -width 12n 310.It Sy file system 311A 312.Tn ZFS 313dataset of type 314.Em filesystem 315can be mounted within the standard system namespace and behaves like other file 316systems. While 317.Tn ZFS 318file systems are designed to be 319.Tn POSIX 320compliant, known issues exist that prevent compliance in some cases. 321Applications that depend on standards conformance might fail due to nonstandard 322behavior when checking file system free space. 323.It Sy volume 324A logical volume exported as a raw or block device. This type of dataset should 325only be used under special circumstances. File systems are typically used in 326most environments. 327.It Sy snapshot 328A read-only version of a file system or volume at a given point in time. It is 329specified as 330.Em filesystem@name 331or 332.Em volume@name . 333.El 334.Ss ZFS File System Hierarchy 335A 336.Tn ZFS 337storage pool is a logical collection of devices that provide space for 338datasets. A storage pool is also the root of the 339.Tn ZFS 340file system hierarchy. 341.Pp 342The root of the pool can be accessed as a file system, such as mounting and 343unmounting, taking snapshots, and setting properties. The physical storage 344characteristics, however, are managed by the 345.Xr zpool 8 346command. 347.Pp 348See 349.Xr zpool 8 350for more information on creating and administering pools. 351.Ss Snapshots 352A snapshot is a read-only copy of a file system or volume. Snapshots can be 353created extremely quickly, and initially consume no additional space within the 354pool. As data within the active dataset changes, the snapshot consumes more 355data than would otherwise be shared with the active dataset. 356.Pp 357Snapshots can have arbitrary names. Snapshots of volumes can be cloned or 358rolled back, but cannot be accessed independently. 359.Pp 360File system snapshots can be accessed under the 361.Pa \&.zfs/snapshot 362directory in the root of the file system. Snapshots are automatically mounted 363on demand and may be unmounted at regular intervals. The visibility of the 364.Pa \&.zfs 365directory can be controlled by the 366.Sy snapdir 367property. 368.Ss Clones 369A clone is a writable volume or file system whose initial contents are the same 370as another dataset. As with snapshots, creating a clone is nearly 371instantaneous, and initially consumes no additional space. 372.Pp 373Clones can only be created from a snapshot. When a snapshot is cloned, it 374creates an implicit dependency between the parent and child. Even though the 375clone is created somewhere else in the dataset hierarchy, the original snapshot 376cannot be destroyed as long as a clone exists. The 377.Sy origin 378property exposes this dependency, and the 379.Cm destroy 380command lists any such dependencies, if they exist. 381.Pp 382The clone parent-child dependency relationship can be reversed by using the 383.Cm promote 384subcommand. This causes the "origin" file system to become a clone of the 385specified file system, which makes it possible to destroy the file system that 386the clone was created from. 387.Ss Mount Points 388Creating a 389.Tn ZFS 390file system is a simple operation, so the number of file systems per system is 391likely to be numerous. To cope with this, 392.Tn ZFS 393automatically manages mounting and unmounting file systems without the need to 394edit the 395.Pa /etc/fstab 396file. All automatically managed file systems are mounted by 397.Tn ZFS 398at boot time. 399.Pp 400By default, file systems are mounted under 401.Pa /path , 402where 403.Ar path 404is the name of the file system in the 405.Tn ZFS 406namespace. Directories are created and destroyed as needed. 407.Pp 408A file system can also have a mount point set in the 409.Sy mountpoint 410property. This directory is created as needed, and 411.Tn ZFS 412automatically mounts the file system when the 413.Qq Nm Cm mount Fl a 414command is invoked (without editing 415.Pa /etc/fstab ) . 416The 417.Sy mountpoint 418property can be inherited, so if 419.Em pool/home 420has a mount point of 421.Pa /home , 422then 423.Em pool/home/user 424automatically inherits a mount point of 425.Pa /home/user . 426.Pp 427A file system 428.Sy mountpoint 429property of 430.Cm none 431prevents the file system from being mounted. 432.Pp 433If needed, 434.Tn ZFS 435file systems can also be managed with traditional tools 436.Pq Xr mount 8 , Xr umount 8 , Xr fstab 5 . 437If a file system's mount point is set to 438.Cm legacy , 439.Tn ZFS 440makes no attempt to manage the file system, and the administrator is 441responsible for mounting and unmounting the file system. 442.Ss Deduplication 443Deduplication is the process for removing redundant data at the block-level, 444reducing the total amount of data stored. If a file system has the 445.Cm dedup 446property enabled, duplicate data blocks are removed synchronously. The result 447is that only unique data is stored and common components are shared among 448files. 449.Ss Native Properties 450Properties are divided into two types, native properties and user-defined (or 451"user") properties. Native properties either export internal statistics or 452control 453.Tn ZFS 454behavior. In addition, native properties are either editable or read-only. User 455properties have no effect on 456.Tn ZFS 457behavior, but you can use them to annotate datasets in a way that is meaningful 458in your environment. For more information about user properties, see the 459.Qq Sx User Properties 460section, below. 461.Pp 462Every dataset has a set of properties that export statistics about the dataset 463as well as control various behaviors. Properties are inherited from the parent 464unless overridden by the child. Some properties apply only to certain types of 465datasets (file systems, volumes, or snapshots). 466.Pp 467The values of numeric properties can be specified using human-readable suffixes 468(for example, 469.Sy k , KB , M , Gb , 470and so forth, up to 471.Sy Z 472for zettabyte). The following are all valid (and equal) specifications: 473.Bd -ragged -offset 4n 4741536M, 1.5g, 1.50GB 475.Ed 476.Pp 477The values of non-numeric properties are case sensitive and must be lowercase, 478except for 479.Sy mountpoint , sharenfs , No and Sy sharesmb . 480.Pp 481The following native properties consist of read-only statistics about the 482dataset. These properties can be neither set, nor inherited. Native properties 483apply to all dataset types unless otherwise noted. 484.Bl -tag -width 2n 485.It Sy available 486The amount of space available to the dataset and all its children, assuming 487that there is no other activity in the pool. Because space is shared within a 488pool, availability can be limited by any number of factors, including physical 489pool size, quotas, reservations, or other datasets within the pool. 490.Pp 491This property can also be referred to by its shortened column name, 492.Sy avail . 493.It Sy compressratio 494For non-snapshots, the compression ratio achieved for the 495.Sy used 496space of this dataset, expressed as a multiplier. The 497.Sy used 498property includes descendant datasets, and, for clones, does not include 499the space shared with the origin snapshot. For snapshots, the 500.Sy compressratio 501is the same as the 502.Sy refcompressratio 503property. Compression can be turned on by running: 504.Qq Nm Cm set compression=on Ar dataset 505The default value is 506.Cm off . 507.It Sy creation 508The time this dataset was created. 509.It Sy clones 510For snapshots, this property is a comma-separated list of filesystems or 511volumes which are clones of this snapshot. The clones' 512.Sy origin 513property is this snapshot. If the 514.Sy clones 515property is not empty, then this snapshot can not be destroyed (even with the 516.Fl r 517or 518.Fl f 519options). 520.It Sy defer_destroy 521This property is 522.Cm on 523if the snapshot has been marked for deferred destroy by using the 524.Qq Nm Cm destroy -d 525command. Otherwise, the property is 526.Cm off . 527.It Sy filesystem_count 528The total number of filesystems and volumes that exist under this location in the 529dataset tree. 530This value is only available when a 531.Sy filesystem_limit 532has 533been set somewhere in the tree under which the dataset resides. 534.It Sy logicalreferenced 535The amount of space that is 536.Qq logically 537accessible by this dataset. 538See the 539.Sy referenced 540property. 541The logical space ignores the effect of the 542.Sy compression 543and 544.Sy copies 545properties, giving a quantity closer to the amount of data that applications 546see. 547However, it does include space consumed by metadata. 548.Pp 549This property can also be referred to by its shortened column name, 550.Sy lrefer . 551.It Sy logicalused 552The amount of space that is 553.Qq logically 554consumed by this dataset and all its descendents. 555See the 556.Sy used 557property. 558The logical space ignores the effect of the 559.Sy compression 560and 561.Sy copies 562properties, giving a quantity closer to the amount of data that applications 563see. 564.Pp 565This property can also be referred to by its shortened column name, 566.Sy lused . 567.It Sy mounted 568For file systems, indicates whether the file system is currently mounted. This 569property can be either 570.Cm yes 571or 572.Cm no . 573.It Sy origin 574For cloned file systems or volumes, the snapshot from which the clone was 575created. See also the 576.Sy clones 577property. 578.It Sy receive_resume_token 579For filesystems or volumes which have saved partially-completed state from 580.Sy zfs receive -s , 581this opaque token can be provided to 582.Sy zfs send -t 583to resume and complete the 584.Sy zfs receive . 585.It Sy referenced 586The amount of data that is accessible by this dataset, which may or may not be 587shared with other datasets in the pool. When a snapshot or clone is created, it 588initially references the same amount of space as the file system or snapshot it 589was created from, since its contents are identical. 590.Pp 591This property can also be referred to by its shortened column name, 592.Sy refer . 593.It Sy refcompressratio 594The compression ratio achieved for the 595.Sy referenced 596space of this dataset, expressed as a multiplier. See also the 597.Sy compressratio 598property. 599.It Sy snapshot_count 600The total number of snapshots that exist under this location in the dataset tree. 601This value is only available when a 602.Sy snapshot_limit 603has been set somewhere 604in the tree under which the dataset resides. 605.It Sy type 606The type of dataset: 607.Sy filesystem , volume , No or Sy snapshot . 608.It Sy used 609The amount of space consumed by this dataset and all its descendents. This is 610the value that is checked against this dataset's quota and reservation. The 611space used does not include this dataset's reservation, but does take into 612account the reservations of any descendent datasets. The amount of space that a 613dataset consumes from its parent, as well as the amount of space that are freed 614if this dataset is recursively destroyed, is the greater of its space used and 615its reservation. 616.Pp 617When snapshots (see the 618.Qq Sx Snapshots 619section) are created, their space is 620initially shared between the snapshot and the file system, and possibly with 621previous snapshots. As the file system changes, space that was previously 622shared becomes unique to the snapshot, and counted in the snapshot's space 623used. Additionally, deleting snapshots can increase the amount of space unique 624to (and used by) other snapshots. 625.Pp 626The amount of space used, available, or referenced does not take into account 627pending changes. Pending changes are generally accounted for within a few 628seconds. Committing a change to a disk using 629.Xr fsync 2 630or 631.Sy O_SYNC 632does not necessarily guarantee that the space usage information is updated 633immediately. 634.It Sy usedby* 635The 636.Sy usedby* 637properties decompose the 638.Sy used 639properties into the various reasons that space is used. Specifically, 640.Sy used No = 641.Sy usedbysnapshots + usedbydataset + usedbychildren + usedbyrefreservation . 642These properties are only available for datasets created 643with 644.Tn ZFS 645pool version 13 pools and higher. 646.It Sy usedbysnapshots 647The amount of space consumed by snapshots of this dataset. In particular, it is 648the amount of space that would be freed if all of this dataset's snapshots were 649destroyed. Note that this is not simply the sum of the snapshots' 650.Sy used 651properties because space can be shared by multiple snapshots. 652.It Sy usedbydataset 653The amount of space used by this dataset itself, which would be freed if the 654dataset were destroyed (after first removing any 655.Sy refreservation 656and destroying any necessary snapshots or descendents). 657.It Sy usedbychildren 658The amount of space used by children of this dataset, which would be freed if 659all the dataset's children were destroyed. 660.It Sy usedbyrefreservation 661The amount of space used by a 662.Sy refreservation 663set on this dataset, which would be freed if the 664.Sy refreservation 665was removed. 666.It Sy userused@ Ns Ar user 667The amount of space consumed by the specified user in this dataset. Space is 668charged to the owner of each file, as displayed by 669.Qq Nm ls Fl l . 670The amount of space charged is displayed by 671.Qq Nm du 672and 673.Qq Nm ls Fl s . 674See the 675.Qq Nm Cm userspace 676subcommand for more information. 677.Pp 678Unprivileged users can access only their own space usage. The root user, or a 679user who has been granted the 680.Sy userused 681privilege with 682.Qq Nm Cm allow , 683can access everyone's usage. 684.Pp 685The 686.Sy userused@ Ns ... 687properties are not displayed by 688.Qq Nm Cm get all . 689The user's name must be appended after the 690.Sy @ 691symbol, using one of the following forms: 692.Bl -bullet -offset 2n 693.It 694POSIX name (for example, 695.Em joe ) 696.It 697POSIX numeric ID (for example, 698.Em 1001 ) 699.El 700.It Sy userrefs 701This property is set to the number of user holds on this snapshot. User holds 702are set by using the 703.Qq Nm Cm hold 704command. 705.It Sy groupused@ Ns Ar group 706The amount of space consumed by the specified group in this dataset. Space is 707charged to the group of each file, as displayed by 708.Nm ls Fl l . 709See the 710.Sy userused@ Ns Ar user 711property for more information. 712.Pp 713Unprivileged users can only access their own groups' space usage. The root 714user, or a user who has been granted the 715.Sy groupused 716privilege with 717.Qq Nm Cm allow , 718can access all groups' usage. 719.It Sy volblocksize Ns = Ns Ar blocksize 720For volumes, specifies the block size of the volume. The 721.Ar blocksize 722cannot be changed once the volume has been written, so it should be set at 723volume creation time. The default 724.Ar blocksize 725for volumes is 8 Kbytes. Any 726power of 2 from 512 bytes to 128 Kbytes is valid. 727.Pp 728This property can also be referred to by its shortened column name, 729.Sy volblock . 730.It Sy written 731The amount of 732.Sy referenced 733space written to this dataset since the previous snapshot. 734.It Sy written@ Ns Ar snapshot 735The amount of 736.Sy referenced 737space written to this dataset since the specified snapshot. This is the space 738that is referenced by this dataset but was not referenced by the specified 739snapshot. 740.Pp 741The 742.Ar snapshot 743may be specified as a short snapshot name (just the part after the 744.Sy @ ) , 745in which case it will be interpreted as a snapshot in the same filesystem as 746this dataset. The 747.Ar snapshot 748may be a full snapshot name 749.Pq Em filesystem@snapshot , 750which for clones may be a snapshot in the origin's filesystem (or the origin of 751the origin's filesystem, etc). 752.El 753.Pp 754The following native properties can be used to change the behavior of a 755.Tn ZFS 756dataset. 757.Bl -tag -width 2n 758.It Xo 759.Sy aclinherit Ns = Ns Cm discard | 760.Cm noallow | 761.Cm restricted | 762.Cm passthrough | 763.Cm passthrough-x 764.Xc 765Controls how 766.Tn ACL 767entries are inherited when files and directories are created. A file system 768with an 769.Sy aclinherit 770property of 771.Cm discard 772does not inherit any 773.Tn ACL 774entries. A file system with an 775.Sy aclinherit 776property value of 777.Cm noallow 778only inherits inheritable 779.Tn ACL 780entries that specify "deny" permissions. The property value 781.Cm restricted 782(the default) removes the 783.Em write_acl 784and 785.Em write_owner 786permissions when the 787.Tn ACL 788entry is inherited. A file system with an 789.Sy aclinherit 790property value of 791.Cm passthrough 792inherits all inheritable 793.Tn ACL 794entries without any modifications made to the 795.Tn ACL 796entries when they are inherited. A file system with an 797.Sy aclinherit 798property value of 799.Cm passthrough-x 800has the same meaning as 801.Cm passthrough , 802except that the 803.Em owner@ , group@ , No and Em everyone@ Tn ACE Ns s 804inherit the execute permission only if the file creation mode also requests the 805execute bit. 806.Pp 807When the property value is set to 808.Cm passthrough , 809files are created with a mode determined by the inheritable 810.Tn ACE Ns s. 811If no inheritable 812.Tn ACE Ns s 813exist that affect the mode, then the mode is set in accordance to the requested 814mode from the application. 815.It Sy aclmode Ns = Ns Cm discard | groupmask | passthrough | restricted 816Controls how an 817.Tn ACL 818is modified during 819.Xr chmod 2 . 820A file system with an 821.Sy aclmode 822property of 823.Cm discard 824(the default) deletes all 825.Tn ACL 826entries that do not represent the mode of the file. An 827.Sy aclmode 828property of 829.Cm groupmask 830reduces permissions granted in all 831.Em ALLOW 832entries found in the 833.Tn ACL 834such that they are no greater than the group permissions specified by 835.Xr chmod 2 . 836A file system with an 837.Sy aclmode 838property of 839.Cm passthrough 840indicates that no changes are made to the 841.Tn ACL 842other than creating or updating the necessary 843.Tn ACL 844entries to represent the new mode of the file or directory. 845An 846.Sy aclmode 847property of 848.Cm restricted 849will cause the 850.Xr chmod 2 851operation to return an error when used on any file or directory which has 852a non-trivial 853.Tn ACL 854whose entries can not be represented by a mode. 855.Xr chmod 2 856is required to change the set user ID, set group ID, or sticky bits on a file 857or directory, as they do not have equivalent 858.Tn ACL 859entries. 860In order to use 861.Xr chmod 2 862on a file or directory with a non-trivial 863.Tn ACL 864when 865.Sy aclmode 866is set to 867.Cm restricted , 868you must first remove all 869.Tn ACL 870entries which do not represent the current mode. 871.It Sy atime Ns = Ns Cm on | off 872Controls whether the access time for files is updated when they are read. 873Turning this property off avoids producing write traffic when reading files and 874can result in significant performance gains, though it might confuse mailers 875and other similar utilities. The default value is 876.Cm on . 877.It Sy canmount Ns = Ns Cm on | off | noauto 878If this property is set to 879.Cm off , 880the file system cannot be mounted, and is ignored by 881.Qq Nm Cm mount Fl a . 882Setting this property to 883.Cm off 884is similar to setting the 885.Sy mountpoint 886property to 887.Cm none , 888except that the dataset still has a normal 889.Sy mountpoint 890property, which can be inherited. Setting this property to 891.Cm off 892allows datasets to be used solely as a mechanism to inherit properties. One 893example of setting 894.Sy canmount Ns = Ns Cm off 895is to have two datasets with the same 896.Sy mountpoint , 897so that the children of both datasets appear in the same directory, but might 898have different inherited characteristics. 899.Pp 900When the 901.Cm noauto 902value is set, a dataset can only be mounted and unmounted explicitly. The 903dataset is not mounted automatically when the dataset is created or imported, 904nor is it mounted by the 905.Qq Nm Cm mount Fl a 906command or unmounted by the 907.Qq Nm Cm umount Fl a 908command. 909.Pp 910This property is not inherited. 911.It Sy checksum Ns = Ns Cm on | off | fletcher2 | fletcher4 | sha256 | noparity | sha512 | skein 912Controls the checksum used to verify data integrity. The default value is 913.Cm on , 914which automatically selects an appropriate algorithm (currently, 915.Cm fletcher4 , 916but this may change in future releases). The value 917.Cm off 918disables integrity checking on user data. 919The value 920.Cm noparity 921not only 922disables integrity but also disables maintaining parity for user data. This 923setting is used internally by a dump device residing on a RAID-Z pool and should 924not be used by any other dataset. 925Disabling checksums is 926.Em NOT 927a recommended practice. 928The 929.Sy sha512 , 930and 931.Sy skein 932checksum algorithms require enabling the appropriate features on the pool. 933Please see 934.Xr zpool-features 7 935for more information on these algorithms. 936.Pp 937Changing this property affects only newly-written data. 938.It Sy compression Ns = Ns Cm on | off | lzjb | gzip | gzip- Ns Ar N | Cm zle | Cm lz4 939Controls the compression algorithm used for this dataset. 940Setting compression to 941.Cm on 942indicates that the current default compression algorithm should be used. 943The default balances compression and decompression speed, with compression 944ratio and is expected to work well on a wide variety of workloads. 945Unlike all other settings for this property, on does not select a fixed 946compression type. 947As new compression algorithms are added to ZFS and enabled on a pool, the 948default compression algorithm may change. 949The current default compression algorthm is either 950.Cm lzjb 951or, if the 952.Sy lz4_compress 953feature is enabled, 954.Cm lz4 . 955The 956.Cm lzjb 957compression algorithm is optimized for performance while providing decent data 958compression. Setting compression to 959.Cm on 960uses the 961.Cm lzjb 962compression algorithm. The 963.Cm gzip 964compression algorithm uses the same compression as the 965.Xr gzip 1 966command. You can specify the 967.Cm gzip 968level by using the value 969.Cm gzip- Ns Ar N 970where 971.Ar N 972is an integer from 1 (fastest) to 9 (best compression ratio). Currently, 973.Cm gzip 974is equivalent to 975.Cm gzip-6 976(which is also the default for 977.Xr gzip 1 ) . 978The 979.Cm zle 980compression algorithm compresses runs of zeros. 981.Pp 982The 983.Sy lz4 984compression algorithm is a high-performance replacement 985for the 986.Sy lzjb 987algorithm. It features significantly faster 988compression and decompression, as well as a moderately higher 989compression ratio than 990.Sy lzjb , 991but can only be used on pools with 992the 993.Sy lz4_compress 994feature set to 995.Sy enabled . 996See 997.Xr zpool-features 7 998for details on ZFS feature flags and the 999.Sy lz4_compress 1000feature. 1001.Pp 1002This property can also be referred to by its shortened column name 1003.Cm compress . 1004Changing this property affects only newly-written data. 1005.It Sy copies Ns = Ns Cm 1 | 2 | 3 1006Controls the number of copies of data stored for this dataset. These copies are 1007in addition to any redundancy provided by the pool, for example, mirroring or 1008RAID-Z. The copies are stored on different disks, if possible. The space used 1009by multiple copies is charged to the associated file and dataset, changing the 1010.Sy used 1011property and counting against quotas and reservations. 1012.Pp 1013Changing this property only affects newly-written data. Therefore, set this 1014property at file system creation time by using the 1015.Fl o Cm copies= Ns Ar N 1016option. 1017.It Sy dedup Ns = Ns Cm on | off | verify | sha256 Ns Oo Cm ,verify Oc | Sy sha512 Ns Oo Cm ,verify Oc | Sy skein Ns Oo Cm ,verify Oc 1018Configures deduplication for a dataset. The default value is 1019.Cm off . 1020The default deduplication checksum is 1021.Cm sha256 1022(this may change in the future). 1023When 1024.Sy dedup 1025is enabled, the checksum defined here overrides the 1026.Sy checksum 1027property. Setting the value to 1028.Cm verify 1029has the same effect as the setting 1030.Cm sha256,verify . 1031.Pp 1032If set to 1033.Cm verify , 1034.Tn ZFS 1035will do a byte-to-byte comparsion in case of two blocks having the same 1036signature to make sure the block contents are identical. 1037.It Sy devices Ns = Ns Cm on | off 1038The 1039.Sy devices 1040property is currently not supported on 1041.Nx . 1042.It Sy exec Ns = Ns Cm on | off 1043Controls whether processes can be executed from within this file system. The 1044default value is 1045.Cm on . 1046.It Sy mlslabel Ns = Ns Ar label | Cm none 1047The 1048.Sy mlslabel 1049property is currently not supported on 1050.Nx . 1051.It Sy filesystem_limit Ns = Ns Ar count | Cm none 1052Limits the number of filesystems and volumes that can exist under this point in 1053the dataset tree. 1054The limit is not enforced if the user is allowed to change 1055the limit. 1056Setting a 1057.Sy filesystem_limit 1058on a descendent of a filesystem that 1059already has a 1060.Sy filesystem_limit 1061does not override the ancestor's 1062.Sy filesystem_limit , 1063but rather imposes an additional limit. 1064This feature must be enabled to be used 1065.Po see 1066.Xr zpool-features 7 1067.Pc . 1068.It Sy mountpoint Ns = Ns Ar path | Cm none | legacy 1069Controls the mount point used for this file system. See the 1070.Qq Sx Mount Points 1071section for more information on how this property is used. 1072.Pp 1073When the 1074.Sy mountpoint 1075property is changed for a file system, the file system and any children that 1076inherit the mount point are unmounted. If the new value is 1077.Cm legacy , 1078then they remain unmounted. Otherwise, they are automatically remounted in the 1079new location if the property was previously 1080.Cm legacy 1081or 1082.Cm none , 1083or if they were mounted before the property was changed. In addition, any 1084shared file systems are unshared and shared in the new location. 1085.It Sy nbmand Ns = Ns Cm on | off 1086The 1087.Sy nbmand 1088property is currently not supported on 1089.Nx . 1090.It Sy primarycache Ns = Ns Cm all | none | metadata 1091Controls what is cached in the primary cache (ARC). If this property is set to 1092.Cm all , 1093then both user data and metadata is cached. If this property is set to 1094.Cm none , 1095then neither user data nor metadata is cached. If this property is set to 1096.Cm metadata , 1097then only metadata is cached. The default value is 1098.Cm all . 1099.It Sy quota Ns = Ns Ar size | Cm none 1100Limits the amount of space a dataset and its descendents can consume. This 1101property enforces a hard limit on the amount of space used. This includes all 1102space consumed by descendents, including file systems and snapshots. Setting a 1103quota on a descendent of a dataset that already has a quota does not override 1104the ancestor's quota, but rather imposes an additional limit. 1105.Pp 1106Quotas cannot be set on volumes, as the 1107.Sy volsize 1108property acts as an implicit quota. 1109.It Sy snapshot_limit Ns = Ns Ar count | Cm none 1110Limits the number of snapshots that can be created on a dataset and its 1111descendents. 1112Setting a 1113.Sy snapshot_limit 1114on a descendent of a dataset that already 1115has a 1116.Sy snapshot_limit 1117does not override the ancestor's 1118.Sy snapshot_limit , 1119but 1120rather imposes an additional limit. 1121The limit is not enforced if the user is 1122allowed to change the limit. 1123For example, this means that recursive snapshots 1124taken from the global zone are counted against each delegated dataset within 1125a jail. 1126This feature must be enabled to be used 1127.Po see 1128.Xr zpool-features 7 1129.Pc . 1130.It Sy userquota@ Ns Ar user Ns = Ns Ar size | Cm none 1131Limits the amount of space consumed by the specified user. 1132Similar to the 1133.Sy refquota 1134property, the 1135.Sy userquota 1136space calculation does not include space that is used by descendent datasets, 1137such as snapshots and clones. User space consumption is identified by the 1138.Sy userspace@ Ns Ar user 1139property. 1140.Pp 1141Enforcement of user quotas may be delayed by several seconds. This delay means 1142that a user might exceed their quota before the system notices that they are 1143over quota and begins to refuse additional writes with the 1144.Em EDQUOT 1145error message. See the 1146.Cm userspace 1147subcommand for more information. 1148.Pp 1149Unprivileged users can only access their own groups' space usage. The root 1150user, or a user who has been granted the 1151.Sy userquota 1152privilege with 1153.Qq Nm Cm allow , 1154can get and set everyone's quota. 1155.Pp 1156This property is not available on volumes, on file systems before version 4, or 1157on pools before version 15. The 1158.Sy userquota@ Ns ... 1159properties are not displayed by 1160.Qq Nm Cm get all . 1161The user's name must be appended after the 1162.Sy @ 1163symbol, using one of the following forms: 1164.Bl -bullet -offset 2n 1165.It 1166POSIX name (for example, 1167.Em joe ) 1168.It 1169POSIX numeric ID (for example, 1170.Em 1001 ) 1171.El 1172.It Sy groupquota@ Ns Ar group Ns = Ns Ar size | Cm none 1173Limits the amount of space consumed by the specified group. Group space 1174consumption is identified by the 1175.Sy userquota@ Ns Ar user 1176property. 1177.Pp 1178Unprivileged users can access only their own groups' space usage. The root 1179user, or a user who has been granted the 1180.Sy groupquota 1181privilege with 1182.Qq Nm Cm allow , 1183can get and set all groups' quotas. 1184.It Sy readonly Ns = Ns Cm on | off 1185Controls whether this dataset can be modified. The default value is 1186.Cm off . 1187.It Sy recordsize Ns = Ns Ar size 1188Specifies a suggested block size for files in the file system. This property is 1189designed solely for use with database workloads that access files in fixed-size 1190records. 1191.Tn ZFS 1192automatically tunes block sizes according to internal algorithms optimized for 1193typical access patterns. 1194.Pp 1195For databases that create very large files but access them in small random 1196chunks, these algorithms may be suboptimal. Specifying a 1197.Sy recordsize 1198greater than or equal to the record size of the database can result in 1199significant performance gains. Use of this property for general purpose file 1200systems is strongly discouraged, and may adversely affect performance. 1201.Pp 1202The size specified must be a power of two greater than or equal to 512 and less 1203than or equal to 128 Kbytes. 1204If the 1205.Sy large_blocks 1206feature is enabled on the pool, the size may be up to 1 Mbyte. 1207See 1208.Xr zpool-features 7 1209for details on ZFS feature flags. 1210.Pp 1211Changing the file system's 1212.Sy recordsize 1213affects only files created afterward; existing files are unaffected. 1214.Pp 1215This property can also be referred to by its shortened column name, 1216.Sy recsize . 1217.It Sy redundant_metadata Ns = Ns Cm all | most 1218Controls what types of metadata are stored redundantly. 1219ZFS stores an extra copy of metadata, so that if a single block is corrupted, 1220the amount of user data lost is limited. 1221This extra copy is in addition to any redundancy provided at the pool level 1222.Pq e.g. by mirroring or RAID-Z , 1223and is in addition to an extra copy specified by the 1224.Sy copies 1225property 1226.Pq up to a total of 3 copies . 1227For example if the pool is mirrored, 1228.Cm copies Ns = Ns Ar 2 , 1229and 1230.Cm redundant_metadata Ns = Ns Ar most , 1231then ZFS 1232stores 6 copies of most metadata, and 4 copies of data and some 1233metadata. 1234.Pp 1235When set to 1236.Cm all , 1237ZFS stores an extra copy of all metadata. 1238If a 1239single on-disk block is corrupt, at worst a single block of user data 1240.Po which is 1241.Cm recordsize 1242bytes long 1243can be lost. 1244.Pc 1245.Pp 1246When set to 1247.Cm most , 1248ZFS stores an extra copy of most types of 1249metadata. 1250This can improve performance of random writes, because less 1251metadata must be written. 1252In practice, at worst about 100 blocks 1253.Po of 1254.Cm recordsize 1255bytes each 1256.Pc 1257of user data can be lost if a single 1258on-disk block is corrupt. 1259The exact behavior of which metadata blocks 1260are stored redundantly may change in future releases. 1261.Pp 1262The default value is 1263.Cm all . 1264.It Sy refquota Ns = Ns Ar size | Cm none 1265Limits the amount of space a dataset can consume. This property enforces a hard 1266limit on the amount of space used. This hard limit does not include space used 1267by descendents, including file systems and snapshots. 1268.It Sy refreservation Ns = Ns Ar size | Cm none 1269The minimum amount of space guaranteed to a dataset, not including its 1270descendents. When the amount of space used is below this value, the dataset is 1271treated as if it were taking up the amount of space specified by 1272.Sy refreservation . 1273The 1274.Sy refreservation 1275reservation is accounted for in the parent datasets' space used, and counts 1276against the parent datasets' quotas and reservations. 1277.Pp 1278If 1279.Sy refreservation 1280is set, a snapshot is only allowed if there is enough free pool space outside 1281of this reservation to accommodate the current number of "referenced" bytes in 1282the dataset. 1283.Pp 1284This property can also be referred to by its shortened column name, 1285.Sy refreserv . 1286.It Sy reservation Ns = Ns Ar size | Cm none 1287The minimum amount of space guaranteed to a dataset and its descendents. When 1288the amount of space used is below this value, the dataset is treated as if it 1289were taking up the amount of space specified by its reservation. Reservations 1290are accounted for in the parent datasets' space used, and count against the 1291parent datasets' quotas and reservations. 1292.Pp 1293This property can also be referred to by its shortened column name, 1294.Sy reserv . 1295.It Sy secondarycache Ns = Ns Cm all | none | metadata 1296Controls what is cached in the secondary cache (L2ARC). If this property is set 1297to 1298.Cm all , 1299then both user data and metadata is cached. If this property is set to 1300.Cm none , 1301then neither user data nor metadata is cached. If this property is set to 1302.Cm metadata , 1303then only metadata is cached. The default value is 1304.Cm all . 1305.It Sy setuid Ns = Ns Cm on | off 1306Controls whether the 1307.No set- Ns Tn UID 1308bit is respected for the file system. The default value is 1309.Cm on . 1310.It Sy sharesmb Ns = Ns Cm on | off | Ar opts 1311The 1312.Sy sharesmb 1313property currently has no effect on 1314.Nx . 1315.It Sy sharenfs Ns = Ns Cm on | off | Ar opts 1316Controls whether the file system is shared via 1317.Tn NFS , 1318and what options are used. A file system with a 1319.Sy sharenfs 1320property of 1321.Cm off 1322is managed the traditional way via 1323.Xr exports 5 . 1324Otherwise, the file system is automatically shared and unshared with the 1325.Qq Nm Cm share 1326and 1327.Qq Nm Cm unshare 1328commands. If the property is set to 1329.Cm on 1330no 1331.Tn NFS 1332export options are used. Otherwise, 1333.Tn NFS 1334export options are equivalent to the contents of this property. The export 1335options may be comma-separated. See 1336.Xr exports 5 1337for a list of valid options. 1338.Pp 1339When the 1340.Sy sharenfs 1341property is changed for a dataset, the 1342.Xr mountd 8 1343daemon is reloaded. 1344.It Sy logbias Ns = Ns Cm latency | throughput 1345Provide a hint to 1346.Tn ZFS 1347about handling of synchronous requests in this dataset. 1348If 1349.Sy logbias 1350is set to 1351.Cm latency 1352(the default), 1353.Tn ZFS 1354will use pool log devices (if configured) to handle the requests at low 1355latency. If 1356.Sy logbias 1357is set to 1358.Cm throughput , 1359.Tn ZFS 1360will not use configured pool log devices. 1361.Tn ZFS 1362will instead optimize synchronous operations for global pool throughput and 1363efficient use of resources. 1364.It Sy snapdir Ns = Ns Cm hidden | visible 1365Controls whether the 1366.Pa \&.zfs 1367directory is hidden or visible in the root of the file system as discussed in 1368the 1369.Qq Sx Snapshots 1370section. The default value is 1371.Cm hidden . 1372.It Sy sync Ns = Ns Cm standard | always | disabled 1373Controls the behavior of synchronous requests (e.g. 1374.Xr fsync 2 , 1375O_DSYNC). This property accepts the following values: 1376.Bl -tag -offset 4n -width 8n 1377.It Sy standard 1378This is the POSIX specified behavior of ensuring all synchronous requests are 1379written to stable storage and all devices are flushed to ensure data is not 1380cached by device controllers (this is the default). 1381.It Sy always 1382All file system transactions are written and flushed before their system calls 1383return. This has a large performance penalty. 1384.It Sy disabled 1385Disables synchronous requests. File system transactions are only committed to 1386stable storage periodically. This option will give the highest performance. 1387However, it is very dangerous as 1388.Tn ZFS 1389would be ignoring the synchronous transaction demands of applications such as 1390databases or 1391.Tn NFS . 1392Administrators should only use this option when the risks are understood. 1393.El 1394.It Sy volsize Ns = Ns Ar size 1395For volumes, specifies the logical size of the volume. By default, creating a 1396volume establishes a reservation of equal size. For storage pools with a 1397version number of 9 or higher, a 1398.Sy refreservation 1399is set instead. Any changes to 1400.Sy volsize 1401are reflected in an equivalent change to the reservation (or 1402.Sy refreservation ) . 1403The 1404.Sy volsize 1405can only be set to a multiple of 1406.Cm volblocksize , 1407and cannot be zero. 1408.Pp 1409The reservation is kept equal to the volume's logical size to prevent 1410unexpected behavior for consumers. Without the reservation, the volume could 1411run out of space, resulting in undefined behavior or data corruption, depending 1412on how the volume is used. These effects can also occur when the volume size is 1413changed while it is in use (particularly when shrinking the size). Extreme care 1414should be used when adjusting the volume size. 1415.Pp 1416Though not recommended, a "sparse volume" (also known as "thin provisioning") 1417can be created by specifying the 1418.Fl s 1419option to the 1420.Qq Nm Cm create Fl V 1421command, or by changing the reservation after the volume has been created. A 1422"sparse volume" is a volume where the reservation is less then the volume size. 1423Consequently, writes to a sparse volume can fail with 1424.Sy ENOSPC 1425when the pool is low on space. For a sparse volume, changes to 1426.Sy volsize 1427are not reflected in the reservation. 1428.It Sy volmode Ns = Ns Cm default | geom | dev | none 1429This property specifies how volumes should be exposed to the OS. 1430Setting it to 1431.Sy geom 1432exposes volumes as 1433.Xr geom 4 1434providers, providing maximal functionality. 1435Setting it to 1436.Sy dev 1437exposes volumes only as cdev device in devfs. 1438Such volumes can be accessed only as raw disk device files, i.e. they 1439can not be partitioned, mounted, participate in RAIDs, etc, but they 1440are faster, and in some use scenarios with untrusted consumer, such as 1441NAS or VM storage, can be more safe. 1442Volumes with property set to 1443.Sy none 1444are not exposed outside ZFS, but can be snapshoted, cloned, replicated, etc, 1445that can be suitable for backup purposes. 1446Value 1447.Sy default 1448means that volumes exposition is controlled by system-wide sysctl/tunable 1449.Va vfs.zfs.vol.mode , 1450where 1451.Sy geom , 1452.Sy dev 1453and 1454.Sy none 1455are encoded as 1, 2 and 3 respectively. 1456The default values is 1457.Sy geom . 1458This property can be changed any time, but so far it is processed only 1459during volume creation and pool import. 1460.It Sy vscan Ns = Ns Cm off | on 1461The 1462.Sy vscan 1463property is currently not supported on 1464.Nx . 1465.It Sy xattr Ns = Ns Cm off | on 1466The 1467.Sy xattr 1468property is currently not supported on 1469.Nx . 1470.El 1471.Pp 1472The following three properties cannot be changed after the file system is 1473created, and therefore, should be set when the file system is created. If the 1474properties are not set with the 1475.Qq Nm Cm create 1476or 1477.Nm zpool Cm create 1478commands, these properties are inherited from the parent dataset. If the parent 1479dataset lacks these properties due to having been created prior to these 1480features being supported, the new file system will have the default values for 1481these properties. 1482.Bl -tag -width 4n 1483.It Sy casesensitivity Ns = Ns Cm sensitive | insensitive | mixed 1484Indicates whether the file name matching algorithm used by the file system 1485should be case-sensitive, case-insensitive, or allow a combination of both 1486styles of matching. The default value for the 1487.Sy casesensitivity 1488property is 1489.Cm sensitive . 1490Traditionally, UNIX and POSIX file systems have case-sensitive file names. 1491.Pp 1492The 1493.Cm mixed 1494value for the 1495.Sy casesensitivity 1496property indicates that the 1497file system can support requests for both case-sensitive and case-insensitive 1498matching behavior. 1499.It Sy normalization Ns = Ns Cm none | formC | formD | formKC | formKD 1500Indicates whether the file system should perform a 1501.Sy unicode 1502normalization of file names whenever two file names are compared, and which 1503normalization algorithm should be used. File names are always stored 1504unmodified, names are normalized as part of any comparison process. If this 1505property is set to a legal value other than 1506.Cm none , 1507and the 1508.Sy utf8only 1509property was left unspecified, the 1510.Sy utf8only 1511property is automatically set to 1512.Cm on . 1513The default value of the 1514.Sy normalization 1515property is 1516.Cm none . 1517This property cannot be changed after the file system is created. 1518.It Sy utf8only Ns = Ns Cm on | off 1519Indicates whether the file system should reject file names that include 1520characters that are not present in the 1521.Sy UTF-8 1522character code set. If this property is explicitly set to 1523.Cm off , 1524the normalization property must either not be explicitly set or be set to 1525.Cm none . 1526The default value for the 1527.Sy utf8only 1528property is 1529.Cm off . 1530This property cannot be changed after the file system is created. 1531.El 1532.Pp 1533The 1534.Sy casesensitivity , normalization , No and Sy utf8only 1535properties are also new permissions that can be assigned to non-privileged 1536users by using the 1537.Tn ZFS 1538delegated administration feature. 1539.Ss Temporary Mount Point Properties 1540When a file system is mounted, either through 1541.Xr mount 8 1542for legacy mounts or the 1543.Qq Nm Cm mount 1544command for normal file systems, its mount options are set according to its 1545properties. The correlation between properties and mount options is as follows: 1546.Bl -column -offset 4n "PROPERTY" "MOUNT OPTION" 1547.It "PROPERTY MOUNT OPTION" 1548.It "atime atime/noatime" 1549.It "exec exec/noexec" 1550.It "readonly ro/rw" 1551.It "setuid suid/nosuid" 1552.El 1553.Pp 1554In addition, these options can be set on a per-mount basis using the 1555.Fl o 1556option, without affecting the property that is stored on disk. The values 1557specified on the command line override the values stored in the dataset. These 1558properties are reported as "temporary" by the 1559.Qq Nm Cm get 1560command. If the properties are changed while the dataset is mounted, the new 1561setting overrides any temporary settings. 1562.Ss User Properties 1563In addition to the standard native properties, 1564.Tn ZFS 1565supports arbitrary user properties. User properties have no effect on 1566.Tn ZFS 1567behavior, but applications or administrators can use them to annotate datasets 1568(file systems, volumes, and snapshots). 1569.Pp 1570User property names must contain a colon 1571.Pq Sy \&: 1572character to distinguish them from native properties. They may contain 1573lowercase letters, numbers, and the following punctuation characters: colon 1574.Pq Sy \&: , 1575dash 1576.Pq Sy \&- , 1577period 1578.Pq Sy \&. 1579and underscore 1580.Pq Sy \&_ . 1581The expected convention is that the property name is divided into two portions 1582such as 1583.Em module Ns Sy \&: Ns Em property , 1584but this namespace is not enforced by 1585.Tn ZFS . 1586User property names can be at most 256 characters, and cannot begin with a dash 1587.Pq Sy \&- . 1588.Pp 1589When making programmatic use of user properties, it is strongly suggested to 1590use a reversed 1591.Tn DNS 1592domain name for the 1593.Ar module 1594component of property names to reduce the chance that two 1595independently-developed packages use the same property name for different 1596purposes. Property names beginning with 1597.Em com.sun 1598are reserved for use by Sun Microsystems. 1599.Pp 1600The values of user properties are arbitrary strings, are always inherited, and 1601are never validated. All of the commands that operate on properties 1602.Po 1603.Qq Nm Cm list , 1604.Qq Nm Cm get , 1605.Qq Nm Cm set 1606and so forth 1607.Pc 1608can be used to manipulate both native properties and user properties. Use the 1609.Qq Nm Cm inherit 1610command to clear a user property. If the property is not defined in any parent 1611dataset, it is removed entirely. Property values are limited to 1024 1612characters. 1613.Sh SUBCOMMANDS 1614All subcommands that modify state are logged persistently to the pool in their 1615original form. 1616.Bl -tag -width 2n 1617.It Xo 1618.Nm 1619.Op Fl \&? 1620.Xc 1621.Pp 1622Displays a help message. 1623.It Xo 1624.Nm 1625.Cm create 1626.Op Fl pu 1627.Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... 1628.Ar filesystem 1629.Xc 1630.Pp 1631Creates a new 1632.Tn ZFS 1633file system. The file system is automatically mounted according to the 1634.Sy mountpoint 1635property inherited from the parent. 1636.Bl -tag -width indent 1637.It Fl p 1638Creates all the non-existing parent datasets. Datasets created in this manner 1639are automatically mounted according to the 1640.Sy mountpoint 1641property inherited from their parent. Any property specified on the command 1642line using the 1643.Fl o 1644option is ignored. If the target filesystem already exists, the operation 1645completes successfully. 1646.It Fl u 1647Newly created file system is not mounted. 1648.It Fl o Ar property Ns = Ns Ar value 1649Sets the specified property as if the command 1650.Qq Nm Cm set Ar property Ns = Ns Ar value 1651was invoked at the same time the dataset was created. Any editable 1652.Tn ZFS 1653property can also be set at creation time. Multiple 1654.Fl o 1655options can be specified. An error results if the same property is specified in 1656multiple 1657.Fl o 1658options. 1659.El 1660.It Xo 1661.Nm 1662.Cm create 1663.Op Fl ps 1664.Op Fl b Ar blocksize 1665.Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... 1666.Fl V 1667.Ar size volume 1668.Xc 1669.Pp 1670Creates a volume of the given size. The volume is exported as a block device in 1671.Pa /dev/zvol/path , 1672where 1673.Ar path 1674is the name of the volume in the 1675.Tn ZFS 1676namespace. The size represents the logical size as exported by the device. By 1677default, a reservation of equal size is created. 1678.Pp 1679.Ar size 1680is automatically rounded up to the nearest 128 Kbytes to ensure that 1681the volume has an integral number of blocks regardless of 1682.Ar blocksize . 1683.Bl -tag -width indent 1684.It Fl p 1685Creates all the non-existing parent datasets. Datasets created in this manner 1686are automatically mounted according to the 1687.Sy mountpoint 1688property inherited from their parent. Any property specified on the command 1689line using the 1690.Fl o 1691option is ignored. If the target filesystem already exists, the operation 1692completes successfully. 1693.It Fl s 1694Creates a sparse volume with no reservation. See 1695.Sy volsize 1696in the 1697.Qq Sx Native Properties 1698section for more information about sparse volumes. 1699.It Fl b Ar blocksize 1700Equivalent to 1701.Fl o Cm volblocksize Ns = Ns Ar blocksize . 1702If this option is specified in conjunction with 1703.Fl o Cm volblocksize , 1704the resulting behavior is undefined. 1705.It Fl o Ar property Ns = Ns Ar value 1706Sets the specified property as if the 1707.Qq Nm Cm set Ar property Ns = Ns Ar value 1708command was invoked at the same time the dataset was created. Any editable 1709.Tn ZFS 1710property can also be set at creation time. Multiple 1711.Fl o 1712options can be specified. An error results if the same property is specified in 1713multiple 1714.Fl o 1715options. 1716.El 1717.It Xo 1718.Nm 1719.Cm destroy 1720.Op Fl fnpRrv 1721.Ar filesystem Ns | Ns Ar volume 1722.Xc 1723.Pp 1724Destroys the given dataset. By default, the command unshares any file systems 1725that are currently shared, unmounts any file systems that are currently 1726mounted, and refuses to destroy a dataset that has active dependents (children 1727or clones). 1728.Bl -tag -width indent 1729.It Fl r 1730Recursively destroy all children. 1731.It Fl R 1732Recursively destroy all dependents, including cloned file systems outside the 1733target hierarchy. 1734.It Fl f 1735Force an unmount of any file systems using the 1736.Qq Nm Cm unmount Fl f 1737command. This option has no effect on non-file systems or unmounted file 1738systems. 1739.It Fl n 1740Do a dry-run ("No-op") deletion. No data will be deleted. This is useful in 1741conjunction with the 1742.Fl v 1743or 1744.Fl p 1745flags to determine what data would be deleted. 1746.It Fl p 1747Print machine-parsable verbose information about the deleted data. 1748.It Fl v 1749Print verbose information about the deleted data. 1750.El 1751.Pp 1752Extreme care should be taken when applying either the 1753.Fl r 1754or the 1755.Fl R 1756options, as they can destroy large portions of a pool and cause unexpected 1757behavior for mounted file systems in use. 1758.It Xo 1759.Nm 1760.Cm destroy 1761.Op Fl dnpRrv 1762.Sm off 1763.Ar snapshot 1764.Op % Ns Ar snapname 1765.Op , Ns ... 1766.Sm on 1767.Xc 1768.Pp 1769The given snapshots are destroyed immediately if and only if the 1770.Qq Nm Cm destroy 1771command without the 1772.Fl d 1773option would have destroyed it. Such immediate destruction would occur, for 1774example, if the snapshot had no clones and the user-initiated reference count 1775were zero. 1776.Pp 1777If a snapshot does not qualify for immediate destruction, it is marked for 1778deferred deletion. In this state, it exists as a usable, visible snapshot until 1779both of the preconditions listed above are met, at which point it is destroyed. 1780.Pp 1781An inclusive range of snapshots may be specified by separating the 1782first and last snapshots with a percent sign 1783.Pq Sy % . 1784The first and/or last snapshots may be left blank, in which case the 1785filesystem's oldest or newest snapshot will be implied. 1786.Pp 1787Multiple snapshots 1788(or ranges of snapshots) of the same filesystem or volume may be specified 1789in a comma-separated list of snapshots. 1790Only the snapshot's short name (the 1791part after the 1792.Sy @ ) 1793should be specified when using a range or comma-separated list to identify 1794multiple snapshots. 1795.Bl -tag -width indent 1796.It Fl r 1797Destroy (or mark for deferred deletion) all snapshots with this name in 1798descendent file systems. 1799.It Fl R 1800Recursively destroy all clones of these snapshots, including the clones, 1801snapshots, and children. 1802If this flag is specified, the 1803.Fl d 1804flag will have no effect. 1805.It Fl n 1806Do a dry-run ("No-op") deletion. No data will be deleted. This is useful in 1807conjunction with the 1808.Fl v 1809or 1810.Fl p 1811flags to determine what data would be deleted. 1812.It Fl p 1813Print machine-parsable verbose information about the deleted data. 1814.It Fl v 1815Print verbose information about the deleted data. 1816.It Fl d 1817Defer snapshot deletion. 1818.El 1819.Pp 1820Extreme care should be taken when applying either the 1821.Fl r 1822or the 1823.Fl R 1824options, as they can destroy large portions of a pool and cause unexpected 1825behavior for mounted file systems in use. 1826.It Xo 1827.Nm 1828.Cm destroy 1829.Ar filesystem Ns | Ns Ar volume Ns # Ns Ar bookmark 1830.Xc 1831.Pp 1832The given bookmark is destroyed. 1833.It Xo 1834.Nm 1835.Cm snapshot Ns | Ns Cm snap 1836.Op Fl r 1837.Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... 1838.Ar filesystem@snapname Ns | Ns volume@snapname 1839.Ar filesystem@snapname Ns | Ns volume@snapname Ns ... 1840.Xc 1841.Pp 1842Creates snapshots with the given names. All previous modifications by 1843successful system calls to the file system are part of the snapshots. 1844Snapshots are taken atomically, so that all snapshots correspond to the same 1845moment in time. See the 1846.Qq Sx Snapshots 1847section for details. 1848.Bl -tag -width indent 1849.It Fl r 1850Recursively create snapshots of all descendent datasets 1851.It Fl o Ar property Ns = Ns Ar value 1852Sets the specified property; see 1853.Qq Nm Cm create 1854for details. 1855.El 1856.It Xo 1857.Nm 1858.Cm rollback 1859.Op Fl rRf 1860.Ar snapshot 1861.Xc 1862.Pp 1863Roll back the given dataset to a previous snapshot. When a dataset is rolled 1864back, all data that has changed since the snapshot is discarded, and the 1865dataset reverts to the state at the time of the snapshot. By default, the 1866command refuses to roll back to a snapshot other than the most recent one. In 1867order to do so, all intermediate snapshots and bookmarks must be destroyed 1868by specifying the 1869.Fl r 1870option. 1871.Pp 1872The 1873.Fl rR 1874options do not recursively destroy the child snapshots of a 1875recursive snapshot. 1876Only direct snapshots of the specified filesystem 1877are destroyed by either of these options. 1878To completely roll back a 1879recursive snapshot, you must rollback the individual child snapshots. 1880.Bl -tag -width indent 1881.It Fl r 1882Destroy any snapshots and bookmarks more recent than the one specified. 1883.It Fl R 1884Destroy any more recent snapshots and bookmarks, as well as any clones of those 1885snapshots. 1886.It Fl f 1887Used with the 1888.Fl R 1889option to force an unmount of any clone file systems that are to be destroyed. 1890.El 1891.It Xo 1892.Nm 1893.Cm clone 1894.Op Fl p 1895.Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... 1896.Ar snapshot filesystem Ns | Ns Ar volume 1897.Xc 1898.Pp 1899Creates a clone of the given snapshot. See the 1900.Qq Sx Clones 1901section for details. The target dataset can be located anywhere in the 1902.Tn ZFS 1903hierarchy, and is created as the same type as the original. 1904.Bl -tag -width indent 1905.It Fl p 1906Creates all the non-existing parent datasets. Datasets created in this manner 1907are automatically mounted according to the 1908.Sy mountpoint 1909property inherited from their parent. If the target filesystem or volume 1910already exists, the operation completes successfully. 1911.It Fl o Ar property Ns = Ns Ar value 1912Sets the specified property; see 1913.Qq Nm Cm create 1914for details. 1915.El 1916.It Xo 1917.Nm 1918.Cm promote 1919.Ar clone-filesystem 1920.Xc 1921.Pp 1922Promotes a clone file system to no longer be dependent on its "origin" 1923snapshot. This makes it possible to destroy the file system that the clone was 1924created from. The clone parent-child dependency relationship is reversed, so 1925that the origin file system becomes a clone of the specified file system. 1926.Pp 1927The snapshot that was cloned, and any snapshots previous to this snapshot, are 1928now owned by the promoted clone. The space they use moves from the origin file 1929system to the promoted clone, so enough space must be available to accommodate 1930these snapshots. No new space is consumed by this operation, but the space 1931accounting is adjusted. The promoted clone must not have any conflicting 1932snapshot names of its own. The 1933.Cm rename 1934subcommand can be used to rename any conflicting snapshots. 1935.It Xo 1936.Nm 1937.Cm rename 1938.Op Fl f 1939.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot 1940.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot 1941.Xc 1942.It Xo 1943.Nm 1944.Cm rename 1945.Op Fl f 1946.Fl p 1947.Ar filesystem Ns | Ns Ar volume 1948.Ar filesystem Ns | Ns Ar volume 1949.Xc 1950.It Xo 1951.Nm 1952.Cm rename 1953.Fl u 1954.Op Fl p 1955.Ar filesystem filesystem 1956.Xc 1957.Pp 1958Renames the given dataset. The new target can be located anywhere in the 1959.Tn ZFS 1960hierarchy, with the exception of snapshots. Snapshots can only be renamed 1961within the parent file system or volume. When renaming a snapshot, the parent 1962file system of the snapshot does not need to be specified as part of the second 1963argument. Renamed file systems can inherit new mount points, in which case they 1964are unmounted and remounted at the new mount point. 1965.Bl -tag -width indent 1966.It Fl p 1967Creates all the nonexistent parent datasets. Datasets created in this manner 1968are automatically mounted according to the 1969.Sy mountpoint 1970property inherited from their parent. 1971.It Fl u 1972Do not remount file systems during rename. If a file system's 1973.Sy mountpoint 1974property is set to 1975.Cm legacy 1976or 1977.Cm none , 1978file system is not unmounted even if this option is not given. 1979.It Fl f 1980Force unmount any filesystems that need to be unmounted in the process. 1981This flag has no effect if used together with the 1982.Fl u 1983flag. 1984.El 1985.It Xo 1986.Nm 1987.Cm rename 1988.Fl r 1989.Ar snapshot snapshot 1990.Xc 1991.Pp 1992Recursively rename the snapshots of all descendent datasets. Snapshots are the 1993only dataset that can be renamed recursively. 1994.It Xo 1995.Nm 1996.Cm list 1997.Op Fl r Ns | Ns Fl d Ar depth 1998.Op Fl Hp 1999.Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ... 2000.Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... 2001.Oo Fl s Ar property Oc Ns ... 2002.Oo Fl S Ar property Oc Ns ... 2003.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ... 2004.Xc 2005.Pp 2006Lists the property information for the given datasets in tabular form. If 2007specified, you can list property information by the absolute pathname or the 2008relative pathname. By default, all file systems and volumes are displayed. 2009Snapshots are displayed if the 2010.Sy listsnaps 2011property is 2012.Cm on 2013(the default is 2014.Cm off ) . 2015The following fields are displayed, 2016.Sy name , used , available , referenced , mountpoint . 2017.Bl -tag -width indent 2018.It Fl r 2019Recursively display any children of the dataset on the command line. 2020.It Fl d Ar depth 2021Recursively display any children of the dataset, limiting the recursion to 2022.Ar depth . 2023A depth of 2024.Sy 1 2025will display only the dataset and its direct children. 2026.It Fl H 2027Used for scripting mode. Do not print headers and separate fields by a single 2028tab instead of arbitrary white space. 2029.It Fl p 2030Display numbers in parsable (exact) values. 2031.It Fl o Ar property Ns Oo , Ns Ar property Oc Ns ... 2032A comma-separated list of properties to display. The property must be: 2033.Bl -bullet -offset 2n 2034.It 2035One of the properties described in the 2036.Qq Sx Native Properties 2037section 2038.It 2039A user property 2040.It 2041The value 2042.Cm name 2043to display the dataset name 2044.It 2045The value 2046.Cm space 2047to display space usage properties on file systems and volumes. This is a 2048shortcut for specifying 2049.Fl o 2050.Sy name,avail,used,usedsnap,usedds,usedrefreserv,usedchild 2051.Fl t 2052.Sy filesystem,volume 2053syntax. 2054.El 2055.It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... 2056A comma-separated list of types to display, where 2057.Ar type 2058is one of 2059.Sy filesystem , snapshot , snap , volume , bookmark , No or Sy all . 2060For example, specifying 2061.Fl t Cm snapshot 2062displays only snapshots. 2063.It Fl s Ar property 2064A property for sorting the output by column in ascending order based on the 2065value of the property. The property must be one of the properties described in 2066the 2067.Qq Sx Properties 2068section, or the special value 2069.Cm name 2070to sort by the dataset name. Multiple properties can be specified at one time 2071using multiple 2072.Fl s 2073property options. Multiple 2074.Fl s 2075options are evaluated from left to right in decreasing order of importance. 2076.Pp 2077The following is a list of sorting criteria: 2078.Bl -bullet -offset 2n 2079.It 2080Numeric types sort in numeric order. 2081.It 2082String types sort in alphabetical order. 2083.It 2084Types inappropriate for a row sort that row to the literal bottom, regardless 2085of the specified ordering. 2086.It 2087If no sorting options are specified the existing behavior of 2088.Qq Nm Cm list 2089is preserved. 2090.El 2091.It Fl S Ar property 2092Same as the 2093.Fl s 2094option, but sorts by property in descending order. 2095.El 2096.It Xo 2097.Nm 2098.Cm set 2099.Ar property Ns = Ns Ar value Oo Ar property Ns = Ns Ar value Oc Ns ... 2100.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot 2101.Xc 2102.Pp 2103Sets the property or list of properties to the given value(s) for each dataset. 2104Only some properties can be edited. See the "Properties" section for more 2105information on what properties can be set and acceptable values. Numeric values 2106can be specified as exact values, or in a human-readable form with a suffix of 2107.Sy B , K , M , G , T , P , E , Z 2108(for bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes, exabytes, or 2109zettabytes, respectively). User properties can be set on snapshots. For more 2110information, see the 2111.Qq Sx User Properties 2112section. 2113.It Xo 2114.Nm 2115.Cm get 2116.Op Fl r Ns | Ns Fl d Ar depth 2117.Op Fl Hp 2118.Op Fl o Ar all | field Ns Oo , Ns Ar field Oc Ns ... 2119.Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... 2120.Op Fl s Ar source Ns Oo , Ns Ar source Oc Ns ... 2121.Ar all | property Ns Oo , Ns Ar property Oc Ns ... 2122.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ... 2123.Xc 2124.Pp 2125Displays properties for the given datasets. If no datasets are specified, then 2126the command displays properties for all datasets on the system. For each 2127property, the following columns are displayed: 2128.Pp 2129.Bl -hang -width "property" -offset indent -compact 2130.It name 2131Dataset name 2132.It property 2133Property name 2134.It value 2135Property value 2136.It source 2137Property source. Can either be local, default, temporary, inherited, received, 2138or none 2139(\&-). 2140.El 2141.Pp 2142All columns except the 2143.Sy RECEIVED 2144column are displayed by default. The columns to display can be specified 2145by using the 2146.Fl o 2147option. This command takes a comma-separated list of properties as described in 2148the 2149.Qq Sx Native Properties 2150and 2151.Qq Sx User Properties 2152sections. 2153.Pp 2154The special value 2155.Cm all 2156can be used to display all properties that apply to the given dataset's type 2157(filesystem, volume, snapshot, or bookmark). 2158.Bl -tag -width indent 2159.It Fl r 2160Recursively display properties for any children. 2161.It Fl d Ar depth 2162Recursively display any children of the dataset, limiting the recursion to 2163.Ar depth . 2164A depth of 2165.Sy 1 2166will display only the dataset and its direct children. 2167.It Fl H 2168Display output in a form more easily parsed by scripts. Any headers are 2169omitted, and fields are explicitly separated by a single tab instead of an 2170arbitrary amount of space. 2171.It Fl p 2172Display numbers in parsable (exact) values. 2173.It Fl o Cm all | Ar field Ns Oo , Ns Ar field Oc Ns ... 2174A comma-separated list of columns to display. Supported values are 2175.Sy name,property,value,received,source . 2176Default values are 2177.Sy name,property,value,source . 2178The keyword 2179.Cm all 2180specifies all columns. 2181.It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... 2182A comma-separated list of types to display, where 2183.Ar type 2184is one of 2185.Sy filesystem , snapshot , volume , No or Sy all . 2186For example, specifying 2187.Fl t Cm snapshot 2188displays only snapshots. 2189.It Fl s Ar source Ns Oo , Ns Ar source Oc Ns ... 2190A comma-separated list of sources to display. Those properties coming from a 2191source other than those in this list are ignored. Each source must be one of 2192the following: 2193.Sy local,default,inherited,temporary,received,none . 2194The default value is all sources. 2195.El 2196.It Xo 2197.Nm 2198.Cm inherit 2199.Op Fl rS 2200.Ar property 2201.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ... 2202.Xc 2203.Pp 2204Clears the specified property, causing it to be inherited from an ancestor, 2205restored to default if no ancestor has the property set, or with the 2206.Fl S 2207option reverted to the received value if one exists. 2208See the 2209.Qq Sx Properties 2210section for a listing of default values, and details on which properties can be 2211inherited. 2212.Bl -tag -width indent 2213.It Fl r 2214Recursively inherit the given property for all children. 2215.It Fl S 2216Revert the property to the received value if one exists; otherwise operate as 2217if the 2218.Fl S 2219option was not specified. 2220.El 2221.It Xo 2222.Nm 2223.Cm upgrade 2224.Op Fl v 2225.Xc 2226.Pp 2227Displays a list of file systems that are not the most recent version. 2228.Bl -tag -width indent 2229.It Fl v 2230Displays 2231.Tn ZFS 2232filesystem versions supported by the current software. The current 2233.Tn ZFS 2234filesystem version and all previous supported versions are displayed, along 2235with an explanation of the features provided with each version. 2236.El 2237.It Xo 2238.Nm 2239.Cm upgrade 2240.Op Fl r 2241.Op Fl V Ar version 2242.Fl a | Ar filesystem 2243.Xc 2244.Pp 2245Upgrades file systems to a new on-disk version. Once this is done, the file 2246systems will no longer be accessible on systems running older versions of the 2247software. 2248.Qq Nm Cm send 2249streams generated from new snapshots of these file systems cannot be accessed 2250on systems running older versions of the software. 2251.Pp 2252In general, the file system version is independent of the pool version. See 2253.Xr zpool 8 2254for information on the 2255.Nm zpool Cm upgrade 2256command. 2257.Pp 2258In some cases, the file system version and the pool version are interrelated 2259and the pool version must be upgraded before the file system version can be 2260upgraded. 2261.Bl -tag -width indent 2262.It Fl r 2263Upgrade the specified file system and all descendent file systems. 2264.It Fl V Ar version 2265Upgrade to the specified 2266.Ar version . 2267If the 2268.Fl V 2269flag is not specified, this command upgrades to the most recent version. This 2270option can only be used to increase the version number, and only up to the most 2271recent version supported by this software. 2272.It Fl a 2273Upgrade all file systems on all imported pools. 2274.It Ar filesystem 2275Upgrade the specified file system. 2276.El 2277.It Xo 2278.Nm 2279.Cm userspace 2280.Op Fl Hinp 2281.Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... 2282.Oo Fl s Ar field Oc Ns ... 2283.Oo Fl S Ar field Oc Ns ... 2284.Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... 2285.Ar filesystem Ns | Ns Ar snapshot 2286.Xc 2287.Pp 2288Displays space consumed by, and quotas on, each user in the specified 2289filesystem or snapshot. This corresponds to the 2290.Sy userused@ Ns Ar user 2291and 2292.Sy userquota@ Ns Ar user 2293properties. 2294.Bl -tag -width indent 2295.It Fl n 2296Print numeric ID instead of user/group name. 2297.It Fl H 2298Do not print headers, use tab-delimited output. 2299.It Fl p 2300Use exact (parsable) numeric output. 2301.It Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... 2302Display only the specified fields from the following set: 2303.Sy type,name,used,quota . 2304The default is to display all fields. 2305.It Fl s Ar field 2306Sort output by this field. The 2307.Fl s 2308and 2309.Fl S 2310flags may be specified multiple times to sort first by one field, then by 2311another. The default is 2312.Fl s Cm type Fl s Cm name . 2313.It Fl S Ar field 2314Sort by this field in reverse order. See 2315.Fl s . 2316.It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... 2317Print only the specified types from the following set: 2318.Sy all,posixuser,smbuser,posixgroup,smbgroup . 2319.Pp 2320The default is 2321.Fl t Cm posixuser,smbuser . 2322.Pp 2323The default can be changed to include group types. 2324.It Fl i 2325Translate SID to POSIX ID. This flag currently has no effect on 2326.Nx . 2327.El 2328.It Xo 2329.Nm 2330.Cm groupspace 2331.Op Fl Hinp 2332.Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... 2333.Oo Fl s Ar field Oc Ns ... 2334.Oo Fl S Ar field Oc Ns ... 2335.Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... 2336.Ar filesystem Ns | Ns Ar snapshot 2337.Xc 2338.Pp 2339Displays space consumed by, and quotas on, each group in the specified 2340filesystem or snapshot. This subcommand is identical to 2341.Qq Nm Cm userspace , 2342except that the default types to display are 2343.Fl t Sy posixgroup,smbgroup . 2344.It Xo 2345.Nm 2346.Cm mount 2347.Xc 2348.Pp 2349Displays all 2350.Tn ZFS 2351file systems currently mounted. 2352.It Xo 2353.Nm 2354.Cm mount 2355.Op Fl vO 2356.Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ... 2357.Fl a | Ar filesystem 2358.Xc 2359.Pp 2360Mounts 2361.Tn ZFS 2362file systems. 2363.Bl -tag -width indent 2364.It Fl v 2365Report mount progress. 2366.It Fl O 2367Perform an overlay mount. Overlay mounts are not supported on 2368.Nx . 2369.It Fl o Ar property Ns Oo , Ns Ar property Oc Ns ... 2370An optional, comma-separated list of mount options to use temporarily for the 2371duration of the mount. See the 2372.Qq Sx Temporary Mount Point Properties 2373section for details. 2374.It Fl a 2375Mount all available 2376.Tn ZFS 2377file systems. 2378This command may be executed on 2379.Nx 2380system startup by 2381.Pa /etc/rc.d/zfs . 2382For more information, see variable 2383.Va zfs_enable 2384in 2385.Xr rc.conf 5 . 2386.It Ar filesystem 2387Mount the specified filesystem. 2388.El 2389.It Xo 2390.Nm 2391.Cm unmount Ns | Ns Cm umount 2392.Op Fl f 2393.Fl a | Ar filesystem Ns | Ns Ar mountpoint 2394.Xc 2395.Pp 2396Unmounts currently mounted 2397.Tn ZFS 2398file systems. 2399.Bl -tag -width indent 2400.It Fl f 2401Forcefully unmount the file system, even if it is currently in use. 2402.It Fl a 2403Unmount all available 2404.Tn ZFS 2405file systems. 2406.It Ar filesystem | mountpoint 2407Unmount the specified filesystem. The command can also be given a path to a 2408.Tn ZFS 2409file system mount point on the system. 2410.El 2411.It Xo 2412.Nm 2413.Cm share 2414.Fl a | Ar filesystem 2415.Xc 2416.Pp 2417Shares 2418.Tn ZFS 2419file systems that have the 2420.Sy sharenfs 2421property set. 2422.Bl -tag -width indent 2423.It Fl a 2424Share all 2425.Tn ZFS 2426file systems that have the 2427.Sy sharenfs 2428property set. 2429This command may be executed on 2430.Nx 2431system startup by 2432.Pa /etc/rc.d/zfs . 2433For more information, see variable 2434.Va zfs_enable 2435in 2436.Xr rc.conf 5 . 2437.It Ar filesystem 2438Share the specified filesystem according to the 2439.Tn sharenfs 2440property. File systems are shared when the 2441.Tn sharenfs 2442property is set. 2443.El 2444.It Xo 2445.Nm 2446.Cm unshare 2447.Fl a | Ar filesystem Ns | Ns Ar mountpoint 2448.Xc 2449.Pp 2450Unshares 2451.Tn ZFS 2452file systems that have the 2453.Tn sharenfs 2454property set. 2455.Bl -tag -width indent 2456.It Fl a 2457Unshares 2458.Tn ZFS 2459file systems that have the 2460.Sy sharenfs 2461property set. 2462This command may be executed on 2463.Nx 2464system shutdown by 2465.Pa /etc/rc.d/zfs . 2466For more information, see variable 2467.Va zfs_enable 2468in 2469.Xr rc.conf 5 . 2470.It Ar filesystem | mountpoint 2471Unshare the specified filesystem. The command can also be given a path to a 2472.Tn ZFS 2473file system shared on the system. 2474.El 2475.It Xo 2476.Nm 2477.Cm bookmark 2478.Ar snapshot 2479.Ar bookmark 2480.Xc 2481.Pp 2482Creates a bookmark of the given snapshot. 2483Bookmarks mark the point in time 2484when the snapshot was created, and can be used as the incremental source for 2485a 2486.Qq Nm Cm send 2487command. 2488.Pp 2489This feature must be enabled to be used. 2490See 2491.Xr zpool-features 7 2492for details on ZFS feature flags and the 2493.Sy bookmark 2494feature. 2495.It Xo 2496.Nm 2497.Cm send 2498.Op Fl DnPpRveL 2499.Op Fl i Ar snapshot | Fl I Ar snapshot 2500.Ar snapshot 2501.Xc 2502.Pp 2503Creates a stream representation of the last 2504.Ar snapshot 2505argument (not part of 2506.Fl i 2507or 2508.Fl I ) 2509which is written to standard output. The output can be redirected to 2510a file or to a different system (for example, using 2511.Xr ssh 1 ) . 2512By default, a full stream is generated. 2513.Bl -tag -width indent 2514.It Fl i Ar snapshot 2515Generate an incremental stream from the first 2516.Ar snapshot Pq the incremental source 2517to the second 2518.Ar snapshot Pq the incremental target . 2519The incremental source can be specified as the last component of the 2520snapshot name 2521.Pq the Em @ No character and following 2522and 2523it is assumed to be from the same file system as the incremental target. 2524.Pp 2525If the destination is a clone, the source may be the origin snapshot, which 2526must be fully specified (for example, 2527.Cm pool/fs@origin , 2528not just 2529.Cm @origin ) . 2530.It Fl I Ar snapshot 2531Generate a stream package that sends all intermediary snapshots from the first 2532.Ar snapshot 2533to the second 2534.Ar snapshot . 2535For example, 2536.Ic -I @a fs@d 2537is similar to 2538.Ic -i @a fs@b; -i @b fs@c; -i @c fs@d . 2539The incremental 2540source may be specified as with the 2541.Fl i 2542option. 2543.It Fl R 2544Generate a replication stream package, which will replicate the specified 2545filesystem, and all descendent file systems, up to the named snapshot. When 2546received, all properties, snapshots, descendent file systems, and clones are 2547preserved. 2548.Pp 2549If the 2550.Fl i 2551or 2552.Fl I 2553flags are used in conjunction with the 2554.Fl R 2555flag, an incremental replication stream is generated. The current values of 2556properties, and current snapshot and file system names are set when the stream 2557is received. If the 2558.Fl F 2559flag is specified when this stream is received, snapshots and file systems that 2560do not exist on the sending side are destroyed. 2561.It Fl D 2562Generate a deduplicated stream. Blocks which would have been sent multiple 2563times in the send stream will only be sent once. The receiving system must 2564also support this feature to receive a deduplicated stream. This flag can 2565be used regardless of the dataset's 2566.Sy dedup 2567property, but performance will be much better if the filesystem uses a 2568dedup-capable checksum (eg. 2569.Sy sha256 ) . 2570.It Fl L 2571Generate a stream which may contain blocks larger than 128KB. 2572This flag 2573has no effect if the 2574.Sy large_blocks 2575pool feature is disabled, or if the 2576.Sy recordsize 2577property of this filesystem has never been set above 128KB. 2578The receiving system must have the 2579.Sy large_blocks 2580pool feature enabled as well. 2581See 2582.Xr zpool-features 7 2583for details on ZFS feature flags and the 2584.Sy large_blocks 2585feature. 2586.It Fl e 2587Generate a more compact stream by using WRITE_EMBEDDED records for blocks 2588which are stored more compactly on disk by the 2589.Sy embedded_data 2590pool 2591feature. 2592This flag has no effect if the 2593.Sy embedded_data 2594feature is 2595disabled. 2596The receiving system must have the 2597.Sy embedded_data 2598feature 2599enabled. 2600If the 2601.Sy lz4_compress 2602feature is active on the sending system, 2603then the receiving system must have that feature enabled as well. 2604See 2605.Xr zpool-features 7 2606for details on ZFS feature flags and the 2607.Sy embedded_data 2608feature. 2609.It Fl p 2610Include the dataset's properties in the stream. This flag is implicit when 2611.Fl R 2612is specified. The receiving system must also support this feature. 2613.It Fl n 2614Do a dry-run ("No-op") send. Do not generate any actual send data. This is 2615useful in conjunction with the 2616.Fl v 2617or 2618.Fl P 2619flags to determine what data will be sent. 2620In this case, the verbose output will be written to 2621standard output (contrast with a non-dry-run, where the stream is written 2622to standard output and the verbose output goes to standard error). 2623.It Fl P 2624Print machine-parsable verbose information about the stream package generated. 2625.It Fl v 2626Print verbose information about the stream package generated. 2627This information includes a per-second report of how much data has been sent. 2628.El 2629.Pp 2630The format of the stream is committed. You will be able to receive your streams 2631on future versions of 2632.Tn ZFS . 2633.It Xo 2634.Nm 2635.Cm send 2636.Op Fl eL 2637.Op Fl i Ar snapshot Ns | Ns Ar bookmark 2638.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot 2639.Xc 2640.Pp 2641Generate a send stream, which may be of a filesystem, and may be 2642incremental from a bookmark. 2643If the destination is a filesystem or volume, 2644the pool must be read-only, or the filesystem must not be mounted. 2645When the 2646stream generated from a filesystem or volume is received, the default snapshot 2647name will be 2648.Pq --head-- . 2649.Bl -tag -width indent 2650.It Fl i Ar snapshot Ns | Ns bookmark 2651Generate an incremental send stream. 2652The incremental source must be an earlier 2653snapshot in the destination's history. 2654It will commonly be an earlier 2655snapshot in the destination's filesystem, in which case it can be 2656specified as the last component of the name 2657.Pq the Em # No or Em @ No character and following . 2658.Pp 2659If the incremental target is a clone, the incremental source can 2660be the origin snapshot, or an earlier snapshot in the origin's filesystem, 2661or the origin's origin, etc. 2662.It Fl L 2663Generate a stream which may contain blocks larger than 128KB. 2664This flag 2665has no effect if the 2666.Sy large_blocks 2667pool feature is disabled, or if the 2668.Sy recordsize 2669property of this filesystem has never been set above 128KB. 2670The receiving system must have the 2671.Sy large_blocks 2672pool feature enabled as well. 2673See 2674.Xr zpool-features 7 2675for details on ZFS feature flags and the 2676.Sy large_blocks 2677feature. 2678.It Fl e 2679Generate a more compact stream by using WRITE_EMBEDDED records for blocks 2680which are stored more compactly on disk by the 2681.Sy embedded_data 2682pool 2683feature. 2684This flag has no effect if the 2685.Sy embedded_data 2686feature is 2687disabled. 2688The receiving system must have the 2689.Sy embedded_data 2690feature 2691enabled. 2692If the 2693.Sy lz4_compress 2694feature is active on the sending system, 2695then the receiving system must have that feature enabled as well. 2696See 2697.Xr zpool-features 7 2698for details on ZFS feature flags and the 2699.Sy embedded_data 2700feature. 2701.El 2702.It Xo 2703.Nm 2704.Cm send 2705.Op Fl Penv 2706.Fl t 2707.Ar receive_resume_token 2708.Xc 2709Creates a send stream which resumes an interrupted receive. The 2710.Ar receive_resume_token 2711is the value of this property on the filesystem 2712or volume that was being received into. See the documentation for 2713.Sy zfs receive -s 2714for more details. 2715.It Xo 2716.Nm 2717.Cm receive Ns | Ns Cm recv 2718.Op Fl vnsFu 2719.Op Fl o Sy origin Ns = Ns Ar snapshot 2720.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot 2721.Xc 2722.It Xo 2723.Nm 2724.Cm receive Ns | Ns Cm recv 2725.Op Fl vnsFu 2726.Op Fl d | e 2727.Op Fl o Sy origin Ns = Ns Ar snapshot 2728.Ar filesystem 2729.Xc 2730.Pp 2731Creates a snapshot whose contents are as specified in the stream provided on 2732standard input. If a full stream is received, then a new file system is created 2733as well. Streams are created using the 2734.Qq Nm Cm send 2735subcommand, which by default creates a full stream. 2736.Qq Nm Cm recv 2737can be used as an alias for 2738.Qq Nm Cm receive . 2739.Pp 2740If an incremental stream is received, then the destination file system must 2741already exist, and its most recent snapshot must match the incremental stream's 2742source. For 2743.Sy zvol Ns s, 2744the destination device link is destroyed and recreated, which means the 2745.Sy zvol 2746cannot be accessed during the 2747.Sy receive 2748operation. 2749.Pp 2750When a snapshot replication package stream that is generated by using the 2751.Qq Nm Cm send Fl R 2752command is received, any snapshots that do not exist on the sending location 2753are destroyed by using the 2754.Qq Nm Cm destroy Fl d 2755command. 2756.Pp 2757The name of the snapshot (and file system, if a full stream is received) that 2758this subcommand creates depends on the argument type and the 2759.Fl d 2760or 2761.Fl e 2762option. 2763.Pp 2764If the argument is a snapshot name, the specified 2765.Ar snapshot 2766is created. If the argument is a file system or volume name, a snapshot with 2767the same name as the sent snapshot is created within the specified 2768.Ar filesystem 2769or 2770.Ar volume . 2771If the 2772.Fl d 2773or 2774.Fl e 2775option is specified, the snapshot name is determined by appending the sent 2776snapshot's name to the specified 2777.Ar filesystem . 2778If the 2779.Fl d 2780option is specified, all but the pool name of the sent snapshot path is 2781appended (for example, 2782.Sy b/c@1 2783appended from sent snapshot 2784.Sy a/b/c@1 ) , 2785and if the 2786.Fl e 2787option is specified, only the tail of the sent snapshot path is appended (for 2788example, 2789.Sy c@1 2790appended from sent snapshot 2791.Sy a/b/c@1 ) . 2792In the case of 2793.Fl d , 2794any file systems needed to replicate the path of the sent snapshot are created 2795within the specified file system. 2796.Bl -tag -width indent 2797.It Fl d 2798Use the full sent snapshot path without the first element (without pool name) 2799to determine the name of the new snapshot as described in the paragraph above. 2800.It Fl e 2801Use only the last element of the sent snapshot path to determine the name of 2802the new snapshot as described in the paragraph above. 2803.It Fl u 2804File system that is associated with the received stream is not mounted. 2805.It Fl v 2806Print verbose information about the stream and the time required to perform the 2807receive operation. 2808.It Fl n 2809Do not actually receive the stream. This can be useful in conjunction with the 2810.Fl v 2811option to verify the name the receive operation would use. 2812.It Fl o Sy origin Ns = Ns Ar snapshot 2813Forces the stream to be received as a clone of the given snapshot. 2814If the stream is a full send stream, this will create the filesystem 2815described by the stream as a clone of the specified snapshot. Which 2816snapshot was specified will not affect the success or failure of the 2817receive, as long as the snapshot does exist. If the stream is an 2818incremental send stream, all the normal verification will be performed. 2819.It Fl F 2820Force a rollback of the file system to the most recent snapshot before 2821performing the receive operation. If receiving an incremental replication 2822stream (for example, one generated by 2823.Qq Nm Cm send Fl R Bro Fl i | Fl I Brc ) , 2824destroy snapshots and file systems that do not exist on the sending side. 2825.It Fl s 2826If the receive is interrupted, save the partially received state, rather 2827than deleting it. Interruption may be due to premature termination of 2828the stream 2829.Po e.g. due to network failure or failure of the remote system 2830if the stream is being read over a network connection 2831.Pc , 2832a checksum error in the stream, termination of the 2833.Nm zfs Cm receive 2834process, or unclean shutdown of the system. 2835.Pp 2836The receive can be resumed with a stream generated by 2837.Nm zfs Cm send Fl t Ar token , 2838where the 2839.Ar token 2840is the value of the 2841.Sy receive_resume_token 2842property of the filesystem or volume which is received into. 2843.Pp 2844To use this flag, the storage pool must have the 2845.Sy extensible_dataset 2846feature enabled. See 2847.Xr zpool-features 5 2848for details on ZFS feature flags. 2849.El 2850.It Xo 2851.Nm 2852.Cm receive Ns | Ns Cm recv 2853.Fl A 2854.Ar filesystem Ns | Ns Ar volume 2855.Xc 2856Abort an interrupted 2857.Nm zfs Cm receive Fl s , 2858deleting its saved partially received state. 2859.It Xo 2860.Nm 2861.Cm allow 2862.Ar filesystem Ns | Ns Ar volume 2863.Xc 2864.Pp 2865Displays permissions that have been delegated on the specified filesystem or 2866volume. See the other forms of 2867.Qq Nm Cm allow 2868for more information. 2869.It Xo 2870.Nm 2871.Cm allow 2872.Op Fl ldug 2873.Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ... 2874.Ar perm Ns | Ns Ar @setname Ns 2875.Oo Ns , Ns Ar perm Ns | Ns Ar @setname Oc Ns ... 2876.Ar filesystem Ns | Ns Ar volume 2877.Xc 2878.It Xo 2879.Nm 2880.Cm allow 2881.Op Fl ld 2882.Fl e Ns | Ns Cm everyone 2883.Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns 2884.Ns ... 2885.Ar filesystem Ns | Ns Ar volume 2886.Xc 2887.Pp 2888Delegates 2889.Tn ZFS 2890administration permission for the file systems to non-privileged users. 2891.Bl -tag -width indent 2892.It Xo 2893.Op Fl ug 2894.Ar user Ns | Ns Ar group Ns Oo , Ar user Ns | Ns Ar group Oc Ns ... 2895.Xc 2896Specifies to whom the permissions are delegated. Multiple entities can be 2897specified as a comma-separated list. If neither of the 2898.Fl ug 2899options are specified, then the argument is interpreted preferentially as the 2900keyword 2901.Cm everyone , 2902then as a user name, and lastly as a group name. To specify 2903a user or group named 2904.Qq everyone , 2905use the 2906.Fl u 2907or 2908.Fl g 2909options. To specify a group with the same name as a user, use the 2910.Fl g 2911option. 2912.It Op Fl e Ns | Ns Cm everyone 2913Specifies that the permissions be delegated to 2914.Qq everyone . 2915.It Xo 2916.Ar perm Ns | Ns Ar @setname Ns Oo , Ns Ar perm Ns | Ns Ar @setname Oc Ns ... 2917.Xc 2918The permissions to delegate. Multiple permissions 2919may be specified as a comma-separated list. Permission names are the same as 2920.Tn ZFS 2921subcommand and property names. See the property list below. Property set names, 2922which begin with an at sign 2923.Pq Sy @ , 2924may be specified. See the 2925.Fl s 2926form below for details. 2927.It Xo 2928.Op Fl ld 2929.Ar filesystem Ns | Ns Ar volume 2930.Xc 2931Specifies where the permissions are delegated. If neither of the 2932.Fl ld 2933options are specified, or both are, then the permissions are allowed for the 2934file system or volume, and all of its descendents. If only the 2935.Fl l 2936option is used, then is allowed "locally" only for the specified file system. 2937If only the 2938.Fl d 2939option is used, then is allowed only for the descendent file systems. 2940.El 2941.Pp 2942Permissions are generally the ability to use a 2943.Tn ZFS 2944subcommand or change a 2945.Tn ZFS 2946property. The following permissions are available: 2947.Bl -column -offset 4n "secondarycache" "subcommand" 2948.It NAME Ta TYPE Ta NOTES 2949.It allow Ta subcommand Ta Must Xo 2950also have the permission that is being allowed 2951.Xc 2952.It clone Ta subcommand Ta Must Xo 2953also have the 'create' ability and 'mount' ability in the origin file system 2954.Xc 2955.It create Ta subcommand Ta Must also have the 'mount' ability 2956.It destroy Ta subcommand Ta Must also have the 'mount' ability 2957.It diff Ta subcommand Ta Allows lookup of paths within a dataset given an 2958object number, and the ability to create snapshots necessary to 'zfs diff' 2959.It hold Ta subcommand Ta Allows adding a user hold to a snapshot 2960.It mount Ta subcommand Ta Allows mount/umount of Tn ZFS No datasets 2961.It promote Ta subcommand Ta Must Xo 2962also have the 'mount' and 'promote' ability in the origin file system 2963.Xc 2964.It receive Ta subcommand Ta Must also have the 'mount' and 'create' ability 2965.It release Ta subcommand Ta Allows Xo 2966releasing a user hold which might destroy the snapshot 2967.Xc 2968.It rename Ta subcommand Ta Must Xo 2969also have the 'mount' and 'create' ability in the new parent 2970.Xc 2971.It rollback Ta subcommand Ta Must also have the 'mount' ability 2972.It send Ta subcommand 2973.It share Ta subcommand Ta Allows Xo 2974sharing file systems over the 2975.Tn NFS 2976protocol 2977.Xc 2978.It snapshot Ta subcommand Ta Must also have the 'mount' ability 2979.It groupquota Ta other Ta Allows accessing any groupquota@... property 2980.It groupused Ta other Ta Allows reading any groupused@... property 2981.It userprop Ta other Ta Allows changing any user property 2982.It userquota Ta other Ta Allows accessing any userquota@... property 2983.It userused Ta other Ta Allows reading any userused@... property 2984.It aclinherit Ta property 2985.It aclmode Ta property 2986.It atime Ta property 2987.It canmount Ta property 2988.It casesensitivity Ta property 2989.It checksum Ta property 2990.It compression Ta property 2991.It copies Ta property 2992.It dedup Ta property 2993.It devices Ta property 2994.It exec Ta property 2995.It filesystem_limit Ta property 2996.It logbias Ta property 2997.It mlslabel Ta property 2998.It mountpoint Ta property 2999.It nbmand Ta property 3000.It normalization Ta property 3001.It primarycache Ta property 3002.It quota Ta property 3003.It readonly Ta property 3004.It recordsize Ta property 3005.It refquota Ta property 3006.It refreservation Ta property 3007.It reservation Ta property 3008.It secondarycache Ta property 3009.It setuid Ta property 3010.It sharenfs Ta property 3011.It sharesmb Ta property 3012.It snapdir Ta property 3013.It snapshot_limit Ta property 3014.It sync Ta property 3015.It utf8only Ta property 3016.It version Ta property 3017.It volblocksize Ta property 3018.It volsize Ta property 3019.It vscan Ta property 3020.It xattr Ta property 3021.El 3022.It Xo 3023.Nm 3024.Cm allow 3025.Fl c 3026.Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns 3027.Ns ... 3028.Ar filesystem Ns | Ns Ar volume 3029.Xc 3030.Pp 3031Sets "create time" permissions. These permissions are granted (locally) to the 3032creator of any newly-created descendent file system. 3033.It Xo 3034.Nm 3035.Cm allow 3036.Fl s 3037.Ar @setname 3038.Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns 3039.Ns ... 3040.Ar filesystem Ns | Ns Ar volume 3041.Xc 3042.Pp 3043Defines or adds permissions to a permission set. The set can be used by other 3044.Qq Nm Cm allow 3045commands for the specified file system and its descendents. Sets are evaluated 3046dynamically, so changes to a set are immediately reflected. Permission sets 3047follow the same naming restrictions as ZFS file systems, but the name must 3048begin with an "at sign" 3049.Pq Sy @ , 3050and can be no more than 64 characters long. 3051.It Xo 3052.Nm 3053.Cm unallow 3054.Op Fl rldug 3055.Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ... 3056.Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns 3057.Ns ... Oc 3058.Ar filesystem Ns | Ns Ar volume 3059.Xc 3060.It Xo 3061.Nm 3062.Cm unallow 3063.Op Fl rld 3064.Fl e Ns | Ns Cm everyone 3065.Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns 3066.Ns ... Oc 3067.Ar filesystem Ns | Ns Ar volume 3068.Xc 3069.It Xo 3070.Nm 3071.Cm unallow 3072.Op Fl r 3073.Fl c 3074.Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns 3075.Ns ... Oc 3076.Ar filesystem Ns | Ns Ar volume 3077.Xc 3078.Pp 3079Removes permissions that were granted with the 3080.Qq Nm Cm allow 3081command. No permissions are explicitly denied, so other permissions granted are 3082still in effect. For example, if the permission is granted by an ancestor. If 3083no permissions are specified, then all permissions for the specified 3084.Ar user , group , No or everyone 3085are removed. Specifying 3086.Cm everyone 3087.Po or using the Fl e 3088option 3089.Pc only removes the permissions that were granted to everyone , 3090not all permissions for every user and group. See the 3091.Qq Nm Cm allow 3092command for a description of the 3093.Fl ldugec 3094options. 3095.Bl -tag -width indent 3096.It Fl r 3097Recursively remove the permissions from this file system and all descendents. 3098.El 3099.It Xo 3100.Nm 3101.Cm unallow 3102.Op Fl r 3103.Fl s 3104.Ar @setname 3105.Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns 3106.Ns ... Oc 3107.Ar filesystem Ns | Ns Ar volume 3108.Xc 3109.Pp 3110Removes permissions from a permission set. If no permissions are specified, 3111then all permissions are removed, thus removing the set entirely. 3112.It Xo 3113.Nm 3114.Cm hold 3115.Op Fl r 3116.Ar tag snapshot Ns ... 3117.Xc 3118.Pp 3119Adds a single reference, named with the 3120.Ar tag 3121argument, to the specified snapshot or snapshots. Each snapshot has its own tag 3122namespace, and tags must be unique within that space. 3123.Pp 3124If a hold exists on a snapshot, attempts to destroy that snapshot by using the 3125.Qq Nm Cm destroy 3126command returns 3127.Em EBUSY . 3128.Bl -tag -width indent 3129.It Fl r 3130Specifies that a hold with the given tag is applied recursively to the 3131snapshots of all descendent file systems. 3132.El 3133.It Xo 3134.Nm 3135.Cm holds 3136.Op Fl Hp 3137.Op Fl r Ns | Ns Fl d Ar depth 3138.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns 3139.Ns ... 3140.Xc 3141.Pp 3142Lists all existing user references for the given dataset or datasets. 3143.Bl -tag -width indent 3144.It Fl H 3145Used for scripting mode. Do not print headers and separate fields by a single 3146tab instead of arbitrary white space. 3147.It Fl p 3148Display numbers in parsable (exact) values. 3149.It Fl r 3150Lists the holds that are set on the descendent snapshots of the named datasets 3151or snapshots, in addition to listing the holds on the named snapshots, if any. 3152.It Fl d Ar depth 3153Recursively display any holds on the named snapshots, or descendent snapshots of 3154the named datasets or snapshots, limiting the recursion to 3155.Ar depth . 3156.El 3157.It Xo 3158.Nm 3159.Cm release 3160.Op Fl r 3161.Ar tag snapshot Ns ... 3162.Xc 3163.Pp 3164Removes a single reference, named with the 3165.Ar tag 3166argument, from the specified snapshot or snapshots. The tag must already exist 3167for each snapshot. 3168.Bl -tag -width indent 3169.It Fl r 3170Recursively releases a hold with the given tag on the snapshots of all 3171descendent file systems. 3172.El 3173.It Xo 3174.Nm 3175.Cm diff 3176.Op Fl FHt 3177.Ar snapshot 3178.Op Ar snapshot Ns | Ns Ar filesystem 3179.Xc 3180.Pp 3181Display the difference between a snapshot of a given filesystem and another 3182snapshot of that filesystem from a later time or the current contents of the 3183filesystem. The first column is a character indicating the type of change, 3184the other columns indicate pathname, new pathname 3185.Pq in case of rename , 3186change in link count, and optionally file type and/or change time. 3187.Pp 3188The types of change are: 3189.Bl -column -offset 2n indent 3190.It \&- Ta path was removed 3191.It \&+ Ta path was added 3192.It \&M Ta path was modified 3193.It \&R Ta path was renamed 3194.El 3195.Bl -tag -width indent 3196.It Fl F 3197Display an indication of the type of file, in a manner similar to the 3198.Fl F 3199option of 3200.Xr ls 1 . 3201.Bl -column -offset 2n indent 3202.It \&B Ta block device 3203.It \&C Ta character device 3204.It \&F Ta regular file 3205.It \&/ Ta directory 3206.It \&@ Ta symbolic link 3207.It \&= Ta socket 3208.It \&> Ta door (not supported on Nx ) 3209.It \&| Ta named pipe (not supported on Nx ) 3210.It \&P Ta event port (not supported on Nx ) 3211.El 3212.It Fl H 3213Give more parsable tab-separated output, without header lines and without 3214arrows. 3215.It Fl t 3216Display the path's inode change time as the first column of output. 3217.El 3218.Sh EXIT STATUS 3219The following exit values are returned: 3220.Bl -tag -offset 2n -width 2n 3221.It 0 3222Successful completion. 3223.It 1 3224An error occurred. 3225.It 2 3226Invalid command line options were specified. 3227.El 3228.Sh EXAMPLES 3229.Bl -tag -width 0n 3230.It Sy Example 1 No Creating a Tn ZFS No File System Hierarchy 3231.Pp 3232The following commands create a file system named 3233.Em pool/home 3234and a file system named 3235.Em pool/home/bob . 3236The mount point 3237.Pa /home 3238is set for the parent file system, and is automatically inherited by the child 3239file system. 3240.Bd -literal -offset 2n 3241.Li # Ic zfs create pool/home 3242.Li # Ic zfs set mountpoint=/home pool/home 3243.Li # Ic zfs create pool/home/bob 3244.Ed 3245.It Sy Example 2 No Creating a Tn ZFS No Snapshot 3246.Pp 3247The following command creates a snapshot named 3248.Sy yesterday . 3249This snapshot is mounted on demand in the 3250.Pa \&.zfs/snapshot 3251directory at the root of the 3252.Em pool/home/bob 3253file system. 3254.Bd -literal -offset 2n 3255.Li # Ic zfs snapshot pool/home/bob@yesterday 3256.Ed 3257.It Sy Example 3 No Creating and Destroying Multiple Snapshots 3258.Pp 3259The following command creates snapshots named 3260.Em yesterday 3261of 3262.Em pool/home 3263and all of its descendent file systems. Each snapshot is mounted on demand in 3264the 3265.Pa \&.zfs/snapshot 3266directory at the root of its file system. The second command destroys the newly 3267created snapshots. 3268.Bd -literal -offset 2n 3269.Li # Ic zfs snapshot -r pool/home@yesterday 3270.Li # Ic zfs destroy -r pool/home@yesterday 3271.Ed 3272.It Sy Example 4 No Disabling and Enabling File System Compression 3273.Pp 3274The following command disables the 3275.Sy compression 3276property for all file systems under 3277.Em pool/home . 3278The next command explicitly enables 3279.Sy compression 3280for 3281.Em pool/home/anne . 3282.Bd -literal -offset 2n 3283.Li # Ic zfs set compression=off pool/home 3284.Li # Ic zfs set compression=on pool/home/anne 3285.Ed 3286.It Sy Example 5 No Listing Tn ZFS No Datasets 3287.Pp 3288The following command lists all active file systems and volumes in the system. 3289Snapshots are displayed if the 3290.Sy listsnaps 3291property is 3292.Cm on . 3293The default is 3294.Cm off . 3295See 3296.Xr zpool 8 3297for more information on pool properties. 3298.Bd -literal -offset 2n 3299.Li # Ic zfs list 3300 NAME USED AVAIL REFER MOUNTPOINT 3301 pool 450K 457G 18K /pool 3302 pool/home 315K 457G 21K /home 3303 pool/home/anne 18K 457G 18K /home/anne 3304 pool/home/bob 276K 457G 276K /home/bob 3305.Ed 3306.It Sy Example 6 No Setting a Quota on a Tn ZFS No File System 3307.Pp 3308The following command sets a quota of 50 Gbytes for 3309.Em pool/home/bob . 3310.Bd -literal -offset 2n 3311.Li # Ic zfs set quota=50G pool/home/bob 3312.Ed 3313.It Sy Example 7 No Listing Tn ZFS No Properties 3314.Pp 3315The following command lists all properties for 3316.Em pool/home/bob . 3317.Bd -literal -offset 2n 3318.Li # Ic zfs get all pool/home/bob 3319NAME PROPERTY VALUE SOURCE 3320pool/home/bob type filesystem - 3321pool/home/bob creation Tue Jul 21 15:53 2009 - 3322pool/home/bob used 21K - 3323pool/home/bob available 20.0G - 3324pool/home/bob referenced 21K - 3325pool/home/bob compressratio 1.00x - 3326pool/home/bob mounted yes - 3327pool/home/bob quota 20G local 3328pool/home/bob reservation none default 3329pool/home/bob recordsize 128K default 3330pool/home/bob mountpoint /home/bob default 3331pool/home/bob sharenfs off default 3332pool/home/bob checksum on default 3333pool/home/bob compression on local 3334pool/home/bob atime on default 3335pool/home/bob devices on default 3336pool/home/bob exec on default 3337pool/home/bob filesystem_limit none default 3338pool/home/bob setuid on default 3339pool/home/bob readonly off default 3340pool/home/bob snapdir hidden default 3341pool/home/bob snapshot_limit none default 3342pool/home/bob aclmode discard default 3343pool/home/bob aclinherit restricted default 3344pool/home/bob canmount on default 3345pool/home/bob xattr on default 3346pool/home/bob copies 1 default 3347pool/home/bob version 5 - 3348pool/home/bob utf8only off - 3349pool/home/bob normalization none - 3350pool/home/bob casesensitivity sensitive - 3351pool/home/bob vscan off default 3352pool/home/bob nbmand off default 3353pool/home/bob sharesmb off default 3354pool/home/bob refquota none default 3355pool/home/bob refreservation none default 3356pool/home/bob primarycache all default 3357pool/home/bob secondarycache all default 3358pool/home/bob usedbysnapshots 0 - 3359pool/home/bob usedbydataset 21K - 3360pool/home/bob usedbychildren 0 - 3361pool/home/bob usedbyrefreservation 0 - 3362pool/home/bob logbias latency default 3363pool/home/bob dedup off default 3364pool/home/bob mlslabel - 3365pool/home/bob sync standard default 3366pool/home/bob refcompressratio 1.00x - 3367.Ed 3368.Pp 3369The following command gets a single property value. 3370.Bd -literal -offset 2n 3371.Li # Ic zfs get -H -o value compression pool/home/bob 3372on 3373.Ed 3374.Pp 3375The following command lists all properties with local settings for 3376.Em pool/home/bob . 3377.Bd -literal -offset 2n 3378.Li # Ic zfs get -s local -o name,property,value all pool/home/bob 3379NAME PROPERTY VALUE 3380pool/home/bob quota 20G 3381pool/home/bob compression on 3382.Ed 3383.It Sy Example 8 No Rolling Back a Tn ZFS No File System 3384.Pp 3385The following command reverts the contents of 3386.Em pool/home/anne 3387to the snapshot named 3388.Em yesterday , 3389deleting all intermediate snapshots. 3390.Bd -literal -offset 2n 3391.Li # Ic zfs rollback -r pool/home/anne@yesterday 3392.Ed 3393.It Sy Example 9 No Creating a Tn ZFS No Clone 3394.Pp 3395The following command creates a writable file system whose initial contents are 3396the same as 3397.Em pool/home/bob@yesterday . 3398.Bd -literal -offset 2n 3399.Li # Ic zfs clone pool/home/bob@yesterday pool/clone 3400.Ed 3401.It Sy Example 10 No Promoting a Tn ZFS No Clone 3402.Pp 3403The following commands illustrate how to test out changes to a file system, and 3404then replace the original file system with the changed one, using clones, clone 3405promotion, and renaming: 3406.Bd -literal -offset 2n 3407.Li # Ic zfs create pool/project/production 3408.Ed 3409.Pp 3410Populate 3411.Pa /pool/project/production 3412with data and continue with the following commands: 3413.Bd -literal -offset 2n 3414.Li # Ic zfs snapshot pool/project/production@today 3415.Li # Ic zfs clone pool/project/production@today pool/project/beta 3416.Ed 3417.Pp 3418Now make changes to 3419.Pa /pool/project/beta 3420and continue with the following commands: 3421.Bd -literal -offset 2n 3422.Li # Ic zfs promote pool/project/beta 3423.Li # Ic zfs rename pool/project/production pool/project/legacy 3424.Li # Ic zfs rename pool/project/beta pool/project/production 3425.Ed 3426.Pp 3427Once the legacy version is no longer needed, it can be destroyed. 3428.Bd -literal -offset 2n 3429.Li # Ic zfs destroy pool/project/legacy 3430.Ed 3431.It Sy Example 11 No Inheriting Tn ZFS No Properties 3432.Pp 3433The following command causes 3434.Em pool/home/bob 3435and 3436.Em pool/home/anne 3437to inherit the 3438.Sy checksum 3439property from their parent. 3440.Bd -literal -offset 2n 3441.Li # Ic zfs inherit checksum pool/home/bob pool/home/anne 3442.Ed 3443.It Sy Example 12 No Remotely Replicating Tn ZFS No Data 3444.Pp 3445The following commands send a full stream and then an incremental stream to a 3446remote machine, restoring them into 3447.Sy poolB/received/fs@a 3448and 3449.Sy poolB/received/fs@b , 3450respectively. 3451.Sy poolB 3452must contain the file system 3453.Sy poolB/received , 3454and must not initially contain 3455.Sy poolB/received/fs . 3456.Bd -literal -offset 2n 3457.Li # Ic zfs send pool/fs@a | ssh host zfs receive poolB/received/fs@a 3458.Li # Ic zfs send -i a pool/fs@b | ssh host zfs receive poolB/received/fs 3459.Ed 3460.It Xo 3461.Sy Example 13 3462Using the 3463.Qq zfs receive -d 3464Option 3465.Xc 3466.Pp 3467The following command sends a full stream of 3468.Sy poolA/fsA/fsB@snap 3469to a remote machine, receiving it into 3470.Sy poolB/received/fsA/fsB@snap . 3471The 3472.Sy fsA/fsB@snap 3473portion of the received snapshot's name is determined from the name of the sent 3474snapshot. 3475.Sy poolB 3476must contain the file system 3477.Sy poolB/received . 3478If 3479.Sy poolB/received/fsA 3480does not exist, it is created as an empty file system. 3481.Bd -literal -offset 2n 3482.Li # Ic zfs send poolA/fsA/fsB@snap | ssh host zfs receive -d poolB/received 3483.Ed 3484.It Sy Example 14 No Setting User Properties 3485.Pp 3486The following example sets the user-defined 3487.Sy com.example:department 3488property for a dataset. 3489.Bd -literal -offset 2n 3490.Li # Ic zfs set com.example:department=12345 tank/accounting 3491.Ed 3492.It Sy Example 15 No Performing a Rolling Snapshot 3493.Pp 3494The following example shows how to maintain a history of snapshots with a 3495consistent naming scheme. To keep a week's worth of snapshots, the user 3496destroys the oldest snapshot, renames the remaining snapshots, and then creates 3497a new snapshot, as follows: 3498.Bd -literal -offset 2n 3499.Li # Ic zfs destroy -r pool/users@7daysago 3500.Li # Ic zfs rename -r pool/users@6daysago @7daysago 3501.Li # Ic zfs rename -r pool/users@5daysago @6daysago 3502.Li # Ic zfs rename -r pool/users@4daysago @5daysago 3503.Li # Ic zfs rename -r pool/users@3daysago @4daysago 3504.Li # Ic zfs rename -r pool/users@2daysago @3daysago 3505.Li # Ic zfs rename -r pool/users@yesterday @2daysago 3506.Li # Ic zfs rename -r pool/users@today @yesterday 3507.Li # Ic zfs snapshot -r pool/users@today 3508.Ed 3509.It Xo 3510.Sy Example 16 3511Setting 3512.Qq sharenfs 3513Property Options on a ZFS File System 3514.Xc 3515.Pp 3516The following command shows how to set 3517.Sy sharenfs 3518property options to enable root access for a specific network on the 3519.Em tank/home 3520file system. The contents of the 3521.Sy sharenfs 3522property are valid 3523.Xr exports 5 3524options. 3525.Bd -literal -offset 2n 3526.Li # Ic zfs set sharenfs="maproot=root,network 192.168.0.0/24" tank/home 3527.Ed 3528.Pp 3529Another way to write this command with the same result is: 3530.Bd -literal -offset 2n 3531.Li # Ic set zfs sharenfs="-maproot=root -network 192.168.0.0/24" tank/home 3532.Ed 3533.It Xo 3534.Sy Example 17 3535Delegating 3536.Tn ZFS 3537Administration Permissions on a 3538.Tn ZFS 3539Dataset 3540.Xc 3541.Pp 3542The following example shows how to set permissions so that user 3543.Em cindys 3544can create, destroy, mount, and take snapshots on 3545.Em tank/cindys . 3546The permissions on 3547.Em tank/cindys 3548are also displayed. 3549.Bd -literal -offset 2n 3550.Li # Ic zfs allow cindys create,destroy,mount,snapshot tank/cindys 3551.Li # Ic zfs allow tank/cindys 3552---- Permissions on tank/cindys -------------------------------------- 3553Local+Descendent permissions: 3554 user cindys create,destroy,mount,snapshot 3555.Ed 3556.It Sy Example 18 No Delegating Create Time Permissions on a Tn ZFS No Dataset 3557.Pp 3558The following example shows how to grant anyone in the group 3559.Em staff 3560to create file systems in 3561.Em tank/users . 3562This syntax also allows staff members to destroy their own file systems, but 3563not destroy anyone else's file system. The permissions on 3564.Em tank/users 3565are also displayed. 3566.Bd -literal -offset 2n 3567.Li # Ic zfs allow staff create,mount tank/users 3568.Li # Ic zfs allow -c destroy tank/users 3569.Li # Ic zfs allow tank/users 3570---- Permissions on tank/users --------------------------------------- 3571Permission sets: 3572 destroy 3573Local+Descendent permissions: 3574 group staff create,mount 3575.Ed 3576.It Xo 3577.Sy Example 19 3578Defining and Granting a Permission Set on a 3579.Tn ZFS 3580Dataset 3581.Xc 3582.Pp 3583The following example shows how to define and grant a permission set on the 3584.Em tank/users 3585file system. The permissions on 3586.Em tank/users 3587are also displayed. 3588.Bd -literal -offset 2n 3589.Li # Ic zfs allow -s @pset create,destroy,snapshot,mount tank/users 3590.Li # Ic zfs allow staff @pset tank/users 3591.Li # Ic zfs allow tank/users 3592---- Permissions on tank/users --------------------------------------- 3593Permission sets: 3594 @pset create,destroy,mount,snapshot 3595Local+Descendent permissions: 3596 group staff @pset 3597.Ed 3598.It Sy Example 20 No Delegating Property Permissions on a Tn ZFS No Dataset 3599.Pp 3600The following example shows to grant the ability to set quotas and reservations 3601on the 3602.Sy users/home 3603file system. The permissions on 3604.Sy users/home 3605are also displayed. 3606.Bd -literal -offset 2n 3607.Li # Ic zfs allow cindys quota,reservation users/home 3608.Li # Ic zfs allow users/home 3609---- Permissions on users/home --------------------------------------- 3610Local+Descendent permissions: 3611 user cindys quota,reservation 3612.Li # Ic su - cindys 3613.Li cindys% Ic zfs set quota=10G users/home/marks 3614.Li cindys% Ic zfs get quota users/home/marks 3615NAME PROPERTY VALUE SOURCE 3616users/home/marks quota 10G local 3617.Ed 3618.It Sy Example 21 No Removing ZFS Delegated Permissions on a Tn ZFS No Dataset 3619.Pp 3620The following example shows how to remove the snapshot permission from the 3621.Em staff 3622group on the 3623.Em tank/users 3624file system. The permissions on 3625.Em tank/users 3626are also displayed. 3627.Bd -literal -offset 2n 3628.Li # Ic zfs unallow staff snapshot tank/users 3629.Li # Ic zfs allow tank/users 3630---- Permissions on tank/users --------------------------------------- 3631Permission sets: 3632 @pset create,destroy,mount,snapshot 3633Local+Descendent permissions: 3634 group staff @pset 3635.Ed 3636.It Sy Example 22 Showing the differences between a snapshot and a ZFS Dataset 3637.Pp 3638The following example shows how to see what has changed between a prior 3639snapshot of a ZFS Dataset and its current state. The 3640.Fl F 3641option is used to indicate type information for the files affected. 3642.Bd -literal -offset 2n 3643.Li # Ic zfs diff tank/test@before tank/test 3644M / /tank/test/ 3645M F /tank/test/linked (+1) 3646R F /tank/test/oldname -> /tank/test/newname 3647- F /tank/test/deleted 3648+ F /tank/test/created 3649M F /tank/test/modified 3650.Ed 3651.El 3652.Sh SEE ALSO 3653.Xr chmod 2 , 3654.Xr fsync 2 , 3655.Xr exports 5 , 3656.Xr fstab 5 , 3657.Xr rc.conf 5 , 3658.Xr mount 8 , 3659.Xr umount 8 , 3660.Xr zpool 8 3661.Sh AUTHORS 3662This manual page is a 3663.Xr mdoc 7 3664reimplementation of the 3665.Tn OpenSolaris 3666manual page 3667.Em zfs(1M) , 3668modified and customized for 3669.Fx 3670and licensed under the 3671Common Development and Distribution License 3672.Pq Tn CDDL . 3673.Pp 3674The 3675.Xr mdoc 7 3676implementation of this manual page was initially written by 3677.An Martin Matuska Aq mm@FreeBSD.org . 3678