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