~ubuntu-branches/debian/squeeze/devicekit-disks/squeeze

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
<?xml version="1.0"?><!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="Disks">
  <refmeta>
    <refentrytitle role="top_of_page">org.freedesktop.DeviceKit.Disks</refentrytitle>
  </refmeta>
  <refnamediv>
    <refname>org.freedesktop.DeviceKit.Disks</refname>
    <refpurpose>Disks interface</refpurpose>
  </refnamediv>
  <refsynopsisdiv role="synopsis">
    <title role="synopsis.title">Methods</title>
    <synopsis><link linkend="Disks.EnumerateDevices">EnumerateDevices</link>              (out 'ao' devices)
<link linkend="Disks.EnumerateDeviceFiles">EnumerateDeviceFiles</link>          (out 'as' device_files)
<link linkend="Disks.FindDeviceByDeviceFile">FindDeviceByDeviceFile</link>        (in  's'  device_file,
                               out 'o'  device)
<link linkend="Disks.FindDeviceByMajorMinor">FindDeviceByMajorMinor</link>        (in  'x'  device_major,
                               in  'x'  device_minor,
                               out 'o'  device)
<link linkend="Disks.DriveInhibitAllPolling">DriveInhibitAllPolling</link>        (in  'as' options,
                               out 's'  cookie)
<link linkend="Disks.DriveUninhibitAllPolling">DriveUninhibitAllPolling</link>      (in  's'  cookie)
<link linkend="Disks.DriveSetAllSpindownTimeouts">DriveSetAllSpindownTimeouts</link>   (in  'i'  timeout_seconds,
                               in  'as' options,
                               out 's'  cookie)
<link linkend="Disks.DriveUnsetAllSpindownTimeouts">DriveUnsetAllSpindownTimeouts</link> (in  's'  cookie)
<link linkend="Disks.LinuxMdStart">LinuxMdStart</link>                  (in  'ao' components,
                               in  'as' options,
                               out 'o'  device)
<link linkend="Disks.LinuxMdCreate">LinuxMdCreate</link>                 (in  'ao' components,
                               in  's'  level,
                               in  't'  stripe_size,
                               in  's'  name,
                               in  'as' options,
                               out 'o'  device)
<link linkend="Disks.Inhibit">Inhibit</link>                       (out 's'  cookie)
<link linkend="Disks.Uninhibit">Uninhibit</link>                     (in  's'  cookie)
</synopsis>
  </refsynopsisdiv>
  <refsect1 role="signal_proto">
    <title role="signal_proto.title">Signals</title>
    <synopsis><link linkend="Disks::DeviceAdded">DeviceAdded</link>      ('o' device)
<link linkend="Disks::DeviceRemoved">DeviceRemoved</link>    ('o' device)
<link linkend="Disks::DeviceChanged">DeviceChanged</link>    ('o' device)
<link linkend="Disks::DeviceJobChanged">DeviceJobChanged</link> ('o' device,
                  'b' job_in_progress,
                  'b' job_is_cancellable,
                  's' job_id,
                  'i' job_num_tasks,
                  'i' job_cur_task,
                  's' job_cur_task_id,
                  'd' job_cur_task_percentage)
</synopsis>
  </refsect1>
  <refsect1 role="impl_interfaces">
    <title role="impl_interfaces.title">Implemented Interfaces</title>
    <para>
    Objects implementing org.freedesktop.DeviceKit.Disks also implements
    org.freedesktop.DBus.Introspectable,
    org.freedesktop.DBus.Properties
    </para>
  </refsect1>
  <refsect1 role="properties">
    <title role="properties.title">Properties</title>
    <synopsis><link linkend="Disks:DaemonVersion">'DaemonVersion'</link>       read      's'
