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

89 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_cinder_san">
<caption>Description of SAN 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>san_clustername</option> = <replaceable></replaceable></td>
<td>(StrOpt) Cluster name to use for creating volumes</td>
</tr>
<tr>
<td><option>san_ip</option> = <replaceable></replaceable></td>
<td>(StrOpt) IP address of SAN controller</td>
</tr>
<tr>
<td><option>san_is_local</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Execute commands locally instead of over SSH; use if the volume service is running on the SAN device</td>
</tr>
<tr>
<td><option>san_login</option> = <replaceable>admin</replaceable></td>
<td>(StrOpt) Username for SAN controller</td>
</tr>
<tr>
<td><option>san_password</option> = <replaceable></replaceable></td>
<td>(StrOpt) Password for SAN controller</td>
</tr>
<tr>
<td><option>san_private_key</option> = <replaceable></replaceable></td>
<td>(StrOpt) Filename of private key to use for SSH authentication</td>
</tr>
<tr>
<td><option>san_secondary_ip</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) VNX secondary SP IP Address.</td>
</tr>
<tr>
<td><option>san_ssh_port</option> = <replaceable>22</replaceable></td>
<td>(IntOpt) SSH port to use with SAN</td>
</tr>
<tr>
<td><option>san_thin_provision</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Use thin provisioning for SAN volumes?</td>
</tr>
<tr>
<td><option>ssh_conn_timeout</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) SSH connection timeout in seconds</td>
</tr>
<tr>
<td><option>ssh_max_pool_conn</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) Maximum ssh connections in the pool</td>
</tr>
<tr>
<td><option>ssh_min_pool_conn</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Minimum ssh connections in the pool</td>
</tr>
</tbody>
</table>
</para>