~behda/+junk/udisks2.original

<a href="#gdbus-org.freedesktop.UDisks2.Block.description" class="shortcut">Description</a></span><span id="nav_properties"> <span class="dim">|</span>

<a href="#gdbus-org.freedesktop.UDisks2.Block.properties" class="shortcut">Properties</a></span>

</td>

</tr></table>

<h2><span class="refentrytitle"><a name="gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page"></a>org.freedesktop.UDisks2.Block</span></h2>

<p>org.freedesktop.UDisks2.Block — Block device</p>

</td>

</tr></table></div>

<h2>Methods</h2>

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.AddConfigurationItem" title="The AddConfigurationItem() method">AddConfigurationItem</a> (IN (sa{sv}) item,

IN a{sv} options);

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.RemoveConfigurationItem" title="The RemoveConfigurationItem() method">RemoveConfigurationItem</a> (IN (sa{sv}) item,

IN a{sv} options);

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.UpdateConfigurationItem" title="The UpdateConfigurationItem() method">UpdateConfigurationItem</a> (IN (sa{sv}) old_item,

IN (sa{sv}) new_item,

IN a{sv} options);

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.GetSecretConfiguration" title="The GetSecretConfiguration() method">GetSecretConfiguration</a> (IN a{sv} options,

OUT a(sa{sv}) configuration);

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.Format" title="The Format() method">Format</a> (IN s type,

IN a{sv} options);

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.OpenForBackup" title="The OpenForBackup() method">OpenForBackup</a> (IN a{sv} options,

OUT h fd);

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.OpenForRestore" title="The OpenForRestore() method">OpenForRestore</a> (IN a{sv} options,

OUT h fd);

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.OpenForBenchmark" title="The OpenForBenchmark() method">OpenForBenchmark</a> (IN a{sv} options,

OUT h fd);

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.Rescan" title="The Rescan() method">Rescan</a> (IN a{sv} options);

</pre>

</div>

<a name="id-1.3.3.6.4"></a><h2>Properties</h2>

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Device" title='The "Device" property'>Device</a> readable ay

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.PreferredDevice" title='The "PreferredDevice" property'>PreferredDevice</a> readable ay

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Symlinks" title='The "Symlinks" property'>Symlinks</a> readable aay

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.DeviceNumber" title='The "DeviceNumber" property'>DeviceNumber</a> readable t

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Id" title='The "Id" property'>Id</a> readable s

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Size" title='The "Size" property'>Size</a> readable t

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.ReadOnly" title='The "ReadOnly" property'>ReadOnly</a> readable b

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Drive" title='The "Drive" property'>Drive</a> readable o

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.MDRaid" title='The "MDRaid" property'>MDRaid</a> readable o

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.MDRaidMember" title='The "MDRaidMember" property'>MDRaidMember</a> readable o

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.IdUsage" title='The "IdUsage" property'>IdUsage</a> readable s

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.IdType" title='The "IdType" property'>IdType</a> readable s

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.IdVersion" title='The "IdVersion" property'>IdVersion</a> readable s

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.IdLabel" title='The "IdLabel" property'>IdLabel</a> readable s

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.IdUUID" title='The "IdUUID" property'>IdUUID</a> readable s

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Configuration" title='The "Configuration" property'>Configuration</a> readable a(sa{sv})

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.CryptoBackingDevice" title='The "CryptoBackingDevice" property'>CryptoBackingDevice</a> readable o

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.HintPartitionable" title='The "HintPartitionable" property'>HintPartitionable</a> readable b

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.HintSystem" title='The "HintSystem" property'>HintSystem</a> readable b

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.HintIgnore" title='The "HintIgnore" property'>HintIgnore</a> readable b

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.HintAuto" title='The "HintAuto" property'>HintAuto</a> readable b

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.HintName" title='The "HintName" property'>HintName</a> readable s

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.HintIconName" title='The "HintIconName" property'>HintIconName</a> readable s

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.HintSymbolicIconName" title='The "HintSymbolicIconName" property'>HintSymbolicIconName</a> readable s

</pre>

</div>

<a name="gdbus-interface-org-freedesktop-UDisks2-Block"></a><h2>Description</h2>

<p> This interface represents a block device.

</p>

<p> This should not be confused with the

<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-interface-org-freedesktop-UDisks2-Drive.top_of_page">org.freedesktop.UDisks2.Drive</a> interface that is used to represent

disk drives. For example, the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</a>