<link linkend="Disks:DaemonIsInhibited">'DaemonIsInhibited'</link>   read      'b'
<link linkend="Disks:SupportsLuksDevices">'SupportsLuksDevices'</link> read      'b'
<link linkend="Disks:KnownFilesystems">'KnownFilesystems'</link>    read      'a(ssbbbubbbbbbbb)'
</synopsis>
  </refsect1>
  <refsect1 role="desc">
    <title role="desc.title">Description</title>
    <para/>
  </refsect1>
  <refsect1 role="details"><title role="details.title">Details</title><refsect2><title><anchor role="function" id="Disks.EnumerateDevices"/>EnumerateDevices ()</title><indexterm><primary>EnumerateDevices</primary><secondary>Disks</secondary></indexterm><programlisting>EnumerateDevices (out 'ao' devices)</programlisting></refsect2>
          <para>
            Enumerate all disk devices on the system.
          </para>
        <variablelist role="params"><varlistentry><term><parameter>devices</parameter>:</term><listitem><simpara>An array of object paths for devices.</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Disks.EnumerateDeviceFiles"/>EnumerateDeviceFiles ()</title><indexterm><primary>EnumerateDeviceFiles</primary><secondary>Disks</secondary></indexterm><programlisting>EnumerateDeviceFiles (out 'as' device_files)</programlisting></refsect2>
          <para>
            Enumerate all device files (including symlinks) for disk devices on the system.
          </para>
        <variablelist role="params"><varlistentry><term><parameter>device_files</parameter>:</term><listitem><simpara>An array device file names.</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Disks.FindDeviceByDeviceFile"/>FindDeviceByDeviceFile ()</title><indexterm><primary>FindDeviceByDeviceFile</primary><secondary>Disks</secondary></indexterm><programlisting>FindDeviceByDeviceFile (in  's' device_file,
                        out 'o' device)</programlisting></refsect2>
          <para>
            Finds a device by device path.
          </para>
        <variablelist role="params"><varlistentry><term><parameter>device_file</parameter>:</term><listitem><simpara>UNIX special device file</simpara></listitem></varlistentry><varlistentry><term><parameter>device</parameter>:</term><listitem><simpara>Object path of device</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Disks.FindDeviceByMajorMinor"/>FindDeviceByMajorMinor ()</title><indexterm><primary>FindDeviceByMajorMinor</primary><secondary>Disks</secondary></indexterm><programlisting>FindDeviceByMajorMinor (in  'x' device_major,
                        in  'x' device_minor,
                        out 'o' device)</programlisting></refsect2>
          <para>
            Finds a device by major:minor.
          </para>
        <variablelist role="params"><varlistentry><term><parameter>device_major</parameter>:</term><listitem><simpara>Device major</simpara></listitem></varlistentry><varlistentry><term><parameter>device_minor</parameter>:</term><listitem><simpara>Device minor</simpara></listitem></varlistentry><varlistentry><term><parameter>device</parameter>:</term><listitem><simpara>Object path of device</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Disks.DriveInhibitAllPolling"/>DriveInhibitAllPolling ()</title><indexterm><primary>DriveInhibitAllPolling</primary><secondary>Disks</secondary></indexterm><programlisting>DriveInhibitAllPolling (in  'as' options,
                        out 's'  cookie)</programlisting></refsect2>
          <para>
            Inhibits the daemon from polling devices for media changes.
          </para>
        <variablelist role="params"><varlistentry><term><parameter>options</parameter>:</term><listitem><simpara>Inhibit options. Currently no options are recognized.</simpara></listitem></varlistentry><varlistentry><term><parameter>cookie</parameter>:</term><listitem><simpara>
            A cookie that can be used in the
            <link linkend="Disks.DriveUninhibitAllPolling"><function>DriveUninhibitAllPolling()</function></link> method
            to stop inhibiting polling of all devices.
        </simpara></listitem></varlistentry></variablelist><refsect3><title>Errors</title><variablelist role="errors"><varlistentry><term><parameter>org.freedesktop.PolicyKit.Error.NotAuthorized</parameter>:</term><listitem><simpara>if the caller lacks the appropriate PolicyKit authorization</simpara></listitem></varlistentry><varlistentry><term><parameter>org.freedesktop.DeviceKit.Disks.Error.Failed</parameter>:</term><listitem><simpara>if the operation failed</simpara></listitem></varlistentry></variablelist></refsect3><refsect3><title>Permissions</title><para role="permission">
          The caller will need one of the following PolicyKit authorizations:
          <para><itemizedlist><listitem><emphasis role="bold">org.freedesktop.devicekit.disks.inhibit-polling: </emphasis>To inhibit polling</listitem></itemizedlist></para>
        </para></refsect3><refsect2><title><anchor role="function" id="Disks.DriveUninhibitAllPolling"/>DriveUninhibitAllPolling ()</title><indexterm><primary>DriveUninhibitAllPolling</primary><secondary>Disks</secondary></indexterm><programlisting>DriveUninhibitAllPolling (in  's' cookie)</programlisting></refsect2>
          <para>
            Uninhibits daemon from polling devices for media changes.
          </para>
        <variablelist role="params"><varlistentry><term><parameter>cookie</parameter>:</term><listitem><simpara>
            A cookie obtained from the
            <link linkend="Disks.DriveInhibitAllPolling"><function>DriveInhibitAllPolling()</function></link> method.
        </simpara></listitem></varlistentry></variablelist><refsect3><title>Errors</title><variablelist role="errors"><varlistentry><term><parameter>org.freedesktop.DeviceKit.Disks.Error.Failed</parameter>:</term><listitem><simpara>if the given cookie is malformed</simpara></listitem></varlistentry></variablelist></refsect3><refsect2><title><anchor role="function" id="Disks.DriveSetAllSpindownTimeouts"/>DriveSetAllSpindownTimeouts ()</title><indexterm><primary>DriveSetAllSpindownTimeouts</primary><secondary>Disks</secondary></indexterm><programlisting>DriveSetAllSpindownTimeouts (in  'i'  timeout_seconds,
                             in  'as' options,
                             out 's'  cookie)</programlisting></refsect2>
          <para>
            Configures spindown timeout for all drives capable of being spun down.
            Caution should be exercised when using this method, see
            the SPINNING DOWN DISKS section in the
            devkit-disks<literal>(1)</literal> man page before using it.
          </para>
        <variablelist role="params"><varlistentry><term><parameter>timeout_seconds</parameter>:</term><listitem><simpara>
            Number of seconds before drives should be spun down.
        </simpara></listitem></varlistentry><varlistentry><term><parameter>options</parameter>:</term><listitem><simpara>
            Options related to setting spindown timeouts. Currently no options are recognized.
        </simpara></listitem></varlistentry><varlistentry><term><parameter>cookie</parameter>:</term><listitem><simpara>
            A cookie that can be used in the
            <link linkend="Drive.DriveUnsetAllSpindownTimeouts"><function>DriveUnsetAllSpindownTimeouts()</function></link> method
            to unset the spindown timeout for drives.
        </simpara></listitem></varlistentry></variablelist><refsect3><title>Errors</title><variablelist role="errors"><varlistentry><term><parameter>org.freedesktop.PolicyKit.Error.NotAuthorized</parameter>:</term><listitem><simpara>if the caller lacks the appropriate PolicyKit authorization</simpara></listitem></varlistentry><varlistentry><term><parameter>org.freedesktop.DeviceKit.Disks.Error.Failed</parameter>:</term><listitem><simpara>if the operation failed</simpara></listitem></varlistentry><varlistentry><term><parameter>org.freedesktop.DeviceKit.Disks.Error.InvalidOption</parameter>:</term><listitem><simpara>if an invalid or malformed option was given</simpara></listitem></varlistentry></variablelist></refsect3><refsect3><title>Permissions</title><para role="permission">
          The caller will need one of the following PolicyKit authorizations:
          <para><itemizedlist><listitem><emphasis role="bold">org.freedesktop.devicekit.disks.drive-set-spindown: </emphasis>To set spindown timeouts</listitem></itemizedlist></para>
        </para></refsect3><refsect2><title><anchor role="function" id="Disks.DriveUnsetAllSpindownTimeouts"/>DriveUnsetAllSpindownTimeouts ()</title><indexterm><primary>DriveUnsetAllSpindownTimeouts</primary><secondary>Disks</secondary></indexterm><programlisting>DriveUnsetAllSpindownTimeouts (in  's' cookie)</programlisting></refsect2>
          <para>
            Unsets spindown timeout for the drive.
          </para>
        <variablelist role="params"><varlistentry><term><parameter>cookie</parameter>:</term><listitem><simpara>
            A cookie obtained from the
            <link linkend="Device.DriveSetSpindownTimeout"><function>DriveSetSpindownTimeout()</function></link> method.
        </simpara></listitem></varlistentry></variablelist><refsect3><title>Errors</title><variablelist role="errors"><varlistentry><term><parameter>org.freedesktop.PolicyKit.Error.NotAuthorized</parameter>:</term><listitem><simpara>if the caller lacks the appropriate PolicyKit authorization</simpara></listitem></varlistentry><varlistentry><term><parameter>org.freedesktop.DeviceKit.Disks.Error.Failed</parameter>:</term><listitem><simpara>if the operation failed</simpara></listitem></varlistentry></variablelist></refsect3><refsect3><title>Permissions</title><para role="permission">
          The caller will need one of the following PolicyKit authorizations:
          <para><itemizedlist><listitem><emphasis role="bold">org.freedesktop.devicekit.disks.drive-set-spindown: </emphasis>To set spindown timeouts</listitem></itemizedlist></para>
        </para></refsect3><refsect2><title><anchor role="function" id="Disks.LinuxMdStart"/>LinuxMdStart ()</title><indexterm><primary>LinuxMdStart</primary><secondary>Disks</secondary></indexterm><programlisting>LinuxMdStart (in  'ao' components,
              in  'as' options,
              out 'o'  device)</programlisting></refsect2>
          <para>
            Starts an Linux md RAID array. The array will be assembled
            and started in degraded mode if an insufficient number of
            components are given.
          </para>
        <variablelist role="params"><varlistentry><term><parameter>components</parameter>:</term><listitem><simpara>The object paths of the components of the array to start.</simpara></listitem></varlistentry><varlistentry><term><parameter>options</parameter>:</term><listitem><simpara>Options for starting the array. Currently no options are supported.</simpara></listitem></varlistentry><varlistentry><term><parameter>device</parameter>:</term><listitem><simpara>The object path of the assembled array device.</simpara></listitem></varlistentry></variablelist><refsect3><title>Errors</title><variablelist role="errors"><varlistentry><term><parameter>org.freedesktop.PolicyKit.Error.NotAuthorized</parameter>:</term><listitem><simpara>if the caller lacks the appropriate PolicyKit authorization</simpara></listitem></varlistentry><varlistentry><term><parameter>org.freedesktop.DeviceKit.Disks.Error.Busy</parameter>:</term><listitem><simpara>if one of the given components are busy</simpara></listitem></varlistentry><varlistentry><term><parameter>org.freedesktop.DeviceKit.Disks.Error.Failed</parameter>:</term><listitem><simpara>if the operation failed</simpara></listitem></varlistentry><varlistentry><term><parameter>org.freedesktop.DeviceKit.Disks.Error.Cancelled</parameter>:</term><listitem><simpara>if the job was cancelled</simpara></listitem></varlistentry></variablelist></refsect3><refsect3><title>Permissions</title><para role="permission">
          The caller will need the following PolicyKit authorization:
          <para><itemizedlist><listitem><emphasis role="bold">org.freedesktop.devicekit.disks.linux-md: </emphasis>
                Needed to configured Linux md Software RAID devices.
              </listitem></itemizedlist></para>
        </para></refsect3><refsect2><title><anchor role="function" id="Disks.LinuxMdCreate"/>LinuxMdCreate ()</title><indexterm><primary>LinuxMdCreate</primary><secondary>Disks</secondary></indexterm><programlisting>LinuxMdCreate (in  'ao' components,
               in  's'  level,
               in  't'  stripe_size,
               in  's'  name,
               in  'as' options,
               out 'o'  device)</programlisting></refsect2>
          <para>
            Creates a Linux md RAID array. The array will be created and
            assembled.
          </para>
        <variablelist role="params"><varlistentry><term><parameter>components</parameter>:</term><listitem><simpara>The object paths of the components to use for the array.</simpara></listitem></varlistentry><varlistentry><term><parameter>level</parameter>:</term><listitem><simpara>RAID level.</simpara></listitem></varlistentry><varlistentry><term><parameter>stripe_size</parameter>:</term><listitem><simpara>Stripe Size in bytes, or 0 to use the default stripe size.</simpara></listitem></varlistentry><varlistentry><term><parameter>name</parameter>:</term><listitem><simpara>Name of the array.</simpara></listitem></varlistentry><varlistentry><term><parameter>options</parameter>:</term><listitem><simpara>Options for creating the array. Currently no options are supported.</simpara></listitem></varlistentry><varlistentry><term><parameter>device</parameter>:</term><listitem><simpara>The object path of the created array device.</simpara></listitem></varlistentry></variablelist><refsect3><title>Errors</title><variablelist role="errors"><varlistentry><term><parameter>org.freedesktop.PolicyKit.Error.NotAuthorized</parameter>:</term><listitem><simpara>if the caller lacks the appropriate PolicyKit authorization</simpara></listitem></varlistentry><varlistentry><term><parameter>org.freedesktop.DeviceKit.Disks.Error.Busy</parameter>:</term><listitem><simpara>if one of the given components are busy</simpara></listitem></varlistentry><varlistentry><term><parameter>org.freedesktop.DeviceKit.Disks.Error.Failed</parameter>:</term><listitem><simpara>if the operation failed</simpara></listitem></varlistentry><varlistentry><term><parameter>org.freedesktop.DeviceKit.Disks.Error.Cancelled</parameter>:</term><listitem><simpara>if the job was cancelled</simpara></listitem></varlistentry></variablelist></refsect3><refsect3><title>Permissions</title><para role="permission">
          The caller will need the following PolicyKit authorization:
          <para><itemizedlist><listitem><emphasis role="bold">org.freedesktop.devicekit.disks.linux-md: </emphasis>
                Needed to configured Linux md Software RAID devices.
              </listitem></itemizedlist></para>
        </para></refsect3><refsect2><title><anchor role="function" id="Disks.Inhibit"/>Inhibit ()</title><indexterm><primary>Inhibit</primary><secondary>Disks</secondary></indexterm><programlisting>Inhibit (out 's' cookie)</programlisting></refsect2>
          <para>
            Inhibits clients from invoking methods on the daemon
            of the daemon that require authorization (all methods
            will return the <literal>org.freedesktop.DeviceKit.Disks.Error.Inhibited</literal> error)
            if the caller is not the super user.
            This is typically used by OS installers and other
            programs that expects full control of the system, specifically
            to avoid automounting devices.
          </para>
        <variablelist role="params"><varlistentry><term><parameter>cookie</parameter>:</term><listitem><simpara>
            A cookie that can be used in the
            <link linkend="Disks.Uninhibit"><function>Uninhibit()</function></link> method.
            to stop inhibiting the daemon.
        </simpara></listitem></varlistentry></variablelist><refsect3><title>Errors</title><variablelist role="errors"><varlistentry><term><parameter>org.freedesktop.PolicyKit.Error.NotAuthorized</parameter>:</term><listitem><simpara>if the caller is not the super user</simpara></listitem></varlistentry></variablelist></refsect3><refsect3><title>Permissions</title><para role="permission">
          Only the super user can invoke this method.
        </para></refsect3><refsect2><title><anchor role="function" id="Disks.Uninhibit"/>Uninhibit ()</title><indexterm><primary>Uninhibit</primary><secondary>Disks</secondary></indexterm><programlisting>Uninhibit (in  's' cookie)</programlisting></refsect2>
          <para>
            Uninhibits other clients from using the daemon.
          </para>
        <variablelist role="params"><varlistentry><term><parameter>cookie</parameter>:</term><listitem><simpara>
            A cookie obtained from the
            <link linkend="Disks.Inhibit"><function>Inhibit()</function></link> method.
        </simpara></listitem></varlistentry></variablelist><refsect3><title>Errors</title><variablelist role="errors"><varlistentry><term><parameter>org.freedesktop.DeviceKit.Disks.Error.Failed</parameter>:</term><listitem><simpara>if the given cookie is malformed</simpara></listitem></varlistentry></variablelist></refsect3></refsect1>
  <refsect1 role="signals"><title role="signals.title">Signal Details</title><refsect2><title><anchor role="function" id="Disks::DeviceAdded"/>The DeviceAdded signal</title><indexterm><primary>DeviceAdded</primary><secondary>Disks</secondary></indexterm><programlisting>DeviceAdded ('o' device)</programlisting></refsect2>
          <para>
            Emitted when a device is added.
          </para>
        <variablelist role="params"><varlistentry><term><parameter>device</parameter>:</term><listitem><simpara>Object path of device that was added.</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Disks::DeviceRemoved"/>The DeviceRemoved signal</title><indexterm><primary>DeviceRemoved</primary><secondary>Disks</secondary></indexterm><programlisting>DeviceRemoved ('o' device)</programlisting></refsect2>
          <para>
            Emitted when a device is removed.
          </para>
        <variablelist role="params"><varlistentry><term><parameter>device</parameter>:</term><listitem><simpara>Object path of device that was removed.</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Disks::DeviceChanged"/>The DeviceChanged signal</title><indexterm><primary>DeviceChanged</primary><secondary>Disks</secondary></indexterm><programlisting>DeviceChanged ('o' device)</programlisting></refsect2>
          <para>
            Emitted when a device changed.
          </para>
        <variablelist role="params"><varlistentry><term><parameter>device</parameter>:</term><listitem><simpara>Object path of device that was changed.</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Disks::DeviceJobChanged"/>The DeviceJobChanged signal</title><indexterm><primary>DeviceJobChanged</primary><secondary>Disks</secondary></indexterm><programlisting>DeviceJobChanged ('o' device,
                  'b' job_in_progress,
                  'b' job_is_cancellable,
                  's' job_id,
                  'i' job_num_tasks,
                  'i' job_cur_task,
                  's' job_cur_task_id,
                  'd' job_cur_task_percentage)</programlisting></refsect2>
          <para>
            Emitted when a job on a device changes.
          </para>
        <variablelist role="params"><varlistentry><term><parameter>device</parameter>:</term><listitem><simpara>The object path of the device.</simpara></listitem></varlistentry><varlistentry><term><parameter>job_in_progress</parameter>:</term><listitem><simpara>Whether a job is currently in progress.</simpara></listitem></varlistentry><varlistentry><term><parameter>job_is_cancellable</parameter>:</term><listitem><simpara>Whether the job is cancellable.</simpara></listitem></varlistentry><varlistentry><term><parameter>job_id</parameter>:</term><listitem><simpara>The identifier of the job.</simpara></listitem></varlistentry><varlistentry><term><parameter>job_num_tasks</parameter>:</term><listitem><simpara>Number of tasks in the job.</simpara></listitem></varlistentry><varlistentry><term><parameter>job_cur_task</parameter>:</term><listitem><simpara>Current task number (zero-based offset).</simpara></listitem></varlistentry><varlistentry><term><parameter>job_cur_task_id</parameter>:</term><listitem><simpara>Task identifier for current task.</simpara></listitem></varlistentry><varlistentry><term><parameter>job_cur_task_percentage</parameter>:</term><listitem><simpara>Percentage completed of current task (between 0 and 100, negative if unknown).</simpara></listitem></varlistentry></variablelist></refsect1>
  <refsect1 role="property_details">
    <title role="property_details.title">Property Details</title>
    <refsect2>
      <title><anchor role="function" id="Disks:DaemonVersion"/>The "DaemonVersion" property</title>
      <indexterm>
        <primary>DaemonVersion</primary>
        <secondary>Disks</secondary>
      </indexterm>
      <programlisting>'DaemonVersion'  read      's'
