openstack-manuals/doc/common/tables/neutron-bigswitch.xml
Gauvain Pocentek db162cf2b1 [config-ref] Update neutron options
New tables have been included in the config ref and existing *aas
options have been moved to the same file for consistency.

Change-Id: I7836b7d1358ada1b1392a96581a92551df4cf7b3
Closes-Bug: #1460851
Closes-Bug: #1439648
Partial-Bug: #1452738
Closes-Bug: #1455237
Closes-Bug: #1469932
Closes-Bug: #1470371
2015-07-24 09:13:50 +02:00

176 lines
8.4 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_bigswitch">
<caption>Description of BigSwitch 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">[NOVA]</th>
</tr>
<tr>
<td><option>node_override_vif_802.1qbg</option> = <replaceable></replaceable></td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to 802.1qbg</td>
</tr>
<tr>
<td><option>node_override_vif_802.1qbh</option> = <replaceable></replaceable></td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to 802.1qbh</td>
</tr>
<tr>
<td><option>node_override_vif_binding_failed</option> = <replaceable></replaceable></td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to binding_failed</td>
</tr>
<tr>
<td><option>node_override_vif_bridge</option> = <replaceable></replaceable></td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to bridge</td>
</tr>
<tr>
<td><option>node_override_vif_distributed</option> = <replaceable></replaceable></td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to distributed</td>
</tr>
<tr>
<td><option>node_override_vif_dvs</option> = <replaceable></replaceable></td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to dvs</td>
</tr>
<tr>
<td><option>node_override_vif_hw_veb</option> = <replaceable></replaceable></td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to hw_veb</td>
</tr>
<tr>
<td><option>node_override_vif_hyperv</option> = <replaceable></replaceable></td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to hyperv</td>
</tr>
<tr>
<td><option>node_override_vif_ib_hostdev</option> = <replaceable></replaceable></td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to ib_hostdev</td>
</tr>
<tr>
<td><option>node_override_vif_ivs</option> = <replaceable></replaceable></td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to ivs</td>
</tr>
<tr>
<td><option>node_override_vif_midonet</option> = <replaceable></replaceable></td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to midonet</td>
</tr>
<tr>
<td><option>node_override_vif_other</option> = <replaceable></replaceable></td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to other</td>
</tr>
<tr>
<td><option>node_override_vif_ovs</option> = <replaceable></replaceable></td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to ovs</td>
</tr>
<tr>
<td><option>node_override_vif_unbound</option> = <replaceable></replaceable></td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to unbound</td>
</tr>
<tr>
<td><option>node_override_vif_vrouter</option> = <replaceable></replaceable></td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to vrouter</td>
</tr>
<tr>
<td><option>vif_type</option> = <replaceable>ivs</replaceable></td>
<td>(StrOpt) Virtual interface type to configure on Nova compute nodes</td>
</tr>
<tr>
<td><option>vif_types</option> = <replaceable>unbound, binding_failed, ovs, ivs, bridge, 802.1qbg, 802.1qbh, hyperv, midonet, ib_hostdev, hw_veb, dvs, other, distributed, vrouter</replaceable></td>
<td>(ListOpt) List of allowed vif_type values.</td>
</tr>
<tr>
<th colspan="2">[RESTPROXY]</th>
</tr>
<tr>
<td><option>add_meta_server_route</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Flag to decide if a route to the metadata server should be injected into the VM</td>
</tr>
<tr>
<td><option>auto_sync_on_failure</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If neutron fails to create a resource because the backend controller doesn't know of a dependency, the plugin automatically triggers a full data synchronization to the controller.</td>
</tr>
<tr>
<td><option>cache_connections</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Re-use HTTP/HTTPS connections to the controller.</td>
</tr>
<tr>
<td><option>consistency_interval</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Time between verifications that the backend controller database is consistent with Neutron. (0 to disable)</td>
</tr>
<tr>
<td><option>neutron_id</option> = <replaceable>neutron-shock</replaceable></td>
<td>(StrOpt) User defined identifier for this Neutron deployment</td>
</tr>
<tr>
<td><option>no_ssl_validation</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Disables SSL certificate validation for controllers</td>
</tr>
<tr>
<td><option>server_auth</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The username and password for authenticating against the Big Switch or Floodlight controller.</td>
</tr>
<tr>
<td><option>server_ssl</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If True, Use SSL when connecting to the Big Switch or Floodlight controller.</td>
</tr>
<tr>
<td><option>server_timeout</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Maximum number of seconds to wait for proxy request to connect and complete.</td>
</tr>
<tr>
<td><option>servers</option> = <replaceable>localhost:8800</replaceable></td>
<td>(ListOpt) A comma separated list of Big Switch or Floodlight servers and port numbers. The plugin proxies the requests to the Big Switch/Floodlight server, which performs the networking configuration. Only oneserver is needed per deployment, but you may wish todeploy multiple servers to support failover.</td>
</tr>
<tr>
<td><option>ssl_cert_directory</option> = <replaceable>/etc/neutron/plugins/bigswitch/ssl</replaceable></td>
<td>(StrOpt) Directory containing ca_certs and host_certs certificate directories.</td>
</tr>
<tr>
<td><option>ssl_sticky</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Trust and store the first certificate received for each controller address and use it to validate future connections to that address.</td>
</tr>
<tr>
<td><option>sync_data</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Sync data on connect</td>
</tr>
<tr>
<td><option>thread_pool_size</option> = <replaceable>4</replaceable></td>
<td>(IntOpt) Maximum number of threads to spawn to handle large volumes of port creations.</td>
</tr>
<tr>
<th colspan="2">[RESTPROXYAGENT]</th>
</tr>
<tr>
<td><option>integration_bridge</option> = <replaceable>br-int</replaceable></td>
<td>(StrOpt) Name of integration bridge on compute nodes used for security group insertion.</td>
</tr>
<tr>
<td><option>polling_interval</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) Seconds between agent checks for port changes</td>
</tr>
<tr>
<td><option>virtual_switch_type</option> = <replaceable>ivs</replaceable></td>
<td>(StrOpt) Virtual switch type.</td>
</tr>
<tr>
<th colspan="2">[ROUTER]</th>
</tr>
<tr>
<td><option>max_router_rules</option> = <replaceable>200</replaceable></td>
<td>(IntOpt) Maximum number of router rules</td>
</tr>
<tr>
<td><option>tenant_default_router_rule</option> = <replaceable>['*:any:any:permit']</replaceable></td>
<td>(MultiStrOpt) The default router rules installed in new tenant routers. Repeat the config option for each rule. Format is &lt;tenant&gt;:&lt;source&gt;:&lt;destination&gt;:&lt;action&gt; Use an * to specify default for all tenants.</td>
</tr>
</tbody>
</table>
</para>