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

NAME

6       nbdkit-nbd-plugin - nbdkit nbd plugin
7

SYNOPSIS

9        nbdkit nbd socket=SOCKNAME [export=NAME]
10

DESCRIPTION

12       "nbdkit-nbd-plugin" is an NBD forwarding plugin for nbdkit(1).
13
14       It provides an NBD server that forwards all traffic as a client to
15       another existing NBD server.  A primary usage of this setup is to alter
16       the set of features available to the ultimate end client, without
17       having to change the original server (for example, to convert between
18       oldstyle and newstyle, or to add TLS support where the original server
19       lacks it).
20
21       For now, this is limited to connecting to another NBD server over a
22       named Unix socket without TLS, although it is feasible that future
23       additions will support network sockets and encryption.
24

PARAMETERS

26       socket=SOCKNAME
27           Connect to the NBD server located at the Unix socket "SOCKNAME".
28           The server can speak either new or old style protocol.
29
30           This parameter is required.
31
32       export=NAME
33           If this parameter is given, and the server speaks new style
34           protocol, then connect to the named export instead of the default
35           export (the empty string).
36

SEE ALSO

38       nbdkit(1), nbdkit-plugin(3).
39

AUTHORS

41       Eric Blake
42

44       Copyright (C) 2017 Red Hat Inc.
45

LICENSE

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