Print this page 
NEX-15425 rework share man pages
Reviewed by: Roman Strashkin <roman.strashkin@nexenta.com>
Reviewed by: Matt Barden <matt.barden@nexenta.com>
Reviewed by: Evan Layton <evan.layton@nexenta.com>
NEX-15425 rework share man pages
Reviewed by: Roman Strashkin <roman.strashkin@nexenta.com>
Reviewed by: Matt Barden <matt.barden@nexenta.com>
Reviewed by: Evan Layton <evan.layton@nexenta.com>
NEX-9406 Add a property to show that a dataset has been modified since a snapshot
Reviewed by: Alexey Komarov <alexey.komarov@nexenta.com>
Reviewed by: Sanjay Nadkarni <sanjay.nadkarni@nexenta.com>
NEX-5728 Autosync Destination retention policy not being honoured
Reviewed by: Roman Strashkin <roman.strashkin@nexenta.com>
Reviewed by: Sanjay Nadkarni <sanjay.nadkarni@nexenta.com>
NEX-5795 Rename 'wrc' as 'wbc' in the source and in the tech docs
Reviewed by: Alex Aizman <alex.aizman@nexenta.com>
Reviewed by: Sanjay Nadkarni <sanjay.nadkarni@nexenta.com>
Reviewed by: Alek Pinchuk <alek.pinchuk@nexenta.com>
NEX-5060 WBC: Writecache and deduplication should not be used together
Reviewed by: Alex Aizman <alex.aizman@nexenta.com>
Reviewed by: Saso Kiselkov <saso.kiselkov@nexenta.com>
NEX-5058 WBC: Race between the purging of window and opening new one
Reviewed by: Alek Pinchuk <alek.pinchuk@nexenta.com>
Reviewed by: Alex Aizman <alex.aizman@nexenta.com>
NEX-2830 ZFS smart compression
Reviewed by: Alek Pinchuk <alek.pinchuk@nexenta.com>
Reviewed by: Roman Strashkin <roman.strashkin@nexenta.com>
6358 A faulted pool with only unavailable vdevs triggers assertion failure in libzfs
Reviewed by: Matthew Ahrens <mahrens@delphix.com>
Reviewed by: Andrew Stormont <andyjstormont@gmail.com>
Reviewed by: Serban Maduta <serban.maduta@gmail.com>
Approved by: Dan McDonald <danmcd@omniti.com>
6393 zfs receive a full send as a clone
Reviewed by: Matthew Ahrens <mahrens@delphix.com>
Reviewed by: Prakash Surya <prakash.surya@delphix.com>
Reviewed by: Richard Elling <Richard.Elling@RichardElling.com>
Approved by: Dan McDonald <danmcd@omniti.com>
6434 sa_find_sizes() may compute wrong SA header size
Reviewed-by: Ned Bass <bass6@llnl.gov>
Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed by: Andriy Gapon <avg@freebsd.org>
Reviewed by: Matthew Ahrens <mahrens@delphix.com>
Approved by: Robert Mustacchi <rm@joyent.com>
6346 zfs(1M) has spurious comma
Reviewed by: Garrett D'Amore <garrett@damore.org>
Reviewed by: Igor Kozhukhov <ikozhukhov@gmail.com>
Reviewed by: Robert Mustacchi <rm@joyent.com>
Approved by: Gordon Ross <gwr@nexenta.com>
2605 want to resume interrupted zfs send
Reviewed by: George Wilson <george.wilson@delphix.com>
Reviewed by: Paul Dagnelie <pcd@delphix.com>
Reviewed by: Richard Elling <Richard.Elling@RichardElling.com>
Reviewed by: Xin Li <delphij@freebsd.org>
Reviewed by: Arne Jansen <sensille@gmx.net>
Approved by: Dan McDonald <danmcd@omniti.com>
4185 add new cryptographic checksums to ZFS: SHA-512, Skein, Edon-R (fix studio build)
4185 add new cryptographic checksums to ZFS: SHA-512, Skein, Edon-R
Reviewed by: George Wilson <george.wilson@delphix.com>
Reviewed by: Prakash Surya <prakash.surya@delphix.com>
Reviewed by: Saso Kiselkov <saso.kiselkov@nexenta.com>
Reviewed by: Richard Lowe <richlowe@richlowe.net>
Approved by: Garrett D'Amore <garrett@damore.org>
NEX-4582 update wrc test cases for allow to use write back cache per tree of datasets
Reviewed by: Steve Peng <steve.peng@nexenta.com>
Reviewed by: Alex Aizman <alex.aizman@nexenta.com>
5960 zfs recv should prefetch indirect blocks
5925 zfs receive -o origin=
Reviewed by: Prakash Surya <prakash.surya@delphix.com>
Reviewed by: Matthew Ahrens <mahrens@delphix.com>
5409 Remove shareiscsi description and example from zfs(1M)
5988 zfs(1M) diff is excessively indented
Reviewed by: Matthew Ahrens <mahrens@delphix.com>
Approved by: Gordon Ross <gwr@nexenta.com>
5745 zfs set allows only one dataset property to be set at a time
Reviewed by: Christopher Siden <christopher.siden@delphix.com>
Reviewed by: George Wilson <george@delphix.com>
Reviewed by: Matthew Ahrens <mahrens@delphix.com>
Reviewed by: Bayard Bell <buffer.g.overflow@gmail.com>
Reviewed by: Richard PALO <richard@NetBSD.org>
Reviewed by: Steven Hartland <killing@multiplay.co.uk>
Approved by: Rich Lowe <richlowe@richlowe.net>
5764 "zfs send -nv" directs output to stderr
Reviewed by: Matthew Ahrens <mahrens@delphix.com>
Reviewed by: Paul Dagnelie <paul.dagnelie@delphix.com>
Reviewed by: Basil Crow <basil.crow@delphix.com>
Reviewed by: Steven Hartland <killing@multiplay.co.uk>
Reviewed by: Bayard Bell <buffer.g.overflow@gmail.com>
Approved by: Dan McDonald <danmcd@omniti.com>
NEX-4476 WRC: Allow to use write back cache per tree of datasets
Reviewed by: Alek Pinchuk <alek.pinchuk@nexenta.com>
Reviewed by: Alex Aizman <alex.aizman@nexenta.com>
Revert "NEX-4476 WRC: Allow to use write back cache per tree of datasets"
This reverts commit fe97b74444278a6f36fec93179133641296312da.
NEX-4476 WRC: Allow to use write back cache per tree of datasets
Reviewed by: Alek Pinchuk <alek.pinchuk@nexenta.com>
Reviewed by: Alex Aizman <alex.aizman@nexenta.com>
NEX-4028 use lz4 by default
Reviewed by: Saso Kiselkov <saso.kiselkov@nexenta.com>
Reviewed by: Alek Pinchuk <alek.pinchuk@nexenta.com>
NEX-1456 Part 2, port FreeBSD patch - new zfs recv options support
SUP-817 Further clean-up of zfs manpage
OS-123 aclinherit=restricted masks inherited permissions by group perms (groupmask)
OS-102 add man page info and tests for vdev/CoS properties and ZFS meta features
re #11781 rb3701 Update man related tools (add missed files)
re #11781 rb3701 Update man related tools
--HG--
rename : usr/src/cmd/man/src/THIRDPARTYLICENSE => usr/src/cmd/man/THIRDPARTYLICENSE
rename : usr/src/cmd/man/src/THIRDPARTYLICENSE.descrip => usr/src/cmd/man/THIRDPARTYLICENSE.descrip
rename : usr/src/cmd/man/src/man.c => usr/src/cmd/man/man.c
Bug 10481 - Dry run option in 'zfs send' isn't the same as in NexentaStor 3.1
Split Close
Expand all
Collapse all
          --- old/usr/src/man/man1m/zfs.1m.man.txt
          +++ new/usr/src/man/man1m/zfs.1m.man.txt