interface is also used for block devices that do not correspond to

drives at all (e.g. <a class="ulink" href="http://en.wikipedia.org/wiki/Loop_device" target="_top">Loop

Devices</a>).

</p>

</div>

100

<a name="gdbus-methods-org.freedesktop.UDisks2.Block"></a><h2>Method Details</h2>

101

102

<a name="gdbus-method-org-freedesktop-UDisks2-Block.AddConfigurationItem"></a><h3>The AddConfigurationItem() method</h3>

103

104

AddConfigurationItem (IN (sa{sv}) item,

105

IN a{sv} options);

106

</pre>

107

<p> Adds a new configuration item.

108

</p>

109

<p> See the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Configuration" title='The "Configuration" property'>"Configuration"</a>

110

property for details about valid configuration items.

111

</p>

112

113

114

115

<col>

116

</colgroup>

117

<tbody>

118

<tr>

119

120

<td><p>The configuration item to add.</p></td>

121

</tr>

122

<tr>

123

<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>

124

<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>

125

</tr>

126

</tbody>

127

</table></div>

128

</div>

129

<hr>

130

131

<a name="gdbus-method-org-freedesktop-UDisks2-Block.RemoveConfigurationItem"></a><h3>The RemoveConfigurationItem() method</h3>

132

133

RemoveConfigurationItem (IN (sa{sv}) item,

134

IN a{sv} options);

135

</pre>

136

<p> Removes an existing configuration item.

137

</p>

138

<p> See the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Configuration" title='The "Configuration" property'>"Configuration"</a>

139

property for details about valid configuration items.

140

</p>

141

142

143

144

<col>

145

</colgroup>

146

<tbody>

147

<tr>

148

149

<td><p>The configuration item to remove.</p></td>

150

</tr>

151

<tr>

152

<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>

153

<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>

154

</tr>

155

</tbody>

156

</table></div>

157

</div>

158

<hr>

159

160

<a name="gdbus-method-org-freedesktop-UDisks2-Block.UpdateConfigurationItem"></a><h3>The UpdateConfigurationItem() method</h3>

161

162

UpdateConfigurationItem (IN (sa{sv}) old_item,

163

IN (sa{sv}) new_item,

164

IN a{sv} options);

165

</pre>

166

<p> Removes a configuration item and adds a new one. This is

167

equivalent to calling

168

169

followed by

170

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.AddConfigurationItem" title="The AddConfigurationItem() method">AddConfigurationItem()</a>

171

with the change that only one PolicyKit check is made

172

and that <em class="parameter"><code>new_item</code></em> can be validated against <em class="parameter"><code>old_item</code></em>.

173

</p>

174

<p> See the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Configuration" title='The "Configuration" property'>"Configuration"</a>

175

property for details about valid configuration items.

176

</p>

177

178

179

180

<col>

181

</colgroup>

182

<tbody>

183

<tr>

184

185

<td><p>The configuration item to remove.</p></td>

186

</tr>

187

<tr>

188

189

<td><p>The configuration item to add. Must be of the same type as <em class="parameter"><code>old_item</code></em>.</p></td>

190

</tr>

191

<tr>

192

<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>

193

<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>

194

</tr>

195

</tbody>

196

</table></div>

197

</div>

198

<hr>

199

200

<a name="gdbus-method-org-freedesktop-UDisks2-Block.GetSecretConfiguration"></a><h3>The GetSecretConfiguration() method</h3>

201

202

GetSecretConfiguration (IN a{sv} options,

203

OUT a(sa{sv}) configuration);

204

</pre>

205

<p> Returns the same value as in the

206

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Configuration" title='The "Configuration" property'>"Configuration"</a> property

207

but without secret information filtered out.

208

</p>

209

210

211

212

<col>

213

</colgroup>

214

<tbody>

215

<tr>

216

<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>

217

<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>

218

</tr>

219

<tr>

220

<td><p><span class="term"><code class="literal">OUT a(sa{sv}) <em class="parameter"><code>configuration</code></em></code>:</span></p></td>

221

<td><p>The resulting configuration.</p></td>

222

</tr>

223

</tbody>

224

</table></div>

225

</div>

226

<hr>

227

228

<a name="gdbus-method-org-freedesktop-UDisks2-Block.Format"></a><h3>The Format() method</h3>

229

230

Format (IN s type,

231

IN a{sv} options);

232

</pre>

233

<p> Formats the device with a file system, partition table or

234

other well-known content.

235

</p>

236

