Signed-off-by: Peter Krempa <pkrempa@xxxxxxxxxx> --- docs/drvvmware.html.in | 89 ------------------------------------------ docs/drvvmware.rst | 72 ++++++++++++++++++++++++++++++++++ docs/meson.build | 2 +- 3 files changed, 73 insertions(+), 90 deletions(-) delete mode 100644 docs/drvvmware.html.in create mode 100644 docs/drvvmware.rst diff --git a/docs/drvvmware.html.in b/docs/drvvmware.html.in deleted file mode 100644 index d581ad1d1c..0000000000 --- a/docs/drvvmware.html.in +++ /dev/null @@ -1,89 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE html> -<html xmlns="http://www.w3.org/1999/xhtml";> - <body> - <h1>VMware Workstation / Player / Fusion hypervisors driver</h1> - <p> - The libvirt VMware driver should be able to manage any Workstation, - Player, Fusion version supported by the VMware VIX API. See the - compatibility list - <a href="https://www.vmware.com/support/developer/vix-api/vix110_reference/";>here</a>. - </p> - <p> - This driver uses the "vmrun" utility which is distributed with the VMware VIX API. - You can download the VIX API - from <a href="https://www.vmware.com/support/developer/vix-api/";>here</a>. - </p> - - <h2><a id="project">Project Links</a></h2> - - <ul> - <li> - The <a href="https://www.vmware.com/";>VMware Workstation and - Player</a> hypervisors - </li> - <li> - The <a href="https://www.vmware.com/fusion";>VMware Fusion</a> - hypervisor - </li> - </ul> - - <h2>Connections to VMware driver</h2> - - <p> - The libvirt VMware driver provides per-user drivers (the "session" instance). - Three uris are available: - </p> - <ul> - <li>"vmwareplayer" for VMware Player</li> - <li>"vmwarews" for VMware Workstation</li> - <li>"vmwarefusion" for VMware Fusion</li> - </ul> - <p> - Some example connection URIs for the driver are: - </p> - -<pre> -vmwareplayer:///session (local access to VMware Player per-user instance) -vmwarews:///session (local access to VMware Workstation per-user instance) -vmwarefusion:///session (local access to VMware Fusion per-user instance) -vmwarews+tcp://user@xxxxxxxxxxx/session (remote access to VMware Workstation, SASl/Kerberos) -vmwarews+ssh://user@xxxxxxxxxxx/session (remote access to VMware Workstation, SSH tunnelled) -</pre> - - <h2><a id="xmlconfig">Example domain XML config</a></h2> - -<pre> -<domain type='vmware'> - <name>vmware</name> - <uuid>bea92244-8885-4562-828b-3b086731c5b1</uuid> - - <os> - <type>hvm</type> - </os> - - <memory>524288</memory> - <vcpu>1</vcpu> - - <features> - <pae/> - <acpi/> - </features> - - <devices> - <disk type='file' device='disk'> - <source file='/home/user/tmp/disk.vmdk'/> - <target bus='ide' dev='hda'/> - </disk> - - <interface type='bridge'> - <target dev='/dev/vmnet1'/> - <source bridge=''/> - <mac address='00:16:3e:5d:c7:9e'/> - </interface> - </devices> -</domain> -</pre> - - </body> -</html> diff --git a/docs/drvvmware.rst b/docs/drvvmware.rst new file mode 100644 index 0000000000..6db1a78a17 --- /dev/null +++ b/docs/drvvmware.rst @@ -0,0 +1,72 @@ +======================================================= +VMware Workstation / Player / Fusion hypervisors driver +======================================================= + +The libvirt VMware driver should be able to manage any Workstation, Player, +Fusion version supported by the VMware VIX API. See the compatibility list +`here <https://www.vmware.com/support/developer/vix-api/vix110_reference/>`__. + +This driver uses the "vmrun" utility which is distributed with the VMware VIX +API. You can download the VIX API from +`here <https://www.vmware.com/support/developer/vix-api/>`__. + +Project Links +------------- + +- The `VMware Workstation and Player <https://www.vmware.com/>`__ hypervisors +- The `VMware Fusion <https://www.vmware.com/fusion>`__ hypervisor + +Connections to VMware driver +---------------------------- + +The libvirt VMware driver provides per-user drivers (the "session" instance). +Three uris are available: + +- "vmwareplayer" for VMware Player +- "vmwarews" for VMware Workstation +- "vmwarefusion" for VMware Fusion + +Some example connection URIs for the driver are: + +:: + + vmwareplayer:///session (local access to VMware Player per-user instance) + vmwarews:///session (local access to VMware Workstation per-user instance) + vmwarefusion:///session (local access to VMware Fusion per-user instance) + vmwarews+tcp://user@xxxxxxxxxxx/session (remote access to VMware Workstation, SASl/Kerberos) + vmwarews+ssh://user@xxxxxxxxxxx/session (remote access to VMware Workstation, SSH tunnelled) + +Example domain XML config +------------------------- + +:: + + <domain type='vmware'> + <name>vmware</name> + <uuid>bea92244-8885-4562-828b-3b086731c5b1</uuid> + + <os> + <type>hvm</type> + </os> + + <memory>524288</memory> + <vcpu>1</vcpu> + + <features> + <pae/> + <acpi/> + </features> + + <devices> + <disk type='file' device='disk'> + <source file='/home/user/tmp/disk.vmdk'/> + <target bus='ide' dev='hda'/> + </disk> + + <interface type='bridge'> + <target dev='/dev/vmnet1'/> + <source bridge=''/> + <mac address='00:16:3e:5d:c7:9e'/> + </interface> + </devices> + </domain> diff --git a/docs/meson.build b/docs/meson.build index 99732f57ba..940fbedcfa 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -22,7 +22,6 @@ docs_html_in_files = [ 'csharp', 'dbus', 'docs', - 'drvvmware', 'drvxen', 'firewall', 'format', @@ -81,6 +80,7 @@ docs_rst_files = [ 'drvtest', 'drvvbox', 'drvvirtuozzo', + 'drvvmware', 'errors', 'formatbackup', 'formatcheckpoint', -- 2.35.1
