openstack-manuals/doc/common/tables/neutron-api.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><option>allow_bulk</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) Allow the usage of the bulk API</td>
      </tr>
      <tr>
        <td><option>allow_pagination</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Allow the usage of the pagination</td>
      </tr>
      <tr>
        <td><option>allow_sorting</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Allow the usage of the sorting</td>
      </tr>
      <tr>
        <td><option>api_extensions_path</option> = <replaceable></replaceable></td>
        <td>(StrOpt) The path for API extensions</td>
      </tr>
      <tr>
        <td><option>api_paste_config</option> = <replaceable>api-paste.ini</replaceable></td>
        <td>(StrOpt) The API paste config file to use</td>
      </tr>
      <tr>
        <td><option>backlog</option> = <replaceable>4096</replaceable></td>
        <td>(IntOpt) Number of backlog requests to configure the socket with</td>
      </tr>
      <tr>
        <td><option>client_socket_timeout</option> = <replaceable>900</replaceable></td>
        <td>(IntOpt) Timeout for client connections socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever.</td>
      </tr>
      <tr>
        <td><option>max_header_line</option> = <replaceable>16384</replaceable></td>
        <td>(IntOpt) Max header line to accommodate large tokens</td>
      </tr>
      <tr>
        <td><option>pagination_max_limit</option> = <replaceable>-1</replaceable></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><option>retry_until_window</option> = <replaceable>30</replaceable></td>
        <td>(IntOpt) Number of seconds to keep retrying to listen</td>
      </tr>
      <tr>
        <td><option>service_plugins</option> = <replaceable></replaceable></td>
        <td>(ListOpt) The service plugins Neutron will use</td>
      </tr>
      <tr>
        <td><option>tcp_keepidle</option> = <replaceable>600</replaceable></td>
        <td>(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.</td>
      </tr>
      <tr>
        <td><option>wsgi_keep_alive</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) Determines if connections are allowed to be held open by clients after a request is fulfilled. A value of False will ensure that the socket connection will be explicitly closed once a response has been sent to the client.</td>
      </tr>
      <tr>
        <th colspan="2">[oslo_middleware]</th>
      </tr>
      <tr>
        <td><option>max_request_body_size</option> = <replaceable>114688</replaceable></td>
        <td>(IntOpt) The maximum body size for each  request, in bytes.</td>
      </tr>
      <tr>
        <td><option>secure_proxy_ssl_header</option> = <replaceable>X-Forwarded-Proto</replaceable></td>
        <td>(StrOpt) The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy.</td>
      </tr>
      <tr>
        <th colspan="2">[oslo_policy]</th>
      </tr>
      <tr>
        <td><option>policy_default_rule</option> = <replaceable>default</replaceable></td>
        <td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
      </tr>
      <tr>
        <td><option>policy_dirs</option> = <replaceable>['policy.d']</replaceable></td>
        <td>(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched.  Missing or empty directories are ignored.</td>
      </tr>
      <tr>
        <td><option>policy_file</option> = <replaceable>policy.json</replaceable></td>
        <td>(StrOpt) The JSON file that defines policies.</td>
      </tr>
      <tr>
        <th colspan="2">[service_providers]</th>
      </tr>
      <tr>
        <td><option>service_provider</option> = <replaceable>[]</replaceable></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>