<p> Known values for <em class="parameter"><code>type</code></em> includes <code class="constant">empty</code> (to

237

just zero out areas of the device known to host file system

238

signatures) and <code class="constant">swap</code> (Linux swap space)

239

and most file systems supported by the <span class="citerefentry"><span class="refentrytitle">mkfs</span>(8)</span>

240

program through its <code class="option">-t</code> option.

241

</p>

242

<p> Known partition table formats includes

243

<code class="constant">dos</code> and <code class="constant">gpt</code>.

244

</p>

245

<p> If <em class="parameter"><code>type</code></em> supports it, you can specify a label with the

246

<em class="parameter"><code>label</code></em> option in the <em class="parameter"><code>options</code></em> parameter;

247

however, note that this may not be supported on all file

248

systems and, if supported, the maximum allowed length may

249

vary.

250

</p>

251

<p> If the file system in question supports owners and the option

252

<em class="parameter"><code>take-ownership</code></em> is set to <code class="constant">TRUE</code> then the

253

root directory of the created file system will be owned by the

254

caller of this method.

255

</p>

256

<p> If the option <em class="parameter"><code>encrypt.passphrase</code></em> is

257

given then a LUKS device is created with the given passphrase

258

and the file system is created on the unlocked device. The

259

unlocked device will be left open.

260

</p>

261

<p> If the option <em class="parameter"><code>erase</code></em> is used then the

262

underlying device will be erased. Valid values include

263

<span class="quote">“<span class="quote">zero</span>”</span> to write zeroes over the entire device

264

before formatting, <span class="quote">“<span class="quote">ata-secure-erase</span>”</span> to perform

265

a secure erase or <span class="quote">“<span class="quote">ata-secure-erase-enhanced</span>”</span> to

266

perform an enhanced secure erase.

267

</p>

268

<p> If the option <em class="parameter"><code>update-partition-type</code></em> is

269

set to <code class="constant">TRUE</code> and the object in question is a partition, then

270

its type (cf. the <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.Type" title='The "Type" property'>"Type"</a>

271

property) will be set to the <span class="emphasis"><em>natural</em></span>

272

partition type matching <em class="parameter"><code>type</code></em>, if any. For example, if

273

formatting a GPT partition with a FAT filesystem, the

274

<span class="quote">“<span class="quote">Microsoft Basic Data</span>”</span> partition type will be

275

chosen; similar, if formatting a DOS partition with a Ext4

276

filesystem then partition type 0x83 is chosen.

277

</p>

278

<p> If the option <em class="parameter"><code>no-block</code></em> is set to <code class="constant">TRUE</code>

279

then the method returns just before the actual formatting

280

takes place but after authorization and other checks are

281

done. This is useful for applications that want to format

282

several devices in parallel.

283

</p>

284

285

286

287

<col>

288

</colgroup>

289

<tbody>

290

<tr>

291

292

<td><p>The type of file system, partition table or other content to format the device with.</p></td>

293

</tr>

294

<tr>

295

<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>

296

<td><p>Options - known options (in addition to <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>) includes <em class="parameter"><code>label</code></em> (of type 's'), <em class="parameter"><code>take-ownership</code></em> (of type 'b'), <em class="parameter"><code>encrypt.passphrase</code></em> (of type 's'), <em class="parameter"><code>erase</code></em> (of type 's'), <em class="parameter"><code>no-block</code></em> (of type 'b') and <em class="parameter"><code>update-partition-type</code></em> (of type 'b').</p></td>

297

</tr>

298

</tbody>

299

</table></div>

300

</div>

301

<hr>

302

303

<a name="gdbus-method-org-freedesktop-UDisks2-Block.OpenForBackup"></a><h3>The OpenForBackup() method</h3>

304

305

OpenForBackup (IN a{sv} options,

306

OUT h fd);

307

</pre>

308

<p> Gets a read-only file descriptor for the device intended for a

309

byte-by-byte imaging of the device. This can only be done if

310

the device is not already in use.

311

</p>

312

313

314

315

<col>

316

</colgroup>

317

<tbody>

318

<tr>

319

<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>

320

<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>

321

</tr>

322

<tr>

323

324

<td><p>An index for the returned file descriptor.</p></td>

325

</tr>

326

</tbody>

327

</table></div>

328

</div>

329

<hr>

330

331

<a name="gdbus-method-org-freedesktop-UDisks2-Block.OpenForRestore"></a><h3>The OpenForRestore() method</h3>

