| 1 |
'\" t |
| 2 |
.TH "ORG\&.FREEDESKTOP\&.PORTABLE1" "5" "" "systemd 261~rc3" "org.freedesktop.portable1" |
| 3 |
.\" ----------------------------------------------------------------- |
| 4 |
.\" * Define some portability stuff |
| 5 |
.\" ----------------------------------------------------------------- |
| 6 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 7 |
.\" http://bugs.debian.org/507673 |
| 8 |
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
| 9 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 10 |
.ie \n(.g .ds Aq \(aq |
| 11 |
.el .ds Aq ' |
| 12 |
.\" ----------------------------------------------------------------- |
| 13 |
.\" * set default formatting |
| 14 |
.\" ----------------------------------------------------------------- |
| 15 |
.\" disable hyphenation |
| 16 |
.nh |
| 17 |
.\" disable justification (adjust text to left margin only) |
| 18 |
.ad l |
| 19 |
.\" ----------------------------------------------------------------- |
| 20 |
.\" * MAIN CONTENT STARTS HERE * |
| 21 |
.\" ----------------------------------------------------------------- |
| 22 |
.SH "NAME" |
| 23 |
org.freedesktop.portable1 \- The D\-Bus interface of systemd\-portabled |
| 24 |
.SH "INTRODUCTION" |
| 25 |
.PP |
| 26 |
\fBsystemd-portabled.service\fR(8) |
| 27 |
is a system service that may be used to attach, detach and inspect portable services\&. This page describes the D\-Bus interface\&. |
| 28 |
.SH "THE MANAGER OBJECT" |
| 29 |
.PP |
| 30 |
The service exposes the following interfaces on the Manager object on the bus: |
| 31 |
.sp |
| 32 |
.if n \{\ |
| 33 |
.RS 4 |
| 34 |
.\} |
| 35 |
.nf |
| 36 |
node /org/freedesktop/portable1 { |
| 37 |
interface org\&.freedesktop\&.portable1\&.Manager { |
| 38 |
methods: |
| 39 |
GetImage(in s image, |
| 40 |
out o object); |
| 41 |
ListImages(out a(ssbtttso) images); |
| 42 |
GetImageOSRelease(in s image, |
| 43 |
out a{ss} os_release); |
| 44 |
GetImageMetadata(in s image, |
| 45 |
in as matches, |
| 46 |
out s image, |
| 47 |
out ay os_release, |
| 48 |
out a{say} units); |
| 49 |
GetImageMetadataWithExtensions(in s image, |
| 50 |
in as extensions, |
| 51 |
in as matches, |
| 52 |
in t flags, |
| 53 |
out s image, |
| 54 |
out ay os_release, |
| 55 |
out a{say} extensions, |
| 56 |
out a{say} units); |
| 57 |
GetImageState(in s image, |
| 58 |
out s state); |
| 59 |
GetImageStateWithExtensions(in s image, |
| 60 |
in as extensions, |
| 61 |
in t flags, |
| 62 |
out s state); |
| 63 |
AttachImage(in s image, |
| 64 |
in as matches, |
| 65 |
in s profile, |
| 66 |
in b runtime, |
| 67 |
in s copy_mode, |
| 68 |
out a(sss) changes); |
| 69 |
AttachImageWithExtensions(in s image, |
| 70 |
in as extensions, |
| 71 |
in as matches, |
| 72 |
in s profile, |
| 73 |
in s copy_mode, |
| 74 |
in t flags, |
| 75 |
out a(sss) changes); |
| 76 |
DetachImage(in s image, |
| 77 |
in b runtime, |
| 78 |
out a(sss) changes); |
| 79 |
DetachImageWithExtensions(in s image, |
| 80 |
in as extensions, |
| 81 |
in t flags, |
| 82 |
out a(sss) changes); |
| 83 |
ReattachImage(in s image, |
| 84 |
in as matches, |
| 85 |
in s profile, |
| 86 |
in b runtime, |
| 87 |
in s copy_mode, |
| 88 |
out a(sss) changes_removed, |
| 89 |
out a(sss) changes_updated); |
| 90 |
ReattachImageWithExtensions(in s image, |
| 91 |
in as extensions, |
| 92 |
in as matches, |
| 93 |
in s profile, |
| 94 |
in s copy_mode, |
| 95 |
in t flags, |
| 96 |
out a(sss) changes_removed, |
| 97 |
out a(sss) changes_updated); |
| 98 |
RemoveImage(in s image); |
| 99 |
MarkImageReadOnly(in s image, |
| 100 |
in b read_only); |
| 101 |
SetImageLimit(in s image, |
| 102 |
in t limit); |
| 103 |
SetPoolLimit(in t limit); |
| 104 |
properties: |
| 105 |
@org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") |
| 106 |
readonly s PoolPath = \*(Aq\&.\&.\&.\*(Aq; |
| 107 |
@org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") |
| 108 |
readonly t PoolUsage = \&.\&.\&.; |
| 109 |
@org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") |
| 110 |
readonly t PoolLimit = \&.\&.\&.; |
| 111 |
@org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") |
| 112 |
readonly as Profiles = [\*(Aq\&.\&.\&.\*(Aq, \&.\&.\&.]; |
| 113 |
}; |
| 114 |
interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. }; |
| 115 |
interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. }; |
| 116 |
interface org\&.freedesktop\&.DBus\&.Properties { \&.\&.\&. }; |
| 117 |
}; |
| 118 |
.fi |
| 119 |
.if n \{\ |
| 120 |
.RE |
| 121 |
.\} |
| 122 |
|
| 123 |
|
| 124 |
|
| 125 |
|
| 126 |
|
| 127 |
|
| 128 |
|
| 129 |
|
| 130 |
|
| 131 |
|
| 132 |
|
| 133 |
|
| 134 |
|
| 135 |
|
| 136 |
|
| 137 |
|
| 138 |
|
| 139 |
|
| 140 |
|
| 141 |
|
| 142 |
|
| 143 |
|
| 144 |
.SS "Methods" |
| 145 |
.PP |
| 146 |
\fBGetImage()\fR |
| 147 |
may be used to get the image object path of the image with the specified name\&. |
| 148 |
.PP |
| 149 |
\fBListImages()\fR |
| 150 |
returns an array of all currently known images\&. The structures in the array consist of the following fields: image name, type, read\-only flag, creation time, modification time, current disk space, usage and image object path\&. |
| 151 |
.PP |
| 152 |
\fBGetImageOSRelease()\fR |
| 153 |
retrieves the OS release information of an image\&. This method returns an array of key value pairs read from the |
| 154 |
\fBos-release\fR(5) |
| 155 |
file in the image and is useful to identify the operating system used in a portable service\&. |
| 156 |
.PP |
| 157 |
\fBGetImageMetadata()\fR |
| 158 |
retrieves metadata associated with an image\&. This method returns the image name, the image\*(Aqs |
| 159 |
\fBos-release\fR(5) |
| 160 |
content in the form of a (streamable) array of bytes, and a list of portable units contained in the image, in the form of a string (unit name) and an array of bytes with the content\&. |
| 161 |
.PP |
| 162 |
\fBGetImageMetadataWithExtensions()\fR |
| 163 |
retrieves metadata associated with an image\&. This method is a superset of |
| 164 |
\fBGetImageMetadata()\fR |
| 165 |
with the addition of a list of extensions as input parameter, which were overlaid on top of the main image via |
| 166 |
\fBAttachImageWithExtensions()\fR\&. The path of each extension and an array of bytes with the content of the respective extension\-release file are returned, one such structure for each extension named in the input arguments\&. |
| 167 |
.PP |
| 168 |
\fBGetImageState()\fR |
| 169 |
retrieves the image state as one of the following strings: |
| 170 |
.sp |
| 171 |
.RS 4 |
| 172 |
.ie n \{\ |
| 173 |
\h'-04'\(bu\h'+03'\c |
| 174 |
.\} |
| 175 |
.el \{\ |
| 176 |
.sp -1 |
| 177 |
.IP \(bu 2.3 |
| 178 |
.\} |
| 179 |
detached |
| 180 |
.RE |
| 181 |
.sp |
| 182 |
.RS 4 |
| 183 |
.ie n \{\ |
| 184 |
\h'-04'\(bu\h'+03'\c |
| 185 |
.\} |
| 186 |
.el \{\ |
| 187 |
.sp -1 |
| 188 |
.IP \(bu 2.3 |
| 189 |
.\} |
| 190 |
attached |
| 191 |
.RE |
| 192 |
.sp |
| 193 |
.RS 4 |
| 194 |
.ie n \{\ |
| 195 |
\h'-04'\(bu\h'+03'\c |
| 196 |
.\} |
| 197 |
.el \{\ |
| 198 |
.sp -1 |
| 199 |
.IP \(bu 2.3 |
| 200 |
.\} |
| 201 |
attached\-runtime |
| 202 |
.RE |
| 203 |
.sp |
| 204 |
.RS 4 |
| 205 |
.ie n \{\ |
| 206 |
\h'-04'\(bu\h'+03'\c |
| 207 |
.\} |
| 208 |
.el \{\ |
| 209 |
.sp -1 |
| 210 |
.IP \(bu 2.3 |
| 211 |
.\} |
| 212 |
enabled |
| 213 |
.RE |
| 214 |
.sp |
| 215 |
.RS 4 |
| 216 |
.ie n \{\ |
| 217 |
\h'-04'\(bu\h'+03'\c |
| 218 |
.\} |
| 219 |
.el \{\ |
| 220 |
.sp -1 |
| 221 |
.IP \(bu 2.3 |
| 222 |
.\} |
| 223 |
enabled\-runtime |
| 224 |
.RE |
| 225 |
.sp |
| 226 |
.RS 4 |
| 227 |
.ie n \{\ |
| 228 |
\h'-04'\(bu\h'+03'\c |
| 229 |
.\} |
| 230 |
.el \{\ |
| 231 |
.sp -1 |
| 232 |
.IP \(bu 2.3 |
| 233 |
.\} |
| 234 |
running |
| 235 |
.RE |
| 236 |
.sp |
| 237 |
.RS 4 |
| 238 |
.ie n \{\ |
| 239 |
\h'-04'\(bu\h'+03'\c |
| 240 |
.\} |
| 241 |
.el \{\ |
| 242 |
.sp -1 |
| 243 |
.IP \(bu 2.3 |
| 244 |
.\} |
| 245 |
running\-runtime |
| 246 |
.RE |
| 247 |
.PP |
| 248 |
\fBGetImageStateWithExtensions()\fR |
| 249 |
is a superset of |
| 250 |
\fBGetImageState()\fR, with additional support for a list of extensions as input parameters, which is necessary to query the state in case the image was attached in that particular way\&. The |
| 251 |
\fIflag\fR |
| 252 |
parameter is currently unused and reserved for future purposes\&. |
| 253 |
.PP |
| 254 |
\fBAttachImage()\fR |
| 255 |
attaches a portable image to the system\&. This method takes an image path or name, a list of strings that will be used to search for unit files inside the image (partial or complete matches), a string indicating which portable profile to use for the image (see |
| 256 |
\fIProfiles\fR |
| 257 |
property for a list of available profiles), a boolean indicating whether to attach the image only for the current boot session, and a string representing the preferred copy mode (whether to copy the image or to just symlink it) with the following possible values: |
| 258 |
.sp |
| 259 |
.RS 4 |
| 260 |
.ie n \{\ |
| 261 |
\h'-04'\(bu\h'+03'\c |
| 262 |
.\} |
| 263 |
.el \{\ |
| 264 |
.sp -1 |
| 265 |
.IP \(bu 2.3 |
| 266 |
.\} |
| 267 |
(empty) |
| 268 |
.RE |
| 269 |
.sp |
| 270 |
.RS 4 |
| 271 |
.ie n \{\ |
| 272 |
\h'-04'\(bu\h'+03'\c |
| 273 |
.\} |
| 274 |
.el \{\ |
| 275 |
.sp -1 |
| 276 |
.IP \(bu 2.3 |
| 277 |
.\} |
| 278 |
copy |
| 279 |
.RE |
| 280 |
.sp |
| 281 |
.RS 4 |
| 282 |
.ie n \{\ |
| 283 |
\h'-04'\(bu\h'+03'\c |
| 284 |
.\} |
| 285 |
.el \{\ |
| 286 |
.sp -1 |
| 287 |
.IP \(bu 2.3 |
| 288 |
.\} |
| 289 |
symlink |
| 290 |
.RE |
| 291 |
.sp |
| 292 |
.RS 4 |
| 293 |
.ie n \{\ |
| 294 |
\h'-04'\(bu\h'+03'\c |
| 295 |
.\} |
| 296 |
.el \{\ |
| 297 |
.sp -1 |
| 298 |
.IP \(bu 2.3 |
| 299 |
.\} |
| 300 |
mixed |
| 301 |
.RE |
| 302 |
.sp |
| 303 |
If an empty string is passed the security profile drop\-ins and images will be symlinked while unit files will be copied, |
| 304 |
\fIcopy\fR |
| 305 |
will copy, |
| 306 |
\fIsymlink\fR |
| 307 |
will prefer linking if possible (e\&.g\&.: a unit has to be copied out of an image), and |
| 308 |
\fImixed\fR |
| 309 |
will prefer linking the resources owned by the OS (e\&.g\&.: the portable profile located within the host\*(Aqs /usr/ tree) but will copy the resources owned by the portable image (e\&.g\&.: the unit files and the images)\&. This method returns the list of changes applied to the system (for example, which unit was added and is now available as a system service)\&. Each change is represented as a triplet of strings: the type of change applied, the path on which it was applied, and the source (if any)\&. The type of change applied will be one of the following possible values: |
| 310 |
.sp |
| 311 |
.RS 4 |
| 312 |
.ie n \{\ |
| 313 |
\h'-04'\(bu\h'+03'\c |
| 314 |
.\} |
| 315 |
.el \{\ |
| 316 |
.sp -1 |
| 317 |
.IP \(bu 2.3 |
| 318 |
.\} |
| 319 |
copy |
| 320 |
.RE |
| 321 |
.sp |
| 322 |
.RS 4 |
| 323 |
.ie n \{\ |
| 324 |
\h'-04'\(bu\h'+03'\c |
| 325 |
.\} |
| 326 |
.el \{\ |
| 327 |
.sp -1 |
| 328 |
.IP \(bu 2.3 |
| 329 |
.\} |
| 330 |
symlink |
| 331 |
.RE |
| 332 |
.sp |
| 333 |
.RS 4 |
| 334 |
.ie n \{\ |
| 335 |
\h'-04'\(bu\h'+03'\c |
| 336 |
.\} |
| 337 |
.el \{\ |
| 338 |
.sp -1 |
| 339 |
.IP \(bu 2.3 |
| 340 |
.\} |
| 341 |
write |
| 342 |
.RE |
| 343 |
.sp |
| 344 |
.RS 4 |
| 345 |
.ie n \{\ |
| 346 |
\h'-04'\(bu\h'+03'\c |
| 347 |
.\} |
| 348 |
.el \{\ |
| 349 |
.sp -1 |
| 350 |
.IP \(bu 2.3 |
| 351 |
.\} |
| 352 |
mkdir |
| 353 |
.RE |
| 354 |
.sp |
| 355 |
Note that an image cannot be attached if a unit that it contains is already present on the system\&. Note that this method returns only after all the listed operations are completed, and due to the I/O involved it might take some time\&. |
| 356 |
.PP |
| 357 |
In place of the image path a |
| 358 |
"\&.v/" |
| 359 |
versioned directory may be specified, see |
| 360 |
\fBsystemd.v\fR(7) |
| 361 |
for details\&. |
| 362 |
.PP |
| 363 |
In place of the directory path a |
| 364 |
"\&.v/" |
| 365 |
versioned directory may be specified, see |
| 366 |
\fBsystemd.v\fR(7) |
| 367 |
for details\&. |
| 368 |
.PP |
| 369 |
\fBAttachImageWithExtensions()\fR |
| 370 |
attaches a portable image to the system\&. This method is a superset of |
| 371 |
\fBAttachImage()\fR |
| 372 |
with the addition of a list of extensions as input parameter, which will be overlaid on top of the main image\&. When this method is used, detaching must be done by passing the same arguments via the |
| 373 |
\fBDetachImageWithExtensions()\fR |
| 374 |
method\&. For more details on this functionality, see the |
| 375 |
\fIMountImages=\fR |
| 376 |
entry on |
| 377 |
\fBsystemd.exec\fR(5) |
| 378 |
and |
| 379 |
\fBsystemd-sysext\fR(8)\&. |
| 380 |
.PP |
| 381 |
\fBDetachImage()\fR |
| 382 |
detaches a portable image from the system\&. This method takes an image path or name, and a boolean indicating whether the image to detach was attached only for the current boot session or persistently\&. This method returns the list of changes applied to the system (for example, which unit was removed and is no longer available as a system service)\&. Each change is represented as a triplet of strings: the type of change applied, the path on which it was applied, and the source (if any)\&. The type of change applied will be one of the following possible values: |
| 383 |
.sp |
| 384 |
.RS 4 |
| 385 |
.ie n \{\ |
| 386 |
\h'-04'\(bu\h'+03'\c |
| 387 |
.\} |
| 388 |
.el \{\ |
| 389 |
.sp -1 |
| 390 |
.IP \(bu 2.3 |
| 391 |
.\} |
| 392 |
unlink |
| 393 |
.RE |
| 394 |
.sp |
| 395 |
Note that an image cannot be detached if a unit that it contains is running\&. Note that this method returns only after all the listed operations are completed, and due to the I/O involved it might take some time\&. |
| 396 |
.PP |
| 397 |
\fBDetachImageWithExtensions()\fR |
| 398 |
detaches a portable image from the system\&. This method is a superset of |
| 399 |
\fBDetachImage()\fR |
| 400 |
with the addition of a list of extensions as input parameter, which were overlaid on top of the main image via |
| 401 |
\fBAttachImageWithExtensions()\fR\&. |
| 402 |
.PP |
| 403 |
\fBReattachImage()\fR |
| 404 |
combines the effects of the |
| 405 |
\fBAttachImage()\fR |
| 406 |
method and the |
| 407 |
\fBDetachImage()\fR |
| 408 |
method\&. The difference is that it is allowed to reattach an image while one or more of its units are running\&. The reattach operation will fail if no matching image is attached\&. The input parameters match the |
| 409 |
\fBAttachImage()\fR |
| 410 |
method, and the return parameters are the combination of the return parameters of the |
| 411 |
\fBDetachImage()\fR |
| 412 |
method (first array, units that were removed) and the |
| 413 |
\fBAttachImage()\fR |
| 414 |
method (second array, units that were updated or added)\&. |
| 415 |
.PP |
| 416 |
\fBReattachImageWithExtensions()\fR |
| 417 |
reattaches a portable image to the system\&. This method is a superset of |
| 418 |
\fBReattachImage()\fR |
| 419 |
with the addition of a list of extensions as input parameter, which will be overlaid on top of the main image\&. For more details on this functionality, see the |
| 420 |
\fIMountImages=\fR |
| 421 |
entry on |
| 422 |
\fBsystemd.exec\fR(5) |
| 423 |
and |
| 424 |
\fBsystemd-sysext\fR(8)\&. |
| 425 |
.PP |
| 426 |
\fBRemoveImage()\fR |
| 427 |
removes the image with the specified name\&. |
| 428 |
.PP |
| 429 |
\fBMarkImageReadOnly()\fR |
| 430 |
toggles the read\-only flag of an image\&. |
| 431 |
.PP |
| 432 |
\fBSetPoolLimit()\fR |
| 433 |
sets an overall quota limit on the pool of images\&. |
| 434 |
.PP |
| 435 |
\fBSetImageLimit()\fR |
| 436 |
sets a per\-image quota limit\&. |
| 437 |
.PP |
| 438 |
The |
| 439 |
\fBAttachImageWithExtensions()\fR, |
| 440 |
\fBDetachImageWithExtensions()\fR |
| 441 |
and |
| 442 |
\fBReattachImageWithExtensions()\fR |
| 443 |
methods take in options as flags instead of booleans to allow for extendability\&. |
| 444 |
\fISD_SYSTEMD_PORTABLE_FORCE_ATTACH\fR |
| 445 |
will bypass the safety checks that ensure the units are not running while the image is attached or detached\&. |
| 446 |
\fISD_SYSTEMD_PORTABLE_FORCE_EXTENSION\fR |
| 447 |
will bypass the check that ensures the |
| 448 |
extension\-release\&.\fINAME\fR |
| 449 |
file in the extension image matches the image name\&. They are defined as follows: |
| 450 |
.sp |
| 451 |
.if n \{\ |
| 452 |
.RS 4 |
| 453 |
.\} |
| 454 |
.nf |
| 455 |
#define SD_SYSTEMD_PORTABLE_RUNTIME (UINT64_C(1) << 0) |
| 456 |
#define SD_SYSTEMD_PORTABLE_FORCE_ATTACH (UINT64_C(1) << 1) |
| 457 |
#define SD_SYSTEMD_PORTABLE_FORCE_EXTENSION (UINT64_C(1) << 2) |
| 458 |
.fi |
| 459 |
.if n \{\ |
| 460 |
.RE |
| 461 |
.\} |
| 462 |
.SS "Properties" |
| 463 |
.PP |
| 464 |
\fIPoolPath\fR |
| 465 |
specifies the file system path where images are written to\&. |
| 466 |
.PP |
| 467 |
\fIPoolUsage\fR |
| 468 |
specifies the current usage size of the image pool in bytes\&. |
| 469 |
.PP |
| 470 |
\fIPoolLimit\fR |
| 471 |
specifies the size limit of the image pool in bytes\&. |
| 472 |
.PP |
| 473 |
\fIProfiles\fR |
| 474 |
specifies the available runtime profiles for portable services\&. |
| 475 |
.SH "THE IMAGE OBJECT" |
| 476 |
.PP |
| 477 |
The service exposes the following interfaces on the Image object on the bus: |
| 478 |
.sp |
| 479 |
.if n \{\ |
| 480 |
.RS 4 |
| 481 |
.\} |
| 482 |
.nf |
| 483 |
node /org/freedesktop/portable1 { |
| 484 |
interface org\&.freedesktop\&.portable1\&.Image { |
| 485 |
methods: |
| 486 |
GetOSRelease(out a{ss} os_release); |
| 487 |
GetMetadata(in as matches, |
| 488 |
out s image, |
| 489 |
out ay os_release, |
| 490 |
out a{say} units); |
| 491 |
GetMetadataWithExtensions(in as extensions, |
| 492 |
in as matches, |
| 493 |
in t flags, |
| 494 |
out s image, |
| 495 |
out ay os_release, |
| 496 |
out a{say} extensions, |
| 497 |
out a{say} units); |
| 498 |
GetState(out s state); |
| 499 |
GetStateWithExtensions(in as extensions, |
| 500 |
in t flags, |
| 501 |
out s state); |
| 502 |
Attach(in as matches, |
| 503 |
in s profile, |
| 504 |
in b runtime, |
| 505 |
in s copy_mode, |
| 506 |
out a(sss) changes); |
| 507 |
AttachWithExtensions(in as extensions, |
| 508 |
in as matches, |
| 509 |
in s profile, |
| 510 |
in s copy_mode, |
| 511 |
in t flags, |
| 512 |
out a(sss) changes); |
| 513 |
Detach(in b runtime, |
| 514 |
out a(sss) changes); |
| 515 |
DetachWithExtensions(in as extensions, |
| 516 |
in t flags, |
| 517 |
out a(sss) changes); |
| 518 |
Reattach(in as matches, |
| 519 |
in s profile, |
| 520 |
in b runtime, |
| 521 |
in s copy_mode, |
| 522 |
out a(sss) changes_removed, |
| 523 |
out a(sss) changes_updated); |
| 524 |
ReattachWithExtensions(in as extensions, |
| 525 |
in as matches, |
| 526 |
in s profile, |
| 527 |
in s copy_mode, |
| 528 |
in t flags, |
| 529 |
out a(sss) changes_removed, |
| 530 |
out a(sss) changes_updated); |
| 531 |
Remove(); |
| 532 |
MarkReadOnly(in b read_only); |
| 533 |
SetLimit(in t limit); |
| 534 |
properties: |
| 535 |
@org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") |
| 536 |
readonly s Name = \*(Aq\&.\&.\&.\*(Aq; |
| 537 |
@org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") |
| 538 |
readonly s Path = \*(Aq\&.\&.\&.\*(Aq; |
| 539 |
@org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") |
| 540 |
readonly s Type = \*(Aq\&.\&.\&.\*(Aq; |
| 541 |
@org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") |
| 542 |
readonly b ReadOnly = \&.\&.\&.; |
| 543 |
@org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") |
| 544 |
readonly t CreationTimestamp = \&.\&.\&.; |
| 545 |
@org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") |
| 546 |
readonly t ModificationTimestamp = \&.\&.\&.; |
| 547 |
@org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") |
| 548 |
readonly t Usage = \&.\&.\&.; |
| 549 |
@org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") |
| 550 |
readonly t Limit = \&.\&.\&.; |
| 551 |
@org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") |
| 552 |
readonly t UsageExclusive = \&.\&.\&.; |
| 553 |
@org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false") |
| 554 |
readonly t LimitExclusive = \&.\&.\&.; |
| 555 |
}; |
| 556 |
interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. }; |
| 557 |
interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. }; |
| 558 |
interface org\&.freedesktop\&.DBus\&.Properties { \&.\&.\&. }; |
| 559 |
}; |
| 560 |
.fi |
| 561 |
.if n \{\ |
| 562 |
.RE |
| 563 |
.\} |
| 564 |
|
| 565 |
|
| 566 |
|
| 567 |
|
| 568 |
|
| 569 |
|
| 570 |
|
| 571 |
|
| 572 |
|
| 573 |
|
| 574 |
|
| 575 |
|
| 576 |
|
| 577 |
|
| 578 |
|
| 579 |
|
| 580 |
|
| 581 |
|
| 582 |
|
| 583 |
|
| 584 |
|
| 585 |
|
| 586 |
|
| 587 |
|
| 588 |
|
| 589 |
.SS "Methods" |
| 590 |
.PP |
| 591 |
The following methods implement the same operation as the respective methods on the |
| 592 |
Manager |
| 593 |
object (see above)\&. However, these methods operate on the image object and hence does not take an image name parameter\&. Invoking the methods directly on the Manager object has the advantage of not requiring a |
| 594 |
\fBGetImage()\fR |
| 595 |
call to get the image object for a specific image name\&. Calling the methods on the Manager object is hence a round trip optimization\&. List of methods: |
| 596 |
.sp |
| 597 |
.RS 4 |
| 598 |
.ie n \{\ |
| 599 |
\h'-04'\(bu\h'+03'\c |
| 600 |
.\} |
| 601 |
.el \{\ |
| 602 |
.sp -1 |
| 603 |
.IP \(bu 2.3 |
| 604 |
.\} |
| 605 |
GetOSRelease() |
| 606 |
.RE |
| 607 |
.sp |
| 608 |
.RS 4 |
| 609 |
.ie n \{\ |
| 610 |
\h'-04'\(bu\h'+03'\c |
| 611 |
.\} |
| 612 |
.el \{\ |
| 613 |
.sp -1 |
| 614 |
.IP \(bu 2.3 |
| 615 |
.\} |
| 616 |
GetMetadata() |
| 617 |
.RE |
| 618 |
.sp |
| 619 |
.RS 4 |
| 620 |
.ie n \{\ |
| 621 |
\h'-04'\(bu\h'+03'\c |
| 622 |
.\} |
| 623 |
.el \{\ |
| 624 |
.sp -1 |
| 625 |
.IP \(bu 2.3 |
| 626 |
.\} |
| 627 |
GetMetadataWithExtensions() |
| 628 |
.RE |
| 629 |
.sp |
| 630 |
.RS 4 |
| 631 |
.ie n \{\ |
| 632 |
\h'-04'\(bu\h'+03'\c |
| 633 |
.\} |
| 634 |
.el \{\ |
| 635 |
.sp -1 |
| 636 |
.IP \(bu 2.3 |
| 637 |
.\} |
| 638 |
GetState() |
| 639 |
.RE |
| 640 |
.sp |
| 641 |
.RS 4 |
| 642 |
.ie n \{\ |
| 643 |
\h'-04'\(bu\h'+03'\c |
| 644 |
.\} |
| 645 |
.el \{\ |
| 646 |
.sp -1 |
| 647 |
.IP \(bu 2.3 |
| 648 |
.\} |
| 649 |
Attach() |
| 650 |
.RE |
| 651 |
.sp |
| 652 |
.RS 4 |
| 653 |
.ie n \{\ |
| 654 |
\h'-04'\(bu\h'+03'\c |
| 655 |
.\} |
| 656 |
.el \{\ |
| 657 |
.sp -1 |
| 658 |
.IP \(bu 2.3 |
| 659 |
.\} |
| 660 |
AttachWithExtensions() |
| 661 |
.RE |
| 662 |
.sp |
| 663 |
.RS 4 |
| 664 |
.ie n \{\ |
| 665 |
\h'-04'\(bu\h'+03'\c |
| 666 |
.\} |
| 667 |
.el \{\ |
| 668 |
.sp -1 |
| 669 |
.IP \(bu 2.3 |
| 670 |
.\} |
| 671 |
Detach() |
| 672 |
.RE |
| 673 |
.sp |
| 674 |
.RS 4 |
| 675 |
.ie n \{\ |
| 676 |
\h'-04'\(bu\h'+03'\c |
| 677 |
.\} |
| 678 |
.el \{\ |
| 679 |
.sp -1 |
| 680 |
.IP \(bu 2.3 |
| 681 |
.\} |
| 682 |
DetachWithExtensions() |
| 683 |
.RE |
| 684 |
.sp |
| 685 |
.RS 4 |
| 686 |
.ie n \{\ |
| 687 |
\h'-04'\(bu\h'+03'\c |
| 688 |
.\} |
| 689 |
.el \{\ |
| 690 |
.sp -1 |
| 691 |
.IP \(bu 2.3 |
| 692 |
.\} |
| 693 |
Reattach() |
| 694 |
.RE |
| 695 |
.sp |
| 696 |
.RS 4 |
| 697 |
.ie n \{\ |
| 698 |
\h'-04'\(bu\h'+03'\c |
| 699 |
.\} |
| 700 |
.el \{\ |
| 701 |
.sp -1 |
| 702 |
.IP \(bu 2.3 |
| 703 |
.\} |
| 704 |
ReattachWithExtensions() |
| 705 |
.RE |
| 706 |
.sp |
| 707 |
.RS 4 |
| 708 |
.ie n \{\ |
| 709 |
\h'-04'\(bu\h'+03'\c |
| 710 |
.\} |
| 711 |
.el \{\ |
| 712 |
.sp -1 |
| 713 |
.IP \(bu 2.3 |
| 714 |
.\} |
| 715 |
Remove() |
| 716 |
.RE |
| 717 |
.sp |
| 718 |
.RS 4 |
| 719 |
.ie n \{\ |
| 720 |
\h'-04'\(bu\h'+03'\c |
| 721 |
.\} |
| 722 |
.el \{\ |
| 723 |
.sp -1 |
| 724 |
.IP \(bu 2.3 |
| 725 |
.\} |
| 726 |
MarkReadOnly() |
| 727 |
.RE |
| 728 |
.sp |
| 729 |
.RS 4 |
| 730 |
.ie n \{\ |
| 731 |
\h'-04'\(bu\h'+03'\c |
| 732 |
.\} |
| 733 |
.el \{\ |
| 734 |
.sp -1 |
| 735 |
.IP \(bu 2.3 |
| 736 |
.\} |
| 737 |
SetLimit() |
| 738 |
.RE |
| 739 |
.SS "Properties" |
| 740 |
.PP |
| 741 |
\fIName\fR |
| 742 |
specifies the image name\&. |
| 743 |
.PP |
| 744 |
\fIPath\fR |
| 745 |
specifies the file system path where image is stored\&. |
| 746 |
.PP |
| 747 |
\fIType\fR |
| 748 |
specifies the image type\&. |
| 749 |
.PP |
| 750 |
\fIReadOnly\fR |
| 751 |
specifies whether the image is read\-only\&. |
| 752 |
.PP |
| 753 |
\fICreationTimestamp\fR |
| 754 |
specifies the image creation timestamp\&. |
| 755 |
.PP |
| 756 |
\fIModificationTimestamp\fR |
| 757 |
specifies the image modification timestamp\&. |
| 758 |
.PP |
| 759 |
\fIUsage\fR |
| 760 |
specifies the image disk usage\&. |
| 761 |
.PP |
| 762 |
\fILimit\fR |
| 763 |
specifies the image disk usage limit\&. |
| 764 |
.PP |
| 765 |
\fIUsageExclusive\fR |
| 766 |
specifies the image disk usage (exclusive)\&. |
| 767 |
.PP |
| 768 |
\fILimitExclusive\fR |
| 769 |
specifies the image disk usage limit (exclusive)\&. |
| 770 |
.SH "VERSIONING" |
| 771 |
.PP |
| 772 |
These D\-Bus interfaces follow |
| 773 |
\m[blue]\fBthe usual interface versioning guidelines\fR\m[]\&\s-2\u[1]\d\s+2\&. |
| 774 |
.SH "HISTORY" |
| 775 |
.SS "The Manager Object" |
| 776 |
.PP |
| 777 |
\fBGetImageStateWithExtensions()\fR |
| 778 |
was added in version 251\&. |
| 779 |
.SS "The Image Object" |
| 780 |
.PP |
| 781 |
\fBGetStateWithExtensions()\fR |
| 782 |
was added in version 251\&. |
| 783 |
.PP |
| 784 |
\fBReattachWithExtensions()\fR |
| 785 |
was added in version 254\&. |
| 786 |
.SH "SEE ALSO" |
| 787 |
.PP |
| 788 |
\fBsystemd\fR(1), \fBsystemd-portabled.service\fR(8), \fBportablectl\fR(1) |
| 789 |
.SH "NOTES" |
| 790 |
.IP " 1." 4 |
| 791 |
the usual interface versioning guidelines |
| 792 |
.RS 4 |
| 793 |
\%https://0pointer.de/blog/projects/versioning-dbus.html |
| 794 |
.RE |