Print this page
Placeholder


  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...
  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 [-DLPRenpv] [[-I|-i] snapshot] snapshot
  42      zfs send [-Le] [-i snapshot|bookmark] filesystem|volume|snapshot
  43      zfs send [-Penv] -t receive_resume_token
  44      zfs receive [-Fnsuv] [-o origin=snapshot] filesystem|volume|snapshot
  45      zfs receive [-Fnsuv] [-d|-e] [-o origin=snapshot] filesystem
  46      zfs receive -A filesystem|volume
  47      zfs allow filesystem|volume
  48      zfs allow [-dglu] user|group[,user|group]...
  49          perm|@setname[,perm|@setname]... filesystem|volume
  50      zfs allow [-dl] -e|everyone perm|@setname[,perm|@setname]...
  51          filesystem|volume
  52      zfs allow -c perm|@setname[,perm|@setname]... filesystem|volume
  53      zfs allow -s @setname perm|@setname[,perm|@setname]... filesystem|volume
  54      zfs unallow [-dglru] user|group[,user|group]...
  55          [perm|@setname[,perm|@setname]...] filesystem|volume
  56      zfs unallow [-dlr] -e|everyone [perm|@setname[,perm|@setname]...]
  57          filesystem|volume
  58      zfs unallow [-r] -c [perm|@setname[,perm|@setname]...] filesystem|volume
  59      zfs unallow [-r] -s -@setname [perm|@setname[,perm|@setname]...]
  60          filesystem|volume
  61      zfs hold [-r] tag snapshot...
  62      zfs holds [-r] snapshot...


1465            sharesmb property is set.
1466 
1467      zfs unshare -a | filesystem|mountpoint
1468        Unshares currently shared ZFS file systems.
1469 
1470        -a  Unshare all available ZFS file systems. Invoked automatically as
1471            part of the shutdown process.
1472 
1473        filesystem|mountpoint
1474            Unshare the specified filesystem. The command can also be given a
1475            path to a ZFS file system shared on the system.
1476 
1477      zfs bookmark snapshot bookmark
1478        Creates a bookmark of the given snapshot. Bookmarks mark the point in
1479        time when the snapshot was created, and can be used as the incremental
1480        source for a zfs send command.
1481 
1482        This feature must be enabled to be used. See zpool-features(5) for
1483        details on ZFS feature flags and the bookmarks feature.
1484 
1485      zfs send [-DLPRenpv] [[-I|-i] snapshot] snapshot
1486        Creates a stream representation of the second snapshot, which is
1487        written to standard output. The output can be redirected to a file or
1488        to a different system (for example, using ssh(1)).  By default, a full
1489        stream is generated.
1490 
1491        -D  Generate a deduplicated stream. Blocks which would have been sent
1492            multiple times in the send stream will only be sent once. The
1493            receiving system must also support this feature to recieve a
1494            deduplicated stream. This flag can be used regardless of the
1495            dataset's dedup property, but performance will be much better if
1496            the filesystem uses a dedup-capable checksum (for example, sha256).
1497 
1498        -I snapshot
1499            Generate a stream package that sends all intermediary snapshots
1500            from the first snapshot to the second snapshot. For example, -I @a
1501            fs@d is similar to -i @a fs@b; -i @b fs@c; -i @c fs@d.  The
1502            incremental source may be specified as with the -i option.
1503 
1504        -L  Generate a stream which may contain blocks larger than 128KB. This
1505            flag has no effect if the large_blocks pool feature is disabled, or


1515            specified file system, and all descendent file systems, up to the
1516            named snapshot. When received, all properties, snapshots,
1517            descendent file systems, and clones are preserved.
1518 
1519            If the -i or -I flags are used in conjunction with the -R flag, an
1520            incremental replication stream is generated. The current values of
1521            properties, and current snapshot and file system names are set when
1522            the stream is received. If the -F flag is specified when this
1523            stream is received, snapshots and file systems that do not exist on
1524            the sending side are destroyed.
1525 
1526        -e  Generate a more compact stream by using WRITE_EMBEDDED records for
1527            blocks which are stored more compactly on disk by the embedded_data
1528            pool feature. This flag has no effect if the embedded_data feature
1529            is disabled. The receiving system must have the embedded_data
1530            feature enabled. If the lz4_compress feature is active on the
1531            sending system, then the receiving system must have that feature
1532            enabled as well. See zpool-features(5) for details on ZFS feature
1533            flags and the embedded_data feature.
1534 




