openstack-manuals/doc/common/tables/neutron-hyperv_agent.xml
Tom Fifield dc7c13a659 Regenerate config tables for K1
This patch regenerates the configuration tables using
code from 2014-12-31, or about kilo-1.

It also uses new doc-tools code to mark-up options
and their default values semantically.

Change-Id: Id68a87b69fb80edbc156b9bcb1549cca5e61464b
2015-01-01 19:13:38 +08:00

61 lines
2.7 KiB
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><option>enable_metrics_collection</option> = <replaceable>False</replaceable></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><option>local_network_vswitch</option> = <replaceable>private</replaceable></td>
<td>(StrOpt) Private vswitch name used for local networks</td>
</tr>
<tr>
<td><option>metrics_max_retries</option> = <replaceable>100</replaceable></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><option>physical_network_vswitch_mappings</option> = <replaceable></replaceable></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><option>polling_interval</option> = <replaceable>2</replaceable></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><option>network_vlan_ranges</option> = <replaceable></replaceable></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><option>tenant_network_type</option> = <replaceable>local</replaceable></td>
<td>(StrOpt) Network type for tenant networks (local, flat, vlan or none)</td>
</tr>
<tr>
<th colspan="2">[hyperv]</th>
</tr>
<tr>
<td><option>force_hyperv_utils_v1</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Force V1 WMI utility classes</td>
</tr>
</tbody>
</table>
</para>