332

333

OpenForRestore (IN a{sv} options,

334

OUT h fd);

335

</pre>

336

<p> Gets a writable file descriptor for the device intended for a

337

byte-by-byte restore of a disk image onto the device. This can

338

only be done if the device is not already in use.

339

</p>

340

341

342

343

<col>

344

</colgroup>

345

<tbody>

346

<tr>

347

<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>

348

<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>

349

</tr>

350

<tr>

351

352

<td><p>An index for the returned file descriptor.</p></td>

353

</tr>

354

</tbody>

355

</table></div>

356

</div>

357

<hr>

358

359

<a name="gdbus-method-org-freedesktop-UDisks2-Block.OpenForBenchmark"></a><h3>The OpenForBenchmark() method</h3>

360

361

OpenForBenchmark (IN a{sv} options,

362

OUT h fd);

363

</pre>

364

<p> Gets a file descriptor for the device that is suitable to be

365

used for benchmarking the device (transfer rate, access time

366

etc.). Note that the file descriptor may be opened with the

367

<code class="literal">O_DIRECT</code> and <code class="literal">O_SYNC</code>

368

flags so care must be taken to only perform page-aligned I/O.

369

</p>

370

<p> If the <em class="parameter"><code>writable</code></em> in <em class="parameter"><code>options</code></em> is <code class="constant">TRUE</code>

371

then the returned file descriptor will be writable. This only

372

works if the device is not already in use.

373

</p>

374

375

376

377

<col>

378

</colgroup>

379

<tbody>

380

<tr>

381

<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>

382

<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>

383

</tr>

384

<tr>

385

386

<td><p>An index for the returned file descriptor.</p></td>

387

</tr>

388

</tbody>

389

</table></div>

390

</div>

391

<hr>

392

393

<a name="gdbus-method-org-freedesktop-UDisks2-Block.Rescan"></a><h3>The Rescan() method</h3>

394

395

Rescan (IN a{sv} options);

396

</pre>

397

<p> Request that the kernel and core OS rescans the contents of

398

the device and update their state to reflect this (including

399

things such as the <code class="filename">/dev/disk/</code> hierarchy

400

of symlinks). This includes requesting that the kernel

401

re-reads the partition table, if appropriate.

402

</p>

403

<p> This is usually not needed since the OS automatically does

404

this when the last process with a writable file descriptor for

405

the device closes it.

406

</p>

407

408

409

410

<col>

411

</colgroup>

412

413

<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>

414

<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>

415

</tr></tbody>

416

</table></div>

417

</div>

418

</div>

419

420

<a name="gdbus-properties-org.freedesktop.UDisks2.Block"></a><h2>Property Details</h2>

421

422

<a name="gdbus-property-org-freedesktop-UDisks2-Block.Device"></a><h3>The "Device" property</h3>

423

424

Device readable ay

425

</pre>

426

<p>The special device file for the block device e.g. <code class="filename">/dev/sda2</code>.</p>

427

</div>

428

<hr>

429

430

<a name="gdbus-property-org-freedesktop-UDisks2-Block.PreferredDevice"></a><h3>The "PreferredDevice" property</h3>

431

432

PreferredDevice readable ay

433

</pre>

434

<p> The special device file to present in the UI instead of the value

435

of the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Device" title='The "Device" property'>"Device"</a> property.

436

</p>

437

<p> For example this could be

438

e.g. <code class="filename">/dev/mapper/mpathk</code> for a multipath

439

device with special device file <code class="filename">/dev/dm-9</code>.

440

</p>

441

</div>

442

<hr>

443

444

<a name="gdbus-property-org-freedesktop-UDisks2-Block.Symlinks"></a><h3>The "Symlinks" property</h3>

445

446

Symlinks readable aay

447

</pre>

448

<p> Known symlinks in <code class="filename">/dev</code> that points to

449

the device file in the

450

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Device" title='The "Device" property'>"Device"</a> property.

451

</p>

452

<p> For example, this array could include symlinks such as

453

<code class="filename">/dev/disk/by-id/ata-INTEL_SSDSA2MH080G1GC_CVEM842101HD080DGN</code>

454

and

455

<code class="filename">/dev/disk/by-id/wwn-0x5001517387d61905</code>.

456

</p>

457

</div>

458

<hr>

459

460

<a name="gdbus-property-org-freedesktop-UDisks2-Block.DeviceNumber"></a><h3>The "DeviceNumber" property</h3>

