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
@@ -18,11 +18,10 @@
zfs rename [-f] filesystem|volume|snapshot filesystem|volume|snapshot
zfs rename [-fp] filesystem|volume filesystem|volume
zfs rename -r snapshot snapshot
zfs list [-r|-d depth] [-Hp] [-o property[,property]...] [-s property]...
[-S property]... [-t type[,type]...] [filesystem|volume|snapshot]...
- zfs remap filesystem|volume
zfs set property=value [property=value]... filesystem|volume|snapshot...
zfs get [-r|-d depth] [-Hp] [-o field[,field]...] [-s source[,source]...]
[-t type[,type]...] all | property[,property]...
filesystem|volume|snapshot|bookmark...
zfs inherit [-rS] property filesystem|volume|snapshot...
@@ -37,15 +36,17 @@
zfs mount [-Ov] [-o options] -a | filesystem
zfs unmount [-f] -a | filesystem|mountpoint
zfs share -a | filesystem
zfs unshare -a | filesystem|mountpoint
zfs bookmark snapshot bookmark
- zfs send [-DLPRcenpv] [[-I|-i] snapshot] snapshot
+ zfs send [-DLPRcenpsv] [[-I|-i] snapshot] snapshot
zfs send [-Lce] [-i snapshot|bookmark] filesystem|volume|snapshot
zfs send [-Penv] -t receive_resume_token
- zfs receive [-Fnsuv] [-o origin=snapshot] filesystem|volume|snapshot
- zfs receive [-Fnsuv] [-d|-e] [-o origin=snapshot] filesystem
+ zfs receive [-FKnsuv] [-l filesystem|volume]... [-o property=value]...
+ [-x property]... filesystem|volume|snapshot
+ zfs receive [-FKnsuv] [-d|-e] [-l filesystem|volume]...
+ [-o property=value]... [-x property]... filesystem
zfs receive -A filesystem|volume
zfs allow filesystem|volume
zfs allow [-dglu] user|group[,user|group]...
perm|@setname[,perm|@setname]... filesystem|volume
zfs allow [-dl] -e|everyone perm|@setname[,perm|@setname]...
@@ -280,10 +281,14 @@
consumed by metadata.
This property can also be referred to by its
shortened column name, lused.
+ modified For a snapshot, indicates whether the parent
+ filesystem or volume has been modified since the
+ snapshot. This property can be either yes or no.
+
mounted For file systems, indicates whether the file system
is currently mounted. This property can be either
yes or no.
origin For cloned file systems or volumes, the snapshot
@@ -571,10 +576,32 @@
The zle compression algorithm compresses runs of zeros.
This property can also be referred to by its shortened column name
compress. Changing this property affects only newly-written data.
+ smartcompression=on|off
+ Smart compression is a feature which optimizes compression performance
+ on filesystems which contain a mixture of compressible and
+ incompressible data. When 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.
+
+ 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
+ smartcompression property to off turns off smart compression on a
+ filesystem, so that data is always compressed regardless of the
+ compression ratio achieved.
+
+ The default value is on.
+
copies=1|2|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. The space used by multiple copies is charged to
@@ -783,14 +810,12 @@
sharesmb=on|off|opts
Controls whether the file system is shared via SMB, and what options
are to be used. A file system with the sharesmb property set to off is
managed through traditional tools such as sharemgr(1M). Otherwise, the
file system is automatically shared and unshared with the zfs share and
- zfs unshare commands. If the property is set to on, the sharemgr(1M)
- command is invoked with no options. Otherwise, the sharemgr(1M)
- command is invoked with options equivalent to the contents of this
- property.
+ zfs unshare commands. See sharesmb(5) for the share options
+ description.
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 underscore (_)
@@ -815,14 +840,12 @@
sharenfs=on|off|opts
Controls whether the file system is shared via NFS, and what options
are to be used. A file system with a sharenfs property of off is
managed through traditional tools such as share(1M), unshare(1M), and
dfstab(4). Otherwise, the file system is automatically shared and
- unshared with the zfs share and zfs unshare commands. If the property
- is set to on, share(1M) command is invoked with no options. Otherwise,
- the share(1M) command is invoked with options equivalent to the
- contents of this property.
+ unshared with the zfs share and zfs unshare commands. See sharenfs(5)
+ for the share options description.
When the 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 off, or if they were
shared before the property was changed. If the new property is off,
@@ -888,10 +911,19 @@
Controls whether regular files should be scanned for viruses when a
file is 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 off.
+ wbc_mode=on|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 (special
+ vdev). The default value is off. This property cannot be enabled
+ together with the dedup property.
+
xattr=on|off
Controls whether extended attributes are enabled for this file system.
The default value is on.
zoned=on|off
@@ -1353,18 +1385,10 @@
-r Recursively inherit the given property for all children.
-S Revert the property to the received value if one exists; otherwise
operate as if the -S option was not specified.
- zfs remap filesystem|volume
- 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.
-
zfs upgrade
Displays a list of file systems that are not the most recent version.
zfs upgrade -v
Displays a list of currently supported file system versions.
@@ -1502,11 +1526,11 @@
source for a zfs send command.
This feature must be enabled to be used. See zpool-features(5) for
details on ZFS feature flags and the bookmarks feature.
- zfs send [-DLPRcenpv] [[-I|-i] snapshot] snapshot
+ zfs send [-DLPRcenpsv] [[-I|-i] snapshot] snapshot
Creates a stream representation of the second snapshot, which is
written to standard output. The output can be redirected to a file or
to a different system (for example, using ssh(1)). By default, a full
stream is generated.
@@ -1545,11 +1569,14 @@
If the -i or -I flags are used in conjunction with the -R flag, an
incremental replication stream is generated. The current values of
properties, and current snapshot and file system names are set when
the stream is received. If the -F flag is specified when this
stream is received, snapshots and file systems that do not exist on
- the sending side are destroyed.
+ the sending side are destroyed. If the -K flag is specified in
+ conjunction with -F flag, then it modifies the conventional force-
+ receive behavior to not destroy destination snapshots that are not
+ present at the replication source.
-e, --embed
Generate a more compact stream by using WRITE_EMBEDDED records for
blocks which are stored more compactly on disk by the embedded_data
pool feature. This flag has no effect if the embedded_data feature
@@ -1592,10 +1619,16 @@
-p, --props
Include the dataset's properties in the stream. This flag is
implicit when -R is specified. The receiving system must also
support this feature.
+ -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 -v specified, provides info on stream
+ header and stream data portion sizes, in addition to the total
+ stream size.
+
-v, --verbose
Print verbose information about the stream package generated. This
information includes a per-second report of how much data has been
sent.
@@ -1652,13 +1685,15 @@
Creates a send stream which resumes an interrupted receive. The
receive_resume_token is the value of this property on the filesystem or
volume that was being received into. See the documentation for zfs
receive -s for more details.
- zfs receive [-Fnsuv] [-o origin=snapshot] filesystem|volume|snapshot
+ zfs receive [-FKsnuv] [-l filesystem|volume]... [-o property=value]...
+ [-x property]... filesystem|volume|snapshot
- zfs receive [-Fnsuv] [-d|-e] [-o origin=snapshot] filesystem
+ zfs receive [-FKnsuv] [-d|-e] [-l filesystem|volume]... [-o
+ property=value]... [-x property]... filesystem
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. Streams are created using the zfs send
subcommand, which by default creates a full stream. zfs recv can be
used as an alias for zfs receive.
@@ -1698,23 +1733,35 @@
before performing the receive operation. If receiving an
incremental replication stream (for example, one generated by zfs
send -R [-i|-I]), destroy snapshots and file systems that do not
exist on the sending side.
+ -K When force receive is enabled, do not destroy snapshots on the
+ receiving side that do not exist on the sending side.
+
-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.
-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.
+ -l filesystem|volume
+ Limits the receive to only the filesystem or volume specified. As
+ multiple options may be specified, this can be used to restore
+ specific filesystems or volumes from the received stream.
+
-n Do not actually receive the stream. This can be useful in
conjunction with the -v option to verify the name the receive
operation would use.
+ -o property=value
+ Sets the specified property to value during receive of the stream.
+ Specifying multiple -o options is allowed.
+
-o origin=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
@@ -1726,10 +1773,15 @@
mounted.
-v Print verbose information about the stream and the time required to
perform the receive operation.
+ -x property
+ Excludes the specified property from the received stream as if it
+ was not included in the send stream. Specifying multiple -x
+ options is allowed.
+
-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 (e.g. due to network failure or failure
of the remote system if the stream is being read over a network
connection), a checksum error in the stream, termination of the zfs
@@ -2291,10 +2343,10 @@
INTERFACE STABILITY
Committed.
SEE ALSO
- gzip(1), ssh(1), mount(1M), share(1M), sharemgr(1M), unshare(1M),
- zonecfg(1M), zpool(1M), chmod(2), stat(2), write(2), fsync(3C),
- dfstab(4), acl(5), attributes(5)
+ gzip(1), ssh(1), mount(1M), sharemgr(1M), zonecfg(1M), zpool(1M),
+ chmod(2), stat(2), write(2), fsync(3C), dfstab(4), acl(5), attributes(5),
+ sharenfs(5), sharesmb(5)
illumos December 6, 2017 illumos