</programlisting>
    </refsect2>
    <para>
            The version of the running daemon.
      </para>
    <variablelist role="params"/>
    <refsect2>
      <title><anchor role="function" id="Disks:DaemonIsInhibited"/>The "DaemonIsInhibited" property</title>
      <indexterm>
        <primary>DaemonIsInhibited</primary>
        <secondary>Disks</secondary>
      </indexterm>
      <programlisting>'DaemonIsInhibited'  read      'b'
</programlisting>
    </refsect2>
    <para>
            TRUE only if the daemon is inhibited.
      </para>
    <variablelist role="params"/>
    <refsect2>
      <title><anchor role="function" id="Disks:SupportsLuksDevices"/>The "SupportsLuksDevices" property</title>
      <indexterm>
        <primary>SupportsLuksDevices</primary>
        <secondary>Disks</secondary>
      </indexterm>
      <programlisting>'SupportsLuksDevices'  read      'b'
</programlisting>
    </refsect2>
    <para>
            TRUE only if the daemon can create encrypted LUKS block devices, see the
            <link linkend="Device.LuksLock"><function>LuksUnlock()</function></link> and
            <link linkend="Device.LuksLock"><function>LuksLock()</function></link>
            methods for details.
      </para>
    <variablelist role="params"/>
    <refsect2>
      <title><anchor role="function" id="Disks:KnownFilesystems"/>The "KnownFilesystems" property</title>
      <indexterm>
        <primary>KnownFilesystems</primary>
        <secondary>Disks</secondary>
      </indexterm>
      <programlisting>'KnownFilesystems'  read      'a(ssbbbubbbbbbbb)'
