| 1 |
<?xml version="1.0"?> |
| 2 |
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
| 3 |
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" |
| 4 |
[<!ENTITY version SYSTEM "../version.xml">]> |
| 5 |
<refentry id="udisks2_lsm.conf.5"> |
| 6 |
<refentryinfo> |
| 7 |
<title>udisks2_lsm.conf</title> |
| 8 |
<date>August 2018</date> |
| 9 |
<productname>udisks2</productname> |
| 10 |
</refentryinfo> |
| 11 |
|
| 12 |
<refmeta> |
| 13 |
<refentrytitle>udisks2_lsm.conf</refentrytitle> |
| 14 |
<manvolnum>5</manvolnum> |
| 15 |
<refmiscinfo class="manual">UDisks2 LSM Module Configuration</refmiscinfo> |
| 16 |
<refmiscinfo class="source">udisks2_lsm.conf</refmiscinfo> |
| 17 |
<refmiscinfo class="version">&version;</refmiscinfo> |
| 18 |
</refmeta> |
| 19 |
|
| 20 |
<refnamediv> |
| 21 |
<refname>udisks2_lsm.conf</refname> |
| 22 |
<refpurpose>The UDisks2 LSM Module configuration file</refpurpose> |
| 23 |
</refnamediv> |
| 24 |
|
| 25 |
<refsect1> |
| 26 |
<title>DESCRIPTION</title> |
| 27 |
<para> |
| 28 |
The lsm module of UDisks2 uses <emphasis>LibStorageMgmt</emphasis>[1] |
| 29 |
API to provides <function>org.freedesktop.UDisks2.Drive.LSM</function> |
| 30 |
interface with RAID information for external(DAS or SAN) Linux disk |
| 31 |
drive. Please refer to storage interface document for detail. |
| 32 |
</para> |
| 33 |
|
| 34 |
<para> |
| 35 |
Some storage systems require extra configuration in |
| 36 |
<emphasis>@sysconfdir@/udisks2/modules.conf.d/udisks2_lsm.conf</emphasis>. |
| 37 |
</para> |
| 38 |
</refsect1> |
| 39 |
|
| 40 |
<refsect1> |
| 41 |
<title>CONFIGURATION FILE</title> |
| 42 |
<para> |
| 43 |
<variablelist> |
| 44 |
<varlistentry> |
| 45 |
<term><option>refresh_interval = <integer></option></term> |
| 46 |
<para> |
| 47 |
This option controls how often the RAID information cache should be |
| 48 |
refreshed. If not defined, the default value is 30 (seconds). |
| 49 |
</para> |
| 50 |
</varlistentry> |
| 51 |
|
| 52 |
<varlistentry> |
| 53 |
<term><option>enable_sim = true|false</option></term> |
| 54 |
<para> |
| 55 |
This option indicates whether the lsm module should try simulator of |
| 56 |
LibStorageMgmt. This is only for developers. If not defined, |
| 57 |
the default value is false (do not enable simulator of |
| 58 |
LibStorageMgmt). If enabled, the |
| 59 |
<emphasis role="bold">sim://</emphasis> URI will be |
| 60 |
used to query LibStorageMgmt simulator plugin. |
| 61 |
</para> |
| 62 |
</varlistentry> |
| 63 |
|
| 64 |
<varlistentry> |
| 65 |
<term><option>enable_hpsa = true|false</option></term> |
| 66 |
<para> |
| 67 |
This option indicates whether the lsm module should check HP |
| 68 |
SmartArray. If not defined, the default value is true (check HP |
| 69 |
SmartArray). |
| 70 |
</para> |
| 71 |
<para> |
| 72 |
To be functional this also requires the |
| 73 |
<emphasis role="bold">libstoragemgmt-hpsa-plugin</emphasis> |
| 74 |
package to be installed and configured properly. Please refer to the |
| 75 |
<emphasis>hpsa_lsmplugin(1)</emphasis> manpage for detail. |
| 76 |
</para> |
| 77 |
<para> |
| 78 |
If enabled, the <emphasis role="bold">hpsa://</emphasis> URI will |
| 79 |
be used to query LibStorageMgmt HP SmartArray plugin. |
| 80 |
</para> |
| 81 |
</varlistentry> |
| 82 |
|
| 83 |
<varlistentry> |
| 84 |
<term><option>extra_uris= ["uri_string_1", "uri_string_2"]</option></term> |
| 85 |
<para> |
| 86 |
This option defines extra LibStorageMgmt URI list here. Please |
| 87 |
refer to <emphasis>LibStorageMgmt User Guide[3]</emphasis> for the URI |
| 88 |
format. |
| 89 |
</para> |
| 90 |
<para> |
| 91 |
Requires double quoted string separated by comma, for example: |
| 92 |
|
| 93 |
<programlisting> |
| 94 |
extra_uris = ["ontap+ssl://[email protected]", "ontap+ssl://[email protected]"] |
| 95 |
</programlisting> |
| 96 |
|
| 97 |
If not defined, empty list (no extra URI loaded) will be used. |
| 98 |
</para> |
| 99 |
</varlistentry> |
| 100 |
|
| 101 |
<varlistentry> |
| 102 |
<term><option>extra_passwords = ["password_string_1", "password_string_2"]</option></term> |
| 103 |
<para> |
| 104 |
This options defines the passwords of above URI list. Please use |
| 105 |
double quoted string separated by comma, for example: |
| 106 |
|
| 107 |
<programlisting> |
| 108 |
extra_paasswords = ["password1", "password2"] |
| 109 |
</programlisting> |
| 110 |
</para> |
| 111 |
</varlistentry> |
| 112 |
</variablelist> |
| 113 |
</para> |
| 114 |
</refsect1> |
| 115 |
|
| 116 |
<refsect1> |
| 117 |
<title>HARDWARE SUPPORT STATUS</title> |
| 118 |
<para> |
| 119 |
Any hardware which is supported in LibStorageMgmt with these capabilities |
| 120 |
will get fully supported by the UDisks2 LSM module: |
| 121 |
</para> |
| 122 |
|
| 123 |
<variablelist> |
| 124 |
<varlistentry> |
| 125 |
<term> |
| 126 |
* <option>VOLUMES capabilities</option> |
| 127 |
with valid VPD83 information, |
| 128 |
</term> |
| 129 |
</varlistentry> |
| 130 |
<varlistentry> |
| 131 |
<term> |
| 132 |
* <option>VOLUME_RAID_INFO</option> |
| 133 |
capabilities. |
| 134 |
</term> |
| 135 |
</varlistentry> |
| 136 |
</variablelist> |
| 137 |
<para> |
| 138 |
Please refer to LibStorageMgmt document website[2] for support status. |
| 139 |
</para> |
| 140 |
<para> |
| 141 |
Tested hardware: |
| 142 |
</para> |
| 143 |
<variablelist> |
| 144 |
<varlistentry> |
| 145 |
<term><emphasis role="bold">HP SmartArray</emphasis></term> |
| 146 |
<para> |
| 147 |
Using <emphasis role="bold">libstoragemgmt-hpsa-plugin</emphasis> |
| 148 |
package. |
| 149 |
</para> |
| 150 |
</varlistentry> |
| 151 |
|
| 152 |
<varlistentry> |
| 153 |
<term><emphasis role="bold">NetApp ONTAP</emphasis></term> |
| 154 |
<para> |
| 155 |
Using <emphasis role="bold">libstoragemgmt-netapp-plugin</emphasis> |
| 156 |
package. |
| 157 |
</para> |
| 158 |
</varlistentry> |
| 159 |
</variablelist> |
| 160 |
</refsect1> |
| 161 |
|
| 162 |
<refsect1> |
| 163 |
<title>AUTHOR</title> |
| 164 |
<para> |
| 165 |
Gris Ge <email><![CDATA[[email protected]]]></email> |
| 166 |
</para> |
| 167 |
</refsect1> |
| 168 |
|
| 169 |
<refsect1> |
| 170 |
<title>BUGS</title> |
| 171 |
<para> |
| 172 |
Please send bug reports to either the distribution bug tracker |
| 173 |
or the upstream bug tracker at |
| 174 |
<ulink url="https://github.com/storaged-project/udisks/issues"/>. |
| 175 |
</para> |
| 176 |
</refsect1> |
| 177 |
|
| 178 |
<refsect1> |
| 179 |
<title>SEE ALSO</title> |
| 180 |
<para> |
| 181 |
<emphasis role="bold">lsmd</emphasis>(1), |
| 182 |
<link linkend="udisksd.8"><citerefentry><refentrytitle>udisksd</refentrytitle><manvolnum>8</manvolnum></citerefentry></link>, |
| 183 |
<emphasis role="bold">hpsa_lsmplugin</emphasis>(1), |
| 184 |
<emphasis role="bold">ontap_lsmplugin</emphasis>(1), |
| 185 |
</para> |
| 186 |
<para> |
| 187 |
<variablelist> |
| 188 |
<varlistentry> |
| 189 |
<term> |
| 190 |
[1]: <ulink url="https://github.com/libstorage/libstoragemgmt"/> |
| 191 |
</term> |
| 192 |
</varlistentry> |
| 193 |
<varlistentry> |
| 194 |
<term> |
| 195 |
[2]: <ulink url="http://libstorage.github.io/libstoragemgmt-doc"/> |
| 196 |
</term> |
| 197 |
</varlistentry> |
| 198 |
<varlistentry> |
| 199 |
<term> |
| 200 |
[3]: <ulink url="http://libstorage.github.io/libstoragemgmt-doc/doc/user_guide.html"/> |
| 201 |
</term> |
| 202 |
</varlistentry> |
| 203 |
</variablelist> |
| 204 |
</para> |
| 205 |
</refsect1> |
| 206 |
</refentry> |