From patchwork Thu Oct 27 09:33:21 2011 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: Documentation: Describe NBD URL syntax Date: Wed, 26 Oct 2011 23:33:21 -0000 From: ronniesahlberg@gmail.com X-Patchwork-Id: 122098 Message-Id: <1319708001-24075-2-git-send-email-ronniesahlberg@gmail.com> To: qemu-devel@nongnu.org Cc: kwolf@redhat.com, Ronnie Sahlberg 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 --- qemu-options.hx | 21 +++++++++++++++++++++ 1 files changed, 21 insertions(+), 0 deletions(-) diff --git a/qemu-options.hx b/qemu-options.hx index 7c434f8..564ae3f 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -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 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 NDB device using TCP +``nbd::[:exportname=]'' + +Syntax for specifying a NDB device using Unix Domain Sockets +``nbd:unix:[:exportname=]'' + + +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 ETEXI