MAN page from openSUSE Tumbleweed nbd-3.19-1.2.i586.rpm
Updated: : 2006-10-18 15:01:57 +0200 (wo, 18 okt 2006) $Index
/etc/nbdtab - configuration file for nbd-client
This file allows to configure predefined connections fornbd-client. It may contain multiple definitions, one per line,each of which contains four space-separated fields.
To connect a device specified in the nbdtab file,run nbd-client(8) with the short name of thatdevice as the sole argument. It will then look up the requiredinformation in nbdtab, and make theconnection.
Fields are separated from one another by any number of spaceor tab characters; records are separated from one another bynewline characters. The file may also contain any number ofcomments, which start with a '#' character and continue until theend of the line or the end of the file, whichever is first.
The file contains the following fields:
- The short name of the device file. That is, it shouldcontain the name of the device without the leading/dev/ part; e.g., it could saynbd0.
- The hostname (in case of a TCP socket) or filename (incase of a unix domain socket) on which the server islistening.
- The name of the export as exported bynbd-server.
- Any extra options. This field is optional (no punintended), and need not appear in a file if no options arenecessary. The options recognized bynbd-client(8) are specified below, in thesection "Options". Any unknown options inthis field will produce a warning bynbd-client, unless they are prepended byan underscore ('_') character; the underscore isspecifically reserved for local use, or for distributioncustomization.
Every command-line nbd-client optionwhich allows to configure specific options for a particulardevice node has a corresponding option in thenbdtab file, and vice versa; where thisisn't the case, that is a bug.
Individual options in this field should be separated fromone another by the comma character.
- bs=block size
- The block size for this export. If this option isnot used, the kernel's default will be usedinstead.
Corresponds to the -b option on thecommand line.
- cacertfile=certificate file
- The CA certificate file for TLS. Corresponds to the-A option on the command line.
- certfile=certificate file
- The certificate file for TLS. Corresponds to the-F option on the command line.
- The number of connections to use for this device.Corresponds to the -C option on the commandline; see nbd-client(8) for more details on thatoption.
- keyfile=key file
- The private key file for TLS. Corresponds to the-K option on the command line.
- Disable the use of NBD_OPT_GO in the conversation.Corresponds to the -g option on the commandline.
- port=port number
- The port on which to communicate with thenbd-server. Defaults to theIANA-assigned port for NBD, 10809.
- The timeout. If this option is not specified, notimeout is configured.
Corresponds to the -t option on thecommand line.
- Persist the connection, using the semantics of the-p command-line option.
- Optimize for swap; -s.
- Use the Socket Direct protocol; -S.
- tlshostname=TLS hostname
- The hostname for TLS purposes;-H
- Use a Unix Domain socket to connect to the server;-u.
nbd-server (1), nbd-client (8), nbd-trdump (8)
The NBD kernel module and the NBD tools were originallywritten by Pavel Machek (pavelAATTucw.cz)
The Linux kernel module is now maintained by Paul Clements(Paul.ClementsAATTsteeleye.com), while the userland tools aremaintained by Wouter Verhelst (<wouterAATTdebian.org>)
On The Hurd there is a regular translator available to perform theclient side of the protocol, and the use ofnbd-client is not required. Please see therelevant documentation for more information.
This manual page was written by Wouter Verhelst (<wouterAATTdebian.org>).Permission is granted to copy, distribute and/or modify thisdocument under the terms of the GNU GeneralPublic License, version 2, as published by the Free SoftwareFoundation.
A simple nbdtab file could look likethis:
# swap space, called "swapexport" on the server# optimize for swap, and try to reconnect upon disconnect.nbd0 nbdserver.example.com swapexport swap,persist# other export, called "data" on the server. No options for this one.nbd1 nbdserver.example.com data
- SEE ALSO
This document was created byman2html,using the manual pages.