↓ open down ↓ 12 lines elided ↑ open up ↑ 
  13   13       zfs snapshot [-r] [-o property=value]...
  14   14           filesystem@snapname|volume@snapname...
  15   15       zfs rollback [-Rfr] snapshot
  16   16       zfs clone [-p] [-o property=value]... snapshot filesystem|volume
  17   17       zfs promote clone-filesystem
  18   18       zfs rename [-f] filesystem|volume|snapshot filesystem|volume|snapshot
  19   19       zfs rename [-fp] filesystem|volume filesystem|volume
  20   20       zfs rename -r snapshot snapshot
  21   21       zfs list [-r|-d depth] [-Hp] [-o property[,property]...] [-s property]...
  22   22           [-S property]... [-t type[,type]...] [filesystem|volume|snapshot]...
  23      -     zfs remap filesystem|volume
  24   23       zfs set property=value [property=value]... filesystem|volume|snapshot...
  25   24       zfs get [-r|-d depth] [-Hp] [-o field[,field]...] [-s source[,source]...]
  26   25           [-t type[,type]...] all | property[,property]...
  27   26           filesystem|volume|snapshot|bookmark...
  28   27       zfs inherit [-rS] property filesystem|volume|snapshot...
  29   28       zfs upgrade
  30   29       zfs upgrade -v
  31   30       zfs upgrade [-r] [-V version] -a | filesystem
  32   31       zfs userspace [-Hinp] [-o field[,field]...] [-s field]... [-S field]...
  33   32           [-t type[,type]...] filesystem|snapshot
  34   33       zfs groupspace [-Hinp] [-o field[,field]...] [-s field]... [-S field]...
  35   34           [-t type[,type]...] filesystem|snapshot
  36   35       zfs mount
  37   36       zfs mount [-Ov] [-o options] -a | filesystem
  38   37       zfs unmount [-f] -a | filesystem|mountpoint
  39   38       zfs share -a | filesystem
  40   39       zfs unshare -a | filesystem|mountpoint
  41   40       zfs bookmark snapshot bookmark
  42      -     zfs send [-DLPRcenpv] [[-I|-i] snapshot] snapshot
       41 +     zfs send [-DLPRcenpsv] [[-I|-i] snapshot] snapshot
  43   42       zfs send [-Lce] [-i snapshot|bookmark] filesystem|volume|snapshot
  44   43       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
       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
  47   48       zfs receive -A filesystem|volume
  48   49       zfs allow filesystem|volume
  49   50       zfs allow [-dglu] user|group[,user|group]...
  50   51           perm|@setname[,perm|@setname]... filesystem|volume
  51   52       zfs allow [-dl] -e|everyone perm|@setname[,perm|@setname]...
  52   53           filesystem|volume
  53   54       zfs allow -c perm|@setname[,perm|@setname]... filesystem|volume
  54   55       zfs allow -s @setname perm|@setname[,perm|@setname]... filesystem|volume
  55   56       zfs unallow [-dglru] user|group[,user|group]...
  56   57           [perm|@setname[,perm|@setname]...] filesystem|volume
