From nobody Mon Feb 9 11:05:58 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) client-ip=170.10.133.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1648469475; cv=none; d=zohomail.com; s=zohoarc; b=S9cGhFj7th8EGRDf9XlcApLzzUgmfQPNfVgf96Pxp1K8VUB4an/UgZd0EWUHxJ4pf4qT+Nz/IJBuEdNx8mafO7e1OMlvptcEV2ZQ87o1gq4yLDYpEh/3bS2qWIkSXUveNeUg3R1kH4W7t1X4ykTo2seVTX3myfG4efIAyd9U96A= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1648469475; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=iwze2XSqQ5HV6E9b1njq09ptJd02uxqh3hJvSOAg9jE=; b=azPCAq4RISoe9bgnwYHaVd5HlIZtmDUbVblGjULkUx2PxX6MzoKeji/t4oUOSnfDbhY9ukhzpZ00J6FjOYesLugTspWNVFMa3fYYqBoWhUEh58Pb9SpoxxoFw1l5niHhc0SVCidIGrRWpRVfikx5ruNlRmgIhBG5nkrVP/AyKVc= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mx.zohomail.com with SMTPS id 1648469475281265.26210587179924; Mon, 28 Mar 2022 05:11:15 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-272-TgOEh7ILNHm78zAAQv-yKg-1; Mon, 28 Mar 2022 08:11:02 -0400 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.rdu2.redhat.com [10.11.54.2]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 5E8A5100BAC9; Mon, 28 Mar 2022 12:10:59 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id 4805040149AC; Mon, 28 Mar 2022 12:10:59 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 9FD501940375; Mon, 28 Mar 2022 12:10:58 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.rdu2.redhat.com [10.11.54.7]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 216B51947BBE for ; Mon, 28 Mar 2022 12:10:58 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 16BD1140240A; Mon, 28 Mar 2022 12:10:58 +0000 (UTC) Received: from speedmetal.lan (unknown [10.40.208.35]) by smtp.corp.redhat.com (Postfix) with ESMTP id 86F38140241F for ; Mon, 28 Mar 2022 12:10:57 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1648469474; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=iwze2XSqQ5HV6E9b1njq09ptJd02uxqh3hJvSOAg9jE=; b=LuhusLXgzXMzdRk3v4rsCI9EeqC0K4Wzw7XWG00C4o2bXyy+8A+/61wotLLYsMMv6B8AFq byirnsN0dLHGrU8jwoOeVYB2pHvl4ZyQe+FdxrbpdQ/fg8WtZIt8mnfGI7Mdetn1tupHkF GvrwLlLlpgQoO5nQv9wG9PbqiK+hbLo= X-MC-Unique: TgOEh7ILNHm78zAAQv-yKg-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Peter Krempa To: libvir-list@redhat.com Subject: [PATCH 11/29] docs: Convert 'drvvbox' page to rST Date: Mon, 28 Mar 2022 14:10:26 +0200 Message-Id: <7cefabc36b404a29cd0b4739968d8bdb340a2874.1648469356.git.pkrempa@redhat.com> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.7 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.84 on 10.11.54.2 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1648469476332100001 Content-Type: text/plain; charset="utf-8"; x-default="true" Signed-off-by: Peter Krempa Reviewed-by: Erik Skultety --- docs/drvvbox.html.in | 172 ------------------------------------------- docs/drvvbox.rst | 161 ++++++++++++++++++++++++++++++++++++++++ docs/meson.build | 2 +- 3 files changed, 162 insertions(+), 173 deletions(-) delete mode 100644 docs/drvvbox.html.in create mode 100644 docs/drvvbox.rst diff --git a/docs/drvvbox.html.in b/docs/drvvbox.html.in deleted file mode 100644 index 0c0d14fa6a..0000000000 --- a/docs/drvvbox.html.in +++ /dev/null @@ -1,172 +0,0 @@ - - - - -