1535        -i snapshot
1536            Generate an incremental stream from the first snapshot (the
1537            incremental source) to the second snapshot (the incremental
1538            target).  The incremental source can be specified as the last
1539            component of the snapshot name (the @ character and following) and
1540            it is assumed to be from the same file system as the incremental
1541            target.
1542 
1543            If the destination is a clone, the source may be the origin
1544            snapshot, which must be fully specified (for example,
1545            pool/fs@origin, not just @origin).
1546 
1547        -n  Do a dry-run ("No-op") send. Do not generate any actual send data.
1548            This is useful in conjunction with the -v or -P flags to determine
1549            what data will be sent. In this case, the verbose output will be
1550            written to standard output (contrast with a non-dry-run, where the
1551            stream is written to standard output and the verbose output goes to
1552            standard error).
1553 
1554        -p  Include the dataset's properties in the stream. This flag is
1555            implicit when -R is specified. The receiving system must also
1556            support this feature.
1557 
1558        -v  Print verbose information about the stream package generated. This
1559            information includes a per-second report of how much data has been
1560            sent.
1561 
1562            The format of the stream is committed. You will be able to receive
1563            your streams on future versions of ZFS .
1564 
1565      zfs send [-Le] [-i snapshot|bookmark] filesystem|volume|snapshot
1566        Generate a send stream, which may be of a filesystem, and may be
1567        incremental from a bookmark. If the destination is a filesystem or
1568        volume, the pool must be read-only, or the filesystem must not be
1569        mounted. When the stream generated from a filesystem or volume is
1570        received, the default snapshot name will be "--head--".
1571 
1572        -L  Generate a stream which may contain blocks larger than 128KB. This
1573            flag has no effect if the large_blocks pool feature is disabled, or
1574            if the recordsize property of this filesystem has never been set
1575            above 128KB. The receiving system must have the large_blocks pool
1576            feature enabled as well. See zpool-features(5) for details on ZFS
1577            feature flags and the large_blocks feature.
1578 
1579        -e  Generate a more compact stream by using WRITE_EMBEDDED records for
1580            blocks which are stored more compactly on disk by the embedded_data
1581            pool feature. This flag has no effect if the embedded_data feature
1582            is disabled. The receiving system must have the embedded_data
1583            feature enabled. If the lz4_compress feature is active on the
1584            sending system, then the receiving system must have that feature
1585            enabled as well. See zpool-features(5) for details on ZFS feature
1586            flags and the embedded_data feature.
1587 




1588        -i snapshot|bookmark
1589            Generate an incremental send stream. The incremental source must be
1590            an earlier snapshot in the destination's history. It will commonly
1591            be an earlier snapshot in the destination's file system, in which
1592            case it can be specified as the last component of the name (the #
1593            or @ character and following).
1594 
1595            If the incremental target is a clone, the incremental source can be
1596            the origin snapshot, or an earlier snapshot in the origin's
1597            filesystem, or the origin's origin, etc.
1598 
1599      zfs send [-Penv] -t receive_resume_token
1600        Creates a send stream which resumes an interrupted receive.  The
1601        receive_resume_token is the value of this property on the filesystem or
1602        volume that was being received into.  See the documentation for zfs
1603        receive -s for more details.
1604 
1605      zfs receive [-Fnsuv] [-o origin=snapshot] filesystem|volume|snapshot
1606      zfs receive [-Fnsuv] [-d|-e] [-o origin=snapshot] filesystem
1607        Creates a snapshot whose contents are as specified in the stream


