openstack-manuals/doc/common/tables/neutron-l3_agent.xml
Gauvain Pocentek ad9faae7c3 Update the config reference tables (exept swift)
Include new tables in the config reference.

Closes-Bug: #1366489
Closes-Bug: #1374844

Change-Id: I47883b3e524aba67f82304112a066a281c341be3
2014-09-28 19:20:42 +02:00

87 lines
3.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_l3_agent">
<caption>Description of L3 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">[DEFAULT]</th>
</tr>
<tr>
<td>agent_mode = legacy</td>
<td>(StrOpt) The working mode for the agent. Allowed modes are: 'legacy' - this preserves the existing behavior where the L3 agent is deployed on a centralized networking node to provide L3 services like DNAT, and SNAT. Use this mode if you do not want to adopt DVR. 'dvr' - this mode enables DVR functionality and must be used for an L3 agent that runs on a compute host. 'dvr_snat' - this enables centralized SNAT support in conjunction with DVR. This mode must be used for an L3 agent running on a centralized node (or in single-host deployments, e.g. devstack)</td>
</tr>
<tr>
<td>allow_automatic_l3agent_failover = False</td>
<td>(BoolOpt) Automatically reschedule routers from offline L3 agents to online L3 agents.</td>
</tr>
<tr>
<td>enable_metadata_proxy = True</td>
<td>(BoolOpt) Allow running metadata proxy.</td>
</tr>
<tr>
<td>external_network_bridge = br-ex</td>
<td>(StrOpt) Name of bridge used for external network traffic.</td>
</tr>
<tr>
<td>gateway_external_network_id = </td>
<td>(StrOpt) UUID of external network for routers implemented by the agents.</td>
</tr>
<tr>
<td>ha_confs_path = $state_path/ha_confs</td>
<td>(StrOpt) Location to store keepalived/conntrackd config files</td>
</tr>
<tr>
<td>ha_vrrp_advert_int = 2</td>
<td>(IntOpt) The advertisement interval in seconds</td>
</tr>
<tr>
<td>ha_vrrp_auth_password = None</td>
<td>(StrOpt) VRRP authentication password</td>
</tr>
<tr>
<td>ha_vrrp_auth_type = PASS</td>
<td>(StrOpt) VRRP authentication type AH/PASS</td>
</tr>
<tr>
<td>handle_internal_only_routers = True</td>
<td>(BoolOpt) Agent should implement routers with no gateway</td>
</tr>
<tr>
<td>l3_ha = False</td>
<td>(BoolOpt) Enable HA mode for virtual routers.</td>
</tr>
<tr>
<td>l3_ha_net_cidr = 169.254.192.0/18</td>
<td>(StrOpt) Subnet used for the l3 HA admin network.</td>
</tr>
<tr>
<td>max_l3_agents_per_router = 3</td>
<td>(IntOpt) Maximum number of agents on which a router will be scheduled.</td>
</tr>
<tr>
<td>min_l3_agents_per_router = 2</td>
<td>(IntOpt) Minimum number of agents on which a router will be scheduled.</td>
</tr>
<tr>
<td>router_id = </td>
<td>(StrOpt) If namespaces is disabled, the l3 agent can only configure a router that has the matching router ID.</td>
</tr>
<tr>
<td>send_arp_for_ha = 3</td>
<td>(IntOpt) Send this many gratuitous ARPs for HA setup, if less than or equal to 0, the feature is disabled</td>
</tr>
</tbody>
</table>
</para>