1NBDTAB(5)                                                            NBDTAB(5)
2
3
4

NAME

6       /etc/nbdtab - configuration file for nbd-client
7

SYNOPSIS

9       /etc/nbdtab
10
11

DESCRIPTION

13       This file allows to configure predefined connections for nbd-client. It
14       may contain multiple definitions, one per line, each of which  contains
15       four space-separated fields.
16
17       To  connect  a  device  specified in the nbdtab file, run nbd-client(8)
18       with the short name of that device as the sole argument. It  will  then
19       look up the required information in nbdtab, and make the connection.
20
21       Fields  are  separated  from  one another by any number of space or tab
22       characters; records are separated from one another by  newline  charac‐
23       ters.  The  file  may  also contain any number of comments, which start
24       with a '#' character and continue until the end of the line or the  end
25       of the file, whichever is first.
26
27   FIELDS
28       The file contains the following fields:
29
30       1. The  short  name  of the device file. That is, it should contain the
31          name of the device without the leading /dev/ part;  e.g.,  it  could
32          say nbd0.
33
34       2. The  hostname  (in  case  of a TCP socket) or filename (in case of a
35          unix domain socket) on which the server is listening.
36
37       3. The name of the export as exported by nbd-server.
38
39       4. Any extra options. This field is optional  (no  pun  intended),  and
40          need  not  appear in a file if no options are necessary. The options
41          recognized by nbd-client(8) are  specified  below,  in  the  section
42          "Options".  Any unknown options in this field will produce a warning
43          by nbd-client, unless they are  prepended  by  an  underscore  ('_')
44          character; the underscore is specifically reserved for local use, or
45          for distribution customization.
46
47   OPTIONS
48       Every command-line nbd-client option which allows to configure specific
49       options  for a particular device node has a corresponding option in the
50       nbdtab file, and vice versa; where this isn't the case, that is a bug.
51
52       Individual options in this field should be separated from  one  another
53       by the comma character.
54
55       bs=block size
56              The  block size for this export. If this option is not used, the
57              kernel's default will be used instead.
58
59              Corresponds to the -b option on the command line.
60
61       cacertfile=certificate file
62              The CA certificate file for TLS. Corresponds to the -A option on
63              the command line.
64
65       certfile=certificate file
66              The  certificate  file  for TLS. Corresponds to the -F option on
67              the command line.
68
69       conns=number
70              The number of connections to use for this  device.   Corresponds
71              to the -C option on the command line; see nbd-client(8) for more
72              details on that option.
73
74       keyfile=key file
75              The private key file for TLS. Corresponds to the  -K  option  on
76              the command line.
77
78       no_optgo
79              Disable  the use of NBD_OPT_GO in the conversation.  Corresponds
80              to the -g option on the command line.
81
82       port=port number
83              The port on which to communicate with the  nbd-server.  Defaults
84              to the IANA-assigned port for NBD, 10809.
85
86       timeout=timeout
87              The timeout. If this option is not specified, no timeout is con‐
88              figured.
89
90              Corresponds to the -t option on the command line.
91
92       persist
93              Persist the connection, using the semantics of the  -p  command-
94              line option.
95
96       swap   Optimize for swap; -s.
97
98       sdp    Use the Socket Direct protocol; -S.
99
100       tlshostname=TLS hostname
101              The hostname for TLS purposes; -H
102
103       unix   Use a Unix Domain socket to connect to the server; -u.
104

SEE ALSO

106       nbd-server (1), nbd-client (8), nbd-trdump (8)
107

AUTHOR

109       The  NBD  kernel  module  and  the NBD tools were originally written by
110       Pavel Machek (pavel@ucw.cz)
111
112       The  Linux  kernel  module  is  now   maintained   by   Paul   Clements
113       (Paul.Clements@steeleye.com),  while  the userland tools are maintained
114       by Wouter Verhelst (<wouter@debian.org>)
115
116       On The Hurd there is a regular  translator  available  to  perform  the
117       client side of the protocol, and the use of nbd-client is not required.
118       Please see the relevant documentation for more information.
119
120       This manual page was written by Wouter Verhelst  (<wouter@debian.org>).
121       Permission  is  granted to copy, distribute and/or modify this document
122       under the terms of the GNU General Public License, version 2,  as  pub‐
123       lished by the Free Software Foundation.
124

EXAMPLES

126       A simple nbdtab file could look like this:
127
128       # swap space, called "swapexport" on the server
129       # optimize for swap, and try to reconnect upon disconnect.
130       nbd0 nbdserver.example.com swapexport swap,persist
131       # other export, called "data" on the server. No options for this one.
132       nbd1 nbdserver.example.com data
133
134
135
136                : 2006-10-18 15:01:57 +0200 (wo, 18 okt 2006) $      NBDTAB(5)
Impressum