From patchwork Thu Oct 27 09:33:21 2011 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: ronnie sahlberg X-Patchwork-Id: 122098 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.gnu.org (lists.gnu.org [140.186.70.17]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (Client did not present a certificate) by ozlabs.org (Postfix) with ESMTPS id DBBBA1007D8 for ; Thu, 27 Oct 2011 20:30:51 +1100 (EST) Received: from localhost ([::1]:53675 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1RJMIT-0007fI-EJ for incoming@patchwork.ozlabs.org; Thu, 27 Oct 2011 05:30:49 -0400 Received: from eggs.gnu.org ([140.186.70.92]:38501) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1RJMIO-0007fD-OF for qemu-devel@nongnu.org; Thu, 27 Oct 2011 05:30:45 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1RJMIK-0006LQ-JF for qemu-devel@nongnu.org; Thu, 27 Oct 2011 05:30:44 -0400 Received: from mail-yw0-f45.google.com ([209.85.213.45]:40923) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1RJMIK-0006LJ-FS for qemu-devel@nongnu.org; Thu, 27 Oct 2011 05:30:40 -0400 Received: by ywb3 with SMTP id 3so2948158ywb.4 for ; Thu, 27 Oct 2011 02:30:40 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references; bh=FDb8RvZBuIUlD/pM2KYj6m2zaMYsdZxofIEyFNZlhBI=; b=nQbKc+6GMhwpKfvKS6e009omg5YJkNYYWr1CrCNvZOq3H3gBZzE7mujrhOe5I4hHKy sOzPiTQYpdZApcmVwiR0V/iP+ZFw2FdFlKVM1jejYWcYOQbqLL2NZ/wWPWCp42d0rF7g byg+xUIdf5Dqh0MIhqxftQx7+tIYv+m5eQ+to= Received: by 10.68.33.69 with SMTP id p5mr49649440pbi.12.1319707839559; Thu, 27 Oct 2011 02:30:39 -0700 (PDT) Received: from ronniesahlberg@gmail.com (CPE-58-164-57-199.lnse5.ken.bigpond.net.au. [58.164.57.199]) by mx.google.com with ESMTPS id x8sm13239856pbx.15.2011.10.27.02.30.36 (version=TLSv1/SSLv3 cipher=OTHER); Thu, 27 Oct 2011 02:30:39 -0700 (PDT) Received: by ronniesahlberg@gmail.com (sSMTP sendmail emulation); Thu, 27 Oct 2011 20:33:51 +1100 From: Ronnie Sahlberg To: qemu-devel@nongnu.org Date: Thu, 27 Oct 2011 20:33:21 +1100 Message-Id: <1319708001-24075-2-git-send-email-ronniesahlberg@gmail.com> X-Mailer: git-send-email 1.7.3.1 In-Reply-To: <1319708001-24075-1-git-send-email-ronniesahlberg@gmail.com> References: <1319708001-24075-1-git-send-email-ronniesahlberg@gmail.com> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 2) X-Received-From: 209.85.213.45 Cc: kwolf@redhat.com, Ronnie Sahlberg Subject: [Qemu-devel] [PATCH] Documentation: Describe NBD URL syntax X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Sender: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org 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