</programlisting>
    </refsect2>
    <para>
            An array of file systems known to the daemon and what features are supported.
            Each element in the array contains the following members:
            <para><itemizedlist><listitem><emphasis role="bold">id: </emphasis>
                  The name / identifier of the file system (such as <literal>ext3</literal> or <literal>vfat</literal>),
                  similar to the contents of the
                  <link linkend="Device:IdType"><literal>Device:IdType</literal></link>
                  property.
                </listitem><listitem><emphasis role="bold">name: </emphasis>
                  A human readable name for the file system such as "Linux Ext3".
                </listitem><listitem><emphasis role="bold">supports_unix_owners: </emphasis>
                  Whether the file system supports the UNIX owners model (e.g. ext3 does, but vfat doesn't).
                </listitem><listitem><emphasis role="bold">can_mount: </emphasis>
                  Whether the file system can be mounted.
                </listitem><listitem><emphasis role="bold">can_create: </emphasis>
                  Whether the file system can be created on a device.
                </listitem><listitem><emphasis role="bold">max_label_len: </emphasis>
                  The maximum amount of bytes that the file system label can hold. Set to zero if the file
                  system doesn't support labels.
                </listitem><listitem><emphasis role="bold">supports_label_rename: </emphasis>
                  Whether the label of the file system can be changed.
                </listitem><listitem><emphasis role="bold">supports_online_label_rename: </emphasis>
                  Whether the label can be changed while the file system is mounted.
                </listitem><listitem><emphasis role="bold">supports_fsck: </emphasis>
                  Whether the file system can be checked.
                </listitem><listitem><emphasis role="bold">supports_online_fsck: </emphasis>
                  Whether the file system can be checked while mounted.
                </listitem><listitem><emphasis role="bold">supports_resize_enlarge: </emphasis>
                  Whether the file system can be enlarged.
                </listitem><listitem><emphasis role="bold">supports_online_resize_enlarge: </emphasis>
                  Whether the file system can be enlarged while mounted.
                </listitem><listitem><emphasis role="bold">supports_resize_shrink: </emphasis>
                  Whether the file system can be shrunk.
                </listitem><listitem><emphasis role="bold">supports_online_resize_shrink: </emphasis>
                  Whether the file system can be shrunk while mounted.
                </listitem></itemizedlist></para>

      </para>
    <variablelist role="params"/>
  </refsect1>
</refentry>