461

462

DeviceNumber readable t

463

</pre>

464

<p>The dev_t of the block device.</p>

465

</div>

466

<hr>

467

468

<a name="gdbus-property-org-freedesktop-UDisks2-Block.Id"></a><h3>The "Id" property</h3>

469

470

Id readable s

471

</pre>

472

<p> A unique and persistent identifier for the device or blank if

473

no such identifier is available.

474

</p>

475

<p> For devices with fixed media, this identifier is derived from

476

vital product data / UUIDs / serial numbers of the drive or

477

construct (e.g. LVM or MD-RAID) the block device is part

478

of. For devices with removable media, this identifier is

479

derived from the medium currently inserted.

480

</p>

481

<p> This identifier is guaranteed to not include the slash

482

character '/' (U+002F SOLIDUS) which means it can be used as

483

a filename.

484

</p>

485

<p> Examples:

486

<span class="quote">“<span class="quote">by-id-ata-INTEL_SSDSA2MH080G1GC_CVEM842101HD080DGN</span>”</span>,

487

<span class="quote">“<span class="quote">by-id-ata-ST1000LM024_HN-M101MBB_S2TBJA0C230233-part3</span>”</span>,

488

<span class="quote">“<span class="quote">by-id-usb-Kingston_DataTraveler_2.0_0013729940C4F9A166250D3E-0:0</span>”</span>,

489

<span class="quote">“<span class="quote">by-id-dm-name-luks-6d81fe85-26b1-4f8b-b834-405454c1cd46</span>”</span>,

490

<span class="quote">“<span class="quote">by-id-dm-name-vg_thinkpad-lv_swap</span>”</span>,

491

<span class="quote">“<span class="quote">by-label-HARRY_POTTER_SORCERERS_STONE-</span>”</span>,

492

<span class="quote">“<span class="quote">by-uuid-D22D-08B8</span>”</span>.

493

</p>

494

<p class="since">Since 2.1</p>

495

</div>

496

<hr>

497

498

<a name="gdbus-property-org-freedesktop-UDisks2-Block.Size"></a><h3>The "Size" property</h3>

499

500

Size readable t

501

</pre>

502

<p>The size of the block device.</p>

503

</div>

504

<hr>

505

506

<a name="gdbus-property-org-freedesktop-UDisks2-Block.ReadOnly"></a><h3>The "ReadOnly" property</h3>

507

508

ReadOnly readable b

509

</pre>

510

<p>If <code class="constant">TRUE</code>, the device can not be written to, only read from.</p>

511

</div>

512

<hr>

513

514

<a name="gdbus-property-org-freedesktop-UDisks2-Block.Drive"></a><h3>The "Drive" property</h3>

515

516

Drive readable o

517

</pre>

518

<p> The <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-interface-org-freedesktop-UDisks2-Drive.top_of_page">org.freedesktop.UDisks2.Drive</a> object that the block device

519

belongs to, or '/' if no such object exists.

520

</p>

521

</div>

522

<hr>

523

524

<a name="gdbus-property-org-freedesktop-UDisks2-Block.MDRaid"></a><h3>The "MDRaid" property</h3>

525

526

MDRaid readable o

527

</pre>

528

<p> If the block device is a running MD-RAID array, this is set

529

to the <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-interface-org-freedesktop-UDisks2-MDRaid.top_of_page">org.freedesktop.UDisks2.MDRaid</a> object that it

530

correspond to. Is '/' if no such object exists.

531

</p>

532

<p class="since">Since 2.1</p>

533

</div>

534

<hr>

535

536

<a name="gdbus-property-org-freedesktop-UDisks2-Block.MDRaidMember"></a><h3>The "MDRaidMember" property</h3>

537

538

MDRaidMember readable o

539

</pre>

540

<p> If the block device is a member of a MD-RAID array, this

541

is set to the <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-interface-org-freedesktop-UDisks2-MDRaid.top_of_page">org.freedesktop.UDisks2.MDRaid</a> object that it

542

correspond to. Is '/' if no such object exists.

543

</p>

544

<p class="since">Since 2.1</p>

545

</div>

546

<hr>

547

548

<a name="gdbus-property-org-freedesktop-UDisks2-Block.IdUsage"></a><h3>The "IdUsage" property</h3>

549

550

IdUsage readable s

551

</pre>

552

<p> A result of probing for signatures on the block device. Known values include:

553

</p>

554

555

556

557

<col>

558

</colgroup>

559

