Merge tag 'rtc-5.3' of git://git.kernel.org/pub/scm/linux/kernel/git/abelloni/linux
[sfrench/cifs-2.6.git] / Documentation / admin-guide / blockdev / nbd.rst
1 ==================================
2 Network Block Device (TCP version)
3 ==================================
4
5 1) Overview
6 -----------
7
8 What is it: With this compiled in the kernel (or as a module), Linux
9 can use a remote server as one of its block devices. So every time
10 the client computer wants to read, e.g., /dev/nb0, it sends a
11 request over TCP to the server, which will reply with the data read.
12 This can be used for stations with low disk space (or even diskless)
13 to borrow disk space from another computer.
14 Unlike NFS, it is possible to put any filesystem on it, etc.
15
16 For more information, or to download the nbd-client and nbd-server
17 tools, go to http://nbd.sf.net/.
18
19 The nbd kernel module need only be installed on the client
20 system, as the nbd-server is completely in userspace. In fact,
21 the nbd-server has been successfully ported to other operating
22 systems, including Windows.
23
24 A) NBD parameters
25 -----------------
26
27 max_part
28         Number of partitions per device (default: 0).
29
30 nbds_max
31         Number of block devices that should be initialized (default: 16).