Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xnbd-register(1) [debian man page]

XNBD-REGISTER(1)					      General Commands Manual						  XNBD-REGISTER(1)

NAME

       xnbd-register -- Restore xNBD sessions upon boot

SYNOPSIS

       xnbd-register [--start]	[--stop]  [--restart]  [--status]  [--quiet]

DESCRIPTION

       With  the xmbd-register command one can restore xnbd-server and xnbd-client sessions based on a configuration file. This is useful to start
       both, client or server upon boot.

       To achieve this, xmbd-register reads a semi-structured configuration file located in /etc/xnbd.conf. See below for format hints.

OPTIONS

       The following options are supported:

       --start	 Start devices configured in the configuration files. If the configuration files describes  volumes,  xnbd-register  will  try	to
		 establish a client connection to the configured server instance.

		 Alternatively, xnbd-register will start sharing configured volumes by starting an xnbd-wrapper super server.

       --status  Retrieve server status from a running xnbd-wrapper command, if applicable.

       --stop	 Analogous to the start option, the stop argument will stop all xnbd connection, being client or server instances.

       --restart Restart all xnbd instances, being client or server

CONFIGURATION FILE

       xnbd-register  will  read its defaults from /etc/xnbd.conf. This is a semi-structured configuration file, describing client and server con-
       nections that are supposed to be restored upon start of the system.

       The syntax of the file is a JSON data structure, allowing comments starting with a hash key ("#"). Two types  of  objects  are  recognized:
       xnbd  volumes  and  a server instance. xnbd volumes are indexed by the supposed devices name. This is, to restore /dev/nbd0 an object named
       "nbd0 must be configured. Valid arguments are host, name and port. So, for example, this is  to	configure  /dev/nbd0	    connecting	to
       localhost on port 8520. If present, identify the shared device by the configured logical name:

       "nbd0": {
       "host": "127.0.0.1",
       "port": 8520,
       "name": "name"
       }

       Similarly, a server instance configures an xnbd-wrapper. Valid options are:

       address	 Specifies the listening address

       port	 Specifies the listening port

       socket	 Specifies the listening socket for the control channels

       logpath	 Specifies the log path where logging output is being redirected to

       volumes	 A list of volumes which are exported

       "server": {
       "address": "127.0.0.1",
       "port": 8520,
       "socket": "/var/run/xnbd.ctl",
       "logpath": "/tmp/xnbd.log",
       "volumes": [ "/dev/volume", "/dev/sdb1", "/var/lib/image.file" ]
       }

SEE ALSO

       xnbd-wrapper (8), xnbd-client (1)

AUTHOR

       xnbd-register was written by Arno Toell (debian@toell.net) for the Debian GNU/Linux     system. Report bugs to the Debian bug tracking sys-
       tem on http://bugs.debian.org

       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-REGISTER(1)

Check Out this Related Man Page

XNBD-BGCTL(1)						      General Commands Manual						     XNBD-BGCTL(1)

NAME

       xnbd-bgctl -- Control a server running xnbd-server(8) through its control socket

SYNOPSIS

       xnbd-bgctl [--cache-all]  [--cache-all2]  [--query]  [--reconnect REMOTE_HOST	   REMOTE_PORT]  [--shutdown]  [control_socket]

DESCRIPTION

       With  the  xmbd-bgctl command you can connect to a xnbd-server control channel and instruct it to act as directed. You may pass an argument
       to the control program which is then forwarded, on your behalf, to the server instance.

OPTIONS

       The following options are supported:

       --cache-all
		 If the remote xnbd-server acts as proxy server, this command intstructs the controlling xnbd-server instance to cache all  blocks
		 on  its  associated block disk. Upon completion the controlled xnbd instance holds all data from the origin instance and it is no
		 longer necessary to act as proxy.

       --cache-all2
		 This command is identical to cache-all but detaches the process from the terminal and is hence using a dedicated  connection  for
		 data transfer.

       --query	 This  command	retrieves  completion  statistics  from  the  proxy server instance. It returns the number of cached blocks on the
		 server.

       --reconnect
		 This command recovers from a lost connection by re-establishing connectivity with the origin server.  This  command  expects  two
		 additional arguments, the REMOTE_HOST, and the REMOTE_PORT    you want to connect to, to recover from a disconnected session.

       --shutdown
		 This command stops the proxy server and restarts the target server.  All client sessions are preserved.

POSITIONAL ARGUMENTS

       The following positional options are supported:

       CONTROL_SOCKET
		 The Unix domain socket, the xnbd-server(8) program is listening on.

SEE ALSO

       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-BGCTL(1)
Man Page