<tbody>

560

<tr>

561

<td><p><span class="term">filesystem</span></p></td>

562

<td><p>Used for mountable filesystems</p></td>

563

</tr>

564

<tr>

565

<td><p><span class="term">crypto</span></p></td>

566

<td><p>Used for e.g. LUKS devices</p></td>

567

</tr>

568

<tr>

569

570

<td><p>Used for e.g. RAID members and LVM PVs</p></td>

571

</tr>

572

<tr>

573

<td><p><span class="term">other</span></p></td>

574

<td><p>Something else was detected.</p></td>

575

</tr>

576

</tbody>

577

</table></div>

578

<p>

579

If blank, no known signature was detected. This doesn't

580

necessarily mean the device contains no structured data; it

581

only means that no signature known to the probing code was

582

detected.

583

</p>

584

<p> Applications should not rely on the value in this or the

585

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.IdType" title='The "IdType" property'>"IdType"</a> property - instead,

586

applications should check for whether the object in question

587

implements interfaces such as

588

e.g. <a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.html#gdbus-interface-org-freedesktop-UDisks2-Filesystem.top_of_page">org.freedesktop.UDisks2.Filesystem</a>,

589

<a class="link" href="gdbus-org.freedesktop.UDisks2.Swapspace.html#gdbus-interface-org-freedesktop-UDisks2-Swapspace.top_of_page">org.freedesktop.UDisks2.Swapspace</a> or

590

<a class="link" href="gdbus-org.freedesktop.UDisks2.Encrypted.html#gdbus-interface-org-freedesktop-UDisks2-Encrypted.top_of_page">org.freedesktop.UDisks2.Encrypted</a>.

591

</p>

592

</div>

593

<hr>

594

595

<a name="gdbus-property-org-freedesktop-UDisks2-Block.IdType"></a><h3>The "IdType" property</h3>

596

597

IdType readable s

598

</pre>

599

<p> This property contains more information about the result of

600

probing the block device. Its value depends of the value the

601

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.IdUsage" title='The "IdUsage" property'>"IdUsage"</a> property:

602

</p>

603

604

605

606

<col>

607

</colgroup>

608

<tbody>

609

<tr>

610

<td><p><span class="term">filesystem</span></p></td>

611

<td><p>The mountable file system that was detected (e.g. <code class="literal">vfat</code>).</p></td>

612

</tr>

613

<tr>

614

<td><p><span class="term">crypto</span></p></td>

615

<td><p>Encrypted data. Known values include <code class="literal">crypto_LUKS</code>.</p></td>

616

</tr>

617

<tr>

618

619

<td><p><a class="ulink" href="http://en.wikipedia.org/wiki/RAID" target="_top">RAID</a> or similar. Known values include <code class="literal">LVM2_member</code> (for LVM2 components), <code class="literal">linux_raid_member</code> (for MD-RAID components.)</p></td>

620

</tr>

621

<tr>

622

<td><p><span class="term">other</span></p></td>

623

