openstack-manuals/doc/common/tables/neutron-api.xml
Gauvain Pocentek a8e0a7f97d Rework the config reference tables
Try to use the same categories for options found in multiple projects.

Change-Id: If582194081854b06542ca32335c6225ac94de013
Closes-Bug: #1363485
2014-10-03 08:39:38 +02:00

82 lines
2.7 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_api">
<caption>Description of API 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>allow_bulk = True</td>
<td>(BoolOpt) Allow the usage of the bulk API</td>
</tr>
<tr>
<td>allow_pagination = False</td>
<td>(BoolOpt) Allow the usage of the pagination</td>
</tr>
<tr>
<td>allow_sorting = False</td>
<td>(BoolOpt) Allow the usage of the sorting</td>
</tr>
<tr>
<td>api_extensions_path = </td>
<td>(StrOpt) The path for API extensions</td>
</tr>
<tr>
<td>api_paste_config = api-paste.ini</td>
<td>(StrOpt) The API paste config file to use</td>
</tr>
<tr>
<td>backlog = 4096</td>
<td>(IntOpt) Number of backlog requests to configure the socket with</td>
</tr>
<tr>
<td>max_header_line = 16384</td>
<td>(IntOpt) Max header line to accommodate large tokens</td>
</tr>
<tr>
<td>max_request_body_size = 114688</td>
<td>(IntOpt) the maximum body size per each request(bytes)</td>
</tr>
<tr>
<td>pagination_max_limit = -1</td>
<td>(StrOpt) The maximum number of items returned in a single response, value was 'infinite' or negative integer means no limit</td>
</tr>
<tr>
<td>retry_until_window = 30</td>
<td>(IntOpt) Number of seconds to keep retrying to listen</td>
</tr>
<tr>
<td>run_external_periodic_tasks = True</td>
<td>(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here?</td>
</tr>
<tr>
<td>service_plugins = </td>
<td>(ListOpt) The service plugins Neutron will use</td>
</tr>
<tr>
<td>tcp_keepidle = 600</td>
<td>(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.</td>
</tr>
<tr>
<th colspan="2">[service_providers]</th>
</tr>
<tr>
<td>service_provider = []</td>
<td>(MultiStrOpt) Defines providers for advanced services using the format: &lt;service_type&gt;:&lt;name&gt;:&lt;driver&gt;[:default]</td>
</tr>
</tbody>
</table>
</para>