]>
Commit | Line | Data |
---|---|---|
23e5c8d2 LB |
1 | <?xml version='1.0'?> |
2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" | |
eea10b26 | 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" > |
23e5c8d2 LB |
4 | <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> |
5 | ||
6 | <refentry id="org.freedesktop.portable1" conditional='ENABLE_PORTABLED' | |
7 | xmlns:xi="http://www.w3.org/2001/XInclude"> | |
8 | <refentryinfo> | |
9 | <title>org.freedesktop.portable1</title> | |
10 | <productname>systemd</productname> | |
11 | </refentryinfo> | |
12 | ||
13 | <refmeta> | |
14 | <refentrytitle>org.freedesktop.portable1</refentrytitle> | |
15 | <manvolnum>5</manvolnum> | |
16 | </refmeta> | |
17 | ||
18 | <refnamediv> | |
19 | <refname>org.freedesktop.portable1</refname> | |
20 | <refpurpose>The D-Bus interface of systemd-portabled</refpurpose> | |
21 | </refnamediv> | |
22 | ||
23 | <refsect1> | |
24 | <title>Introduction</title> | |
25 | ||
26 | <para> | |
27 | <citerefentry><refentrytitle>systemd-portabled.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
28 | is a system service that may be used to attach, detach and inspect portable services. This page describes the | |
29 | D-Bus interface.</para> | |
30 | </refsect1> | |
31 | ||
32 | <refsect1> | |
33 | <title>The Manager Object</title> | |
34 | ||
35 | <para>The service exposes the following interfaces on the Manager object on the bus:</para> | |
36 | ||
37 | <programlisting executable="systemd-portabled" node="/org/freedesktop/portable1" interface="org.freedesktop.portable1.Manager"> | |
38 | node /org/freedesktop/portable1 { | |
39 | interface org.freedesktop.portable1.Manager { | |
40 | methods: | |
41 | GetImage(in s image, | |
42 | out o object); | |
c068a17f | 43 | ListImages(out a(ssbtttso) images); |
23e5c8d2 LB |
44 | GetImageOSRelease(in s image, |
45 | out a{ss} os_release); | |
46 | GetImageMetadata(in s image, | |
47 | in as matches, | |
48 | out s image, | |
49 | out ay os_release, | |
50 | out a{say} units); | |
907952bb LB |
51 | GetImageMetadataWithExtensions(in s image, |
52 | in as extensions, | |
53 | in as matches, | |
54 | in t flags, | |
55 | out s image, | |
56 | out ay os_release, | |
087a799f | 57 | out a{say} extensions, |
907952bb | 58 | out a{say} units); |
23e5c8d2 LB |
59 | GetImageState(in s image, |
60 | out s state); | |
0017415c LB |
61 | GetImageStateWithExtensions(in s image, |
62 | in as extensions, | |
63 | in t flags, | |
64 | out s state); | |
23e5c8d2 LB |
65 | AttachImage(in s image, |
66 | in as matches, | |
67 | in s profile, | |
68 | in b runtime, | |
69 | in s copy_mode, | |
70 | out a(sss) changes); | |
907952bb LB |
71 | AttachImageWithExtensions(in s image, |
72 | in as extensions, | |
73 | in as matches, | |
74 | in s profile, | |
75 | in s copy_mode, | |
76 | in t flags, | |
77 | out a(sss) changes); | |
23e5c8d2 LB |
78 | DetachImage(in s image, |
79 | in b runtime, | |
80 | out a(sss) changes); | |
907952bb LB |
81 | DetachImageWithExtensions(in s image, |
82 | in as extensions, | |
83 | in t flags, | |
84 | out a(sss) changes); | |
23e5c8d2 LB |
85 | ReattachImage(in s image, |
86 | in as matches, | |
87 | in s profile, | |
88 | in b runtime, | |
89 | in s copy_mode, | |
90 | out a(sss) changes_removed, | |
91 | out a(sss) changes_updated); | |
907952bb LB |
92 | ReattachImageWithExtensions(in s image, |
93 | in as extensions, | |
94 | in as matches, | |
95 | in s profile, | |
96 | in s copy_mode, | |
97 | in t flags, | |
98 | out a(sss) changes_removed, | |
99 | out a(sss) changes_updated); | |
23e5c8d2 LB |
100 | RemoveImage(in s image); |
101 | MarkImageReadOnly(in s image, | |
102 | in b read_only); | |
103 | SetImageLimit(in s image, | |
104 | in t limit); | |
105 | SetPoolLimit(in t limit); | |
106 | properties: | |
107 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
108 | readonly s PoolPath = '...'; | |
109 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
110 | readonly t PoolUsage = ...; | |
111 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
112 | readonly t PoolLimit = ...; | |
113 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
114 | readonly as Profiles = ['...', ...]; | |
115 | }; | |
116 | interface org.freedesktop.DBus.Peer { ... }; | |
117 | interface org.freedesktop.DBus.Introspectable { ... }; | |
118 | interface org.freedesktop.DBus.Properties { ... }; | |
119 | }; | |
120 | </programlisting> | |
121 | ||
122 | <!--Autogenerated cross-references for systemd.directives, do not edit--> | |
123 | ||
124 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.portable1.Manager"/> | |
125 | ||
126 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.portable1.Manager"/> | |
127 | ||
128 | <variablelist class="dbus-method" generated="True" extra-ref="GetImage()"/> | |
129 | ||
130 | <variablelist class="dbus-method" generated="True" extra-ref="ListImages()"/> | |
131 | ||
132 | <variablelist class="dbus-method" generated="True" extra-ref="GetImageOSRelease()"/> | |
133 | ||
134 | <variablelist class="dbus-method" generated="True" extra-ref="GetImageMetadata()"/> | |
135 | ||
907952bb LB |
136 | <variablelist class="dbus-method" generated="True" extra-ref="GetImageMetadataWithExtensions()"/> |
137 | ||
23e5c8d2 LB |
138 | <variablelist class="dbus-method" generated="True" extra-ref="GetImageState()"/> |
139 | ||
0017415c LB |
140 | <variablelist class="dbus-method" generated="True" extra-ref="GetImageStateWithExtensions()"/> |
141 | ||
23e5c8d2 LB |
142 | <variablelist class="dbus-method" generated="True" extra-ref="AttachImage()"/> |
143 | ||
907952bb LB |
144 | <variablelist class="dbus-method" generated="True" extra-ref="AttachImageWithExtensions()"/> |
145 | ||
23e5c8d2 LB |
146 | <variablelist class="dbus-method" generated="True" extra-ref="DetachImage()"/> |
147 | ||
907952bb LB |
148 | <variablelist class="dbus-method" generated="True" extra-ref="DetachImageWithExtensions()"/> |
149 | ||
23e5c8d2 LB |
150 | <variablelist class="dbus-method" generated="True" extra-ref="ReattachImage()"/> |
151 | ||
907952bb LB |
152 | <variablelist class="dbus-method" generated="True" extra-ref="ReattachImageWithExtensions()"/> |
153 | ||
23e5c8d2 LB |
154 | <variablelist class="dbus-method" generated="True" extra-ref="RemoveImage()"/> |
155 | ||
156 | <variablelist class="dbus-method" generated="True" extra-ref="MarkImageReadOnly()"/> | |
157 | ||
158 | <variablelist class="dbus-method" generated="True" extra-ref="SetImageLimit()"/> | |
159 | ||
160 | <variablelist class="dbus-method" generated="True" extra-ref="SetPoolLimit()"/> | |
161 | ||
162 | <variablelist class="dbus-property" generated="True" extra-ref="PoolPath"/> | |
163 | ||
164 | <variablelist class="dbus-property" generated="True" extra-ref="PoolUsage"/> | |
165 | ||
166 | <variablelist class="dbus-property" generated="True" extra-ref="PoolLimit"/> | |
167 | ||
168 | <variablelist class="dbus-property" generated="True" extra-ref="Profiles"/> | |
169 | ||
170 | <!--End of Autogenerated section--> | |
171 | ||
172 | <refsect2> | |
173 | <title>Methods</title> | |
174 | ||
175 | <para><function>GetImage()</function> may be used to get the image object path of the image with the | |
176 | specified name.</para> | |
177 | ||
178 | <para><function>ListImages()</function> returns an array of all currently known images. The | |
179 | structures in the array consist of the following fields: image name, type, read-only flag, creation | |
180 | time, modification time, current disk space, usage and image object path.</para> | |
181 | ||
182 | <para><function>GetImageOSRelease()</function> retrieves the OS release information of an image. | |
183 | This method returns an array of key value pairs read from the | |
184 | <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry> file in | |
185 | the image and is useful to identify the operating system used in a portable service.</para> | |
186 | ||
187 | <para><function>GetImageMetadata()</function> retrieves metadata associated with an image. | |
188 | This method returns the image name, the image's <citerefentry><refentrytitle>os-release</refentrytitle> | |
189 | <manvolnum>5</manvolnum></citerefentry> content in the form of a (streamable) array of bytes, | |
190 | and a list of portable units contained in the image, in the form of a string (unit name) and | |
191 | an array of bytes with the content.</para> | |
192 | ||
087a799f ZJS |
193 | <para><function>GetImageMetadataWithExtensions()</function> retrieves metadata associated with an |
194 | image. This method is a superset of <function>GetImageMetadata()</function> with the addition of a list | |
195 | of extensions as input parameter, which were overlaid on top of the main image via | |
196 | <function>AttachImageWithExtensions()</function>. The path of each extension and an array of bytes with | |
197 | the content of the respective extension-release file are returned, one such structure for each | |
198 | extension named in the input arguments.</para> | |
907952bb | 199 | |
23e5c8d2 LB |
200 | <para><function>GetImageState()</function> retrieves the image state as one of the following |
201 | strings: | |
202 | <itemizedlist> | |
203 | <listitem><para>detached</para></listitem> | |
204 | ||
205 | <listitem><para>attached</para></listitem> | |
206 | ||
207 | <listitem><para>attached-runtime</para></listitem> | |
208 | ||
209 | <listitem><para>enabled</para></listitem> | |
210 | ||
211 | <listitem><para>enabled-runtime</para></listitem> | |
212 | ||
213 | <listitem><para>running</para></listitem> | |
214 | ||
215 | <listitem><para>running-runtime</para></listitem> | |
216 | </itemizedlist></para> | |
217 | ||
0017415c LB |
218 | <para><function>GetImageStateWithExtensions()</function> is a superset of |
219 | <function>GetImageState()</function>, with additional support for a list of extensions | |
220 | as input parameters, which is necessary to query the state in case the image was attached | |
221 | in that particular way. The <varname>flag</varname> parameter is currently unused and | |
222 | reserved for future purposes.</para> | |
223 | ||
23e5c8d2 LB |
224 | <para><function>AttachImage()</function> attaches a portable image to the system. |
225 | This method takes an image path or name, a list of strings that will be used to search for | |
226 | unit files inside the image (partial or complete matches), a string indicating which | |
227 | portable profile to use for the image (see <varname>Profiles</varname> property for | |
228 | a list of available profiles), a boolean indicating whether to attach the image only | |
229 | for the current boot session, and a string representing the preferred copy mode | |
230 | (whether to copy the image or to just symlink it) with the following possible values: | |
231 | <itemizedlist> | |
82047a6a | 232 | <listitem><para>(empty)</para></listitem> |
23e5c8d2 LB |
233 | |
234 | <listitem><para>copy</para></listitem> | |
235 | ||
236 | <listitem><para>symlink</para></listitem> | |
82047a6a LB |
237 | |
238 | <listitem><para>mixed</para></listitem> | |
23e5c8d2 | 239 | </itemizedlist> |
82047a6a LB |
240 | If an empty string is passed the security profile drop-ins and images will be symlinked while unit |
241 | files will be copied, <varname>copy</varname> will copy, <varname>symlink</varname> will prefer | |
242 | linking if possible (e.g.: a unit has to be copied out of an image), and <varname>mixed</varname> will | |
243 | prefer linking the resources owned by the OS (e.g.: the portable profile located within the host's | |
244 | /usr/ tree) but will copy the resources owned by the portable image (e.g.: the unit files and the | |
245 | images). This method returns the list of changes applied to the system (for example, which unit was | |
246 | added and is now available as a system service). Each change is represented as a triplet of strings: | |
247 | the type of change applied, the path on which it was applied, and the source (if any). The type of | |
248 | change applied will be one of the following possible values: | |
23e5c8d2 LB |
249 | <itemizedlist> |
250 | <listitem><para>copy</para></listitem> | |
251 | ||
252 | <listitem><para>symlink</para></listitem> | |
253 | ||
254 | <listitem><para>write</para></listitem> | |
255 | ||
256 | <listitem><para>mkdir</para></listitem> | |
257 | </itemizedlist> | |
258 | Note that an image cannot be attached if a unit that it contains is already present | |
803bcc43 LB |
259 | on the system. Note that this method returns only after all the listed operations are completed, |
260 | and due to the I/O involved it might take some time.</para> | |
23e5c8d2 | 261 | |
8257508c LB |
262 | <xi:include href="vpick.xml" xpointer="image"/> |
263 | <xi:include href="vpick.xml" xpointer="directory"/> | |
264 | ||
907952bb LB |
265 | <para><function>AttachImageWithExtensions()</function> attaches a portable image to the system. |
266 | This method is a superset of <function>AttachImage()</function> with the addition of | |
f1a5c566 | 267 | a list of extensions as input parameter, which will be overlaid on top of the main |
907952bb LB |
268 | image. When this method is used, detaching must be done by passing the same arguments via the |
269 | <function>DetachImageWithExtensions()</function> method. For more details on this functionality, | |
270 | see the <varname>MountImages=</varname> entry on | |
271 | <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
272 | and <citerefentry><refentrytitle>systemd-sysext</refentrytitle><manvolnum>8</manvolnum></citerefentry>. | |
3397a143 | 273 | </para> |
907952bb | 274 | |
23e5c8d2 LB |
275 | <para><function>DetachImage()</function> detaches a portable image from the system. |
276 | This method takes an image path or name, and a boolean indicating whether the image to | |
277 | detach was attached only for the current boot session or persistently. This method | |
278 | returns the list of changes applied to the system (for example, which unit was removed | |
279 | and is no longer available as a system service). Each change is represented as a triplet of | |
280 | strings: the type of change applied, the path on which it was applied, and the source | |
281 | (if any). The type of change applied will be one of the following possible values: | |
282 | <itemizedlist> | |
283 | <listitem><para>unlink</para></listitem> | |
284 | </itemizedlist> | |
803bcc43 LB |
285 | Note that an image cannot be detached if a unit that it contains is running. Note that this method |
286 | returns only after all the listed operations are completed, and due to the I/O involved it might take | |
287 | some time.</para> | |
23e5c8d2 | 288 | |
907952bb LB |
289 | <para><function>DetachImageWithExtensions()</function> detaches a portable image from the system. |
290 | This method is a superset of <function>DetachImage()</function> with the addition of | |
f1a5c566 | 291 | a list of extensions as input parameter, which were overlaid on top of the main |
55c1a411 | 292 | image via <function>AttachImageWithExtensions()</function>.</para> |
907952bb | 293 | |
23e5c8d2 LB |
294 | <para><function>ReattachImage()</function> combines the effects of the |
295 | <function>AttachImage()</function> method and the <function>DetachImage()</function> method. | |
296 | The difference is that it is allowed to reattach an image while one or more of its units | |
297 | are running. The reattach operation will fail if no matching image is attached. | |
298 | The input parameters match the <function>AttachImage()</function> method, and the return | |
299 | parameters are the combination of the return parameters of the | |
300 | <function>DetachImage()</function> method (first array, units that were removed) and the | |
301 | <function>AttachImage()</function> method (second array, units that were updated or added).</para> | |
302 | ||
907952bb LB |
303 | <para><function>ReattachImageWithExtensions()</function> reattaches a portable image to the system. |
304 | This method is a superset of <function>ReattachImage()</function> with the addition of | |
f1a5c566 | 305 | a list of extensions as input parameter, which will be overlaid on top of the main |
907952bb LB |
306 | image. For more details on this functionality, see the <varname>MountImages=</varname> entry on |
307 | <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
308 | and <citerefentry><refentrytitle>systemd-sysext</refentrytitle><manvolnum>8</manvolnum></citerefentry>. | |
55c1a411 | 309 | </para> |
907952bb | 310 | |
23e5c8d2 LB |
311 | <para><function>RemoveImage()</function> removes the image with the specified name.</para> |
312 | ||
313 | <para><function>MarkImageReadOnly()</function> toggles the read-only flag of an image.</para> | |
314 | ||
315 | <para><function>SetPoolLimit()</function> sets an overall quota limit on the pool of images.</para> | |
316 | ||
317 | <para><function>SetImageLimit()</function> sets a per-image quota limit.</para> | |
907952bb LB |
318 | |
319 | <para>The <function>AttachImageWithExtensions()</function>, | |
320 | <function>DetachImageWithExtensions()</function> and | |
321 | <function>ReattachImageWithExtensions()</function> methods take in options as flags instead of | |
c03a321e LB |
322 | booleans to allow for extendability. <varname>SD_SYSTEMD_PORTABLE_FORCE_ATTACH</varname> will bypass |
323 | the safety checks that ensure the units are not running while the image is attached or detached. | |
324 | <varname>SD_SYSTEMD_PORTABLE_FORCE_EXTENSION</varname> will bypass the check that ensures the | |
06768b90 | 325 | <filename>extension-release.<replaceable>NAME</replaceable></filename> file in the extension image |
c03a321e | 326 | matches the image name. They are defined as follows:</para> |
907952bb LB |
327 | |
328 | <programlisting> | |
db776f69 MG |
329 | #define SD_SYSTEMD_PORTABLE_RUNTIME (UINT64_C(1) << 0) |
330 | #define SD_SYSTEMD_PORTABLE_FORCE_ATTACH (UINT64_C(1) << 1) | |
331 | #define SD_SYSTEMD_PORTABLE_FORCE_EXTENSION (UINT64_C(1) << 2) | |
907952bb | 332 | </programlisting> |
23e5c8d2 LB |
333 | </refsect2> |
334 | ||
335 | <refsect2> | |
336 | <title>Properties</title> | |
337 | ||
338 | <para><varname>PoolPath</varname> specifies the file system path where images are written to.</para> | |
339 | ||
340 | <para><varname>PoolUsage</varname> specifies the current usage size of the image pool in bytes.</para> | |
341 | ||
342 | <para><varname>PoolLimit</varname> specifies the size limit of the image pool in bytes.</para> | |
343 | ||
344 | <para><varname>Profiles</varname> specifies the available runtime profiles for portable services.</para> | |
345 | </refsect2> | |
346 | </refsect1> | |
347 | ||
348 | <refsect1> | |
349 | <title>The Image Object</title> | |
350 | ||
351 | <para>The service exposes the following interfaces on the Image object on the bus:</para> | |
352 | ||
353 | <programlisting executable="systemd-portabled" node="/org/freedesktop/portable1" interface="org.freedesktop.portable1.Image"> | |
354 | node /org/freedesktop/portable1 { | |
355 | interface org.freedesktop.portable1.Image { | |
356 | methods: | |
c068a17f | 357 | GetOSRelease(out a{ss} os_release); |
23e5c8d2 LB |
358 | GetMetadata(in as matches, |
359 | out s image, | |
360 | out ay os_release, | |
361 | out a{say} units); | |
907952bb LB |
362 | GetMetadataWithExtensions(in as extensions, |
363 | in as matches, | |
364 | in t flags, | |
365 | out s image, | |
366 | out ay os_release, | |
087a799f | 367 | out a{say} extensions, |
907952bb | 368 | out a{say} units); |
c068a17f | 369 | GetState(out s state); |
0017415c LB |
370 | GetStateWithExtensions(in as extensions, |
371 | in t flags, | |
372 | out s state); | |
23e5c8d2 LB |
373 | Attach(in as matches, |
374 | in s profile, | |
375 | in b runtime, | |
376 | in s copy_mode, | |
377 | out a(sss) changes); | |
907952bb LB |
378 | AttachWithExtensions(in as extensions, |
379 | in as matches, | |
380 | in s profile, | |
381 | in s copy_mode, | |
382 | in t flags, | |
383 | out a(sss) changes); | |
23e5c8d2 LB |
384 | Detach(in b runtime, |
385 | out a(sss) changes); | |
907952bb LB |
386 | DetachWithExtensions(in as extensions, |
387 | in t flags, | |
388 | out a(sss) changes); | |
23e5c8d2 LB |
389 | Reattach(in as matches, |
390 | in s profile, | |
391 | in b runtime, | |
392 | in s copy_mode, | |
393 | out a(sss) changes_removed, | |
394 | out a(sss) changes_updated); | |
e0a067a2 LB |
395 | ReattachWithExtensions(in as extensions, |
396 | in as matches, | |
397 | in s profile, | |
398 | in s copy_mode, | |
399 | in t flags, | |
400 | out a(sss) changes_removed, | |
401 | out a(sss) changes_updated); | |
23e5c8d2 LB |
402 | Remove(); |
403 | MarkReadOnly(in b read_only); | |
404 | SetLimit(in t limit); | |
405 | properties: | |
406 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
407 | readonly s Name = '...'; | |
408 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
409 | readonly s Path = '...'; | |
410 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
411 | readonly s Type = '...'; | |
412 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
413 | readonly b ReadOnly = ...; | |
414 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
415 | readonly t CreationTimestamp = ...; | |
416 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
417 | readonly t ModificationTimestamp = ...; | |
418 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
419 | readonly t Usage = ...; | |
420 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
421 | readonly t Limit = ...; | |
422 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
423 | readonly t UsageExclusive = ...; | |
424 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
425 | readonly t LimitExclusive = ...; | |
426 | }; | |
427 | interface org.freedesktop.DBus.Peer { ... }; | |
428 | interface org.freedesktop.DBus.Introspectable { ... }; | |
429 | interface org.freedesktop.DBus.Properties { ... }; | |
430 | }; | |
431 | </programlisting> | |
432 | ||
433 | <!--method GetOSRelease is not documented!--> | |
434 | ||
435 | <!--method GetMetadata is not documented!--> | |
436 | ||
907952bb LB |
437 | <!--method GetMetadataWithExtensions is not documented!--> |
438 | ||
23e5c8d2 LB |
439 | <!--method GetState is not documented!--> |
440 | ||
0017415c LB |
441 | <!--method GetStateWithExtensions is not documented!--> |
442 | ||
23e5c8d2 LB |
443 | <!--method Attach is not documented!--> |
444 | ||
907952bb LB |
445 | <!--method AttachWithExtensions is not documented!--> |
446 | ||
23e5c8d2 LB |
447 | <!--method Detach is not documented!--> |
448 | ||
907952bb LB |
449 | <!--method DetachWithExtensions is not documented!--> |
450 | ||
23e5c8d2 LB |
451 | <!--method Reattach is not documented!--> |
452 | ||
e0a067a2 | 453 | <!--method ReattachWithExtensions is not documented!--> |
907952bb | 454 | |
23e5c8d2 LB |
455 | <!--method Remove is not documented!--> |
456 | ||
457 | <!--method MarkReadOnly is not documented!--> | |
458 | ||
459 | <!--method SetLimit is not documented!--> | |
460 | ||
461 | <!--Autogenerated cross-references for systemd.directives, do not edit--> | |
462 | ||
463 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.portable1.Image"/> | |
464 | ||
465 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.portable1.Image"/> | |
466 | ||
467 | <variablelist class="dbus-method" generated="True" extra-ref="GetOSRelease()"/> | |
468 | ||
469 | <variablelist class="dbus-method" generated="True" extra-ref="GetMetadata()"/> | |
470 | ||
907952bb LB |
471 | <variablelist class="dbus-method" generated="True" extra-ref="GetMetadataWithExtensions()"/> |
472 | ||
23e5c8d2 LB |
473 | <variablelist class="dbus-method" generated="True" extra-ref="GetState()"/> |
474 | ||
0017415c LB |
475 | <variablelist class="dbus-method" generated="True" extra-ref="GetStateWithExtensions()"/> |
476 | ||
23e5c8d2 LB |
477 | <variablelist class="dbus-method" generated="True" extra-ref="Attach()"/> |
478 | ||
907952bb LB |
479 | <variablelist class="dbus-method" generated="True" extra-ref="AttachWithExtensions()"/> |
480 | ||
23e5c8d2 LB |
481 | <variablelist class="dbus-method" generated="True" extra-ref="Detach()"/> |
482 | ||
907952bb LB |
483 | <variablelist class="dbus-method" generated="True" extra-ref="DetachWithExtensions()"/> |
484 | ||
23e5c8d2 LB |
485 | <variablelist class="dbus-method" generated="True" extra-ref="Reattach()"/> |
486 | ||
e0a067a2 | 487 | <variablelist class="dbus-method" generated="True" extra-ref="ReattachWithExtensions()"/> |
907952bb | 488 | |
23e5c8d2 LB |
489 | <variablelist class="dbus-method" generated="True" extra-ref="Remove()"/> |
490 | ||
491 | <variablelist class="dbus-method" generated="True" extra-ref="MarkReadOnly()"/> | |
492 | ||
493 | <variablelist class="dbus-method" generated="True" extra-ref="SetLimit()"/> | |
494 | ||
495 | <variablelist class="dbus-property" generated="True" extra-ref="Name"/> | |
496 | ||
497 | <variablelist class="dbus-property" generated="True" extra-ref="Path"/> | |
498 | ||
499 | <variablelist class="dbus-property" generated="True" extra-ref="Type"/> | |
500 | ||
501 | <variablelist class="dbus-property" generated="True" extra-ref="ReadOnly"/> | |
502 | ||
503 | <variablelist class="dbus-property" generated="True" extra-ref="CreationTimestamp"/> | |
504 | ||
505 | <variablelist class="dbus-property" generated="True" extra-ref="ModificationTimestamp"/> | |
506 | ||
507 | <variablelist class="dbus-property" generated="True" extra-ref="Usage"/> | |
508 | ||
509 | <variablelist class="dbus-property" generated="True" extra-ref="Limit"/> | |
510 | ||
511 | <variablelist class="dbus-property" generated="True" extra-ref="UsageExclusive"/> | |
512 | ||
513 | <variablelist class="dbus-property" generated="True" extra-ref="LimitExclusive"/> | |
514 | ||
515 | <!--End of Autogenerated section--> | |
516 | ||
517 | <refsect2> | |
518 | <title>Methods</title> | |
519 | ||
520 | <para>The following methods implement the same operation as the respective methods on the | |
521 | <interfacename>Manager</interfacename> object (see above). However, these methods operate on the image | |
522 | object and hence does not take an image name parameter. Invoking the methods directly on the Manager | |
523 | object has the advantage of not requiring a <function>GetImage()</function> call to get the image object | |
524 | for a specific image name. Calling the methods on the Manager object is hence a round trip | |
525 | optimization. List of methods: | |
526 | <itemizedlist> | |
527 | <listitem><para>GetOSRelease()</para></listitem> | |
528 | ||
529 | <listitem><para>GetMetadata()</para></listitem> | |
530 | ||
907952bb LB |
531 | <listitem><para>GetMetadataWithExtensions()</para></listitem> |
532 | ||
23e5c8d2 LB |
533 | <listitem><para>GetState()</para></listitem> |
534 | ||
535 | <listitem><para>Attach()</para></listitem> | |
536 | ||
907952bb LB |
537 | <listitem><para>AttachWithExtensions()</para></listitem> |
538 | ||
23e5c8d2 LB |
539 | <listitem><para>Detach()</para></listitem> |
540 | ||
907952bb LB |
541 | <listitem><para>DetachWithExtensions()</para></listitem> |
542 | ||
23e5c8d2 LB |
543 | <listitem><para>Reattach()</para></listitem> |
544 | ||
e0a067a2 | 545 | <listitem><para>ReattachWithExtensions()</para></listitem> |
907952bb | 546 | |
23e5c8d2 LB |
547 | <listitem><para>Remove()</para></listitem> |
548 | ||
549 | <listitem><para>MarkReadOnly()</para></listitem> | |
550 | ||
551 | <listitem><para>SetLimit()</para></listitem> | |
552 | </itemizedlist></para> | |
553 | </refsect2> | |
554 | ||
555 | <refsect2> | |
556 | <title>Properties</title> | |
557 | ||
558 | <para><varname>Name</varname> specifies the image name.</para> | |
559 | ||
560 | <para><varname>Path</varname> specifies the file system path where image is stored.</para> | |
561 | ||
562 | <para><varname>Type</varname> specifies the image type.</para> | |
563 | ||
564 | <para><varname>ReadOnly</varname> specifies whether the image is read-only.</para> | |
565 | ||
566 | <para><varname>CreationTimestamp</varname> specifies the image creation timestamp.</para> | |
567 | ||
568 | <para><varname>ModificationTimestamp</varname> specifies the image modification timestamp.</para> | |
569 | ||
570 | <para><varname>Usage</varname> specifies the image disk usage.</para> | |
571 | ||
572 | <para><varname>Limit</varname> specifies the image disk usage limit.</para> | |
573 | ||
574 | <para><varname>UsageExclusive</varname> specifies the image disk usage (exclusive).</para> | |
575 | ||
576 | <para><varname>LimitExclusive</varname> specifies the image disk usage limit (exclusive).</para> | |
577 | </refsect2> | |
578 | </refsect1> | |
579 | ||
e4239a34 | 580 | <xi:include href="org.freedesktop.locale1.xml" xpointer="versioning"/> |
d9d2d16a AK |
581 | |
582 | <refsect1> | |
583 | <title>History</title> | |
584 | <refsect2> | |
585 | <title>The Manager Object</title> | |
586 | <para><function>GetImageStateWithExtensions()</function> was added in version 251.</para> | |
587 | </refsect2> | |
588 | <refsect2> | |
589 | <title>The Image Object</title> | |
590 | <para><function>GetStateWithExtensions()</function> was added in version 251.</para> | |
591 | <para><function>ReattachWithExtensions()</function> was added in version 254.</para> | |
592 | </refsect2> | |
593 | </refsect1> | |
23e5c8d2 | 594 | </refentry> |