1nbdkit-streaming-plugin(1)          nbdkit          nbdkit-streaming-plugin(1)
2
3
4

NAME

6       nbdkit-streaming-plugin - nbdkit streaming plugin
7

SYNOPSIS

9        nbdkit streaming pipe=FILENAME [size=SIZE]
10

DESCRIPTION

12       "nbdkit-streaming-plugin" is a plugin for nbdkit(1) that can turn
13       certain kinds of input into a stream.
14
15       If the NBD client opens the NBD port, and writes from the start to the
16       end of the disk without seeking backwards, then this plugin will turn
17       the resulting disk image into a stream of data which is written to the
18       named "pipe" parameter.
19
20       Typical usage is with qemu tools.  For example:
21
22        qemu-img convert input -O raw output
23
24       does not work if "output" is a pipe.  However this does:
25
26        nbdkit -U /tmp/nbd.sock streaming pipe=output --run '
27          qemu-img convert -n input -O raw $nbd
28        '
29

PARAMETERS

31       pipe=FILENAME
32           Write to the named pipe or socket.  If the pipe or socket does not
33           exist, then it is created (as a named FIFO), otherwise the existing
34           pipe or socket is opened and used.
35
36           This parameter is required.
37
38       size=SIZE
39           Specify the virtual size of the stream.
40
41           This parameter is optional.  If not specified, then the virtual
42           disk appears to the client to be very large (effectively infinite).
43           Whether you need to specify this parameter depends on the client.
44           Some clients don't check the size and just write/stream, others do
45           checks or calculations based on the apparent size.
46

SEE ALSO

48       nbdkit(1), nbdkit-plugin(3).
49

AUTHORS

51       Richard W.M. Jones
52

54       Copyright (C) 2014 Red Hat Inc.
55

LICENSE

57       Redistribution and use in source and binary forms, with or without
58       modification, are permitted provided that the following conditions are
59       met:
60
61       ·   Redistributions of source code must retain the above copyright
62           notice, this list of conditions and the following disclaimer.
63
64       ·   Redistributions in binary form must reproduce the above copyright
65           notice, this list of conditions and the following disclaimer in the
66           documentation and/or other materials provided with the
67           distribution.
68
69       ·   Neither the name of Red Hat nor the names of its contributors may
70           be used to endorse or promote products derived from this software
71           without specific prior written permission.
72
73       THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND ANY
74       EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
75       IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
76       PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR CONTRIBUTORS BE
77       LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
78       CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
79       SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
80       BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
81       WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
82       OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
83       ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
84
85
86
87nbdkit                            2017-02-06        nbdkit-streaming-plugin(1)
Impressum