openstack-manuals/doc/common/tables/ironic-agent.xml
Gauvain Pocentek 7a31597e38 [config-ref] Ironic option tables update
Change-Id: I2e8f86f799a34398b2c222d6467eab1ad3e2ffa1
2015-07-19 16:41:36 +02:00

63 lines
3.0 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_ironic_agent">
<caption>Description of 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">[agent]</th>
</tr>
<tr>
<td><option>agent_api_version</option> = <replaceable>v1</replaceable></td>
<td>(StrOpt) API version to use for communicating with the ramdisk agent.</td>
</tr>
<tr>
<td><option>agent_erase_devices_iterations</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Number of iterations to be run for erasing devices.</td>
</tr>
<tr>
<td><option>agent_erase_devices_priority</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Priority to run in-band erase devices via the Ironic Python Agent ramdisk. If unset, will use the priority set in the ramdisk (defaults to 10 for the GenericHardwareManager). If set to 0, will not run during cleaning.</td>
</tr>
<tr>
<td><option>agent_pxe_append_params</option> = <replaceable>nofb nomodeset vga=normal</replaceable></td>
<td>(StrOpt) Additional append parameters for baremetal PXE boot.</td>
</tr>
<tr>
<td><option>agent_pxe_bootfile_name</option> = <replaceable>pxelinux.0</replaceable></td>
<td>(StrOpt) Neutron bootfile DHCP parameter.</td>
</tr>
<tr>
<td><option>agent_pxe_config_template</option> = <replaceable>$pybasedir/drivers/modules/agent_config.template</replaceable></td>
<td>(StrOpt) Template file for PXE configuration.</td>
</tr>
<tr>
<td><option>heartbeat_timeout</option> = <replaceable>300</replaceable></td>
<td>(IntOpt) Maximum interval (in seconds) for agent heartbeats.</td>
</tr>
<tr>
<td><option>manage_tftp</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Whether Ironic will manage TFTP files for the deploy ramdisks. If set to False, you will need to configure your own TFTP server that allows booting the deploy ramdisks.</td>
</tr>
<tr>
<td><option>post_deploy_get_power_state_retries</option> = <replaceable>6</replaceable></td>
<td>(IntOpt) Number of times to retry getting power state to check if bare metal node has been powered off after a soft power off.</td>
</tr>
<tr>
<td><option>post_deploy_get_power_state_retry_interval</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) Amount of time (in seconds) to wait between polling power state after trigger soft poweroff.</td>
</tr>
</tbody>
</table>
</para>