From patchwork Wed Oct 26 12:51:37 2011 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: ronnie sahlberg X-Patchwork-Id: 121896 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 5A0061007DB for ; Wed, 26 Oct 2011 23:49:17 +1100 (EST) Received: from localhost ([::1]:54742 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1RJ2up-0007uT-H0 for incoming@patchwork.ozlabs.org; Wed, 26 Oct 2011 08:49:07 -0400 Received: from eggs.gnu.org ([140.186.70.92]:43511) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1RJ2ue-0007ha-Ln for qemu-devel@nongnu.org; Wed, 26 Oct 2011 08:49:00 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1RJ2uc-0004q7-Ve for qemu-devel@nongnu.org; Wed, 26 Oct 2011 08:48:56 -0400 Received: from mail-pz0-f43.google.com ([209.85.210.43]:54823) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1RJ2uc-0004p5-M5 for qemu-devel@nongnu.org; Wed, 26 Oct 2011 08:48:54 -0400 Received: by pzk33 with SMTP id 33so4119466pzk.2 for ; Wed, 26 Oct 2011 05:48:53 -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=mE69FrMRr3Cx31LX27fdYgpRrUyySWqQ3AfRuTzh3nU=; b=IRegm0mE9tLltw8v4AUD6oeIduJ/FDNaQKLMRC3xcbQn33aOJubUFrGliSmreJVJli sGkjTmniFyw2nhF6Zml90i9izNdNTbkaUoRo9nliI8CGO30YWxBp4QWSbU5BK4+5C7m6 z8BeJEM5DxbjaekkLm1dCfc8s2gbrCx0ch7LA= Received: by 10.68.64.169 with SMTP id p9mr6093531pbs.116.1319633333051; Wed, 26 Oct 2011 05:48:53 -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 lt6sm5491088pbb.17.2011.10.26.05.48.49 (version=TLSv1/SSLv3 cipher=OTHER); Wed, 26 Oct 2011 05:48:52 -0700 (PDT) Received: by ronniesahlberg@gmail.com (sSMTP sendmail emulation); Wed, 26 Oct 2011 23:51:54 +1100 From: Ronnie Sahlberg To: qemu-devel@nongnu.org Date: Wed, 26 Oct 2011 23:51:37 +1100 Message-Id: <1319633497-19923-2-git-send-email-ronniesahlberg@gmail.com> X-Mailer: git-send-email 1.7.3.1 In-Reply-To: <1319633497-19923-1-git-send-email-ronniesahlberg@gmail.com> References: <1319633497-19923-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.210.43 Cc: kwolf@redhat.com, Ronnie Sahlberg Subject: [Qemu-devel] [PATCH] Documentation: add new section for device URL syntax for special files and describe the iSCSI URL with examples 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 Signed-off-by: Ronnie Sahlberg Reviewed-by: Stefan Hajnoczi --- qemu-options.hx | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 42 insertions(+), 0 deletions(-) diff --git a/qemu-options.hx b/qemu-options.hx index 5d2a776..7c434f8 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -148,6 +148,9 @@ Define a new drive. Valid options are: This option defines which disk image (@pxref{disk_images}) to use with this drive. If the filename contains comma, you must double it (for instance, "file=my,,file" to use file "my,file"). + +Special files such as iSCSI devices can be specified using protocol +specific URLs. See the section for "Device URL Syntax" for more information. @item if=@var{interface} This option defines on which type on interface the drive is connected. Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio. @@ -1718,6 +1721,45 @@ ETEXI DEFHEADING() +DEFHEADING(Device URL Syntax:) + +In addition to using normal file images for the emulated storage devices, +QEMU can also use networked resources such as iSCSI devices. These are +specified using a special URL syntax. + +STEXI +@table @option +@item iSCSI +iSCSI support allows QEMU to access iSCSI resources directly and use as +images for the guest storage. Both disk and cdrom images are supported. + +Syntax for specifying iSCSI LUNs is +``iscsi://[:]//'' + +Example (without authentication): +@example +qemu -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \ +--drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 +@end example + +Example (CHAP username/password via URL): +@example +qemu --drive file=iscsi://user%password@192.0.2.1/iqn.2001-04.com.example/1 +@end example + +Example (CHAP username/password via environment variables): +@example +LIBISCSI_CHAP_USERNAME="user" \ +LIBISCSI_CHAP_PASSWORD="password" \ +qemu --drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 +@end example + +iSCSI support is an optional feature of QEMU and only available when +compiled and linked against libiscsi. + +@end table +ETEXI + DEFHEADING(Bluetooth(R) options:) DEF("bt", HAS_ARG, QEMU_OPTION_bt, \