openstack-manuals/doc/common/tables/neutron-common.xml

247 lines
7.9 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_common">
<caption>Description of common 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">[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>api_workers = 0</td>
<td>(IntOpt) Number of separate API 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>check_child_processes = False</td>
<td>(BoolOpt) Periodically check child processes</td>
</tr>
<tr>
<td>check_child_processes_action = respawn</td>
<td>(StrOpt) Action to be executed when a child process dies</td>
</tr>
<tr>
<td>check_child_processes_interval = 60</td>
<td>(IntOpt) Interval between checks of child process liveness (seconds)</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 (in seconds). Use -1 to tell dnsmasq to use infinite lease times.</td>
</tr>
<tr>
<td>endpoint_type = publicURL</td>
<td>(StrOpt) Network service endpoint type to pull from the keystone catalog</td>
</tr>
<tr>
<td>force_gateway_on_subnet = True</td>
<td>(BoolOpt) Ensure that configured gateway is on subnet. For IPv6, validate only if gateway is not a link local address. Deprecated, to be removed during the K release, at which point the check will be mandatory.</td>
</tr>
<tr>
<td>host = localhost</td>
<td>(StrOpt) The hostname Neutron is running on</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_allowed_address_pair = 10</td>
<td>(IntOpt) Maximum number of allowed address pairs</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>memcached_servers = None</td>
<td>(ListOpt) Memcached servers or None for in process cache.</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>
<tr>
<th colspan="2">[keystone_authtoken]</th>
</tr>
<tr>
<td>memcached_servers = None</td>
<td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
</tr>
</tbody>
</table>
</para>