Patchwork Documentation: Describe NBD URL syntax

login
register
mail settings
Submitter ronniesahlberg@gmail.com
Date Oct. 27, 2011, 9:33 a.m.
Message ID <1319708001-24075-2-git-send-email-ronniesahlberg@gmail.com>
Download mbox | patch
Permalink /patch/122098/
State New
Headers show

Comments

ronniesahlberg@gmail.com - Oct. 27, 2011, 9:33 a.m.
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>
---
 qemu-options.hx |   21 +++++++++++++++++++++
 1 files changed, 21 insertions(+), 0 deletions(-)
Kevin Wolf - Oct. 27, 2011, 9:41 a.m.
Am 27.10.2011 11:33, schrieb 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 <ronniesahlberg@gmail.com>

Thanks, applied to the block branch.

Kevin
Eric Sunshine - Oct. 27, 2011, 2:04 p.m.
On Oct 27, 2011, at 5:33 AM, Ronnie Sahlberg wrote:
> 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>
> ---
> 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:<server-ip>:<port>[:exportname=<export>]''
> +
> +Syntax for specifying a NDB device using Unix Domain Sockets
> +``nbd:unix:<domain-socket>[:exportname=<export>]''

On the two "Syntax for..." lines: s/NDB/NBD/

-- ES

Patch

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:<server-ip>:<port>[:exportname=<export>]''
+
+Syntax for specifying a NDB 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
 ETEXI