| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 |
<html> |
| 3 |
<head> |
| 4 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| 5 |
<title>org.freedesktop.UDisks2.LogicalVolume: UDisks Reference Manual</title> |
| 6 |
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> |
| 7 |
<link rel="home" href="index.html" title="UDisks Reference Manual"> |
| 8 |
<link rel="up" href="ch03.html" title="D-Bus Interfaces"> |
| 9 |
<link rel="prev" href="gdbus-org.freedesktop.UDisks2.Block.LVM2.html" title="org.freedesktop.UDisks2.Block.LVM2"> |
| 10 |
<link rel="next" href="gdbus-org.freedesktop.UDisks2.VDOVolume.html" title="org.freedesktop.UDisks2.VDOVolume"> |
| 11 |
<meta name="generator" content="GTK-Doc V1.35.1 (XML mode)"> |
| 12 |
<link rel="stylesheet" href="style.css" type="text/css"> |
| 13 |
</head> |
| 14 |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| 15 |
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> |
| 16 |
<td width="100%" align="left" class="shortcuts"> |
| 17 |
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> |
| 18 |
<a href="#gdbus-org.freedesktop.UDisks2.LogicalVolume.description" class="shortcut">Description</a></span><span id="nav_properties"> <span class="dim">|</span> |
| 19 |
<a href="#gdbus-org.freedesktop.UDisks2.LogicalVolume.properties" class="shortcut">Properties</a></span> |
| 20 |
</td> |
| 21 |
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> |
| 22 |
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| 23 |
<td><a accesskey="p" href="gdbus-org.freedesktop.UDisks2.Block.LVM2.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| 24 |
<td><a accesskey="n" href="gdbus-org.freedesktop.UDisks2.VDOVolume.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| 25 |
</tr></table> |
| 26 |
<div class="refentry"> |
| 27 |
<a name="gdbus-org.freedesktop.UDisks2.LogicalVolume"></a><div class="titlepage"></div> |
| 28 |
<div class="refnamediv"><table width="100%"><tr> |
| 29 |
<td valign="top"> |
| 30 |
<h2><span class="refentrytitle"><a name="gdbus-interface-org-freedesktop-UDisks2-LogicalVolume.top_of_page"></a>org.freedesktop.UDisks2.LogicalVolume</span></h2> |
| 31 |
<p>org.freedesktop.UDisks2.LogicalVolume — A logical volume</p> |
| 32 |
</td> |
| 33 |
<td class="gallery_image" valign="top" align="right"></td> |
| 34 |
</tr></table></div> |
| 35 |
<div class="refsynopsisdiv"> |
| 36 |
<h2>Methods</h2> |
| 37 |
<pre class="synopsis"> |
| 38 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-method-org-freedesktop-UDisks2-LogicalVolume.Activate" title="The Activate() method">Activate</a> (IN a{sv} options, |
| 39 |
OUT o result); |
| 40 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-method-org-freedesktop-UDisks2-LogicalVolume.Deactivate" title="The Deactivate() method">Deactivate</a> (IN a{sv} options); |
| 41 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-method-org-freedesktop-UDisks2-LogicalVolume.Delete" title="The Delete() method">Delete</a> (IN a{sv} options); |
| 42 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-method-org-freedesktop-UDisks2-LogicalVolume.Rename" title="The Rename() method">Rename</a> (IN s new_name, |
| 43 |
IN a{sv} options, |
| 44 |
OUT o result); |
| 45 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-method-org-freedesktop-UDisks2-LogicalVolume.Resize" title="The Resize() method">Resize</a> (IN t new_size, |
| 46 |
IN a{sv} options); |
| 47 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-method-org-freedesktop-UDisks2-LogicalVolume.Repair" title="The Repair() method">Repair</a> (IN ao pvs, |
| 48 |
IN a{sv} options); |
| 49 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-method-org-freedesktop-UDisks2-LogicalVolume.CreateSnapshot" title="The CreateSnapshot() method">CreateSnapshot</a> (IN s name, |
| 50 |
IN t size, |
| 51 |
IN a{sv} options, |
| 52 |
OUT o result); |
| 53 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-method-org-freedesktop-UDisks2-LogicalVolume.CacheAttach" title="The CacheAttach() method">CacheAttach</a> (IN s cache_name, |
| 54 |
IN a{sv} options); |
| 55 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-method-org-freedesktop-UDisks2-LogicalVolume.CacheSplit" title="The CacheSplit() method">CacheSplit</a> (IN a{sv} options); |
| 56 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-method-org-freedesktop-UDisks2-LogicalVolume.CacheDetach" title="The CacheDetach() method">CacheDetach</a> (IN a{sv} options); |
| 57 |
</pre> |
| 58 |
</div> |
| 59 |
<div class="refsect1"> |
| 60 |
<a name="id-1.3.3.21.4"></a><h2>Properties</h2> |
| 61 |
<pre class="synopsis"> |
| 62 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.VolumeGroup" title='The "VolumeGroup" property'>VolumeGroup</a> readable o |
| 63 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Name" title='The "Name" property'>Name</a> readable s |
| 64 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Active" title='The "Active" property'>Active</a> readable b |
| 65 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.UUID" title='The "UUID" property'>UUID</a> readable s |
| 66 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Size" title='The "Size" property'>Size</a> readable t |
| 67 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.DataAllocatedRatio" title='The "DataAllocatedRatio" property'>DataAllocatedRatio</a> readable d |
| 68 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.MetadataAllocatedRatio" title='The "MetadataAllocatedRatio" property'>MetadataAllocatedRatio</a> readable d |
| 69 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Type" title='The "Type" property'>Type</a> readable s |
| 70 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Layout" title='The "Layout" property'>Layout</a> readable s |
| 71 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Structure" title='The "Structure" property'>Structure</a> readable a{sv} |
| 72 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.SyncRatio" title='The "SyncRatio" property'>SyncRatio</a> readable d |
| 73 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.ThinPool" title='The "ThinPool" property'>ThinPool</a> readable o |
| 74 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Origin" title='The "Origin" property'>Origin</a> readable o |
| 75 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.ChildConfiguration" title='The "ChildConfiguration" property'>ChildConfiguration</a> readable a(sa{sv}) |
| 76 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.BlockDevice" title='The "BlockDevice" property'>BlockDevice</a> readable o |
| 77 |
</pre> |
| 78 |
</div> |
| 79 |
<div class="refsect1"> |
| 80 |
<a name="gdbus-interface-org-freedesktop-UDisks2-LogicalVolume"></a><h2>Description</h2> |
| 81 |
<p> |
| 82 |
Objects with this interface represent logical volumes in a |
| 83 |
volume group. Active logical volumes are associated with a |
| 84 |
block device, which link back to the logical volume object via |
| 85 |
their <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.LVM2.html#gdbus-property-org-freedesktop-UDisks2-Block-LVM2.LogicalVolume" title='The "LogicalVolume" property'>"LogicalVolume"</a> property. |
| 86 |
</p> |
| 87 |
<p> |
| 88 |
Logical volume objects are children of their volume group |
| 89 |
object, and also link to it via the #VolumeGroup property. |
| 90 |
</p> |
| 91 |
<p class="since">Since 2.0.0</p> |
| 92 |
</div> |
| 93 |
<div class="refsect1"> |
| 94 |
<a name="gdbus-methods-org.freedesktop.UDisks2.LogicalVolume"></a><h2>Method Details</h2> |
| 95 |
<div class="refsect2"> |
| 96 |
<a name="gdbus-method-org-freedesktop-UDisks2-LogicalVolume.Activate"></a><h3>The Activate() method</h3> |
| 97 |
<pre class="programlisting"> |
| 98 |
Activate (IN a{sv} options, |
| 99 |
OUT o result); |
| 100 |
</pre> |
| 101 |
<p> |
| 102 |
</p> |
| 103 |
<p> |
| 104 |
<em class="parameter"><code>options</code></em>: Additional options. |
| 105 |
<em class="parameter"><code>result</code></em>: The UDisks2 object path of the block device. |
| 106 |
</p> |
| 107 |
<p> |
| 108 |
Activate this logical volume, which makes it appear as a |
| 109 |
block device in the system. |
| 110 |
</p> |
| 111 |
<p> |
| 112 |
Non-thin snapshots are always activated and deactivated |
| 113 |
together with their origins. |
| 114 |
</p> |
| 115 |
<p> |
| 116 |
No additional options are currently defined. |
| 117 |
</p> |
| 118 |
<div class="variablelist"><table border="0" class="variablelist"> |
| 119 |
<colgroup> |
| 120 |
<col align="left" valign="top"> |
| 121 |
<col> |
| 122 |
</colgroup> |
| 123 |
<tbody> |
| 124 |
<tr> |
| 125 |
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td> |
| 126 |
<td> |
| 127 |
<p> |
| 128 |
</p> |
| 129 |
<p> |
| 130 |
</p> |
| 131 |
</td> |
| 132 |
</tr> |
| 133 |
<tr> |
| 134 |
<td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>result</code></em></code>:</span></p></td> |
| 135 |
<td> |
| 136 |
<p> |
| 137 |
</p> |
| 138 |
<p> |
| 139 |
</p> |
| 140 |
</td> |
| 141 |
</tr> |
| 142 |
</tbody> |
| 143 |
</table></div> |
| 144 |
<p class="since">Since 2.0.0</p> |
| 145 |
</div> |
| 146 |
<hr> |
| 147 |
<div class="refsect2"> |
| 148 |
<a name="gdbus-method-org-freedesktop-UDisks2-LogicalVolume.Deactivate"></a><h3>The Deactivate() method</h3> |
| 149 |
<pre class="programlisting"> |
| 150 |
Deactivate (IN a{sv} options); |
| 151 |
</pre> |
| 152 |
<p> |
| 153 |
</p> |
| 154 |
<p> |
| 155 |
<em class="parameter"><code>options</code></em>: Additional options. |
| 156 |
</p> |
| 157 |
<p> |
| 158 |
Deactivate this logical volume, which makes its block device |
| 159 |
disappear. |
| 160 |
</p> |
| 161 |
<p> |
| 162 |
Non-thin snapshots are always activated and deactivated |
| 163 |
together with their origins. |
| 164 |
</p> |
| 165 |
<p> |
| 166 |
No additional options are currently defined. |
| 167 |
</p> |
| 168 |
<div class="variablelist"><table border="0" class="variablelist"> |
| 169 |
<colgroup> |
| 170 |
<col align="left" valign="top"> |
| 171 |
<col> |
| 172 |
</colgroup> |
| 173 |
<tbody><tr> |
| 174 |
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td> |
| 175 |
<td> |
| 176 |
<p> |
| 177 |
</p> |
| 178 |
<p> |
| 179 |
</p> |
| 180 |
</td> |
| 181 |
</tr></tbody> |
| 182 |
</table></div> |
| 183 |
<p class="since">Since 2.0.0</p> |
| 184 |
</div> |
| 185 |
<hr> |
| 186 |
<div class="refsect2"> |
| 187 |
<a name="gdbus-method-org-freedesktop-UDisks2-LogicalVolume.Delete"></a><h3>The Delete() method</h3> |
| 188 |
<pre class="programlisting"> |
| 189 |
Delete (IN a{sv} options); |
| 190 |
</pre> |
| 191 |
<p> |
| 192 |
</p> |
| 193 |
<p> |
| 194 |
<em class="parameter"><code>options</code></em>: Additional options. |
| 195 |
</p> |
| 196 |
<p> |
| 197 |
Delete this logical volume. |
| 198 |
</p> |
| 199 |
<p> |
| 200 |
If there are any non-thin snapshots of this logical volume, |
| 201 |
they will be deleted as well. |
| 202 |
</p> |
| 203 |
<p> |
| 204 |
If this is a thin pool, all its contained thin volumes will |
| 205 |
be deleted as well. |
| 206 |
</p> |
| 207 |
<p> |
| 208 |
If the option <em class="parameter"><code>tear-down</code></em> is set to |
| 209 |
<code class="constant">TRUE</code>, then the logical volume and all its children will be |
| 210 |
cleaned up before deletion. This cleanup consists of |
| 211 |
removing entries from /etc/fstab and /etc/crypttab, and |
| 212 |
locking of encrypted block devices. Entries in /etc/fstab |
| 213 |
and /etc/crypttab that have been created with the |
| 214 |
'track-parents' options to AddConfigurationItem will be |
| 215 |
removed even if their block device is currently unavailable. |
| 216 |
</p> |
| 217 |
<div class="variablelist"><table border="0" class="variablelist"> |
| 218 |
<colgroup> |
| 219 |
<col align="left" valign="top"> |
| 220 |
<col> |
| 221 |
</colgroup> |
| 222 |
<tbody><tr> |
| 223 |
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td> |
| 224 |
<td> |
| 225 |
<p> |
| 226 |
</p> |
| 227 |
<p> |
| 228 |
</p> |
| 229 |
</td> |
| 230 |
</tr></tbody> |
| 231 |
</table></div> |
| 232 |
<p class="since">Since 2.0.0</p> |
| 233 |
</div> |
| 234 |
<hr> |
| 235 |
<div class="refsect2"> |
| 236 |
<a name="gdbus-method-org-freedesktop-UDisks2-LogicalVolume.Rename"></a><h3>The Rename() method</h3> |
| 237 |
<pre class="programlisting"> |
| 238 |
Rename (IN s new_name, |
| 239 |
IN a{sv} options, |
| 240 |
OUT o result); |
| 241 |
</pre> |
| 242 |
<p> |
| 243 |
</p> |
| 244 |
<p> |
| 245 |
<em class="parameter"><code>new_name</code></em>: The new name. |
| 246 |
<em class="parameter"><code>options</code></em>: Additional options. |
| 247 |
<em class="parameter"><code>result</code></em>: The new object path. |
| 248 |
</p> |
| 249 |
<p> |
| 250 |
Rename this logical volume. This might cause the logical |
| 251 |
volume object to disappear from D-Bus and reappear with a |
| 252 |
different path. |
| 253 |
</p> |
| 254 |
<p> |
| 255 |
No additional options are currently defined. |
| 256 |
</p> |
| 257 |
<div class="variablelist"><table border="0" class="variablelist"> |
| 258 |
<colgroup> |
| 259 |
<col align="left" valign="top"> |
| 260 |
<col> |
| 261 |
</colgroup> |
| 262 |
<tbody> |
| 263 |
<tr> |
| 264 |
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>new_name</code></em></code>:</span></p></td> |
| 265 |
<td> |
| 266 |
<p> |
| 267 |
</p> |
| 268 |
<p> |
| 269 |
</p> |
| 270 |
</td> |
| 271 |
</tr> |
| 272 |
<tr> |
| 273 |
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td> |
| 274 |
<td> |
| 275 |
<p> |
| 276 |
</p> |
| 277 |
<p> |
| 278 |
</p> |
| 279 |
</td> |
| 280 |
</tr> |
| 281 |
<tr> |
| 282 |
<td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>result</code></em></code>:</span></p></td> |
| 283 |
<td> |
| 284 |
<p> |
| 285 |
</p> |
| 286 |
<p> |
| 287 |
</p> |
| 288 |
</td> |
| 289 |
</tr> |
| 290 |
</tbody> |
| 291 |
</table></div> |
| 292 |
<p class="since">Since 2.0.0</p> |
| 293 |
</div> |
| 294 |
<hr> |
| 295 |
<div class="refsect2"> |
| 296 |
<a name="gdbus-method-org-freedesktop-UDisks2-LogicalVolume.Resize"></a><h3>The Resize() method</h3> |
| 297 |
<pre class="programlisting"> |
| 298 |
Resize (IN t new_size, |
| 299 |
IN a{sv} options); |
| 300 |
</pre> |
| 301 |
<p> |
| 302 |
</p> |
| 303 |
<p> |
| 304 |
<em class="parameter"><code>new_size</code></em>: The new size, in bytes. |
| 305 |
<em class="parameter"><code>options</code></em>: Additional options. |
| 306 |
</p> |
| 307 |
<p> |
| 308 |
Resize this logical volume. |
| 309 |
</p> |
| 310 |
<p> |
| 311 |
Additional options: |
| 312 |
</p> |
| 313 |
<p> |
| 314 |
resize_fsys (b): Whether to resize the filesystem on the |
| 315 |
logical volume as well. Default to 'false'. |
| 316 |
</p> |
| 317 |
<p> |
| 318 |
force (b): Whether to force the resize even if it might |
| 319 |
destroy data. |
| 320 |
</p> |
| 321 |
<p> |
| 322 |
pvs (ao): A list of physical volumes to allocate more space |
| 323 |
from. |
| 324 |
</p> |
| 325 |
<div class="variablelist"><table border="0" class="variablelist"> |
| 326 |
<colgroup> |
| 327 |
<col align="left" valign="top"> |
| 328 |
<col> |
| 329 |
</colgroup> |
| 330 |
<tbody> |
| 331 |
<tr> |
| 332 |
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>new_size</code></em></code>:</span></p></td> |
| 333 |
<td> |
| 334 |
<p> |
| 335 |
</p> |
| 336 |
<p> |
| 337 |
</p> |
| 338 |
</td> |
| 339 |
</tr> |
| 340 |
<tr> |
| 341 |
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td> |
| 342 |
<td> |
| 343 |
<p> |
| 344 |
</p> |
| 345 |
<p> |
| 346 |
</p> |
| 347 |
</td> |
| 348 |
</tr> |
| 349 |
</tbody> |
| 350 |
</table></div> |
| 351 |
<p class="since">Since 2.0.0</p> |
| 352 |
</div> |
| 353 |
<hr> |
| 354 |
<div class="refsect2"> |
| 355 |
<a name="gdbus-method-org-freedesktop-UDisks2-LogicalVolume.Repair"></a><h3>The Repair() method</h3> |
| 356 |
<pre class="programlisting"> |
| 357 |
Repair (IN ao pvs, |
| 358 |
IN a{sv} options); |
| 359 |
</pre> |
| 360 |
<p> |
| 361 |
</p> |
| 362 |
<p> |
| 363 |
<em class="parameter"><code>pvs</code></em>: A list of physical volumes to use for the repair. |
| 364 |
<em class="parameter"><code>options</code></em>: Additional options. |
| 365 |
<em class="parameter"><code>since</code></em>: 2.10.0 |
| 366 |
</p> |
| 367 |
<p> |
| 368 |
Attempt a repair of this logical volume after it has lost |
| 369 |
some physical volumes. Space is allocated from the given |
| 370 |
physical volumes as needed. A empty list means to allocate |
| 371 |
from all physical volumes. |
| 372 |
</p> |
| 373 |
<p> |
| 374 |
No additional options are currently defined. |
| 375 |
</p> |
| 376 |
<div class="variablelist"><table border="0" class="variablelist"> |
| 377 |
<colgroup> |
| 378 |
<col align="left" valign="top"> |
| 379 |
<col> |
| 380 |
</colgroup> |
| 381 |
<tbody> |
| 382 |
<tr> |
| 383 |
<td><p><span class="term"><code class="literal">IN ao <em class="parameter"><code>pvs</code></em></code>:</span></p></td> |
| 384 |
<td> |
| 385 |
<p> |
| 386 |
</p> |
| 387 |
<p> |
| 388 |
</p> |
| 389 |
</td> |
| 390 |
</tr> |
| 391 |
<tr> |
| 392 |
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td> |
| 393 |
<td> |
| 394 |
<p> |
| 395 |
</p> |
| 396 |
<p> |
| 397 |
</p> |
| 398 |
</td> |
| 399 |
</tr> |
| 400 |
</tbody> |
| 401 |
</table></div> |
| 402 |
<p class="since">Since 2.0.0</p> |
| 403 |
</div> |
| 404 |
<hr> |
| 405 |
<div class="refsect2"> |
| 406 |
<a name="gdbus-method-org-freedesktop-UDisks2-LogicalVolume.CreateSnapshot"></a><h3>The CreateSnapshot() method</h3> |
| 407 |
<pre class="programlisting"> |
| 408 |
CreateSnapshot (IN s name, |
| 409 |
IN t size, |
| 410 |
IN a{sv} options, |
| 411 |
OUT o result); |
| 412 |
</pre> |
| 413 |
<p> |
| 414 |
</p> |
| 415 |
<p> |
| 416 |
<em class="parameter"><code>name</code></em>: The name of the snapshot. |
| 417 |
<em class="parameter"><code>size</code></em>: The size of the backing store for the snapshot, in bytes. |
| 418 |
<em class="parameter"><code>options</code></em>: Additional options. |
| 419 |
</p> |
| 420 |
<p> |
| 421 |
Create a snapshot of this logical volume. |
| 422 |
</p> |
| 423 |
<p> |
| 424 |
When creating a snapshot of a non-thin volume, a non-zero |
| 425 |
size must be specified. A non-thin snapshot is created in |
| 426 |
this case. |
| 427 |
</p> |
| 428 |
<p> |
| 429 |
When creating a snapshot of a thin volume, specifying a <em class="parameter"><code>size</code></em> |
| 430 |
of zero will create a thin snapshot in the same pool. |
| 431 |
</p> |
| 432 |
<p> |
| 433 |
When creating a snapshot of a thin volume, specifying a |
| 434 |
non-zero <em class="parameter"><code>size</code></em> will create a non-thin snapshot. |
| 435 |
</p> |
| 436 |
<p> |
| 437 |
No additional options are currently defined. |
| 438 |
</p> |
| 439 |
<div class="variablelist"><table border="0" class="variablelist"> |
| 440 |
<colgroup> |
| 441 |
<col align="left" valign="top"> |
| 442 |
<col> |
| 443 |
</colgroup> |
| 444 |
<tbody> |
| 445 |
<tr> |
| 446 |
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>name</code></em></code>:</span></p></td> |
| 447 |
<td> |
| 448 |
<p> |
| 449 |
</p> |
| 450 |
<p> |
| 451 |
</p> |
| 452 |
</td> |
| 453 |
</tr> |
| 454 |
<tr> |
| 455 |
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>size</code></em></code>:</span></p></td> |
| 456 |
<td> |
| 457 |
<p> |
| 458 |
</p> |
| 459 |
<p> |
| 460 |
</p> |
| 461 |
</td> |
| 462 |
</tr> |
| 463 |
<tr> |
| 464 |
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td> |
| 465 |
<td> |
| 466 |
<p> |
| 467 |
</p> |
| 468 |
<p> |
| 469 |
</p> |
| 470 |
</td> |
| 471 |
</tr> |
| 472 |
<tr> |
| 473 |
<td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>result</code></em></code>:</span></p></td> |
| 474 |
<td> |
| 475 |
<p> |
| 476 |
</p> |
| 477 |
<p> |
| 478 |
</p> |
| 479 |
</td> |
| 480 |
</tr> |
| 481 |
</tbody> |
| 482 |
</table></div> |
| 483 |
<p class="since">Since 2.0.0</p> |
| 484 |
</div> |
| 485 |
<hr> |
| 486 |
<div class="refsect2"> |
| 487 |
<a name="gdbus-method-org-freedesktop-UDisks2-LogicalVolume.CacheAttach"></a><h3>The CacheAttach() method</h3> |
| 488 |
<pre class="programlisting"> |
| 489 |
CacheAttach (IN s cache_name, |
| 490 |
IN a{sv} options); |
| 491 |
</pre> |
| 492 |
<p> |
| 493 |
</p> |
| 494 |
<p> |
| 495 |
<em class="parameter"><code>cache_name</code></em>: The name of an existing volume. |
| 496 |
<em class="parameter"><code>options</code></em>: Additional options. |
| 497 |
<em class="parameter"><code>since</code></em>: 2.3.0 |
| 498 |
</p> |
| 499 |
<p> |
| 500 |
Creates cache LV. Logical volume which name is provided, will be formatted, converted to cache type |
| 501 |
and attached to origin logical volume as a cache pool LV. Logical volumes must be in the same volume group. |
| 502 |
</p> |
| 503 |
<p> |
| 504 |
No additional options are currently defined. |
| 505 |
</p> |
| 506 |
<div class="variablelist"><table border="0" class="variablelist"> |
| 507 |
<colgroup> |
| 508 |
<col align="left" valign="top"> |
| 509 |
<col> |
| 510 |
</colgroup> |
| 511 |
<tbody> |
| 512 |
<tr> |
| 513 |
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>cache_name</code></em></code>:</span></p></td> |
| 514 |
<td> |
| 515 |
<p> |
| 516 |
</p> |
| 517 |
<p> |
| 518 |
</p> |
| 519 |
</td> |
| 520 |
</tr> |
| 521 |
<tr> |
| 522 |
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td> |
| 523 |
<td> |
| 524 |
<p> |
| 525 |
</p> |
| 526 |
<p> |
| 527 |
</p> |
| 528 |
</td> |
| 529 |
</tr> |
| 530 |
</tbody> |
| 531 |
</table></div> |
| 532 |
<p class="since">Since 2.0.0</p> |
| 533 |
</div> |
| 534 |
<hr> |
| 535 |
<div class="refsect2"> |
| 536 |
<a name="gdbus-method-org-freedesktop-UDisks2-LogicalVolume.CacheSplit"></a><h3>The CacheSplit() method</h3> |
| 537 |
<pre class="programlisting"> |
| 538 |
CacheSplit (IN a{sv} options); |
| 539 |
</pre> |
| 540 |
<p> |
| 541 |
</p> |
| 542 |
<p> |
| 543 |
<em class="parameter"><code>options</code></em>: Additional options. |
| 544 |
<em class="parameter"><code>since</code></em>: 2.3.0 |
| 545 |
</p> |
| 546 |
<p> |
| 547 |
Splits Cache LV to Cache pool LV and Origin LV, not afeecting its content. |
| 548 |
</p> |
| 549 |
<p> |
| 550 |
No additional options are currently defined. |
| 551 |
</p> |
| 552 |
<div class="variablelist"><table border="0" class="variablelist"> |
| 553 |
<colgroup> |
| 554 |
<col align="left" valign="top"> |
| 555 |
<col> |
| 556 |
</colgroup> |
| 557 |
<tbody><tr> |
| 558 |
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td> |
| 559 |
<td> |
| 560 |
<p> |
| 561 |
</p> |
| 562 |
<p> |
| 563 |
</p> |
| 564 |
</td> |
| 565 |
</tr></tbody> |
| 566 |
</table></div> |
| 567 |
<p class="since">Since 2.0.0</p> |
| 568 |
</div> |
| 569 |
<hr> |
| 570 |
<div class="refsect2"> |
| 571 |
<a name="gdbus-method-org-freedesktop-UDisks2-LogicalVolume.CacheDetach"></a><h3>The CacheDetach() method</h3> |
| 572 |
<pre class="programlisting"> |
| 573 |
CacheDetach (IN a{sv} options); |
| 574 |
</pre> |
| 575 |
<p> |
| 576 |
</p> |
| 577 |
<p> |
| 578 |
<em class="parameter"><code>options</code></em>: Additional options. |
| 579 |
<em class="parameter"><code>since</code></em>: 2.6.3 |
| 580 |
</p> |
| 581 |
<p> |
| 582 |
Detaches the cached LV from its cache. |
| 583 |
</p> |
| 584 |
<p> |
| 585 |
No additional options are currently defined. |
| 586 |
</p> |
| 587 |
<div class="variablelist"><table border="0" class="variablelist"> |
| 588 |
<colgroup> |
| 589 |
<col align="left" valign="top"> |
| 590 |
<col> |
| 591 |
</colgroup> |
| 592 |
<tbody><tr> |
| 593 |
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td> |
| 594 |
<td> |
| 595 |
<p> |
| 596 |
</p> |
| 597 |
<p> |
| 598 |
</p> |
| 599 |
</td> |
| 600 |
</tr></tbody> |
| 601 |
</table></div> |
| 602 |
<p class="since">Since 2.0.0</p> |
| 603 |
</div> |
| 604 |
</div> |
| 605 |
<div class="refsect1"> |
| 606 |
<a name="gdbus-properties-org.freedesktop.UDisks2.LogicalVolume"></a><h2>Property Details</h2> |
| 607 |
<div class="refsect2"> |
| 608 |
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.VolumeGroup"></a><h3>The "VolumeGroup" property</h3> |
| 609 |
<pre class="programlisting"> |
| 610 |
VolumeGroup readable o |
| 611 |
</pre> |
| 612 |
<p> |
| 613 |
The path of the volume group object that this logical volume |
| 614 |
belongs to. |
| 615 |
</p> |
| 616 |
<p class="since">Since 2.0.0</p> |
| 617 |
</div> |
| 618 |
<hr> |
| 619 |
<div class="refsect2"> |
| 620 |
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Name"></a><h3>The "Name" property</h3> |
| 621 |
<pre class="programlisting"> |
| 622 |
Name readable s |
| 623 |
</pre> |
| 624 |
<p> |
| 625 |
The name of this logical volume, as it is known to LVM2. |
| 626 |
</p> |
| 627 |
<p class="since">Since 2.0.0</p> |
| 628 |
</div> |
| 629 |
<hr> |
| 630 |
<div class="refsect2"> |
| 631 |
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Active"></a><h3>The "Active" property</h3> |
| 632 |
<pre class="programlisting"> |
| 633 |
Active readable b |
| 634 |
</pre> |
| 635 |
<p> |
| 636 |
Whether or not this volume is active. |
| 637 |
</p> |
| 638 |
<p class="since">Since 2.0.0</p> |
| 639 |
</div> |
| 640 |
<hr> |
| 641 |
<div class="refsect2"> |
| 642 |
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.UUID"></a><h3>The "UUID" property</h3> |
| 643 |
<pre class="programlisting"> |
| 644 |
UUID readable s |
| 645 |
</pre> |
| 646 |
<p> |
| 647 |
The UUID of this logical volume. It is guaranteed to be |
| 648 |
unique within the group, but it might change over time. |
| 649 |
</p> |
| 650 |
<p class="since">Since 2.0.0</p> |
| 651 |
</div> |
| 652 |
<hr> |
| 653 |
<div class="refsect2"> |
| 654 |
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Size"></a><h3>The "Size" property</h3> |
| 655 |
<pre class="programlisting"> |
| 656 |
Size readable t |
| 657 |
</pre> |
| 658 |
<p> |
| 659 |
The total size of this logical volume in bytes, including the |
| 660 |
size of the metadata. |
| 661 |
</p> |
| 662 |
<p class="since">Since 2.0.0</p> |
| 663 |
</div> |
| 664 |
<hr> |
| 665 |
<div class="refsect2"> |
| 666 |
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.DataAllocatedRatio"></a><h3>The "DataAllocatedRatio" property</h3> |
| 667 |
<pre class="programlisting"> |
| 668 |
DataAllocatedRatio readable d |
| 669 |
</pre> |
| 670 |
<p> |
| 671 |
For a thin pool or a non-thin snapshot, indicates how full |
| 672 |
the area for storing data is. A value of 1.0 corresponds to |
| 673 |
100<code class="constant"></code>. |
| 674 |
</p> |
| 675 |
<p class="since">Since 2.0.0</p> |
| 676 |
</div> |
| 677 |
<hr> |
| 678 |
<div class="refsect2"> |
| 679 |
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.MetadataAllocatedRatio"></a><h3>The "MetadataAllocatedRatio" property</h3> |
| 680 |
<pre class="programlisting"> |
| 681 |
MetadataAllocatedRatio readable d |
| 682 |
</pre> |
| 683 |
<p> |
| 684 |
For a thin pool or a non-thin snapshot, indicates how full |
| 685 |
the area for storing meta data is. A value of 1.0 |
| 686 |
corresponds to 100<code class="constant"></code>. |
| 687 |
</p> |
| 688 |
<p class="since">Since 2.0.0</p> |
| 689 |
</div> |
| 690 |
<hr> |
| 691 |
<div class="refsect2"> |
| 692 |
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Type"></a><h3>The "Type" property</h3> |
| 693 |
<pre class="programlisting"> |
| 694 |
Type readable s |
| 695 |
</pre> |
| 696 |
<p> |
| 697 |
The general type of a logical volume. One of "block", "pool" |
| 698 |
or "vdopool". More types might be defined in the future. |
| 699 |
</p> |
| 700 |
<p> |
| 701 |
A volume of type "block" can be used as a block device. A |
| 702 |
volume of type "pool" can be used to create thin volumes. |
| 703 |
A volume of type "vdopool" is the internal pool for the |
| 704 |
VDO logical volume device. |
| 705 |
</p> |
| 706 |
<p class="since">Since 2.0.0</p> |
| 707 |
</div> |
| 708 |
<hr> |
| 709 |
<div class="refsect2"> |
| 710 |
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Layout"></a><h3>The "Layout" property</h3> |
| 711 |
<pre class="programlisting"> |
| 712 |
Layout readable s |
| 713 |
</pre> |
| 714 |
<p> |
| 715 |
</p> |
| 716 |
<p> |
| 717 |
<em class="parameter"><code>since</code></em>: 2.10.0 |
| 718 |
</p> |
| 719 |
<p> |
| 720 |
The layout of this logical volume, such as "linear", "raid5", |
| 721 |
etc. |
| 722 |
</p> |
| 723 |
<p class="since">Since 2.0.0</p> |
| 724 |
</div> |
| 725 |
<hr> |
| 726 |
<div class="refsect2"> |
| 727 |
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Structure"></a><h3>The "Structure" property</h3> |
| 728 |
<pre class="programlisting"> |
| 729 |
Structure readable a{sv} |
| 730 |
</pre> |
| 731 |
<p> |
| 732 |
</p> |
| 733 |
<p> |
| 734 |
<em class="parameter"><code>since</code></em>: 2.10.0 |
| 735 |
</p> |
| 736 |
<p> |
| 737 |
The detailed structure of how this logical volume is stored on physical volumes. |
| 738 |
</p> |
| 739 |
<p> |
| 740 |
The following fields are present: |
| 741 |
</p> |
| 742 |
<p> |
| 743 |
- name (s): The name of the logical volume. |
| 744 |
- type (s): The layout type of the logical volume. |
| 745 |
- size (t): The size in bytes of the logical volume. |
| 746 |
</p> |
| 747 |
<p> |
| 748 |
If the logical volume is stored directly on physical volumes, |
| 749 |
this field is present as well: |
| 750 |
</p> |
| 751 |
<p> |
| 752 |
- segs (a(tto)): Information about the segments of the logical volume (see below). |
| 753 |
</p> |
| 754 |
<p> |
| 755 |
A segment is represented by a "(tto)" tuple, where the fields |
| 756 |
have these meanings: |
| 757 |
</p> |
| 758 |
<p> |
| 759 |
- (t): The start of this segement on the physical volume, in bytes. |
| 760 |
- (t): The size of the segment, in bytes. |
| 761 |
- (o): The path of the org.freedesktop.UDisks.Block object of the physical volume. |
| 762 |
</p> |
| 763 |
<p> |
| 764 |
For a healthy logical volume, the sizes of its segments will |
| 765 |
add up exactly to its own size. If a volume group has lost |
| 766 |
some physical volumes, a affected logical volume will have a |
| 767 |
list of segments here that do not add up to its full size. |
| 768 |
</p> |
| 769 |
<p> |
| 770 |
If the logical volume is stored on other logical volumes, |
| 771 |
these fields are present in the "Structure" value instead of |
| 772 |
"segs": |
| 773 |
</p> |
| 774 |
<p> |
| 775 |
- data (aa{sv}): The list of "Structure" objects for the data sub-volumes. |
| 776 |
- metadata (aa{sv}): The list of "Structure" objects for the metadata sub-volumes. |
| 777 |
</p> |
| 778 |
<p> |
| 779 |
For example, a minimal "raid5" layout will have three "data" |
| 780 |
sub-volumes (and three parallel "metadata" sub-volumes), |
| 781 |
which are the three stripes of the RAID configuration. Each |
| 782 |
of those sub-volume will be stored directly on physical |
| 783 |
volumes and one can inspect the "segs" field of those to |
| 784 |
figure out how many are damaged. From that, one can deduce |
| 785 |
whether the RAID is degraded (exactly one damaged), or has |
| 786 |
lost data (more than one damaged). |
| 787 |
</p> |
| 788 |
<p class="since">Since 2.0.0</p> |
| 789 |
</div> |
| 790 |
<hr> |
| 791 |
<div class="refsect2"> |
| 792 |
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.SyncRatio"></a><h3>The "SyncRatio" property</h3> |
| 793 |
<pre class="programlisting"> |
| 794 |
SyncRatio readable d |
| 795 |
</pre> |
| 796 |
<p> |
| 797 |
</p> |
| 798 |
<p> |
| 799 |
<em class="parameter"><code>since</code></em>: 2.10.0 |
| 800 |
</p> |
| 801 |
<p> |
| 802 |
How far along the logical volume is with resynchronizing. A |
| 803 |
value of 1.0 corresponds to fully synchronized and indicates |
| 804 |
that no operation is in progress. This is only relevant for |
| 805 |
logical volumes with some redundancy, like "raid1" or |
| 806 |
"raid5". |
| 807 |
</p> |
| 808 |
<p class="since">Since 2.0.0</p> |
| 809 |
</div> |
| 810 |
<hr> |
| 811 |
<div class="refsect2"> |
| 812 |
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.ThinPool"></a><h3>The "ThinPool" property</h3> |
| 813 |
<pre class="programlisting"> |
| 814 |
ThinPool readable o |
| 815 |
</pre> |
| 816 |
<p> |
| 817 |
For a thin volume, the object path of its pool. |
| 818 |
</p> |
| 819 |
<p class="since">Since 2.0.0</p> |
| 820 |
</div> |
| 821 |
<hr> |
| 822 |
<div class="refsect2"> |
| 823 |
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Origin"></a><h3>The "Origin" property</h3> |
| 824 |
<pre class="programlisting"> |
| 825 |
Origin readable o |
| 826 |
</pre> |
| 827 |
<p> |
| 828 |
For a snapshot, the object path of its origin. |
| 829 |
</p> |
| 830 |
<p class="since">Since 2.0.0</p> |
| 831 |
</div> |
| 832 |
<hr> |
| 833 |
<div class="refsect2"> |
| 834 |
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.ChildConfiguration"></a><h3>The "ChildConfiguration" property</h3> |
| 835 |
<pre class="programlisting"> |
| 836 |
ChildConfiguration readable a(sa{sv}) |
| 837 |
</pre> |
| 838 |
<p> |
| 839 |
Configuration items belonging to the |
| 840 |
</p> |
| 841 |
<p> |
| 842 |
block device of this logical volume and its children. This |
| 843 |
is also valid when this logical volume is not currently |
| 844 |
active and there is no block device for it. It works via the |
| 845 |
'track-parents' options of |
| 846 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.AddConfigurationItem" title="The AddConfigurationItem() method">AddConfigurationItem()</a>, which |
| 847 |
see. |
| 848 |
</p> |
| 849 |
<p class="since">Since 2.0.0</p> |
| 850 |
</div> |
| 851 |
<hr> |
| 852 |
<div class="refsect2"> |
| 853 |
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.BlockDevice"></a><h3>The "BlockDevice" property</h3> |
| 854 |
<pre class="programlisting"> |
| 855 |
BlockDevice readable o |
| 856 |
</pre> |
| 857 |
<p> |
| 858 |
</p> |
| 859 |
<p> |
| 860 |
<em class="parameter"><code>since</code></em>: 2.7.1 |
| 861 |
</p> |
| 862 |
<p> |
| 863 |
For an active LV, the object path of its block device. |
| 864 |
</p> |
| 865 |
<p class="since">Since 2.0.0</p> |
| 866 |
</div> |
| 867 |
</div> |
| 868 |
</div> |
| 869 |
<div class="footer"> |
| 870 |
<hr>Generated by GTK-Doc V1.35.1</div> |
| 871 |
</body> |
| 872 |
</html> |