openkylin
/
libvirt
mirror of https://gitee.com/openkylin/libvirt.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity
libvirt/docs/drvesx.html.in

823 lines
31 KiB
HTML
Raw Normal View History

Fix multiple formatting problems in HTML docs The rule generating the HTML docs passing the --html flag to xsltproc. This makes it use the legacy HTML parser, which either ignores or tries to fix all sorts of broken XML tags. There's no reason why we should be writing broken XML in the first place, so removing --html and adding the XHTML doctype to all files forces us to create good XML. This adds the XHTML doc type and fixes many, many XML tag problems it exposes. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-05-03 22:25:37 +08:00
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<body>
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
<h1>VMware ESX hypervisor driver</h1>
<ul id="toc"></ul>
<p>
esx: Update version checks for vSphere 5.1 Also remove warnings for upcoming versions. There hadn't been any compatibility problems with new ESX version over the whole lifetime of the ESX driver, so I don't expect any in the future. Update documentation to mention vSphere 5.x support.
2012-10-25 01:50:15 +08:00
The libvirt VMware ESX driver can manage VMware ESX/ESXi 3.5/4.x/5.x and
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
VMware GSX 2.0, also called VMware Server 2.0, and possibly later
esx: Add vpx:// scheme to allow direct connection to a vCenter Add a pointer to the primary context of a connection and use it in all driver functions that don't dependent on the context type. This includes almost all functions that deal with a virDomianPtr. Therefore, using a vpx:// connection allows you to perform all the usual domain related actions like start, destroy, suspend, resume, dumpxml etc. Some functions that require an explicitly specified ESX server don't work yet. This includes the host UUID, the hostname, the general node info, the max vCPU count and the free memory. Also not working yet are migration and defining new domains.
2010-07-18 23:27:05 +08:00
versions. <span class="since">Since 0.8.3</span> the driver can also
esx: Update version checks for vSphere 5.1 Also remove warnings for upcoming versions. There hadn't been any compatibility problems with new ESX version over the whole lifetime of the ESX driver, so I don't expect any in the future. Update documentation to mention vSphere 5.x support.
2012-10-25 01:50:15 +08:00
connect to a VMware vCenter 2.5/4.x/5.x (VPX).
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
</p>
website: Point main page links to libvirt driver pages The "libvirt supports:" section on the main page of libvirt.org contains a list of hypervisors with links that point to the sites of the underlying virt technologies. The entry for KVM points to http://www.linux-kvm.org/, for example. People coming to libvirt.org for the first time are likely to know about those sites, and they're probably interested in how libvirt manages those technologies. This patch points those links to the libvirt driver pages instead. It also consolidates KVM and QEMU as there is only one libvirt driver page for them. Finally, it adds a line about networking support. v2: incorporate Eric's feedback adding project links to driver pages. website: Add project links to KVM/QEMU driver page website: Add project links to Xen driver page website: Add project links to LXC driver page website: Add project links to OpenVZ driver page website: Add project links to UML driver page website: Add project links to Virtualbox driver page website: Add project links to ESX driver page website: Add project links to VMware driver page
2011-07-16 02:33:17 +08:00
<h2><a name="project">Project Links</a></h2>
<ul>
<li>
The <a href="http://www.vmware.com/">VMware ESX and GSX</a>
hypervisors
</li>
</ul>
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
<h2><a name="prereq">Deployment pre-requisites</a></h2>
<p>
esx: Add vpx:// scheme to allow direct connection to a vCenter Add a pointer to the primary context of a connection and use it in all driver functions that don't dependent on the context type. This includes almost all functions that deal with a virDomianPtr. Therefore, using a vpx:// connection allows you to perform all the usual domain related actions like start, destroy, suspend, resume, dumpxml etc. Some functions that require an explicitly specified ESX server don't work yet. This includes the host UUID, the hostname, the general node info, the max vCPU count and the free memory. Also not working yet are migration and defining new domains.
2010-07-18 23:27:05 +08:00
None. Any out-of-the-box installation of VPX/ESX(i)/GSX should work. No
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
preparations are required on the server side, no libvirtd must be
installed on the ESX server. The driver uses version 2.5 of the remote,
SOAP based
<a href="http://www.vmware.com/support/developer/vc-sdk/visdk25pubs/ReferenceGuide/">
esx: Extend documentation about 'vcenter' and add some about 'auto_answer'
2009-11-23 04:00:15 +08:00
VMware Virtual Infrastructure API</a> (VI API) to communicate with the
esx: Fix 'vpx' MAC address range and allow arbitrary MAC addresses The MAC addresses with 00:50:56 prefix are split into several ranges: 00:50:56:00:00:00 - 00:50:56:3f:ff:ff 'static' range (manually assigned) 00:50:56:80:00:00 - 00:50:56:bf:ff:ff 'vpx' range (assigned by a VI Client) Erroneously the 'vpx' range was assumed to be larger and to occupy the remaining addresses of the 00:50:56 prefix that are not part of the 'static' range. 00:50:56 was used as prefix for generated MAC addresses, this is not possible anymore, because there are gaps in the allowed ranges. Therefore, change the prefix to 00:0c:29 which is the prefix for auto generated MAC addresses anyway. Allow arbitrary MAC addresses to be used and set the checkMACAddress VMX option to false in case the MAC address doesn't fall into any predefined range. * docs/drvesx.html.in: update website accordingly * src/esx/esx_driver.c: set the auto generation prefix to 00:0c:29 * src/esx/esx_vmx.c: fix MAC address range handling and allow arbitrary MAC addresses * tests/vmx2xml*, tests/xml2vmx*: add some basic MAC address range tests
2010-01-03 06:58:24 +08:00
ESX server, like the VMware Virtual Infrastructure Client (VI client)
does. Since version 4.0 this API is called
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
<a href="http://www.vmware.com/support/developer/vc-sdk/visdk400pubs/ReferenceGuide/">
VMware vSphere API</a>.
</p>
<h2><a name="uri">Connections to the VMware ESX driver</a></h2>
<p>
Some example remote connection URIs for the driver are:
</p>
<pre>
esx: Restrict vpx:// to handle a single host in a vCenter Now a vpx:// connection has an explicitly specified host. This allows to enabled several functions for a vpx:// connection again, like host UUID, hostname, general node info, max vCPU count, free memory, migration and defining new domains. Lookup datacenter, compute resource, resource pool and host system once and cache them. This simplifies the rest of the code and reduces overall HTTP(S) traffic a bit. esx:// and vpx:// can be mixed freely for a migration. Ensure that migration source and destination refer to the same vCenter. Also directly encode the resource pool and host system object IDs into the migration URI in the prepare function. Then directly build managed object references in the perform function instead of re-looking up already known information.
2010-08-01 05:57:42 +08:00
vpx://example-vcenter.com/dc1/srv1 (VPX over HTTPS, select ESX server 'srv1' in datacenter 'dc1')
esx: Add vpx:// scheme to allow direct connection to a vCenter Add a pointer to the primary context of a connection and use it in all driver functions that don't dependent on the context type. This includes almost all functions that deal with a virDomianPtr. Therefore, using a vpx:// connection allows you to perform all the usual domain related actions like start, destroy, suspend, resume, dumpxml etc. Some functions that require an explicitly specified ESX server don't work yet. This includes the host UUID, the hostname, the general node info, the max vCPU count and the free memory. Also not working yet are migration and defining new domains.
2010-07-18 23:27:05 +08:00
esx://example-esx.com (ESX over HTTPS)
gsx://example-gsx.com (GSX over HTTPS)
esx://example-esx.com/?transport=http (ESX over HTTP)
esx://example-esx.com/?no_verify=1 (ESX over HTTPS, but doesn't verify the server's SSL certificate)
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
</pre>
esx: Improve documentation about remote URIs
2010-03-13 05:09:11 +08:00
<p>
<strong>Note</strong>: In contrast to other drivers, the ESX driver is
a client-side-only driver. It connects to the ESX server using HTTP(S).
Therefore, the <a href="remote.html">remote transport mechanism</a>
provided by the remote driver and libvirtd will not work, and you
cannot use URIs like <code>esx+ssh://example.com</code>.
</p>
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
<h3><a name="uriformat">URI Format</a></h3>
<p>
esx: Add vpx:// scheme to allow direct connection to a vCenter Add a pointer to the primary context of a connection and use it in all driver functions that don't dependent on the context type. This includes almost all functions that deal with a virDomianPtr. Therefore, using a vpx:// connection allows you to perform all the usual domain related actions like start, destroy, suspend, resume, dumpxml etc. Some functions that require an explicitly specified ESX server don't work yet. This includes the host UUID, the hostname, the general node info, the max vCPU count and the free memory. Also not working yet are migration and defining new domains.
2010-07-18 23:27:05 +08:00
URIs have this general form (<code>[...]</code> marks an optional part).
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
</p>
<pre>
esx: Support folders in the path of vpx:// connection URIs Allow the datacenter and compute resource parts of the path to be prefixed with folders. Therefore, the way the path is parsed has changed. Before, it was split in 2 or 3 items and the items' meanings were determined by their positions. Now the path can have 2 or more items and the the vCenter server is asked whether a folder, datacenter of compute resource with the specified name exists at the current hierarchy level. Before the datacenter and compute resource lookup automatically traversed folders during lookup. This is logic got removed and folders have to be specified explicitly. The proper datacenter path including folders is now used when accessing a datastore over HTTPS. This makes virsh dumpxml and define work for datacenters in folders. https://bugzilla.redhat.com/show_bug.cgi?id=732676
2011-11-02 00:12:37 +08:00
type://[username@]hostname[:port]/[[folder/...]datacenter/[folder/...][cluster/]server][?extraparameters]
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
</pre>
<p>
The <code>type://</code> is either <code>esx://</code> or
esx: Add vpx:// scheme to allow direct connection to a vCenter Add a pointer to the primary context of a connection and use it in all driver functions that don't dependent on the context type. This includes almost all functions that deal with a virDomianPtr. Therefore, using a vpx:// connection allows you to perform all the usual domain related actions like start, destroy, suspend, resume, dumpxml etc. Some functions that require an explicitly specified ESX server don't work yet. This includes the host UUID, the hostname, the general node info, the max vCPU count and the free memory. Also not working yet are migration and defining new domains.
2010-07-18 23:27:05 +08:00
<code>gsx://</code> or <code>vpx://</code> <span class="since">since 0.8.3</span>.
The driver selects the default port depending on the <code>type://</code>.
For <code>esx://</code> and <code>vpx://</code> the default HTTPS port
is 443, for <code>gsx://</code> it is 8333.
If the port parameter is given, it overrides the default port.
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
</p>
esx: Restrict vpx:// to handle a single host in a vCenter Now a vpx:// connection has an explicitly specified host. This allows to enabled several functions for a vpx:// connection again, like host UUID, hostname, general node info, max vCPU count, free memory, migration and defining new domains. Lookup datacenter, compute resource, resource pool and host system once and cache them. This simplifies the rest of the code and reduces overall HTTP(S) traffic a bit. esx:// and vpx:// can be mixed freely for a migration. Ensure that migration source and destination refer to the same vCenter. Also directly encode the resource pool and host system object IDs into the migration URI in the prepare function. Then directly build managed object references in the perform function instead of re-looking up already known information.
2010-08-01 05:57:42 +08:00
<p>
A <code>vpx://</code> connection is currently restricted to a single
ESX server. This might be relaxed in the future. The path part of the
URI is used to specify the datacenter and the ESX server in it. If the
ESX server is part of a cluster then the cluster has to be specified too.
</p>
<p>
An example: ESX server <code>example-esx.com</code> is managed by
vCenter <code>example-vcenter.com</code> and part of cluster
<code>cluster1</code>. This cluster is part of datacenter <code>dc1</code>.
</p>
<pre>
vpx://example-vcenter.com/dc1/cluster1/example-esx.com
esx: Support folders in the path of vpx:// connection URIs Allow the datacenter and compute resource parts of the path to be prefixed with folders. Therefore, the way the path is parsed has changed. Before, it was split in 2 or 3 items and the items' meanings were determined by their positions. Now the path can have 2 or more items and the the vCenter server is asked whether a folder, datacenter of compute resource with the specified name exists at the current hierarchy level. Before the datacenter and compute resource lookup automatically traversed folders during lookup. This is logic got removed and folders have to be specified explicitly. The proper datacenter path including folders is now used when accessing a datastore over HTTPS. This makes virsh dumpxml and define work for datacenters in folders. https://bugzilla.redhat.com/show_bug.cgi?id=732676
2011-11-02 00:12:37 +08:00
</pre>
<p>
Datacenters and clusters can be organized in folders, those have to be
specified as well. The driver can handle folders
<span class="since">since 0.9.7</span>.
</p>
<pre>
vpx://example-vcenter.com/folder1/dc1/folder2/example-esx.com
esx: Restrict vpx:// to handle a single host in a vCenter Now a vpx:// connection has an explicitly specified host. This allows to enabled several functions for a vpx:// connection again, like host UUID, hostname, general node info, max vCPU count, free memory, migration and defining new domains. Lookup datacenter, compute resource, resource pool and host system once and cache them. This simplifies the rest of the code and reduces overall HTTP(S) traffic a bit. esx:// and vpx:// can be mixed freely for a migration. Ensure that migration source and destination refer to the same vCenter. Also directly encode the resource pool and host system object IDs into the migration URI in the prepare function. Then directly build managed object references in the perform function instead of re-looking up already known information.
2010-08-01 05:57:42 +08:00
</pre>
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
docs: correct invalid xml * docs/internals.html.in: Fix xml errors. * docs/formatstorageencryption.html.in: Likewise. * docs/drvesx.html.in: Likewise. * docs/archnetwork.html.in: Likewise. * docs/logging.html.in: Likewise. * docs/drvvmware.html.in: Likewise. * docs/api.html.in: Likewise. * docs/formatnwfilter.html.in: Likewise. * docs/formatdomain.html.in: Likewise. * docs/windows.html.in: Likewise.
2011-04-02 06:02:10 +08:00
<h4><a name="extraparams">Extra parameters</a></h4>
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
<p>
Extra parameters can be added to a URI as part of the query string
esx: Add vpx:// scheme to allow direct connection to a vCenter Add a pointer to the primary context of a connection and use it in all driver functions that don't dependent on the context type. This includes almost all functions that deal with a virDomianPtr. Therefore, using a vpx:// connection allows you to perform all the usual domain related actions like start, destroy, suspend, resume, dumpxml etc. Some functions that require an explicitly specified ESX server don't work yet. This includes the host UUID, the hostname, the general node info, the max vCPU count and the free memory. Also not working yet are migration and defining new domains.
2010-07-18 23:27:05 +08:00
(the part following <code>?</code>). A single parameter is formed by a
<code>name=value</code> pair. Multiple parameters are separated by
<code>&amp;</code>.
</p>
<pre>
?<span style="color: #E50000">no_verify=1</span>&amp;<span style="color: #00B200">auto_answer=1</span>&amp;<span style="color: #0000E5">proxy=socks://example-proxy.com:23456</span>
</pre>
<p>
The driver understands the extra parameters shown below.
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
</p>
<table class="top_table">
<tr>
<th>Name</th>
<th>Values</th>
<th>Meaning</th>
</tr>
<tr>
<td>
<code>transport</code>
</td>
<td>
<code>http</code> or <code>https</code>
</td>
<td>
esx: Add vpx:// scheme to allow direct connection to a vCenter Add a pointer to the primary context of a connection and use it in all driver functions that don't dependent on the context type. This includes almost all functions that deal with a virDomianPtr. Therefore, using a vpx:// connection allows you to perform all the usual domain related actions like start, destroy, suspend, resume, dumpxml etc. Some functions that require an explicitly specified ESX server don't work yet. This includes the host UUID, the hostname, the general node info, the max vCPU count and the free memory. Also not working yet are migration and defining new domains.
2010-07-18 23:27:05 +08:00
Overrides the default HTTPS transport. For <code>esx://</code>
and <code>vpx://</code> the default HTTP port is 80, for
<code>gsx://</code> it is 8222.
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
</td>
</tr>
<tr>
<td>
<code>vcenter</code>
</td>
<td>
esx: Extend documentation about 'vcenter' and add some about 'auto_answer'
2009-11-23 04:00:15 +08:00
Hostname of a VMware vCenter or <code>*</code>
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
</td>
<td>
In order to perform a migration the driver needs to know the
esx: Extend documentation about 'vcenter' and add some about 'auto_answer'
2009-11-23 04:00:15 +08:00
VMware vCenter for the ESX server. If set to <code>*</code>,
the driver connects to the vCenter known to the ESX server.
esx: Add documentation about certificates and connection problems
2010-10-22 21:01:21 +08:00
This parameter in useful when connecting to an ESX server only.
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
</td>
</tr>
<tr>
<td>
<code>no_verify</code>
</td>
<td>
<code>0</code> or <code>1</code>
</td>
<td>
If set to 1, this disables libcurl client checks of the server's
typos: fix s/it/is/ where applicable Signed-off-by: Martin Kletzander <mkletzan@redhat.com>
2014-05-05 17:49:24 +08:00
SSL certificate. The default value is 0. See the
esx: Add documentation about certificates and connection problems
2010-10-22 21:01:21 +08:00
<a href="#certificates">Certificates for HTTPS</a> section for
details.
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
</td>
</tr>
esx: Extend documentation about 'vcenter' and add some about 'auto_answer'
2009-11-23 04:00:15 +08:00
<tr>
<td>
<code>auto_answer</code>
</td>
<td>
<code>0</code> or <code>1</code>
</td>
<td>
If set to 1, the driver answers all
<a href="#questions">questions</a> with the default answer.
If set to 0, questions are reported as errors. The default
typos: fix s/it/is/ where applicable Signed-off-by: Martin Kletzander <mkletzan@redhat.com>
2014-05-05 17:49:24 +08:00
value is 0. <span class="since">Since 0.7.5</span>.
esx: Add proxy query parameter Allow to specify a proxy to be used by libcurl.
2010-06-04 05:09:12 +08:00
</td>
</tr>
<tr>
<td>
<code>proxy</code>
</td>
<td>
<code>[type://]hostname[:port]</code>
</td>
<td>
Allows to specify a proxy for HTTP and HTTPS communication.
<span class="since">Since 0.8.2</span>.
The optional <code>type</code> part may be one of:
<code>http</code>, <code>socks</code>, <code>socks4</code>,
<code>socks4a</code> or <code>socks5</code>. The default is
<code>http</code> and <code>socks</code> is synonymous for
<code>socks5</code>. The optional <code>port</code> allows to
override the default port 1080.
esx: Extend documentation about 'vcenter' and add some about 'auto_answer'
2009-11-23 04:00:15 +08:00
</td>
</tr>
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
</table>
<h3><a name="auth">Authentication</a></h3>
<p>
In order to perform any useful operation the driver needs to log into
the ESX server. Therefore, only <code>virConnectOpenAuth</code> can be
used to connect to an ESX server, <code>virConnectOpen</code> and
<code>virConnectOpenReadOnly</code> don't work.
To log into an ESX server or vCenter the driver will request
credentials using the callback passed to the
<code>virConnectOpenAuth</code> function. The driver passes the
hostname as challenge parameter to the callback. This enables the
callback to distinguish between requests for ESX server and vCenter.
</p>
<p>
<strong>Note</strong>: During the ongoing driver development, testing
is done using an unrestricted <code>root</code> account. Problems may
occur if you use a restricted account. Detailed testing with restricted
accounts has not been done yet.
</p>
esx: Add documentation about certificates and connection problems
2010-10-22 21:01:21 +08:00
<h3><a name="certificates">Certificates for HTTPS</a></h3>
<p>
By default the ESX driver uses HTTPS to communicate with an ESX server.
Proper HTTPS communication requires correctly configured SSL
certificates. This certificates are different from the ones libvirt
uses for <a href="remote.html">secure communication over TLS</a> to a
libvirtd one a remote server.
</p>
<p>
By default the driver tries to verify the server's SSL certificate
using the CA certificate pool installed on your client computer. With
an out-of-the-box installed ESX server this won't work, because a newly
installed ESX server uses auto-generated self-signed certificates.
Those are singed by a CA certificate that is typically not known to your
client computer and libvirt will report an error like this one:
</p>
<pre>
error: internal error curl_easy_perform() returned an error: Peer certificate cannot be authenticated with known CA certificates (60)
</pre>
<p>
Where are two ways to solve this problem:
</p>
<ul>
<li>
Use the <code>no_verify=1</code> <a href="#extraparams">extra parameter</a>
to disable server certificate verification.
</li>
<li>
Generate new SSL certificates signed by a CA known to your client
computer and replace the original ones on your ESX server. See the
section <i>Replace a Default Certificate with a CA-Signed Certificate</i>
in the <a href="http://www.vmware.com/pdf/vsphere4/r40/vsp_40_esx_server_config.pdf">ESX Configuration Guide</a>
</li>
</ul>
<h3><a name="connproblems">Connection problems</a></h3>
<p>
There are also other causes for connection problems than the
<a href="#certificates">HTTPS certificate</a> related ones.
</p>
<ul>
<li>
As stated before the ESX driver doesn't need the
<a href="remote.html">remote transport mechanism</a>
provided by the remote driver and libvirtd, nor does the ESX driver
support it. Therefore, using an URI including a transport in the
scheme won't work. Only <a href="#uriformat">URIs as described</a>
are supported by the ESX driver. Here's a collection of possible
error messages:
<pre>
$ virsh -c esx+tcp://example.com/
error: unable to connect to libvirtd at 'example.com': Connection refused
</pre>
<pre>
$ virsh -c esx+tls://example.com/
error: Cannot access CA certificate '/etc/pki/CA/cacert.pem': No such file or directory
</pre>
<pre>
$ virsh -c esx+ssh://example.com/
error: cannot recv data: ssh: connect to host example.com port 22: Connection refused
</pre>
<pre>
$ virsh -c esx+ssh://example.com/
error: cannot recv data: Resource temporarily unavailable
</pre>
</li>
<li>
<span class="since">Since 0.7.0</span> libvirt contains the ESX
driver. Earlier versions of libvirt will report a misleading error
about missing certificates when you try to connect to an ESX server.
<pre>
$ virsh -c esx://example.com/
error: Cannot access CA certificate '/etc/pki/CA/cacert.pem': No such file or directory
</pre>
<p>
Don't let this error message confuse you. Setting up certificates
as described on the <a href="remote.html#Remote_certificates">remote transport mechanism</a> page
does not help, as this is not a certificate related problem.
</p>
<p>
To fix this problem you need to update your libvirt to 0.7.0 or newer.
You may also see this error when you use a libvirt version that
contains the ESX driver but you or your distro disabled the ESX
driver during compilation. <span class="since">Since 0.8.3</span>
the error message has been improved in this case:
</p>
<pre>
$ virsh -c esx://example.com/
error: invalid argument in libvirt was built without the 'esx' driver
</pre>
</li>
</ul>
esx: Extend documentation about 'vcenter' and add some about 'auto_answer'
2009-11-23 04:00:15 +08:00
<h2><a name="questions">Questions blocking tasks</a></h2>
<p>
Some methods of the VI API start tasks, for example
<code>PowerOnVM_Task()</code>. Such tasks may be blocked by questions
if the ESX server detects an issue with the domain that requires user
interaction. The ESX driver cannot prompt the user to answer a
question, libvirt doesn't have an API for something like this.
</p>
<p>
The VI API provides the <code>AnswerVM()</code> method to
programmatically answer a questions. So the driver has two options
how to handle such a situation: either answer the questions with the
default answer or report the question as an error and cancel the
blocked task if possible. The
<a href="#uriformat"><code>auto_answer</code></a> query parameter
controls the answering behavior.
</p>
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
<h2><a name="xmlspecial">Specialties in the domain XML config</a></h2>
<p>
There are several specialties in the domain XML config for ESX domains.
</p>
docs: correct invalid xml * docs/internals.html.in: Fix xml errors. * docs/formatstorageencryption.html.in: Likewise. * docs/drvesx.html.in: Likewise. * docs/archnetwork.html.in: Likewise. * docs/logging.html.in: Likewise. * docs/drvvmware.html.in: Likewise. * docs/api.html.in: Likewise. * docs/formatnwfilter.html.in: Likewise. * docs/formatdomain.html.in: Likewise. * docs/windows.html.in: Likewise.
2011-04-02 06:02:10 +08:00
<h3><a name="restrictions">Restrictions</a></h3>
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
<p>
There are some restrictions for some values of the domain XML config.
The driver will complain if this restrictions are violated.
</p>
<ul>
<li>
Memory size has to be a multiple of 4096
</li>
<li>
Number of virtual CPU has to be 1 or a multiple of 2
</li>
<li>
Valid MAC address prefixes are <code>00:0c:29</code> and
esx: Fix 'vpx' MAC address range and allow arbitrary MAC addresses The MAC addresses with 00:50:56 prefix are split into several ranges: 00:50:56:00:00:00 - 00:50:56:3f:ff:ff 'static' range (manually assigned) 00:50:56:80:00:00 - 00:50:56:bf:ff:ff 'vpx' range (assigned by a VI Client) Erroneously the 'vpx' range was assumed to be larger and to occupy the remaining addresses of the 00:50:56 prefix that are not part of the 'static' range. 00:50:56 was used as prefix for generated MAC addresses, this is not possible anymore, because there are gaps in the allowed ranges. Therefore, change the prefix to 00:0c:29 which is the prefix for auto generated MAC addresses anyway. Allow arbitrary MAC addresses to be used and set the checkMACAddress VMX option to false in case the MAC address doesn't fall into any predefined range. * docs/drvesx.html.in: update website accordingly * src/esx/esx_driver.c: set the auto generation prefix to 00:0c:29 * src/esx/esx_vmx.c: fix MAC address range handling and allow arbitrary MAC addresses * tests/vmx2xml*, tests/xml2vmx*: add some basic MAC address range tests
2010-01-03 06:58:24 +08:00
<code>00:50:56</code>. <span class="since">Since 0.7.6</span>
arbitrary <a href="#macaddresses">MAC addresses</a> are supported.
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
</li>
</ul>
docs: correct invalid xml * docs/internals.html.in: Fix xml errors. * docs/formatstorageencryption.html.in: Likewise. * docs/drvesx.html.in: Likewise. * docs/archnetwork.html.in: Likewise. * docs/logging.html.in: Likewise. * docs/drvvmware.html.in: Likewise. * docs/api.html.in: Likewise. * docs/formatnwfilter.html.in: Likewise. * docs/formatdomain.html.in: Likewise. * docs/windows.html.in: Likewise.
2011-04-02 06:02:10 +08:00
<h3><a name="datastore">Datastore references</a></h3>
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
<p>
Storage is managed in datastores. VMware uses a special path format to
reference files in a datastore. Basically, the datastore name is put
into squared braces in front of the path.
</p>
<pre>
[datastore] directory/filename
</pre>
<p>
To define a new domain the driver converts the domain XML into a
VMware VMX file and uploads it to a datastore known to the ESX server.
Because multiple datastores may be known to an ESX server the driver
esx: Add vpx:// scheme to allow direct connection to a vCenter Add a pointer to the primary context of a connection and use it in all driver functions that don't dependent on the context type. This includes almost all functions that deal with a virDomianPtr. Therefore, using a vpx:// connection allows you to perform all the usual domain related actions like start, destroy, suspend, resume, dumpxml etc. Some functions that require an explicitly specified ESX server don't work yet. This includes the host UUID, the hostname, the general node info, the max vCPU count and the free memory. Also not working yet are migration and defining new domains.
2010-07-18 23:27:05 +08:00
needs to decide to which datastore the VMX file should be uploaded.
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
The driver deduces this information from the path of the source of the
first file-based harddisk listed in the domain XML.
</p>
docs: correct invalid xml * docs/internals.html.in: Fix xml errors. * docs/formatstorageencryption.html.in: Likewise. * docs/drvesx.html.in: Likewise. * docs/archnetwork.html.in: Likewise. * docs/logging.html.in: Likewise. * docs/drvvmware.html.in: Likewise. * docs/api.html.in: Likewise. * docs/formatnwfilter.html.in: Likewise. * docs/formatdomain.html.in: Likewise. * docs/windows.html.in: Likewise.
2011-04-02 06:02:10 +08:00
<h3><a name="macaddresses">MAC addresses</a></h3>
esx: Fix 'vpx' MAC address range and allow arbitrary MAC addresses The MAC addresses with 00:50:56 prefix are split into several ranges: 00:50:56:00:00:00 - 00:50:56:3f:ff:ff 'static' range (manually assigned) 00:50:56:80:00:00 - 00:50:56:bf:ff:ff 'vpx' range (assigned by a VI Client) Erroneously the 'vpx' range was assumed to be larger and to occupy the remaining addresses of the 00:50:56 prefix that are not part of the 'static' range. 00:50:56 was used as prefix for generated MAC addresses, this is not possible anymore, because there are gaps in the allowed ranges. Therefore, change the prefix to 00:0c:29 which is the prefix for auto generated MAC addresses anyway. Allow arbitrary MAC addresses to be used and set the checkMACAddress VMX option to false in case the MAC address doesn't fall into any predefined range. * docs/drvesx.html.in: update website accordingly * src/esx/esx_driver.c: set the auto generation prefix to 00:0c:29 * src/esx/esx_vmx.c: fix MAC address range handling and allow arbitrary MAC addresses * tests/vmx2xml*, tests/xml2vmx*: add some basic MAC address range tests
2010-01-03 06:58:24 +08:00
<p>
VMware has registered two MAC address prefixes for domains:
<code>00:0c:29</code> and <code>00:50:56</code>. These prefixes are
split into ranges for different purposes.
</p>
<table class="top_table">
<tr>
<th>Range</th>
<th>Purpose</th>
</tr>
<tr>
<td>
<code>00:0c:29:00:00:00</code> - <code>00:0c:29:ff:ff:ff</code>
</td>
<td>
An ESX server autogenerates MAC addresses from this range if
the VMX file doesn't contain a MAC address when trying to start
a domain.
</td>
</tr>
<tr>
<td>
<code>00:50:56:00:00:00</code> - <code>00:50:56:3f:ff:ff</code>
</td>
<td>
MAC addresses from this range can by manually assigned by the
user in the VI client.
</td>
</tr>
<tr>
<td>
<code>00:50:56:80:00:00</code> - <code>00:50:56:bf:ff:ff</code>
</td>
<td>
A VI client autogenerates MAC addresses from this range for
newly defined domains.
</td>
</tr>
</table>
<p>
The VMX files generated by the ESX driver always contain a MAC address,
because libvirt generates a random one if an interface element in the
domain XML file lacks a MAC address.
<span class="since">Since 0.7.6</span> the ESX driver sets the prefix
for generated MAC addresses to <code>00:0c:29</code>. Before 0.7.6
the <code>00:50:56</code> prefix was used. Sometimes this resulted in
the generation of out-of-range MAC address that were rejected by the
ESX server.
</p>
<p>
Also <span class="since">since 0.7.6</span> every MAC address outside
this ranges can be used. For such MAC addresses the ESX server-side
check is disabled in the VMX file to stop the ESX server from rejecting
out-of-predefined-range MAC addresses.
</p>
<pre>
ethernet0.checkMACAddress = "false"
</pre>
docs: correct invalid xml * docs/internals.html.in: Fix xml errors. * docs/formatstorageencryption.html.in: Likewise. * docs/drvesx.html.in: Likewise. * docs/archnetwork.html.in: Likewise. * docs/logging.html.in: Likewise. * docs/drvvmware.html.in: Likewise. * docs/api.html.in: Likewise. * docs/formatnwfilter.html.in: Likewise. * docs/formatdomain.html.in: Likewise. * docs/windows.html.in: Likewise.
2011-04-02 06:02:10 +08:00
<h3><a name="hardware">Available hardware</a></h3>
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
<p>
VMware ESX supports different models of SCSI controllers and network
cards.
</p>
<h4>SCSI controller models</h4>
<dl>
esx: Add autodetection for the SCSI controller model This works for file-backed SCSI disk device with a datastore related source path.
2010-07-07 01:02:48 +08:00
<dt><code>auto</code></dt>
<dd>
This isn't a actual controller model. If specified the ESX driver
tries to detect the SCSI controller model referenced in the
<code>.vmdk</code> file and use it. Autodetection fails when a
SCSI controller has multiple disks attached and the SCSI controller
models referenced in the <code>.vmdk</code> files are inconsistent.
<span class="since">Since 0.8.3</span>
</dd>
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
<dt><code>buslogic</code></dt>
<dd>
BusLogic SCSI controller for older guests.
</dd>
<dt><code>lsilogic</code></dt>
<dd>
LSI Logic SCSI controller for recent guests.
</dd>
esx: Allow 'lsisas1068' as SCSI controller type Extend tests to cover all SCSI controller types and document the new type. The lsisas1068 SCSI controller type was added in ESX 4.0. The VMX parser reports an error when this controller type is present. This makes virsh dumpxml fail for every domain that uses this controller type. This patch fixes this and adds lsisas1068 to the list of accepted SCSI controller types. Reported by Jonathan Kelley.
2010-03-13 03:08:47 +08:00
<dt><code>lsisas1068</code></dt>
<dd>
esx: Allow 'vmpvscsi' as SCSI controller model
2010-06-24 22:58:54 +08:00
LSI Logic SAS 1068 controller. <span class="since">Since 0.8.0</span>
</dd>
<dt><code>vmpvscsi</code></dt>
<dd>
Special VMware Paravirtual SCSI controller, requires VMware tools inside
the guest. See <a href="http://kb.vmware.com/kb/1010398">VMware KB1010398</a>
for details. <span class="since">Since 0.8.3</span>
esx: Allow 'lsisas1068' as SCSI controller type Extend tests to cover all SCSI controller types and document the new type. The lsisas1068 SCSI controller type was added in ESX 4.0. The VMX parser reports an error when this controller type is present. This makes virsh dumpxml fail for every domain that uses this controller type. This patch fixes this and adds lsisas1068 to the list of accepted SCSI controller types. Reported by Jonathan Kelley.
2010-03-13 03:08:47 +08:00
</dd>
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
</dl>
<p>
Here a domain XML snippet:
</p>
esx: Add support for the controller element Also don't abuse the disk driver name to specify the SCSI controller model anymore: <driver name='buslogic'/> Use the newly added model attribute of the controller element for this: <controller type='scsi' index='0' model='buslogic'/> The disk driver name approach is deprecated now, but still works for backward compatibility reasons. Update the documentation and tests accordingly. Fix usage of the words controller and id in the VMX handling code. Use controller, bus and unit properly.
2010-06-18 01:57:12 +08:00
<pre>
...
&lt;disk type='file' device='disk'&gt;
&lt;source file='[local-storage] Fedora11/Fedora11.vmdk'/&gt;
&lt;target dev='sda' bus='scsi'/&gt;
&lt;address type='drive' controller='0' bus='0' unit='0'/&gt;
&lt;/disk&gt;
&lt;controller type='scsi' index='0' model='<strong>lsilogic</strong>'/&gt;
...
</pre>
<p>
The controller element is supported <span class="since">since 0.8.2</span>.
Prior to this <code>&lt;driver name='lsilogic'/&gt;</code> was abused to
specify the SCSI controller model. This attribute usage is deprecated now.
</p>
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
<pre>
...
&lt;disk type='file' device='disk'&gt;
&lt;driver name='<strong>lsilogic</strong>'/&gt;
&lt;source file='[local-storage] Fedora11/Fedora11.vmdk'/&gt;
&lt;target dev='sda' bus='scsi'/&gt;
&lt;/disk&gt;
...
</pre>
<h4>Network card models</h4>
<dl>
<dt><code>vlance</code></dt>
<dd>
AMD PCnet32 network card for older guests.
</dd>
esx: Add support for the VMXNET 2 (Enhanced) NIC model Add a test case and document it.
2010-04-17 17:43:01 +08:00
<dt><code>vmxnet</code>, <code>vmxnet2</code>, <code>vmxnet3</code></dt>
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
<dd>
Special VMware VMXnet network card, requires VMware tools inside
esx: Add support for the VMXNET 2 (Enhanced) NIC model Add a test case and document it.
2010-04-17 17:43:01 +08:00
the guest. See <a href="http://kb.vmware.com/kb/1001805">VMware KB1001805</a>
for details.
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
</dd>
<dt><code>e1000</code></dt>
<dd>
Intel E1000 network card for recent guests.
</dd>
</dl>
<p>
Here a domain XML snippet:
</p>
<pre>
...
&lt;interface type='bridge'&gt;
&lt;mac address='00:50:56:25:48:c7'/&gt;
&lt;source bridge='VM Network'/&gt;
&lt;model type='<strong>e1000</strong>'/&gt;
&lt;/interface&gt;
...
</pre>
<h2><a name="importexport">Import and export of domain XML configs</a></h2>
<p>
The ESX driver currently supports a native config format known as
<code>vmware-vmx</code> to handle VMware VMX configs.
</p>
<h3><a name="xmlimport">Converting from VMware VMX config to domain XML config</a></h3>
<p>
The <code>virsh domxml-from-native</code> provides a way to convert an
existing VMware VMX config into a domain XML config that can then be
used by libvirt.
</p>
<pre>
$ cat &gt; demo.vmx &lt;&lt; EOF
#!/usr/bin/vmware
config.version = "8"
virtualHW.version = "4"
floppy0.present = "false"
nvram = "Fedora11.nvram"
deploymentPlatform = "windows"
virtualHW.productCompatibility = "hosted"
tools.upgrade.policy = "useGlobal"
powerType.powerOff = "default"
powerType.powerOn = "default"
powerType.suspend = "default"
powerType.reset = "default"
displayName = "Fedora11"
extendedConfigFile = "Fedora11.vmxf"
scsi0.present = "true"
scsi0.sharedBus = "none"
scsi0.virtualDev = "lsilogic"
memsize = "1024"
scsi0:0.present = "true"
scsi0:0.fileName = "/vmfs/volumes/498076b2-02796c1a-ef5b-000ae484a6a3/Fedora11/Fedora11.vmdk"
scsi0:0.deviceType = "scsi-hardDisk"
ide0:0.present = "true"
ide0:0.clientDevice = "true"
ide0:0.deviceType = "cdrom-raw"
ide0:0.startConnected = "false"
ethernet0.present = "true"
ethernet0.networkName = "VM Network"
ethernet0.addressType = "vpx"
esx: Add support for the controller element Also don't abuse the disk driver name to specify the SCSI controller model anymore: <driver name='buslogic'/> Use the newly added model attribute of the controller element for this: <controller type='scsi' index='0' model='buslogic'/> The disk driver name approach is deprecated now, but still works for backward compatibility reasons. Update the documentation and tests accordingly. Fix usage of the words controller and id in the VMX handling code. Use controller, bus and unit properly.
2010-06-18 01:57:12 +08:00
ethernet0.generatedAddress = "00:50:56:91:48:c7"
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
chipset.onlineStandby = "false"
guestOSAltName = "Red Hat Enterprise Linux 5 (32-Bit)"
guestOS = "rhel5"
uuid.bios = "50 11 5e 16 9b dc 49 d7-f1 71 53 c4 d7 f9 17 10"
snapshot.action = "keep"
sched.cpu.min = "0"
sched.cpu.units = "mhz"
sched.cpu.shares = "normal"
sched.mem.minsize = "0"
sched.mem.shares = "normal"
toolScripts.afterPowerOn = "true"
toolScripts.afterResume = "true"
toolScripts.beforeSuspend = "true"
toolScripts.beforePowerOff = "true"
scsi0:0.redo = ""
tools.syncTime = "false"
uuid.location = "56 4d b5 06 a2 bd fb eb-ae 86 f7 d8 49 27 d0 c4"
sched.cpu.max = "unlimited"
sched.swap.derivedName = "/vmfs/volumes/498076b2-02796c1a-ef5b-000ae484a6a3/Fedora11/Fedora11-7de040d8.vswp"
tools.remindInstall = "TRUE"
EOF
$ virsh -c esx://example.com domxml-from-native vmware-vmx demo.vmx
Enter username for example.com [root]:
Enter root password for example.com:
&lt;domain type='vmware'&gt;
&lt;name&gt;Fedora11&lt;/name&gt;
&lt;uuid&gt;50115e16-9bdc-49d7-f171-53c4d7f91710&lt;/uuid&gt;
&lt;memory&gt;1048576&lt;/memory&gt;
&lt;currentMemory&gt;1048576&lt;/currentMemory&gt;
&lt;vcpu&gt;1&lt;/vcpu&gt;
&lt;os&gt;
&lt;type arch='i686'&gt;hvm&lt;/type&gt;
&lt;/os&gt;
&lt;clock offset='utc'/&gt;
&lt;on_poweroff&gt;destroy&lt;/on_poweroff&gt;
&lt;on_reboot&gt;restart&lt;/on_reboot&gt;
&lt;on_crash&gt;destroy&lt;/on_crash&gt;
&lt;devices&gt;
&lt;disk type='file' device='disk'&gt;
&lt;source file='[local-storage] Fedora11/Fedora11.vmdk'/&gt;
&lt;target dev='sda' bus='scsi'/&gt;
esx: Add support for the controller element Also don't abuse the disk driver name to specify the SCSI controller model anymore: <driver name='buslogic'/> Use the newly added model attribute of the controller element for this: <controller type='scsi' index='0' model='buslogic'/> The disk driver name approach is deprecated now, but still works for backward compatibility reasons. Update the documentation and tests accordingly. Fix usage of the words controller and id in the VMX handling code. Use controller, bus and unit properly.
2010-06-18 01:57:12 +08:00
&lt;address type='drive' controller='0' bus='0' unit='0'/&gt;
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
&lt;/disk&gt;
esx: Add support for the controller element Also don't abuse the disk driver name to specify the SCSI controller model anymore: <driver name='buslogic'/> Use the newly added model attribute of the controller element for this: <controller type='scsi' index='0' model='buslogic'/> The disk driver name approach is deprecated now, but still works for backward compatibility reasons. Update the documentation and tests accordingly. Fix usage of the words controller and id in the VMX handling code. Use controller, bus and unit properly.
2010-06-18 01:57:12 +08:00
&lt;controller type='scsi' index='0' model='lsilogic'/&gt;
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
&lt;interface type='bridge'&gt;
&lt;mac address='00:50:56:91:48:c7'/&gt;
&lt;source bridge='VM Network'/&gt;
&lt;/interface&gt;
&lt;/devices&gt;
&lt;/domain&gt;
</pre>
<h3><a name="xmlexport">Converting from domain XML config to VMware VMX config</a></h3>
<p>
The <code>virsh domxml-to-native</code> provides a way to convert a
domain XML config into a VMware VMX config.
</p>
<pre>
$ cat &gt; demo.xml &lt;&lt; EOF
&lt;domain type='vmware'&gt;
&lt;name&gt;Fedora11&lt;/name&gt;
&lt;uuid&gt;50115e16-9bdc-49d7-f171-53c4d7f91710&lt;/uuid&gt;
&lt;memory&gt;1048576&lt;/memory&gt;
&lt;currentMemory&gt;1048576&lt;/currentMemory&gt;
&lt;vcpu&gt;1&lt;/vcpu&gt;
&lt;os&gt;
&lt;type arch='x86_64'&gt;hvm&lt;/type&gt;
&lt;/os&gt;
&lt;devices&gt;
&lt;disk type='file' device='disk'&gt;
&lt;source file='[local-storage] Fedora11/Fedora11.vmdk'/&gt;
&lt;target dev='sda' bus='scsi'/&gt;
esx: Add support for the controller element Also don't abuse the disk driver name to specify the SCSI controller model anymore: <driver name='buslogic'/> Use the newly added model attribute of the controller element for this: <controller type='scsi' index='0' model='buslogic'/> The disk driver name approach is deprecated now, but still works for backward compatibility reasons. Update the documentation and tests accordingly. Fix usage of the words controller and id in the VMX handling code. Use controller, bus and unit properly.
2010-06-18 01:57:12 +08:00
&lt;address type='drive' controller='0' bus='0' unit='0'/&gt;
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
&lt;/disk&gt;
esx: Add support for the controller element Also don't abuse the disk driver name to specify the SCSI controller model anymore: <driver name='buslogic'/> Use the newly added model attribute of the controller element for this: <controller type='scsi' index='0' model='buslogic'/> The disk driver name approach is deprecated now, but still works for backward compatibility reasons. Update the documentation and tests accordingly. Fix usage of the words controller and id in the VMX handling code. Use controller, bus and unit properly.
2010-06-18 01:57:12 +08:00
&lt;controller type='scsi' index='0' model='lsilogic'/&gt;
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
&lt;interface type='bridge'&gt;
&lt;mac address='00:50:56:25:48:c7'/&gt;
&lt;source bridge='VM Network'/&gt;
&lt;/interface&gt;
&lt;/devices&gt;
&lt;/domain&gt;
EOF
$ virsh -c esx://example.com domxml-to-native vmware-vmx demo.xml
Enter username for example.com [root]:
Enter root password for example.com:
config.version = "8"
virtualHW.version = "4"
guestOS = "other-64"
uuid.bios = "50 11 5e 16 9b dc 49 d7-f1 71 53 c4 d7 f9 17 10"
displayName = "Fedora11"
memsize = "1024"
numvcpus = "1"
scsi0.present = "true"
scsi0.virtualDev = "lsilogic"
scsi0:0.present = "true"
scsi0:0.deviceType = "scsi-hardDisk"
scsi0:0.fileName = "/vmfs/volumes/local-storage/Fedora11/Fedora11.vmdk"
ethernet0.present = "true"
ethernet0.networkName = "VM Network"
ethernet0.connectionType = "bridged"
ethernet0.addressType = "static"
ethernet0.address = "00:50:56:25:48:C7"
</pre>
<h2><a name="xmlconfig">Example domain XML configs</a></h2>
<h3>Fedora11 on x86_64</h3>
<pre>
&lt;domain type='vmware'&gt;
&lt;name&gt;Fedora11&lt;/name&gt;
&lt;uuid&gt;50115e16-9bdc-49d7-f171-53c4d7f91710&lt;/uuid&gt;
&lt;memory&gt;1048576&lt;/memory&gt;
&lt;currentMemory&gt;1048576&lt;/currentMemory&gt;
&lt;vcpu&gt;1&lt;/vcpu&gt;
&lt;os&gt;
&lt;type arch='x86_64'&gt;hvm&lt;/type&gt;
&lt;/os&gt;
&lt;devices&gt;
&lt;disk type='file' device='disk'&gt;
&lt;source file='[local-storage] Fedora11/Fedora11.vmdk'/&gt;
&lt;target dev='sda' bus='scsi'/&gt;
esx: Add support for the controller element Also don't abuse the disk driver name to specify the SCSI controller model anymore: <driver name='buslogic'/> Use the newly added model attribute of the controller element for this: <controller type='scsi' index='0' model='buslogic'/> The disk driver name approach is deprecated now, but still works for backward compatibility reasons. Update the documentation and tests accordingly. Fix usage of the words controller and id in the VMX handling code. Use controller, bus and unit properly.
2010-06-18 01:57:12 +08:00
&lt;address type='drive' controller='0' bus='0' unit='0'/&gt;
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
&lt;/disk&gt;
esx: Add support for the controller element Also don't abuse the disk driver name to specify the SCSI controller model anymore: <driver name='buslogic'/> Use the newly added model attribute of the controller element for this: <controller type='scsi' index='0' model='buslogic'/> The disk driver name approach is deprecated now, but still works for backward compatibility reasons. Update the documentation and tests accordingly. Fix usage of the words controller and id in the VMX handling code. Use controller, bus and unit properly.
2010-06-18 01:57:12 +08:00
&lt;controller type='scsi' index='0'/&gt;
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
&lt;interface type='bridge'&gt;
&lt;mac address='00:50:56:25:48:c7'/&gt;
&lt;source bridge='VM Network'/&gt;
&lt;/interface&gt;
&lt;/devices&gt;
&lt;/domain&gt;
</pre>
<h2><a name="migration">Migration</a></h2>
<p>
A migration cannot be initiated on an ESX server directly, a VMware
esx: Extend documentation about 'vcenter' and add some about 'auto_answer'
2009-11-23 04:00:15 +08:00
vCenter is necessary for this. The <code>vcenter</code> query
parameter must be set either to the hostname or IP address of the
vCenter managing the ESX server or to <code>*</code>. Setting it
to <code>*</code> causes the driver to connect to the vCenter known to
the ESX server. If the ESX server is not managed by a vCenter an error
is reported.
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
</p>
<pre>
esx://example.com/?vcenter=example-vcenter.com
</pre>
<p>
esx: Restrict vpx:// to handle a single host in a vCenter Now a vpx:// connection has an explicitly specified host. This allows to enabled several functions for a vpx:// connection again, like host UUID, hostname, general node info, max vCPU count, free memory, migration and defining new domains. Lookup datacenter, compute resource, resource pool and host system once and cache them. This simplifies the rest of the code and reduces overall HTTP(S) traffic a bit. esx:// and vpx:// can be mixed freely for a migration. Ensure that migration source and destination refer to the same vCenter. Also directly encode the resource pool and host system object IDs into the migration URI in the prepare function. Then directly build managed object references in the perform function instead of re-looking up already known information.
2010-08-01 05:57:42 +08:00
Here's an example how to migrate the domain <code>Fedora11</code> from
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
ESX server <code>example-src.com</code> to ESX server
esx: Extend documentation about 'vcenter' and add some about 'auto_answer'
2009-11-23 04:00:15 +08:00
<code>example-dst.com</code> implicitly involving vCenter
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
<code>example-vcenter.com</code> using <code>virsh</code>.
</p>
<pre>
esx: Extend documentation about 'vcenter' and add some about 'auto_answer'
2009-11-23 04:00:15 +08:00
$ virsh -c esx://example-src.com/?vcenter=* migrate Fedora11 esx://example-dst.com/?vcenter=*
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
Enter username for example-src.com [root]:
Enter root password for example-src.com:
Enter username for example-vcenter.com [administrator]:
Enter administrator password for example-vcenter.com:
Enter username for example-dst.com [root]:
Enter root password for example-dst.com:
Enter username for example-vcenter.com [administrator]:
Enter administrator password for example-vcenter.com:
esx: Restrict vpx:// to handle a single host in a vCenter Now a vpx:// connection has an explicitly specified host. This allows to enabled several functions for a vpx:// connection again, like host UUID, hostname, general node info, max vCPU count, free memory, migration and defining new domains. Lookup datacenter, compute resource, resource pool and host system once and cache them. This simplifies the rest of the code and reduces overall HTTP(S) traffic a bit. esx:// and vpx:// can be mixed freely for a migration. Ensure that migration source and destination refer to the same vCenter. Also directly encode the resource pool and host system object IDs into the migration URI in the prepare function. Then directly build managed object references in the perform function instead of re-looking up already known information.
2010-08-01 05:57:42 +08:00
</pre>
<p>
<span class="since">Since 0.8.3</span> you can directly connect to a vCenter.
This simplifies migration a bit. Here's the same migration as above but
using <code>vpx://</code> connections and assuming both ESX server are in
datacenter <code>dc1</code> and aren't part of a cluster.
</p>
<pre>
$ virsh -c vpx://example-vcenter.com/dc1/example-src.com migrate Fedora11 vpx://example-vcenter.com/dc1/example-dst.com
Enter username for example-vcenter.com [administrator]:
Enter administrator password for example-vcenter.com:
Enter username for example-vcenter.com [administrator]:
Enter administrator password for example-vcenter.com:
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
</pre>
<h2><a name="scheduler">Scheduler configuration</a></h2>
<p>
The driver exposes the ESX CPU scheduler. The parameters listed below
are available to control the scheduler.
</p>
<dl>
<dt><code>reservation</code></dt>
<dd>
The amount of CPU resource in MHz that is guaranteed to be
available to the domain. Valid values are 0 and greater.
</dd>
<dt><code>limit</code></dt>
<dd>
The CPU utilization of the domain will be
limited to this value in MHz, even if more CPU resources are
available. If the limit is set to -1, the CPU utilization of the
domain is unlimited. If the limit is not set to -1, it must be
greater than or equal to the reservation.
</dd>
<dt><code>shares</code></dt>
<dd>
Shares are used to determine relative CPU
allocation between domains. In general, a domain with more shares
gets proportionally more of the CPU resource. Valid values are 0
and greater. The special values -1, -2 and -3 represent the
predefined shares level <code>low</code>, <code>normal</code> and
<code>high</code>.
</dd>
</dl>
<h2><a name="tools">VMware tools</a></h2>
<p>
Some actions require installed VMware tools. If the VMware tools are
not installed in the guest and one of the actions below is to be
performed the ESX server raises an error and the driver reports it.
</p>
<ul>
<li>
<code>virDomainReboot</code>
</li>
<li>
<code>virDomainShutdown</code>
</li>
</ul>
<h2><a name="links">Links</a></h2>
<ul>
<li>
<a href="http://www.vmware.com/support/developer/vc-sdk/">
VMware vSphere Web Services SDK Documentation
</a>
</li>
<li>
<a href="http://www.vmware.com/pdf/esx3_memory.pdf">
The Role of Memory in VMware ESX Server 3
</a>
</li>
<li>
<a href="http://www.sanbarrow.com/vmx.html">
VMware VMX config parameters
</a>
</li>
esx: Allow 'vmpvscsi' as SCSI controller model
2010-06-24 22:58:54 +08:00
<li>
<a href="http://www.vmware.com/pdf/vsp_4_pvscsi_perf.pdf">
VMware ESX 4.0 PVSCSI Storage Performance
</a>
</li>
esx: Add documentation to the website * docs/drivers.html.in: list the ESX driver * docs/drvesx.html.in: the new ESX driver documentation * docs/hvsupport.html.in: add the ESX driver to the matrix * docs/index.html.in, docs/sitemap.html.in: list the ESX driver * src/esx/esx_driver.c: fix and cleanup some comments
2009-11-14 05:43:10 +08:00
</ul>
</body></html>