4 .\" The contents of this file are subject to the terms of the
5 .\" Common Development and Distribution License (the "License").
6 .\" You may not use this file except in compliance with the License.
8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 .\" or http://www.opensolaris.org/os/licensing.
10 .\" See the License for the specific language governing permissions
11 .\" and limitations under the License.
13 .\" When distributing Covered Code, include this CDDL HEADER in each
14 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 .\" If applicable, add the following below this CDDL HEADER, with the
16 .\" fields enclosed by brackets "[]" replaced with your own identifying
17 .\" information: Portions Copyright [yyyy] [name of copyright owner]
22 .\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
23 .\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
24 .\" Copyright (c) 2011, 2019 by Delphix. All rights reserved.
25 .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
26 .\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
27 .\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
28 .\" Copyright (c) 2014 Integros [integros.com]
29 .\" Copyright 2019 Richard Laager. All rights reserved.
30 .\" Copyright 2018 Nexenta Systems, Inc.
31 .\" Copyright 2019 Joyent, Inc.
38 .Nd Creates a snapshot whose contents are as specified in the stream provided on standard input.
43 .Op Fl o Sy origin Ns = Ns Ar snapshot
44 .Op Fl o Ar property Ns = Ns Ar value
46 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
51 .Op Fl o Sy origin Ns = Ns Ar snapshot
52 .Op Fl o Ar property Ns = Ns Ar value
58 .Ar filesystem Ns | Ns Ar volume
65 .Op Fl o Sy origin Ns = Ns Ar snapshot
66 .Op Fl o Ar property Ns = Ns Ar value
68 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
75 .Op Fl o Sy origin Ns = Ns Ar snapshot
76 .Op Fl o Ar property Ns = Ns Ar value
80 Creates a snapshot whose contents are as specified in the stream provided on
82 If a full stream is received, then a new file system is created as well.
83 Streams are created using the
85 subcommand, which by default creates a full stream.
87 can be used as an alias for
90 If an incremental stream is received, then the destination file system must
91 already exist, and its most recent snapshot must match the incremental stream's
95 the destination device link is destroyed and recreated, which means the
97 cannot be accessed during the
101 When a snapshot replication package stream that is generated by using the
103 command is received, any snapshots that do not exist on the sending location are
104 destroyed by using the
105 .Nm zfs Cm destroy Fl d
108 The ability to send and receive deduplicated send streams has been removed.
109 However, a deduplicated send stream created with older software can be converted
110 to a regular (non-deduplicated) stream by using the
115 .Fl o Em property Ns = Ns Ar value
118 is specified, it applies to the effective value of the property throughout
119 the entire subtree of replicated datasets. Effective property values will be
124 ) on the topmost in the replicated subtree. In descendant datasets, if the
125 property is set by the send stream, it will be overridden by forcing the
126 property to be inherited from the top‐most file system. Received properties
127 are retained in spite of being overridden and may be restored with
128 .Nm zfs Cm inherit Fl S .
130 .Fl o Sy origin Ns = Ns Em snapshot
131 is a special case because, even if
133 is a read-only property and cannot be set, it's allowed to receive the send
134 stream as a clone of the given snapshot.
136 Raw encrypted send streams (created with
138 ) may only be received as is, and cannot be re-encrypted, decrypted, or
139 recompressed by the receive process. Unencrypted streams can be received as
140 encrypted datasets, either through inheritance or by specifying encryption
143 options. Note that the
145 property cannot be overridden to
147 during a receive. This is because the receive process itself is already using
148 stdin for the send stream. Instead, the property can be overridden after the
151 The added security provided by raw sends adds some restrictions to the send
152 and receive process. ZFS will not allow a mix of raw receives and non-raw
153 receives. Specifically, any raw incremental receives that are attempted after
154 a non-raw receive will fail. Non-raw receives do not have this restriction and,
155 therefore, are always possible. Because of this, it is best practice to always
156 use either raw sends for their security benefits or non-raw sends for their
157 flexibility when working with encrypted datasets, but not a combination.
159 The reason for this restriction stems from the inherent restrictions of the
160 AEAD ciphers that ZFS uses to encrypt data. When using ZFS native encryption,
161 each block of data is encrypted against a randomly generated number known as
162 the "initialization vector" (IV), which is stored in the filesystem metadata.
163 This number is required by the encryption algorithms whenever the data is to
164 be decrypted. Together, all of the IVs provided for all of the blocks in a
165 given snapshot are collectively called an "IV set". When ZFS performs a raw
166 send, the IV set is transferred from the source to the destination in the send
167 stream. When ZFS performs a non-raw send, the data is decrypted by the source
168 system and re-encrypted by the destination system, creating a snapshot with
169 effectively the same data, but a different IV set. In order for decryption to
170 work after a raw send, ZFS must ensure that the IV set used on both the source
171 and destination side match. When an incremental raw receive is performed on
172 top of an existing snapshot, ZFS will check to confirm that the "from"
173 snapshot on both the source and destination were using the same IV set,
174 ensuring the new IV set is consistent.
176 The name of the snapshot
177 .Pq and file system, if a full stream is received
178 that this subcommand creates depends on the argument type and the use of the
184 If the argument is a snapshot name, the specified
187 If the argument is a file system or volume name, a snapshot with the same name
188 as the sent snapshot is created within the specified
196 options are specified, the provided target snapshot name is used exactly as
203 options cause the file system name of the target snapshot to be determined by
204 appending a portion of the sent snapshot's name to the specified target
208 option is specified, all but the first element of the sent snapshot's file
210 .Pq usually the pool name
211 is used and any required intermediate file systems within the specified one are
215 option is specified, then only the last element of the sent snapshot's file
217 .Pq i.e. the name of the source file system itself
218 is used as the target file system name.
221 Force a rollback of the file system to the most recent snapshot before
222 performing the receive operation.
223 If receiving an incremental replication stream
224 .Po for example, one generated by
225 .Nm zfs Cm send Fl R Op Fl i Ns | Ns Fl I
227 destroy snapshots and file systems that do not exist on the sending side.
229 Discard the first element of the sent snapshot's file system name, using the
230 remaining elements to determine the name of the target file system for the new
231 snapshot as described in the paragraph above.
233 Discard all but the last element of the sent snapshot's file system name, using
234 that element to determine the name of the target file system for the new
235 snapshot as described in the paragraph above.
237 Skip the receive of holds. There is no effect if holds are not sent.
239 Force an unmount of the file system while receiving a snapshot.
240 This option is not supported on Linux.
242 Do not actually receive the stream.
243 This can be useful in conjunction with the
245 option to verify the name the receive operation would use.
246 .It Fl o Sy origin Ns = Ns Ar snapshot
247 Forces the stream to be received as a clone of the given snapshot.
248 If the stream is a full send stream, this will create the filesystem
249 described by the stream as a clone of the specified snapshot.
250 Which snapshot was specified will not affect the success or failure of the
251 receive, as long as the snapshot does exist.
252 If the stream is an incremental send stream, all the normal verification will be
254 .It Fl o Em property Ns = Ns Ar value
255 Sets the specified property as if the command
256 .Nm zfs Cm set Em property Ns = Ns Ar value
257 was invoked immediately before the receive. When receiving a stream from
258 .Nm zfs Cm send Fl R ,
259 causes the property to be inherited by all descendant datasets, as through
260 .Nm zfs Cm inherit Em property
261 was run on any descendant datasets that have this property set on the
264 If the send stream was sent with
268 property will have no affect on received data but the
270 property will be set. To have the data recompressed on receive remove the
272 flag from the send stream.
274 Any editable property can be set at receive time. Set-once properties bound
275 to the received data, such as
278 .Sy casesensitivity ,
279 cannot be set at receive time even when the datasets are newly created by
281 Additionally both settable properties
285 cannot be set at receive time.
289 option may be specified multiple times, for different properties. An error
290 results if the same property is specified in multiple
298 option may also be used to override encryption properties upon initial
299 receive. This allows unencrypted streams to be received as encrypted datasets.
300 To cause the received dataset (or root dataset of a recursive stream) to be
301 received as an encryption root, specify encryption properties in the same
302 manner as is required for
307 # zfs send tank/test@snap1 | zfs recv -o encryption=on -o keyformat=passphrase -o keylocation=file:///path/to/keyfile
311 .Op Fl o Ar keylocation Ns = Ns Ar prompt
312 may not be specified here, since stdin is already being utilized for the send
313 stream. Once the receive has completed, you can use
316 to change this setting after the fact. Similarly, you can receive a dataset as
317 an encrypted child by specifying
318 .Op Fl x Ar encryption
319 to force the property to be inherited. Overriding encryption properties (except
322 is not possible with raw send streams.
324 If the receive is interrupted, save the partially received state, rather
326 Interruption may be due to premature termination of the stream
327 .Po e.g. due to network failure or failure of the remote system
328 if the stream is being read over a network connection
330 a checksum error in the stream, termination of the
332 process, or unclean shutdown of the system.
334 The receive can be resumed with a stream generated by
335 .Nm zfs Cm send Fl t Ar token ,
339 .Sy receive_resume_token
340 property of the filesystem or volume which is received into.
342 To use this flag, the storage pool must have the
343 .Sy extensible_dataset
347 for details on ZFS feature flags.
349 File system that is associated with the received stream is not mounted.
351 Print verbose information about the stream and the time required to perform the
354 Ensures that the effective value of the specified property after the
355 receive is unaffected by the value of that property in the send stream (if any),
356 as if the property had been excluded from the send stream.
358 If the specified property is not present in the send stream, this option does
361 If a received property needs to be overridden, the effective value will be
362 set or inherited, depending on whether the property is inheritable or not.
364 In the case of an incremental update,
366 leaves any existing local setting or explicit inheritance unchanged.
370 restrictions (e.g. set-once) apply equally to
377 .Ar filesystem Ns | Ns Ar volume
380 .Nm zfs Cm receive Fl s ,
381 deleting its saved partially received state.
projects / freebsd.git / blob