NAME¶

nbdkit-nbd-plugin - nbdkit nbd plugin

SYNOPSIS¶

 nbdkit nbd socket=SOCKNAME [export=NAME]

DESCRIPTION¶

"nbdkit-nbd-plugin" is an NBD forwarding plugin for nbdkit(1).

It provides an NBD server that forwards all traffic as a client to another existing NBD server. A primary usage of this setup is to alter the set of features available to the ultimate end client, without having to change the original server (for example, to convert between oldstyle and newstyle, or to add TLS support where the original server lacks it).

For now, this is limited to connecting to another NBD server over a named Unix socket without TLS, although it is feasible that future additions will support network sockets and encryption.

PARAMETERS¶

socket=SOCKNAME

Connect to the NBD server located at the Unix socket "SOCKNAME". The server can speak either new or old style protocol.

This parameter is required.

export=NAME

If this parameter is given, and the server speaks new style protocol, then connect to the named export instead of the default export (the empty string).

SEE ALSO¶

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

AUTHORS¶

Eric Blake

COPYRIGHT¶

Copyright (C) 2017 Red Hat Inc.

LICENSE¶

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of Red Hat nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.