openstack-manuals/doc/common/tables/neutron-hyperv_agent.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_neutron_hyperv_agent">
    <caption>Description of HyperV agent 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">[AGENT]</th>
      </tr>
      <tr>
        <td>enable_metrics_collection = False</td>
        <td>(BoolOpt) Enables metrics collections for switch ports by using Hyper-V's metric APIs. Collected data can by retrieved by other apps and services, e.g.: Ceilometer. Requires Hyper-V / Windows Server 2012 and above</td>
      </tr>
      <tr>
        <td>local_network_vswitch = private</td>
        <td>(StrOpt) Private vswitch name used for local networks</td>
      </tr>
      <tr>
        <td>metrics_max_retries = 100</td>
        <td>(IntOpt) Specifies the maximum number of retries to enable Hyper-V's port metrics collection. The agent will try to enable the feature once every polling_interval period for at most metrics_max_retries or until it succeedes.</td>
      </tr>
      <tr>
        <td>physical_network_vswitch_mappings = </td>
        <td>(ListOpt) List of &lt;physical_network&gt;:&lt;vswitch&gt; where the physical networks can be expressed with wildcards, e.g.: ."*:external"</td>
      </tr>
      <tr>
        <td>polling_interval = 2</td>
        <td>(IntOpt) The number of seconds the agent will wait between polling for local device changes.</td>
      </tr>
      <tr>
        <th colspan="2">[HYPERV]</th>
      </tr>
      <tr>
        <td>network_vlan_ranges = </td>
        <td>(ListOpt) List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt;</td>
      </tr>
      <tr>
        <td>tenant_network_type = local</td>
        <td>(StrOpt) Network type for tenant networks (local, flat, vlan or none)</td>
      </tr>
      <tr>
        <th colspan="2">[hyperv]</th>
      </tr>
      <tr>
        <td>force_hyperv_utils_v1 = False</td>
        <td>(BoolOpt) Force V1 WMI utility classes</td>
      </tr>
    </tbody>
  </table>
</para>