Documentation: Describe NBD URL syntax

This patch adds a short description of how to specify a NBD device
to QEMU.
Syntax for both TCP and Unix Domain Sockets are provided as well
as examples.

Signed-off-by: Ronnie Sahlberg <ronniesahlberg@gmail.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
This commit is contained in:
Ronnie Sahlberg 2011-10-27 20:33:21 +11:00 committed by Kevin Wolf
parent 93897b9fd4
commit 08ae330e17

View File

@ -1757,6 +1757,27 @@ qemu --drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
iSCSI support is an optional feature of QEMU and only available when iSCSI support is an optional feature of QEMU and only available when
compiled and linked against libiscsi. compiled and linked against libiscsi.
@item NBD
QEMU supports NBD (Network Block Devices) both using TCP protocol as well
as Unix Domain Sockets.
Syntax for specifying a NBD device using TCP
``nbd:<server-ip>:<port>[:exportname=<export>]''
Syntax for specifying a NBD device using Unix Domain Sockets
``nbd:unix:<domain-socket>[:exportname=<export>]''
Example for TCP
@example
qemu --drive file=nbd:192.0.2.1:30000
@end example
Example for Unix Domain Sockets
@example
qemu --drive file=nbd:unix:/tmp/nbd-socket
@end example
@end table @end table
ETEXI ETEXI