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]
21 .\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
22 .\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
23 .\" Copyright (c) 2011, 2019 by Delphix. All rights reserved.
24 .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
25 .\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
26 .\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
27 .\" Copyright (c) 2014 Integros [integros.com]
28 .\" Copyright 2019 Richard Laager. All rights reserved.
29 .\" Copyright 2018 Nexenta Systems, Inc.
30 .\" Copyright 2019 Joyent, Inc.
38 .Nd create snapshot from backup stream
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
66 .Op Fl o Sy origin Ns = Ns Ar snapshot
67 .Op Fl o Ar property Ns = Ns Ar value
69 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
76 .Op Fl o Sy origin Ns = Ns Ar snapshot
77 .Op Fl o Ar property Ns = Ns Ar value
81 Creates a snapshot whose contents are as specified in the stream provided on
83 If a full stream is received, then a new file system is created as well.
84 Streams are created using the
86 subcommand, which by default creates a full stream.
88 can be used as an alias for
91 If an incremental stream is received, then the destination file system must
92 already exist, and its most recent snapshot must match the incremental stream's
96 the destination device link is destroyed and recreated, which means the
98 cannot be accessed during the
102 When a snapshot replication package stream that is generated by using the
104 command is received, any snapshots that do not exist on the sending location are
105 destroyed by using the
106 .Nm zfs Cm destroy Fl d
109 The ability to send and receive deduplicated send streams has been removed.
110 However, a deduplicated send stream created with older software can be converted
111 to a regular (non-deduplicated) stream by using the
116 .Fl o Em property Ns = Ns Ar value
119 is specified, it applies to the effective value of the property throughout
120 the entire subtree of replicated datasets.
121 Effective property values will be set
125 on the topmost in the replicated subtree.
126 In descendant datasets, if the
127 property is set by the send stream, it will be overridden by forcing the
128 property to be inherited from the top‐most file system.
129 Received properties are retained in spite of being overridden
130 and may be restored with
131 .Nm zfs Cm inherit Fl S .
133 .Fl o Sy origin Ns = Ns Em snapshot
134 is a special case because, even if
136 is a read-only property and cannot be set, it's allowed to receive the send
137 stream as a clone of the given snapshot.
139 Raw encrypted send streams (created with
140 .Nm zfs Cm send Fl w )
141 may only be received as is, and cannot be re-encrypted, decrypted, or
142 recompressed by the receive process.
143 Unencrypted streams can be received as
144 encrypted datasets, either through inheritance or by specifying encryption
150 property cannot be overridden to
153 This is because the receive process itself is already using
154 the standard input for the send stream.
155 Instead, the property can be overridden after the receive completes.
157 The added security provided by raw sends adds some restrictions to the send
159 ZFS will not allow a mix of raw receives and non-raw receives.
160 Specifically, any raw incremental receives that are attempted after
161 a non-raw receive will fail.
162 Non-raw receives do not have this restriction and,
163 therefore, are always possible.
164 Because of this, it is best practice to always
165 use either raw sends for their security benefits or non-raw sends for their
166 flexibility when working with encrypted datasets, but not a combination.
168 The reason for this restriction stems from the inherent restrictions of the
169 AEAD ciphers that ZFS uses to encrypt data.
170 When using ZFS native encryption,
171 each block of data is encrypted against a randomly generated number known as
172 the "initialization vector" (IV), which is stored in the filesystem metadata.
173 This number is required by the encryption algorithms whenever the data is to
175 Together, all of the IVs provided for all of the blocks in a
176 given snapshot are collectively called an "IV set".
177 When ZFS performs a raw send, the IV set is transferred from the source
178 to the destination in the send stream.
179 When ZFS performs a non-raw send, the data is decrypted by the source
180 system and re-encrypted by the destination system, creating a snapshot with
181 effectively the same data, but a different IV set.
182 In order for decryption to work after a raw send, ZFS must ensure that
183 the IV set used on both the source and destination side match.
184 When an incremental raw receive is performed on
185 top of an existing snapshot, ZFS will check to confirm that the "from"
186 snapshot on both the source and destination were using the same IV set,
187 ensuring the new IV set is consistent.
189 The name of the snapshot
190 .Pq and file system, if a full stream is received
191 that this subcommand creates depends on the argument type and the use of the
197 If the argument is a snapshot name, the specified
200 If the argument is a file system or volume name, a snapshot with the same name
201 as the sent snapshot is created within the specified
209 options are specified, the provided target snapshot name is used exactly as
216 options cause the file system name of the target snapshot to be determined by
217 appending a portion of the sent snapshot's name to the specified target
221 option is specified, all but the first element of the sent snapshot's file
223 .Pq usually the pool name
224 is used and any required intermediate file systems within the specified one are
228 option is specified, then only the last element of the sent snapshot's file
230 .Pq i.e. the name of the source file system itself
231 is used as the target file system name.
234 Force a rollback of the file system to the most recent snapshot before
235 performing the receive operation.
236 If receiving an incremental replication stream
237 .Po for example, one generated by
238 .Nm zfs Cm send Fl R Op Fl i Ns | Ns Fl I
240 destroy snapshots and file systems that do not exist on the sending side.
242 Discard the first element of the sent snapshot's file system name, using the
243 remaining elements to determine the name of the target file system for the new
244 snapshot as described in the paragraph above.
246 Discard all but the last element of the sent snapshot's file system name, using
247 that element to determine the name of the target file system for the new
248 snapshot as described in the paragraph above.
250 Skip the receive of holds.
251 There is no effect if holds are not sent.
253 Force an unmount of the file system while receiving a snapshot.
254 This option is not supported on Linux.
256 Do not actually receive the stream.
257 This can be useful in conjunction with the
259 option to verify the name the receive operation would use.
260 .It Fl o Sy origin Ns = Ns Ar snapshot
261 Forces the stream to be received as a clone of the given snapshot.
262 If the stream is a full send stream, this will create the filesystem
263 described by the stream as a clone of the specified snapshot.
264 Which snapshot was specified will not affect the success or failure of the
265 receive, as long as the snapshot does exist.
266 If the stream is an incremental send stream, all the normal verification will be
268 .It Fl o Em property Ns = Ns Ar value
269 Sets the specified property as if the command
270 .Nm zfs Cm set Em property Ns = Ns Ar value
271 was invoked immediately before the receive.
272 When receiving a stream from
273 .Nm zfs Cm send Fl R ,
274 causes the property to be inherited by all descendant datasets, as through
275 .Nm zfs Cm inherit Em property
276 was run on any descendant datasets that have this property set on the
279 If the send stream was sent with
283 property will have no effect on received data but the
285 property will be set.
286 To have the data recompressed on receive remove the
288 flag from the send stream.
290 Any editable property can be set at receive time.
291 Set-once properties bound
292 to the received data, such as
295 .Sy casesensitivity ,
296 cannot be set at receive time even when the datasets are newly created by
298 Additionally both settable properties
302 cannot be set at receive time.
306 option may be specified multiple times, for different properties.
307 An error results if the same property is specified in multiple
315 option may also be used to override encryption properties upon initial receive.
316 This allows unencrypted streams to be received as encrypted datasets.
317 To cause the received dataset (or root dataset of a recursive stream) to be
318 received as an encryption root, specify encryption properties in the same
319 manner as is required for
322 .Dl # Nm zfs Cm send Pa tank/test@snap1 | Nm zfs Cm recv Fl o Sy encryption Ns = Ns Sy on Fl o Sy keyformat Ns = Ns Sy passphrase Fl o Sy keylocation Ns = Ns Pa file:///path/to/keyfile
325 .Fl o Sy keylocation Ns = Ns Sy prompt
326 may not be specified here, since the standard input
327 is already being utilized for the send stream.
328 Once the receive has completed, you can use
330 to change this setting after the fact.
331 Similarly, you can receive a dataset as an encrypted child by specifying
333 to force the property to be inherited.
334 Overriding encryption properties (except for
336 is not possible with raw send streams.
338 If the receive is interrupted, save the partially received state, rather
340 Interruption may be due to premature termination of the stream
341 .Po e.g. due to network failure or failure of the remote system
342 if the stream is being read over a network connection
344 a checksum error in the stream, termination of the
346 process, or unclean shutdown of the system.
348 The receive can be resumed with a stream generated by
349 .Nm zfs Cm send Fl t Ar token ,
353 .Sy receive_resume_token
354 property of the filesystem or volume which is received into.
356 To use this flag, the storage pool must have the
357 .Sy extensible_dataset
361 for details on ZFS feature flags.
363 File system that is associated with the received stream is not mounted.
365 Print verbose information about the stream and the time required to perform the
368 Ensures that the effective value of the specified property after the
369 receive is unaffected by the value of that property in the send stream (if any),
370 as if the property had been excluded from the send stream.
372 If the specified property is not present in the send stream, this option does
375 If a received property needs to be overridden, the effective value will be
376 set or inherited, depending on whether the property is inheritable or not.
378 In the case of an incremental update,
380 leaves any existing local setting or explicit inheritance unchanged.
384 restrictions (e.g. set-once) apply equally to
391 .Ar filesystem Ns | Ns Ar volume
394 .Nm zfs Cm receive Fl s ,
395 deleting its saved partially received state.
399 .\" These are, respectively, examples 12, 13 from zfs.8
400 .\" Make sure to update them bidirectionally
401 .Ss Example 1 : No Remotely Replicating ZFS Data
402 The following commands send a full stream and then an incremental stream to a
403 remote machine, restoring them into
404 .Em poolB/received/fs@a
406 .Em poolB/received/fs@b ,
409 must contain the file system
411 and must not initially contain
412 .Em poolB/received/fs .
413 .Bd -literal -compact -offset Ds
414 .No # Nm zfs Cm send Ar pool/fs@a |
415 .No " " Nm ssh Ar host Nm zfs Cm receive Ar poolB/received/fs Ns @ Ns Ar a
416 .No # Nm zfs Cm send Fl i Ar a pool/fs@b |
417 .No " " Nm ssh Ar host Nm zfs Cm receive Ar poolB/received/fs
420 .Ss Example 2 : No Using the Nm zfs Cm receive Fl d No Option
421 The following command sends a full stream of
422 .Ar poolA/fsA/fsB@snap
423 to a remote machine, receiving it into
424 .Ar poolB/received/fsA/fsB@snap .
427 portion of the received snapshot's name is determined from the name of the sent
430 must contain the file system
433 .Ar poolB/received/fsA
434 does not exist, it is created as an empty file system.
435 .Bd -literal -compact -offset Ds
436 .No # Nm zfs Cm send Ar poolA/fsA/fsB@snap |
437 .No " " Nm ssh Ar host Nm zfs Cm receive Fl d Ar poolB/received
projects / FreeBSD / FreeBSD.git / blob