VirtualBox hypervisor driver

-

- The libvirt VirtualBox driver can manage any VirtualBox version - from version 4.0 onwards - (since libvirt 3.0.0). -

- -

Project Links

- - - -

Connections to VirtualBox driver

- -

- The libvirt VirtualBox driver provides per-user drivers (the "session"= instance). - The uri of the driver protocol is "vbox". Some example connection URIs= for the driver are: -

- -
-vbox:///session                      (local access to per-user instance)
-vbox+unix:///session                 (local access to per-user instance)
-vbox+tcp://user@example.com/session  (remote access, SASl/Kerberos)
-vbox+ssh://user@example.com/session  (remote access, SSH tunnelled)
-
- -

- NOTE: as of libvirt 1.0.6, the VirtualBox driver will always - run inside the libvirtd daemon, instead of being built-in to the - libvirt.so library directly. This change was required due to the - fact that VirtualBox code is LGPLv2-only licensed, which is not - compatible with the libvirt.so license of LGPLv2-or-later. The - daemon will be auto-started when the first connection to VirtualBox - is requested. This change also means that it will not be possible - to use VirtualBox URIs on the Windows platform, until additional - work is completed to get the libvirtd daemon working there. -

- -

Example domain XML config

- -
-<domain type=3D'vbox'>
-  <name>vbox</name>
-  <uuid>4dab22b31d52d8f32516782e98ab3fa0</uuid>
-
-  <os>
-    <type>hvm</type>
-    <boot dev=3D'cdrom'/>
-    <boot dev=3D'hd'/>
-    <boot dev=3D'fd'/>
-    <boot dev=3D'network'/>
-  </os>
-
-  <memory>654321</memory>
-  <vcpu>1</vcpu>
-
-  <features>
-    <pae/>
-    <acpi/>
-    <apic/>
-  </features>
-
-  <devices>
-    <!--Set IDE controller model to PIIX4 (default PIIX3)-->
-    <controller type=3D'ide' model=3D'piix4'/>
-
-    <controller type=3D'scsi' index=3D'0'/>
-
-    <!--VirtualBox SAS Controller-->
-    <controller type=3D'scsi' index=3D'1' model=3D'lsisas1068'/>
-
-    <disk type=3D'file' device=3D'cdrom'>
-      <source file=3D'/home/user/Downloads/slax-6.0.9.iso'/>
-      <target dev=3D'hdc'/>
-      <readonly/>
-    </disk>
-
-    <disk type=3D'file' device=3D'disk'>
-      <source file=3D'/home/user/tmp/vbox.vdi'/>
-      <target dev=3D'hdd'/>
-    </disk>
-
-    <!--Attach to the SCSI controller (index=3D0, default)-->
-    <disk type=3D'file' device=3D'disk'>
-      <source file=3D'/home/user/tmp/vbox2.vdi'/>
-      <target dev=3D'sda' bus=3D'scsi'/>
-    </disk>
-
-    <!--Attach to the SAS controller (index=3D1)-->
-    <disk type=3D'file' device=3D'disk'>
-      <source file=3D'/home/user/tmp/vbox3.vdi'/>
-      <target dev=3D'sda' bus=3D'scsi'/>
-      <address type=3D'drive' controller=3D'1' bus=3D'0' target=3D'0' u=
nit=3D'0'/>
-    </disk>
-
-    <disk type=3D'file' device=3D'floppy'>
-      <source file=3D'/home/user/tmp/WIN98C.IMG'/>
-      <target dev=3D'fda'/>
-    </disk>
-
-    <filesystem type=3D'mount'>
-      <source dir=3D'/home/user/stuff'/>
-      <target dir=3D'my-shared-folder'/>
-    </filesystem>
-
-    <!--BRIDGE-->
-    <interface type=3D'bridge'>
-      <source bridge=3D'eth0'/>
-      <mac address=3D'00:16:3e:5d:c7:9e'/>
-      <model type=3D'am79c973'/>
-    </interface>
-
-    <!--NAT-->
-    <interface type=3D'user'>
-      <mac address=3D'56:16:3e:5d:c7:9e'/>
-      <model type=3D'82540eM'/>
-    </interface>
-
-    <graphics type=3D'desktop'/>
-
-    <!--Activate the VRDE server with a port in 3389-3689 range-->
-    <graphics type=3D'rdp' autoport=3D'yes' multiUser=3D'yes'/>
-
-    <sound model=3D'sb16'/>
-
-    <parallel type=3D'dev'>
-      <source path=3D'/dev/pts/1'/>
-      <target port=3D'0'/>
-    </parallel>
-
-    <parallel type=3D'dev'>
-      <source path=3D'/dev/pts/2'/>
-      <target port=3D'1'/>
-    </parallel>
-
-    <serial type=3D"dev">
-      <source path=3D"/dev/ttyS0"/>
-      <target port=3D"0"/>
-    </serial>
-
-    <serial type=3D"pipe">
-      <source path=3D"/tmp/serial.txt"/>
-      <target port=3D"1"/>
-    </serial>
-
-    <hostdev mode=3D'subsystem' type=3D'usb'>
-      <source>
-        <vendor id=3D'0x1234'/>
-        <product id=3D'0xbeef'/>
-      </source>
-    </hostdev>
-
-    <hostdev mode=3D'subsystem' type=3D'usb'>
-      <source>
-        <vendor id=3D'0x4321'/>
-        <product id=3D'0xfeeb'/>
-      </source>
-    </hostdev>
-  </devices>
-</domain>
-
- - - diff --git a/docs/drvvbox.rst b/docs/drvvbox.rst new file mode 100644 index 0000000000..5154280ca2 --- /dev/null +++ b/docs/drvvbox.rst @@ -0,0 +1,161 @@ +.. role:: since + +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D +VirtualBox hypervisor driver +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D + +The libvirt VirtualBox driver can manage any VirtualBox version from versi= on 4.0 +onwards ( :since:`since libvirt 3.0.0` ). + +Project Links +------------- + +- The `VirtualBox `__ hypervisor + +Connections to VirtualBox driver +-------------------------------- + +The libvirt VirtualBox driver provides per-user drivers (the "session" +instance). The uri of the driver protocol is "vbox". Some example connecti= on +URIs for the driver are: + +:: + + vbox:///session (local access to per-user instance) + vbox+unix:///session (local access to per-user instance) + vbox+tcp://user@example.com/session (remote access, SASl/Kerberos) + vbox+ssh://user@example.com/session (remote access, SSH tunnelled) + +**NOTE: as of libvirt 1.0.6, the VirtualBox driver will always run inside = the +libvirtd daemon, instead of being built-in to the libvirt.so library direc= tly. +This change was required due to the fact that VirtualBox code is LGPLv2-on= ly +licensed, which is not compatible with the libvirt.so license of +LGPLv2-or-later. The daemon will be auto-started when the first connection= to +VirtualBox is requested. This change also means that it will not be possib= le to +use VirtualBox URIs on the Windows platform, until additional work is comp= leted +to get the libvirtd daemon working there.** + +Example domain XML config +------------------------- + +:: + + + vbox + 4dab22b31d52d8f32516782e98ab3fa0 + + + hvm + + + + + + + 654321 + 1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/meson.build b/docs/meson.build index 5995b2ec91..954c4e4b96 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -22,7 +22,6 @@ docs_html_in_files =3D [ 'csharp', 'dbus', 'docs', - 'drvvbox', 'drvvirtuozzo', 'drvvmware', 'drvxen', @@ -81,6 +80,7 @@ docs_rst_files =3D [ 'drvqemu', 'drvsecret', 'drvtest', + 'drvvbox', 'errors', 'formatbackup', 'formatcheckpoint', --=20 2.35.1