<td><p>Something else. Known values include <code class="literal">swap</code> (for swap space), <code class="literal">suspend</code> (data used when resuming from suspend-to-disk.</p></td>

624

</tr>

625

</tbody>

626

</table></div>

627

<p>

628

See the note for the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.IdUsage" title='The "IdUsage" property'>"IdUsage"</a> property about usage.

629

</p>

630

</div>

631

<hr>

632

633

<a name="gdbus-property-org-freedesktop-UDisks2-Block.IdVersion"></a><h3>The "IdVersion" property</h3>

634

635

IdVersion readable s

636

</pre>

637

<p> The version of the filesystem or other structured data on the block device.

638

Do not make any assumptions about the format.

639

</p>

640

<p> This property is blank if there is no version or the version is unknown.

641

</p>

642

</div>

643

<hr>

644

645

<a name="gdbus-property-org-freedesktop-UDisks2-Block.IdLabel"></a><h3>The "IdLabel" property</h3>

646

647

IdLabel readable s

648

</pre>

649

<p> The label of the filesystem or other structured data on the block device.

650

</p>

651

<p> This property is blank if there is no label or the label is unknown.

652

</p>

653

</div>

654

<hr>

655

656

<a name="gdbus-property-org-freedesktop-UDisks2-Block.IdUUID"></a><h3>The "IdUUID" property</h3>

657

658

IdUUID readable s

659

</pre>

660

<p> The <a class="ulink" href="http://en.wikipedia.org/wiki/UUID" target="_top">UUID</a> of the

661

filesystem or other structured data on the block device. Do not make

662

any assumptions about the UUID as its format depends on what kind of

663

data is on the device.

664

</p>

665

<p> This property is blank if there is no UUID or the UUID is unknown.

666

</p>

667

</div>

668

<hr>

669

670

<a name="gdbus-property-org-freedesktop-UDisks2-Block.Configuration"></a><h3>The "Configuration" property</h3>

671

672

Configuration readable a(sa{sv})

673

</pre>

674

<p> The configuration for the device.

675

</p>

676

<p> This is an array of pairs of (<em class="parameter"><code>type</code></em>, <em class="parameter"><code>details</code></em>) where <em class="parameter"><code>type</code></em> is

677

a string identifying the configuration source

678

(e.g. <code class="literal">fstab</code>) and <em class="parameter"><code>details</code></em> contains the

679

actual configuration data.

680

</p>

681

<p> Use the

682

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.AddConfigurationItem" title="The AddConfigurationItem() method">AddConfigurationItem()</a>,

683

684

and

685

686

methods to add, remove and update configuration items.

687

</p>

688

<p> Use

689

690

to get the secrets (e.g. passphrases) that may be part of the

691

configuration but isn't exported in this property for

692

security reasons.

693

</p>

694

<p> For entries of type <code class="literal">fstab</code>, it means that

695

the block device is referenced in the system-wide

696

<code class="filename">/etc/fstab</code> file. Known configuration

697

items for type <code class="literal">fstab</code> are

698

</p>

699

700

701

702

<col>

703

</colgroup>

704

<tbody>

705

<tr>

706

<td><p><span class="term">fsname (type <code class="literal">'ay'</code>)</span></p></td>

707

<td><p>The special device</p></td>

708

</tr>

709

<tr>

710

711

<td><p>The mount point</p></td>

712

</tr>

713

<tr>

714

715

<td><p>The filesystem type</p></td>

716

</tr>

717

<tr>

718

719

<td><p>Options</p></td>

720

</tr>

721

<tr>

722

723

<td><p>Dump frequency in days</p></td>

724

</tr>

725

<tr>

726

<td><p><span class="term">passno (type <code class="literal">'i'</code>)</span></p></td>

727

<td><p>Pass number of parallel fsck</p></td>

728

</tr>

729

</tbody>

730

</table></div>

731

<p>

732

</p>

733

<p> For entries of type <code class="literal">crypttab</code>, it means that

734

the block device is referenced in the system-wide

735

<code class="filename">/etc/crypttab</code> file. Known configuration

736

items for type <code class="literal">crypttab</code> are

737

</p>

738

739

740

741

<col>

742

</colgroup>

743

<tbody>

744

<tr>

745

746

<td><p>The name to set the device up as</p></td>

747

</tr>

748

<tr>

749

<td><p><span class="term">device (type <code class="literal">'ay'</code>)</span></p></td>

750

<td><p>The special device</p></td>

751

</tr>

752

<tr>

753

<td><p><span class="term">passphrase-path (type <code class="literal">'ay'</code>)</span></p></td>

754

<td><p>Either empty to specify that no password is set,

755

otherwise a path to a file containing the encryption password.

756

This may also point to a special device file in <code class="filename">/dev</code>

757

such as <code class="literal">/dev/random</code>.

758

</p></td>

759

</tr>

760

<tr>

761

<td><p><span class="term">passphrase-contents (type <code class="literal">'ay'</code>)</span></p></td>

762

<td><p>The contents of the file containing the encryption password, if applicable.

763

This is only available via the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.GetSecretConfiguration" title="The GetSecretConfiguration() method">GetSecretConfiguration()</a>

764

method.</p></td>

765

</tr>

766

<tr>

767

768

<td><p>Options</p></td>

769

</tr>

770

</tbody>

771

</table></div>

772

<p>

773

For security reasons, when creating a new

774

<code class="literal">crypttab</code> entry (via the

775

<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.AddConfigurationItem" title="The AddConfigurationItem() method">AddConfigurationItem()</a>

776

method), then the <code class="option">passphrase-path</code> must

777

reference an unexisting file in the

778

<code class="filename">/etc/luks-keys</code> directory.

779

</p>

780

</div>

781

<hr>

782

783

<a name="gdbus-property-org-freedesktop-UDisks2-Block.CryptoBackingDevice"></a><h3>The "CryptoBackingDevice" property</h3>

784

785

CryptoBackingDevice readable o

786

</pre>

787

<p> The <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</a> object that is

788

backing the device or <code class="literal">/</code> if unknown or if

789

the block device is not the cleartext device for an encrypted

790

device.

791

</p>

792

</div>

793

<hr>

794

795

<a name="gdbus-property-org-freedesktop-UDisks2-Block.HintPartitionable"></a><h3>The "HintPartitionable" property</h3>

796

797

HintPartitionable readable b

798

</pre>

799

<p> If <code class="constant">TRUE</code>, the device is normally expected to be

800

partitionable. Devices for which this is not the case include

801

floppy drives, optical drives and LVM logical volumes.

802

</p>

803

</div>

804

<hr>

805

806

<a name="gdbus-property-org-freedesktop-UDisks2-Block.HintSystem"></a><h3>The "HintSystem" property</h3>

807

808

HintSystem readable b

809

</pre>

810

<p>If <code class="constant">TRUE</code>, the device is considered a <span class="emphasis"><em>system device</em></span>.</p>

811

<p> System devices are devices that require additional permissions to access.

812

</p>

813

<p> See <a class="xref" href="udisks.8.html" title="udisks"><span class="refentrytitle">udisks</span>(8)</a> for how to influence the value of this property.

814

</p>

815

</div>

816

<hr>

817

818

<a name="gdbus-property-org-freedesktop-UDisks2-Block.HintIgnore"></a><h3>The "HintIgnore" property</h3>

819

820

HintIgnore readable b

821

</pre>

822

<p>If <code class="constant">TRUE</code>, the device should be hidden from users.</p>

823

<p> See <a class="xref" href="udisks.8.html" title="udisks"><span class="refentrytitle">udisks</span>(8)</a> for how to influence the value of this property.

824

</p>

825

</div>

826

<hr>

827

828

<a name="gdbus-property-org-freedesktop-UDisks2-Block.HintAuto"></a><h3>The "HintAuto" property</h3>

829

830

HintAuto readable b

831

</pre>

832

<p>If <code class="constant">TRUE</code>, the device should be automatically started (e.g. mounted, unlocked etc.).</p>

833

<p> See <a class="xref" href="udisks.8.html" title="udisks"><span class="refentrytitle">udisks</span>(8)</a> for how to influence the value of this property.

834

</p>

835

</div>

836

<hr>

837

838

<a name="gdbus-property-org-freedesktop-UDisks2-Block.HintName"></a><h3>The "HintName" property</h3>

839

840

HintName readable s

841

</pre>

842

<p>If not blank, the name to use when presenting the device.</p>

843

<p> See <a class="xref" href="udisks.8.html" title="udisks"><span class="refentrytitle">udisks</span>(8)</a> for how to influence the value of this property.

844

</p>

845

</div>

846

<hr>

847

848

<a name="gdbus-property-org-freedesktop-UDisks2-Block.HintIconName"></a><h3>The "HintIconName" property</h3>

849

850

HintIconName readable s

851

</pre>

852

<p>If not blank, the icon name to use when presenting the device.</p>

853

<p> The name must adhere to the

854

<a class="ulink" href="http://www.freedesktop.org/wiki/Specifications/icon-theme-spec" target="_top">freedesktop.org icon theme specification</a>.

855

</p>

856

<p> See <a class="xref" href="udisks.8.html" title="udisks"><span class="refentrytitle">udisks</span>(8)</a> for how to influence the value of this property.

857

</p>

858

</div>

859

<hr>

860

861

<a name="gdbus-property-org-freedesktop-UDisks2-Block.HintSymbolicIconName"></a><h3>The "HintSymbolicIconName" property</h3>

862

863

HintSymbolicIconName readable s

864

</pre>

865

<p> If not blank, the icon name to use when presenting the device using a symbolic icon.

866

</p>

867

<p> The name must adhere to the

868

<a class="ulink" href="http://www.freedesktop.org/wiki/Specifications/icon-theme-spec" target="_top">freedesktop.org icon theme specification</a>.

869

</p>

870

<p> See <a class="xref" href="udisks.8.html" title="udisks"><span class="refentrytitle">udisks</span>(8)</a> for how to influence the value of this property.

871

</p>

872

<p class="since">Since 2.1</p>

873

</div>

874

</div>

875

</div>

876

877

<hr>

878

Generated by GTK-Doc V1.20</div>

879

</body>

880

</html>

b'\\ No newline at end of file'