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
*** 99,111 ****
.Oo Fl s Ar property Oc Ns ...
.Oo Fl S Ar property Oc Ns ...
.Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
.Oo Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Oc Ns ...
.Nm
- .Cm remap
- .Ar filesystem Ns | Ns Ar volume
- .Nm
.Cm set
.Ar property Ns = Ns Ar value Oo Ar property Ns = Ns Ar value Oc Ns ...
.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
.Nm
.Cm get
--- 99,108 ----
*** 166,176 ****
.Nm
.Cm bookmark
.Ar snapshot bookmark
.Nm
.Cm send
! .Op Fl DLPRcenpv
.Op Oo Fl I Ns | Ns Fl i Oc Ar snapshot
.Ar snapshot
.Nm
.Cm send
.Op Fl Lce
--- 163,173 ----
.Nm
.Cm bookmark
.Ar snapshot bookmark
.Nm
.Cm send
! .Op Fl DLPRcenpsv
.Op Oo Fl I Ns | Ns Fl i Oc Ar snapshot
.Ar snapshot
.Nm
.Cm send
.Op Fl Lce
*** 180,197 ****
.Cm send
.Op Fl Penv
.Fl t Ar receive_resume_token
.Nm
.Cm receive
! .Op Fl Fnsuv
! .Op Fl o Sy origin Ns = Ns Ar snapshot
.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
.Nm
.Cm receive
! .Op Fl Fnsuv
.Op Fl d Ns | Ns Fl e
! .Op Fl o Sy origin Ns = Ns Ar snapshot
.Ar filesystem
.Nm
.Cm receive
.Fl A
.Ar filesystem Ns | Ns Ar volume
--- 177,198 ----
.Cm send
.Op Fl Penv
.Fl t Ar receive_resume_token
.Nm
.Cm receive
! .Op Fl FKnsuv
! .Oo Fl l Ar filesystem Ns | Ns Ar volume Oc Ns ...
! .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
! .Oo Fl x Ar property Oc Ns ...
.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
.Nm
.Cm receive
! .Op Fl FKnsuv
.Op Fl d Ns | Ns Fl e
! .Oo Fl l Ar filesystem Ns | Ns Ar volume Oc Ns ...
! .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
! .Oo Fl x Ar property Oc Ns ...
.Ar filesystem
.Nm
.Cm receive
.Fl A
.Ar filesystem Ns | Ns Ar volume
*** 611,620 ****
--- 612,628 ----
see.
However, it does include space consumed by metadata.
.Pp
This property can also be referred to by its shortened column name,
.Sy lused .
+ .It Sy modified
+ For a snapshot, indicates whether the parent filesystem or volume has
+ been modified since the snapshot.
+ This property can be either
+ .Sy yes
+ or
+ .Sy no .
.It Sy mounted
For file systems, indicates whether the file system is currently mounted.
This property can be either
.Sy yes
or
*** 1078,1087 ****
--- 1086,1124 ----
compression algorithm compresses runs of zeros.
.Pp
This property can also be referred to by its shortened column name
.Sy compress .
Changing this property affects only newly-written data.
+ .It Sy smartcompression Ns = Ns Sy on Ns | Ns Sy off
+ Smart compression is a feature which optimizes compression performance
+ on filesystems which contain a mixture of compressible and
+ incompressible data.
+ When
+ .Sy compression
+ is enabled on a filesystem, smart compression dynamically tracks per-file
+ compression ratios to determine if a file is compressible or not.
+ When the compression ratio being achieved is too low, smart compression
+ progressively backs off attempting to compress the file.
+ .Pp
+ The algorithm periodically checks whether new data written to a file
+ previously deemed incompressible is still not compressible and adjusts
+ behavior accordingly.
+ Certain types of files, such as virtual machine disk files or large database
+ files, can contain a mixture of both types of data.
+ Although smart compression tries to detect these situations, in marginal cases
+ it can be too pessimistic, which results in a reduction of the overall
+ compression ratio.
+ In this case, setting the
+ .Sy smartcompression
+ property to
+ .Sy off
+ turns off smart compression
+ on a filesystem, so that data is always compressed regardless of the
+ compression ratio achieved.
+ .Pp
+ The default value is
+ .Sy on .
.It Sy copies Ns = Ns Sy 1 Ns | Ns Sy 2 Ns | Ns Sy 3
Controls the number of copies of data stored for this dataset.
These copies are in addition to any redundancy provided by the pool, for
example, mirroring or RAID-Z.
The copies are stored on different disks, if possible.
*** 1404,1421 ****
Otherwise, the file system is automatically shared and unshared with the
.Nm zfs Cm share
and
.Nm zfs Cm unshare
commands.
! If the property is set to
! .Sy on ,
! the
! .Xr sharemgr 1M
! command is invoked with no options.
! Otherwise, the
! .Xr sharemgr 1M
! command is invoked with options equivalent to the contents of this property.
.Pp
Because SMB shares requires a resource name, a unique resource name is
constructed from the dataset name.
The constructed name is a copy of the dataset name except that the characters in
the dataset name, which would be invalid in the resource name, are replaced with
--- 1441,1453 ----
Otherwise, the file system is automatically shared and unshared with the
.Nm zfs Cm share
and
.Nm zfs Cm unshare
commands.
! See
! .Xr sharesmb 5
! for the share options description.
.Pp
Because SMB shares requires a resource name, a unique resource name is
constructed from the dataset name.
The constructed name is a copy of the dataset name except that the characters in
the dataset name, which would be invalid in the resource name, are replaced with
*** 1475,1491 ****
Otherwise, the file system is automatically shared and unshared with the
.Nm zfs Cm share
and
.Nm zfs Cm unshare
commands.
! If the property is set to
! .Sy on ,
! .Xr share 1M
! command is invoked with no options.
! Otherwise, the
! .Xr share 1M
! command is invoked with options equivalent to the contents of this property.
.Pp
When the
.Sy sharenfs
property is changed for a dataset, the dataset and any children inheriting the
property are re-shared with the new options, only if the property was previously
--- 1507,1519 ----
Otherwise, the file system is automatically shared and unshared with the
.Nm zfs Cm share
and
.Nm zfs Cm unshare
commands.
! See
! .Xr sharenfs 5
! for the share options description.
.Pp
When the
.Sy sharenfs
property is changed for a dataset, the dataset and any children inheriting the
property are re-shared with the new options, only if the property was previously
*** 1598,1607 ****
--- 1626,1648 ----
opened and closed.
In addition to enabling this property, the virus scan service must also be
enabled for virus scanning to occur.
The default value is
.Sy off .
+ .It Sy wbc_mode Ns = Ns Sy on Ns | Ns Sy off
+ Controls the mode of write back cache.
+ After the property has been set on a dataset all the child datasets inherit the
+ property.
+ Due to its recursive nature the property will conflict with any child dataset or
+ any parent dataset having this property enabled as well.
+ The property cannot be set if the target pool does not have special device
+ .Pq special vdev .
+ The default value is
+ .Sy off .
+ This property cannot be enabled together with the
+ .Sy dedup
+ property.
.It Sy xattr Ns = Ns Sy on Ns | Ns Sy off
Controls whether extended attributes are enabled for this file system.
The default value is
.Sy on .
.It Sy zoned Ns = Ns Sy on Ns | Ns Sy off
*** 2395,2414 ****
.Fl S
option was not specified.
.El
.It Xo
.Nm
- .Cm remap
- .Ar filesystem Ns | Ns Ar volume
- .Xc
- Remap the indirect blocks in the given fileystem or volume so that they no
- longer reference blocks on previously removed vdevs and we can eventually
- shrink the size of the indirect mapping objects for the previously removed
- vdevs. Note that remapping all blocks might not be possible and that
- references from snapshots will still exist and cannot be remapped.
- .It Xo
- .Nm
.Cm upgrade
.Xc
Displays a list of file systems that are not the most recent version.
.It Xo
.Nm
--- 2436,2445 ----
*** 2658,2668 ****
.Sy bookmarks
feature.
.It Xo
.Nm
.Cm send
! .Op Fl DLPRcenpv
.Op Oo Fl I Ns | Ns Fl i Oc Ar snapshot
.Ar snapshot
.Xc
Creates a stream representation of the second
.Ar snapshot ,
--- 2689,2699 ----
.Sy bookmarks
feature.
.It Xo
.Nm
.Cm send
! .Op Fl DLPRcenpsv
.Op Oo Fl I Ns | Ns Fl i Oc Ar snapshot
.Ar snapshot
.Xc
Creates a stream representation of the second
.Ar snapshot ,
*** 2730,2739 ****
--- 2761,2776 ----
set when the stream is received.
If the
.Fl F
flag is specified when this stream is received, snapshots and file systems that
do not exist on the sending side are destroyed.
+ If the
+ .Fl K
+ flag is specified in conjunction with
+ .Fl F
+ flag, then it modifies the conventional force-receive behavior to not destroy
+ destination snapshots that are not present at the replication source.
.It Fl e, -embed
Generate a more compact stream by using
.Sy WRITE_EMBEDDED
records for blocks which are stored more compactly on disk by the
.Sy embedded_data
*** 2812,2821 ****
--- 2849,2867 ----
Include the dataset's properties in the stream.
This flag is implicit when
.Fl R
is specified.
The receiving system must also support this feature.
+ .It Fl s
+ Calculate send stream size.
+ Do not generate any actual send data.
+ This is useful when one needs to know stream size in order to store the stream
+ externally.
+ With
+ .Fl v
+ specified, provides info on stream header and stream data portion sizes, in
+ addition to the total stream size.
.It Fl v, -verbose
Print verbose information about the stream package generated.
This information includes a per-second report of how much data has been sent.
.Pp
The format of the stream is committed.
*** 2923,2942 ****
.Sy zfs receive -s
for more details.
.It Xo
.Nm
.Cm receive
! .Op Fl Fnsuv
! .Op Fl o Sy origin Ns = Ns Ar snapshot
.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
.Xc
.It Xo
.Nm
.Cm receive
! .Op Fl Fnsuv
.Op Fl d Ns | Ns Fl e
! .Op Fl o Sy origin Ns = Ns Ar snapshot
.Ar filesystem
.Xc
Creates a snapshot whose contents are as specified in the stream provided on
standard input.
If a full stream is received, then a new file system is created as well.
--- 2969,2992 ----
.Sy zfs receive -s
for more details.
.It Xo
.Nm
.Cm receive
! .Op Fl FKsnuv
! .Oo Fl l Ar filesystem Ns | Ns Ar volume Oc Ns ...
! .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
! .Oo Fl x Ar property Oc Ns ...
.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
.Xc
.It Xo
.Nm
.Cm receive
! .Op Fl FKnsuv
.Op Fl d Ns | Ns Fl e
! .Oo Fl l Ar filesystem Ns | Ns Ar volume Oc Ns ...
! .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
! .Oo Fl x Ar property Oc Ns ...
.Ar filesystem
.Xc
Creates a snapshot whose contents are as specified in the stream provided on
standard input.
If a full stream is received, then a new file system is created as well.
*** 3015,3037 ****
--- 3065,3107 ----
If receiving an incremental replication stream
.Po for example, one generated by
.Nm zfs Cm send Fl R Op Fl i Ns | Ns Fl I
.Pc ,
destroy snapshots and file systems that do not exist on the sending side.
+ .It Fl K
+ When force receive is enabled, do not destroy snapshots on the receiving side
+ that do not exist on the sending side.
.It Fl d
Discard the first element of the sent snapshot's file system name, using the
remaining elements to determine the name of the target file system for the new
snapshot as described in the paragraph above.
.It Fl e
Discard all but the last element of the sent snapshot's file system name, using
that element to determine the name of the target file system for the new
snapshot as described in the paragraph above.
+ .It Fl l Ar filesystem Ns | Ns Ar volume
+ Limits the receive to only the
+ .Ar filesystem
+ or
+ .Ar volume
+ specified.
+ As multiple options may be specified, this can be used to restore specific
+ filesystems or volumes from the received stream.
.It Fl n
Do not actually receive the stream.
This can be useful in conjunction with the
.Fl v
option to verify the name the receive operation would use.
+ .It Fl o Ar property Ns = Ns Ar value
+ Sets the specified
+ .Ar property
+ to
+ .Ar value
+ during receive of the stream.
+ Specifying multiple
+ .Fl o
+ options is allowed.
.It Fl o Sy origin Ns = Ns Ar snapshot
Forces the stream to be received as a clone of the given snapshot.
If the stream is a full send stream, this will create the filesystem
described by the stream as a clone of the specified snapshot.
Which snapshot was specified will not affect the success or failure of the
*** 3041,3050 ****
--- 3111,3126 ----
.It Fl u
File system that is associated with the received stream is not mounted.
.It Fl v
Print verbose information about the stream and the time required to perform the
receive operation.
+ .It Fl x Ar property
+ Excludes the specified property from the received stream as if it was not
+ included in the send stream.
+ Specifying multiple
+ .Fl x
+ options is allowed.
.It Fl s
If the receive is interrupted, save the partially received state, rather
than deleting it.
Interruption may be due to premature termination of the stream
.Po e.g. due to network failure or failure of the remote system
*** 3861,3877 ****
.Sy Committed .
.Sh SEE ALSO
.Xr gzip 1 ,
.Xr ssh 1 ,
.Xr mount 1M ,
- .Xr share 1M ,
.Xr sharemgr 1M ,
- .Xr unshare 1M ,
.Xr zonecfg 1M ,
.Xr zpool 1M ,
.Xr chmod 2 ,
.Xr stat 2 ,
.Xr write 2 ,
.Xr fsync 3C ,
.Xr dfstab 4 ,
.Xr acl 5 ,
! .Xr attributes 5
--- 3937,3953 ----
.Sy Committed .
.Sh SEE ALSO
.Xr gzip 1 ,
.Xr ssh 1 ,
.Xr mount 1M ,
.Xr sharemgr 1M ,
.Xr zonecfg 1M ,
.Xr zpool 1M ,
.Xr chmod 2 ,
.Xr stat 2 ,
.Xr write 2 ,
.Xr fsync 3C ,
.Xr dfstab 4 ,
.Xr acl 5 ,
! .Xr attributes 5 ,
! .Xr sharenfs 5 ,
! .Xr sharesmb 5