2179        The following example shows how to see what has changed between a prior
2180        snapshot of a ZFS dataset and its current state. The -F option is used
2181        to indicate type information for the files affected.
2182 
2183        # zfs diff -F tank/test@before tank/test
2184        M       /       /tank/test/
2185        M       F       /tank/test/linked      (+1)
2186        R       F       /tank/test/oldname -> /tank/test/newname
2187        -       F       /tank/test/deleted
2188        +       F       /tank/test/created
2189        M       F       /tank/test/modified
2190 
2191 INTERFACE STABILITY
2192      Commited.
2193 
2194 SEE ALSO
2195      gzip(1), ssh(1), mount(1M), share(1M), sharemgr(1M), unshare(1M),
2196      zonecfg(1M), zpool(1M), chmod(2), stat(2), write(2), fsync(3C),
2197      dfstab(4), acl(5), attributes(5)
2198 
2199 illumos                          June 8, 2015                          illumos


  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...
  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 [-DFLPRenpv] [[-I|-i] snapshot] snapshot
  42      zfs send [-FLe] [-i snapshot|bookmark] filesystem|volume|snapshot
  43      zfs send [-Penv] -t receive_resume_token
  44      zfs receive [-Fnsuv] [-o origin=snapshot] filesystem|volume|snapshot
  45      zfs receive [-Fnsuv] [-d|-e] [-o origin=snapshot] filesystem
  46      zfs receive -A filesystem|volume
  47      zfs allow filesystem|volume
  48      zfs allow [-dglu] user|group[,user|group]...
  49          perm|@setname[,perm|@setname]... filesystem|volume
  50      zfs allow [-dl] -e|everyone perm|@setname[,perm|@setname]...
  51          filesystem|volume
  52      zfs allow -c perm|@setname[,perm|@setname]... filesystem|volume
  53      zfs allow -s @setname perm|@setname[,perm|@setname]... filesystem|volume
  54      zfs unallow [-dglru] user|group[,user|group]...
  55          [perm|@setname[,perm|@setname]...] filesystem|volume
  56      zfs unallow [-dlr] -e|everyone [perm|@setname[,perm|@setname]...]
  57          filesystem|volume
  58      zfs unallow [-r] -c [perm|@setname[,perm|@setname]...] filesystem|volume
  59      zfs unallow [-r] -s -@setname [perm|@setname[,perm|@setname]...]
  60          filesystem|volume
  61      zfs hold [-r] tag snapshot...
  62      zfs holds [-r] snapshot...


1465            sharesmb property is set.
1466 
1467      zfs unshare -a | filesystem|mountpoint
1468        Unshares currently shared ZFS file systems.
1469 
1470        -a  Unshare all available ZFS file systems. Invoked automatically as
1471            part of the shutdown process.
1472 
1473        filesystem|mountpoint
1474            Unshare the specified filesystem. The command can also be given a
1475            path to a ZFS file system shared on the system.
1476 
1477      zfs bookmark snapshot bookmark
1478        Creates a bookmark of the given snapshot. Bookmarks mark the point in
1479        time when the snapshot was created, and can be used as the incremental
1480        source for a zfs send command.
1481 
1482        This feature must be enabled to be used. See zpool-features(5) for
1483        details on ZFS feature flags and the bookmarks feature.
1484 
1485      zfs send [-DFLPRenpv] [[-I|-i] snapshot] snapshot
1486        Creates a stream representation of the second snapshot, which is
1487        written to standard output. The output can be redirected to a file or
1488        to a different system (for example, using ssh(1)).  By default, a full
1489        stream is generated.
1490 
1491        -D  Generate a deduplicated stream. Blocks which would have been sent
1492            multiple times in the send stream will only be sent once. The
1493            receiving system must also support this feature to recieve a
1494            deduplicated stream. This flag can be used regardless of the
1495            dataset's dedup property, but performance will be much better if
1496            the filesystem uses a dedup-capable checksum (for example, sha256).
1497 
1498        -I snapshot
1499            Generate a stream package that sends all intermediary snapshots
1500            from the first snapshot to the second snapshot. For example, -I @a
1501            fs@d is similar to -i @a fs@b; -i @b fs@c; -i @c fs@d.  The
1502            incremental source may be specified as with the -i option.
1503 
1504        -L  Generate a stream which may contain blocks larger than 128KB. This
1505            flag has no effect if the large_blocks pool feature is disabled, or