↓ open down ↓ 218 lines elided ↑ open up ↑ 
 275  276                             this dataset and all its descendents.  See the used
 276  277                             property.  The logical space ignores the effect of
 277  278                             the compression and copies properties, giving a
 278  279                             quantity closer to the amount of data that
 279  280                             applications see.  However, it does include space
 280  281                             consumed by metadata.
 281  282  
 282  283                             This property can also be referred to by its
 283  284                             shortened column name, lused.
 284  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 +
 285  290       mounted               For file systems, indicates whether the file system
 286  291                             is currently mounted.  This property can be either
 287  292                             yes or no.
 288  293  
 289  294       origin                For cloned file systems or volumes, the snapshot
 290  295                             from which the clone was created.  See also the
 291  296                             clones property.
 292  297  
 293  298       receive_resume_token  For filesystems or volumes which have saved
 294  299                             partially-completed state from zfs receive -s, this
↓ open down ↓ 271 lines elided ↑ open up ↑ 
 566  571         command.  You can specify the gzip level by using the value gzip-N,
 567  572         where N is an integer from 1 (fastest) to 9 (best compression ratio).
 568  573         Currently, gzip is equivalent to gzip-6 (which is also the default for
 569  574         gzip(1)).
 570  575  
 571  576         The zle compression algorithm compresses runs of zeros.
 572  577  
 573  578         This property can also be referred to by its shortened column name
 574  579         compress.  Changing this property affects only newly-written data.
 575  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 +
 576  603       copies=1|2|3
 577  604         Controls the number of copies of data stored for this dataset.  These
 578  605         copies are in addition to any redundancy provided by the pool, for
 579  606         example, mirroring or RAID-Z.  The copies are stored on different
 580  607         disks, if possible.  The space used by multiple copies is charged to
 581  608         the associated file and dataset, changing the used property and
 582  609         counting against quotas and reservations.
 583  610  
 584  611         Changing this property only affects newly-written data.  Therefore, set
 585  612         this property at file system creation time by using the -o copies=N
