openstack-manuals/doc/common/tables/neutron-hyperv_agent.xml
Atsushi SAKAI 71bf779f1c Update Config reference for neutron
Edit section_network-plugins.xml
       section_network-plugins-ml2.xml
  Stay removed mlnx (mellanox)

  Unchanged because of trouble
       networking-ibm (SDN-VE)
       octavia

  Cannot include because of trouble
       networking-infoblox
       networking-zvm

  Consider neutron plugin addition (#1503967)

Change-Id: I41272af4ec46c7e7c1c3ce7d6e03c6a40fb0cb25
Partial-Bug: #1407581
Related-Bug: #1503967
2015-10-13 19:36:54 +09:00

100 lines
4.5 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>neutron_metadata_address</option> = <replaceable>169.254.169.254</replaceable></td>
<td>(StrOpt) Specifies the address which will serve the metadata for the instance.</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">[NVGRE]</th>
</tr>
<tr>
<td><option>enable_support</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables Hyper-V NVGRE. Requires Windows Server 2012 or above.</td>
</tr>
<tr>
<td><option>provider_tunnel_ip</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Specifies the tunnel IP which will be used and reported by this host for NVGRE networks.</td>
</tr>
<tr>
<td><option>provider_vlan_id</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Specifies the VLAN ID of the physical network, required for setting the NVGRE Provider Address.</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>
<tr>
<th colspan="2">[neutron]</th>
</tr>
<tr>
<td><option>admin_auth_url</option> = <replaceable>http://localhost:5000/v2.0</replaceable></td>
<td>(StrOpt) auth url for connecting to neutron in admin context</td>
</tr>
<tr>
<td><option>admin_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) password for connecting to neutron in admin context</td>
</tr>
<tr>
<td><option>admin_tenant_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) tenant name for connecting to neutron in admin context</td>
</tr>
<tr>
<td><option>admin_username</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) username for connecting to neutron in admin context</td>
</tr>
<tr>
<td><option>auth_strategy</option> = <replaceable>keystone</replaceable></td>
<td>(StrOpt) auth strategy for connecting to neutron in admin context</td>
</tr>
<tr>
<td><option>url</option> = <replaceable>http://127.0.0.1:9696</replaceable></td>
<td>(StrOpt) URL for connecting to neutron</td>
</tr>
<tr>
<td><option>url_timeout</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) timeout value for connecting to neutron in seconds</td>
</tr>
</tbody>
</table>
</para>