openstack-manuals/doc/common/tables/cinder-vmware.xml
Gauvain Pocentek e7cbc675ce update the config reference tables for liberty
Change-Id: I959cc6884633ada1deb55f44ca1fc6f230bdebd9
2015-10-29 07:45:04 +01:00

97 lines
4.8 KiB
XML

<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_vmware">
<caption>Description of VMware configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>vmware_api_retry_count</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Number of times VMware ESX/vCenter server API must be retried upon connection related issues.</td>
</tr>
<tr>
<td><option>vmware_ca_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) CA bundle file to use in verifying the vCenter server certificate.</td>
</tr>
<tr>
<td><option>vmware_cluster_name</option> = <replaceable>None</replaceable></td>
<td>(MultiStrOpt) Name of a vCenter compute cluster where volumes should be created.</td>
</tr>
<tr>
<td><option>vmware_host_ip</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) IP address for connecting to VMware ESX/vCenter server.</td>
</tr>
<tr>
<td><option>vmware_host_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password for authenticating with VMware ESX/vCenter server.</td>
</tr>
<tr>
<td><option>vmware_host_username</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Username for authenticating with VMware ESX/vCenter server.</td>
</tr>
<tr>
<td><option>vmware_host_version</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Optional string specifying the VMware vCenter server version. The driver attempts to retrieve the version from VMware vCenter server. Set this configuration only if you want to override the vCenter server version.</td>
</tr>
<tr>
<td><option>vmware_image_transfer_timeout_secs</option> = <replaceable>7200</replaceable></td>
<td>(IntOpt) Timeout in seconds for VMDK volume transfer between Cinder and Glance.</td>
</tr>
<tr>
<td><option>vmware_insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) If true, the vCenter server certificate is not verified. If false, then the default CA truststore is used for verification. This option is ignored if "vmware_ca_file" is set.</td>
</tr>
<tr>
<td><option>vmware_max_objects_retrieval</option> = <replaceable>100</replaceable></td>
<td>(IntOpt) Max number of objects to be retrieved per batch. Query results will be obtained in batches from the server and not in one shot. Server may still limit the count to something less than the configured value.</td>
</tr>
<tr>
<td><option>vmware_task_poll_interval</option> = <replaceable>0.5</replaceable></td>
<td>(FloatOpt) The interval (in seconds) for polling remote tasks invoked on VMware ESX/vCenter server.</td>
</tr>
<tr>
<td><option>vmware_tmp_dir</option> = <replaceable>/tmp</replaceable></td>
<td>(StrOpt) Directory where virtual disks are stored during volume backup and restore.</td>
</tr>
<tr>
<td><option>vmware_volume_folder</option> = <replaceable>Volumes</replaceable></td>
<td>(StrOpt) Name of the vCenter inventory folder that will contain Cinder volumes. This folder will be created under "OpenStack/&lt;project_folder&gt;", where project_folder is of format "Project (&lt;volume_project_id&gt;)".</td>
</tr>
<tr>
<td><option>vmware_wsdl_location</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Optional VIM service WSDL Location e.g http://&lt;server&gt;/vimService.wsdl. Optional over-ride to default location for bug work-arounds.</td>
</tr>
</tbody>
</table>
</para>