↓ open down ↓ 192 lines elided ↑ open up ↑ 
 778  805  
 779  806       setuid=on|off
 780  807         Controls whether the setuid bit is respected for the file system.  The
 781  808         default value is on.
 782  809  
 783  810       sharesmb=on|off|opts
 784  811         Controls whether the file system is shared via SMB, and what options
 785  812         are to be used.  A file system with the sharesmb property set to off is
 786  813         managed through traditional tools such as sharemgr(1M).  Otherwise, the
 787  814         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.
      815 +       zfs unshare commands.  See sharesmb(5) for the share options
      816 +       description.
 792  817  
 793  818         Because SMB shares requires a resource name, a unique resource name is
 794  819         constructed from the dataset name.  The constructed name is a copy of
 795  820         the dataset name except that the characters in the dataset name, which
 796  821         would be invalid in the resource name, are replaced with underscore (_)
 797  822         characters.  A pseudo property "name" is also supported that allows you
 798  823         to replace the data set name with a specified name.  The specified name
 799  824         is then used to replace the prefix dataset in the case of inheritance.
 800  825         For example, if the dataset data/home/john is set to name=john, then
 801  826         data/home/john has a resource name of john.  If a child dataset
↓ open down ↓ 8 lines elided ↑ open up ↑ 
 810  835         any children inheriting the property are re-shared with the new
 811  836         options, only if the property was previously set to off, or if they
 812  837         were shared before the property was changed.  If the new property is
 813  838         set to off, the file systems are unshared.
 814  839  
 815  840       sharenfs=on|off|opts
 816  841         Controls whether the file system is shared via NFS, and what options
 817  842         are to be used.  A file system with a sharenfs property of off is
 818  843         managed through traditional tools such as share(1M), unshare(1M), and
 819  844         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.
      845 +       unshared with the zfs share and zfs unshare commands.  See sharenfs(5)
      846 +       for the share options description.
 824  847  
 825  848         When the sharenfs property is changed for a dataset, the dataset and
 826  849         any children inheriting the property are re-shared with the new
 827  850         options, only if the property was previously off, or if they were
 828  851         shared before the property was changed.  If the new property is off,
 829  852         the file systems are unshared.
 830  853  
 831  854       logbias=latency|throughput
 832  855         Provide a hint to ZFS about handling of synchronous requests in this
 833  856         dataset.  If logbias is set to latency (the default), ZFS will use pool
↓ open down ↓ 49 lines elided ↑ open up ↑ 
 883  906         less then the volume size.  Consequently, writes to a sparse volume can
 884  907         fail with ENOSPC when the pool is low on space.  For a sparse volume,
 885  908         changes to volsize are not reflected in the reservation.
 886  909  
 887  910       vscan=on|off
 888  911         Controls whether regular files should be scanned for viruses when a
 889  912         file is opened and closed.  In addition to enabling this property, the
 890  913         virus scan service must also be enabled for virus scanning to occur.
 891  914         The default value is off.
 892  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 +
 893  925       xattr=on|off
 894  926         Controls whether extended attributes are enabled for this file system.
 895  927         The default value is on.
 896  928  
 897  929       zoned=on|off
 898  930         Controls whether the dataset is managed from a non-global zone.  See
 899  931         the Zones section for more information.  The default value is off.
 900  932  
 901  933       The following three properties cannot be changed after the file system is
 902  934       created, and therefore, should be set when the file system is created.
