openstack-manuals/doc/common/tables/neutron-l3_agent.xml
Anish Bhatt 546ea5db59 Update flagmappings for neutron
Change-Id: I02784cd0330771220f84325884cd147b3fdf2b8e
2015-02-20 17:33:51 -08:00

102 lines
4.8 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><option>agent_mode</option> = <replaceable>legacy</replaceable></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><option>allow_automatic_dhcp_failover</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Automatically remove networks from offline DHCP agents.</td>
</tr>
<tr>
<td><option>allow_automatic_l3agent_failover</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Automatically reschedule routers from offline L3 agents to online L3 agents.</td>
</tr>
<tr>
<td><option>enable_metadata_proxy</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Allow running metadata proxy.</td>
</tr>
<tr>
<td><option>external_network_bridge</option> = <replaceable>br-ex</replaceable></td>
<td>(StrOpt) Name of bridge used for external network traffic.</td>
</tr>
<tr>
<td><option>gateway_external_network_id</option> = <replaceable></replaceable></td>
<td>(StrOpt) UUID of external network for routers implemented by the agents.</td>
</tr>
<tr>
<td><option>ha_confs_path</option> = <replaceable>$state_path/ha_confs</replaceable></td>
<td>(StrOpt) Location to store keepalived/conntrackd config files</td>
</tr>
<tr>
<td><option>ha_vrrp_advert_int</option> = <replaceable>2</replaceable></td>
<td>(IntOpt) The advertisement interval in seconds</td>
</tr>
<tr>
<td><option>ha_vrrp_auth_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) VRRP authentication password</td>
</tr>
<tr>
<td><option>ha_vrrp_auth_type</option> = <replaceable>PASS</replaceable></td>
<td>(StrOpt) VRRP authentication type AH/PASS</td>
</tr>
<tr>
<td><option>handle_internal_only_routers</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Agent should implement routers with no gateway</td>
</tr>
<tr>
<td><option>l3_ha</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable HA mode for virtual routers.</td>
</tr>
<tr>
<td><option>l3_ha_net_cidr</option> = <replaceable>169.254.192.0/18</replaceable></td>
<td>(StrOpt) Subnet used for the l3 HA admin network.</td>
</tr>
<tr>
<td><option>max_l3_agents_per_router</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Maximum number of agents on which a router will be scheduled.</td>
</tr>
<tr>
<td><option>min_l3_agents_per_router</option> = <replaceable>2</replaceable></td>
<td>(IntOpt) Minimum number of agents on which a router will be scheduled.</td>
</tr>
<tr>
<td><option>router_id</option> = <replaceable></replaceable></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><option>send_arp_for_ha</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Send this many gratuitous ARPs for HA setup, if less than or equal to 0, the feature is disabled</td>
</tr>
<tr>
<th colspan="2">[AGENT]</th>
</tr>
<tr>
<td><option>comment_iptables_rules</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Add comments to iptables rules.</td>
</tr>
<tr>
<td><option>use_helper_for_ns_read</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Use the root helper to read the namespaces from the operating system.</td>
</tr>
</tbody>
</table>
</para>