1515            specified file system, and all descendent file systems, up to the
1516            named snapshot. When received, all properties, snapshots,
1517            descendent file systems, and clones are preserved.
1518 
1519            If the -i or -I flags are used in conjunction with the -R flag, an
1520            incremental replication stream is generated. The current values of
1521            properties, and current snapshot and file system names are set when
1522            the stream is received. If the -F flag is specified when this
1523            stream is received, snapshots and file systems that do not exist on
1524            the sending side are destroyed.
1525 
1526        -e  Generate a more compact stream by using WRITE_EMBEDDED records for
1527            blocks which are stored more compactly on disk by the embedded_data
1528            pool feature. This flag has no effect if the embedded_data feature
1529            is disabled. The receiving system must have the embedded_data
1530            feature enabled. If the lz4_compress feature is active on the
1531            sending system, then the receiving system must have that feature
1532            enabled as well. See zpool-features(5) for details on ZFS feature
1533            flags and the embedded_data feature.
1534 
1535        -F  Generate a stream which omits free records.  The stream will be
1536            more compact but the receiving system will not be able to receive
1537            the stream as a clone.
1538 
1539        -i snapshot
1540            Generate an incremental stream from the first snapshot (the
1541            incremental source) to the second snapshot (the incremental
1542            target).  The incremental source can be specified as the last
1543            component of the snapshot name (the @ character and following) and
1544            it is assumed to be from the same file system as the incremental
1545            target.
1546 
1547            If the destination is a clone, the source may be the origin
1548            snapshot, which must be fully specified (for example,
1549            pool/fs@origin, not just @origin).
1550 
1551        -n  Do a dry-run ("No-op") send. Do not generate any actual send data.
1552            This is useful in conjunction with the -v or -P flags to determine
1553            what data will be sent. In this case, the verbose output will be
1554            written to standard output (contrast with a non-dry-run, where the
1555            stream is written to standard output and the verbose output goes to
1556            standard error).
1557 
1558        -p  Include the dataset's properties in the stream. This flag is
1559            implicit when -R is specified. The receiving system must also
1560            support this feature.
1561 
1562        -v  Print verbose information about the stream package generated. This
1563            information includes a per-second report of how much data has been
1564            sent.
1565 
1566            The format of the stream is committed. You will be able to receive
1567            your streams on future versions of ZFS .
1568 
1569      zfs send [-FLe] [-i snapshot|bookmark] filesystem|volume|snapshot
1570        Generate a send stream, which may be of a filesystem, and may be
1571        incremental from a bookmark. If the destination is a filesystem or
1572        volume, the pool must be read-only, or the filesystem must not be
1573        mounted. When the stream generated from a filesystem or volume is
1574        received, the default snapshot name will be "--head--".
1575 
1576        -L  Generate a stream which may contain blocks larger than 128KB. This
1577            flag has no effect if the large_blocks pool feature is disabled, or
1578            if the recordsize property of this filesystem has never been set
1579            above 128KB. The receiving system must have the large_blocks pool
1580            feature enabled as well. See zpool-features(5) for details on ZFS
1581            feature flags and the large_blocks feature.
1582 
1583        -e  Generate a more compact stream by using WRITE_EMBEDDED records for
1584            blocks which are stored more compactly on disk by the embedded_data
1585            pool feature. This flag has no effect if the embedded_data feature
1586            is disabled. The receiving system must have the embedded_data
1587            feature enabled. If the lz4_compress feature is active on the
1588            sending system, then the receiving system must have that feature
1589            enabled as well. See zpool-features(5) for details on ZFS feature
1590            flags and the embedded_data feature.
1591 
1592        -F  Generate a stream which omits free records.  The stream will be
1593            more compact but the receiving system will not be able to receive
1594            the stream as a clone.
1595 
1596        -i snapshot|bookmark
1597            Generate an incremental send stream. The incremental source must be
1598            an earlier snapshot in the destination's history. It will commonly
1599            be an earlier snapshot in the destination's file system, in which
1600            case it can be specified as the last component of the name (the #
1601            or @ character and following).
1602 
1603            If the incremental target is a clone, the incremental source can be
1604            the origin snapshot, or an earlier snapshot in the origin's
1605            filesystem, or the origin's origin, etc.
1606 
1607      zfs send [-Penv] -t receive_resume_token
1608        Creates a send stream which resumes an interrupted receive.  The
1609        receive_resume_token is the value of this property on the filesystem or
1610        volume that was being received into.  See the documentation for zfs
1611        receive -s for more details.
1612 
1613      zfs receive [-Fnsuv] [-o origin=snapshot] filesystem|volume|snapshot
1614      zfs receive [-Fnsuv] [-d|-e] [-o origin=snapshot] filesystem
1615        Creates a snapshot whose contents are as specified in the stream


2187        The following example shows how to see what has changed between a prior
2188        snapshot of a ZFS dataset and its current state. The -F option is used
2189        to indicate type information for the files affected.
2190 
2191        # zfs diff -F tank/test@before tank/test
2192        M       /       /tank/test/
2193        M       F       /tank/test/linked      (+1)
2194        R       F       /tank/test/oldname -> /tank/test/newname
2195        -       F       /tank/test/deleted
2196        +       F       /tank/test/created
2197        M       F       /tank/test/modified
2198 
2199 INTERFACE STABILITY
2200      Commited.
2201 
2202 SEE ALSO
2203      gzip(1), ssh(1), mount(1M), share(1M), sharemgr(1M), unshare(1M),
2204      zonecfg(1M), zpool(1M), chmod(2), stat(2), write(2), fsync(3C),
2205      dfstab(4), acl(5), attributes(5)
2206 
2207 illumos                        December 29, 2015                       illumos