openstack-manuals/doc/common/tables/neutron-common.xml
Gauvain Pocentek bb9d38971d Update flags and tables for neutron
Remove unneeded xi:include (metadata agent is not a plug-in)

Provide tables for new plugins and ML2 mechanisms

To avoid breaking the large tables appearance by using xrefs, the
bigswitch table is generated twice (one table for the ML2 mechanism, one
table for the standalone plugin). This is a (hopefully) temporary
change. Tables generations will probably be updated in Juno.

Change-Id: I27573975c83c5b25682135a4ea3ab852fec170ea
Closes-Bug: #1291785
Closes-Bug: #1292317
Closes-Bug: #1292318
Closes-Bug: #1294402
Closes-Bug: #1294405
Closes-Bug: #1294961
2014-03-21 14:54:25 +01:00

225 lines
9.4 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all" xml:id="config_table_neutron_common">
<caption>Description of configuration options for common</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>admin_password = None</td>
<td>(StrOpt) Admin password</td>
</tr>
<tr>
<td>admin_tenant_name = None</td>
<td>(StrOpt) Admin tenant name</td>
</tr>
<tr>
<td>admin_user = None</td>
<td>(StrOpt) Admin username</td>
</tr>
<tr>
<td>agent_down_time = 75</td>
<td>(IntOpt) Seconds to regard the agent is down; should be at least twice report_interval, to be sure the agent is down for good.</td>
</tr>
<tr>
<td>allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions</td>
<td>(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.</td>
</tr>
<tr>
<td>api_workers = 0</td>
<td>(IntOpt) Number of separate worker processes for service</td>
</tr>
<tr>
<td>auth_ca_cert = None</td>
<td>(StrOpt) Certificate Authority public key (CA cert) file for ssl</td>
</tr>
<tr>
<td>auth_insecure = False</td>
<td>(BoolOpt) Turn off verification of the certificate for ssl</td>
</tr>
<tr>
<td>auth_region = None</td>
<td>(StrOpt) Authentication region</td>
</tr>
<tr>
<td>auth_strategy = keystone</td>
<td>(StrOpt) The type of authentication to use</td>
</tr>
<tr>
<td>auth_url = None</td>
<td>(StrOpt) Authentication URL</td>
</tr>
<tr>
<td>base_mac = fa:16:3e:00:00:00</td>
<td>(StrOpt) The base MAC address Neutron will use for VIFs</td>
</tr>
<tr>
<td>bind_host = 0.0.0.0</td>
<td>(StrOpt) The host IP to bind to</td>
</tr>
<tr>
<td>bind_port = 9696</td>
<td>(IntOpt) The port to bind to</td>
</tr>
<tr>
<td>ca-certs = None</td>
<td>(StrOpt) CA certificates</td>
</tr>
<tr>
<td>core_plugin = None</td>
<td>(StrOpt) The core plugin Neutron will use</td>
</tr>
<tr>
<td>ctl-cert = None</td>
<td>(StrOpt) controller certificate</td>
</tr>
<tr>
<td>ctl-privkey = None</td>
<td>(StrOpt) controller private key</td>
</tr>
<tr>
<td>dhcp_agent_notification = True</td>
<td>(BoolOpt) Allow sending resource operation notification to DHCP agent</td>
</tr>
<tr>
<td>dhcp_agents_per_network = 1</td>
<td>(IntOpt) Number of DHCP agents scheduled to host a network.</td>
</tr>
<tr>
<td>dhcp_confs = $state_path/dhcp</td>
<td>(StrOpt) Location to store DHCP server config files</td>
</tr>
<tr>
<td>dhcp_delete_namespaces = False</td>
<td>(BoolOpt) Delete namespace after removing a dhcp server.</td>
</tr>
<tr>
<td>dhcp_domain = openstacklocal</td>
<td>(StrOpt) Domain to use for building the hostnames</td>
</tr>
<tr>
<td>dhcp_driver = neutron.agent.linux.dhcp.Dnsmasq</td>
<td>(StrOpt) The driver used to manage the DHCP server.</td>
</tr>
<tr>
<td>dhcp_lease_duration = 86400</td>
<td>(IntOpt) DHCP lease duration</td>
</tr>
<tr>
<td>disable_process_locking = False</td>
<td>(BoolOpt) Whether to disable inter-process locks</td>
</tr>
<tr>
<td>endpoint_type = adminURL</td>
<td>(StrOpt) Network service endpoint type to pull from the keystone catalog</td>
</tr>
<tr>
<td>force_gateway_on_subnet = False</td>
<td>(BoolOpt) Ensure that configured gateway is on subnet</td>
</tr>
<tr>
<td>interface_driver = None</td>
<td>(StrOpt) The driver used to manage the virtual interface.</td>
</tr>
<tr>
<td>ip_lib_force_root = False</td>
<td>(BoolOpt) Force ip_lib calls to use the root helper</td>
</tr>
<tr>
<td>lock_path = None</td>
<td>(StrOpt) Directory to use for lock files.</td>
</tr>
<tr>
<td>mac_generation_retries = 16</td>
<td>(IntOpt) How many times Neutron will retry MAC generation</td>
</tr>
<tr>
<td>max_dns_nameservers = 5</td>
<td>(IntOpt) Maximum number of DNS nameservers</td>
</tr>
<tr>
<td>max_fixed_ips_per_port = 5</td>
<td>(IntOpt) Maximum number of fixed ips per port</td>
</tr>
<tr>
<td>max_subnet_host_routes = 20</td>
<td>(IntOpt) Maximum number of host routes per subnet</td>
</tr>
<tr>
<td>periodic_fuzzy_delay = 5</td>
<td>(IntOpt) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)</td>
</tr>
<tr>
<td>periodic_interval = 40</td>
<td>(IntOpt) Seconds between running periodic tasks</td>
</tr>
<tr>
<td>report_interval = 300</td>
<td>(IntOpt) Interval between two metering reports</td>
</tr>
<tr>
<td>root_helper = sudo</td>
<td>(StrOpt) Root helper application.</td>
</tr>
<tr>
<td>state_path = /var/lib/neutron</td>
<td>(StrOpt) Where to store Neutron state files. This directory must be writable by the agent.</td>
</tr>
<tr>
<th colspan="2">[AGENT]</th>
</tr>
<tr>
<td>root_helper = sudo</td>
<td>(StrOpt) Root helper application.</td>
</tr>
<tr>
<th colspan="2">[PROXY]</th>
</tr>
<tr>
<td>admin_password = None</td>
<td>(StrOpt) Admin password</td>
</tr>
<tr>
<td>admin_tenant_name = None</td>
<td>(StrOpt) Admin tenant name</td>
</tr>
<tr>
<td>admin_user = None</td>
<td>(StrOpt) Admin user</td>
</tr>
<tr>
<td>auth_region = None</td>
<td>(StrOpt) Authentication region</td>
</tr>
<tr>
<td>auth_strategy = keystone</td>
<td>(StrOpt) The type of authentication to use</td>
</tr>
<tr>
<td>auth_url = None</td>
<td>(StrOpt) Authentication URL</td>
</tr>
<tr>
<th colspan="2">[heleos]</th>
</tr>
<tr>
<td>admin_password = None</td>
<td>(StrOpt) ESM admin password.</td>
</tr>
</tbody>
</table>
</para>