openstack-manuals/doc/common/tables/nova-hypervisor.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_hypervisor">
    <caption>Description of hypervisor 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>default_ephemeral_format = None</td>
        <td>(StrOpt) The default format an ephemeral_volume will be formatted with on creation.</td>
      </tr>
      <tr>
        <td>force_raw_images = True</td>
        <td>(BoolOpt) Force backing images to raw format</td>
      </tr>
      <tr>
        <td>preallocate_images = none</td>
        <td>(StrOpt) VM image preallocation mode: "none" =&gt; no storage provisioning is done up front, "space" =&gt; storage is fully allocated at instance start</td>
      </tr>
      <tr>
        <td>timeout_nbd = 10</td>
        <td>(IntOpt) Amount of time, in seconds, to wait for NBD device start up.</td>
      </tr>
      <tr>
        <td>use_cow_images = True</td>
        <td>(BoolOpt) Whether to use cow images</td>
      </tr>
      <tr>
        <td>vcpu_pin_set = None</td>
        <td>(StrOpt) Defines which pcpus that instance vcpus can use. For example, "4-12,^8,15"</td>
      </tr>
      <tr>
        <td>virt_mkfs = []</td>
        <td>(MultiStrOpt) Name of the mkfs commands for ephemeral device. The format is &lt;os_type&gt;=&lt;mkfs command&gt;</td>
      </tr>
      <tr>
        <th colspan="2">[libvirt]</th>
      </tr>
      <tr>
        <td>block_migration_flag = VIR_MIGRATE_UNDEFINE_SOURCE, VIR_MIGRATE_PEER2PEER, VIR_MIGRATE_LIVE, VIR_MIGRATE_TUNNELLED, VIR_MIGRATE_NON_SHARED_INC</td>
        <td>(StrOpt) Migration flags to be set for block migration</td>
      </tr>
      <tr>
        <td>disk_cachemodes = </td>
        <td>(ListOpt) Specific cachemodes to use for different disk types e.g: file=directsync,block=none</td>
      </tr>
      <tr>
        <td>images_rbd_ceph_conf = </td>
        <td>(StrOpt) Path to the ceph configuration file to use</td>
      </tr>
      <tr>
        <td>images_rbd_pool = rbd</td>
        <td>(StrOpt) The RADOS pool in which rbd volumes are stored</td>
      </tr>
      <tr>
        <td>images_type = default</td>
        <td>(StrOpt) VM Images format. Acceptable values are: raw, qcow2, lvm, rbd, default. If default is specified, then use_cow_images flag is used instead of this one.</td>
      </tr>
      <tr>
        <td>images_volume_group = None</td>
        <td>(StrOpt) LVM Volume Group that is used for VM images, when you specify images_type=lvm.</td>
      </tr>
      <tr>
        <td>inject_key = False</td>
        <td>(BoolOpt) Inject the ssh public key at boot time</td>
      </tr>
      <tr>
        <td>inject_partition = -2</td>
        <td>(IntOpt) The partition to inject to : -2 =&gt; disable, -1 =&gt; inspect (libguestfs only), 0 =&gt; not partitioned, &gt;0 =&gt; partition number</td>
      </tr>
      <tr>
        <td>inject_password = False</td>
        <td>(BoolOpt) Inject the admin password at boot time, without an agent.</td>
      </tr>
      <tr>
        <td>iscsi_use_multipath = False</td>
        <td>(BoolOpt) Use multipath connection of the iSCSI volume</td>
      </tr>
      <tr>
        <td>iser_use_multipath = False</td>
        <td>(BoolOpt) Use multipath connection of the iSER volume</td>
      </tr>
      <tr>
        <td>rescue_image_id = None</td>
        <td>(StrOpt) Rescue ami image. This will not be used if an image id is provided by the user.</td>
      </tr>
      <tr>
        <td>rescue_kernel_id = None</td>
        <td>(StrOpt) Rescue aki image</td>
      </tr>
      <tr>
        <td>rescue_ramdisk_id = None</td>
        <td>(StrOpt) Rescue ari image</td>
      </tr>
      <tr>
        <td>snapshot_compression = False</td>
        <td>(BoolOpt) Compress snapshot images when possible. This currently applies exclusively to qcow2 images</td>
      </tr>
      <tr>
        <td>snapshot_image_format = None</td>
        <td>(StrOpt) Snapshot image format (valid options are : raw, qcow2, vmdk, vdi). Defaults to same as source image</td>
      </tr>
      <tr>
        <td>sparse_logical_volumes = False</td>
        <td>(BoolOpt) Create sparse logical volumes (with virtualsize) if this flag is set to True.</td>
      </tr>
      <tr>
        <td>use_usb_tablet = True</td>
        <td>(BoolOpt) Sync virtual and real mouse cursors in Windows VMs</td>
      </tr>
      <tr>
        <td>use_virtio_for_bridges = True</td>
        <td>(BoolOpt) Use virtio for bridge interfaces with KVM/QEMU</td>
      </tr>
    </tbody>
  </table>
</para>