xref: /freebsd/sys/contrib/openzfs/man/man8/zstream.8 (revision eda14cbc264d6969b02f2b1994cef11148e914f1)
1*eda14cbcSMatt Macy.\"
2*eda14cbcSMatt Macy.\" CDDL HEADER START
3*eda14cbcSMatt Macy.\"
4*eda14cbcSMatt Macy.\" The contents of this file are subject to the terms of the
5*eda14cbcSMatt Macy.\" Common Development and Distribution License (the "License").
6*eda14cbcSMatt Macy.\" You may not use this file except in compliance with the License.
7*eda14cbcSMatt Macy.\"
8*eda14cbcSMatt Macy.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9*eda14cbcSMatt Macy.\" or http://www.opensolaris.org/os/licensing.
10*eda14cbcSMatt Macy.\" See the License for the specific language governing permissions
11*eda14cbcSMatt Macy.\" and limitations under the License.
12*eda14cbcSMatt Macy.\"
13*eda14cbcSMatt Macy.\" When distributing Covered Code, include this CDDL HEADER in each
14*eda14cbcSMatt Macy.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15*eda14cbcSMatt Macy.\" If applicable, add the following below this CDDL HEADER, with the
16*eda14cbcSMatt Macy.\" fields enclosed by brackets "[]" replaced with your own identifying
17*eda14cbcSMatt Macy.\" information: Portions Copyright [yyyy] [name of copyright owner]
18*eda14cbcSMatt Macy.\"
19*eda14cbcSMatt Macy.\" CDDL HEADER END
20*eda14cbcSMatt Macy.\"
21*eda14cbcSMatt Macy.\"
22*eda14cbcSMatt Macy.\" Copyright (c) 2020 by Delphix. All rights reserved.
23*eda14cbcSMatt Macy.Dd March 25, 2020
24*eda14cbcSMatt Macy.Dt ZSTREAM 8
25*eda14cbcSMatt Macy.Os
26*eda14cbcSMatt Macy.Sh NAME
27*eda14cbcSMatt Macy.Nm zstream
28*eda14cbcSMatt Macy.Nd manipulate zfs send streams
29*eda14cbcSMatt Macy.Sh SYNOPSIS
30*eda14cbcSMatt Macy.Nm
31*eda14cbcSMatt Macy.Cm dump
32*eda14cbcSMatt Macy.Op Fl Cvd
33*eda14cbcSMatt Macy.Op Ar file
34*eda14cbcSMatt Macy.Nm
35*eda14cbcSMatt Macy.Cm redup
36*eda14cbcSMatt Macy.Op Fl v
37*eda14cbcSMatt Macy.Ar file
38*eda14cbcSMatt Macy.Nm
39*eda14cbcSMatt Macy.Cm token
40*eda14cbcSMatt Macy.Ar resume_token
41*eda14cbcSMatt Macy.Sh DESCRIPTION
42*eda14cbcSMatt Macy.sp
43*eda14cbcSMatt Macy.LP
44*eda14cbcSMatt MacyThe
45*eda14cbcSMatt Macy.Sy zstream
46*eda14cbcSMatt Macyutility manipulates zfs send streams, which are the output of the
47*eda14cbcSMatt Macy.Sy zfs send
48*eda14cbcSMatt Macycommand.
49*eda14cbcSMatt Macy.Bl -tag -width ""
50*eda14cbcSMatt Macy.It Xo
51*eda14cbcSMatt Macy.Nm
52*eda14cbcSMatt Macy.Cm dump
53*eda14cbcSMatt Macy.Op Fl Cvd
54*eda14cbcSMatt Macy.Op Ar file
55*eda14cbcSMatt Macy.Xc
56*eda14cbcSMatt MacyPrint information about the specified send stream, including headers and
57*eda14cbcSMatt Macyrecord counts.
58*eda14cbcSMatt MacyThe send stream may either be in the specified
59*eda14cbcSMatt Macy.Ar file ,
60*eda14cbcSMatt Macyor provided on standard input.
61*eda14cbcSMatt Macy.Bl -tag -width "-D"
62*eda14cbcSMatt Macy.It Fl C
63*eda14cbcSMatt MacySuppress the validation of checksums.
64*eda14cbcSMatt Macy.It Fl v
65*eda14cbcSMatt MacyVerbose.
66*eda14cbcSMatt MacyPrint metadata for each record.
67*eda14cbcSMatt Macy.It Fl d
68*eda14cbcSMatt MacyDump data contained in each record.
69*eda14cbcSMatt MacyImplies verbose.
70*eda14cbcSMatt Macy.El
71*eda14cbcSMatt Macy.It Xo
72*eda14cbcSMatt Macy.Nm
73*eda14cbcSMatt Macy.Cm token
74*eda14cbcSMatt Macy.Ar resume_token
75*eda14cbcSMatt Macy.Xc
76*eda14cbcSMatt MacyDumps zfs resume token information
77*eda14cbcSMatt Macy.It Xo
78*eda14cbcSMatt Macy.Nm
79*eda14cbcSMatt Macy.Cm redup
80*eda14cbcSMatt Macy.Op Fl v
81*eda14cbcSMatt Macy.Ar file
82*eda14cbcSMatt Macy.Xc
83*eda14cbcSMatt MacyDeduplicated send streams can be generated by using the
84*eda14cbcSMatt Macy.Nm zfs Cm send Fl D
85*eda14cbcSMatt Macycommand.
86*eda14cbcSMatt MacyThe ability to send deduplicated send streams is deprecated.
87*eda14cbcSMatt MacyIn the future, the ability to receive a deduplicated send stream with
88*eda14cbcSMatt Macy.Nm zfs Cm receive
89*eda14cbcSMatt Macywill be removed.
90*eda14cbcSMatt MacyHowever, deduplicated send streams can still be received by utilizing
91*eda14cbcSMatt Macy.Nm zstream Cm redup .
92*eda14cbcSMatt Macy.Pp
93*eda14cbcSMatt MacyThe
94*eda14cbcSMatt Macy.Nm zstream Cm redup
95*eda14cbcSMatt Macycommand is provided a
96*eda14cbcSMatt Macy.Ar file
97*eda14cbcSMatt Macycontaining a deduplicated send stream, and outputs an equivalent
98*eda14cbcSMatt Macynon-deduplicated send stream on standard output.
99*eda14cbcSMatt MacyTherefore, a deduplicated send stream can be received by running:
100*eda14cbcSMatt Macy.Bd -literal
101*eda14cbcSMatt Macy# zstream redup DEDUP_STREAM_FILE | zfs receive ...
102*eda14cbcSMatt Macy.Ed
103*eda14cbcSMatt Macy.Bl -tag -width "-D"
104*eda14cbcSMatt Macy.It Fl v
105*eda14cbcSMatt MacyVerbose.
106*eda14cbcSMatt MacyPrint summary of converted records.
107*eda14cbcSMatt Macy.Sh SEE ALSO
108*eda14cbcSMatt Macy.Xr zfs 8 ,
109*eda14cbcSMatt Macy.Xr zfs-send 8 ,
110*eda14cbcSMatt Macy.Xr zfs-receive 8
111