XNBD-WRAPPER(8) System Manager's Manual XNBD-WRAPPER(8)NAME
xnbd-wrapper-ctl -- manage a xnbd-wrapper(8) super-server.
SYNOPSIS
xnbd-wrapper-ctl [--socket SOCKETPATH] [--add FILE] [--remove FILE] [--list]
DESCRIPTION
With the xnbd-wrapper-ctl command you can connect to a xnbd-wrapper control channel and instruct it to act as directed. You may pass cer-
tain commands as argument to the control program which are then forwarded, on your behalf, to the server instance.
OPTIONS
The following options are supported:
--add|-a FILE
Instruct the xnbd-wrapper to add the given FILE as exported xNBD device.
--help|-h
Display a short usage overview and exit
--list|-l
Connects to the xNBD wrapper and retrieves a list exported file names
--remove|-r INDEX
Instruct the xnbd-wrapper to remove the volume exported on INDEX from the list of exported xNBD devices.
--socket|-s SOCKETPATH
Connect to SOCKETPATH as xnbd-wrapper control sokcet. Default is /tmp/xnbd_wrapper.ctl.
SEE ALSO
xnbd-wrapper (1), xnbd-server (8).
AUTHOR
The NBD kernel module and the NBD tools have been written by Pavel Macheck (pavel@ucw.cz) and is now maintained by Paul Clements.
(Paul.Clements@steeleye.com).
The xNBD userland (client and server) have been written by Takahiro Hirofuchi (t.hirofuchi@aist.go.jp)
This manual page was written by Arno Toell (debian@toell.net) for the Debian GNU/Linux system (but may be used by others). Permission is
granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, version 2, as published by the
Free Software Foundation.
XNBD-WRAPPER(8)
Check Out this Related Man Page
XNBD-WRAPPER(8) System Manager's Manual XNBD-WRAPPER(8)NAME
xnbd-wrapper -- manage multiple files to be exported as a block device to other computers running the GNU/Linux(tm) Operating System
SYNOPSIS
xnbd-wrapper [ --imgfile IMAGE [--imgfile IMAGE ...] ] [--laddr ADDRESS] [--port PORT] [--socket PATH] [--xnbd-binary
PATH] [--daemonize] [--logpath PATH]
DESCRIPTION
xnbd-wrapper is a super-server for xnbd-server. Its purpose is to manage multiple exported images at once. A client may connect to this
super-server and it will be indirected to the actual xnbd-server providing the requested resource.
xnbd-wrapper comes handy if you want to export multiple files (or block devices) on a single host. Instead of starting multiple xnbd-server
instances and remember the exported port for each, you can use xnbd-wrapper to looks up the requested image file name and map it automati-
cally to the corresponding xnbd-server.
OPTIONS
The following options are supported:
--daemonize
Go into background as soon as the xnbd-server is started up
--imgfile IMAGE
Export the image file IMAGE through xnbd-wrapper, with IMAGE being a block device or a file name of an image file.
xnbd-wrapper will export the file name accessible through this name to clients, which may connect to the server by providing this
name
This option can be specified multiple times. In this case, xnbd-wrapper will export all IMAGE files at once. Alternatively this
argument can be omitted and images may be (un-)exported ar runtime with xnbd-wrapper-ctl.
--laddr ADDRESS
The address, where this wrapper shall listen for incoming connections. You can specify any resolvable hostname or IP address,
being in IPv4 or IPv6 notation.
--logpath FILE
Log informational messages to the given FILE if given. Defaults to /var/log/xnbd-wrapper.log
--lport PORT
Accept incoming connections on the given PORT. A valid port is any number between 1 and 65536. You may not use the same listeing
port more than once per system. If this argument is not given, xNBD will listen on port 8520 by default.
--socket PATH
The xNBD wrapper can be controlled through a control socket. When given, use PATH as file name, default is /tmp/xnbd_wrap-
per.ctl).
--xnbd-binary PATH
Specifies the path to the xnbd-server program. The wrapper will spawn server instances on demand. Give PATH as file name,
default is xnbd-server (relative to the directory, where the wrapper is in).
SEE ALSO
xnbd-client (1), xnbd-server (8), xnbd-wrapper-ctl (8).
AUTHOR
The NBD kernel module and the NBD tools have been written by Pavel Macheck (pavel@ucw.cz) and is now maintained by Paul Clements.
(Paul.Clements@steeleye.com).
The xNBD userland (client and server) have been written by Takahiro Hirofuchi (t.hirofuchi@aist.go.jp)
This manual page was written by Arno Toell (debian@toell.net) for the Debian GNU/Linux system (but may be used by others). Permission is
granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, version 2, as published by the
Free Software Foundation.
XNBD-WRAPPER(8)