openstack-manuals/doc/common/tables/ironic-console.xml
Gauvain Pocentek e7cbc675ce update the config reference tables for liberty
Change-Id: I959cc6884633ada1deb55f44ca1fc6f230bdebd9
2015-10-29 07:45:04 +01:00

61 lines
2.3 KiB
XML

<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ironic_console">
<caption>Description of console 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">[console]</th>
</tr>
<tr>
<td><option>subprocess_checking_interval</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Time interval (in seconds) for checking the status of console subprocess.</td>
</tr>
<tr>
<td><option>subprocess_timeout</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Time (in seconds) to wait for the console subprocess to start.</td>
</tr>
<tr>
<td><option>terminal</option> = <replaceable>shellinaboxd</replaceable></td>
<td>(StrOpt) Path to serial console terminal program</td>
</tr>
<tr>
<td><option>terminal_cert_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Directory containing the terminal SSL cert(PEM) for serial console access</td>
</tr>
<tr>
<td><option>terminal_pid_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Directory for holding terminal pid files. If not specified, the temporary directory will be used.</td>
</tr>
</tbody>
</table>
</para>