openstack-manuals/doc/common/tables/nova-vmware.xml

<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
  <!-- Warning: Do not edit this file. It is automatically
     generated and your changes will be overwritten.
     The tool to do so lives in openstack-doc-tools repository. -->
  <table rules="all" xml:id="config_table_nova_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">[vmware]</th>
      </tr>
      <tr>
        <td><option>api_retry_count</option> = <replaceable>10</replaceable></td>
        <td>(IntOpt) The number of times we retry on failures, e.g., socket error, etc.</td>
      </tr>
      <tr>
        <td><option>ca_file</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Specify a CA bundle file to use in verifying the vCenter server certificate.</td>
      </tr>
      <tr>
        <td><option>cache_prefix</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) The prefix for where cached images are stored. This is NOT the full path - just a folder prefix. This should only be used when a datastore cache should be shared between compute nodes. Note: this should only be used when the compute nodes have a shared file system.</td>
      </tr>
      <tr>
        <td><option>cluster_name</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Name of a VMware Cluster ComputeResource.</td>
      </tr>
      <tr>
        <td><option>console_delay_seconds</option> = <replaceable>None</replaceable></td>
        <td>(IntOpt) Set this value if affected by an increased network latency causing repeated characters when typing in a remote console.</td>
      </tr>
      <tr>
        <td><option>datastore_regex</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Regex to match the name of a datastore.</td>
      </tr>
      <tr>
        <td><option>host_ip</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Hostname or IP address for connection to VMware vCenter host.</td>
      </tr>
      <tr>
        <td><option>host_password</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Password for connection to VMware vCenter host.</td>
      </tr>
      <tr>
        <td><option>host_port</option> = <replaceable>443</replaceable></td>
        <td>(IntOpt) Port for connection to VMware vCenter host.</td>
      </tr>
      <tr>
        <td><option>host_username</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Username for connection to VMware vCenter host.</td>
      </tr>
      <tr>
        <td><option>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 "ca_file" is set.</td>
      </tr>
      <tr>
        <td><option>integration_bridge</option> = <replaceable>br-int</replaceable></td>
        <td>(StrOpt) Name of Integration Bridge</td>
      </tr>
      <tr>
        <td><option>maximum_objects</option> = <replaceable>100</replaceable></td>
        <td>(IntOpt) The maximum number of ObjectContent data objects that should be returned in a single result. A positive value will cause the operation to suspend the retrieval when the count of objects reaches the specified maximum. The server may still limit the count to something less than the configured value. Any remaining objects may be retrieved with additional requests.</td>
      </tr>
      <tr>
        <td><option>pbm_default_policy</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) The PBM default policy. If pbm_wsdl_location is set and there is no defined storage policy for the specific request then this policy will be used.</td>
      </tr>
      <tr>
        <td><option>pbm_enabled</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) The PBM status.</td>
      </tr>
      <tr>
        <td><option>pbm_wsdl_location</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) PBM service WSDL file location URL. e.g. file:///opt/SDK/spbm/wsdl/pbmService.wsdl Not setting this will disable storage policy based placement of instances.</td>
      </tr>
      <tr>
        <td><option>serial_port_proxy_uri</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Identifies a proxy service that provides network access to the serial_port_service_uri. This option is ignored if serial_port_service_uri is not specified.</td>
      </tr>
      <tr>
        <td><option>serial_port_service_uri</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Identifies the remote system that serial port traffic will be sent to. If this is not set, no serial ports will be added to the created VMs.</td>
      </tr>
      <tr>
        <td><option>task_poll_interval</option> = <replaceable>0.5</replaceable></td>
        <td>(FloatOpt) The interval used for polling of remote tasks.</td>
      </tr>
      <tr>
        <td><option>use_linked_clone</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) Whether to use linked clone</td>
      </tr>
      <tr>
        <td><option>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>