man/man8/zstream.8

   1 .\"
   2 .\" CDDL HEADER START
   3 .\"
   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.
   7 .\"
   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.
  12 .\"
  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]
  18 .\"
  19 .\" CDDL HEADER END
  20 .\"
  21 .\"
  22 .\" Copyright (c) 2020 by Delphix. All rights reserved.
  23 .Dd March 25, 2020
  24 .Dt ZSTREAM 8
  25 .Os
  26 .Sh NAME
  27 .Nm zstream
  28 .Nd manipulate zfs send streams
  29 .Sh SYNOPSIS
  30 .Nm
  31 .Cm dump
  32 .Op Fl Cvd
  33 .Op Ar file
  34 .Nm
  35 .Cm redup
  36 .Op Fl v
  37 .Ar file
  38 .Nm
  39 .Cm token
  40 .Ar resume_token
  41 .Sh DESCRIPTION
  42 .sp
  43 .LP
  44 The
  45 .Sy zstream
  46 utility manipulates zfs send streams, which are the output of the
  47 .Sy zfs send
  48 command.
  49 .Bl -tag -width ""
  50 .It Xo
  51 .Nm
  52 .Cm dump
  53 .Op Fl Cvd
  54 .Op Ar file
  55 .Xc
  56 Print information about the specified send stream, including headers and
  57 record counts.
  58 The send stream may either be in the specified
  59 .Ar file ,
  60 or provided on standard input.
  61 .Bl -tag -width "-D"
  62 .It Fl C
  63 Suppress the validation of checksums.
  64 .It Fl v
  65 Verbose.
  66 Print metadata for each record.
  67 .It Fl d
  68 Dump data contained in each record.
  69 Implies verbose.
  70 .El
  71 .It Xo
  72 .Nm
  73 .Cm token
  74 .Ar resume_token
  75 .Xc
  76 Dumps zfs resume token information
  77 .It Xo
  78 .Nm
  79 .Cm redup
  80 .Op Fl v
  81 .Ar file
  82 .Xc
  83 Deduplicated send streams can be generated by using the
  84 .Nm zfs Cm send Fl D
  85 command.
  86 The ability to send deduplicated send streams is deprecated.
  87 In the future, the ability to receive a deduplicated send stream with
  88 .Nm zfs Cm receive
  89 will be removed.
  90 However, deduplicated send streams can still be received by utilizing
  91 .Nm zstream Cm redup .
  92 .Pp
  93 The
  94 .Nm zstream Cm redup
  95 command is provided a
  96 .Ar file
  97 containing a deduplicated send stream, and outputs an equivalent
  98 non-deduplicated send stream on standard output.
  99 Therefore, a deduplicated send stream can be received by running:
 100 .Bd -literal
 101 # zstream redup DEDUP_STREAM_FILE | zfs receive ...
 102 .Ed
 103 .Bl -tag -width "-D"
 104 .It Fl v
 105 Verbose.
 106 Print summary of converted records.
 107 .Sh SEE ALSO
 108 .Xr zfs 8 ,
 109 .Xr zfs-send 8 ,
 110 .Xr zfs-receive 8