| 1 |
|
| 2 |
<!DOCTYPE node PUBLIC |
| 3 |
"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" |
| 4 |
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"> |
| 5 |
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd"> |
| 6 |
|
| 7 |
<!-- |
| 8 |
Copyright (C) 2011 David Zeuthen <[email protected]> |
| 9 |
|
| 10 |
This library is free software; you can redistribute it and/or |
| 11 |
modify it under the terms of the GNU Lesser General Public |
| 12 |
License as published by the Free Software Foundation; either |
| 13 |
version 2 of the License, or (at your option) any later version. |
| 14 |
|
| 15 |
This library is distributed in the hope that it will be useful, |
| 16 |
but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 17 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 18 |
Lesser General Public License for more details. |
| 19 |
|
| 20 |
You should have received a copy of the GNU Lesser General |
| 21 |
Public License along with this library; if not, write to the |
| 22 |
Free Software Foundation, Inc., 59 Temple Place, Suite 330, |
| 23 |
Boston, MA 02111-1307, USA. |
| 24 |
--> |
| 25 |
|
| 26 |
<!-- ********************************************************************** --> |
| 27 |
|
| 28 |
<!-- |
| 29 |
org.freedesktop.UDisks2.Manager: |
| 30 |
@short_description: Manager singleton |
| 31 |
|
| 32 |
Interface for top-level manager singleton object located at the |
| 33 |
object path <literal>/org/freedesktop/UDisks2/Manager</literal>. |
| 34 |
--> |
| 35 |
<interface name="org.freedesktop.UDisks2.Manager"> |
| 36 |
<!-- Version: The version of the daemon currently running --> |
| 37 |
<property name="Version" type="s" access="read"/> |
| 38 |
|
| 39 |
<!-- |
| 40 |
SupportedFilesystems: |
| 41 |
|
| 42 |
List of filesystems supported by UDisks2. For each such filesystem |
| 43 |
UDisks supports filesystem creation (<quote>mkfs</quote>) and |
| 44 |
changing labels. |
| 45 |
|
| 46 |
While UDisks2 can essentially mount any filesystem, only the listed |
| 47 |
types are fully supported for block operations. |
| 48 |
--> |
| 49 |
<property name="SupportedFilesystems" type="as" access="read"/> |
| 50 |
|
| 51 |
<!-- |
| 52 |
SupportedEncryptionTypes: |
| 53 |
@since: 2.8.3 |
| 54 |
|
| 55 |
List of supported block encryption types by UDisks2. |
| 56 |
--> |
| 57 |
<property name="SupportedEncryptionTypes" type="as" access="read"/> |
| 58 |
|
| 59 |
<!-- |
| 60 |
DefaultEncryptionType: |
| 61 |
@since: 2.8.3 |
| 62 |
|
| 63 |
The default block encryption type. |
| 64 |
--> |
| 65 |
<property name="DefaultEncryptionType" type="s" access="read"/> |
| 66 |
|
| 67 |
<!-- |
| 68 |
CanFormat: |
| 69 |
@type: The filesystem type to be tested for formatting availability. |
| 70 |
@available: Formatting availability and the required binary name if missing (i.e. no error and returns FALSE). |
| 71 |
@since: 2.7.2 |
| 72 |
|
| 73 |
Tests for availability to create the given filesystem. |
| 74 |
See the #org.freedesktop.UDisks2.Manager:SupportedFilesystems property |
| 75 |
for a list of known types. Unknown or unsupported filesystems result in an error. |
| 76 |
--> |
| 77 |
<method name="CanFormat"> |
| 78 |
<arg name="type" direction="in" type="s"/> |
| 79 |
<arg name="available" direction="out" type="(bs)"/> |
| 80 |
</method> |
| 81 |
|
| 82 |
<!-- |
| 83 |
CanResize: |
| 84 |
@type: The filesystem type to be tested for resize availability. |
| 85 |
@available: Resizing availability, flags for allowed resizing (i.e. growing/shrinking support for online/offline) and the required binary name if missing (i.e. no error and returns FALSE). |
| 86 |
@since: 2.7.2 |
| 87 |
|
| 88 |
Tests for availability to resize the given filesystem. |
| 89 |
The mode flags indicate if growing and/or shriking resize is available if mounted/unmounted. |
| 90 |
The mode corresponds to bitwise-OR combined BDFSResizeFlags of the libblockdev FS plugin: |
| 91 |
BD_FS_OFFLINE_SHRINK = 2, shrinking resize allowed when unmounted |
| 92 |
BD_FS_OFFLINE_GROW = 4, growing resize allowed when unmounted |
| 93 |
BD_FS_ONLINE_SHRINK = 8, shrinking resize allowed when mounted |
| 94 |
BD_FS_ONLINE_GROW = 16, growing resize allowed when mounted |
| 95 |
Unknown filesystems or filesystems which do not support resizing result in errors. |
| 96 |
--> |
| 97 |
<method name="CanResize"> |
| 98 |
<arg name="type" direction="in" type="s"/> |
| 99 |
<arg name="available" direction="out" type="(bts)"/> |
| 100 |
</method> |
| 101 |
|
| 102 |
<!-- |
| 103 |
CanCheck: |
| 104 |
@type: The filesystem type to be tested for consistency check availability. |
| 105 |
@available: Checking availability and the required binary name if missing (i.e. no error and returns FALSE). |
| 106 |
@since: 2.7.2 |
| 107 |
|
| 108 |
Tests for availability to check the given filesystem. |
| 109 |
Unsupported filesystems or filesystems which do not support checking result in errors. |
| 110 |
--> |
| 111 |
<method name="CanCheck"> |
| 112 |
<arg name="type" direction="in" type="s"/> |
| 113 |
<arg name="available" direction="out" type="(bs)"/> |
| 114 |
</method> |
| 115 |
|
| 116 |
<!-- |
| 117 |
CanRepair: |
| 118 |
@type: The filesystem type to be tested for repair availability. |
| 119 |
@available: Repair availability and the required binary name if missing (i.e. no error and returns FALSE). |
| 120 |
@since: 2.7.2 |
| 121 |
|
| 122 |
Tests for availability repair the given filesystem. |
| 123 |
Unsupported filesystems or filesystems which do not support repairing result in errors. |
| 124 |
--> |
| 125 |
<method name="CanRepair"> |
| 126 |
<arg name="type" direction="in" type="s"/> |
| 127 |
<arg name="available" direction="out" type="(bs)"/> |
| 128 |
</method> |
| 129 |
|
| 130 |
<!-- |
| 131 |
LoopSetup: |
| 132 |
@fd: An index for the file descriptor to use. |
| 133 |
@options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>offset</parameter> (of type 't'), <parameter>size</parameter> (of type 't'), <parameter>read-only</parameter> (of type 'b'), <parameter>no-part-scan</parameter> (of type 'b') and <parameter>sector-size</parameter> (of type 't'). |
| 134 |
@resulting_device: An object path to the object implementing the #org.freedesktop.UDisks2.Block interface. |
| 135 |
|
| 136 |
Creates a block device for the file represented by @fd. |
| 137 |
--> |
| 138 |
<method name="LoopSetup"> |
| 139 |
<annotation name="org.gtk.GDBus.C.UnixFD" value="1"/> |
| 140 |
<arg name="fd" direction="in" type="h"/> |
| 141 |
<arg name="options" direction="in" type="a{sv}"/> |
| 142 |
<arg name="resulting_device" direction="out" type="o"/> |
| 143 |
</method> |
| 144 |
|
| 145 |
<!-- |
| 146 |
MDRaidCreate: |
| 147 |
@blocks: An array of object paths to objects implementing the #org.freedesktop.UDisks2.Block interface. |
| 148 |
@level: The RAID level for the array. |
| 149 |
@name: The name for the array. |
| 150 |
@chunk: The chunk size (in bytes) or 0 if @level is <quote>raid1</quote>. |
| 151 |
@options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) include <parameter>bitmap</parameter> (of type 'ay') and <parameter>version</parameter> (of type 'ay'). |
| 152 |
@resulting_array: An object path to the object implementing the #org.freedesktop.UDisks2.MDRaid interface. |
| 153 |
@since: 2.0.0 |
| 154 |
|
| 155 |
Creates a new RAID array on the block devices specified by |
| 156 |
@blocks. Each element in this array must be an object path to |
| 157 |
an object implementing the #org.freedesktop.UDisks2.Block |
| 158 |
interface. |
| 159 |
|
| 160 |
Known and supported values for @level include |
| 161 |
<quote>raid0</quote>, <quote>raid1</quote>, |
| 162 |
<quote>raid4</quote>, <quote>raid5</quote>, |
| 163 |
<quote>raid6</quote> and <quote>raid10</quote>. |
| 164 |
|
| 165 |
Before the array is created, all devices in @blocks are |
| 166 |
erased. Once created (but before the method returns), the RAID |
| 167 |
array will be erased. |
| 168 |
|
| 169 |
The @bitmap option specifies the write-intent bitmap type, currently |
| 170 |
only 'none' and 'internal' values are supported. When this option |
| 171 |
is not present, it is up to <literal>mdadm</literal> to decide |
| 172 |
whether to create an internal bitmap (typically for arrays larger |
| 173 |
than 100 GB) or not. |
| 174 |
|
| 175 |
The @version option specifies the MD metadata version, for example |
| 176 |
'0.90'. If not specified the default medata version specified by |
| 177 |
<literal>mdadm</literal> is used. (since 2.11) |
| 178 |
--> |
| 179 |
<method name="MDRaidCreate"> |
| 180 |
<arg name="blocks" direction="in" type="ao"/> |
| 181 |
<arg name="level" direction="in" type="s"/> |
| 182 |
<arg name="name" direction="in" type="s"/> |
| 183 |
<arg name="chunk" direction="in" type="t"/> |
| 184 |
<arg name="options" direction="in" type="a{sv}"/> |
| 185 |
<arg name="resulting_array" direction="out" type="o"/> |
| 186 |
</method> |
| 187 |
|
| 188 |
<!-- |
| 189 |
EnableModules: |
| 190 |
@enable: A boolean value indicating whether modules should be enabled. Currently only the %TRUE value is permitted. |
| 191 |
|
| 192 |
Loads and activates modules. Modules that have been already loaded are not reinitialized on subsequent calls to this method and are skipped. |
| 193 |
In case any new module is getting activated by this method call a <literal>add</literal> uevent is triggered on all exported objects. |
| 194 |
|
| 195 |
This takes in account an optional explicit list of modules to load as specified in the <filename>/etc/udisks2/udisks2.conf</filename> |
| 196 |
config file. If unspecified all available modules will be loaded. |
| 197 |
|
| 198 |
Modules cannot be deactivated at the moment. This method call never fails even if no module has been activated |
| 199 |
and by nature it cannot report any particular module initialization failures. Clients have no way of finding that |
| 200 |
a particular module is available. |
| 201 |
|
| 202 |
<note> |
| 203 |
<emphasis>This method is deprecated since 2.9.0.</emphasis> |
| 204 |
Use org.freedesktop.UDisks2.Manager.EnableModule() instead. |
| 205 |
</note> |
| 206 |
--> |
| 207 |
<method name="EnableModules"> |
| 208 |
<annotation name="org.freedesktop.DBus.Deprecated" value="true"/> |
| 209 |
<arg name="enable" direction="in" type="b"/> |
| 210 |
</method> |
| 211 |
|
| 212 |
<!-- |
| 213 |
EnableModule: |
| 214 |
@name: Name of the module. |
| 215 |
@enable: A boolean value indicating whether modules should be enabled. Currently only the %TRUE value is permitted. |
| 216 |
@since: 2.9.0 |
| 217 |
|
| 218 |
Loads and activates single module identified by @name. In case the module is already active no reinitialization |
| 219 |
is done and this call has no effect. Clients are supposed to call this method before using any of the particular module API. |
| 220 |
In case no such module is available or its initialization fails a proper error is returned. This action also causes |
| 221 |
all objects to receive <literal>add</literal> uevent that allows the module to attach extra interfaces before |
| 222 |
this method call returns. |
| 223 |
|
| 224 |
Modules cannot be deactivated at the moment. |
| 225 |
--> |
| 226 |
<method name="EnableModule"> |
| 227 |
<arg name="name" direction="in" type="s"/> |
| 228 |
<arg name="enable" direction="in" type="b"/> |
| 229 |
</method> |
| 230 |
|
| 231 |
<!-- |
| 232 |
GetBlockDevices: |
| 233 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 234 |
@since: 2.7.2 |
| 235 |
|
| 236 |
Get list of all block devices (object paths of objects implementing the #org.freedesktop.UDisks2.Block interface) known to UDisks. |
| 237 |
|
| 238 |
--> |
| 239 |
<method name="GetBlockDevices"> |
| 240 |
<arg name="options" direction="in" type="a{sv}"/> |
| 241 |
<arg name="block_objects" direction="out" type="ao"/> |
| 242 |
</method> |
| 243 |
|
| 244 |
<!-- |
| 245 |
GetDrives: |
| 246 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 247 |
@since: 2.11 |
| 248 |
|
| 249 |
Get list of all drives (object paths of objects implementing the #org.freedesktop.UDisks2.Drive interface) known to UDisks. |
| 250 |
|
| 251 |
--> |
| 252 |
<method name="GetDrives"> |
| 253 |
<arg name="options" direction="in" type="a{sv}"/> |
| 254 |
<arg name="drive_objects" direction="out" type="ao"/> |
| 255 |
</method> |
| 256 |
|
| 257 |
<!-- |
| 258 |
ResolveDevice: |
| 259 |
@devspec: Dictionary with specification of a device. |
| 260 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 261 |
@devices: List of object paths of all devices matching @devspec. |
| 262 |
@since: 2.7.3 |
| 263 |
|
| 264 |
Get device(s) matching specification given in @devspec. |
| 265 |
|
| 266 |
Currently supported keys for @devspec include: |
| 267 |
<variablelist> |
| 268 |
<varlistentry> |
| 269 |
<term>path (type <literal>'s'</literal>)</term> |
| 270 |
<listitem><para> |
| 271 |
Device path (e.g. <quote>/dev/sda</quote>). This also includes symlinks in <quote>/dev</quote> |
| 272 |
(both #org.freedesktop.UDisks2.Block:Device and #org.freedesktop.UDisks2.Block:Symlinks are used). |
| 273 |
</para></listitem> |
| 274 |
</varlistentry> |
| 275 |
<varlistentry> |
| 276 |
<term>label (type <literal>'s'</literal>)</term> |
| 277 |
<listitem><para> |
| 278 |
Filesystem label. #org.freedesktop.UDisks2.Block:IdLabel is used. |
| 279 |
</para></listitem> |
| 280 |
</varlistentry> |
| 281 |
<varlistentry> |
| 282 |
<term>uuid (type <literal>'s'</literal>)</term> |
| 283 |
<listitem><para> |
| 284 |
Filesystem UUID. #org.freedesktop.UDisks2.Block:IdUUID is used. |
| 285 |
</para></listitem> |
| 286 |
</varlistentry> |
| 287 |
<varlistentry> |
| 288 |
<term>partuuid (type <literal>'s'</literal>)</term> |
| 289 |
<listitem><para> |
| 290 |
Partition UUID. #org.freedesktop.UDisks2.Partition:UUID is used. |
| 291 |
</para></listitem> |
| 292 |
</varlistentry> |
| 293 |
<varlistentry> |
| 294 |
<term>partlabel (type <literal>'s'</literal>)</term> |
| 295 |
<listitem><para> |
| 296 |
Partition Name. #org.freedesktop.UDisks2.Partition:Name is used. |
| 297 |
</para></listitem> |
| 298 |
</varlistentry> |
| 299 |
</variablelist> |
| 300 |
|
| 301 |
It is possible to specify multiple keys. In this case, only devices matching all values will be returned. |
| 302 |
|
| 303 |
--> |
| 304 |
<method name="ResolveDevice"> |
| 305 |
<arg name="devspec" direction="in" type="a{sv}"/> |
| 306 |
<arg name="options" direction="in" type="a{sv}"/> |
| 307 |
<arg name="devices" direction="out" type="ao"/> |
| 308 |
</method> |
| 309 |
</interface> |
| 310 |
|
| 311 |
<!-- |
| 312 |
org.freedesktop.UDisks2.Manager.NVMe: |
| 313 |
@short_description: NVMe host management |
| 314 |
|
| 315 |
Extension of the top-level manager singleton object exposing |
| 316 |
NVMe host management. |
| 317 |
--> |
| 318 |
<interface name="org.freedesktop.UDisks2.Manager.NVMe"> |
| 319 |
<!-- HostNQN: |
| 320 |
@since: 2.10.0 |
| 321 |
|
| 322 |
The Host NQN configured for the system. Reflects contents of the <filename>/etc/nvme/hostnqn</filename> |
| 323 |
file if present or uses autogenerated NQN value otherwise. |
| 324 |
--> |
| 325 |
<property name="HostNQN" type="ay" access="read"/> |
| 326 |
|
| 327 |
<!-- HostID: |
| 328 |
@since: 2.10.0 |
| 329 |
|
| 330 |
The Host ID configured for the system. Reflects contents of the <filename>/etc/nvme/hostid</filename> |
| 331 |
file if present. |
| 332 |
--> |
| 333 |
<property name="HostID" type="ay" access="read"/> |
| 334 |
|
| 335 |
<!-- |
| 336 |
SetHostNQN: |
| 337 |
@hostnqn: The Host NQN value to set. |
| 338 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 339 |
@since: 2.10.0 |
| 340 |
|
| 341 |
Sets the system-wide Host NQN string, |
| 342 |
--> |
| 343 |
<method name="SetHostNQN"> |
| 344 |
<arg name="hostnqn" direction="in" type="ay"/> |
| 345 |
<arg name="options" direction="in" type="a{sv}"/> |
| 346 |
</method> |
| 347 |
|
| 348 |
<!-- |
| 349 |
SetHostID: |
| 350 |
@hostid: The Host ID value to set. |
| 351 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 352 |
@since: 2.10.0 |
| 353 |
|
| 354 |
Sets the system-wide Host ID string, |
| 355 |
--> |
| 356 |
<method name="SetHostID"> |
| 357 |
<arg name="hostid" direction="in" type="ay"/> |
| 358 |
<arg name="options" direction="in" type="a{sv}"/> |
| 359 |
</method> |
| 360 |
|
| 361 |
<!-- |
| 362 |
Connect: |
| 363 |
@subsysnqn: The name for the NVMe subsystem to connect to. |
| 364 |
@transport: The network fabric used for a NVMe-over-Fabrics network. |
| 365 |
@transport_addr: The network address of the Controller. For transports using IP addressing (e.g. <literal>rdma</literal>) this should be an IP-based address. |
| 366 |
@options: Additional options, includes <link linkend="udisks-std-options">standard options</link>. |
| 367 |
@nvme_ctrl: An object path to the connected NVMeoF controller. |
| 368 |
@since: 2.10.0 |
| 369 |
|
| 370 |
Create a transport connection to a remote system and create a NVMe over Fabrics controller |
| 371 |
for the NVMe subsystem specified by the @subsysnqn option. |
| 372 |
|
| 373 |
Valid values for @transport are <literal>rdma</literal>, <literal>fc</literal>, |
| 374 |
<literal>tcp</literal> and <literal>loop</literal>. |
| 375 |
|
| 376 |
By default, additional options are read from the system configuration file <filename>/etc/nvme/config.json</filename>. |
| 377 |
This follows the default behaviour of <literal>nvme-cli</literal>. Use the <literal>config</literal> |
| 378 |
option to either specify a different config file or disable use of it altogether. The naming |
| 379 |
of the additional options are generally kept consistent with the JSON config file schema and |
| 380 |
any option specified acts as an override. Available options are: |
| 381 |
<variablelist> |
| 382 |
<varlistentry><term>transport_svcid (type 's')</term> |
| 383 |
<listitem><para>The transport service id. For transports using IP addressing (e.g. <literal>rdma</literal>) this field is the port number. By default, the IP port number for the RDMA transport is <literal>4420</literal>.</para></listitem></varlistentry> |
| 384 |
<varlistentry><term>host_traddr (type 's')</term> |
| 385 |
<listitem><para>The network address used on the host to connect to the Controller. For TCP, this sets the source address on the socket.</para></listitem></varlistentry> |
| 386 |
<varlistentry><term>host_iface (type 's')</term> |
| 387 |
<listitem><para>The network interface used on the host to connect to the Controller (e.g. IP <literal>eth1</literal>, <literal>enp2s0</literal>). This forces the connection to be made on a specific interface instead of letting the system decide.</para></listitem></varlistentry> |
| 388 |
<varlistentry><term>host_nqn (type 'ay')</term> |
| 389 |
<listitem><para>Overrides the default Host NQN that identifies the NVMe Host.</para></listitem></varlistentry> |
| 390 |
<varlistentry><term>host_id (type 'ay')</term> |
| 391 |
<listitem><para>Overrides the default Host UUID.</para></listitem></varlistentry> |
| 392 |
<varlistentry><term>config (type 'ay')</term> |
| 393 |
<listitem><para>Use the specified JSON configuration file instead of the default file (see above) or specify <literal>"none"</literal> to avoid reading any configuration file.</para></listitem></varlistentry> |
| 394 |
<varlistentry><term>dhchap_key (type 'ay')</term> |
| 395 |
<listitem><para>NVMe in-band authentication secret in ASCII format as described in the NVMe 2.0 specification. When not specified, the secret is by default read from <filename>/etc/nvme/hostkey</filename>. In case that file does not exist no in-band authentication is attempted.</para></listitem></varlistentry> |
| 396 |
<varlistentry><term>dhchap_ctrl_key (type 'ay')</term> |
| 397 |
<listitem><para>NVMe in-band authentication controller secret for bi-directional authentication. When not specified, no bi-directional authentication is attempted.</para></listitem></varlistentry> |
| 398 |
<varlistentry><term>nr_io_queues (type 'i')</term> |
| 399 |
<listitem><para>The number of I/O queues.</para></listitem></varlistentry> |
| 400 |
<varlistentry><term>nr_write_queues (type 'i')</term> |
| 401 |
<listitem><para>Number of additional queues that will be used for write I/O.</para></listitem></varlistentry> |
| 402 |
<varlistentry><term>nr_poll_queues (type 'i')</term> |
| 403 |
<listitem><para>Number of additional queues that will be used for polling latency sensitive I/O.</para></listitem></varlistentry> |
| 404 |
<varlistentry><term>queue_size (type 'i')</term> |
| 405 |
<listitem><para>Number of elements in the I/O queues.</para></listitem></varlistentry> |
| 406 |
<varlistentry><term>keep_alive_tmo (type 'i')</term> |
| 407 |
<listitem><para>The keep alive timeout (in seconds).</para></listitem></varlistentry> |
| 408 |
<varlistentry><term>reconnect_delay (type 'i')</term> |
| 409 |
<listitem><para>The delay (in seconds) before reconnect is attempted after a connect loss.</para></listitem></varlistentry> |
| 410 |
<varlistentry><term>ctrl_loss_tmo (type 'i')</term> |
| 411 |
<listitem><para>The controller loss timeout period (in seconds). A special value of <literal>-1</literal> will cause reconnecting forever.</para></listitem></varlistentry> |
| 412 |
<varlistentry><term>fast_io_fail_tmo (type 'i')</term> |
| 413 |
<listitem><para>Fast I/O Fail timeout (in seconds).</para></listitem></varlistentry> |
| 414 |
<varlistentry><term>tos (type 's')</term> |
| 415 |
<listitem><para>Type of service.</para></listitem></varlistentry> |
| 416 |
<varlistentry><term>duplicate_connect (type 'b')</term> |
| 417 |
<listitem><para>Allow duplicated connections between same transport host and subsystem port.</para></listitem></varlistentry> |
| 418 |
<varlistentry><term>disable_sqflow (type 'b')</term> |
| 419 |
<listitem><para>Disables SQ flow control to omit head doorbell update for submission queues when sending nvme completions.</para></listitem></varlistentry> |
| 420 |
<varlistentry><term>hdr_digest (type 'b')</term> |
| 421 |
<listitem><para>Generates/verifies header digest (TCP).</para></listitem></varlistentry> |
| 422 |
<varlistentry><term>data_digest (type 'b')</term> |
| 423 |
<listitem><para>Generates/verifies data digest (TCP).</para></listitem></varlistentry> |
| 424 |
<varlistentry><term>tls (type 'b')</term> |
| 425 |
<listitem><para>Enable TLS encryption (TCP).</para></listitem></varlistentry> |
| 426 |
<varlistentry><term>hostsymname (type 'ay')</term> |
| 427 |
<listitem><para>TP8010: NVMe host symbolic name.</para></listitem></varlistentry> |
| 428 |
<varlistentry><term>keyring (type 'ay')</term> |
| 429 |
<listitem><para>Keyring to store and lookup keys.</para></listitem></varlistentry> |
| 430 |
<varlistentry><term>tls_key (type 'ay')</term> |
| 431 |
<listitem><para>TLS PSK for the connection.</para></listitem></varlistentry> |
| 432 |
</variablelist> |
| 433 |
--> |
| 434 |
<method name="Connect"> |
| 435 |
<arg name="subsysnqn" direction="in" type="ay"/> |
| 436 |
<arg name="transport" direction="in" type="s"/> |
| 437 |
<arg name="transport_addr" direction="in" type="s"/> |
| 438 |
<arg name="options" direction="in" type="a{sv}"/> |
| 439 |
<arg name="nvme_ctrl" direction="out" type="o"/> |
| 440 |
</method> |
| 441 |
</interface> |
| 442 |
|
| 443 |
<!-- |
| 444 |
org.freedesktop.UDisks2.Drive: |
| 445 |
@short_description: Disk drives |
| 446 |
|
| 447 |
This interface is used to represent both hard disks and disk |
| 448 |
drives (with or without removable media). |
| 449 |
|
| 450 |
This interface should not to be confused with the |
| 451 |
#org.freedesktop.UDisks2.Block interface that is used for |
| 452 |
low-level block devices the OS knows about. For example, if |
| 453 |
<filename>/dev/sda</filename> and <filename>/dev/sdb</filename> |
| 454 |
are block devices for two paths to the same drive, there will be |
| 455 |
only one #org.freedesktop.UDisks2.Drive object but two |
| 456 |
#org.freedesktop.UDisks2.Block objects. |
| 457 |
--> |
| 458 |
<interface name="org.freedesktop.UDisks2.Drive"> |
| 459 |
<!-- Vendor: A name for the vendor of the drive or blank if unknown. --> |
| 460 |
<property name="Vendor" type="s" access="read"/> |
| 461 |
<!-- Model: A name for the model of the drive or blank if unknown. --> |
| 462 |
<property name="Model" type="s" access="read"/> |
| 463 |
<!-- Revision: Firmware Revision or blank if unknown. --> |
| 464 |
<property name="Revision" type="s" access="read"/> |
| 465 |
<!-- Serial: Serial number of the drive or blank if unknown. --> |
| 466 |
<property name="Serial" type="s" access="read"/> |
| 467 |
<!-- WWN: |
| 468 |
|
| 469 |
The <ulink |
| 470 |
url="http://en.wikipedia.org/wiki/World_Wide_Name">World Wide |
| 471 |
Name</ulink> of the drive or blank if unknown. |
| 472 |
|
| 473 |
In case of NVMe drives please refer to namespace-level WWN properties. |
| 474 |
--> |
| 475 |
<property name="WWN" type="s" access="read"/> |
| 476 |
|
| 477 |
<!-- Id: |
| 478 |
A unique and persistent identifier for the device or blank if |
| 479 |
no such identifier is available. |
| 480 |
|
| 481 |
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 |
|
| 485 |
Examples: |
| 486 |
<quote>ST32000542AS-6XW00W51</quote>, |
| 487 |
<quote>HITACHI-HTS723232A7A364-E3834563KRG2HN</quote>, |
| 488 |
<quote>INTEL-SSDSA2MH080G1GC-CVEM842101HD080DGN</quote>. |
| 489 |
--> |
| 490 |
<property name="Id" type="s" access="read"/> |
| 491 |
|
| 492 |
<!-- Configuration: |
| 493 |
A set of configuration directives that are applied to the |
| 494 |
drive when it is connected (e.g. at start-up, hotplug or |
| 495 |
resume). |
| 496 |
|
| 497 |
This is an dict of items with the following known keys: |
| 498 |
<variablelist> |
| 499 |
<varlistentry> |
| 500 |
<term>ata-pm-standby (type <literal>'i'</literal>)</term> |
| 501 |
<listitem><para> |
| 502 |
The spindown timeout for ATA drives (See ATA command <quote>STANDBY</quote>). |
| 503 |
</para></listitem> |
| 504 |
</varlistentry> |
| 505 |
<varlistentry> |
| 506 |
<term>ata-apm-level (type <literal>'i'</literal>)</term> |
| 507 |
<listitem><para> |
| 508 |
The APM level for ATA drives (See ATA command <quote>SET FEATURES</quote>, sub-commands 0x05 and 0x85). |
| 509 |
</para></listitem> |
| 510 |
</varlistentry> |
| 511 |
<varlistentry> |
| 512 |
<term>ata-aam-level (type <literal>'i'</literal>)</term> |
| 513 |
<listitem><para> |
| 514 |
The AAM level for ATA drives (See ATA command <quote>SET FEATURES</quote>, sub-commands 0x42 and 0xc2). |
| 515 |
</para></listitem> |
| 516 |
</varlistentry> |
| 517 |
<varlistentry> |
| 518 |
<term>ata-write-cache-enabled (type <literal>'b'</literal>)</term> |
| 519 |
<listitem><para> |
| 520 |
Whether the write-cache is enabled (See ATA command <quote>SET FEATURES</quote>, sub-commands 0x82 and 0x02). Since 2.1. |
| 521 |
</para></listitem> |
| 522 |
</varlistentry> |
| 523 |
<varlistentry> |
| 524 |
<term>ata-read-lookahead-enabled (type <literal>'b'</literal>)</term> |
| 525 |
<listitem><para> |
| 526 |
Whether the read look-ahead is enabled (See ATA command <quote>SET FEATURES</quote>, sub-commands 0x55 and 0xaa). Since 2.1.7. |
| 527 |
</para></listitem> |
| 528 |
</varlistentry> |
| 529 |
</variablelist> |
| 530 |
The contents of this property is read from the configuration |
| 531 |
file <filename>/etc/udisks2/IDENTIFIER.conf</filename> |
| 532 |
where <emphasis>IDENTIFIER</emphasis> is the value of the |
| 533 |
#org.freedesktop.UDisks2.Drive:Id property. See <xref |
| 534 |
linkend="udisks.8"/> for the file format of this file. |
| 535 |
|
| 536 |
Use the org.freedesktop.UDisks2.Drive.SetConfiguration() |
| 537 |
method to change the value of this property. |
| 538 |
--> |
| 539 |
<property name="Configuration" type="a{sv}" access="read"/> |
| 540 |
|
| 541 |
<!-- Media: The kind of media currently in the drive or blank if unknown. |
| 542 |
See the #org.freedesktop.UDisks2.Drive:MediaCompatibility property for known values. |
| 543 |
--> |
| 544 |
<property name="Media" type="s" access="read"/> |
| 545 |
|
| 546 |
<!-- MediaCompatibility: |
| 547 |
The physical kind of media the drive uses or the type of the drive or blank if unknown. |
| 548 |
Known values include |
| 549 |
<variablelist> |
| 550 |
<varlistentry><term>thumb</term><listitem><para>The device is a thumb-drive with non-removable media (e.g. a USB stick)</para></listitem></varlistentry> |
| 551 |
<varlistentry><term>flash</term><listitem><para>Flash Card</para></listitem></varlistentry> |
| 552 |
<varlistentry><term>flash_cf</term><listitem><para>CompactFlash</para></listitem></varlistentry> |
| 553 |
<varlistentry><term>flash_ms</term><listitem><para>MemoryStick</para></listitem></varlistentry> |
| 554 |
<varlistentry><term>flash_sm</term><listitem><para>SmartMedia</para></listitem></varlistentry> |
| 555 |
<varlistentry><term>flash_sd</term><listitem><para>Secure Digital</para></listitem></varlistentry> |
| 556 |
<varlistentry><term>flash_sdhc</term><listitem><para>Secure Digital High Capacity</para></listitem></varlistentry> |
| 557 |
<varlistentry><term>flash_sdxc</term><listitem><para>Secure Digital eXtended Capacity</para></listitem></varlistentry> |
| 558 |
<varlistentry><term>flash_sdio</term><listitem><para>Secure Digital Input Output</para></listitem></varlistentry> |
| 559 |
<varlistentry><term>flash_sd_combo</term><listitem><para>Secure Digital Input Output combo card with storage and I/O functionality</para></listitem></varlistentry> |
| 560 |
<varlistentry><term>flash_mmc</term><listitem><para>MultiMediaCard</para></listitem></varlistentry> |
| 561 |
<varlistentry><term>floppy</term><listitem><para>Floppy Disk</para></listitem></varlistentry> |
| 562 |
<varlistentry><term>floppy_zip</term><listitem><para>Zip Disk</para></listitem></varlistentry> |
| 563 |
<varlistentry><term>floppy_jaz</term><listitem><para>Jaz Disk</para></listitem></varlistentry> |
| 564 |
<varlistentry><term>optical</term><listitem><para>Optical Disc</para></listitem></varlistentry> |
| 565 |
<varlistentry><term>optical_cd</term><listitem><para>Compact Disc</para></listitem></varlistentry> |
| 566 |
<varlistentry><term>optical_cd_r</term><listitem><para>Compact Disc Recordable</para></listitem></varlistentry> |
| 567 |
<varlistentry><term>optical_cd_rw</term><listitem><para>Compact Disc Rewritable</para></listitem></varlistentry> |
| 568 |
<varlistentry><term>optical_dvd</term><listitem><para>Digital Versatile Disc</para></listitem></varlistentry> |
| 569 |
<varlistentry><term>optical_dvd_r</term><listitem><para>DVD-R</para></listitem></varlistentry> |
| 570 |
<varlistentry><term>optical_dvd_rw</term><listitem><para>DVD-RW</para></listitem></varlistentry> |
| 571 |
<varlistentry><term>optical_dvd_ram</term><listitem><para>DVD-RAM</para></listitem></varlistentry> |
| 572 |
<varlistentry><term>optical_dvd_plus_r</term><listitem><para>DVD+R</para></listitem></varlistentry> |
| 573 |
<varlistentry><term>optical_dvd_plus_rw</term><listitem><para>DVD+RW</para></listitem></varlistentry> |
| 574 |
<varlistentry><term>optical_dvd_plus_r_dl</term><listitem><para>DVD+R Dual Layer</para></listitem></varlistentry> |
| 575 |
<varlistentry><term>optical_dvd_plus_rw_dl</term><listitem><para>DVD+RW Dual Layer</para></listitem></varlistentry> |
| 576 |
<varlistentry><term>optical_bd</term><listitem><para>Blu-ray Disc</para></listitem></varlistentry> |
| 577 |
<varlistentry><term>optical_bd_r</term><listitem><para>Blu-ray Recordable</para></listitem></varlistentry> |
| 578 |
<varlistentry><term>optical_bd_re</term><listitem><para>Blu-ray Rewritable</para></listitem></varlistentry> |
| 579 |
<varlistentry><term>optical_hddvd</term><listitem><para>HD-DVD</para></listitem></varlistentry> |
| 580 |
<varlistentry><term>optical_hddvd_r</term><listitem><para>HD-DVD Recordable</para></listitem></varlistentry> |
| 581 |
<varlistentry><term>optical_hddvd_rw</term><listitem><para>HD-DVD Rewritable</para></listitem></varlistentry> |
| 582 |
<varlistentry><term>optical_mo</term><listitem><para>Magneto Optical</para></listitem></varlistentry> |
| 583 |
<varlistentry><term>optical_mrw</term><listitem><para>Can read Mount Rainer media</para></listitem></varlistentry> |
| 584 |
<varlistentry><term>optical_mrw_w</term><listitem><para>Can write Mount Rainer media</para></listitem></varlistentry> |
| 585 |
</variablelist> |
| 586 |
--> |
| 587 |
<property name="MediaCompatibility" type="as" access="read"/> |
| 588 |
|
| 589 |
<!-- MediaRemovable: |
| 590 |
Whether the media can be removed from the drive. |
| 591 |
|
| 592 |
Note that this may be overridden from what the hardware |
| 593 |
reports - for example, USB thumb drives often report that |
| 594 |
they are using removable media while in fact the media |
| 595 |
is not removable. |
| 596 |
--> |
| 597 |
<property name="MediaRemovable" type="b" access="read"/> |
| 598 |
|
| 599 |
<!-- MediaAvailable: Set to %FALSE if no medium is available. |
| 600 |
This is always %TRUE if #org.freedesktop.UDisks2.Drive:MediaChangeDetected is %FALSE. |
| 601 |
--> |
| 602 |
<property name="MediaAvailable" type="b" access="read"/> |
| 603 |
|
| 604 |
<!-- MediaChangeDetected: Set to %TRUE only if media changes are detected. |
| 605 |
Media changes are detected on all modern disk drives through |
| 606 |
either polling or an asynchronous notification mechanism. The |
| 607 |
only known disk drives that cannot report media changes are |
| 608 |
PC floppy drives. |
| 609 |
--> |
| 610 |
<property name="MediaChangeDetected" type="b" access="read"/> |
| 611 |
|
| 612 |
<!-- Size: The size of the drive (or the media currently in the drive). |
| 613 |
In case of NVMe this value indicates the total NVM capacity that is accessible by the NVMe controller. |
| 614 |
This is always 0 if #org.freedesktop.UDisks2.Drive:MediaChangeDetected is %FALSE. |
| 615 |
--> |
| 616 |
<property name="Size" type="t" access="read"/> |
| 617 |
|
| 618 |
<!-- TimeDetected: The time the drive was first detected. |
| 619 |
This is expressed in micro-seconds since the Epoch Jan 1, 1970 0:00 UTC. |
| 620 |
--> |
| 621 |
<property name="TimeDetected" type="t" access="read"/> |
| 622 |
|
| 623 |
<!-- TimeMediaDetected: The earliest time media was last detected or 0 if media is not available. |
| 624 |
This is expressed in micro-seconds since the Epoch Jan 1, 1970 0:00 UTC. |
| 625 |
--> |
| 626 |
<property name="TimeMediaDetected" type="t" access="read"/> |
| 627 |
|
| 628 |
<!-- Optical: %TRUE if the drive contains an optical disc. --> |
| 629 |
<property name="Optical" type="b" access="read"/> |
| 630 |
|
| 631 |
<!-- OpticalBlank: %TRUE if the disc is blank. |
| 632 |
This is only valid if the property #org.freedesktop.UDisks2.Drive:Optical is %TRUE. |
| 633 |
--> |
| 634 |
<property name="OpticalBlank" type="b" access="read"/> |
| 635 |
|
| 636 |
<!-- OpticalNumTracks: The number of tracks. |
| 637 |
This is only valid if the property #org.freedesktop.UDisks2.Drive:Optical is %TRUE. |
| 638 |
--> |
| 639 |
<property name="OpticalNumTracks" type="u" access="read"/> |
| 640 |
|
| 641 |
<!-- OpticalNumAudioTracks: The number of audio tracks. |
| 642 |
This is only valid if the property #org.freedesktop.UDisks2.Drive:Optical is %TRUE. |
| 643 |
--> |
| 644 |
<property name="OpticalNumAudioTracks" type="u" access="read"/> |
| 645 |
|
| 646 |
<!-- OpticalNumDataTracks: The number of data tracks. |
| 647 |
This is only valid if the property #org.freedesktop.UDisks2.Drive:Optical is %TRUE. |
| 648 |
--> |
| 649 |
<property name="OpticalNumDataTracks" type="u" access="read"/> |
| 650 |
|
| 651 |
<!-- OpticalNumSessions: The number of sessions. |
| 652 |
This is only valid if the property #org.freedesktop.UDisks2.Drive:Optical is %TRUE. |
| 653 |
--> |
| 654 |
<property name="OpticalNumSessions" type="u" access="read"/> |
| 655 |
|
| 656 |
<!-- RotationRate: The rotational rate of the drive. |
| 657 |
<itemizedlist> |
| 658 |
<listitem><para>-1 if known to be rotating media but rotation rate isn't known</para></listitem> |
| 659 |
<listitem><para>0 if known to be non-rotating media</para></listitem> |
| 660 |
<listitem><para>the rotation rate in rounds per minute otherwise</para></listitem> |
| 661 |
</itemizedlist> |
| 662 |
--> |
| 663 |
<property name="RotationRate" type="i" access="read"/> |
| 664 |
|
| 665 |
<!-- ConnectionBus: |
| 666 |
The physical connection bus used for the drive as seen by the |
| 667 |
user. This is typically used to draw a USB or Firewire emblem |
| 668 |
on top of an icon in an user interface. |
| 669 |
|
| 670 |
Note that this property has <emphasis>nothing</emphasis> to do |
| 671 |
with the low-level command-set used (such as ATA-8) or what |
| 672 |
low-level connection bus (such as SATA, eSATA, PATA, SAS2 etc) |
| 673 |
is used. |
| 674 |
|
| 675 |
Known values include: |
| 676 |
<variablelist> |
| 677 |
<varlistentry><term>usb</term><listitem><para>Connected via <ulink url="http://en.wikipedia.org/wiki/USB">USB</ulink></para></listitem></varlistentry> |
| 678 |
<varlistentry><term>sdio</term><listitem><para>Connected via SDHC or <ulink url="http://en.wikipedia.org/wiki/Secure_Digital">SDIO</ulink> controller (including eMMC).</para></listitem></varlistentry> |
| 679 |
<varlistentry><term>ieee1394</term><listitem><para>Connected via <ulink url="http://en.wikipedia.org/wiki/Firewire">Firewire</ulink></para></listitem></varlistentry> |
| 680 |
</variablelist> |
| 681 |
--> |
| 682 |
<property name="ConnectionBus" type="s" access="read"/> |
| 683 |
|
| 684 |
<!-- Seat: |
| 685 |
A string identifying what seat the drive is plugged into, if any. |
| 686 |
--> |
| 687 |
<property name="Seat" type="s" access="read"/> |
| 688 |
|
| 689 |
<!-- |
| 690 |
Removable: |
| 691 |
A hint whether the drive and/or its media is considered |
| 692 |
<emphasis>removable</emphasis> by the user. |
| 693 |
|
| 694 |
This includes drives with removable media (cf. the |
| 695 |
#org.freedesktop.UDisks2.Drive:MediaRemovable property), Flash |
| 696 |
media such as SD cards and drives on hotpluggable buses such |
| 697 |
as USB or Firewire (cf. the |
| 698 |
#org.freedesktop.UDisks2.Drive:ConnectionBus property). |
| 699 |
|
| 700 |
Note that this is only a <emphasis>guess</emphasis>. |
| 701 |
--> |
| 702 |
<property name="Removable" type="b" access="read"/> |
| 703 |
|
| 704 |
<!-- Ejectable: |
| 705 |
Whether the media can be ejected from the drive or the drive |
| 706 |
accepts an eject command to switch its state so it displays |
| 707 |
e.g. a "Safe To Remove" message to the user. |
| 708 |
|
| 709 |
Note that this is only a <emphasis>guess</emphasis>. |
| 710 |
--> |
| 711 |
<property name="Ejectable" type="b" access="read"/> |
| 712 |
|
| 713 |
<!-- SortKey: |
| 714 |
A string that can be used for sorting drive objects. |
| 715 |
--> |
| 716 |
<property name="SortKey" type="s" access="read"/> |
| 717 |
|
| 718 |
<!-- |
| 719 |
Eject: |
| 720 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 721 |
|
| 722 |
Ejects media from the drive. This is only meaningful to do on |
| 723 |
drives with removable media. |
| 724 |
|
| 725 |
There are not a lot of guarantees associated with this method |
| 726 |
so it should only be called in response to an user action. |
| 727 |
|
| 728 |
On some hardware the media may be physically ejected while on |
| 729 |
other hardware may simply eject the disc. On some hardware it |
| 730 |
may not do anything physical but it may cause e.g. a display |
| 731 |
on the hardware to show e.g. <quote>It is now safe to remove |
| 732 |
the device</quote>. |
| 733 |
--> |
| 734 |
<method name="Eject"> |
| 735 |
<arg name="options" direction="in" type="a{sv}"/> |
| 736 |
</method> |
| 737 |
|
| 738 |
<!-- |
| 739 |
SetConfiguration: |
| 740 |
@value: The configuration value to set. |
| 741 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 742 |
|
| 743 |
Sets the configuration for the drive. This will store the |
| 744 |
configuration in the file-system and also apply it to the |
| 745 |
drive. |
| 746 |
|
| 747 |
See the #org.freedesktop.UDisks2.Drive:Configuration property |
| 748 |
for details about valid values and the location of the |
| 749 |
configuration file that @value will be written to. |
| 750 |
--> |
| 751 |
<method name="SetConfiguration"> |
| 752 |
<arg name="value" direction="in" type="a{sv}"/> |
| 753 |
<arg name="options" direction="in" type="a{sv}"/> |
| 754 |
</method> |
| 755 |
|
| 756 |
<!-- |
| 757 |
PowerOff: |
| 758 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 759 |
@since: 2.0.0 |
| 760 |
|
| 761 |
Arranges for the drive to be safely removed and powered |
| 762 |
off. On the OS side this includes ensuring that no process is |
| 763 |
using the drive, then requesting that in-flight buffers and |
| 764 |
caches are committed to stable storage. The exact steps for |
| 765 |
powering off the drive depends on the drive itself and the |
| 766 |
interconnect used. For drives connected through USB, the |
| 767 |
effect is that the USB device will be deconfigured followed by |
| 768 |
disabling the upstream hub port it is connected to. |
| 769 |
|
| 770 |
Note that as some physical devices contain multiple drives |
| 771 |
(for example 4-in-1 flash card reader USB devices) powering |
| 772 |
off one drive may affect other drives. Applications can |
| 773 |
examine the #org.freedesktop.UDisks2.Drive:SiblingId property |
| 774 |
to determine such relationships. |
| 775 |
|
| 776 |
There are not a lot of guarantees associated with this method |
| 777 |
so it should only be called in response to an user |
| 778 |
action. Usually the effect is that the drive disappears as if |
| 779 |
it was unplugged. |
| 780 |
|
| 781 |
This method only works if the |
| 782 |
#org.freedesktop.UDisks2.Drive:CanPowerOff property |
| 783 |
is set to %TRUE. |
| 784 |
--> |
| 785 |
<method name="PowerOff"> |
| 786 |
<arg name="options" direction="in" type="a{sv}"/> |
| 787 |
</method> |
| 788 |
|
| 789 |
<!-- CanPowerOff: |
| 790 |
@since: 2.0.0 |
| 791 |
Whether the drive can be safely removed / powered off. See |
| 792 |
the org.freedesktop.UDisks2.Drive.PowerOff() method for more |
| 793 |
information. |
| 794 |
|
| 795 |
See <xref linkend="udisks.8"/> for how to influence the value of this property. |
| 796 |
--> |
| 797 |
<property name="CanPowerOff" type="b" access="read"/> |
| 798 |
|
| 799 |
<!-- SiblingId: |
| 800 |
@since: 2.0.0 |
| 801 |
An opaque token that, if non-blank, is used to group drives |
| 802 |
that are part of the same physical device. |
| 803 |
--> |
| 804 |
<property name="SiblingId" type="s" access="read"/> |
| 805 |
|
| 806 |
</interface> |
| 807 |
|
| 808 |
<!-- |
| 809 |
org.freedesktop.UDisks2.Drive.Ata: |
| 810 |
@short_description: Disk drives using the ATA command-set |
| 811 |
|
| 812 |
Objects implementing this interface also implement the |
| 813 |
#org.freedesktop.UDisks2.Drive interface. |
| 814 |
--> |
| 815 |
<interface name="org.freedesktop.UDisks2.Drive.Ata"> |
| 816 |
<!-- SmartSupported: Whether the drive supports SMART. --> |
| 817 |
<property name="SmartSupported" type="b" access="read"/> |
| 818 |
|
| 819 |
<!-- SmartEnabled: Whether SMART is enabled. --> |
| 820 |
<property name="SmartEnabled" type="b" access="read"/> |
| 821 |
|
| 822 |
<!-- SmartUpdated: |
| 823 |
The point in time (seconds since the |
| 824 |
<ulink url="http://en.wikipedia.org/wiki/Unix_epoch">Unix Epoch</ulink>) |
| 825 |
that the SMART status was updated or 0 if never updated. |
| 826 |
|
| 827 |
The value of the other properties related to SMART are not |
| 828 |
meaningful if this property is 0. |
| 829 |
--> |
| 830 |
<property name="SmartUpdated" type="t" access="read"/> |
| 831 |
|
| 832 |
<!-- SmartFailing: |
| 833 |
Set to %TRUE if disk is about to fail. |
| 834 |
|
| 835 |
This value is read from the disk itself and does not include |
| 836 |
any interpretation. |
| 837 |
--> |
| 838 |
<property name="SmartFailing" type="b" access="read"/> |
| 839 |
|
| 840 |
<!-- SmartPowerOnSeconds: |
| 841 |
The amount of time the disk has been powered on (according to SMART data) or 0 if unknown. |
| 842 |
--> |
| 843 |
<property name="SmartPowerOnSeconds" type="t" access="read"/> |
| 844 |
|
| 845 |
<!-- SmartTemperature: |
| 846 |
The temperature (in Kelvin) of the disk according to SMART data or 0 if unknown. |
| 847 |
--> |
| 848 |
<property name="SmartTemperature" type="d" access="read"/> |
| 849 |
|
| 850 |
<!-- |
| 851 |
SmartNumAttributesFailing: |
| 852 |
The number of attributes failing right now or -1 if unknown. |
| 853 |
--> |
| 854 |
<property name="SmartNumAttributesFailing" type="i" access="read"/> |
| 855 |
|
| 856 |
<!-- |
| 857 |
SmartNumAttributesFailedInThePast: |
| 858 |
The number of attributes that have failed in the past or -1 if unknown. |
| 859 |
--> |
| 860 |
<property name="SmartNumAttributesFailedInThePast" type="i" access="read"/> |
| 861 |
|
| 862 |
<!-- |
| 863 |
SmartNumBadSectors: |
| 864 |
The number of bad sectors (ie. pending and reallocated) or -1 if unknown. |
| 865 |
--> |
| 866 |
<property name="SmartNumBadSectors" type="x" access="read"/> |
| 867 |
|
| 868 |
<!-- SmartSelftestStatus: |
| 869 |
The status of the last self-test. Known values include |
| 870 |
<variablelist> |
| 871 |
<varlistentry><term>success</term> |
| 872 |
<listitem><para>Last self-test was a success (or never ran).</para></listitem></varlistentry> |
| 873 |
<varlistentry><term>aborted</term> |
| 874 |
<listitem><para>Last self-test was aborted.</para></listitem></varlistentry> |
| 875 |
<varlistentry><term>interrupted</term> |
| 876 |
<listitem><para>Last self-test was interrupted.</para></listitem></varlistentry> |
| 877 |
<varlistentry><term>fatal</term> |
| 878 |
<listitem><para>Last self-test did not complete.</para></listitem></varlistentry> |
| 879 |
<varlistentry><term>error_unknown</term> |
| 880 |
<listitem><para>Last self-test failed (Unknown).</para></listitem></varlistentry> |
| 881 |
<varlistentry><term>error_electrical</term> |
| 882 |
<listitem><para>Last self-test failed (Electrical).</para></listitem></varlistentry> |
| 883 |
<varlistentry><term>error_servo</term> |
| 884 |
<listitem><para>Last self-test failed (Servo).</para></listitem></varlistentry> |
| 885 |
<varlistentry><term>error_read</term> |
| 886 |
<listitem><para>Last self-test failed (Read).</para></listitem></varlistentry> |
| 887 |
<varlistentry><term>error_handling</term> |
| 888 |
<listitem><para>Last self-test failed (Damage).</para></listitem></varlistentry> |
| 889 |
<varlistentry><term>inprogress</term> |
| 890 |
<listitem><para>Self-test is currently in progress.</para></listitem></varlistentry> |
| 891 |
</variablelist> |
| 892 |
--> |
| 893 |
<property name="SmartSelftestStatus" type="s" access="read"/> |
| 894 |
|
| 895 |
<!-- |
| 896 |
SmartSelftestPercentRemaining: |
| 897 |
The percent remaining or -1 if unknown. |
| 898 |
--> |
| 899 |
<property name="SmartSelftestPercentRemaining" type="i" access="read"/> |
| 900 |
|
| 901 |
<!-- |
| 902 |
SmartUpdate: |
| 903 |
@options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>nowakeup</parameter> (of type 'b'). |
| 904 |
|
| 905 |
Reads SMART data from the drive and update relevant properties. |
| 906 |
|
| 907 |
If the option @nowakeup is given and the disk is in a sleeping |
| 908 |
state, the error |
| 909 |
<literal>org.freedesktop.UDisks2.Error.WouldWakeup</literal> is |
| 910 |
returned. |
| 911 |
|
| 912 |
The option @atasmart_blob (of type 's' representing a path to |
| 913 |
the blob file) can be used to inject libatasmart-compatible |
| 914 |
blobs for testing how clients react to different kinds of SMART |
| 915 |
data. Only valid when backed with the |
| 916 |
<literal>libblockdev_libatasmart</literal> plugin. This option |
| 917 |
may be removed in the future without it being considered an ABI |
| 918 |
break. Deprecated since 2.11.0. |
| 919 |
--> |
| 920 |
<method name="SmartUpdate"> |
| 921 |
<arg name="options" direction="in" type="a{sv}"/> |
| 922 |
</method> |
| 923 |
|
| 924 |
<!-- |
| 925 |
SmartGetAttributes: |
| 926 |
@options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>nowakeup</parameter> (of type 'b'). |
| 927 |
@attributes: The SMART attributes. |
| 928 |
|
| 929 |
Get the SMART attributes. |
| 930 |
Each attribute is a struct with the following members: |
| 931 |
<variablelist> |
| 932 |
<varlistentry><term>id (type 'y')</term> |
| 933 |
<listitem><para>Attribute Identifier</para></listitem></varlistentry> |
| 934 |
<varlistentry><term>name (type 's')</term> |
| 935 |
<listitem><para>The identifier as a string.</para></listitem></varlistentry> |
| 936 |
<varlistentry><term>flags (type 'q')</term> |
| 937 |
<listitem><para>16-bit attribute flags (bit 0 is prefail/oldage, bit 1 is online/offline).</para></listitem></varlistentry> |
| 938 |
<varlistentry><term>value (type 'i')</term> |
| 939 |
<listitem><para>The current value or -1 if unknown.</para></listitem></varlistentry> |
| 940 |
<varlistentry><term>worst (type 'i')</term> |
| 941 |
<listitem><para>The worst value of -1 if unknown.</para></listitem></varlistentry> |
| 942 |
<varlistentry><term>threshold (type 'i')</term> |
| 943 |
<listitem><para>The threshold or -1 if unknown.</para></listitem></varlistentry> |
| 944 |
<varlistentry><term>pretty (type 'x')</term> |
| 945 |
<listitem><para>An interpretation of the value - must be ignored if @pretty_unit is 0.</para></listitem></varlistentry> |
| 946 |
<varlistentry><term>pretty_unit (type 'i')</term> |
| 947 |
<listitem><para>The unit of the @pretty value - the following units are known: 0 (unknown), 1 (dimensionless), 2 (milliseconds), 3 (sectors), 4 (millikelvin).</para></listitem></varlistentry> |
| 948 |
<varlistentry><term>expansion (type 'a{sv}')</term> |
| 949 |
<listitem><para>Currently unused. Intended for future expansion.</para></listitem></varlistentry> |
| 950 |
</variablelist> |
| 951 |
The @name parameter should be used as the authoritative identifier for the attribute since it is derived from the numerical @id and the disk's <literal>IDENTIFY</literal> data and thus handles ID collisions between drives of different make and model. |
| 952 |
--> |
| 953 |
<method name="SmartGetAttributes"> |
| 954 |
<arg name="options" direction="in" type="a{sv}"/> |
| 955 |
<arg name="attributes" direction="out" type="a(ysqiiixia{sv})"/> |
| 956 |
</method> |
| 957 |
|
| 958 |
<!-- |
| 959 |
SmartSelftestStart: |
| 960 |
@type: The type test to run. |
| 961 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 962 |
|
| 963 |
Starts a SMART selftest. The @type parameter is for the type |
| 964 |
of test to start - valid values are <literal>short</literal>, |
| 965 |
<literal>extended</literal>, <literal>conveyance</literal> and |
| 966 |
<literal>offline</literal> (since 2.11.0). |
| 967 |
|
| 968 |
Note that the method returns immediately after the test has |
| 969 |
been started successfully. |
| 970 |
--> |
| 971 |
<method name="SmartSelftestStart"> |
| 972 |
<arg name="type" direction="in" type="s"/> |
| 973 |
<arg name="options" direction="in" type="a{sv}"/> |
| 974 |
</method> |
| 975 |
|
| 976 |
<!-- |
| 977 |
SmartSelftestAbort: |
| 978 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 979 |
|
| 980 |
Aborts a running SMART selftest. |
| 981 |
--> |
| 982 |
<method name="SmartSelftestAbort"> |
| 983 |
<arg name="options" direction="in" type="a{sv}"/> |
| 984 |
</method> |
| 985 |
|
| 986 |
<!-- |
| 987 |
SmartSetEnabled: |
| 988 |
@value: %TRUE to enable SMART, %FALSE to disable SMART. |
| 989 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 990 |
@since: 2.0.0 |
| 991 |
|
| 992 |
Sets whether SMART is enabled for the drive. This setting is |
| 993 |
stored in the non-volatile memory in the drive itself and does |
| 994 |
not need to be refreshed every time the drive is powered on or |
| 995 |
connected. |
| 996 |
|
| 997 |
Since this may require authentication and thus may fail, it is |
| 998 |
implemented this way instead of the |
| 999 |
#org.freedesktop.UDisks2.Drive.Ata:SmartEnabled property being |
| 1000 |
writable. |
| 1001 |
--> |
| 1002 |
<method name="SmartSetEnabled"> |
| 1003 |
<arg name="value" direction="in" type="b"/> |
| 1004 |
<arg name="options" direction="in" type="a{sv}"/> |
| 1005 |
</method> |
| 1006 |
|
| 1007 |
<!-- PmSupported: Whether the drive supports power management. --> |
| 1008 |
<property name="PmSupported" type="b" access="read"/> |
| 1009 |
|
| 1010 |
<!-- PmEnabled: Whether power management is enabled. --> |
| 1011 |
<property name="PmEnabled" type="b" access="read"/> |
| 1012 |
|
| 1013 |
<!-- ApmSupported: Whether the drive supports Advanced Power Management (APM). --> |
| 1014 |
<property name="ApmSupported" type="b" access="read"/> |
| 1015 |
|
| 1016 |
<!-- ApmEnabled: Whether Advanced Power Management (APM) is enabled. --> |
| 1017 |
<property name="ApmEnabled" type="b" access="read"/> |
| 1018 |
|
| 1019 |
<!-- AamSupported: Whether the drive supports Automatic Acoustic Management (AAM). --> |
| 1020 |
<property name="AamSupported" type="b" access="read"/> |
| 1021 |
|
| 1022 |
<!-- AamEnabled: Whether Automatic Acoustic Management (AAM) is enabled. --> |
| 1023 |
<property name="AamEnabled" type="b" access="read"/> |
| 1024 |
|
| 1025 |
<!-- AamVendorRecommendedValue: The vendor-recommended AAM value (or 0 if AAM is not supported). --> |
| 1026 |
<property name="AamVendorRecommendedValue" type="i" access="read"/> |
| 1027 |
|
| 1028 |
<!-- WriteCacheSupported: |
| 1029 |
@since: 2.0.0 |
| 1030 |
Whether the drive supports configuring the write cache. |
| 1031 |
--> |
| 1032 |
<property name="WriteCacheSupported" type="b" access="read"/> |
| 1033 |
|
| 1034 |
<!-- WriteCacheEnabled: |
| 1035 |
@since: 2.0.0 |
| 1036 |
Whether the write-cache is enabled (or %FALSE if not supported). |
| 1037 |
--> |
| 1038 |
<property name="WriteCacheEnabled" type="b" access="read"/> |
| 1039 |
|
| 1040 |
<!-- ReadLookaheadSupported: |
| 1041 |
@since: 2.1.7 |
| 1042 |
Whether the drive supports configuring the read look-ahead. |
| 1043 |
--> |
| 1044 |
<property name="ReadLookaheadSupported" type="b" access="read"/> |
| 1045 |
|
| 1046 |
<!-- ReadLookaheadEnabled: |
| 1047 |
@since: 2.1.7 |
| 1048 |
Whether the read look-ahead is enabled (or %FALSE if not supported). |
| 1049 |
--> |
| 1050 |
<property name="ReadLookaheadEnabled" type="b" access="read"/> |
| 1051 |
|
| 1052 |
<!-- |
| 1053 |
PmGetState: |
| 1054 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 1055 |
@state: The current power state. |
| 1056 |
|
| 1057 |
Get the current power mode status. This is implemented as a |
| 1058 |
method call as it involves sending a command from the host to |
| 1059 |
the drive and no change notification is available. |
| 1060 |
|
| 1061 |
The format of @state is the result obtained from sending the |
| 1062 |
ATA command <quote>CHECK POWER MODE</quote> to the drive. |
| 1063 |
Known values include |
| 1064 |
<variablelist> |
| 1065 |
<varlistentry><term>0x00</term><listitem><para>Standby</para></listitem></varlistentry> |
| 1066 |
<varlistentry><term>0x80</term><listitem><para>Idle</para></listitem></varlistentry> |
| 1067 |
<varlistentry><term>0xff</term><listitem><para>Active/Idle</para></listitem></varlistentry> |
| 1068 |
</variablelist> |
| 1069 |
Typically user interfaces will report "Drive is spun down" if @state is |
| 1070 |
0x00 and "Drive is spun up" otherwise. |
| 1071 |
--> |
| 1072 |
<method name="PmGetState"> |
| 1073 |
<arg name="options" direction="in" type="a{sv}"/> |
| 1074 |
<arg name="state" direction="out" type="y"/> |
| 1075 |
</method> |
| 1076 |
|
| 1077 |
<!-- |
| 1078 |
PmStandby: |
| 1079 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 1080 |
|
| 1081 |
Force the drive to immediately enter the low power consumption |
| 1082 |
<emphasis>standby</emphasis> mode, usually causing it to spin |
| 1083 |
down. This is done by sending the ATA command |
| 1084 |
<quote>STANDBY IMMEDIATE</quote> to the drive. |
| 1085 |
--> |
| 1086 |
<method name="PmStandby"> |
| 1087 |
<arg name="options" direction="in" type="a{sv}"/> |
| 1088 |
</method> |
| 1089 |
|
| 1090 |
<!-- |
| 1091 |
PmWakeup: |
| 1092 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 1093 |
|
| 1094 |
Force the drive to immediately wake up (exiting the low power |
| 1095 |
consumption <emphasis>standby</emphasis> mode), usually |
| 1096 |
causing it to spin up. This is done by reading data from the |
| 1097 |
disk. |
| 1098 |
--> |
| 1099 |
<method name="PmWakeup"> |
| 1100 |
<arg name="options" direction="in" type="a{sv}"/> |
| 1101 |
</method> |
| 1102 |
|
| 1103 |
<!-- SecurityEraseUnitMinutes: |
| 1104 |
The estimated amount of minutes it takes to complete the |
| 1105 |
<quote>SECURITY ERASE UNIT</quote> command or 0 if this |
| 1106 |
command is not available. |
| 1107 |
|
| 1108 |
If set to 510 it means that it takes at least 508 minutes to |
| 1109 |
complete the operation. |
| 1110 |
--> |
| 1111 |
<property name="SecurityEraseUnitMinutes" type="i" access="read"/> |
| 1112 |
|
| 1113 |
<!-- SecurityEnhancedEraseUnitMinutes: |
| 1114 |
The estimated amount of minutes it takes to complete the |
| 1115 |
<quote>SECURITY ERASE UNIT</quote> command with enhanced mode |
| 1116 |
specified or 0 if enhanced erase is not available. |
| 1117 |
|
| 1118 |
If set to 510 it means that it takes at least 508 minutes to |
| 1119 |
complete the operation. |
| 1120 |
--> |
| 1121 |
<property name="SecurityEnhancedEraseUnitMinutes" type="i" access="read"/> |
| 1122 |
|
| 1123 |
<!-- SecurityFrozen: |
| 1124 |
If set to %TRUE the unit is frozen. |
| 1125 |
--> |
| 1126 |
<property name="SecurityFrozen" type="b" access="read"/> |
| 1127 |
|
| 1128 |
<!-- |
| 1129 |
SecurityEraseUnit: |
| 1130 |
@options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>enhanced</parameter> (of type 'b'). |
| 1131 |
|
| 1132 |
Does all the necessary checks and preparations and then sends |
| 1133 |
the <quote>SECURITY ERASE UNIT</quote> command to the |
| 1134 |
drive. If the option @enhanced is set to %TRUE an |
| 1135 |
<emphasis>enhanced secure erase</emphasis> is requested. |
| 1136 |
|
| 1137 |
All data on the drive will be irrevocably erased. |
| 1138 |
|
| 1139 |
This operation takes either |
| 1140 |
#org.freedesktop.UDisks2.Drive.Ata:SecurityEraseUnitMinutes or |
| 1141 |
#org.freedesktop.UDisks2.Drive.Ata:SecurityEnhancedEraseUnitMinutes |
| 1142 |
minutes to complete depending on whether the @enhanced option |
| 1143 |
is %TRUE. |
| 1144 |
--> |
| 1145 |
<method name="SecurityEraseUnit"> |
| 1146 |
<arg name="options" direction="in" type="a{sv}"/> |
| 1147 |
</method> |
| 1148 |
|
| 1149 |
</interface> |
| 1150 |
|
| 1151 |
<!-- ********************************************************************** --> |
| 1152 |
|
| 1153 |
<!-- |
| 1154 |
org.freedesktop.UDisks2.NVMe.Controller: |
| 1155 |
@short_description: NVMe controller device |
| 1156 |
|
| 1157 |
This interface represents a controller device in a NVM subsystem. |
| 1158 |
--> |
| 1159 |
<interface name="org.freedesktop.UDisks2.NVMe.Controller"> |
| 1160 |
<!-- State: |
| 1161 |
@since: 2.10.0 |
| 1162 |
|
| 1163 |
The controller operating state. Values other than <literal>live</literal> may result in temporary |
| 1164 |
refusal of any I/O and subsequent missing information provided by UDisks. |
| 1165 |
|
| 1166 |
Known values include: |
| 1167 |
<variablelist> |
| 1168 |
<varlistentry><term>live</term><listitem><para>Controller is up and running.</para></listitem></varlistentry> |
| 1169 |
<varlistentry><term>new</term><listitem><para></para></listitem></varlistentry> |
| 1170 |
<varlistentry><term>resetting</term><listitem><para></para></listitem></varlistentry> |
| 1171 |
<varlistentry><term>connecting</term><listitem><para></para></listitem></varlistentry> |
| 1172 |
<varlistentry><term>deleting</term><listitem><para></para></listitem></varlistentry> |
| 1173 |
<varlistentry><term>deleting (no IO)</term><listitem><para></para></listitem></varlistentry> |
| 1174 |
<varlistentry><term>dead</term><listitem><para></para></listitem></varlistentry> |
| 1175 |
</variablelist> |
| 1176 |
--> |
| 1177 |
<property name="State" type="s" access="read"/> |
| 1178 |
|
| 1179 |
<!-- ControllerID: |
| 1180 |
@since: 2.10.0 |
| 1181 |
|
| 1182 |
The NVM subsystem unique controller identifier. |
| 1183 |
--> |
| 1184 |
<property name="ControllerID" type="q" access="read"/> |
| 1185 |
|
| 1186 |
<!-- SubsystemNQN: |
| 1187 |
@since: 2.10.0 |
| 1188 |
|
| 1189 |
The NVM Subsystem NVMe Qualified Name. |
| 1190 |
--> |
| 1191 |
<property name="SubsystemNQN" type="ay" access="read"/> |
| 1192 |
|
| 1193 |
<!-- FGUID: |
| 1194 |
@since: 2.10.0 |
| 1195 |
|
| 1196 |
The FRU Globally Unique Identifier. |
| 1197 |
|
| 1198 |
Field-Replaceable Unit (FRU) is a physical component, device, or assembly that is able |
| 1199 |
to be removed and replaced without having to replace the entire system. |
| 1200 |
|
| 1201 |
The FRU Globally Unique Identifier is a 128-bit value that is globally unique for a given |
| 1202 |
Field Replaceable Unit (FRU). Value of %0 indicates this feature is not supported. |
| 1203 |
--> |
| 1204 |
<property name="FGUID" type="s" access="read"/> |
| 1205 |
|
| 1206 |
<!-- NVMeRevision: |
| 1207 |
@since: 2.10.0 |
| 1208 |
|
| 1209 |
The major, minor, and micro version of the NVM Express base specification |
| 1210 |
that the controller implementation supports. Note that some older devices |
| 1211 |
(typically NVMe rev. lower than 1.2) may not always report this value. |
| 1212 |
--> |
| 1213 |
<property name="NVMeRevision" type="s" access="read"/> |
| 1214 |
|
| 1215 |
<!-- UnallocatedCapacity: |
| 1216 |
@since: 2.10.0 |
| 1217 |
|
| 1218 |
The unallocated NVM capacity that is accessible by the controller. |
| 1219 |
--> |
| 1220 |
<property name="UnallocatedCapacity" type="t" access="read"/> |
| 1221 |
|
| 1222 |
<!-- SmartUpdated: |
| 1223 |
@since: 2.10.0 |
| 1224 |
|
| 1225 |
The point in time (seconds since the |
| 1226 |
<ulink url="http://en.wikipedia.org/wiki/Unix_epoch">Unix Epoch</ulink>) |
| 1227 |
that the SMART/Health Information was updated or 0 if never updated. |
| 1228 |
|
| 1229 |
The value of the other properties related to SMART are not |
| 1230 |
meaningful if this property is 0. |
| 1231 |
--> |
| 1232 |
<property name="SmartUpdated" type="t" access="read"/> |
| 1233 |
|
| 1234 |
<!-- SmartCriticalWarning: |
| 1235 |
@since: 2.10.0 |
| 1236 |
|
| 1237 |
Critical warnings issued for the current state of the controller. An empty array |
| 1238 |
indicates a healthy state. This is the primary health assessment property to watch for. |
| 1239 |
|
| 1240 |
Known values include: |
| 1241 |
<variablelist> |
| 1242 |
<varlistentry><term>spare</term> |
| 1243 |
<listitem><para>The available spare capacity has fallen below the threshold.</para></listitem></varlistentry> |
| 1244 |
<varlistentry><term>temperature</term> |
| 1245 |
<listitem><para>A temperature is either greater than or equal to an over temperature threshold; or less than or equal to an under temperature threshold.</para></listitem></varlistentry> |
| 1246 |
<varlistentry><term>degraded</term> |
| 1247 |
<listitem><para>The NVM subsystem reliability has been degraded due to significant media related errors or any internal error that degrades NVM subsystem reliability.</para></listitem></varlistentry> |
| 1248 |
<varlistentry><term>readonly</term> |
| 1249 |
<listitem><para>All of the media has been placed in read only mode. Unrelated to the write protection state of a namespace.</para></listitem></varlistentry> |
| 1250 |
<varlistentry><term>volatile_mem</term> |
| 1251 |
<listitem><para>The volatile memory backup device has failed. Only valid if the controller has a volatile memory backup solution.</para></listitem></varlistentry> |
| 1252 |
<varlistentry><term>pmr_readonly</term> |
| 1253 |
<listitem><para>Persistent Memory Region has become read-only or unreliable.</para></listitem></varlistentry> |
| 1254 |
</variablelist> |
| 1255 |
--> |
| 1256 |
<property name="SmartCriticalWarning" type="as" access="read"/> |
| 1257 |
|
| 1258 |
<!-- SmartPowerOnHours: |
| 1259 |
@since: 2.10.0 |
| 1260 |
|
| 1261 |
The amount of time the disk has been powered on (according to SMART data) or 0 if unknown. |
| 1262 |
--> |
| 1263 |
<property name="SmartPowerOnHours" type="t" access="read"/> |
| 1264 |
|
| 1265 |
<!-- SmartTemperature: |
| 1266 |
@since: 2.10.0 |
| 1267 |
|
| 1268 |
The temperature (in Kelvin) that represents the current composite temperature |
| 1269 |
of the controller and associated namespaces or 0 if unknown. Values of the particular |
| 1270 |
temperature sensors are exposed via the SmartGetAttributes() method. |
| 1271 |
--> |
| 1272 |
<property name="SmartTemperature" type="q" access="read"/> |
| 1273 |
|
| 1274 |
<!-- SmartSelftestStatus: |
| 1275 |
@since: 2.10.0 |
| 1276 |
|
| 1277 |
The status of the last self-test. Known values include: |
| 1278 |
<variablelist> |
| 1279 |
<varlistentry><term>success</term> |
| 1280 |
<listitem><para>Operation completed without error (or never ran).</para></listitem></varlistentry> |
| 1281 |
<varlistentry><term>aborted</term> |
| 1282 |
<listitem><para>Operation was aborted by a Device Self-test command.</para></listitem></varlistentry> |
| 1283 |
<varlistentry><term>ctrl_reset</term> |
| 1284 |
<listitem><para>Operation was aborted by a Controller Level Reset.</para></listitem></varlistentry> |
| 1285 |
<varlistentry><term>ns_removed</term> |
| 1286 |
<listitem><para>Operation was aborted due to a removal of a namespace from the namespace inventory.</para></listitem></varlistentry> |
| 1287 |
<varlistentry><term>aborted_format</term> |
| 1288 |
<listitem><para>Operation was aborted due to the processing of a Format NVM command.</para></listitem></varlistentry> |
| 1289 |
<varlistentry><term>fatal_error</term> |
| 1290 |
<listitem><para>A fatal error or unknown test error occurred while the controller was executing the device self-test operation and the operation did not complete.</para></listitem></varlistentry> |
| 1291 |
<varlistentry><term>unknown_seg_fail</term> |
| 1292 |
<listitem><para>Operation completed with a segment that failed and the segment that failed is not known.</para></listitem></varlistentry> |
| 1293 |
<varlistentry><term>known_seg_fail</term> |
| 1294 |
<listitem><para>Operation completed with one or more failed segments.</para></listitem></varlistentry> |
| 1295 |
<varlistentry><term>aborted_unknown</term> |
| 1296 |
<listitem><para>Operation was aborted for unknown reason.</para></listitem></varlistentry> |
| 1297 |
<varlistentry><term>aborted_sanitize</term> |
| 1298 |
<listitem><para>Operation was aborted due to a sanitize operation.</para></listitem></varlistentry> |
| 1299 |
<varlistentry><term>inprogress</term> |
| 1300 |
<listitem><para>Self-test operation is currently in progress.</para></listitem></varlistentry> |
| 1301 |
</variablelist> |
| 1302 |
--> |
| 1303 |
<property name="SmartSelftestStatus" type="s" access="read"/> |
| 1304 |
|
| 1305 |
<!-- |
| 1306 |
SmartSelftestPercentRemaining: |
| 1307 |
@since: 2.10.0 |
| 1308 |
|
| 1309 |
The percent remaining or -1 if unknown. |
| 1310 |
--> |
| 1311 |
<property name="SmartSelftestPercentRemaining" type="i" access="read"/> |
| 1312 |
|
| 1313 |
<!-- SanitizeStatus: |
| 1314 |
@since: 2.10.0 |
| 1315 |
|
| 1316 |
The information about the most recent sanitize operation. Known values include: |
| 1317 |
<variablelist> |
| 1318 |
<varlistentry><term>never_sanitized</term> |
| 1319 |
<listitem><para>The NVM subsystem has never been sanitized (or the status is unknown).</para></listitem></varlistentry> |
| 1320 |
<varlistentry><term>success</term> |
| 1321 |
<listitem><para>Operation completed successfully.</para></listitem></varlistentry> |
| 1322 |
<varlistentry><term>failure</term> |
| 1323 |
<listitem><para>The most recent sanitize operation failed.</para></listitem></varlistentry> |
| 1324 |
<varlistentry><term>inprogress</term> |
| 1325 |
<listitem><para>A sanitize operation is currently in progress.</para></listitem></varlistentry> |
| 1326 |
</variablelist> |
| 1327 |
--> |
| 1328 |
<property name="SanitizeStatus" type="s" access="read"/> |
| 1329 |
|
| 1330 |
<!-- |
| 1331 |
SanitizePercentRemaining: |
| 1332 |
@since: 2.10.0 |
| 1333 |
|
| 1334 |
The percent remaining or -1 if unknown. |
| 1335 |
--> |
| 1336 |
<property name="SanitizePercentRemaining" type="i" access="read"/> |
| 1337 |
|
| 1338 |
<!-- |
| 1339 |
SmartUpdate: |
| 1340 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 1341 |
@since: 2.10.0 |
| 1342 |
|
| 1343 |
Reads SMART/Health Information from the NVMe controller and update relevant properties. |
| 1344 |
Data in this interface are typically updated on every uevent or as a result of Asynchronous |
| 1345 |
Event Notification. |
| 1346 |
--> |
| 1347 |
<method name="SmartUpdate"> |
| 1348 |
<arg name="options" direction="in" type="a{sv}"/> |
| 1349 |
</method> |
| 1350 |
|
| 1351 |
<!-- |
| 1352 |
SmartGetAttributes: |
| 1353 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 1354 |
@attributes: The SMART attributes. |
| 1355 |
@since: 2.10.0 |
| 1356 |
|
| 1357 |
Get the SMART/Health Information attributes. |
| 1358 |
|
| 1359 |
Known values include: |
| 1360 |
<variablelist> |
| 1361 |
<varlistentry><term>avail_spare (type 'y')</term> |
| 1362 |
<listitem><para>Available Spare: a normalized percentage (0% to 100%) of the remaining spare capacity available.</para></listitem></varlistentry> |
| 1363 |
<varlistentry><term>spare_thresh (type 'y')</term> |
| 1364 |
<listitem><para>Available Spare Threshold: a normalized percentage (0% to 100%) of the available spare threshold.</para></listitem></varlistentry> |
| 1365 |
<varlistentry><term>percent_used (type 'y')</term> |
| 1366 |
<listitem><para>Percentage Used: a vendor specific estimate of the percentage drive life used based on the actual usage |
| 1367 |
and the manufacturer's prediction. A value of 100 indicates that the estimated endurance has been consumed, |
| 1368 |
but may not indicate an NVM subsystem failure. The value is allowed to exceed 100.</para></listitem></varlistentry> |
| 1369 |
<varlistentry><term>total_data_read (type 't')</term> |
| 1370 |
<listitem><para>An estimated calculation of total data read in bytes based on calculation of data units read from the host.</para></listitem></varlistentry> |
| 1371 |
<varlistentry><term>total_data_written (type 't')</term> |
| 1372 |
<listitem><para>An estimated calculation of total data written in bytes based on calculation of data units written by the host.</para></listitem></varlistentry> |
| 1373 |
<varlistentry><term>ctrl_busy_time (type 't')</term> |
| 1374 |
<listitem><para>Amount of time the controller is busy with I/O commands, reported in minutes.</para></listitem></varlistentry> |
| 1375 |
<varlistentry><term>power_cycles (type 't')</term> |
| 1376 |
<listitem><para>The number of power cycles.</para></listitem></varlistentry> |
| 1377 |
<varlistentry><term>unsafe_shutdowns (type 't')</term> |
| 1378 |
<listitem><para>The number of unsafe shutdowns as a result of a Shutdown Notification not received prior to loss of power.</para></listitem></varlistentry> |
| 1379 |
<varlistentry><term>media_errors (type 't')</term> |
| 1380 |
<listitem><para>Media and Data Integrity Errors: the number of occurrences where the controller detected an unrecovered data integrity error |
| 1381 |
(e.g. uncorrectable ECC, CRC checksum failure, or LBA tag mismatch).</para></listitem></varlistentry> |
| 1382 |
<varlistentry><term>num_err_log_entries (type 't')</term> |
| 1383 |
<listitem><para>Number of Error Information Log Entries: the number of Error Information log entries over the life of the controller.</para></listitem></varlistentry> |
| 1384 |
<varlistentry><term>temp_sensors (type 'aq')</term> |
| 1385 |
<listitem><para>Array of the current temperature reported by temperature sensors 1-8 in Kelvins or 0 when the particular sensor is not available.</para></listitem></varlistentry> |
| 1386 |
<varlistentry><term>wctemp (type 'q')</term> |
| 1387 |
<listitem><para>Warning Composite Temperature Threshold (WCTEMP): indicates the minimum Composite Temperature (@SmartTemperature) value |
| 1388 |
that indicates an overheating condition during which controller operation continues.</para></listitem></varlistentry> |
| 1389 |
<varlistentry><term>cctemp (type 'q')</term> |
| 1390 |
<listitem><para>Critical Composite Temperature Threshold (CCTEMP): indicates the minimum Composite Temperature (@SmartTemperature) value |
| 1391 |
that indicates a critical overheating condition (e.g., may prevent continued normal operation, possibility of data loss, |
| 1392 |
automatic device shutdown, extreme performance throttling, or permanent damage).</para></listitem></varlistentry> |
| 1393 |
<varlistentry><term>warning_temp_time (type 'u')</term> |
| 1394 |
<listitem><para>Warning Composite Temperature Time: the amount of time in minutes that the Composite Temperature (@SmartTemperature) is greater |
| 1395 |
than or equal to the Warning Composite Temperature Threshold (@wctemp) and less than the Critical Composite Temperature Threshold |
| 1396 |
(@cctemp).</para></listitem></varlistentry> |
| 1397 |
<varlistentry><term>critical_temp_time (type 'u')</term> |
| 1398 |
<listitem><para>Critical Composite Temperature Time: the amount of time in minutes that the Composite Temperature (@SmartTemperature) is greater |
| 1399 |
than or equal to the Critical Composite Temperature Threshold (@cctemp).</para></listitem></varlistentry> |
| 1400 |
</variablelist> |
| 1401 |
--> |
| 1402 |
<method name="SmartGetAttributes"> |
| 1403 |
<arg name="options" direction="in" type="a{sv}"/> |
| 1404 |
<arg name="attributes" direction="out" type="a{sv}"/> |
| 1405 |
</method> |
| 1406 |
|
| 1407 |
<!-- |
| 1408 |
SmartSelftestStart: |
| 1409 |
@type: The type test to run. |
| 1410 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 1411 |
@since: 2.10.0 |
| 1412 |
|
| 1413 |
Starts a device selftest operation on all active namespaces accessible through the controller |
| 1414 |
at the time the operation is started. A device selftest operation is a diagnostic testing |
| 1415 |
sequence that tests the integrity and functionality of the controller and may include testing |
| 1416 |
of the media associated with namespaces. |
| 1417 |
|
| 1418 |
The @type parameter indicates the type of test to start - valid values are |
| 1419 |
<literal>short</literal>, <literal>extended</literal> and <literal>vendor-specific</literal>. |
| 1420 |
|
| 1421 |
Note that the method returns immediately after the test has been started |
| 1422 |
successfully and the operation is performed in the background. |
| 1423 |
--> |
| 1424 |
<method name="SmartSelftestStart"> |
| 1425 |
<arg name="type" direction="in" type="s"/> |
| 1426 |
<arg name="options" direction="in" type="a{sv}"/> |
| 1427 |
</method> |
| 1428 |
|
| 1429 |
<!-- |
| 1430 |
SmartSelftestAbort: |
| 1431 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 1432 |
@since: 2.10.0 |
| 1433 |
|
| 1434 |
Aborts a running device selftest. |
| 1435 |
--> |
| 1436 |
<method name="SmartSelftestAbort"> |
| 1437 |
<arg name="options" direction="in" type="a{sv}"/> |
| 1438 |
</method> |
| 1439 |
|
| 1440 |
<!-- |
| 1441 |
SanitizeStart: |
| 1442 |
@action: The sanitize action to perform. |
| 1443 |
@options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>overwrite_pass_count</parameter> (of type 'y'), <parameter>overwrite_pattern</parameter> (of type 'u') and <parameter>overwrite_invert_pattern</parameter> (of type 'b'). |
| 1444 |
@since: 2.10.0 |
| 1445 |
|
| 1446 |
Starts a sanitize operation in the background. A sanitize operation alters all user data |
| 1447 |
in the NVM subsystem such that recovery of any previous user data from any cache, |
| 1448 |
the non-volatile media, or any Controller Memory Buffer is not possible. The scope |
| 1449 |
of a sanitize operation is all locations in the NVM subsystem that are able to contain |
| 1450 |
user data, including caches, Persistent Memory Regions, and unallocated or deallocated |
| 1451 |
areas of the media. |
| 1452 |
|
| 1453 |
Once started, a sanitize operation is not able to be aborted and continues after |
| 1454 |
a Controller Level Reset including across power cycles. Once the sanitize operation |
| 1455 |
has run the media affected may not be immediately ready for use unless additional |
| 1456 |
media modification mechanism is run. This is often vendor specific and also depends |
| 1457 |
on the sanitize method (@action) used. |
| 1458 |
|
| 1459 |
The sanitize operation is set to be executed with the No-Deallocate After Sanitize |
| 1460 |
feature turned on, i.e. the controller shall not deallocate any user data as a result |
| 1461 |
of successfully completing the sanitize operation. |
| 1462 |
|
| 1463 |
The @action parameter indicates the type of the sanitize action to take - valid values are |
| 1464 |
<literal>block-erase</literal>, <literal>overwrite</literal> and <literal>crypto-erase</literal>. |
| 1465 |
|
| 1466 |
In case of the <literal>overwrite</literal> action additional options are taken in account. |
| 1467 |
The <literal>overwrite_pass_count</literal> option specifies number of overwrite passes (1-15) |
| 1468 |
defaulting to 16 passes when not specified. The <literal>overwrite_pattern</literal> option |
| 1469 |
specifies a 32-bit pattern, defaulting to zero if not specified. The <literal>overwrite_invert_pattern</literal> |
| 1470 |
option indicates that the overwrite pattern should be inverted between passes. |
| 1471 |
--> |
| 1472 |
<method name="SanitizeStart"> |
| 1473 |
<arg name="action" direction="in" type="s"/> |
| 1474 |
<arg name="options" direction="in" type="a{sv}"/> |
| 1475 |
</method> |
| 1476 |
|
| 1477 |
</interface> |
| 1478 |
|
| 1479 |
<!-- ********************************************************************** --> |
| 1480 |
|
| 1481 |
<!-- |
| 1482 |
org.freedesktop.UDisks2.NVMe.Namespace: |
| 1483 |
@short_description: NVMe namespace device |
| 1484 |
|
| 1485 |
This interface represents a namespace device in a NVM subsystem. |
| 1486 |
--> |
| 1487 |
<interface name="org.freedesktop.UDisks2.NVMe.Namespace"> |
| 1488 |
<!-- NSID: |
| 1489 |
@since: 2.10.0 |
| 1490 |
|
| 1491 |
The Namespace Identifier. |
| 1492 |
--> |
| 1493 |
<property name="NSID" type="u" access="read"/> |
| 1494 |
|
| 1495 |
<!-- NGUID: |
| 1496 |
@since: 2.10.0 |
| 1497 |
|
| 1498 |
The Namespace Globally Unique Identifier. |
| 1499 |
|
| 1500 |
A 128-bit value that is globally unique and assigned to the namespace when the namespace |
| 1501 |
is created. Remains fixed throughout the life of the namespace. |
| 1502 |
--> |
| 1503 |
<property name="NGUID" type="s" access="read"/> |
| 1504 |
|
| 1505 |
<!-- EUI64: |
| 1506 |
@since: 2.10.0 |
| 1507 |
|
| 1508 |
The IEEE Extended Unique Identifier. |
| 1509 |
|
| 1510 |
A 64-bit value that is globally unique and assigned to the namespace when the namespace |
| 1511 |
is created. Remains fixed throughout the life of the namespace. |
| 1512 |
--> |
| 1513 |
<property name="EUI64" type="s" access="read"/> |
| 1514 |
|
| 1515 |
<!-- UUID: |
| 1516 |
@since: 2.10.0 |
| 1517 |
|
| 1518 |
The Namespace UUID. |
| 1519 |
|
| 1520 |
Contains a 128-bit Universally Unique Identifier (UUID) as specified in RFC 4122. |
| 1521 |
--> |
| 1522 |
<property name="UUID" type="s" access="read"/> |
| 1523 |
|
| 1524 |
<!-- WWN: |
| 1525 |
@since: 2.10.0 |
| 1526 |
|
| 1527 |
The <ulink |
| 1528 |
url="http://en.wikipedia.org/wiki/World_Wide_Name">World Wide |
| 1529 |
Name</ulink> of the namespace or blank if unknown. |
| 1530 |
--> |
| 1531 |
<property name="WWN" type="s" access="read"/> |
| 1532 |
|
| 1533 |
<!-- LBAFormats: |
| 1534 |
@since: 2.10.0 |
| 1535 |
|
| 1536 |
List of LBA formats supported by the controller. |
| 1537 |
|
| 1538 |
This is an array of triplets of (@size, @metadata_size, @performance) where @size |
| 1539 |
denotes LBA Data Size in bytes, @metadata_size denotes the number of metadata bytes |
| 1540 |
provided per LBA and @performance indicates the relative performance relative |
| 1541 |
to other formats in the list. |
| 1542 |
|
| 1543 |
Known values for <literal>performance</literal> include: |
| 1544 |
<variablelist> |
| 1545 |
<varlistentry><term>0</term><listitem><para>Unknown relative performance index</para></listitem></varlistentry> |
| 1546 |
<varlistentry><term>1</term><listitem><para>Best performance</para></listitem></varlistentry> |
| 1547 |
<varlistentry><term>2</term><listitem><para>Better performance</para></listitem></varlistentry> |
| 1548 |
<varlistentry><term>3</term><listitem><para>Good performance</para></listitem></varlistentry> |
| 1549 |
<varlistentry><term>4</term><listitem><para>Degraded performance</para></listitem></varlistentry> |
| 1550 |
</variablelist> |
| 1551 |
--> |
| 1552 |
<property name="LBAFormats" type="a(qqy)" access="read"/> |
| 1553 |
|
| 1554 |
<!-- FormattedLBASize: |
| 1555 |
@since: 2.10.0 |
| 1556 |
|
| 1557 |
The actual LBA data size, the metadata size and the relative performance index |
| 1558 |
that the namespace has been formatted with. |
| 1559 |
|
| 1560 |
Similar to #org.freedesktop.UDisks2.NVMe.Namespace:LBAFormats this is a triplet |
| 1561 |
of (@size, @metadata_size, @performance) where @size denotes LBA Data Size |
| 1562 |
in bytes, @metadata_size denotes the number of metadata bytes provided per LBA |
| 1563 |
and @performance indicates the relative performance relative to other formats |
| 1564 |
indicated in the #org.freedesktop.UDisks2.NVMe.Namespace:LBAFormats property. |
| 1565 |
--> |
| 1566 |
<property name="FormattedLBASize" type="(qqy)" access="read"/> |
| 1567 |
|
| 1568 |
<!-- NamespaceSize: |
| 1569 |
@since: 2.10.0 |
| 1570 |
|
| 1571 |
The total size of the namespace in logical blocks. The number of logical |
| 1572 |
blocks is based on the formatted LBA size (see |
| 1573 |
#org.freedesktop.UDisks2.NVMe.Namespace:FormattedLBASize). |
| 1574 |
--> |
| 1575 |
<property name="NamespaceSize" type="t" access="read"/> |
| 1576 |
|
| 1577 |
<!-- NamespaceCapacity: |
| 1578 |
@since: 2.10.0 |
| 1579 |
|
| 1580 |
The maximum number of logical blocks that may be allocated in the namespace. |
| 1581 |
The number of logical blocks is based on the formatted LBA size (see |
| 1582 |
#org.freedesktop.UDisks2.NVMe.Namespace:FormattedLBASize). |
| 1583 |
--> |
| 1584 |
<property name="NamespaceCapacity" type="t" access="read"/> |
| 1585 |
|
| 1586 |
<!-- NamespaceUtilization: |
| 1587 |
@since: 2.10.0 |
| 1588 |
|
| 1589 |
The current number of logical blocks allocated in the namespace. This value |
| 1590 |
is less than or equal to the #org.freedesktop.UDisks2.NVMe.Namespace:NamespaceCapacity. |
| 1591 |
The number of logical blocks is based on the formatted LBA size (see |
| 1592 |
#org.freedesktop.UDisks2.NVMe.Namespace:FormattedLBASize). |
| 1593 |
--> |
| 1594 |
<property name="NamespaceUtilization" type="t" access="read"/> |
| 1595 |
|
| 1596 |
<!-- |
| 1597 |
FormatPercentRemaining: |
| 1598 |
@since: 2.10.0 |
| 1599 |
|
| 1600 |
The percent remaining of a running format operation or -1 if unknown (e.g. not reported by the drive). |
| 1601 |
--> |
| 1602 |
<property name="FormatPercentRemaining" type="i" access="read"/> |
| 1603 |
|
| 1604 |
<!-- |
| 1605 |
FormatNamespace: |
| 1606 |
@options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>lba_data_size</parameter> (of type 'q'), <parameter>metadata_size</parameter> (of type 'q') and <parameter>secure_erase</parameter> (of type 's'). |
| 1607 |
@since: 2.10.0 |
| 1608 |
|
| 1609 |
Performs low level format of the NVM media, destroying all data and metadata in the current namespace. |
| 1610 |
|
| 1611 |
The optional @lba_data_size parameter indicates the LBA Data Size in bytes to use (see the related |
| 1612 |
#org.freedesktop.UDisks2.NVMe.Namespace:LBAFormats property) and similarly the @metadata_size parameter |
| 1613 |
denotes the number of metadata bytes provided per LBA. If not specified, the current active format is used. |
| 1614 |
|
| 1615 |
The optional @secure_erase parameter can be used to perform secure erase - valid values are |
| 1616 |
<literal>user_data</literal> where the user data are overwritten by a pattern, and <literal>crypto_erase</literal> |
| 1617 |
which removes the encryption key with which the user data was previously encrypted. |
| 1618 |
|
| 1619 |
This call blocks until the format operation has finished. |
| 1620 |
--> |
| 1621 |
<method name="FormatNamespace"> |
| 1622 |
<arg name="options" direction="in" type="a{sv}"/> |
| 1623 |
</method> |
| 1624 |
|
| 1625 |
</interface> |
| 1626 |
|
| 1627 |
<!-- ********************************************************************** --> |
| 1628 |
|
| 1629 |
<!-- |
| 1630 |
org.freedesktop.UDisks2.NVMe.Fabrics: |
| 1631 |
@short_description: NVMe over Fabrics control interface |
| 1632 |
|
| 1633 |
Control interface for NVMe over Fabrics connected controllers. |
| 1634 |
--> |
| 1635 |
<interface name="org.freedesktop.UDisks2.NVMe.Fabrics"> |
| 1636 |
<!-- HostNQN: |
| 1637 |
@since: 2.10.0 |
| 1638 |
|
| 1639 |
The actual Host NQN used for the connection. |
| 1640 |
--> |
| 1641 |
<property name="HostNQN" type="ay" access="read"/> |
| 1642 |
|
| 1643 |
<!-- HostID: |
| 1644 |
@since: 2.10.0 |
| 1645 |
|
| 1646 |
The actual Host UUID used for the connection. |
| 1647 |
--> |
| 1648 |
<property name="HostID" type="ay" access="read"/> |
| 1649 |
|
| 1650 |
<!-- Transport: |
| 1651 |
@since: 2.10.0 |
| 1652 |
|
| 1653 |
The transport type the device is connected with. |
| 1654 |
|
| 1655 |
Known values include: |
| 1656 |
<variablelist> |
| 1657 |
<varlistentry><term>pcie</term><listitem><para>PCI Express Transport</para></listitem></varlistentry> |
| 1658 |
<varlistentry><term>rdma</term><listitem><para>RDMA Transport</para></listitem></varlistentry> |
| 1659 |
<varlistentry><term>fc</term><listitem><para>Fibre Channel Transport</para></listitem></varlistentry> |
| 1660 |
<varlistentry><term>tcp</term><listitem><para>TCP Transport</para></listitem></varlistentry> |
| 1661 |
<varlistentry><term>loop</term><listitem><para>Intra-host Transport (i.e., loopback)</para></listitem></varlistentry> |
| 1662 |
</variablelist> |
| 1663 |
--> |
| 1664 |
<property name="Transport" type="s" access="read"/> |
| 1665 |
|
| 1666 |
<!-- TransportAddress: |
| 1667 |
@since: 2.10.0 |
| 1668 |
|
| 1669 |
The network address of the controller. For transports using IP addressing (e.g. <literal>rdma</literal>) |
| 1670 |
this should be an IP-based address (e.g. IPv4). |
| 1671 |
--> |
| 1672 |
<property name="TransportAddress" type="ay" access="read"/> |
| 1673 |
|
| 1674 |
<!-- |
| 1675 |
Disconnect: |
| 1676 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 1677 |
@since: 2.10.0 |
| 1678 |
|
| 1679 |
Disconnects and removes the NVMe over Fabrics controller. |
| 1680 |
--> |
| 1681 |
<method name="Disconnect"> |
| 1682 |
<arg name="options" direction="in" type="a{sv}"/> |
| 1683 |
</method> |
| 1684 |
</interface> |
| 1685 |
|
| 1686 |
<!-- ********************************************************************** --> |
| 1687 |
|
| 1688 |
<!-- |
| 1689 |
org.freedesktop.UDisks2.Block: |
| 1690 |
@short_description: Block device |
| 1691 |
|
| 1692 |
This interface represents a block device. |
| 1693 |
|
| 1694 |
This should not be confused with the |
| 1695 |
#org.freedesktop.UDisks2.Drive interface that is used to represent |
| 1696 |
disk drives. For example, the #org.freedesktop.UDisks2.Block |
| 1697 |
interface is also used for block devices that do not correspond to |
| 1698 |
drives at all (e.g. <ulink |
| 1699 |
url="http://en.wikipedia.org/wiki/Loop_device">Loop |
| 1700 |
Devices</ulink>). |
| 1701 |
--> |
| 1702 |
<interface name="org.freedesktop.UDisks2.Block"> |
| 1703 |
<!-- Device: The special device file for the block device e.g. <filename>/dev/sda2</filename>. --> |
| 1704 |
<property name="Device" type="ay" access="read"/> |
| 1705 |
|
| 1706 |
<!-- PreferredDevice: |
| 1707 |
The special device file to present in the UI instead of the value |
| 1708 |
of the #org.freedesktop.UDisks2.Block:Device property. |
| 1709 |
|
| 1710 |
For example this could be |
| 1711 |
e.g. <filename>/dev/mapper/mpathk</filename> for a multipath |
| 1712 |
device with special device file <filename>/dev/dm-9</filename>. |
| 1713 |
--> |
| 1714 |
<property name="PreferredDevice" type="ay" access="read"/> |
| 1715 |
|
| 1716 |
<!-- Symlinks: |
| 1717 |
|
| 1718 |
Known symlinks in <filename>/dev</filename> that points to |
| 1719 |
the device file in the |
| 1720 |
#org.freedesktop.UDisks2.Block:Device property. |
| 1721 |
|
| 1722 |
For example, this array could include symlinks such as |
| 1723 |
<filename>/dev/disk/by-id/ata-INTEL_SSDSA2MH080G1GC_CVEM842101HD080DGN</filename> |
| 1724 |
and |
| 1725 |
<filename>/dev/disk/by-id/wwn-0x5001517387d61905</filename>. |
| 1726 |
--> |
| 1727 |
<property name="Symlinks" type="aay" access="read"/> |
| 1728 |
|
| 1729 |
<!-- DeviceNumber: The dev_t of the block device. --> |
| 1730 |
<property name="DeviceNumber" type="t" access="read"/> |
| 1731 |
|
| 1732 |
<!-- Id: |
| 1733 |
@since: 2.0.0 |
| 1734 |
A unique and persistent identifier for the device or blank if |
| 1735 |
no such identifier is available. |
| 1736 |
|
| 1737 |
For devices with fixed media, this identifier is derived from |
| 1738 |
vital product data / UUIDs / serial numbers of the drive or |
| 1739 |
construct (e.g. LVM or MD-RAID) the block device is part |
| 1740 |
of. For devices with removable media, this identifier is |
| 1741 |
derived from the medium currently inserted. |
| 1742 |
|
| 1743 |
This identifier is guaranteed to not include the slash |
| 1744 |
character '/' (U+002F SOLIDUS) which means it can be used as |
| 1745 |
a filename. |
| 1746 |
|
| 1747 |
Examples: |
| 1748 |
<quote>by-id-ata-INTEL_SSDSA2MH080G1GC_CVEM842101HD080DGN</quote>, |
| 1749 |
<quote>by-id-ata-ST1000LM024_HN-M101MBB_S2TBJA0C230233-part3</quote>, |
| 1750 |
<quote>by-id-usb-Kingston_DataTraveler_2.0_0013729940C4F9A166250D3E-0:0</quote>, |
| 1751 |
<quote>by-id-dm-name-luks-6d81fe85-26b1-4f8b-b834-405454c1cd46</quote>, |
| 1752 |
<quote>by-id-dm-name-vg_thinkpad-lv_swap</quote>, |
| 1753 |
<quote>by-label-HARRY_POTTER_SORCERERS_STONE-</quote>, |
| 1754 |
<quote>by-uuid-D22D-08B8</quote>. |
| 1755 |
--> |
| 1756 |
<property name="Id" type="s" access="read"/> |
| 1757 |
|
| 1758 |
<!-- Size: The size of the block device. --> |
| 1759 |
<property name="Size" type="t" access="read"/> |
| 1760 |
|
| 1761 |
<!-- ReadOnly: If %TRUE, the device can not be written to, only read from. --> |
| 1762 |
<property name="ReadOnly" type="b" access="read"/> |
| 1763 |
|
| 1764 |
<!-- Drive: |
| 1765 |
The #org.freedesktop.UDisks2.Drive object that the block device |
| 1766 |
belongs to, or '/' if no such object exists. |
| 1767 |
--> |
| 1768 |
<property name="Drive" type="o" access="read"/> |
| 1769 |
|
| 1770 |
<!-- MDRaid: |
| 1771 |
@since: 2.0.0 |
| 1772 |
If the block device is a running MD-RAID array, this is set |
| 1773 |
to the #org.freedesktop.UDisks2.MDRaid object that it |
| 1774 |
correspond to. Is '/' if no such object exists. |
| 1775 |
--> |
| 1776 |
<property name="MDRaid" type="o" access="read"/> |
| 1777 |
|
| 1778 |
<!-- MDRaidMember: |
| 1779 |
@since: 2.0.0 |
| 1780 |
If the block device is a member of a MD-RAID array, this |
| 1781 |
is set to the #org.freedesktop.UDisks2.MDRaid object that it |
| 1782 |
correspond to. Is '/' if no such object exists. |
| 1783 |
--> |
| 1784 |
<property name="MDRaidMember" type="o" access="read"/> |
| 1785 |
|
| 1786 |
<!-- IdUsage: |
| 1787 |
A result of probing for signatures on the block device. Known values include: |
| 1788 |
<variablelist> |
| 1789 |
<varlistentry> |
| 1790 |
<term>filesystem</term> |
| 1791 |
<listitem><para>Used for mountable filesystems</para></listitem> |
| 1792 |
</varlistentry> |
| 1793 |
<varlistentry> |
| 1794 |
<term>crypto</term> |
| 1795 |
<listitem><para>Used for e.g. LUKS devices</para></listitem> |
| 1796 |
</varlistentry> |
| 1797 |
<varlistentry> |
| 1798 |
<term>raid</term> |
| 1799 |
<listitem><para>Used for e.g. RAID members and LVM PVs</para></listitem> |
| 1800 |
</varlistentry> |
| 1801 |
<varlistentry> |
| 1802 |
<term>other</term> |
| 1803 |
<listitem><para>Something else was detected.</para></listitem> |
| 1804 |
</varlistentry> |
| 1805 |
</variablelist> |
| 1806 |
If blank, no known signature was detected. This doesn't |
| 1807 |
necessarily mean the device contains no structured data; it |
| 1808 |
only means that no signature known to the probing code was |
| 1809 |
detected. |
| 1810 |
|
| 1811 |
Applications should not rely on the value in this or the |
| 1812 |
#org.freedesktop.UDisks2.Block:IdType property - instead, |
| 1813 |
applications should check for whether the object in question |
| 1814 |
implements interfaces such as |
| 1815 |
e.g. #org.freedesktop.UDisks2.Filesystem, |
| 1816 |
#org.freedesktop.UDisks2.Swapspace or |
| 1817 |
#org.freedesktop.UDisks2.Encrypted. |
| 1818 |
--> |
| 1819 |
<property name="IdUsage" type="s" access="read"/> |
| 1820 |
|
| 1821 |
<!-- |
| 1822 |
IdType: |
| 1823 |
This property contains more information about the result of |
| 1824 |
probing the block device. Its value depends of the value the |
| 1825 |
#org.freedesktop.UDisks2.Block:IdUsage property: |
| 1826 |
<variablelist> |
| 1827 |
<varlistentry><term>filesystem</term> |
| 1828 |
<listitem><para>The mountable file system that was detected (e.g. <literal>vfat</literal>).</para></listitem> |
| 1829 |
</varlistentry> |
| 1830 |
<varlistentry><term>crypto</term> |
| 1831 |
<listitem><para>Encrypted data. Known values include <literal>crypto_LUKS</literal>.</para></listitem> |
| 1832 |
</varlistentry> |
| 1833 |
<varlistentry><term>raid</term> |
| 1834 |
<listitem><para><ulink url="http://en.wikipedia.org/wiki/RAID">RAID</ulink> or similar. Known values include <literal>LVM2_member</literal> (for LVM2 components), <literal>linux_raid_member</literal> (for MD-RAID components.)</para></listitem> |
| 1835 |
</varlistentry> |
| 1836 |
<varlistentry><term>other</term> |
| 1837 |
<listitem><para>Something else. Known values include <literal>swap</literal> (for swap space), <literal>suspend</literal> (data used when resuming from suspend-to-disk).</para></listitem> |
| 1838 |
</varlistentry> |
| 1839 |
</variablelist> |
| 1840 |
See the note for the #org.freedesktop.UDisks2.Block:IdUsage property about usage. |
| 1841 |
--> |
| 1842 |
<property name="IdType" type="s" access="read"/> |
| 1843 |
|
| 1844 |
<!-- IdVersion: |
| 1845 |
The version of the filesystem or other structured data on the block device. |
| 1846 |
Do not make any assumptions about the format. |
| 1847 |
|
| 1848 |
This property is blank if there is no version or the version is unknown. |
| 1849 |
--> |
| 1850 |
<property name="IdVersion" type="s" access="read"/> |
| 1851 |
<!-- IdLabel: |
| 1852 |
The label of the filesystem or other structured data on the block device. |
| 1853 |
|
| 1854 |
This property is blank if there is no label or the label is unknown. |
| 1855 |
--> |
| 1856 |
<property name="IdLabel" type="s" access="read"/> |
| 1857 |
<!-- IdUUID: |
| 1858 |
The <ulink url="http://en.wikipedia.org/wiki/UUID">UUID</ulink> of the |
| 1859 |
filesystem or other structured data on the block device. Do not make |
| 1860 |
any assumptions about the UUID as its format depends on what kind of |
| 1861 |
data is on the device. |
| 1862 |
|
| 1863 |
This property is blank if there is no UUID or the UUID is unknown. |
| 1864 |
--> |
| 1865 |
<property name="IdUUID" type="s" access="read"/> |
| 1866 |
|
| 1867 |
<!-- Configuration: |
| 1868 |
The configuration for the device. |
| 1869 |
|
| 1870 |
This is an array of pairs of (@type, @details) where @type is |
| 1871 |
a string identifying the configuration source |
| 1872 |
(e.g. <literal>fstab</literal>) and @details contains the |
| 1873 |
actual configuration data. |
| 1874 |
|
| 1875 |
Use the |
| 1876 |
org.freedesktop.UDisks2.Block.AddConfigurationItem(), |
| 1877 |
org.freedesktop.UDisks2.Block.RemoveConfigurationItem() |
| 1878 |
and |
| 1879 |
org.freedesktop.UDisks2.Block.UpdateConfigurationItem() |
| 1880 |
methods to add, remove and update configuration items. |
| 1881 |
|
| 1882 |
Use |
| 1883 |
org.freedesktop.UDisks2.Block.GetSecretConfiguration() |
| 1884 |
to get the secrets (e.g. passphrases) that may be part of the |
| 1885 |
configuration but isn't exported in this property for |
| 1886 |
security reasons. |
| 1887 |
|
| 1888 |
For entries of type <literal>fstab</literal>, it means that |
| 1889 |
the block device is referenced in the system-wide |
| 1890 |
<filename>/etc/fstab</filename> file. Known configuration |
| 1891 |
items for type <literal>fstab</literal> are |
| 1892 |
<variablelist> |
| 1893 |
<varlistentry> |
| 1894 |
<term>fsname (type <literal>'ay'</literal>)</term> |
| 1895 |
<listitem><para>The special device</para></listitem> |
| 1896 |
</varlistentry> |
| 1897 |
<varlistentry> |
| 1898 |
<term>dir (type <literal>'ay'</literal>)</term> |
| 1899 |
<listitem><para>The mount point</para></listitem> |
| 1900 |
</varlistentry> |
| 1901 |
<varlistentry> |
| 1902 |
<term>type (type <literal>'ay'</literal>)</term> |
| 1903 |
<listitem><para>The filesystem type</para></listitem> |
| 1904 |
</varlistentry> |
| 1905 |
<varlistentry> |
| 1906 |
<term>opts (type <literal>'ay'</literal>)</term> |
| 1907 |
<listitem><para>Options</para></listitem> |
| 1908 |
</varlistentry> |
| 1909 |
<varlistentry> |
| 1910 |
<term>freq (type <literal>'i'</literal>)</term> |
| 1911 |
<listitem><para>Dump frequency in days</para></listitem> |
| 1912 |
</varlistentry> |
| 1913 |
<varlistentry> |
| 1914 |
<term>passno (type <literal>'i'</literal>)</term> |
| 1915 |
<listitem><para>Pass number of parallel fsck</para></listitem> |
| 1916 |
</varlistentry> |
| 1917 |
</variablelist> |
| 1918 |
|
| 1919 |
For entries of type <literal>crypttab</literal>, it means that |
| 1920 |
the block device is referenced in the system-wide |
| 1921 |
<filename>/etc/crypttab</filename> file. Known configuration |
| 1922 |
items for type <literal>crypttab</literal> are |
| 1923 |
<variablelist> |
| 1924 |
<varlistentry> |
| 1925 |
<term>name (type <literal>'ay'</literal>)</term> |
| 1926 |
<listitem><para>The name to set the device up as</para></listitem> |
| 1927 |
</varlistentry> |
| 1928 |
<varlistentry> |
| 1929 |
<term>device (type <literal>'ay'</literal>)</term> |
| 1930 |
<listitem><para>The special device</para></listitem> |
| 1931 |
</varlistentry> |
| 1932 |
<varlistentry> |
| 1933 |
<term>passphrase-path (type <literal>'ay'</literal>)</term> |
| 1934 |
<listitem><para>Either empty to specify that no password is set, |
| 1935 |
otherwise a path to a file containing the encryption password. |
| 1936 |
This may also point to a special device file in <filename>/dev</filename> |
| 1937 |
such as <literal>/dev/random</literal>. |
| 1938 |
</para></listitem> |
| 1939 |
</varlistentry> |
| 1940 |
<varlistentry> |
| 1941 |
<term>passphrase-contents (type <literal>'ay'</literal>)</term> |
| 1942 |
<listitem><para>The contents of the file containing the encryption password, if applicable. |
| 1943 |
This is only available via the org.freedesktop.UDisks2.Block.GetSecretConfiguration() |
| 1944 |
method.</para></listitem> |
| 1945 |
</varlistentry> |
| 1946 |
<varlistentry> |
| 1947 |
<term>options (type <literal>'ay'</literal>)</term> |
| 1948 |
<listitem><para>Options</para></listitem> |
| 1949 |
</varlistentry> |
| 1950 |
</variablelist> |
| 1951 |
For security reasons, when creating a new |
| 1952 |
<literal>crypttab</literal> entry (via the |
| 1953 |
org.freedesktop.UDisks2.Block.AddConfigurationItem() |
| 1954 |
method), then the <option>passphrase-path</option> must |
| 1955 |
reference an unexisting file in the |
| 1956 |
<filename>/etc/luks-keys</filename> directory. |
| 1957 |
--> |
| 1958 |
<property name="Configuration" type="a(sa{sv})" access="read"/> |
| 1959 |
|
| 1960 |
<!-- CryptoBackingDevice: |
| 1961 |
The #org.freedesktop.UDisks2.Block object that is |
| 1962 |
backing the device or <literal>/</literal> if unknown or if |
| 1963 |
the block device is not the cleartext device for an encrypted |
| 1964 |
device. |
| 1965 |
--> |
| 1966 |
<property name="CryptoBackingDevice" type="o" access="read"/> |
| 1967 |
|
| 1968 |
<!-- HintPartitionable: |
| 1969 |
If %TRUE, the device is normally expected to be |
| 1970 |
partitionable. Devices for which this is not the case include |
| 1971 |
floppy drives, optical drives and LVM logical volumes. |
| 1972 |
--> |
| 1973 |
<property name="HintPartitionable" type="b" access="read"/> |
| 1974 |
|
| 1975 |
<!-- HintSystem: If %TRUE, the device is considered a <emphasis>system device</emphasis>. |
| 1976 |
System devices are devices that require additional permissions to access. |
| 1977 |
|
| 1978 |
See <xref linkend="udisks.8"/> for how to influence the value of this property. |
| 1979 |
--> |
| 1980 |
<property name="HintSystem" type="b" access="read"/> |
| 1981 |
|
| 1982 |
<!-- HintIgnore: If %TRUE, the device should be hidden from users. |
| 1983 |
|
| 1984 |
See <xref linkend="udisks.8"/> for how to influence the value of this property. |
| 1985 |
--> |
| 1986 |
<property name="HintIgnore" type="b" access="read"/> |
| 1987 |
|
| 1988 |
<!-- HintAuto: If %TRUE, the device should be automatically started (e.g. mounted, unlocked etc.). |
| 1989 |
|
| 1990 |
See <xref linkend="udisks.8"/> for how to influence the value of this property. |
| 1991 |
--> |
| 1992 |
<property name="HintAuto" type="b" access="read"/> |
| 1993 |
|
| 1994 |
<!-- HintName: If not blank, the name to use when presenting the device. |
| 1995 |
|
| 1996 |
See <xref linkend="udisks.8"/> for how to influence the value of this property. |
| 1997 |
--> |
| 1998 |
<property name="HintName" type="s" access="read"/> |
| 1999 |
|
| 2000 |
<!-- HintIconName: If not blank, the icon name to use when presenting the device. |
| 2001 |
The name must adhere to the |
| 2002 |
<ulink url="http://www.freedesktop.org/wiki/Specifications/icon-theme-spec">freedesktop.org icon theme specification</ulink>. |
| 2003 |
|
| 2004 |
See <xref linkend="udisks.8"/> for how to influence the value of this property. |
| 2005 |
--> |
| 2006 |
<property name="HintIconName" type="s" access="read"/> |
| 2007 |
|
| 2008 |
<!-- HintSymbolicIconName: |
| 2009 |
@since: 2.0.0 |
| 2010 |
If not blank, the icon name to use when presenting the device using a symbolic icon. |
| 2011 |
|
| 2012 |
The name must adhere to the |
| 2013 |
<ulink url="http://www.freedesktop.org/wiki/Specifications/icon-theme-spec">freedesktop.org icon theme specification</ulink>. |
| 2014 |
|
| 2015 |
See <xref linkend="udisks.8"/> for how to influence the value of this property. |
| 2016 |
--> |
| 2017 |
<property name="HintSymbolicIconName" type="s" access="read"/> |
| 2018 |
|
| 2019 |
<!-- UserspaceMountOptions: List of userspace mount options. --> |
| 2020 |
<property name="UserspaceMountOptions" type="as" access="read"/> |
| 2021 |
|
| 2022 |
<!-- |
| 2023 |
AddConfigurationItem: |
| 2024 |
@item: The configuration item to add. |
| 2025 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 2026 |
|
| 2027 |
Adds a new configuration item. |
| 2028 |
|
| 2029 |
See the #org.freedesktop.UDisks2.Block:Configuration |
| 2030 |
property for details about valid configuration items. |
| 2031 |
|
| 2032 |
Some fields can be omitted and will then receive default |
| 2033 |
values. This is useful when passing configuration items to |
| 2034 |
Format, for example, because the proper values are not known |
| 2035 |
before the formatting is done. |
| 2036 |
|
| 2037 |
If 'fsname' is omitted in a 'fstab' entry, or 'device' is |
| 2038 |
omitted in a 'crypttab' entry, it defaults to "UUID=..." when |
| 2039 |
the block device has a filesystem UUID, or to the name of the |
| 2040 |
device in the filesystem. |
| 2041 |
|
| 2042 |
If 'name' is omitted in a 'crypttab' entry, it defaults to |
| 2043 |
"luks-<UUID>". |
| 2044 |
|
| 2045 |
If 'passphrase-path' is omitted, it defaults to |
| 2046 |
"/etc/luks-keys/<NAME>". |
| 2047 |
|
| 2048 |
If 'track-parents' is set to true in @item, then the 'opts' |
| 2049 |
and 'options' fields will be augmented with "x-parent" |
| 2050 |
elements, as appropriate. This will make @item appear in the |
| 2051 |
ChildConfiguration properties, and will allow the 'tear-down' |
| 2052 |
option of Format, DeletePartition, and other methods to remove |
| 2053 |
this item reliably. |
| 2054 |
--> |
| 2055 |
<method name="AddConfigurationItem"> |
| 2056 |
<arg name="item" direction="in" type="(sa{sv})"/> |
| 2057 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2058 |
</method> |
| 2059 |
|
| 2060 |
<!-- |
| 2061 |
RemoveConfigurationItem: |
| 2062 |
@item: The configuration item to remove. |
| 2063 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 2064 |
|
| 2065 |
Removes an existing configuration item. |
| 2066 |
|
| 2067 |
See the #org.freedesktop.UDisks2.Block:Configuration |
| 2068 |
property for details about valid configuration items. |
| 2069 |
--> |
| 2070 |
<method name="RemoveConfigurationItem"> |
| 2071 |
<arg name="item" direction="in" type="(sa{sv})"/> |
| 2072 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2073 |
</method> |
| 2074 |
|
| 2075 |
<!-- |
| 2076 |
UpdateConfigurationItem: |
| 2077 |
@old_item: The configuration item to remove. |
| 2078 |
@new_item: The configuration item to add. Must be of the same type as @old_item. |
| 2079 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 2080 |
|
| 2081 |
Removes a configuration item and adds a new one. This is |
| 2082 |
equivalent to calling |
| 2083 |
org.freedesktop.UDisks2.Block.RemoveConfigurationItem() |
| 2084 |
followed by |
| 2085 |
org.freedesktop.UDisks2.Block.AddConfigurationItem() |
| 2086 |
with the change that only one PolicyKit check is made |
| 2087 |
and that @new_item can be validated against @old_item. |
| 2088 |
|
| 2089 |
See the #org.freedesktop.UDisks2.Block:Configuration |
| 2090 |
property for details about valid configuration items. |
| 2091 |
--> |
| 2092 |
<method name="UpdateConfigurationItem"> |
| 2093 |
<arg name="old_item" direction="in" type="(sa{sv})"/> |
| 2094 |
<arg name="new_item" direction="in" type="(sa{sv})"/> |
| 2095 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2096 |
</method> |
| 2097 |
|
| 2098 |
<!-- |
| 2099 |
GetSecretConfiguration: |
| 2100 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 2101 |
@configuration: The resulting configuration. |
| 2102 |
|
| 2103 |
Returns the same value as in the |
| 2104 |
#org.freedesktop.UDisks2.Block:Configuration property |
| 2105 |
but without secret information filtered out. |
| 2106 |
--> |
| 2107 |
<method name="GetSecretConfiguration"> |
| 2108 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2109 |
<arg name="configuration" direction="out" type="a(sa{sv})"/> |
| 2110 |
</method> |
| 2111 |
|
| 2112 |
<!-- |
| 2113 |
Format: |
| 2114 |
@type: The type of file system, partition table or other content to format the device with. |
| 2115 |
@options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>label</parameter> (of type 's'), <parameter>uuid</parameter> (of type 's'), <parameter>take-ownership</parameter> (of type 'b'), <parameter>encrypt.passphrase</parameter> (of type 's' or 'ay'), <parameter>encrypt.type</parameter> (of type 's'), <parameter>encrypt.label</parameter> (of type 's'), <parameter>encrypt.pbkdf</parameter> (of type 's'), <parameter>encrypt.memory</parameter> (of type 'u'), <parameter>encrypt.iterations</parameter> (of type 'u'), <parameter>encrypt.time</parameter> (of type 'u'), <parameter>encrypt.threads</parameter> (of type 'u'), <parameter>erase</parameter> (of type 's'), <parameter>mkfs-args</parameter> (of type 'as'), <parameter>no-block</parameter> (of type 'b') and <parameter>update-partition-type</parameter> (of type 'b'). |
| 2116 |
|
| 2117 |
Formats the device with a file system, partition table or |
| 2118 |
other well-known content. |
| 2119 |
|
| 2120 |
Known values for @type includes <constant>empty</constant> (to |
| 2121 |
just zero out areas of the device known to host file system |
| 2122 |
signatures) and <constant>swap</constant> (Linux swap space) |
| 2123 |
and most file systems supported by the <citerefentry><refentrytitle>mkfs</refentrytitle><manvolnum>8</manvolnum></citerefentry> |
| 2124 |
program through its <option>-t</option> option. |
| 2125 |
|
| 2126 |
Known partition table formats includes |
| 2127 |
<constant>dos</constant> and <constant>gpt</constant>. |
| 2128 |
|
| 2129 |
If @type supports it, you can specify a label with the |
| 2130 |
<parameter>label</parameter> option in the @options parameter; |
| 2131 |
however, note that this may not be supported on all file |
| 2132 |
systems and, if supported, the maximum allowed length may |
| 2133 |
vary. Similarly, you can specify filesystem UUID with the |
| 2134 |
<parameter>uuid</parameter> option in the @options parameter |
| 2135 |
given that the particular filesystem type supports this feature. |
| 2136 |
The format of the UUID string should match the #org.freedesktop.UDisks2.Block:IdUUID |
| 2137 |
property. |
| 2138 |
|
| 2139 |
If the file system in question supports owners and the option |
| 2140 |
<parameter>take-ownership</parameter> is set to %TRUE then the |
| 2141 |
root directory of the created file system will be owned by the |
| 2142 |
caller of this method. |
| 2143 |
|
| 2144 |
If the option <parameter>encrypt.passphrase</parameter> is |
| 2145 |
given then a LUKS device is created with the given passphrase |
| 2146 |
and the file system is created on the unlocked device. The |
| 2147 |
unlocked device will be left open. This parameter can be used |
| 2148 |
to supply the binary contents of an arbitrary keyfile by passing |
| 2149 |
a value of type <quote>ay</quote>. |
| 2150 |
Option <parameter>encrypt.type</parameter> can be used to |
| 2151 |
specify encryption "technology" that will be used. Currently |
| 2152 |
only <quote>luks1</quote> and <quote>luks2</quote> are supported. |
| 2153 |
Option <parameter>encrypt.label</parameter> can be used to specify |
| 2154 |
label for the LUKS format. |
| 2155 |
Following additional options for LUKS key derivation function can |
| 2156 |
be used: |
| 2157 |
|
| 2158 |
<variablelist> |
| 2159 |
<varlistentry><term>encrypt.pbkdf</term> |
| 2160 |
<listitem><para>key derivation function, one of "pbkdf2", "argon2i", "argon2id"</para></listitem> |
| 2161 |
</varlistentry> |
| 2162 |
<varlistentry><term>encrypt.iterations</term> |
| 2163 |
<listitem><para>number of iterations for PBKDF</para></listitem> |
| 2164 |
</varlistentry> |
| 2165 |
<varlistentry><term>encrypt.memory</term> |
| 2166 |
<listitem><para>memory cost in KiB for Argon2</para></listitem> |
| 2167 |
</varlistentry> |
| 2168 |
<varlistentry><term>encrypt.time</term> |
| 2169 |
<listitem><para>time cost for PBKDF in ms</para></listitem> |
| 2170 |
</varlistentry> |
| 2171 |
<varlistentry><term>encrypt.threads</term> |
| 2172 |
<listitem><para>parallel cost for PBKDF (number of threads, up to 4)</para></listitem> |
| 2173 |
</varlistentry> |
| 2174 |
</variablelist> |
| 2175 |
|
| 2176 |
If the option <parameter>erase</parameter> is used then the |
| 2177 |
underlying device will be erased. Valid values include |
| 2178 |
<quote>zero</quote> to write zeroes over the entire device |
| 2179 |
before formatting, <quote>ata-secure-erase</quote> to perform |
| 2180 |
a secure erase or <quote>ata-secure-erase-enhanced</quote> to |
| 2181 |
perform an enhanced secure erase. |
| 2182 |
|
| 2183 |
If the option <parameter>update-partition-type</parameter> is |
| 2184 |
set to %TRUE and the object in question is a partition, then |
| 2185 |
its type (cf. the #org.freedesktop.UDisks2.Partition:Type |
| 2186 |
property) will be set to the <emphasis>natural</emphasis> |
| 2187 |
partition type matching @type, if any. For example, if |
| 2188 |
formatting a GPT partition with a FAT filesystem, the |
| 2189 |
<quote>Microsoft Basic Data</quote> partition type will be |
| 2190 |
chosen; similar, if formatting a DOS partition with a Ext4 |
| 2191 |
filesystem then partition type 0x83 is chosen. |
| 2192 |
|
| 2193 |
If the option <parameter>no-block</parameter> is set to %TRUE |
| 2194 |
then the method returns just before the actual formatting |
| 2195 |
takes place but after authorization and other checks are |
| 2196 |
done. This is useful for applications that want to format |
| 2197 |
several devices in parallel. |
| 2198 |
|
| 2199 |
If the option <parameter>dry-run-first</parameter> is set to |
| 2200 |
%TRUE then a dry run of the formatting command is performed |
| 2201 |
first, if UDisks knows how to do that. The idea is that |
| 2202 |
this allows a deeper check of the parameters even when |
| 2203 |
<parameter>no-block</parameter> is %TRUE. Note that the block |
| 2204 |
device has already been modified (wiped) when the dry run |
| 2205 |
check is called. |
| 2206 |
|
| 2207 |
If the option <parameter>mkfs-args</parameter> is set then the |
| 2208 |
caller can provide a list of additional command-line arguments |
| 2209 |
that will be passed to the mkfs program. The arguments |
| 2210 |
specified in this way are not validated by UDisks, and the |
| 2211 |
user is responsible for making sure that the available mkfs |
| 2212 |
program for that filesystem supports them and that they work |
| 2213 |
for the intended purpose. Note that UDisks can also pass its |
| 2214 |
own additional arguments to mkfs, and they may vary between |
| 2215 |
releases, with no guarantees of stability in this regard. The |
| 2216 |
position in which the user-provided arguments are appended to |
| 2217 |
the final mkfs command line is also not defined. Because of |
| 2218 |
all this, <parameter>mkfs-args</parameter> should only be used |
| 2219 |
as a last resort when no other dedicated option is available. |
| 2220 |
|
| 2221 |
If the option <parameter>no-discard</parameter> is set to |
| 2222 |
%TRUE then Udisks tells the formatting utility not to issue |
| 2223 |
BLKDISCARD ioctls. |
| 2224 |
|
| 2225 |
If the option <parameter>config-items</parameter> is set, it |
| 2226 |
should be an array of configuration items suitable for |
| 2227 |
org.freedesktop.UDisks2.Block.AddConfigurationItem. They will |
| 2228 |
all be added after the formatting is done. |
| 2229 |
|
| 2230 |
If the option <parameter>tear-down</parameter> is set to |
| 2231 |
%TRUE, then the block device and all its children will be |
| 2232 |
cleaned up before formatting. This cleanup consists of |
| 2233 |
removing entries from /etc/fstab and /etc/crypttab, and |
| 2234 |
locking of encrypted block devices. Entries in /etc/fstab and |
| 2235 |
/etc/crypttab that have been created with the 'track-parents' |
| 2236 |
options to AddConfigurationItem will be removed even if their |
| 2237 |
block device is currently unavailable. |
| 2238 |
|
| 2239 |
Note that if the operation fails the block device may be left |
| 2240 |
in an inconsistent state. In cases of removing partition table |
| 2241 |
and failed operation it's advised to validate the device e.g. |
| 2242 |
by re-reading the partition table or force-wiping it before |
| 2243 |
performing further operations. |
| 2244 |
|
| 2245 |
In case the <parameter>tear-down</parameter> option is not set |
| 2246 |
and the block device being formatted is partitioned and |
| 2247 |
contains mounted filesystem or an active layered structure |
| 2248 |
inside then the Format operation may not fail, yet could still |
| 2249 |
overwrite nested foreign data regions. It is the caller |
| 2250 |
responsibility to ensure the device is ready for destructive |
| 2251 |
operations. This may be subject to further restrictions |
| 2252 |
in the future. |
| 2253 |
--> |
| 2254 |
<method name="Format"> |
| 2255 |
<arg name="type" direction="in" type="s"/> |
| 2256 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2257 |
</method> |
| 2258 |
|
| 2259 |
<!-- |
| 2260 |
OpenForBackup: |
| 2261 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 2262 |
@fd: An index for the returned file descriptor. |
| 2263 |
|
| 2264 |
Gets a read-only file descriptor for the device intended for a |
| 2265 |
byte-by-byte imaging of the device. This can only be done if |
| 2266 |
the device is not already in use. |
| 2267 |
|
| 2268 |
<emphasis>This method is deprecated since 2.7.3.</emphasis> |
| 2269 |
Use org.freedesktop.UDisks2.Block.OpenDevice() with <literal>O_EXCL</literal> |
| 2270 |
and <literal>O_CLOEXEC</literal> flags instead. |
| 2271 |
--> |
| 2272 |
<method name="OpenForBackup"> |
| 2273 |
<annotation name="org.gtk.GDBus.C.UnixFD" value="1"/> |
| 2274 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2275 |
<arg name="fd" direction="out" type="h"/> |
| 2276 |
</method> |
| 2277 |
|
| 2278 |
<!-- |
| 2279 |
OpenForRestore: |
| 2280 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 2281 |
@fd: An index for the returned file descriptor. |
| 2282 |
|
| 2283 |
Gets a writable file descriptor for the device intended for a |
| 2284 |
byte-by-byte restore of a disk image onto the device. This can |
| 2285 |
only be done if the device is not already in use. |
| 2286 |
|
| 2287 |
<emphasis>This method is deprecated since 2.7.3.</emphasis> |
| 2288 |
Use org.freedesktop.UDisks2.Block.OpenDevice() with <literal>O_EXCL</literal>, |
| 2289 |
<literal>O_SYNC</literal> and <literal>O_CLOEXEC</literal> flags instead. |
| 2290 |
|
| 2291 |
--> |
| 2292 |
<method name="OpenForRestore"> |
| 2293 |
<annotation name="org.gtk.GDBus.C.UnixFD" value="1"/> |
| 2294 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2295 |
<arg name="fd" direction="out" type="h"/> |
| 2296 |
</method> |
| 2297 |
|
| 2298 |
<!-- |
| 2299 |
OpenForBenchmark: |
| 2300 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 2301 |
@fd: An index for the returned file descriptor. |
| 2302 |
|
| 2303 |
Gets a file descriptor for the device that is suitable to be |
| 2304 |
used for benchmarking the device (transfer rate, access time |
| 2305 |
etc.). Note that the file descriptor may be opened with the |
| 2306 |
<literal>O_DIRECT</literal> and <literal>O_SYNC</literal> |
| 2307 |
flags so care must be taken to only perform block-aligned I/O. |
| 2308 |
|
| 2309 |
If the <parameter>writable</parameter> in @options is %TRUE |
| 2310 |
then the returned file descriptor will be writable. This only |
| 2311 |
works if the device is not already in use. |
| 2312 |
|
| 2313 |
<emphasis>This method is deprecated since 2.7.3.</emphasis> |
| 2314 |
Use org.freedesktop.UDisks2.Block.OpenDevice() with <literal>O_DIRECT</literal>, |
| 2315 |
<literal>O_SYNC</literal> and <literal>O_CLOEXEC</literal> flags instead. |
| 2316 |
--> |
| 2317 |
<method name="OpenForBenchmark"> |
| 2318 |
<annotation name="org.gtk.GDBus.C.UnixFD" value="1"/> |
| 2319 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2320 |
<arg name="fd" direction="out" type="h"/> |
| 2321 |
</method> |
| 2322 |
|
| 2323 |
<!-- |
| 2324 |
OpenDevice: |
| 2325 |
@options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>flags</parameter> (of type 'i') |
| 2326 |
@mode: Mode: "r" for read-only, "w" for write-only or "rw" for read-write |
| 2327 |
@fd: An index for the returned file descriptor. |
| 2328 |
@since: 2.7.3 |
| 2329 |
|
| 2330 |
Option <parameter>flags</parameter> can be used to specify additional flags. |
| 2331 |
See <literal>man 2 open</literal> for list of supported flags. |
| 2332 |
<literal>O_RDONLY</literal>, <literal>O_WRONLY</literal> and |
| 2333 |
<literal>O_RDWR</literal> are not allowed, use @mode instead. |
| 2334 |
|
| 2335 |
Gets a file descriptor for the device. |
| 2336 |
--> |
| 2337 |
<method name="OpenDevice"> |
| 2338 |
<annotation name="org.gtk.GDBus.C.UnixFD" value="1"/> |
| 2339 |
<arg name="mode" direction="in" type="s"/> |
| 2340 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2341 |
<arg name="fd" direction="out" type="h"/> |
| 2342 |
</method> |
| 2343 |
|
| 2344 |
<!-- |
| 2345 |
Rescan: |
| 2346 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 2347 |
|
| 2348 |
Request that the kernel and core OS rescans the contents of |
| 2349 |
the device and update their state to reflect this (including |
| 2350 |
things such as the <filename>/dev/disk/</filename> hierarchy |
| 2351 |
of symlinks). This includes requesting that the kernel |
| 2352 |
re-reads the partition table, if appropriate. |
| 2353 |
|
| 2354 |
This is usually not needed since the OS automatically does |
| 2355 |
this when the last process with a writable file descriptor for |
| 2356 |
the device closes it. |
| 2357 |
--> |
| 2358 |
<method name="Rescan"> |
| 2359 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2360 |
</method> |
| 2361 |
|
| 2362 |
<!-- |
| 2363 |
RestoreEncryptedHeader: |
| 2364 |
@backup_file: Path from where to backup header and keyslots. |
| 2365 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 2366 |
@since: 2.11.0 |
| 2367 |
|
| 2368 |
Writes header and keyslots from the specified file to the specified device. |
| 2369 |
The specified file must exist. |
| 2370 |
--> |
| 2371 |
<method name="RestoreEncryptedHeader"> |
| 2372 |
<arg name="backup_file" direction="in" type="s"/> |
| 2373 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2374 |
</method> |
| 2375 |
|
| 2376 |
</interface> |
| 2377 |
|
| 2378 |
<!-- ********************************************************************** --> |
| 2379 |
|
| 2380 |
<!-- |
| 2381 |
org.freedesktop.UDisks2.PartitionTable: |
| 2382 |
@short_description: Block device containing a partition table |
| 2383 |
|
| 2384 |
This interface is used for #org.freedesktop.UDisks2.Block |
| 2385 |
devices that contain a partition table. |
| 2386 |
--> |
| 2387 |
<interface name="org.freedesktop.UDisks2.PartitionTable"> |
| 2388 |
<!-- prereq: org.freedesktop.UDisks2.Block --> |
| 2389 |
|
| 2390 |
<!-- Partitions: List of object paths of the #org.freedesktop.UDisks2.Partition |
| 2391 |
objects that belongs to this partition table. |
| 2392 |
@since: 2.7.2 |
| 2393 |
--> |
| 2394 |
<property name="Partitions" type="ao" access="read"/> |
| 2395 |
|
| 2396 |
<!-- Type: The type of partition table detected. |
| 2397 |
Known values include: |
| 2398 |
<variablelist> |
| 2399 |
<varlistentry><term>dos</term><listitem><para><ulink url="http://en.wikipedia.org/wiki/Master_Boot_Record">Master Boot Record</ulink></para></listitem></varlistentry> |
| 2400 |
<varlistentry><term>gpt</term><listitem><para><ulink url="http://en.wikipedia.org/wiki/GUID_Partition_Table">GUID Partition Table</ulink></para></listitem></varlistentry> |
| 2401 |
</variablelist> |
| 2402 |
If blank it means that a partition table was detected but its |
| 2403 |
scheme is unknown. |
| 2404 |
--> |
| 2405 |
<property name="Type" type="s" access="read"/> |
| 2406 |
|
| 2407 |
<!-- |
| 2408 |
CreatePartition: |
| 2409 |
@offset: The desired offset where the partition should be created, in bytes. |
| 2410 |
@size: The desired size of the partition, in bytes (0 for maximal size). |
| 2411 |
@type: The type of partition to create (cf. the #org.freedesktop.UDisks2.Partition:Type property) or blank to use the default for the partition table type and OS. |
| 2412 |
@name: The name for the new partition or blank if the partition table do not support names. |
| 2413 |
@options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) include <parameter>partition-type</parameter> (of type 's') and <parameter>partition-uuid</parameter> (of type 's'). |
| 2414 |
@created_partition: An object path to the created block device object implementing the #org.freedesktop.UDisks2.Partition interface. |
| 2415 |
|
| 2416 |
Creates a new partition. |
| 2417 |
|
| 2418 |
Note that the created partition won't necessarily be created |
| 2419 |
at the exact @offset but slightly behind due to disk geometry |
| 2420 |
and other alignment constraints (e.g. 1MiB alignment). |
| 2421 |
|
| 2422 |
The newly created partition may also end up being slightly |
| 2423 |
larger than the requested @size bytes for the same reasons. |
| 2424 |
The maximal size can be automatically set by using 0 as size. |
| 2425 |
|
| 2426 |
For <literal>dos</literal> partition tables, the partition type can be |
| 2427 |
set with the @partition-type option. Possible values are: "primary", |
| 2428 |
"extended" or "logical". |
| 2429 |
|
| 2430 |
An optional parameter <parameter>partition-uuid</parameter> denotes |
| 2431 |
the partition UUID to set for the newly created partition (GPT only). |
| 2432 |
|
| 2433 |
The newly created partition will be wiped of known filesystem |
| 2434 |
signatures using the |
| 2435 |
<citerefentry><refentrytitle>wipefs</refentrytitle><manvolnum>8</manvolnum></citerefentry> |
| 2436 |
command. |
| 2437 |
--> |
| 2438 |
<method name="CreatePartition"> |
| 2439 |
<arg name="offset" direction="in" type="t"/> |
| 2440 |
<arg name="size" direction="in" type="t"/> |
| 2441 |
<arg name="type" direction="in" type="s"/> |
| 2442 |
<arg name="name" direction="in" type="s"/> |
| 2443 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2444 |
<arg name="created_partition" direction="out" type="o"/> |
| 2445 |
</method> |
| 2446 |
|
| 2447 |
<!-- |
| 2448 |
CreatePartitionAndFormat: |
| 2449 |
@offset: The desired offset where the partition should be created, in bytes. |
| 2450 |
@size: The desired size of the partition, in bytes (0 for maximal size). |
| 2451 |
@type: The type of partition to create (cf. the #org.freedesktop.UDisks2.Partition:Type property) or blank to use the default for the partition table type and OS. |
| 2452 |
@name: The name for the new partition or blank if the partition table do not support names. |
| 2453 |
@options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) include <parameter>partition-type</parameter> (of type 's') and <parameter>partition-uuid</parameter> (of type 's'). |
| 2454 |
@created_partition: An object path to the created block device object implementing the #org.freedesktop.UDisks2.Partition interface. |
| 2455 |
@format_type: The type to use for Format. |
| 2456 |
@format_options: Options for Format. |
| 2457 |
|
| 2458 |
This is a combination of |
| 2459 |
#org.freedesktop.UDisks2.PartitionTable:CreatePartition and |
| 2460 |
#org.freedesktop.UDisks2.Block:Format. After creating the |
| 2461 |
partition, the resulting block device is formatted. |
| 2462 |
--> |
| 2463 |
<method name="CreatePartitionAndFormat"> |
| 2464 |
<arg name="offset" direction="in" type="t"/> |
| 2465 |
<arg name="size" direction="in" type="t"/> |
| 2466 |
<arg name="type" direction="in" type="s"/> |
| 2467 |
<arg name="name" direction="in" type="s"/> |
| 2468 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2469 |
<arg name="format_type" direction="in" type="s"/> |
| 2470 |
<arg name="format_options" direction="in" type="a{sv}"/> |
| 2471 |
<arg name="created_partition" direction="out" type="o"/> |
| 2472 |
</method> |
| 2473 |
|
| 2474 |
</interface> |
| 2475 |
|
| 2476 |
<!-- ********************************************************************** --> |
| 2477 |
|
| 2478 |
<!-- |
| 2479 |
org.freedesktop.UDisks2.Partition: |
| 2480 |
@short_description: Block device representing a partition |
| 2481 |
|
| 2482 |
This interface is used for #org.freedesktop.UDisks2.Block |
| 2483 |
devices that represent entries in a partition table. |
| 2484 |
--> |
| 2485 |
<interface name="org.freedesktop.UDisks2.Partition"> |
| 2486 |
<!-- prereq: org.freedesktop.UDisks2.Block --> |
| 2487 |
|
| 2488 |
<!-- Number: The number of the partition in the partition table. --> |
| 2489 |
<property name="Number" type="u" access="read"/> |
| 2490 |
|
| 2491 |
<!-- Type: The type of the partition. |
| 2492 |
|
| 2493 |
For <literal>dos</literal> partition tables, this string is a |
| 2494 |
hexadecimal number e.g. <literal>0x83</literal> or |
| 2495 |
<literal>0xfd</literal>. For <literal>gpt</literal> partition |
| 2496 |
tables this is the UUID |
| 2497 |
e.g. <literal>ebd0a0a2-b9e5-4433-87c0-68b6b72699c7</literal>. |
| 2498 |
--> |
| 2499 |
<property name="Type" type="s" access="read"/> |
| 2500 |
|
| 2501 |
<!-- Flags: Flags describing the partition. |
| 2502 |
|
| 2503 |
Known flags for <literal>dos</literal> partitions include: |
| 2504 |
<variablelist> |
| 2505 |
<varlistentry><term>Bit 7</term><listitem><para>The partition is marked as bootable</para></listitem></varlistentry> |
| 2506 |
</variablelist> |
| 2507 |
Known flags for <literal>gpt</literal> partitions include: |
| 2508 |
<variablelist> |
| 2509 |
<varlistentry><term>Bit 0</term><listitem><para>System partition</para></listitem></varlistentry> |
| 2510 |
<varlistentry><term>Bit 2</term><listitem><para>Legacy BIOS Bootable</para></listitem></varlistentry> |
| 2511 |
<varlistentry><term>Bit 60</term><listitem><para>Read-only</para></listitem></varlistentry> |
| 2512 |
<varlistentry><term>Bit 62</term><listitem><para>Hidden</para></listitem></varlistentry> |
| 2513 |
<varlistentry><term>Bit 63</term><listitem><para>Do not automount</para></listitem></varlistentry> |
| 2514 |
</variablelist> |
| 2515 |
--> |
| 2516 |
<property name="Flags" type="t" access="read"/> |
| 2517 |
|
| 2518 |
<!-- Offset: Offset of partition, in bytes. --> |
| 2519 |
<property name="Offset" type="t" access="read"/> |
| 2520 |
|
| 2521 |
<!-- Size: Size of partition, in bytes. --> |
| 2522 |
<property name="Size" type="t" access="read"/> |
| 2523 |
|
| 2524 |
<!-- Name: Label of partition or blank if not supported or unknown. --> |
| 2525 |
<property name="Name" type="s" access="read"/> |
| 2526 |
|
| 2527 |
<!-- UUID: The UUID of the partition or blank if not supported or unknown. --> |
| 2528 |
<property name="UUID" type="s" access="read"/> |
| 2529 |
|
| 2530 |
<!-- Table: |
| 2531 |
The object path of the #org.freedesktop.UDisks2.PartitionTable |
| 2532 |
object that the partition entry belongs to. |
| 2533 |
--> |
| 2534 |
<property name="Table" type="o" access="read"/> |
| 2535 |
|
| 2536 |
<!-- IsContainer: |
| 2537 |
Set to %TRUE if the partition itself is a container for other |
| 2538 |
partitions. |
| 2539 |
|
| 2540 |
For example, for <literal>dos</literal> partition tables, |
| 2541 |
this applies to socalled <emphasis>extended partition</emphasis> (partitions of type |
| 2542 |
<constant>0x05</constant>, <constant>0x0f</constant> or <constant>0x85</constant>) |
| 2543 |
containing socalled <emphasis>logical partitions</emphasis>. |
| 2544 |
--> |
| 2545 |
<property name="IsContainer" type="b" access="read"/> |
| 2546 |
|
| 2547 |
<!-- IsContained: |
| 2548 |
Set to %TRUE of the partition is contained in another partition. |
| 2549 |
See the #org.freedesktop.UDisks2.Partition:IsContainer property for more information. |
| 2550 |
--> |
| 2551 |
<property name="IsContained" type="b" access="read"/> |
| 2552 |
|
| 2553 |
<!-- SetType: |
| 2554 |
@type: New type to set. |
| 2555 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 2556 |
|
| 2557 |
Sets the partition type. See the |
| 2558 |
#org.freedesktop.UDisks2.Partition:Type property for a |
| 2559 |
description of known partition types. |
| 2560 |
--> |
| 2561 |
<method name="SetType"> |
| 2562 |
<arg name="type" direction="in" type="s"/> |
| 2563 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2564 |
</method> |
| 2565 |
|
| 2566 |
<!-- SetName: |
| 2567 |
@name: New name to set. |
| 2568 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 2569 |
|
| 2570 |
Sets the partition name (label). |
| 2571 |
--> |
| 2572 |
<method name="SetName"> |
| 2573 |
<arg name="name" direction="in" type="s"/> |
| 2574 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2575 |
</method> |
| 2576 |
|
| 2577 |
<!-- |
| 2578 |
SetUUID: |
| 2579 |
@uuid: The UUID to set. |
| 2580 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 2581 |
@since: 2.10.0 |
| 2582 |
|
| 2583 |
Sets the partition UUID (GPT only). |
| 2584 |
--> |
| 2585 |
<method name="SetUUID"> |
| 2586 |
<arg name="uuid" direction="in" type="s"/> |
| 2587 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2588 |
</method> |
| 2589 |
|
| 2590 |
<!-- SetFlags: |
| 2591 |
@flags: New flags to set. |
| 2592 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 2593 |
|
| 2594 |
Sets the partition flags. See the |
| 2595 |
#org.freedesktop.UDisks2.Partition:Flags property for a |
| 2596 |
description of known flags. |
| 2597 |
--> |
| 2598 |
<method name="SetFlags"> |
| 2599 |
<arg name="flags" direction="in" type="t"/> |
| 2600 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2601 |
</method> |
| 2602 |
|
| 2603 |
<!-- Resize: |
| 2604 |
@size: New partition size in bytes, 0 for maximal size. |
| 2605 |
@options: Options. |
| 2606 |
@since: 2.7.2 |
| 2607 |
|
| 2608 |
Resizes the partition. |
| 2609 |
|
| 2610 |
The partition will not change its position but might be slightly bigger |
| 2611 |
than requested due to sector counts and alignment (e.g. 1MiB). |
| 2612 |
If the requested size can't be allocated it results in an error. |
| 2613 |
The maximal size can automatically be set by using 0 as size. |
| 2614 |
--> |
| 2615 |
<method name="Resize"> |
| 2616 |
<arg name="size" direction="in" type="t"/> |
| 2617 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2618 |
</method> |
| 2619 |
|
| 2620 |
<!-- Delete: |
| 2621 |
@options: Options. |
| 2622 |
|
| 2623 |
Deletes the partition. |
| 2624 |
|
| 2625 |
If the option <parameter>tear-down</parameter> is set to |
| 2626 |
%TRUE, then the block device and all its children will be |
| 2627 |
cleaned up before formatting. This cleanup consists of |
| 2628 |
removing entries from /etc/fstab and /etc/crypttab, and |
| 2629 |
locking of encrypted block devices. Entries in /etc/fstab |
| 2630 |
and /etc/crypttab that have been created with the |
| 2631 |
'track-parents' options to AddConfigurationItem will be |
| 2632 |
removed even if their block device is currently unavailable. |
| 2633 |
--> |
| 2634 |
<method name="Delete"> |
| 2635 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2636 |
</method> |
| 2637 |
</interface> |
| 2638 |
|
| 2639 |
<!-- ********************************************************************** --> |
| 2640 |
|
| 2641 |
<!-- |
| 2642 |
org.freedesktop.UDisks2.Filesystem: |
| 2643 |
@short_description: Block device containing a mountable filesystem |
| 2644 |
|
| 2645 |
This interface is used for #org.freedesktop.UDisks2.Block |
| 2646 |
devices that contain a mountable filesystem. |
| 2647 |
--> |
| 2648 |
<interface name="org.freedesktop.UDisks2.Filesystem"> |
| 2649 |
<!-- prereq: org.freedesktop.UDisks2.Block --> |
| 2650 |
|
| 2651 |
<!-- |
| 2652 |
SetLabel: |
| 2653 |
@label: The label to set. |
| 2654 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 2655 |
|
| 2656 |
Sets the filesystem label. |
| 2657 |
--> |
| 2658 |
<method name="SetLabel"> |
| 2659 |
<arg name="label" direction="in" type="s"/> |
| 2660 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2661 |
</method> |
| 2662 |
|
| 2663 |
<!-- |
| 2664 |
SetUUID: |
| 2665 |
@uuid: The UUID to set. |
| 2666 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 2667 |
@since: 2.10.0 |
| 2668 |
|
| 2669 |
Sets the filesystem UUID value. |
| 2670 |
--> |
| 2671 |
<method name="SetUUID"> |
| 2672 |
<arg name="uuid" direction="in" type="s"/> |
| 2673 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2674 |
</method> |
| 2675 |
|
| 2676 |
<!-- MountPoints: |
| 2677 |
An array of filesystems paths for where the file system on |
| 2678 |
the device is mounted. If the device is not mounted, this |
| 2679 |
array is empty. |
| 2680 |
--> |
| 2681 |
<property name="MountPoints" type="aay" access="read"/> |
| 2682 |
|
| 2683 |
<!-- |
| 2684 |
Mount: |
| 2685 |
@options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>fstype</parameter> (of type 's'), <parameter>as-user</parameter> (of type 's') and <parameter>options</parameter> (of type 's'). |
| 2686 |
@mount_path: The filesystem path where the device was mounted. |
| 2687 |
|
| 2688 |
Mounts the filesystem. |
| 2689 |
|
| 2690 |
The directory the filesystem will be mounted in is determined |
| 2691 |
by looking at data related to the device or filesystem (such |
| 2692 |
the filesystem UUID and label) and will be created |
| 2693 |
automatically except if the device the filesystem resides on |
| 2694 |
is referenced in the <filename>/etc/fstab</filename> file, see |
| 2695 |
below. In either case, the directory the filesystem is mounted |
| 2696 |
in, is returned in @mount_path on success - it is usually a |
| 2697 |
sub-directory of <filename |
| 2698 |
class='directory'>/run/media/$USER</filename> but note that |
| 2699 |
any directory may be returned. |
| 2700 |
|
| 2701 |
The filesystem type to use can be overridden with the @fstype |
| 2702 |
option and mount options (a comma-separated string) can be |
| 2703 |
given in @options option. Note that both the mount options and |
| 2704 |
filesystem types are validated against a (small) whitelist to |
| 2705 |
avoid unexpected privilege escalation. The filesystem type is |
| 2706 |
by default determined by the #org.freedesktop.UDisks2.Block:IdType |
| 2707 |
property. The @fstype option doesn't typically need to be |
| 2708 |
specified, primarily intended as an override in corner cases. |
| 2709 |
|
| 2710 |
If the <parameter>as-user</parameter> option is set, the |
| 2711 |
filesystem is mounted on behalf of the specified user instead |
| 2712 |
of the calling one. This has usually an effect on the returned |
| 2713 |
@mount_path and it also allows that user to unmount the |
| 2714 |
filesystem later. This option expects a user name, not a UID. |
| 2715 |
|
| 2716 |
If the device in question is referenced in the |
| 2717 |
<filename>/etc/fstab</filename> file, the |
| 2718 |
<command>mount</command> command is called directly (as root) |
| 2719 |
and the given options or filesystem type given in @options are |
| 2720 |
ignored. |
| 2721 |
|
| 2722 |
If <literal>x-udisks-auth</literal> is specified as an option |
| 2723 |
for the device in the <filename>/etc/fstab</filename> file, |
| 2724 |
then the <command>mount</command> command is run as the |
| 2725 |
calling user, without performing any authorization check |
| 2726 |
mentioned above. If this fails because of insufficient |
| 2727 |
permissions, an authorization check is performed (which |
| 2728 |
typically results in the user having to authenticate as an |
| 2729 |
administrator). If authorized, the <command>mount</command> |
| 2730 |
command is then run as root. |
| 2731 |
|
| 2732 |
The filesystem should be unmounted using the |
| 2733 |
org.freedesktop.UDisks2.Filesystem.Unmount() method. |
| 2734 |
|
| 2735 |
If the device is removed without being unmounted (e.g. the |
| 2736 |
user yanking the device or pulling the media out) or unmounted |
| 2737 |
in a way that bypasses the |
| 2738 |
org.freedesktop.UDisks2.Filesystem.Unmount() method |
| 2739 |
(e.g. unmounted by the super-user by using the |
| 2740 |
<citerefentry><refentrytitle>umount</refentrytitle><manvolnum>8</manvolnum></citerefentry> |
| 2741 |
command directly), the device will be unmounted (if needed) |
| 2742 |
and/or the mount point will be cleaned up. |
| 2743 |
--> |
| 2744 |
<method name="Mount"> |
| 2745 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2746 |
<arg name="mount_path" direction="out" type="s"/> |
| 2747 |
</method> |
| 2748 |
|
| 2749 |
<!-- |
| 2750 |
Unmount: |
| 2751 |
@options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>force</parameter> (of type 'b'). |
| 2752 |
|
| 2753 |
Unmount a mounted device. |
| 2754 |
|
| 2755 |
If the device in question was mounted by the calling user |
| 2756 |
via the org.freedesktop.UDisks2.Filesystem.Mount() method the |
| 2757 |
filesystem is unmounted without any authorization checks. |
| 2758 |
Otherwise, an authorization check is performed (which |
| 2759 |
typically results in the user having to authenticate as an |
| 2760 |
administrator). If authorized, the filesystem is unmounted. |
| 2761 |
|
| 2762 |
If the mountpoint was previously created by udisks it is |
| 2763 |
guaranteed it will be removed upon returning from this method |
| 2764 |
call. |
| 2765 |
|
| 2766 |
If the filesystem is busy, this operation fails with the error |
| 2767 |
<link linkend="UDISKS-ERROR-DEVICE-BUSY:CAPS"><constant>org.freedesktop.UDisks2.Error.DeviceBusy</constant></link> |
| 2768 |
unless the @force option is used. |
| 2769 |
--> |
| 2770 |
<method name="Unmount"> |
| 2771 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2772 |
</method> |
| 2773 |
|
| 2774 |
<!-- Size: The size of the filesystem. This is the amount of |
| 2775 |
bytes used on the block device representing an outer filesystem |
| 2776 |
boundary. If this is smaller than org.freedesktop.Udisks2.Block.Size, |
| 2777 |
then the filesystem can be made larger with Resize. |
| 2778 |
|
| 2779 |
If the size is unknown, the property is zero. Currently limited |
| 2780 |
to xfs and ext filesystems only. |
| 2781 |
|
| 2782 |
Please note that reading value of this property typically causes |
| 2783 |
some I/O to read the filesystem superblock. Unlike the rest |
| 2784 |
of the properties this one is set to be retrieved on-demand |
| 2785 |
and is not proactively cached by the daemon. |
| 2786 |
--> |
| 2787 |
<property name="Size" type="t" access="read"/> |
| 2788 |
|
| 2789 |
<!-- |
| 2790 |
Resize: |
| 2791 |
@size: The target size in bytes, 0 for maximum. |
| 2792 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 2793 |
@since: 2.7.2 |
| 2794 |
|
| 2795 |
Resizes the filesystem. |
| 2796 |
|
| 2797 |
Shrinking operations need to move data which causes this action to be |
| 2798 |
slow. The filesystem-resize job for the object might expose progress. |
| 2799 |
--> |
| 2800 |
<method name="Resize"> |
| 2801 |
<arg name="size" direction="in" type="t"/> |
| 2802 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2803 |
</method> |
| 2804 |
|
| 2805 |
<!-- Check: |
| 2806 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 2807 |
@consistent: Whether the filesystem is undamaged. |
| 2808 |
@since: 2.7.2 |
| 2809 |
|
| 2810 |
Checks the filesystem for consistency avoiding any modifications or repairs. |
| 2811 |
|
| 2812 |
Mounted or unsupported filesystems will result in an error. |
| 2813 |
--> |
| 2814 |
<method name="Check"> |
| 2815 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2816 |
<arg name="consistent" direction="out" type="b"/> |
| 2817 |
</method> |
| 2818 |
|
| 2819 |
<!-- Repair: |
| 2820 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 2821 |
@repaired: Whether the filesystem could be successfully repaired. |
| 2822 |
@since: 2.7.2 |
| 2823 |
|
| 2824 |
Tries to repair the filesystem. |
| 2825 |
|
| 2826 |
Mounted or unsupported filesystems will result in an error. |
| 2827 |
--> |
| 2828 |
<method name="Repair"> |
| 2829 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2830 |
<arg name="repaired" direction="out" type="b"/> |
| 2831 |
</method> |
| 2832 |
|
| 2833 |
<!-- TakeOwnership: |
| 2834 |
@options: Options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>recursive</parameter> (of type 'b'). |
| 2835 |
@since: 2.7.2 |
| 2836 |
|
| 2837 |
Changes ownership of the filesystem to the UID and GID of the calling |
| 2838 |
user. |
| 2839 |
|
| 2840 |
Filesystems that don't support ownership result in an error. |
| 2841 |
--> |
| 2842 |
<method name="TakeOwnership"> |
| 2843 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2844 |
</method> |
| 2845 |
</interface> |
| 2846 |
|
| 2847 |
<!-- ********************************************************************** --> |
| 2848 |
|
| 2849 |
<!-- |
| 2850 |
org.freedesktop.UDisks2.Swapspace: |
| 2851 |
@short_description: Block device containing swap data |
| 2852 |
|
| 2853 |
This interface is used for #org.freedesktop.UDisks2.Block |
| 2854 |
devices that contain swap space. |
| 2855 |
--> |
| 2856 |
<interface name="org.freedesktop.UDisks2.Swapspace"> |
| 2857 |
<!-- prereq: org.freedesktop.UDisks2.Block --> |
| 2858 |
|
| 2859 |
<!-- Active: Set to %TRUE if the device is currently in use by the OS. --> |
| 2860 |
<property name="Active" type="b" access="read"/> |
| 2861 |
|
| 2862 |
<!-- |
| 2863 |
Start: |
| 2864 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 2865 |
|
| 2866 |
Activates the swap device. |
| 2867 |
--> |
| 2868 |
<method name="Start"> |
| 2869 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2870 |
</method> |
| 2871 |
|
| 2872 |
<!-- |
| 2873 |
Stop: |
| 2874 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 2875 |
|
| 2876 |
Deactivates the swap device. |
| 2877 |
--> |
| 2878 |
<method name="Stop"> |
| 2879 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2880 |
</method> |
| 2881 |
|
| 2882 |
<!-- |
| 2883 |
SetLabel: |
| 2884 |
@label: The label to set. |
| 2885 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 2886 |
|
| 2887 |
Set label for the swap device. |
| 2888 |
--> |
| 2889 |
<method name="SetLabel"> |
| 2890 |
<arg name="label" direction="in" type="s"/> |
| 2891 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2892 |
</method> |
| 2893 |
|
| 2894 |
<!-- |
| 2895 |
SetUUID: |
| 2896 |
@uuid: The UUID to set. |
| 2897 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 2898 |
@since: 2.10.0 |
| 2899 |
|
| 2900 |
Set UUID for the swap device. |
| 2901 |
--> |
| 2902 |
<method name="SetUUID"> |
| 2903 |
<arg name="uuid" direction="in" type="s"/> |
| 2904 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2905 |
</method> |
| 2906 |
</interface> |
| 2907 |
|
| 2908 |
<!-- ********************************************************************** --> |
| 2909 |
|
| 2910 |
<!-- |
| 2911 |
org.freedesktop.UDisks2.Encrypted: |
| 2912 |
@short_description: Block device containing encrypted data |
| 2913 |
|
| 2914 |
This interface is used for #org.freedesktop.UDisks2.Block |
| 2915 |
devices that contain encrypted data. |
| 2916 |
--> |
| 2917 |
<interface name="org.freedesktop.UDisks2.Encrypted"> |
| 2918 |
<!-- prereq: org.freedesktop.UDisks2.Block --> |
| 2919 |
|
| 2920 |
<!-- ChildConfiguration: Configuration items belonging to the |
| 2921 |
clear text device of this encrypted block device and its |
| 2922 |
children. This is also valid when this block device is |
| 2923 |
currently locked and there is no clear text device for it. |
| 2924 |
It works via the 'track-parents' options of |
| 2925 |
org.freedesktop.UDisks2.Block.AddConfigurationItem(), which |
| 2926 |
see. |
| 2927 |
--> |
| 2928 |
<property name="ChildConfiguration" type="a(sa{sv})" access="read"/> |
| 2929 |
|
| 2930 |
<!-- HintEncryptionType: |
| 2931 |
If not blank, the type of the encryption used to encrypt this device. |
| 2932 |
|
| 2933 |
This is set during successful unlocking of an encrypted device. |
| 2934 |
It is required for encryption types which can only be determined |
| 2935 |
by decrypting the device (for example TCRYPT), but is used for all |
| 2936 |
encryption types for consistency reasons. |
| 2937 |
--> |
| 2938 |
<property name="HintEncryptionType" type="s" access="read"/> |
| 2939 |
|
| 2940 |
<!-- MetadataSize: Size of the metadata on the encrypted device in bytes |
| 2941 |
--> |
| 2942 |
<property name="MetadataSize" type="t" access="read"/> |
| 2943 |
|
| 2944 |
<!-- CleartextDevice: |
| 2945 |
For an unlocked device, the object path of its cleartext device. |
| 2946 |
--> |
| 2947 |
<property name="CleartextDevice" type="o" access="read"/> |
| 2948 |
|
| 2949 |
<!-- |
| 2950 |
Unlock: |
| 2951 |
@passphrase: The passphrase to use. |
| 2952 |
@options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>keyfile_contents</parameter> (of type 'ay') which is preferred over @passphrase if specified and <parameter>read-only</parameter> (of type 'b'). |
| 2953 |
@cleartext_device: An object path to the unlocked object implementing the #org.freedesktop.UDisks2.Block interface. |
| 2954 |
|
| 2955 |
Tries to unlock the encrypted device using @passphrase. |
| 2956 |
|
| 2957 |
If the device in question is referenced in a system-wide |
| 2958 |
configuration file (such as the <filename>/etc/crypttab</filename> file), |
| 2959 |
then name, options and passphrase (if available) is used from that |
| 2960 |
file after requesting additional authorization. |
| 2961 |
|
| 2962 |
If an empty passphrase should be used to unlock the device, it has to be |
| 2963 |
passed using the @keyfile_contents parameter. Empty string passed as |
| 2964 |
@passphrase means "Use the passphrase from the configuration file". |
| 2965 |
|
| 2966 |
If the device is removed without being locked (e.g. the user |
| 2967 |
yanking the device or pulling the media out) the cleartext |
| 2968 |
device will be cleaned up. |
| 2969 |
--> |
| 2970 |
<method name="Unlock"> |
| 2971 |
<arg name="passphrase" direction="in" type="s"/> |
| 2972 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2973 |
<arg name="cleartext_device" direction="out" type="o"/> |
| 2974 |
</method> |
| 2975 |
|
| 2976 |
<!-- |
| 2977 |
Lock: |
| 2978 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 2979 |
|
| 2980 |
Locks the encrypted device. |
| 2981 |
--> |
| 2982 |
<method name="Lock"> |
| 2983 |
<arg name="options" direction="in" type="a{sv}"/> |
| 2984 |
</method> |
| 2985 |
|
| 2986 |
<!-- |
| 2987 |
ChangePassphrase: |
| 2988 |
@passphrase: The existing passphrase. |
| 2989 |
@new_passphrase: The new passphrase to use. |
| 2990 |
@options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>old_keyfile_contents</parameter> and <parameter>new_keyfile_contents</parameter> (of type 's' or 'ay'). |
| 2991 |
|
| 2992 |
Changes the passphrase to @new_passphrase. An existing passphrase is required. |
| 2993 |
|
| 2994 |
If <parameter>old_keyfile_contents</parameter> or |
| 2995 |
<parameter>new_keyfile_contents</parameter> are given, they take |
| 2996 |
precedence over the corresponding passphrase parameters individually. |
| 2997 |
|
| 2998 |
If the device in question is referenced in a system-wide |
| 2999 |
configuration file (such as the |
| 3000 |
<filename>/etc/crypttab</filename> file) and this |
| 3001 |
configuration references the passphrase, it is not |
| 3002 |
automatically updated. |
| 3003 |
--> |
| 3004 |
<method name="ChangePassphrase"> |
| 3005 |
<arg name="passphrase" direction="in" type="s"/> |
| 3006 |
<arg name="new_passphrase" direction="in" type="s"/> |
| 3007 |
<arg name="options" direction="in" type="a{sv}"/> |
| 3008 |
</method> |
| 3009 |
|
| 3010 |
<!-- |
| 3011 |
Resize: |
| 3012 |
@size: The target cleartext size in bytes, 0 for maximum. |
| 3013 |
@options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>passphrase</parameter> (of type 's') and <parameter>keyfile_contents</parameter> (of type 'ay') which is preferred over @passphrase if specified. |
| 3014 |
@since: 2.8.0 |
| 3015 |
|
| 3016 |
Resizes the encrypted device. The device must be unlocked. |
| 3017 |
The given size is the target size for the cleartext device. |
| 3018 |
|
| 3019 |
You need to specify either @passphrase or @keyfile_contents for LUKS 2 |
| 3020 |
devices that don't have verified key loaded in kernel keyring. |
| 3021 |
--> |
| 3022 |
<method name="Resize"> |
| 3023 |
<arg name="size" direction="in" type="t"/> |
| 3024 |
<arg name="options" direction="in" type="a{sv}"/> |
| 3025 |
</method> |
| 3026 |
|
| 3027 |
<!-- |
| 3028 |
Convert: |
| 3029 |
@target_version: The LUKS version to convert to. Either 'luks1' or 'luks2'. |
| 3030 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 3031 |
@since: 2.11.0 |
| 3032 |
|
| 3033 |
Converts the encrypted device to a different version of LUKS. Other encryption formats are not supported. |
| 3034 |
The device must be locked. |
| 3035 |
--> |
| 3036 |
<method name="Convert"> |
| 3037 |
<arg name="target_version" direction="in" type="s"/> |
| 3038 |
<arg name="options" direction="in" type="a{sv}"/> |
| 3039 |
</method> |
| 3040 |
|
| 3041 |
<!-- |
| 3042 |
HeaderBackup: |
| 3043 |
@backup_file: Path where to backup header and keyslots to. |
| 3044 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 3045 |
@since: 2.11.0 |
| 3046 |
|
| 3047 |
Saves header and keyslots to the specified file. |
| 3048 |
The target file is not overwritten if exists, and an error is returned. |
| 3049 |
--> |
| 3050 |
<method name="HeaderBackup"> |
| 3051 |
<arg name="backup_file" direction="in" type="s"/> |
| 3052 |
<arg name="options" direction="in" type="a{sv}"/> |
| 3053 |
</method> |
| 3054 |
|
| 3055 |
</interface> |
| 3056 |
|
| 3057 |
<!-- ********************************************************************** --> |
| 3058 |
|
| 3059 |
<!-- |
| 3060 |
org.freedesktop.UDisks2.Loop: |
| 3061 |
@short_description: Block device backed by a file |
| 3062 |
|
| 3063 |
This interface is used for #org.freedesktop.UDisks2.Block |
| 3064 |
devices that are loop devices. |
| 3065 |
--> |
| 3066 |
<interface name="org.freedesktop.UDisks2.Loop"> |
| 3067 |
<!-- prereq: org.freedesktop.UDisks2.Block --> |
| 3068 |
|
| 3069 |
<!-- |
| 3070 |
Delete: |
| 3071 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 3072 |
|
| 3073 |
Deletes the loop device. |
| 3074 |
--> |
| 3075 |
<method name="Delete"> |
| 3076 |
<arg name="options" direction="in" type="a{sv}"/> |
| 3077 |
</method> |
| 3078 |
|
| 3079 |
<!-- BackingFile: |
| 3080 |
A path to the file that is backing the block device or blank |
| 3081 |
if unknown. |
| 3082 |
--> |
| 3083 |
<property name="BackingFile" type="ay" access="read"/> |
| 3084 |
|
| 3085 |
<!-- Autoclear: |
| 3086 |
If %TRUE, the kernel will automatically clear the loop device |
| 3087 |
when the last closer closes the device. This typically |
| 3088 |
happens when the loop device is unmounted. |
| 3089 |
--> |
| 3090 |
<property name="Autoclear" type="b" access="read"/> |
| 3091 |
|
| 3092 |
<!-- SetupByUID: |
| 3093 |
The id of the user who set up the loop device or 0 if set up |
| 3094 |
by root or not through udisks. |
| 3095 |
--> |
| 3096 |
<property name="SetupByUID" type="u" access="read"/> |
| 3097 |
|
| 3098 |
<!-- |
| 3099 |
SetAutoclear: |
| 3100 |
@value: The new value of autoclear. |
| 3101 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 3102 |
|
| 3103 |
Setter for the #org.freedesktop.UDisks2.Loop:Autoclear |
| 3104 |
property. Since this may require authentication and thus may |
| 3105 |
fail, it is implemented this way instead of the property being |
| 3106 |
writable. |
| 3107 |
--> |
| 3108 |
<method name="SetAutoclear"> |
| 3109 |
<arg name="value" direction="in" type="b"/> |
| 3110 |
<arg name="options" direction="in" type="a{sv}"/> |
| 3111 |
</method> |
| 3112 |
|
| 3113 |
<!-- |
| 3114 |
SetCapacity: |
| 3115 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 3116 |
@since: 2.11.0 |
| 3117 |
|
| 3118 |
Forces the loop driver to reread the size of the file associated |
| 3119 |
with this device. |
| 3120 |
--> |
| 3121 |
<method name="SetCapacity"> |
| 3122 |
<arg name="options" direction="in" type="a{sv}"/> |
| 3123 |
</method> |
| 3124 |
</interface> |
| 3125 |
|
| 3126 |
<!-- ********************************************************************** --> |
| 3127 |
|
| 3128 |
<!-- |
| 3129 |
org.freedesktop.UDisks2.MDRaid: |
| 3130 |
@short_description: Linux Software RAID |
| 3131 |
@since: 2.0.0 |
| 3132 |
|
| 3133 |
Objects implementing this interface represent |
| 3134 |
<ulink url="https://docs.kernel.org/admin-guide/md.html">Linux Software RAID arrays</ulink> |
| 3135 |
detected on the system. Both running and not-running arrays are represented. |
| 3136 |
|
| 3137 |
Block devices point to objects implementing this interface, see |
| 3138 |
the #org.freedesktop.UDisks2.Block:MDRaid and |
| 3139 |
#org.freedesktop.UDisks2.Block:MDRaidMember properties on the |
| 3140 |
#org.freedesktop.UDisks2.Block D-Bus interface. |
| 3141 |
--> |
| 3142 |
<interface name="org.freedesktop.UDisks2.MDRaid"> |
| 3143 |
<!-- UUID: |
| 3144 |
The UUID of the array. |
| 3145 |
--> |
| 3146 |
<property name="UUID" type="s" access="read"/> |
| 3147 |
|
| 3148 |
<!-- Name: |
| 3149 |
The name of the array (TODO: homehost etc). |
| 3150 |
--> |
| 3151 |
<property name="Name" type="s" access="read"/> |
| 3152 |
|
| 3153 |
<!-- Level: |
| 3154 |
The RAID level. |
| 3155 |
|
| 3156 |
Known values include <literal>raid0</literal>, <literal>raid1</literal>, <literal>raid4</literal>, <literal>raid5</literal>, <literal>raid6</literal> and <literal>raid10</literal>. |
| 3157 |
--> |
| 3158 |
<property name="Level" type="s" access="read"/> |
| 3159 |
|
| 3160 |
<!-- NumDevices: |
| 3161 |
Number of devices that are part of the array. |
| 3162 |
--> |
| 3163 |
<property name="NumDevices" type="u" access="read"/> |
| 3164 |
|
| 3165 |
<!-- Size: |
| 3166 |
The size of the array or 0 if unknown. |
| 3167 |
|
| 3168 |
This is the usable size, e.g. for a RAID-5 array backed by 4 |
| 3169 |
1TB disks, this will be approximately 3 TB. |
| 3170 |
--> |
| 3171 |
<property name="Size" type="t" access="read"/> |
| 3172 |
|
| 3173 |
<!-- SyncAction: |
| 3174 |
The current state of the array or empty if the array is not |
| 3175 |
running or if the array does not have any redundancy |
| 3176 |
(e.g. RAID-0 or linear). |
| 3177 |
|
| 3178 |
Use the org.freedesktop.UDisks2.MDRaid.RequestSyncAction() |
| 3179 |
method to change this. |
| 3180 |
|
| 3181 |
This property corresponds to the |
| 3182 |
<literal>sync_action</literal> sysfs file, see the |
| 3183 |
<filename><ulink url="https://www.kernel.org/doc/Documentation/admin-guide/md.rst">Documentation/admin-guide/md.rst</ulink></filename> |
| 3184 |
file shipped with the kernel sources. |
| 3185 |
--> |
| 3186 |
<property name="SyncAction" type="s" access="read"/> |
| 3187 |
|
| 3188 |
<!-- SyncCompleted: |
| 3189 |
The fraction or sectors completed (always between <constant>0.0</constant> and <constant>1.0</constant>) in the sync operation or 0.0 if no operation is in progress. |
| 3190 |
|
| 3191 |
This property corresponds to the |
| 3192 |
<literal>sync_completed</literal> sysfs file, see the |
| 3193 |
<filename><ulink url="https://www.kernel.org/doc/Documentation/admin-guide/md.rst">Documentation/admin-guide/md.rst</ulink></filename> |
| 3194 |
file shipped with the kernel sources. |
| 3195 |
--> |
| 3196 |
<property name="SyncCompleted" type="d" access="read"/> |
| 3197 |
|
| 3198 |
<!-- SyncRate: |
| 3199 |
The rate (or speed) at which the sync operation takes |
| 3200 |
place. It is averaged over the last 30 seconds and measured |
| 3201 |
in bytes per second. |
| 3202 |
|
| 3203 |
If the rate is unknown or no operation is in progress, the |
| 3204 |
value of this property is 0. |
| 3205 |
|
| 3206 |
This property corresponds to the |
| 3207 |
<literal>sync_speed</literal> sysfs file, see the |
| 3208 |
<filename><ulink url="https://www.kernel.org/doc/Documentation/admin-guide/md.rst">Documentation/admin-guide/md.rst</ulink></filename> |
| 3209 |
file shipped with the kernel sources. |
| 3210 |
--> |
| 3211 |
<property name="SyncRate" type="t" access="read"/> |
| 3212 |
|
| 3213 |
<!-- SyncRemainingTime: |
| 3214 |
The estimated number of micro-seconds until the operation is |
| 3215 |
finished |
| 3216 |
|
| 3217 |
If the amount of remaining time is unknown or no operation is |
| 3218 |
in progress, the value of this property is 0. |
| 3219 |
|
| 3220 |
This property is based on the value of the |
| 3221 |
<literal>sync_speed</literal> sysfs file, see the |
| 3222 |
<filename><ulink url="https://www.kernel.org/doc/Documentation/admin-guide/md.rst">Documentation/admin-guide/md.rst</ulink></filename> |
| 3223 |
file shipped with the kernel sources. |
| 3224 |
--> |
| 3225 |
<property name="SyncRemainingTime" type="t" access="read"/> |
| 3226 |
|
| 3227 |
<!-- Degraded: |
| 3228 |
Number of devices by which the array is degraded (0 if not degraded or not running). |
| 3229 |
|
| 3230 |
This property corresponds to the |
| 3231 |
<literal>degraded</literal> sysfs file, see the |
| 3232 |
<filename><ulink url="https://www.kernel.org/doc/Documentation/admin-guide/md.rst">Documentation/admin-guide/md.rst</ulink></filename> |
| 3233 |
file shipped with the kernel sources. |
| 3234 |
--> |
| 3235 |
<property name="Degraded" type="u" access="read"/> |
| 3236 |
|
| 3237 |
<!-- ConsistencyPolicy: |
| 3238 |
@since: 2.11.0 |
| 3239 |
The consistency policy of the array. |
| 3240 |
|
| 3241 |
If the RAID array does not support consistency policies (for |
| 3242 |
example RAID-0 arrays), this is empty. |
| 3243 |
|
| 3244 |
This property corresponds to the |
| 3245 |
<literal>consistency_policy</literal> sysfs file. |
| 3246 |
--> |
| 3247 |
<property name="ConsistencyPolicy" type="s" access="read"/> |
| 3248 |
|
| 3249 |
<!-- BitmapLocation: |
| 3250 |
The location of a write-intent bitmap (empty if the array is not running), if any. |
| 3251 |
|
| 3252 |
If the RAID array does not support write-intent bitmaps (for |
| 3253 |
example RAID-0 arrays), this is empty. |
| 3254 |
|
| 3255 |
This property corresponds to the |
| 3256 |
<literal>bitmap/location</literal> sysfs file, see the |
| 3257 |
<filename><ulink url="https://www.kernel.org/doc/Documentation/admin-guide/md.rst">Documentation/admin-guide/md.rst</ulink></filename> |
| 3258 |
file shipped with the kernel sources. |
| 3259 |
--> |
| 3260 |
<property name="BitmapLocation" type="ay" access="read"/> |
| 3261 |
|
| 3262 |
<!-- ChunkSize: |
| 3263 |
The chunk size (0 if the array is not running or not using striping). |
| 3264 |
|
| 3265 |
This property corresponds to the |
| 3266 |
<literal>chunk_size</literal> sysfs file, see the |
| 3267 |
<filename><ulink url="https://www.kernel.org/doc/Documentation/admin-guide/md.rst">Documentation/admin-guide/md.rst</ulink></filename> |
| 3268 |
file shipped with the kernel sources. |
| 3269 |
--> |
| 3270 |
<property name="ChunkSize" type="t" access="read"/> |
| 3271 |
|
| 3272 |
<!-- ActiveDevices: |
| 3273 |
This property is an array with block devices that are |
| 3274 |
currently associated with the with the array. It is empty if |
| 3275 |
the array is not running. |
| 3276 |
|
| 3277 |
Each element of the array is a struct with the following members: |
| 3278 |
<variablelist> |
| 3279 |
<varlistentry><term>block (type 'o')</term> |
| 3280 |
<listitem><para>The object path for the underlying block device (guaranteed to implement the #org.freedesktop.UDisks2.Block interface)</para></listitem></varlistentry> |
| 3281 |
<varlistentry><term>slot (type 'i')</term> |
| 3282 |
<listitem><para>-1 if the device is not currently part of the array (ie. <literal>spare</literal> or <literal>faulty</literal>), otherwise the slot number the device currently fills (between 0 and #org.freedesktop.UDisks2.MDRaid:NumDevices)</para></listitem></varlistentry> |
| 3283 |
<varlistentry><term>state (type 'as')</term> |
| 3284 |
<listitem><para>The state of the device - known elements include <literal>faulty</literal>, <literal>in_sync</literal>, <literal>write_mostly</literal>, <literal>blocked</literal> and <literal>spare</literal></para></listitem></varlistentry> |
| 3285 |
<varlistentry><term>num_read_errors (type 't')</term> |
| 3286 |
<listitem><para>An ongoing count of read errors that have been detected on this device but have not caused the device to be evicted from the array</para></listitem></varlistentry> |
| 3287 |
<varlistentry><term>expansion (type 'a{sv}')</term> |
| 3288 |
<listitem><para>Currently unused. Intended for future expansion.</para></listitem></varlistentry> |
| 3289 |
</variablelist> |
| 3290 |
This property correspond to the |
| 3291 |
<filename>/sys/block/mdN/md/dev-*</filename> directories in sysfs and the sysfs files in each directory. |
| 3292 |
See the |
| 3293 |
<filename><ulink url="https://www.kernel.org/doc/Documentation/admin-guide/md.rst">Documentation/admin-guide/md.rst</ulink></filename> |
| 3294 |
file shipped with the kernel sources. |
| 3295 |
--> |
| 3296 |
<property name="ActiveDevices" type="a(oiasta{sv})" access="read"/> |
| 3297 |
|
| 3298 |
<!-- ChildConfiguration: Configuration items belonging to the |
| 3299 |
block devices of this array (recursively). This is also |
| 3300 |
valid when the array is stopped and there are no actual block |
| 3301 |
devices for it. It works via the 'track-parents' options of |
| 3302 |
org.freedesktop.UDisks2.Block.AddConfigurationItem(), which |
| 3303 |
see. |
| 3304 |
--> |
| 3305 |
<property name="ChildConfiguration" type="a(sa{sv})" access="read"/> |
| 3306 |
|
| 3307 |
<!-- Running: Whether or not the array is considered running. |
| 3308 |
|
| 3309 |
It is an error to call Start on a running array, and Stop on |
| 3310 |
a non-running array, for example. |
| 3311 |
--> |
| 3312 |
<property name="Running" type="b" access="read"/> |
| 3313 |
|
| 3314 |
<!-- |
| 3315 |
Start: |
| 3316 |
@options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>start-degraded</parameter> (of type 'b'). |
| 3317 |
|
| 3318 |
Starts the RAID array. |
| 3319 |
|
| 3320 |
If the @option parameter contains the key @start-degraded with |
| 3321 |
the value %TRUE, the array will be started even if some members |
| 3322 |
are missing. |
| 3323 |
--> |
| 3324 |
<method name="Start"> |
| 3325 |
<arg name="options" direction="in" type="a{sv}"/> |
| 3326 |
</method> |
| 3327 |
|
| 3328 |
<!-- |
| 3329 |
Stop: |
| 3330 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 3331 |
|
| 3332 |
Stops the RAID array. |
| 3333 |
--> |
| 3334 |
<method name="Stop"> |
| 3335 |
<arg name="options" direction="in" type="a{sv}"/> |
| 3336 |
</method> |
| 3337 |
|
| 3338 |
<!-- |
| 3339 |
RemoveDevice: |
| 3340 |
@device: An object path to an object implementing the #org.freedesktop.UDisks2.Block interface. |
| 3341 |
@options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>wipe</parameter> (of type 'b'). |
| 3342 |
|
| 3343 |
Removes @device from the array. |
| 3344 |
|
| 3345 |
For this to work @device must already be associated with the |
| 3346 |
array, e.g. referenced in the |
| 3347 |
#org.freedesktop.UDisks2.MDRaid:ActiveDevices property. |
| 3348 |
|
| 3349 |
If the @option parameter contains the key @wipe with the value |
| 3350 |
%TRUE, all known filesystem signatures will be erased from the |
| 3351 |
@device after removal. |
| 3352 |
--> |
| 3353 |
<method name="RemoveDevice"> |
| 3354 |
<arg name="device" direction="in" type="o"/> |
| 3355 |
<arg name="options" direction="in" type="a{sv}"/> |
| 3356 |
</method> |
| 3357 |
|
| 3358 |
<!-- |
| 3359 |
AddDevice: |
| 3360 |
@device: An object path to an object implementing the #org.freedesktop.UDisks2.Block interface. |
| 3361 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 3362 |
|
| 3363 |
Adds @device to the array. |
| 3364 |
--> |
| 3365 |
<method name="AddDevice"> |
| 3366 |
<arg name="device" direction="in" type="o"/> |
| 3367 |
<arg name="options" direction="in" type="a{sv}"/> |
| 3368 |
</method> |
| 3369 |
|
| 3370 |
<!-- |
| 3371 |
SetBitmapLocation: |
| 3372 |
@value: The value for the bitmap, currently only the values 'none' and 'internal' are supported. |
| 3373 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 3374 |
|
| 3375 |
Sets whether the array has a write-intent bitmap. |
| 3376 |
--> |
| 3377 |
<method name="SetBitmapLocation"> |
| 3378 |
<arg name="value" direction="in" type="ay"/> |
| 3379 |
<arg name="options" direction="in" type="a{sv}"/> |
| 3380 |
</method> |
| 3381 |
|
| 3382 |
<!-- |
| 3383 |
RequestSyncAction: |
| 3384 |
@sync_action: The action to request. |
| 3385 |
@options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>no-inhibit-lock</parameter> (of type 'b'). |
| 3386 |
|
| 3387 |
This method call can be used to trigger and cancel data |
| 3388 |
redundancy checks and repairs. Currently only the values |
| 3389 |
<literal>check</literal>, <literal>repair</literal> and |
| 3390 |
<literal>idle</literal> can be used for @sync_action. |
| 3391 |
|
| 3392 |
See also the property #org.freedesktop.UDisks2.MDRaid:SyncAction. |
| 3393 |
|
| 3394 |
This method call is similar to writing to the |
| 3395 |
<literal>sync_action</literal> sysfs file, see the |
| 3396 |
<filename><ulink url="https://www.kernel.org/doc/Documentation/admin-guide/md.rst">Documentation/admin-guide/md.rst</ulink></filename> |
| 3397 |
file shipped with the kernel sources. |
| 3398 |
|
| 3399 |
If the @option parameter contains the key @no-inhibit-lock with the value |
| 3400 |
%TRUE, no system inhibit lock is attempted to be acquired that would otherwise |
| 3401 |
prevent the system to shutdown, reboot, sleep or hibernate. |
| 3402 |
--> |
| 3403 |
<method name="RequestSyncAction"> |
| 3404 |
<arg name="sync_action" direction="in" type="s"/> |
| 3405 |
<arg name="options" direction="in" type="a{sv}"/> |
| 3406 |
</method> |
| 3407 |
|
| 3408 |
<!-- Delete: |
| 3409 |
@options: Options. |
| 3410 |
|
| 3411 |
Stops the RAID array and destroys all RAID metadata on member devices. |
| 3412 |
|
| 3413 |
If the option <parameter>tear-down</parameter> is set to |
| 3414 |
%TRUE, then the RAID array block device and all its children |
| 3415 |
will be cleaned up before stopping. This cleanup consists of |
| 3416 |
removing entries from /etc/fstab and /etc/crypttab, and |
| 3417 |
locking of encrypted block devices. Entries in /etc/fstab |
| 3418 |
and /etc/crypttab that have been created with the |
| 3419 |
'track-parents' options to AddConfigurationItem will be |
| 3420 |
removed even if their block device is currently unavailable. |
| 3421 |
--> |
| 3422 |
<method name="Delete"> |
| 3423 |
<arg name="options" direction="in" type="a{sv}"/> |
| 3424 |
</method> |
| 3425 |
|
| 3426 |
</interface> |
| 3427 |
|
| 3428 |
<!-- ********************************************************************** --> |
| 3429 |
|
| 3430 |
<!-- |
| 3431 |
org.freedesktop.UDisks2.Job: |
| 3432 |
@short_description: Long-running tasks |
| 3433 |
|
| 3434 |
Some operations may take a long time (hours) to complete, that |
| 3435 |
is, to actually send the D-Bus reply message back. One example |
| 3436 |
of such an operation is the |
| 3437 |
org.freedesktop.UDisks2.Block.Format() method that is used to |
| 3438 |
format a block device. |
| 3439 |
|
| 3440 |
When such operations are initiated, a job object implementing |
| 3441 |
this interface may be created so the progress can be tracked by |
| 3442 |
the caller (and also other observers). |
| 3443 |
|
| 3444 |
The object(s) that a job affects (such as block devices or |
| 3445 |
drives) can be determined by looking at the |
| 3446 |
#org.freedesktop.UDisks2.Job:Objects property. Among other |
| 3447 |
things, this can be used to draw a spinner in the user interface |
| 3448 |
next to e.g. an icon for the drive or device in question. |
| 3449 |
|
| 3450 |
The #org.freedesktop.UDisks2.Job:Operation property is used to |
| 3451 |
convey the type of job currently in progress. |
| 3452 |
|
| 3453 |
The user id of the user who started the job is set in the |
| 3454 |
#org.freedesktop.UDisks2.Job:StartedByUID property. |
| 3455 |
|
| 3456 |
A job <emphasis>may</emphasis> convey how much progress has been |
| 3457 |
made, see the #org.freedesktop.UDisks2.Job:Progress and |
| 3458 |
#org.freedesktop.UDisks2.Job:ProgressValid properties. |
| 3459 |
|
| 3460 |
When a job completes, the #org.freedesktop.UDisks2.Job::Completed signal |
| 3461 |
is emitted. |
| 3462 |
|
| 3463 |
A job may or may not be cancelable, see the |
| 3464 |
#org.freedesktop.UDisks2.Job:Cancelable property. To cancel a |
| 3465 |
job use the org.freedesktop.UDisks2.Job.Cancel() method. This |
| 3466 |
will cause the job to complete (with @success set to %FALSE) and |
| 3467 |
the D-Bus method used to initiate the operation to return, |
| 3468 |
usually returning the |
| 3469 |
<literal>org.freedesktop.UDisks2.Error.Cancelled</literal> |
| 3470 |
error. Once cancellation is requested it may take some time before |
| 3471 |
the job is actually completed as there might be ongoing I/O. |
| 3472 |
--> |
| 3473 |
<interface name="org.freedesktop.UDisks2.Job"> |
| 3474 |
|
| 3475 |
<!-- Operation: |
| 3476 |
The type of the operation that the job represents. |
| 3477 |
|
| 3478 |
Known job operation types include: |
| 3479 |
<variablelist> |
| 3480 |
<varlistentry><term>ata-smart-selftest</term> |
| 3481 |
<listitem><para>SMART self-test operation.</para></listitem></varlistentry> |
| 3482 |
<varlistentry><term>drive-eject</term> |
| 3483 |
<listitem><para>Ejecting the medium from a drive.</para></listitem></varlistentry> |
| 3484 |
<varlistentry><term>encrypted-unlock</term> |
| 3485 |
<listitem><para>Unlocking encrypted device.</para></listitem></varlistentry> |
| 3486 |
<varlistentry><term>encrypted-lock</term> |
| 3487 |
<listitem><para>Locking encrypted device.</para></listitem></varlistentry> |
| 3488 |
<varlistentry><term>encrypted-modify</term> |
| 3489 |
<listitem><para>Modifying encrypted device.</para></listitem></varlistentry> |
| 3490 |
<varlistentry><term>encrypted-resize</term> |
| 3491 |
<listitem><para>Resizing encrypted device.</para></listitem></varlistentry> |
| 3492 |
<varlistentry><term>encrypted-convert</term> |
| 3493 |
<listitem><para>Converting encrypted device.</para></listitem></varlistentry> |
| 3494 |
<varlistentry><term>swapspace-start</term> |
| 3495 |
<listitem><para>Starting swapspace.</para></listitem></varlistentry> |
| 3496 |
<varlistentry><term>swapspace-stop</term> |
| 3497 |
<listitem><para>Stopping swapspace.</para></listitem></varlistentry> |
| 3498 |
<varlistentry><term>swapspace-modify</term> |
| 3499 |
<listitem><para>Modifying swapspace.</para></listitem></varlistentry> |
| 3500 |
<varlistentry><term>filesystem-mount</term> |
| 3501 |
<listitem><para>Mounting a filesystem.</para></listitem></varlistentry> |
| 3502 |
<varlistentry><term>filesystem-unmount</term> |
| 3503 |
<listitem><para>Unmounting a filesystem.</para></listitem></varlistentry> |
| 3504 |
<varlistentry><term>filesystem-modify</term> |
| 3505 |
<listitem><para>Modifying a filesystem.</para></listitem></varlistentry> |
| 3506 |
<varlistentry><term>filesystem-resize</term> |
| 3507 |
<listitem><para>Resizing a filesystem.</para></listitem></varlistentry> |
| 3508 |
<varlistentry><term>format-erase</term> |
| 3509 |
<listitem><para>Erasing a device.</para></listitem></varlistentry> |
| 3510 |
<varlistentry><term>format-mkfs</term> |
| 3511 |
<listitem><para>Creating a filesystem.</para></listitem></varlistentry> |
| 3512 |
<varlistentry><term>loop-setup</term> |
| 3513 |
<listitem><para>Setting up a loop device.</para></listitem></varlistentry> |
| 3514 |
<varlistentry><term>partition-modify</term> |
| 3515 |
<listitem><para>Modifying a partition.</para></listitem></varlistentry> |
| 3516 |
<varlistentry><term>partition-delete</term> |
| 3517 |
<listitem><para>Deleting a partition.</para></listitem></varlistentry> |
| 3518 |
<varlistentry><term>partition-create</term> |
| 3519 |
<listitem><para>Creating a partition.</para></listitem></varlistentry> |
| 3520 |
<varlistentry><term>cleanup</term> |
| 3521 |
<listitem><para>Cleaning up devices that were removed without being properly unmounted or shut down.</para></listitem></varlistentry> |
| 3522 |
<varlistentry><term>ata-secure-erase</term> |
| 3523 |
<listitem><para>ATA Secure Erase.</para></listitem></varlistentry> |
| 3524 |
<varlistentry><term>ata-enhanced-secure-erase</term> |
| 3525 |
<listitem><para>ATA Enhanced Secure Erase.</para></listitem></varlistentry> |
| 3526 |
<varlistentry><term>md-raid-stop</term> |
| 3527 |
<listitem><para>Stopping a RAID Array.</para></listitem></varlistentry> |
| 3528 |
<varlistentry><term>md-raid-start</term> |
| 3529 |
<listitem><para>Starting a RAID Array.</para></listitem></varlistentry> |
| 3530 |
<varlistentry><term>md-raid-fault-device</term> |
| 3531 |
<listitem><para>Marking device in RAID Array as faulty.</para></listitem></varlistentry> |
| 3532 |
<varlistentry><term>md-raid-remove-device</term> |
| 3533 |
<listitem><para>Removing device from RAID Array.</para></listitem></varlistentry> |
| 3534 |
<varlistentry><term>md-raid-create</term> |
| 3535 |
<listitem><para>Create a RAID Array.</para></listitem></varlistentry> |
| 3536 |
<varlistentry><term>nvme-selftest</term> |
| 3537 |
<listitem><para>NVMe device self-test operation.</para></listitem></varlistentry> |
| 3538 |
<varlistentry><term>nvme-sanitize</term> |
| 3539 |
<listitem><para>NVMe sanitize operation.</para></listitem></varlistentry> |
| 3540 |
<varlistentry><term>nvme-format-ns</term> |
| 3541 |
<listitem><para>NVMe format namespace operation.</para></listitem></varlistentry> |
| 3542 |
</variablelist> |
| 3543 |
The |
| 3544 |
<link linkend="udisks-client-get-job-description">udisks_client_get_job_description()</link> |
| 3545 |
function can be used to get a localized human readable description. |
| 3546 |
--> |
| 3547 |
<property name="Operation" type="s" access="read"/> |
| 3548 |
|
| 3549 |
<!-- Progress: |
| 3550 |
How much progress has been made. Values are in the range 0 to 1. |
| 3551 |
|
| 3552 |
Do not use unless #org.freedesktop.UDisks2.Job:ProgressValid is %TRUE. |
| 3553 |
--> |
| 3554 |
<property name="Progress" type="d" access="read"/> |
| 3555 |
|
| 3556 |
<!-- ProgressValid: Set to %TRUE if the #org.freedesktop.UDisks2.Job:Progress is valid. --> |
| 3557 |
<property name="ProgressValid" type="b" access="read"/> |
| 3558 |
|
| 3559 |
<!-- Bytes: |
| 3560 |
@since: 2.0.0 |
| 3561 |
If the job involves processing a known number of bytes (for |
| 3562 |
example, erasing a disk), this property contains the total |
| 3563 |
number of bytes to process. If not, the value of this |
| 3564 |
property is zero. |
| 3565 |
|
| 3566 |
The intent of this property is for user interfaces to convey |
| 3567 |
information such as <quote>123 GB of 1.0 TB completed</quote>. |
| 3568 |
--> |
| 3569 |
<property name="Bytes" type="t" access="read"/> |
| 3570 |
|
| 3571 |
<!-- Rate: |
| 3572 |
@since: 2.0.0 |
| 3573 |
If the job involves processing a number of bytes (for |
| 3574 |
example, erasing) and the rate at which the processing takes |
| 3575 |
place is known, this property contains the rate (measured in |
| 3576 |
bytes per second). Otherwise the value of this property is |
| 3577 |
zero. |
| 3578 |
|
| 3579 |
The intent of this property is for user interfaces to convey |
| 3580 |
information such as <quote>110 MB/sec</quote>. |
| 3581 |
--> |
| 3582 |
<property name="Rate" type="t" access="read"/> |
| 3583 |
|
| 3584 |
<!-- StartTime: |
| 3585 |
|
| 3586 |
The point in time (micro-seconds since the <ulink |
| 3587 |
url="http://en.wikipedia.org/wiki/Unix_epoch">Unix |
| 3588 |
Epoch</ulink>) that the job was started. |
| 3589 |
--> |
| 3590 |
<property name="StartTime" type="t" access="read"/> |
| 3591 |
|
| 3592 |
<!-- ExpectedEndTime: |
| 3593 |
|
| 3594 |
The expected point in time (micro-seconds since the <ulink |
| 3595 |
url="http://en.wikipedia.org/wiki/Unix_epoch">Unix |
| 3596 |
Epoch</ulink>) that the job will complete or 0 if unknown. |
| 3597 |
--> |
| 3598 |
<property name="ExpectedEndTime" type="t" access="read"/> |
| 3599 |
|
| 3600 |
<!-- Objects: The objects that the job is related to, if any. --> |
| 3601 |
<property name="Objects" type="ao" access="read"/> |
| 3602 |
|
| 3603 |
<!-- StartedByUID: |
| 3604 |
The id of the user who started the job or 0 if started |
| 3605 |
by root or not through udisks. |
| 3606 |
--> |
| 3607 |
<property name="StartedByUID" type="u" access="read"/> |
| 3608 |
|
| 3609 |
<!-- |
| 3610 |
Cancel: |
| 3611 |
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>). |
| 3612 |
|
| 3613 |
Cancels the job. Fails with the |
| 3614 |
<literal>org.freedesktop.UDisks2.Error.Failed</literal> error |
| 3615 |
if #org.freedesktop.UDisks2.Job:Cancelable is %FALSE. |
| 3616 |
--> |
| 3617 |
<method name="Cancel"> |
| 3618 |
<arg name="options" direction="in" type="a{sv}"/> |
| 3619 |
</method> |
| 3620 |
|
| 3621 |
<!-- Cancelable: Whether the job can be canceled. --> |
| 3622 |
<property name="Cancelable" type="b" access="read"/> |
| 3623 |
|
| 3624 |
<!-- |
| 3625 |
Completed: |
| 3626 |
@success: If %TRUE, the job completed successfully. |
| 3627 |
@message: A message describing the completion of the job, e.g. an error message. |
| 3628 |
|
| 3629 |
Emitted when a job completes. |
| 3630 |
--> |
| 3631 |
<signal name="Completed"> |
| 3632 |
<arg name="success" type="b"/> |
| 3633 |
<arg name="message" type="s"/> |
| 3634 |
</signal> |
| 3635 |
</interface> |
| 3636 |
|
| 3637 |
<!-- ********************************************************************** --> |
| 3638 |
|
| 3639 |
</node> |