↓ open down ↓ 445 lines elided ↑ open up ↑ 
1348 1380         ancestor, restored to default if no ancestor has the property set, or
1349 1381         with the -S option reverted to the received value if one exists.  See
1350 1382         the Properties section for a listing of default values, and details on
1351 1383         which properties can be inherited.
1352 1384  
1353 1385         -r  Recursively inherit the given property for all children.
1354 1386  
1355 1387         -S  Revert the property to the received value if one exists; otherwise
1356 1388             operate as if the -S option was not specified.
1357 1389  
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 1390       zfs upgrade
1367 1391         Displays a list of file systems that are not the most recent version.
1368 1392  
1369 1393       zfs upgrade -v
1370 1394         Displays a list of currently supported file system versions.
1371 1395  
1372 1396       zfs upgrade [-r] [-V version] -a | filesystem
1373 1397         Upgrades file systems to a new on-disk version.  Once this is done, the
1374 1398         file systems will no longer be accessible on systems running older
1375 1399         versions of the software.  zfs send streams generated from new
↓ open down ↓ 121 lines elided ↑ open up ↑ 
1497 1521             path to a ZFS file system shared on the system.
1498 1522  
1499 1523       zfs bookmark snapshot bookmark
1500 1524         Creates a bookmark of the given snapshot.  Bookmarks mark the point in
1501 1525         time when the snapshot was created, and can be used as the incremental
1502 1526         source for a zfs send command.
1503 1527  
1504 1528         This feature must be enabled to be used.  See zpool-features(5) for
1505 1529         details on ZFS feature flags and the bookmarks feature.
1506 1530  
1507      -     zfs send [-DLPRcenpv] [[-I|-i] snapshot] snapshot
     1531 +     zfs send [-DLPRcenpsv] [[-I|-i] snapshot] snapshot
1508 1532         Creates a stream representation of the second snapshot, which is
1509 1533         written to standard output.  The output can be redirected to a file or
1510 1534         to a different system (for example, using ssh(1)).  By default, a full
1511 1535         stream is generated.
1512 1536  
1513 1537         -D, --dedup
1514 1538             Generate a deduplicated stream.  Blocks which would have been sent
1515 1539             multiple times in the send stream will only be sent once.  The
1516 1540             receiving system must also support this feature to receive a
1517 1541             deduplicated stream.  This flag can be used regardless of the
↓ open down ↓ 22 lines elided ↑ open up ↑ 
1540 1564             Generate a replication stream package, which will replicate the
1541 1565             specified file system, and all descendent file systems, up to the
1542 1566             named snapshot.  When received, all properties, snapshots,
1543 1567             descendent file systems, and clones are preserved.
1544 1568  
1545 1569             If the -i or -I flags are used in conjunction with the -R flag, an
1546 1570             incremental replication stream is generated.  The current values of
1547 1571             properties, and current snapshot and file system names are set when
1548 1572             the stream is received.  If the -F flag is specified when this
1549 1573             stream is received, snapshots and file systems that do not exist on
1550      -           the sending side are destroyed.
     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.
1551 1578  
1552 1579         -e, --embed
1553 1580             Generate a more compact stream by using WRITE_EMBEDDED records for
1554 1581             blocks which are stored more compactly on disk by the embedded_data
1555 1582             pool feature.  This flag has no effect if the embedded_data feature
1556 1583             is disabled.  The receiving system must have the embedded_data
1557 1584             feature enabled.  If the lz4_compress feature is active on the
1558 1585             sending system, then the receiving system must have that feature
1559 1586             enabled as well.  See zpool-features(5) for details on ZFS feature
1560 1587             flags and the embedded_data feature.
↓ open down ↓ 26 lines elided ↑ open up ↑ 
1587 1614             what data will be sent.  In this case, the verbose output will be
1588 1615             written to standard output (contrast with a non-dry-run, where the
1589 1616             stream is written to standard output and the verbose output goes to
1590 1617             standard error).
1591 1618  
1592 1619         -p, --props
1593 1620             Include the dataset's properties in the stream.  This flag is
1594 1621             implicit when -R is specified.  The receiving system must also
1595 1622             support this feature.
1596 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 +
1597 1630         -v, --verbose
1598 1631             Print verbose information about the stream package generated.  This
1599 1632             information includes a per-second report of how much data has been
1600 1633             sent.
1601 1634  
1602 1635             The format of the stream is committed.  You will be able to receive
1603 1636             your streams on future versions of ZFS .
1604 1637  
1605 1638       zfs send [-Lce] [-i snapshot|bookmark] filesystem|volume|snapshot
1606 1639         Generate a send stream, which may be of a filesystem, and may be
↓ open down ↓ 40 lines elided ↑ open up ↑ 
1647 1680             If the incremental target is a clone, the incremental source can be
1648 1681             the origin snapshot, or an earlier snapshot in the origin's
1649 1682             filesystem, or the origin's origin, etc.
1650 1683  
1651 1684       zfs send [-Penv] -t receive_resume_token
1652 1685         Creates a send stream which resumes an interrupted receive.  The
1653 1686         receive_resume_token is the value of this property on the filesystem or
1654 1687         volume that was being received into.  See the documentation for zfs
1655 1688         receive -s for more details.
1656 1689  
1657      -     zfs receive [-Fnsuv] [-o origin=snapshot] filesystem|volume|snapshot
     1690 +     zfs receive [-FKsnuv] [-l filesystem|volume]... [-o property=value]...
     1691 +       [-x property]... filesystem|volume|snapshot
