3 NAME
   4      zfs - configures ZFS file systems
   5 
   6 SYNOPSIS
   7      zfs [-?]
   8      zfs create [-p] [-o property=value]... filesystem
   9      zfs create [-ps] [-b blocksize] [-o property=value]... -V size volume
  10      zfs destroy [-Rfnprv] filesystem|volume
  11      zfs destroy [-Rdnprv] filesystem|volume@snap[%snap[,snap[%snap]]]...
  12      zfs destroy filesystem|volume#bookmark
  13      zfs snapshot [-r] [-o property=value]...
  14          filesystem@snapname|volume@snapname...
  15      zfs rollback [-Rfr] snapshot
  16      zfs clone [-p] [-o property=value]... snapshot filesystem|volume
  17      zfs promote clone-filesystem
  18      zfs rename [-f] filesystem|volume|snapshot filesystem|volume|snapshot
  19      zfs rename [-fp] filesystem|volume filesystem|volume
  20      zfs rename -r snapshot snapshot
  21      zfs list [-r|-d depth] [-Hp] [-o property[,property]...] [-s property]...
  22          [-S property]... [-t type[,type]...] [filesystem|volume|snapshot]...
  23      zfs remap filesystem|volume
  24      zfs set property=value [property=value]... filesystem|volume|snapshot...
  25      zfs get [-r|-d depth] [-Hp] [-o field[,field]...] [-s source[,source]...]
  26          [-t type[,type]...] all | property[,property]...
  27          filesystem|volume|snapshot|bookmark...
  28      zfs inherit [-rS] property filesystem|volume|snapshot...
  29      zfs upgrade
  30      zfs upgrade -v
  31      zfs upgrade [-r] [-V version] -a | filesystem
  32      zfs userspace [-Hinp] [-o field[,field]...] [-s field]... [-S field]...
  33          [-t type[,type]...] filesystem|snapshot
  34      zfs groupspace [-Hinp] [-o field[,field]...] [-s field]... [-S field]...
  35          [-t type[,type]...] filesystem|snapshot
  36      zfs mount
  37      zfs mount [-Ov] [-o options] -a | filesystem
  38      zfs unmount [-f] -a | filesystem|mountpoint
  39      zfs share -a | filesystem
  40      zfs unshare -a | filesystem|mountpoint
  41      zfs bookmark snapshot bookmark
  42      zfs send [-DLPRcenpv] [[-I|-i] snapshot] snapshot
  43      zfs send [-Lce] [-i snapshot|bookmark] filesystem|volume|snapshot
  44      zfs send [-Penv] -t receive_resume_token
  45      zfs receive [-Fnsuv] [-o origin=snapshot] filesystem|volume|snapshot
  46      zfs receive [-Fnsuv] [-d|-e] [-o origin=snapshot] filesystem


  47      zfs receive -A filesystem|volume
  48      zfs allow filesystem|volume
  49      zfs allow [-dglu] user|group[,user|group]...
  50          perm|@setname[,perm|@setname]... filesystem|volume
  51      zfs allow [-dl] -e|everyone perm|@setname[,perm|@setname]...
  52          filesystem|volume
  53      zfs allow -c perm|@setname[,perm|@setname]... filesystem|volume
  54      zfs allow -s @setname perm|@setname[,perm|@setname]... filesystem|volume
  55      zfs unallow [-dglru] user|group[,user|group]...
  56          [perm|@setname[,perm|@setname]...] filesystem|volume
  57      zfs unallow [-dlr] -e|everyone [perm|@setname[,perm|@setname]...]
  58          filesystem|volume
  59      zfs unallow [-r] -c [perm|@setname[,perm|@setname]...] filesystem|volume
  60      zfs unallow [-r] -s -@setname [perm|@setname[,perm|@setname]...]
  61          filesystem|volume
  62      zfs hold [-r] tag snapshot...
  63      zfs holds [-r] snapshot...
  64      zfs release [-r] tag snapshot...
  65      zfs diff [-FHt] snapshot snapshot|filesystem
  66      zfs program [-n] [-t timeout] [-m memory_limit] pool script [arg1 ...]

 265                            by this dataset.  See the referenced property.  The
 266                            logical space ignores the effect of the compression
 267                            and copies properties, giving a quantity closer to
 268                            the amount of data that applications see.  However,
 269                            it does include space consumed by metadata.
 270 
 271                            This property can also be referred to by its
 272                            shortened column name, lrefer.
 273 
 274      logicalused           The amount of space that is "logically" consumed by
 275                            this dataset and all its descendents.  See the used
 276                            property.  The logical space ignores the effect of
 277                            the compression and copies properties, giving a
 278                            quantity closer to the amount of data that
 279                            applications see.  However, it does include space
 280                            consumed by metadata.
 281 
 282                            This property can also be referred to by its
 283                            shortened column name, lused.
 284 




 285      mounted               For file systems, indicates whether the file system
 286                            is currently mounted.  This property can be either
 287                            yes or no.
 288 
 289      origin                For cloned file systems or volumes, the snapshot
 290                            from which the clone was created.  See also the
 291                            clones property.
 292 
 293      receive_resume_token  For filesystems or volumes which have saved
 294                            partially-completed state from zfs receive -s, this
 295                            opaque token can be provided to zfs send -t to
 296                            resume and complete the zfs receive.
 297 
 298      referenced            The amount of data that is accessible by this
 299                            dataset, which may or may not be shared with other
 300                            datasets in the pool.  When a snapshot or clone is
 301                            created, it initially references the same amount of
 302                            space as the file system or snapshot it was created
 303                            from, since its contents are identical.
 304 

 556        lzjb algorithm.  It features significantly faster compression and
 557        decompression, as well as a moderately higher compression ratio than
 558        lzjb, but can only be used on pools with the lz4_compress feature set
 559        to enabled.  See zpool-features(5) for details on ZFS feature flags and
 560        the lz4_compress feature.
 561 
 562        The lzjb compression algorithm is optimized for performance while
 563        providing decent data compression.
 564 
 565        The gzip compression algorithm uses the same compression as the gzip(1)
 566        command.  You can specify the gzip level by using the value gzip-N,
 567        where N is an integer from 1 (fastest) to 9 (best compression ratio).
 568        Currently, gzip is equivalent to gzip-6 (which is also the default for
 569        gzip(1)).
 570 
 571        The zle compression algorithm compresses runs of zeros.
 572 
 573        This property can also be referred to by its shortened column name
 574        compress.  Changing this property affects only newly-written data.
 575 






















 576      copies=1|2|3
 577        Controls the number of copies of data stored for this dataset.  These
 578        copies are in addition to any redundancy provided by the pool, for
 579        example, mirroring or RAID-Z.  The copies are stored on different
 580        disks, if possible.  The space used by multiple copies is charged to
 581        the associated file and dataset, changing the used property and
 582        counting against quotas and reservations.
 583 
 584        Changing this property only affects newly-written data.  Therefore, set
 585        this property at file system creation time by using the -o copies=N
 586        option.
 587 
 588      devices=on|off
 589        Controls whether device nodes can be opened on this file system.  The
 590        default value is on.
 591 
 592      exec=on|off
 593        Controls whether processes can be executed from within this file
 594        system.  The default value is on.
 595 

 768 
 769        This property can also be referred to by its shortened column name,
 770        reserv.
 771 
 772      secondarycache=all|none|metadata
 773        Controls what is cached in the secondary cache (L2ARC).  If this
 774        property is set to all, then both user data and metadata is cached.  If
 775        this property is set to none, then neither user data nor metadata is
 776        cached.  If this property is set to metadata, then only metadata is
 777        cached.  The default value is all.
 778 
 779      setuid=on|off
 780        Controls whether the setuid bit is respected for the file system.  The
 781        default value is on.
 782 
 783      sharesmb=on|off|opts
 784        Controls whether the file system is shared via SMB, and what options
 785        are to be used.  A file system with the sharesmb property set to off is
 786        managed through traditional tools such as sharemgr(1M).  Otherwise, the
 787        file system is automatically shared and unshared with the zfs share and
 788        zfs unshare commands.  If the property is set to on, the sharemgr(1M)
 789        command is invoked with no options.  Otherwise, the sharemgr(1M)
 790        command is invoked with options equivalent to the contents of this
 791        property.
 792 
 793        Because SMB shares requires a resource name, a unique resource name is
 794        constructed from the dataset name.  The constructed name is a copy of
 795        the dataset name except that the characters in the dataset name, which
 796        would be invalid in the resource name, are replaced with underscore (_)
 797        characters.  A pseudo property "name" is also supported that allows you
 798        to replace the data set name with a specified name.  The specified name
 799        is then used to replace the prefix dataset in the case of inheritance.
 800        For example, if the dataset data/home/john is set to name=john, then
 801        data/home/john has a resource name of john.  If a child dataset
 802        data/home/john/backups is shared, it has a resource name of
 803        john_backups.
 804 
 805        When SMB shares are created, the SMB share name appears as an entry in
 806        the .zfs/shares directory.  You can use the ls or chmod command to
 807        display the share-level ACLs on the entries in this directory.
 808 
 809        When the sharesmb property is changed for a dataset, the dataset and
 810        any children inheriting the property are re-shared with the new
 811        options, only if the property was previously set to off, or if they
 812        were shared before the property was changed.  If the new property is
 813        set to off, the file systems are unshared.
 814 
 815      sharenfs=on|off|opts
 816        Controls whether the file system is shared via NFS, and what options
 817        are to be used.  A file system with a sharenfs property of off is
 818        managed through traditional tools such as share(1M), unshare(1M), and
 819        dfstab(4).  Otherwise, the file system is automatically shared and
 820        unshared with the zfs share and zfs unshare commands.  If the property
 821        is set to on, share(1M) command is invoked with no options.  Otherwise,
 822        the share(1M) command is invoked with options equivalent to the
 823        contents of this property.
 824 
 825        When the sharenfs property is changed for a dataset, the dataset and
 826        any children inheriting the property are re-shared with the new
 827        options, only if the property was previously off, or if they were
 828        shared before the property was changed.  If the new property is off,
 829        the file systems are unshared.
 830 
 831      logbias=latency|throughput
 832        Provide a hint to ZFS about handling of synchronous requests in this
 833        dataset.  If logbias is set to latency (the default), ZFS will use pool
 834        log devices (if configured) to handle the requests at low latency.  If
 835        logbias is set to throughput, ZFS will not use configured pool log
 836        devices.  ZFS will instead optimize synchronous operations for global
 837        pool throughput and efficient use of resources.
 838 
 839      snapdir=hidden|visible
 840        Controls whether the .zfs directory is hidden or visible in the root of
 841        the file system as discussed in the Snapshots section.  The default
 842        value is hidden.
 843 

 873        could run out of space, resulting in undefined behavior or data
 874        corruption, depending on how the volume is used.  These effects can
 875        also occur when the volume size is changed while it is in use
 876        (particularly when shrinking the size).  Extreme care should be used
 877        when adjusting the volume size.
 878 
 879        Though not recommended, a "sparse volume" (also known as "thin
 880        provisioning") can be created by specifying the -s option to the zfs
 881        create -V command, or by changing the reservation after the volume has
 882        been created.  A "sparse volume" is a volume where the reservation is
 883        less then the volume size.  Consequently, writes to a sparse volume can
 884        fail with ENOSPC when the pool is low on space.  For a sparse volume,
 885        changes to volsize are not reflected in the reservation.
 886 
 887      vscan=on|off
 888        Controls whether regular files should be scanned for viruses when a
 889        file is opened and closed.  In addition to enabling this property, the
 890        virus scan service must also be enabled for virus scanning to occur.
 891        The default value is off.
 892 









 893      xattr=on|off
 894        Controls whether extended attributes are enabled for this file system.
 895        The default value is on.
 896 
 897      zoned=on|off
 898        Controls whether the dataset is managed from a non-global zone.  See
 899        the Zones section for more information.  The default value is off.
 900 
 901      The following three properties cannot be changed after the file system is
 902      created, and therefore, should be set when the file system is created.
 903      If the properties are not set with the zfs create or zpool create
 904      commands, these properties are inherited from the parent dataset.  If the
 905      parent dataset lacks these properties due to having been created prior to
 906      these features being supported, the new file system will have the default
 907      values for these properties.
 908 
 909      casesensitivity=sensitive|insensitive|mixed
 910        Indicates whether the file name matching algorithm used by the file
 911        system should be case-sensitive, case-insensitive, or allow a
 912        combination of both styles of matching.  The default value for the

1338            coming from a source other than those in this list are ignored.
1339            Each source must be one of the following: local, default,
1340            inherited, temporary, and none.  The default value is all sources.
1341 
1342        -t type
1343            A comma-separated list of types to display, where type is one of
1344            filesystem, snapshot, volume, bookmark, or all.
1345 
1346      zfs inherit [-rS] property filesystem|volume|snapshot...
1347        Clears the specified property, causing it to be inherited from an
1348        ancestor, restored to default if no ancestor has the property set, or
1349        with the -S option reverted to the received value if one exists.  See
1350        the Properties section for a listing of default values, and details on
1351        which properties can be inherited.
1352 
1353        -r  Recursively inherit the given property for all children.
1354 
1355        -S  Revert the property to the received value if one exists; otherwise
1356            operate as if the -S option was not specified.
1357 
1358      zfs remap filesystem|volume
1359        Remap the indirect blocks in the given fileystem or volume so that they
1360        no longer reference blocks on previously removed vdevs and we can
1361        eventually shrink the size of the indirect mapping objects for the
1362        previously removed vdevs. Note that remapping all blocks might not be
1363        possible and that references from snapshots will still exist and cannot
1364        be remapped.
1365 
1366      zfs upgrade
1367        Displays a list of file systems that are not the most recent version.
1368 
1369      zfs upgrade -v
1370        Displays a list of currently supported file system versions.
1371 
1372      zfs upgrade [-r] [-V version] -a | filesystem
1373        Upgrades file systems to a new on-disk version.  Once this is done, the
1374        file systems will no longer be accessible on systems running older
1375        versions of the software.  zfs send streams generated from new
1376        snapshots of these file systems cannot be accessed on systems running
1377        older versions of the software.
1378 
1379        In general, the file system version is independent of the pool version.
1380        See zpool(1M) for information on the zpool upgrade command.
1381 
1382        In some cases, the file system version and the pool version are
1383        interrelated and the pool version must be upgraded before the file
1384        system version can be upgraded.
1385 

1487            sharesmb property is set.
1488 
1489      zfs unshare -a | filesystem|mountpoint
1490        Unshares currently shared ZFS file systems.
1491 
1492        -a  Unshare all available ZFS file systems.  Invoked automatically as
1493            part of the shutdown process.
1494 
1495        filesystem|mountpoint
1496            Unshare the specified filesystem.  The command can also be given a
1497            path to a ZFS file system shared on the system.
1498 
1499      zfs bookmark snapshot bookmark
1500        Creates a bookmark of the given snapshot.  Bookmarks mark the point in
1501        time when the snapshot was created, and can be used as the incremental
1502        source for a zfs send command.
1503 
1504        This feature must be enabled to be used.  See zpool-features(5) for
1505        details on ZFS feature flags and the bookmarks feature.
1506 
1507      zfs send [-DLPRcenpv] [[-I|-i] snapshot] snapshot
1508        Creates a stream representation of the second snapshot, which is
1509        written to standard output.  The output can be redirected to a file or
1510        to a different system (for example, using ssh(1)).  By default, a full
1511        stream is generated.
1512 
1513        -D, --dedup
1514            Generate a deduplicated stream.  Blocks which would have been sent
1515            multiple times in the send stream will only be sent once.  The
1516            receiving system must also support this feature to receive a
1517            deduplicated stream.  This flag can be used regardless of the
1518            dataset's dedup property, but performance will be much better if
1519            the filesystem uses a dedup-capable checksum (for example, sha256).
1520 
1521        -I snapshot
1522            Generate a stream package that sends all intermediary snapshots
1523            from the first snapshot to the second snapshot.  For example, -I @a
1524            fs@d is similar to -i @a fs@b; -i @b fs@c; -i @c fs@d.  The
1525            incremental source may be specified as with the -i option.
1526 
1527        -L, --large-block

1530            if the recordsize property of this filesystem has never been set
1531            above 128KB.  The receiving system must have the large_blocks pool
1532            feature enabled as well.  See zpool-features(5) for details on ZFS
1533            feature flags and the large_blocks feature.
1534 
1535        -P, --parsable
1536            Print machine-parsable verbose information about the stream package
1537            generated.
1538 
1539        -R, --replicate
1540            Generate a replication stream package, which will replicate the
1541            specified file system, and all descendent file systems, up to the
1542            named snapshot.  When received, all properties, snapshots,
1543            descendent file systems, and clones are preserved.
1544 
1545            If the -i or -I flags are used in conjunction with the -R flag, an
1546            incremental replication stream is generated.  The current values of
1547            properties, and current snapshot and file system names are set when
1548            the stream is received.  If the -F flag is specified when this
1549            stream is received, snapshots and file systems that do not exist on
1550            the sending side are destroyed.



1551 
1552        -e, --embed
1553            Generate a more compact stream by using WRITE_EMBEDDED records for
1554            blocks which are stored more compactly on disk by the embedded_data
1555            pool feature.  This flag has no effect if the embedded_data feature
1556            is disabled.  The receiving system must have the embedded_data
1557            feature enabled.  If the lz4_compress feature is active on the
1558            sending system, then the receiving system must have that feature
1559            enabled as well.  See zpool-features(5) for details on ZFS feature
1560            flags and the embedded_data feature.
1561 
1562        -c, --compressed
1563            Generate a more compact stream by using compressed WRITE records
1564            for blocks which are compressed on disk and in memory (see the
1565            compression property for details).  If the lz4_compress feature is
1566            active on the sending system, then the receiving system must have
1567            that feature enabled as well.  If the large_blocks feature is
1568            enabled on the sending system but the -L option is not supplied in
1569            conjunction with -c, then the data will be decompressed before
1570            sending so it can be split into smaller block sizes.

1577            it is assumed to be from the same file system as the incremental
1578            target.
1579 
1580            If the destination is a clone, the source may be the origin
1581            snapshot, which must be fully specified (for example,
1582            pool/fs@origin, not just @origin).
1583 
1584        -n, --dryrun
1585            Do a dry-run ("No-op") send.  Do not generate any actual send data.
1586            This is useful in conjunction with the -v or -P flags to determine
1587            what data will be sent.  In this case, the verbose output will be
1588            written to standard output (contrast with a non-dry-run, where the
1589            stream is written to standard output and the verbose output goes to
1590            standard error).
1591 
1592        -p, --props
1593            Include the dataset's properties in the stream.  This flag is
1594            implicit when -R is specified.  The receiving system must also
1595            support this feature.
1596 






1597        -v, --verbose
1598            Print verbose information about the stream package generated.  This
1599            information includes a per-second report of how much data has been
1600            sent.
1601 
1602            The format of the stream is committed.  You will be able to receive
1603            your streams on future versions of ZFS .
1604 
1605      zfs send [-Lce] [-i snapshot|bookmark] filesystem|volume|snapshot
1606        Generate a send stream, which may be of a filesystem, and may be
1607        incremental from a bookmark.  If the destination is a filesystem or
1608        volume, the pool must be read-only, or the filesystem must not be
1609        mounted.  When the stream generated from a filesystem or volume is
1610        received, the default snapshot name will be "--head--".
1611 
1612        -L, --large-block
1613            Generate a stream which may contain blocks larger than 128KB.  This
1614            flag has no effect if the large_blocks pool feature is disabled, or
1615            if the recordsize property of this filesystem has never been set
1616            above 128KB.  The receiving system must have the large_blocks pool

1637            enabled as well.  See zpool-features(5) for details on ZFS feature
1638            flags and the embedded_data feature.
1639 
1640        -i snapshot|bookmark
1641            Generate an incremental send stream.  The incremental source must
1642            be an earlier snapshot in the destination's history.  It will
1643            commonly be an earlier snapshot in the destination's file system,
1644            in which case it can be specified as the last component of the name
1645            (the # or @ character and following).
1646 
1647            If the incremental target is a clone, the incremental source can be
1648            the origin snapshot, or an earlier snapshot in the origin's
1649            filesystem, or the origin's origin, etc.
1650 
1651      zfs send [-Penv] -t receive_resume_token
1652        Creates a send stream which resumes an interrupted receive.  The
1653        receive_resume_token is the value of this property on the filesystem or
1654        volume that was being received into.  See the documentation for zfs
1655        receive -s for more details.
1656 
1657      zfs receive [-Fnsuv] [-o origin=snapshot] filesystem|volume|snapshot

1658 
1659      zfs receive [-Fnsuv] [-d|-e] [-o origin=snapshot] filesystem

1660        Creates a snapshot whose contents are as specified in the stream
1661        provided on standard input.  If a full stream is received, then a new
1662        file system is created as well.  Streams are created using the zfs send
1663        subcommand, which by default creates a full stream.  zfs recv can be
1664        used as an alias for zfs receive.
1665 
1666        If an incremental stream is received, then the destination file system
1667        must already exist, and its most recent snapshot must match the
1668        incremental stream's source.  For zvols, the destination device link is
1669        destroyed and recreated, which means the zvol cannot be accessed during
1670        the receive operation.
1671 
1672        When a snapshot replication package stream that is generated by using
1673        the zfs send -R command is received, any snapshots that do not exist on
1674        the sending location are destroyed by using the zfs destroy -d command.
1675 
1676        The name of the snapshot (and file system, if a full stream is
1677        received) that this subcommand creates depends on the argument type and
1678        the use of the -d or -e options.
1679 

1683        filesystem or volume.  If neither of the -d or -e options are
1684        specified, the provided target snapshot name is used exactly as
1685        provided.
1686 
1687        The -d and -e options cause the file system name of the target snapshot
1688        to be determined by appending a portion of the sent snapshot's name to
1689        the specified target filesystem.  If the -d option is specified, all
1690        but the first element of the sent snapshot's file system path (usually
1691        the pool name) is used and any required intermediate file systems
1692        within the specified one are created.  If the -e option is specified,
1693        then only the last element of the sent snapshot's file system name
1694        (i.e. the name of the source file system itself) is used as the target
1695        file system name.
1696 
1697        -F  Force a rollback of the file system to the most recent snapshot
1698            before performing the receive operation.  If receiving an
1699            incremental replication stream (for example, one generated by zfs
1700            send -R [-i|-I]), destroy snapshots and file systems that do not
1701            exist on the sending side.
1702 



1703        -d  Discard the first element of the sent snapshot's file system name,
1704            using the remaining elements to determine the name of the target
1705            file system for the new snapshot as described in the paragraph
1706            above.
1707 
1708        -e  Discard all but the last element of the sent snapshot's file system
1709            name, using that element to determine the name of the target file
1710            system for the new snapshot as described in the paragraph above.
1711 





1712        -n  Do not actually receive the stream.  This can be useful in
1713            conjunction with the -v option to verify the name the receive
1714            operation would use.
1715 




1716        -o origin=snapshot
1717            Forces the stream to be received as a clone of the given snapshot.
1718            If the stream is a full send stream, this will create the
1719            filesystem described by the stream as a clone of the specified
1720            snapshot.  Which snapshot was specified will not affect the success
1721            or failure of the receive, as long as the snapshot does exist.  If
1722            the stream is an incremental send stream, all the normal
1723            verification will be performed.
1724 
1725        -u  File system that is associated with the received stream is not
1726            mounted.
1727 
1728        -v  Print verbose information about the stream and the time required to
1729            perform the receive operation.
1730 





1731        -s  If the receive is interrupted, save the partially received state,
1732            rather than deleting it.  Interruption may be due to premature
1733            termination of the stream (e.g. due to network failure or failure
1734            of the remote system if the stream is being read over a network
1735            connection), a checksum error in the stream, termination of the zfs
1736            receive process, or unclean shutdown of the system.
1737 
1738            The receive can be resumed with a stream generated by zfs send -t
1739            token, where the token is the value of the receive_resume_token
1740            property of the filesystem or volume which is received into.
1741 
1742            To use this flag, the storage pool must have the extensible_dataset
1743            feature enabled.  See zpool-features(5) for details on ZFS feature
1744            flags.
1745 
1746      zfs receive -A filesystem|volume
1747        Abort an interrupted zfs receive -s, deleting its saved partially
1748        received state.
1749 
1750      zfs allow filesystem|volume

2276        Local+Descendent permissions:
2277                group staff @pset
2278 
2279      Example 22 Showing the differences between a snapshot and a ZFS Dataset
2280        The following example shows how to see what has changed between a prior
2281        snapshot of a ZFS dataset and its current state.  The -F option is used
2282        to indicate type information for the files affected.
2283 
2284        # zfs diff -F tank/test@before tank/test
2285        M       /       /tank/test/
2286        M       F       /tank/test/linked      (+1)
2287        R       F       /tank/test/oldname -> /tank/test/newname
2288        -       F       /tank/test/deleted
2289        +       F       /tank/test/created
2290        M       F       /tank/test/modified
2291 
2292 INTERFACE STABILITY
2293      Committed.
2294 
2295 SEE ALSO
2296      gzip(1), ssh(1), mount(1M), share(1M), sharemgr(1M), unshare(1M),
2297      zonecfg(1M), zpool(1M), chmod(2), stat(2), write(2), fsync(3C),
2298      dfstab(4), acl(5), attributes(5)
2299 
2300 illumos                        December 6, 2017                        illumos

   3 NAME
   4      zfs - configures ZFS file systems
   5 
   6 SYNOPSIS
   7      zfs [-?]
   8      zfs create [-p] [-o property=value]... filesystem
   9      zfs create [-ps] [-b blocksize] [-o property=value]... -V size volume
  10      zfs destroy [-Rfnprv] filesystem|volume
  11      zfs destroy [-Rdnprv] filesystem|volume@snap[%snap[,snap[%snap]]]...
  12      zfs destroy filesystem|volume#bookmark
  13      zfs snapshot [-r] [-o property=value]...
  14          filesystem@snapname|volume@snapname...
  15      zfs rollback [-Rfr] snapshot
  16      zfs clone [-p] [-o property=value]... snapshot filesystem|volume
  17      zfs promote clone-filesystem
  18      zfs rename [-f] filesystem|volume|snapshot filesystem|volume|snapshot
  19      zfs rename [-fp] filesystem|volume filesystem|volume
  20      zfs rename -r snapshot snapshot
  21      zfs list [-r|-d depth] [-Hp] [-o property[,property]...] [-s property]...
  22          [-S property]... [-t type[,type]...] [filesystem|volume|snapshot]...

  23      zfs set property=value [property=value]... filesystem|volume|snapshot...
  24      zfs get [-r|-d depth] [-Hp] [-o field[,field]...] [-s source[,source]...]
  25          [-t type[,type]...] all | property[,property]...
  26          filesystem|volume|snapshot|bookmark...
  27      zfs inherit [-rS] property filesystem|volume|snapshot...
  28      zfs upgrade
  29      zfs upgrade -v
  30      zfs upgrade [-r] [-V version] -a | filesystem
  31      zfs userspace [-Hinp] [-o field[,field]...] [-s field]... [-S field]...
  32          [-t type[,type]...] filesystem|snapshot
  33      zfs groupspace [-Hinp] [-o field[,field]...] [-s field]... [-S field]...
  34          [-t type[,type]...] filesystem|snapshot
  35      zfs mount
  36      zfs mount [-Ov] [-o options] -a | filesystem
  37      zfs unmount [-f] -a | filesystem|mountpoint
  38      zfs share -a | filesystem
  39      zfs unshare -a | filesystem|mountpoint
  40      zfs bookmark snapshot bookmark
  41      zfs send [-DLPRcenpsv] [[-I|-i] snapshot] snapshot
  42      zfs send [-Lce] [-i snapshot|bookmark] filesystem|volume|snapshot
  43      zfs send [-Penv] -t receive_resume_token
  44      zfs receive [-FKnsuv] [-l filesystem|volume]... [-o property=value]...
  45          [-x property]... filesystem|volume|snapshot
  46      zfs receive [-FKnsuv] [-d|-e] [-l filesystem|volume]...
  47          [-o property=value]... [-x property]... filesystem
  48      zfs receive -A filesystem|volume
  49      zfs allow filesystem|volume
  50      zfs allow [-dglu] user|group[,user|group]...
  51          perm|@setname[,perm|@setname]... filesystem|volume
  52      zfs allow [-dl] -e|everyone perm|@setname[,perm|@setname]...
  53          filesystem|volume
  54      zfs allow -c perm|@setname[,perm|@setname]... filesystem|volume
  55      zfs allow -s @setname perm|@setname[,perm|@setname]... filesystem|volume
  56      zfs unallow [-dglru] user|group[,user|group]...
  57          [perm|@setname[,perm|@setname]...] filesystem|volume
  58      zfs unallow [-dlr] -e|everyone [perm|@setname[,perm|@setname]...]
  59          filesystem|volume
  60      zfs unallow [-r] -c [perm|@setname[,perm|@setname]...] filesystem|volume
  61      zfs unallow [-r] -s -@setname [perm|@setname[,perm|@setname]...]
  62          filesystem|volume
  63      zfs hold [-r] tag snapshot...
  64      zfs holds [-r] snapshot...
  65      zfs release [-r] tag snapshot...
  66      zfs diff [-FHt] snapshot snapshot|filesystem
  67      zfs program [-n] [-t timeout] [-m memory_limit] pool script [arg1 ...]

 266                            by this dataset.  See the referenced property.  The
 267                            logical space ignores the effect of the compression
 268                            and copies properties, giving a quantity closer to
 269                            the amount of data that applications see.  However,
 270                            it does include space consumed by metadata.
 271 
 272                            This property can also be referred to by its
 273                            shortened column name, lrefer.
 274 
 275      logicalused           The amount of space that is "logically" consumed by
 276                            this dataset and all its descendents.  See the used
 277                            property.  The logical space ignores the effect of
 278                            the compression and copies properties, giving a
 279                            quantity closer to the amount of data that
 280                            applications see.  However, it does include space
 281                            consumed by metadata.
 282 
 283                            This property can also be referred to by its
 284                            shortened column name, lused.
 285 
 286      modified              For a snapshot, indicates whether the parent
 287                            filesystem or volume has been modified since the
 288                            snapshot.  This property can be either yes or no.
 289 
 290      mounted               For file systems, indicates whether the file system
 291                            is currently mounted.  This property can be either
 292                            yes or no.
 293 
 294      origin                For cloned file systems or volumes, the snapshot
 295                            from which the clone was created.  See also the
 296                            clones property.
 297 
 298      receive_resume_token  For filesystems or volumes which have saved
 299                            partially-completed state from zfs receive -s, this
 300                            opaque token can be provided to zfs send -t to
 301                            resume and complete the zfs receive.
 302 
 303      referenced            The amount of data that is accessible by this
 304                            dataset, which may or may not be shared with other
 305                            datasets in the pool.  When a snapshot or clone is
 306                            created, it initially references the same amount of
 307                            space as the file system or snapshot it was created
 308                            from, since its contents are identical.
 309 

 561        lzjb algorithm.  It features significantly faster compression and
 562        decompression, as well as a moderately higher compression ratio than
 563        lzjb, but can only be used on pools with the lz4_compress feature set
 564        to enabled.  See zpool-features(5) for details on ZFS feature flags and
 565        the lz4_compress feature.
 566 
 567        The lzjb compression algorithm is optimized for performance while
 568        providing decent data compression.
 569 
 570        The gzip compression algorithm uses the same compression as the gzip(1)
 571        command.  You can specify the gzip level by using the value gzip-N,
 572        where N is an integer from 1 (fastest) to 9 (best compression ratio).
 573        Currently, gzip is equivalent to gzip-6 (which is also the default for
 574        gzip(1)).
 575 
 576        The zle compression algorithm compresses runs of zeros.
 577 
 578        This property can also be referred to by its shortened column name
 579        compress.  Changing this property affects only newly-written data.
 580 
 581      smartcompression=on|off
 582        Smart compression is a feature which optimizes compression performance
 583        on filesystems which contain a mixture of compressible and
 584        incompressible data.  When compression is enabled on a filesystem,
 585        smart compression dynamically tracks per-file compression ratios to
 586        determine if a file is compressible or not.  When the compression ratio
 587        being achieved is too low, smart compression progressively backs off
 588        attempting to compress the file.
 589 
 590        The algorithm periodically checks whether new data written to a file
 591        previously deemed incompressible is still not compressible and adjusts
 592        behavior accordingly.  Certain types of files, such as virtual machine
 593        disk files or large database files, can contain a mixture of both types
 594        of data.  Although smart compression tries to detect these situations,
 595        in marginal cases it can be too pessimistic, which results in a
 596        reduction of the overall compression ratio.  In this case, setting the
 597        smartcompression property to off turns off smart compression on a
 598        filesystem, so that data is always compressed regardless of the
 599        compression ratio achieved.
 600 
 601        The default value is on.
 602 
 603      copies=1|2|3
 604        Controls the number of copies of data stored for this dataset.  These
 605        copies are in addition to any redundancy provided by the pool, for
 606        example, mirroring or RAID-Z.  The copies are stored on different
 607        disks, if possible.  The space used by multiple copies is charged to
 608        the associated file and dataset, changing the used property and
 609        counting against quotas and reservations.
 610 
 611        Changing this property only affects newly-written data.  Therefore, set
 612        this property at file system creation time by using the -o copies=N
 613        option.
 614 
 615      devices=on|off
 616        Controls whether device nodes can be opened on this file system.  The
 617        default value is on.
 618 
 619      exec=on|off
 620        Controls whether processes can be executed from within this file
 621        system.  The default value is on.
 622 

 795 
 796        This property can also be referred to by its shortened column name,
 797        reserv.
 798 
 799      secondarycache=all|none|metadata
 800        Controls what is cached in the secondary cache (L2ARC).  If this
 801        property is set to all, then both user data and metadata is cached.  If
 802        this property is set to none, then neither user data nor metadata is
 803        cached.  If this property is set to metadata, then only metadata is
 804        cached.  The default value is all.
 805 
 806      setuid=on|off
 807        Controls whether the setuid bit is respected for the file system.  The
 808        default value is on.
 809 
 810      sharesmb=on|off|opts
 811        Controls whether the file system is shared via SMB, and what options
 812        are to be used.  A file system with the sharesmb property set to off is
 813        managed through traditional tools such as sharemgr(1M).  Otherwise, the
 814        file system is automatically shared and unshared with the zfs share and
 815        zfs unshare commands.  See sharesmb(5) for the share options
 816        description.


 817 
 818        Because SMB shares requires a resource name, a unique resource name is
 819        constructed from the dataset name.  The constructed name is a copy of
 820        the dataset name except that the characters in the dataset name, which
 821        would be invalid in the resource name, are replaced with underscore (_)
 822        characters.  A pseudo property "name" is also supported that allows you
 823        to replace the data set name with a specified name.  The specified name
 824        is then used to replace the prefix dataset in the case of inheritance.
 825        For example, if the dataset data/home/john is set to name=john, then
 826        data/home/john has a resource name of john.  If a child dataset
 827        data/home/john/backups is shared, it has a resource name of
 828        john_backups.
 829 
 830        When SMB shares are created, the SMB share name appears as an entry in
 831        the .zfs/shares directory.  You can use the ls or chmod command to
 832        display the share-level ACLs on the entries in this directory.
 833 
 834        When the sharesmb property is changed for a dataset, the dataset and
 835        any children inheriting the property are re-shared with the new
 836        options, only if the property was previously set to off, or if they
 837        were shared before the property was changed.  If the new property is
 838        set to off, the file systems are unshared.
 839 
 840      sharenfs=on|off|opts
 841        Controls whether the file system is shared via NFS, and what options
 842        are to be used.  A file system with a sharenfs property of off is
 843        managed through traditional tools such as share(1M), unshare(1M), and
 844        dfstab(4).  Otherwise, the file system is automatically shared and
 845        unshared with the zfs share and zfs unshare commands.  See sharenfs(5)
 846        for the share options description.


 847 
 848        When the sharenfs property is changed for a dataset, the dataset and
 849        any children inheriting the property are re-shared with the new
 850        options, only if the property was previously off, or if they were
 851        shared before the property was changed.  If the new property is off,
 852        the file systems are unshared.
 853 
 854      logbias=latency|throughput
 855        Provide a hint to ZFS about handling of synchronous requests in this
 856        dataset.  If logbias is set to latency (the default), ZFS will use pool
 857        log devices (if configured) to handle the requests at low latency.  If
 858        logbias is set to throughput, ZFS will not use configured pool log
 859        devices.  ZFS will instead optimize synchronous operations for global
 860        pool throughput and efficient use of resources.
 861 
 862      snapdir=hidden|visible
 863        Controls whether the .zfs directory is hidden or visible in the root of
 864        the file system as discussed in the Snapshots section.  The default
 865        value is hidden.
 866 

 896        could run out of space, resulting in undefined behavior or data
 897        corruption, depending on how the volume is used.  These effects can
 898        also occur when the volume size is changed while it is in use
 899        (particularly when shrinking the size).  Extreme care should be used
 900        when adjusting the volume size.
 901 
 902        Though not recommended, a "sparse volume" (also known as "thin
 903        provisioning") can be created by specifying the -s option to the zfs
 904        create -V command, or by changing the reservation after the volume has
 905        been created.  A "sparse volume" is a volume where the reservation is
 906        less then the volume size.  Consequently, writes to a sparse volume can
 907        fail with ENOSPC when the pool is low on space.  For a sparse volume,
 908        changes to volsize are not reflected in the reservation.
 909 
 910      vscan=on|off
 911        Controls whether regular files should be scanned for viruses when a
 912        file is opened and closed.  In addition to enabling this property, the
 913        virus scan service must also be enabled for virus scanning to occur.
 914        The default value is off.
 915 
 916      wbc_mode=on|off
 917        Controls the mode of write back cache.  After the property has been set
 918        on a dataset all the child datasets inherit the property.  Due to its
 919        recursive nature the property will conflict with any child dataset or
 920        any parent dataset having this property enabled as well.  The property
 921        cannot be set if the target pool does not have special device (special
 922        vdev).  The default value is off.  This property cannot be enabled
 923        together with the dedup property.
 924 
 925      xattr=on|off
 926        Controls whether extended attributes are enabled for this file system.
 927        The default value is on.
 928 
 929      zoned=on|off
 930        Controls whether the dataset is managed from a non-global zone.  See
 931        the Zones section for more information.  The default value is off.
 932 
 933      The following three properties cannot be changed after the file system is
 934      created, and therefore, should be set when the file system is created.
 935      If the properties are not set with the zfs create or zpool create
 936      commands, these properties are inherited from the parent dataset.  If the
 937      parent dataset lacks these properties due to having been created prior to
 938      these features being supported, the new file system will have the default
 939      values for these properties.
 940 
 941      casesensitivity=sensitive|insensitive|mixed
 942        Indicates whether the file name matching algorithm used by the file
 943        system should be case-sensitive, case-insensitive, or allow a
 944        combination of both styles of matching.  The default value for the

1370            coming from a source other than those in this list are ignored.
1371            Each source must be one of the following: local, default,
1372            inherited, temporary, and none.  The default value is all sources.
1373 
1374        -t type
1375            A comma-separated list of types to display, where type is one of
1376            filesystem, snapshot, volume, bookmark, or all.
1377 
1378      zfs inherit [-rS] property filesystem|volume|snapshot...
1379        Clears the specified property, causing it to be inherited from an
1380        ancestor, restored to default if no ancestor has the property set, or
1381        with the -S option reverted to the received value if one exists.  See
1382        the Properties section for a listing of default values, and details on
1383        which properties can be inherited.
1384 
1385        -r  Recursively inherit the given property for all children.
1386 
1387        -S  Revert the property to the received value if one exists; otherwise
1388            operate as if the -S option was not specified.
1389 








1390      zfs upgrade
1391        Displays a list of file systems that are not the most recent version.
1392 
1393      zfs upgrade -v
1394        Displays a list of currently supported file system versions.
1395 
1396      zfs upgrade [-r] [-V version] -a | filesystem
1397        Upgrades file systems to a new on-disk version.  Once this is done, the
1398        file systems will no longer be accessible on systems running older
1399        versions of the software.  zfs send streams generated from new
1400        snapshots of these file systems cannot be accessed on systems running
1401        older versions of the software.
1402 
1403        In general, the file system version is independent of the pool version.
1404        See zpool(1M) for information on the zpool upgrade command.
1405 
1406        In some cases, the file system version and the pool version are
1407        interrelated and the pool version must be upgraded before the file
1408        system version can be upgraded.
1409 

1511            sharesmb property is set.
1512 
1513      zfs unshare -a | filesystem|mountpoint
1514        Unshares currently shared ZFS file systems.
1515 
1516        -a  Unshare all available ZFS file systems.  Invoked automatically as
1517            part of the shutdown process.
1518 
1519        filesystem|mountpoint
1520            Unshare the specified filesystem.  The command can also be given a
1521            path to a ZFS file system shared on the system.
1522 
1523      zfs bookmark snapshot bookmark
1524        Creates a bookmark of the given snapshot.  Bookmarks mark the point in
1525        time when the snapshot was created, and can be used as the incremental
1526        source for a zfs send command.
1527 
1528        This feature must be enabled to be used.  See zpool-features(5) for
1529        details on ZFS feature flags and the bookmarks feature.
1530 
1531      zfs send [-DLPRcenpsv] [[-I|-i] snapshot] snapshot
1532        Creates a stream representation of the second snapshot, which is
1533        written to standard output.  The output can be redirected to a file or
1534        to a different system (for example, using ssh(1)).  By default, a full
1535        stream is generated.
1536 
1537        -D, --dedup
1538            Generate a deduplicated stream.  Blocks which would have been sent
1539            multiple times in the send stream will only be sent once.  The
1540            receiving system must also support this feature to receive a
1541            deduplicated stream.  This flag can be used regardless of the
1542            dataset's dedup property, but performance will be much better if
1543            the filesystem uses a dedup-capable checksum (for example, sha256).
1544 
1545        -I snapshot
1546            Generate a stream package that sends all intermediary snapshots
1547            from the first snapshot to the second snapshot.  For example, -I @a
1548            fs@d is similar to -i @a fs@b; -i @b fs@c; -i @c fs@d.  The
1549            incremental source may be specified as with the -i option.
1550 
1551        -L, --large-block

1554            if the recordsize property of this filesystem has never been set
1555            above 128KB.  The receiving system must have the large_blocks pool
1556            feature enabled as well.  See zpool-features(5) for details on ZFS
1557            feature flags and the large_blocks feature.
1558 
1559        -P, --parsable
1560            Print machine-parsable verbose information about the stream package
1561            generated.
1562 
1563        -R, --replicate
1564            Generate a replication stream package, which will replicate the
1565            specified file system, and all descendent file systems, up to the
1566            named snapshot.  When received, all properties, snapshots,
1567            descendent file systems, and clones are preserved.
1568 
1569            If the -i or -I flags are used in conjunction with the -R flag, an
1570            incremental replication stream is generated.  The current values of
1571            properties, and current snapshot and file system names are set when
1572            the stream is received.  If the -F flag is specified when this
1573            stream is received, snapshots and file systems that do not exist on
1574            the sending side are destroyed.  If the -K flag is specified in
1575            conjunction with -F flag, then it modifies the conventional force-
1576            receive behavior to not destroy destination snapshots that are not
1577            present at the replication source.
1578 
1579        -e, --embed
1580            Generate a more compact stream by using WRITE_EMBEDDED records for
1581            blocks which are stored more compactly on disk by the embedded_data
1582            pool feature.  This flag has no effect if the embedded_data feature
1583            is disabled.  The receiving system must have the embedded_data
1584            feature enabled.  If the lz4_compress feature is active on the
1585            sending system, then the receiving system must have that feature
1586            enabled as well.  See zpool-features(5) for details on ZFS feature
1587            flags and the embedded_data feature.
1588 
1589        -c, --compressed
1590            Generate a more compact stream by using compressed WRITE records
1591            for blocks which are compressed on disk and in memory (see the
1592            compression property for details).  If the lz4_compress feature is
1593            active on the sending system, then the receiving system must have
1594            that feature enabled as well.  If the large_blocks feature is
1595            enabled on the sending system but the -L option is not supplied in
1596            conjunction with -c, then the data will be decompressed before
1597            sending so it can be split into smaller block sizes.

1604            it is assumed to be from the same file system as the incremental
1605            target.
1606 
1607            If the destination is a clone, the source may be the origin
1608            snapshot, which must be fully specified (for example,
1609            pool/fs@origin, not just @origin).
1610 
1611        -n, --dryrun
1612            Do a dry-run ("No-op") send.  Do not generate any actual send data.
1613            This is useful in conjunction with the -v or -P flags to determine
1614            what data will be sent.  In this case, the verbose output will be
1615            written to standard output (contrast with a non-dry-run, where the
1616            stream is written to standard output and the verbose output goes to
1617            standard error).
1618 
1619        -p, --props
1620            Include the dataset's properties in the stream.  This flag is
1621            implicit when -R is specified.  The receiving system must also
1622            support this feature.
1623 
1624        -s  Calculate send stream size.  Do not generate any actual send data.
1625            This is useful when one needs to know stream size in order to store
1626            the stream externally.  With -v specified, provides info on stream
1627            header and stream data portion sizes, in addition to the total
1628            stream size.
1629 
1630        -v, --verbose
1631            Print verbose information about the stream package generated.  This
1632            information includes a per-second report of how much data has been
1633            sent.
1634 
1635            The format of the stream is committed.  You will be able to receive
1636            your streams on future versions of ZFS .
1637 
1638      zfs send [-Lce] [-i snapshot|bookmark] filesystem|volume|snapshot
1639        Generate a send stream, which may be of a filesystem, and may be
1640        incremental from a bookmark.  If the destination is a filesystem or
1641        volume, the pool must be read-only, or the filesystem must not be
1642        mounted.  When the stream generated from a filesystem or volume is
1643        received, the default snapshot name will be "--head--".
1644 
1645        -L, --large-block
1646            Generate a stream which may contain blocks larger than 128KB.  This
1647            flag has no effect if the large_blocks pool feature is disabled, or
1648            if the recordsize property of this filesystem has never been set
1649            above 128KB.  The receiving system must have the large_blocks pool

1670            enabled as well.  See zpool-features(5) for details on ZFS feature
1671            flags and the embedded_data feature.
1672 
1673        -i snapshot|bookmark
1674            Generate an incremental send stream.  The incremental source must
1675            be an earlier snapshot in the destination's history.  It will
1676            commonly be an earlier snapshot in the destination's file system,
1677            in which case it can be specified as the last component of the name
1678            (the # or @ character and following).
1679 
1680            If the incremental target is a clone, the incremental source can be
1681            the origin snapshot, or an earlier snapshot in the origin's
1682            filesystem, or the origin's origin, etc.
1683 
1684      zfs send [-Penv] -t receive_resume_token
1685        Creates a send stream which resumes an interrupted receive.  The
1686        receive_resume_token is the value of this property on the filesystem or
1687        volume that was being received into.  See the documentation for zfs
1688        receive -s for more details.
1689 
1690      zfs receive [-FKsnuv] [-l filesystem|volume]... [-o property=value]...
1691        [-x property]... filesystem|volume|snapshot
1692 
1693      zfs receive [-FKnsuv] [-d|-e] [-l filesystem|volume]... [-o
1694        property=value]... [-x property]... filesystem
1695        Creates a snapshot whose contents are as specified in the stream
1696        provided on standard input.  If a full stream is received, then a new
1697        file system is created as well.  Streams are created using the zfs send
1698        subcommand, which by default creates a full stream.  zfs recv can be
1699        used as an alias for zfs receive.
1700 
1701        If an incremental stream is received, then the destination file system
1702        must already exist, and its most recent snapshot must match the
1703        incremental stream's source.  For zvols, the destination device link is
1704        destroyed and recreated, which means the zvol cannot be accessed during
1705        the receive operation.
1706 
1707        When a snapshot replication package stream that is generated by using
1708        the zfs send -R command is received, any snapshots that do not exist on
1709        the sending location are destroyed by using the zfs destroy -d command.
1710 
1711        The name of the snapshot (and file system, if a full stream is
1712        received) that this subcommand creates depends on the argument type and
1713        the use of the -d or -e options.
1714 

1718        filesystem or volume.  If neither of the -d or -e options are
1719        specified, the provided target snapshot name is used exactly as
1720        provided.
1721 
1722        The -d and -e options cause the file system name of the target snapshot
1723        to be determined by appending a portion of the sent snapshot's name to
1724        the specified target filesystem.  If the -d option is specified, all
1725        but the first element of the sent snapshot's file system path (usually
1726        the pool name) is used and any required intermediate file systems
1727        within the specified one are created.  If the -e option is specified,
1728        then only the last element of the sent snapshot's file system name
1729        (i.e. the name of the source file system itself) is used as the target
1730        file system name.
1731 
1732        -F  Force a rollback of the file system to the most recent snapshot
1733            before performing the receive operation.  If receiving an
1734            incremental replication stream (for example, one generated by zfs
1735            send -R [-i|-I]), destroy snapshots and file systems that do not
1736            exist on the sending side.
1737 
1738        -K  When force receive is enabled, do not destroy snapshots on the
1739            receiving side that do not exist on the sending side.
1740 
1741        -d  Discard the first element of the sent snapshot's file system name,
1742            using the remaining elements to determine the name of the target
1743            file system for the new snapshot as described in the paragraph
1744            above.
1745 
1746        -e  Discard all but the last element of the sent snapshot's file system
1747            name, using that element to determine the name of the target file
1748            system for the new snapshot as described in the paragraph above.
1749 
1750        -l filesystem|volume
1751            Limits the receive to only the filesystem or volume specified.  As
1752            multiple options may be specified, this can be used to restore
1753            specific filesystems or volumes from the received stream.
1754 
1755        -n  Do not actually receive the stream.  This can be useful in
1756            conjunction with the -v option to verify the name the receive
1757            operation would use.
1758 
1759        -o property=value
1760            Sets the specified property to value during receive of the stream.
1761            Specifying multiple -o options is allowed.
1762 
1763        -o origin=snapshot
1764            Forces the stream to be received as a clone of the given snapshot.
1765            If the stream is a full send stream, this will create the
1766            filesystem described by the stream as a clone of the specified
1767            snapshot.  Which snapshot was specified will not affect the success
1768            or failure of the receive, as long as the snapshot does exist.  If
1769            the stream is an incremental send stream, all the normal
1770            verification will be performed.
1771 
1772        -u  File system that is associated with the received stream is not
1773            mounted.
1774 
1775        -v  Print verbose information about the stream and the time required to
1776            perform the receive operation.
1777 
1778        -x property
1779            Excludes the specified property from the received stream as if it
1780            was not included in the send stream.  Specifying multiple -x
1781            options is allowed.
1782 
1783        -s  If the receive is interrupted, save the partially received state,
1784            rather than deleting it.  Interruption may be due to premature
1785            termination of the stream (e.g. due to network failure or failure
1786            of the remote system if the stream is being read over a network
1787            connection), a checksum error in the stream, termination of the zfs
1788            receive process, or unclean shutdown of the system.
1789 
1790            The receive can be resumed with a stream generated by zfs send -t
1791            token, where the token is the value of the receive_resume_token
1792            property of the filesystem or volume which is received into.
1793 
1794            To use this flag, the storage pool must have the extensible_dataset
1795            feature enabled.  See zpool-features(5) for details on ZFS feature
1796            flags.
1797 
1798      zfs receive -A filesystem|volume
1799        Abort an interrupted zfs receive -s, deleting its saved partially
1800        received state.
1801 
1802      zfs allow filesystem|volume

2328        Local+Descendent permissions:
2329                group staff @pset
2330 
2331      Example 22 Showing the differences between a snapshot and a ZFS Dataset
2332        The following example shows how to see what has changed between a prior
2333        snapshot of a ZFS dataset and its current state.  The -F option is used
2334        to indicate type information for the files affected.
2335 
2336        # zfs diff -F tank/test@before tank/test
2337        M       /       /tank/test/
2338        M       F       /tank/test/linked      (+1)
2339        R       F       /tank/test/oldname -> /tank/test/newname
2340        -       F       /tank/test/deleted
2341        +       F       /tank/test/created
2342        M       F       /tank/test/modified
2343 
2344 INTERFACE STABILITY
2345      Committed.
2346 
2347 SEE ALSO
2348      gzip(1), ssh(1), mount(1M), sharemgr(1M), zonecfg(1M), zpool(1M),
2349      chmod(2), stat(2), write(2), fsync(3C), dfstab(4), acl(5), attributes(5),
2350      sharenfs(5), sharesmb(5)
2351 
2352 illumos                        December 6, 2017                        illumos