Gauvain Pocentek e7cbc675ce update the config reference tables for liberty
Change-Id: I959cc6884633ada1deb55f44ca1fc6f230bdebd9
2015-10-29 07:45:04 +01:00

85 lines
3.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_irmc">
<caption>Description of iRMC 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">[irmc]</th>
</tr>
<tr>
<td><option>auth_method</option> = <replaceable>basic</replaceable></td>
<td>(StrOpt) Authentication method to be used for iRMC operations, either "basic" or "digest"</td>
</tr>
<tr>
<td><option>client_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Timeout (in seconds) for iRMC operations</td>
</tr>
<tr>
<td><option>port</option> = <replaceable>443</replaceable></td>
<td>(IntOpt) Port to be used for iRMC operations, either 80 or 443</td>
</tr>
<tr>
<td><option>remote_image_server</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) IP of remote image server</td>
</tr>
<tr>
<td><option>remote_image_share_name</option> = <replaceable>share</replaceable></td>
<td>(StrOpt) share name of remote_image_server</td>
</tr>
<tr>
<td><option>remote_image_share_root</option> = <replaceable>/remote_image_share_root</replaceable></td>
<td>(StrOpt) Ironic conductor node's "NFS" or "CIFS" root path</td>
</tr>
<tr>
<td><option>remote_image_share_type</option> = <replaceable>CIFS</replaceable></td>
<td>(StrOpt) Share type of virtual media, either "NFS" or "CIFS"</td>
</tr>
<tr>
<td><option>remote_image_user_domain</option> = <replaceable></replaceable></td>
<td>(StrOpt) Domain name of remote_image_user_name</td>
</tr>
<tr>
<td><option>remote_image_user_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) User name of remote_image_server</td>
</tr>
<tr>
<td><option>remote_image_user_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password of remote_image_user_name</td>
</tr>
<tr>
<td><option>sensor_method</option> = <replaceable>ipmitool</replaceable></td>
<td>(StrOpt) Sensor data retrieval method, either "ipmitool" or "scci"</td>
</tr>
</tbody>
</table>
</para>