1658 1692  
1659      -     zfs receive [-Fnsuv] [-d|-e] [-o origin=snapshot] filesystem
     1693 +     zfs receive [-FKnsuv] [-d|-e] [-l filesystem|volume]... [-o
     1694 +       property=value]... [-x property]... filesystem
1660 1695         Creates a snapshot whose contents are as specified in the stream
1661 1696         provided on standard input.  If a full stream is received, then a new
1662 1697         file system is created as well.  Streams are created using the zfs send
1663 1698         subcommand, which by default creates a full stream.  zfs recv can be
1664 1699         used as an alias for zfs receive.
1665 1700  
1666 1701         If an incremental stream is received, then the destination file system
1667 1702         must already exist, and its most recent snapshot must match the
1668 1703         incremental stream's source.  For zvols, the destination device link is
1669 1704         destroyed and recreated, which means the zvol cannot be accessed during
↓ open down ↓ 23 lines elided ↑ open up ↑ 
1693 1728         then only the last element of the sent snapshot's file system name
1694 1729         (i.e. the name of the source file system itself) is used as the target
1695 1730         file system name.
1696 1731  
1697 1732         -F  Force a rollback of the file system to the most recent snapshot
1698 1733             before performing the receive operation.  If receiving an
1699 1734             incremental replication stream (for example, one generated by zfs
1700 1735             send -R [-i|-I]), destroy snapshots and file systems that do not
1701 1736             exist on the sending side.
1702 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 +
1703 1741         -d  Discard the first element of the sent snapshot's file system name,
1704 1742             using the remaining elements to determine the name of the target
1705 1743             file system for the new snapshot as described in the paragraph
1706 1744             above.
1707 1745  
1708 1746         -e  Discard all but the last element of the sent snapshot's file system
1709 1747             name, using that element to determine the name of the target file
1710 1748             system for the new snapshot as described in the paragraph above.
1711 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 +
1712 1755         -n  Do not actually receive the stream.  This can be useful in
1713 1756             conjunction with the -v option to verify the name the receive
1714 1757             operation would use.
1715 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 +
1716 1763         -o origin=snapshot
1717 1764             Forces the stream to be received as a clone of the given snapshot.
1718 1765             If the stream is a full send stream, this will create the
1719 1766             filesystem described by the stream as a clone of the specified
1720 1767             snapshot.  Which snapshot was specified will not affect the success
1721 1768             or failure of the receive, as long as the snapshot does exist.  If
1722 1769             the stream is an incremental send stream, all the normal
1723 1770             verification will be performed.
1724 1771  
1725 1772         -u  File system that is associated with the received stream is not
1726 1773             mounted.
1727 1774  
1728 1775         -v  Print verbose information about the stream and the time required to
1729 1776             perform the receive operation.
1730 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 +
1731 1783         -s  If the receive is interrupted, save the partially received state,
1732 1784             rather than deleting it.  Interruption may be due to premature
1733 1785             termination of the stream (e.g. due to network failure or failure
1734 1786             of the remote system if the stream is being read over a network
1735 1787             connection), a checksum error in the stream, termination of the zfs
1736 1788             receive process, or unclean shutdown of the system.
1737 1789  
1738 1790             The receive can be resumed with a stream generated by zfs send -t
1739 1791             token, where the token is the value of the receive_resume_token
1740 1792             property of the filesystem or volume which is received into.
↓ open down ↓ 545 lines elided ↑ open up ↑ 
2286 2338         M       F       /tank/test/linked      (+1)
2287 2339         R       F       /tank/test/oldname -> /tank/test/newname
2288 2340         -       F       /tank/test/deleted
2289 2341         +       F       /tank/test/created
2290 2342         M       F       /tank/test/modified
2291 2343  
2292 2344  INTERFACE STABILITY
2293 2345       Committed.
2294 2346  
2295 2347  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)
     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)
2299 2351  
2300 2352  illumos                        December 6, 2017                        illumos
    
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX