Debian Codegraph @

upstream/debian-unstable/man8/dnf5daemon-dbus-api.8

raw
1 .\" Man page generated from reStructuredText
2 .\" by the Docutils 0.22.4 manpage writer.
3 .
4 .
5 .nr rst2man-indent-level 0
6 .
7 .de1 rstReportMargin
8 \\$1 \\n[an-margin]
9 level \\n[rst2man-indent-level]
10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
11 -
12 \\n[rst2man-indent0]
13 \\n[rst2man-indent1]
14 \\n[rst2man-indent2]
15 ..
16 .de1 INDENT
17 .\" .rstReportMargin pre:
18 . RS \\$1
19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20 . nr rst2man-indent-level +1
21 .\" .rstReportMargin post:
22 ..
23 .de UNINDENT
24 . RE
25 .\" indent \\n[an-margin]
26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
27 .nr rst2man-indent-level -1
28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
30 ..
31 .TH "DNF5DAEMON-DBUS-API" "8" "May 09, 2026" "" "dnf5"
32 .SH NAME
33 dnf5daemon-dbus-api \- DBus API Reference for Dnf5daemon
34 .SH SYNOPSIS
35 .sp
36 D\-Bus methods and arguments. Generated from D\-Bus XMLs.
37 .SH DESCRIPTION
38 .sp
39 Note: While most of the following methods can be invoked successfully by a regular user, authentication by an administrative user is required for some of them (e.g. \fIGoal.do_transaction()\fP, \fIRepo.confirm_key()\fP, \fIRepo.enable()\fP, \fIRepo.disable()\fP). This authentication is managed by calling \fICheckAuthorization()\fP method of the \fIorg.freedesktop.PolicyKit1.Authority\fP Polkit D\-Bus interface. The \fIAllowUserInteraction\fP flag is set for this call, indicating that if an authentication agent is available, the call is blocked while the user is prompted to authenticate. A hardcoded timeout of 2 minutes is set for the user interaction.
40 .SH INTERFACES
41 .SS org.rpm.dnf.v0.SessionManager interface
42 .INDENT 0.0
43 .TP
44 .B interface org.rpm.dnf.v0.SessionManager
45 .INDENT 7.0
46 .TP
47 .B method open_session(a{sv} options) -> (o session_object_path)
48 .INDENT 7.0
49 .TP
50 .B Arguments
51 .INDENT 7.0
52 .IP \(bu 2
53 \fBoptions\fP (\fIa{sv}\fP) \-\- session configuration \- an array of key/value pairs
54 .UNINDENT
55 .TP
56 .B Returns
57 .INDENT 7.0
58 .IP \(bu 2
59 \fBsession_object_path\fP (\fIo\fP) \-\- object path to created Session object
60 .UNINDENT
61 .UNINDENT
62 .sp
63 Opens a new session.
64 .sp
65 Following configuration options are supported:
66 .INDENT 7.0
67 .INDENT 3.5
68 .INDENT 0.0
69 .IP \(bu 2
70 .INDENT 2.0
71 .TP
72 .B load_system_repo: bool, default true
73 If true information about currently installed packages is loaded.
74 .UNINDENT
75 .IP \(bu 2
76 .INDENT 2.0
77 .TP
78 .B load_available_repos: bool, default true
79 If true information about packages available in enabled repositories is loaded.
80 .UNINDENT
81 .IP \(bu 2
82 .INDENT 2.0
83 .TP
84 .B config: map {string: string}
85 Override configuration options.
86 .UNINDENT
87 .IP \(bu 2
88 .INDENT 2.0
89 .TP
90 .B releasever: string
91 Override releasever variable used for substitutions in repository configurations.
92 .UNINDENT
93 .IP \(bu 2
94 .INDENT 2.0
95 .TP
96 .B locale: string
97 Override server locale for this session. Affects language used in various error messages.
98 .UNINDENT
99 .UNINDENT
100 .UNINDENT
101 .UNINDENT
102 .sp
103 Unknown options are ignored.
104 .UNINDENT
105 .INDENT 7.0
106 .TP
107 .B method close_session(o session_object_path) -> (b success)
108 .INDENT 7.0
109 .TP
110 .B Arguments
111 .INDENT 7.0
112 .IP \(bu 2
113 \fBsession_object_path\fP (\fIo\fP) \-\- object path of session to close
114 .UNINDENT
115 .TP
116 .B Returns
117 .INDENT 7.0
118 .IP \(bu 2
119 \fBsuccess\fP (\fIb\fP) \-\- bool whether the requested session was successfully closed
120 .UNINDENT
121 .UNINDENT
122 .sp
123 Close session on given object path.
124 .UNINDENT
125 .UNINDENT
126 .SS org.rpm.dnf.v0.Base interface
127 .INDENT 0.0
128 .TP
129 .B interface org.rpm.dnf.v0.Base
130 .INDENT 7.0
131 .TP
132 .B method read_all_repos() -> (b success)
133 .INDENT 7.0
134 .TP
135 .B Returns
136 .INDENT 7.0
137 .IP \(bu 2
138 \fBsuccess\fP (\fIb\fP) \-\- \fItrue\fP if repositories were successfully loaded, \fIfalse\fP otherwise.
139 .UNINDENT
140 .UNINDENT
141 .sp
142 Explicitly ask for loading repositories metadata.
143 .UNINDENT
144 .INDENT 7.0
145 .TP
146 .B method clean_with_options(s cache_type, a{sv} options) -> (b success, s error_msg)
147 .INDENT 7.0
148 .TP
149 .B Arguments
150 .INDENT 7.0
151 .IP \(bu 2
152 \fBcache_type\fP (\fIs\fP) \-\- cache type to clean up. Supported types are \(dqall\(dq, \(dqpackages\(dq, \(dqmetadata\(dq, \(dqdbcache\(dq, and \(dqexpire\-cache\(dq.
153 .IP \(bu 2
154 \fBoptions\fP (\fIa{sv}\fP) \-\- an array of key/value pairs to modify the call behavior
155 .UNINDENT
156 .TP
157 .B Returns
158 .INDENT 7.0
159 .IP \(bu 2
160 \fBsuccess\fP (\fIb\fP) \-\- \fItrue\fP if the cache was successfully cleaned, \fIfalse\fP otherwise.
161 .IP \(bu 2
162 \fBerror_msg\fP (\fIs\fP) \-\- string, contains errors encountered while cleaning the cache.
163 .UNINDENT
164 .UNINDENT
165 .sp
166 Remove or expire cached data.
167 .INDENT 7.0
168 .TP
169 .B Following @options are supported:
170 .INDENT 7.0
171 .IP \(bu 2
172 .INDENT 2.0
173 .TP
174 .B interactive: boolean, default true
175 Set to \(dqtrue\(dq, when the operation is done by a user, thus user interaction like password prompts can be done.
176 .UNINDENT
177 .UNINDENT
178 .UNINDENT
179 .sp
180 Unknown options are ignored.
181 .UNINDENT
182 .INDENT 7.0
183 .TP
184 .B method clean(s cache_type) -> (b success, s error_msg)
185 .INDENT 7.0
186 .TP
187 .B Arguments
188 .INDENT 7.0
189 .IP \(bu 2
190 \fBcache_type\fP (\fIs\fP) \-\- cache type to clean up. Supported types are \(dqall\(dq, \(dqpackages\(dq, \(dqmetadata\(dq, \(dqdbcache\(dq, and \(dqexpire\-cache\(dq.
191 .UNINDENT
192 .TP
193 .B Returns
194 .INDENT 7.0
195 .IP \(bu 2
196 \fBsuccess\fP (\fIb\fP) \-\- \fItrue\fP if the cache was successfully cleaned, \fIfalse\fP otherwise.
197 .IP \(bu 2
198 \fBerror_msg\fP (\fIs\fP) \-\- string, contains errors encountered while cleaning the cache.
199 .UNINDENT
200 .UNINDENT
201 .sp
202 Remove or expire cached data.
203 .sp
204 This is equivalent to call \(dqclean_with_options()\(dq with empty options.
205 .UNINDENT
206 .INDENT 7.0
207 .TP
208 .B method reset() -> (b success, s error_msg)
209 .INDENT 7.0
210 .TP
211 .B Returns
212 .INDENT 7.0
213 .IP \(bu 2
214 \fBsuccess\fP (\fIb\fP) \-\- \fItrue\fP if the session was successfully reset, \fIfalse\fP otherwise.
215 .IP \(bu 2
216 \fBerror_msg\fP (\fIs\fP) \-\- string, contains errors encountered while resetting the session
217 .UNINDENT
218 .UNINDENT
219 .sp
220 Completely reset the session.
221 .UNINDENT
222 .INDENT 7.0
223 .TP
224 .B signal download_add_new(o session_object_path, s download_id, s description, x total_to_download)
225 .INDENT 7.0
226 .TP
227 .B Arguments
228 .INDENT 7.0
229 .IP \(bu 2
230 \fBsession_object_path\fP (\fIo\fP) \-\- object path of the dnf5daemon session
231 .IP \(bu 2
232 \fBdownload_id\fP (\fIs\fP) \-\- unique id of downloaded object (repo or package)
233 .IP \(bu 2
234 \fBdescription\fP (\fIs\fP) \-\- the description of the downloaded object
235 .IP \(bu 2
236 \fBtotal_to_download\fP (\fIx\fP) \-\- total bytes to download
237 .UNINDENT
238 .UNINDENT
239 .sp
240 A new download has started.
241 .UNINDENT
242 .INDENT 7.0
243 .TP
244 .B signal download_progress(o session_object_path, s download_id, x total_to_download, x downloaded)
245 .INDENT 7.0
246 .TP
247 .B Arguments
248 .INDENT 7.0
249 .IP \(bu 2
250 \fBsession_object_path\fP (\fIo\fP) \-\- object path of the dnf5daemon session
251 .IP \(bu 2
252 \fBdownload_id\fP (\fIs\fP) \-\- unique id of downloaded object (repo or package)
253 .IP \(bu 2
254 \fBtotal_to_download\fP (\fIx\fP) \-\- total bytes to download
255 .IP \(bu 2
256 \fBdownloaded\fP (\fIx\fP) \-\- bytes already downloaded
257 .UNINDENT
258 .UNINDENT
259 .sp
260 Progress in downloading.
261 .UNINDENT
262 .INDENT 7.0
263 .TP
264 .B signal download_mirror_failure(o session_object_path, s download_id, s message, s url, s metadata)
265 .INDENT 7.0
266 .TP
267 .B Arguments
268 .INDENT 7.0
269 .IP \(bu 2
270 \fBsession_object_path\fP (\fIo\fP) \-\- object path of the dnf5daemon session
271 .IP \(bu 2
272 \fBdownload_id\fP (\fIs\fP) \-\- unique id of downloaded object (repo or package)
273 .IP \(bu 2
274 \fBmessage\fP (\fIs\fP) \-\- an error message
275 .IP \(bu 2
276 \fBurl\fP (\fIs\fP) \-\- URL being downloaded
277 .IP \(bu 2
278 \fBmetadata\fP (\fIs\fP) \-\- For repository metadata download contains metadata type
279 .UNINDENT
280 .UNINDENT
281 .sp
282 Mirror failure during the download.
283 .UNINDENT
284 .INDENT 7.0
285 .TP
286 .B signal download_end(o session_object_path, s download_id, u transfer_status, s message)
287 .INDENT 7.0
288 .TP
289 .B Arguments
290 .INDENT 7.0
291 .IP \(bu 2
292 \fBsession_object_path\fP (\fIo\fP) \-\- object path of the dnf5daemon session
293 .IP \(bu 2
294 \fBdownload_id\fP (\fIs\fP) \-\- unique id of downloaded object (repo or package)
295 .IP \(bu 2
296 \fBtransfer_status\fP (\fIu\fP) \-\- libdnf5::repo::DownloadCallbacks::TransferStatus (0 \- successful, 1 \- already exists, 2 \- error)
297 .IP \(bu 2
298 \fBmessage\fP (\fIs\fP) \-\- error message in case of failed download
299 .UNINDENT
300 .UNINDENT
301 .sp
302 Downloading has ended.
303 .UNINDENT
304 .INDENT 7.0
305 .TP
306 .B signal repo_key_import_request(o session_object_path, s key_id, as user_ids, s key_fingerprint, s key_url, x timestamp)
307 .INDENT 7.0
308 .TP
309 .B Arguments
310 .INDENT 7.0
311 .IP \(bu 2
312 \fBsession_object_path\fP (\fIo\fP) \-\- object path of the dnf5daemon session
313 .IP \(bu 2
314 \fBkey_id\fP (\fIs\fP) \-\- OpenPGP key id
315 .IP \(bu 2
316 \fBuser_ids\fP (\fIas\fP) \-\- User id
317 .IP \(bu 2
318 \fBkey_fingerprint\fP (\fIs\fP) \-\- Fingerprint of the OpenPGP key
319 .IP \(bu 2
320 \fBkey_url\fP (\fIs\fP) \-\- URL of the OpenPGP key
321 .IP \(bu 2
322 \fBtimestamp\fP (\fIx\fP) \-\- timestamp when the key was created
323 .UNINDENT
324 .UNINDENT
325 .sp
326 Request for repository key import confirmation.
327 .UNINDENT
328 .INDENT 7.0
329 .TP
330 .B signal repo_key_imported(o session_object_path, s key_id, as user_ids, s key_fingerprint, s key_url, x timestamp)
331 .INDENT 7.0
332 .TP
333 .B Arguments
334 .INDENT 7.0
335 .IP \(bu 2
336 \fBsession_object_path\fP (\fIo\fP) \-\- object path of the dnf5daemon session
337 .IP \(bu 2
338 \fBkey_id\fP (\fIs\fP) \-\- OpenPGP key id
339 .IP \(bu 2
340 \fBuser_ids\fP (\fIas\fP) \-\- User id
341 .IP \(bu 2
342 \fBkey_fingerprint\fP (\fIs\fP) \-\- Fingerprint of the OpenPGP key
343 .IP \(bu 2
344 \fBkey_url\fP (\fIs\fP) \-\- URL of the OpenPGP key
345 .IP \(bu 2
346 \fBtimestamp\fP (\fIx\fP) \-\- timestamp when the key was created
347 .UNINDENT
348 .UNINDENT
349 .sp
350 Informational signal emitted after a repository key was successfully imported.
351 .UNINDENT
352 .UNINDENT
353 .SS org.rpm.dnf.v0.rpm.Repo interface
354 .INDENT 0.0
355 .TP
356 .B interface org.rpm.dnf.v0.rpm.Repo
357 .INDENT 7.0
358 .TP
359 .B method list(a{sv} options) -> (aa{sv} repositories)
360 .INDENT 7.0
361 .TP
362 .B Arguments
363 .INDENT 7.0
364 .IP \(bu 2
365 \fBoptions\fP (\fIa{sv}\fP) \-\- an array of key/value pairs
366 .UNINDENT
367 .TP
368 .B Returns
369 .INDENT 7.0
370 .IP \(bu 2
371 \fBrepositories\fP (\fIaa{sv}\fP) \-\- array of returned repositories with requested attributes
372 .UNINDENT
373 .UNINDENT
374 .sp
375 Get list of repositories that match to given filters.
376 .sp
377 Following options are supported:
378 .INDENT 7.0
379 .INDENT 3.5
380 .INDENT 0.0
381 .IP \(bu 2
382 .INDENT 2.0
383 .TP
384 .B patterns: list of strings
385 any repository with id matching to any of patterns is returned
386 .UNINDENT
387 .IP \(bu 2
388 .INDENT 2.0
389 .TP
390 .B repo_attrs: list of strings
391 list of repository attributes that are returned
392 .UNINDENT
393 .IP \(bu 2
394 .INDENT 2.0
395 .TP
396 .B enable_disable: string (default \(dqenabled\(dq)
397 When set to \(dqenabled\(dq or \(dqdisabled\(dq, only enabled / disabled repositories are listed. Any other value means all repositories are returned.
398 .UNINDENT
399 .IP \(bu 2
400 .INDENT 2.0
401 .TP
402 .B interactive: boolean, default false
403 Set to \(dqtrue\(dq, when the operation is done by a user, thus user interaction like password prompts can be done.
404 .UNINDENT
405 .UNINDENT
406 .UNINDENT
407 .UNINDENT
408 .sp
409 Unknown options are ignored.
410 .UNINDENT
411 .INDENT 7.0
412 .TP
413 .B method confirm_key_with_options(s key_id, b confirmed, a{sv} options) -> ()
414 .INDENT 7.0
415 .TP
416 .B Arguments
417 .INDENT 7.0
418 .IP \(bu 2
419 \fBkey_id\fP (\fIs\fP) \-\- id of the key in question
420 .IP \(bu 2
421 \fBconfirmed\fP (\fIb\fP) \-\- whether the key import is confirmed by user
422 .IP \(bu 2
423 \fBoptions\fP (\fIa{sv}\fP) \-\- an array of key/value pairs to modify the call behavior
424 .UNINDENT
425 .UNINDENT
426 .sp
427 Confirm repository OpenPGP key import.
428 .INDENT 7.0
429 .TP
430 .B Following @options are supported:
431 .INDENT 7.0
432 .IP \(bu 2
433 .INDENT 2.0
434 .TP
435 .B interactive: boolean, default true
436 Set to \(dqtrue\(dq, when the operation is done by a user, thus user interaction like password prompts can be done.
437 .UNINDENT
438 .UNINDENT
439 .UNINDENT
440 .sp
441 Unknown options are ignored.
442 .UNINDENT
443 .INDENT 7.0
444 .TP
445 .B method confirm_key(s key_id, b confirmed) -> ()
446 .INDENT 7.0
447 .TP
448 .B Arguments
449 .INDENT 7.0
450 .IP \(bu 2
451 \fBkey_id\fP (\fIs\fP) \-\- id of the key in question
452 .IP \(bu 2
453 \fBconfirmed\fP (\fIb\fP) \-\- whether the key import is confirmed by user
454 .UNINDENT
455 .UNINDENT
456 .sp
457 Confirm repository OpenPGP key import.
458 .sp
459 This is equivalent to call \(dqconfirm_key_with_options()\(dq with empty options.
460 .UNINDENT
461 .INDENT 7.0
462 .TP
463 .B method enable_with_options(as repo_ids, a{sv} options) -> ()
464 .INDENT 7.0
465 .TP
466 .B Arguments
467 .INDENT 7.0
468 .IP \(bu 2
469 \fBrepo_ids\fP (\fIas\fP) \-\- array of strings containing all repo ids to be enabled
470 .IP \(bu 2
471 \fBoptions\fP (\fIa{sv}\fP) \-\- an array of key/value pairs to modify the call behavior
472 .UNINDENT
473 .UNINDENT
474 .sp
475 Enable repositories based on the list of given ids.
476 .INDENT 7.0
477 .TP
478 .B Following @options are supported:
479 .INDENT 7.0
480 .IP \(bu 2
481 .INDENT 2.0
482 .TP
483 .B interactive: boolean, default true
484 Set to \(dqtrue\(dq, when the operation is done by a user, thus user interaction like password prompts can be done.
485 .UNINDENT
486 .UNINDENT
487 .UNINDENT
488 .sp
489 Unknown options are ignored.
490 .UNINDENT
491 .INDENT 7.0
492 .TP
493 .B method enable(as repo_ids) -> ()
494 .INDENT 7.0
495 .TP
496 .B Arguments
497 .INDENT 7.0
498 .IP \(bu 2
499 \fBrepo_ids\fP (\fIas\fP) \-\- array of strings containing all repo ids to be enabled
500 .UNINDENT
501 .UNINDENT
502 .sp
503 Enable repositories based on the list of given ids.
504 .sp
505 This is equivalent to call \(dqenable_with_options()\(dq with empty options.
506 .UNINDENT
507 .INDENT 7.0
508 .TP
509 .B method disable_with_options(as repo_ids, a{sv} options) -> ()
510 .INDENT 7.0
511 .TP
512 .B Arguments
513 .INDENT 7.0
514 .IP \(bu 2
515 \fBrepo_ids\fP (\fIas\fP) \-\- array of strings containing all repo ids to be disabled
516 .IP \(bu 2
517 \fBoptions\fP (\fIa{sv}\fP) \-\- an array of key/value pairs to modify the call behavior
518 .UNINDENT
519 .UNINDENT
520 .sp
521 Disable repositories based on the list of given ids.
522 .INDENT 7.0
523 .TP
524 .B Following @options are supported:
525 .INDENT 7.0
526 .IP \(bu 2
527 .INDENT 2.0
528 .TP
529 .B interactive: boolean, default true
530 Set to \(dqtrue\(dq, when the operation is done by a user, thus user interaction like password prompts can be done.
531 .UNINDENT
532 .UNINDENT
533 .UNINDENT
534 .sp
535 Unknown options are ignored.
536 .UNINDENT
537 .INDENT 7.0
538 .TP
539 .B method disable(as repo_ids) -> ()
540 .INDENT 7.0
541 .TP
542 .B Arguments
543 .INDENT 7.0
544 .IP \(bu 2
545 \fBrepo_ids\fP (\fIas\fP) \-\- array of strings containing all repo ids to be disabled
546 .UNINDENT
547 .UNINDENT
548 .sp
549 Disable repositories based on the list of given ids.
550 .sp
551 This is equivalent to call \(dqdisable_with_options()\(dq with empty options.
552 .UNINDENT
553 .UNINDENT
554 .SS org.rpm.dnf.v0.rpm.Rpm interface
555 .INDENT 0.0
556 .TP
557 .B interface org.rpm.dnf.v0.rpm.Rpm
558 .INDENT 7.0
559 .TP
560 .B method list(a{sv} options) -> (aa{sv} packages)
561 .INDENT 7.0
562 .TP
563 .B Arguments
564 .INDENT 7.0
565 .IP \(bu 2
566 \fBoptions\fP (\fIa{sv}\fP) \-\- an array of key/value pairs
567 .UNINDENT
568 .TP
569 .B Returns
570 .INDENT 7.0
571 .IP \(bu 2
572 \fBpackages\fP (\fIaa{sv}\fP) \-\- array of returned packages with requested attributes
573 .UNINDENT
574 .UNINDENT
575 .sp
576 Get list of packages that match to given filters.
577 Since the method returns packages directly in the D\-Bus method reply
578 message, which has a limited size, there is a possibility that the
579 requested package set size would exceed this limit. If you request a
580 large number of packages and/or a great number of package attributes,
581 please consider using the list_fd() method.
582 .sp
583 Following options and filters are supported:
584 .INDENT 7.0
585 .INDENT 3.5
586 .INDENT 0.0
587 .IP \(bu 2
588 .INDENT 2.0
589 .TP
590 .B package_attrs: list of strings
591 list of package attributes that are returned. Supported attributes are name, epoch, version, release, arch, repo_id, from_repo_id, is_installed, install_size, download_size, buildtime, sourcerpm, summary, url, license, description, files, changelogs, provides, requires, requires_pre, conflicts, obsoletes, recommends, suggests, enhances, supplements, evr, nevra, full_nevra, reason, vendor, group.
592 .UNINDENT
593 .IP \(bu 2
594 .INDENT 2.0
595 .TP
596 .B with_nevra: bool (default true)
597 match patterns against available packages NEVRAs
598 .UNINDENT
599 .IP \(bu 2
600 .INDENT 2.0
601 .TP
602 .B with_provides: bool (default true)
603 match patterns against available packages provides
604 .UNINDENT
605 .IP \(bu 2
606 .INDENT 2.0
607 .TP
608 .B with_filenames: bool (default true)
609 match patterns against names of the files in available packages
610 .UNINDENT
611 .IP \(bu 2
612 .INDENT 2.0
613 .TP
614 .B with_binaries: bool (default true)
615 match patterns against names of the binaries in \fI/usr/(s)bin\fP in available packages
616 .UNINDENT
617 .IP \(bu 2
618 .INDENT 2.0
619 .TP
620 .B with_src: bool (default true)
621 include source rpms into the results
622 .UNINDENT
623 .IP \(bu 2
624 .INDENT 2.0
625 .TP
626 .B icase: bool (default true)
627 ignore case while matching patterns
628 .UNINDENT
629 .IP \(bu 2
630 .INDENT 2.0
631 .TP
632 .B interactive: boolean, default false
633 Set to \(dqtrue\(dq, when the operation is done by a user, thus user interaction like password prompts can be done.
634 .UNINDENT
635 .IP \(bu 2
636 .INDENT 2.0
637 .TP
638 .B patterns: list of strings
639 any package matching to any of patterns is returned
640 .UNINDENT
641 .IP \(bu 2
642 .INDENT 2.0
643 .TP
644 .B scope: string (default \(dqall\(dq)
645 limit packages to one of \(dqall\(dq, \(dqinstalled\(dq, \(dqavailable\(dq, \(dqupgrades\(dq, \(dqupgradable\(dq
646 .UNINDENT
647 .IP \(bu 2
648 .INDENT 2.0
649 .TP
650 .B arch: list of strings
651 limit the resulting set only to packages of given architectures
652 .UNINDENT
653 .IP \(bu 2
654 .INDENT 2.0
655 .TP
656 .B repo: list of strings
657 limit the resulting set only to packages from given repositories
658 .UNINDENT
659 .IP \(bu 2
660 .INDENT 2.0
661 .TP
662 .B latest\-limit: int
663 limit the resulting set to only <limit> of latest packages for every name and architecture
664 .UNINDENT
665 .IP \(bu 2
666 .INDENT 2.0
667 .TP
668 .B whatprovides: list of strings
669 limit the resulting set only to packages that provide any of given capabilities
670 .UNINDENT
671 .IP \(bu 2
672 .INDENT 2.0
673 .TP
674 .B whatdepends: list of strings
675 limit the resulting set only to packages that require, enhance, recommend, suggest or supplement any of given capabilities
676 .UNINDENT
677 .IP \(bu 2
678 .INDENT 2.0
679 .TP
680 .B whatrequires: list of strings
681 limit the resulting set only to packages that require any of given capabilities
682 .UNINDENT
683 .IP \(bu 2
684 .INDENT 2.0
685 .TP
686 .B whatrecommends: list of strings
687 limit the resulting set only to packages that recommend any of given capabilities
688 .UNINDENT
689 .IP \(bu 2
690 .INDENT 2.0
691 .TP
692 .B whatenhances: list of strings
693 limit the resulting set only to packages that enhance any of given capabilities
694 .UNINDENT
695 .IP \(bu 2
696 .INDENT 2.0
697 .TP
698 .B whatsuggests: list of strings
699 limit the resulting set only to packages that suggest any of given capabilities
700 .UNINDENT
701 .IP \(bu 2
702 .INDENT 2.0
703 .TP
704 .B whatsupplements: list of strings
705 limit the resulting set only to packages that supplement any of given capabilities
706 .UNINDENT
707 .IP \(bu 2
708 .INDENT 2.0
709 .TP
710 .B whatobsoletes: list of strings
711 limit the resulting set only to packages that obsolete any of given capabilities
712 .UNINDENT
713 .IP \(bu 2
714 .INDENT 2.0
715 .TP
716 .B whatconflicts: list of strings
717 limit the resulting set only to packages that conflict with any of given capabilities
718 .UNINDENT
719 .UNINDENT
720 .UNINDENT
721 .UNINDENT
722 .sp
723 Unknown options are ignored.
724 .UNINDENT
725 .INDENT 7.0
726 .TP
727 .B method list_fd(a{sv} options, h file_descriptor) -> (s transfer_id)
728 .INDENT 7.0
729 .TP
730 .B Arguments
731 .INDENT 7.0
732 .IP \(bu 2
733 \fBoptions\fP (\fIa{sv}\fP) \-\- an array of key/value pairs
734 .IP \(bu 2
735 \fBfile_descriptor\fP (\fIh\fP) \-\- File descriptor opened for writing used to transfer data
736 .UNINDENT
737 .TP
738 .B Returns
739 .INDENT 7.0
740 .IP \(bu 2
741 \fBtransfer_id\fP (\fIs\fP) \-\- Identifier of this transfer. Used for signaling the end of transfer.
742 .UNINDENT
743 .UNINDENT
744 .sp
745 Retrieve a list of packages that match the provided filters.
746 Packages are transmitted as a stream of JSON objects, with each JSON object representing one package as a dictionary. This stream is then written into the given file_descriptor.
747 Unlike the list() method, this approach does not encounter issues with large output data.
748 The server has a 30\-second timeout during which it waits for the client to read data from the pipe if the pipe is full.
749 .sp
750 The same options as in list() method are supported.
751 .UNINDENT
752 .INDENT 7.0
753 .TP
754 .B method install(as pkg_specs, a{sv} options) -> ()
755 .INDENT 7.0
756 .TP
757 .B Arguments
758 .INDENT 7.0
759 .IP \(bu 2
760 \fBpkg_specs\fP (\fIas\fP) \-\- an array of package specifications to be installed on the system
761 .IP \(bu 2
762 \fBoptions\fP (\fIa{sv}\fP) \-\- an array of key/value pairs to modify install behavior
763 .UNINDENT
764 .UNINDENT
765 .sp
766 Mark packages specified by @pkg_specs for installation.
767 .sp
768 Following @options are supported:
769 .INDENT 7.0
770 .INDENT 3.5
771 .INDENT 0.0
772 .IP \(bu 2
773 .INDENT 2.0
774 .TP
775 .B repo_ids: list of strings
776 Identifiers of the repos from which the packages could be installed.
777 .UNINDENT
778 .IP \(bu 2
779 .INDENT 2.0
780 .TP
781 .B skip_broken: boolean, default false
782 Whether solver can skip packages with broken dependencies to resolve transaction
783 .UNINDENT
784 .IP \(bu 2
785 .INDENT 2.0
786 .TP
787 .B skip_unavailable: boolean, default false
788 Whether nonexisting packages can be skipped.
789 .UNINDENT
790 .UNINDENT
791 .UNINDENT
792 .UNINDENT
793 .sp
794 Unknown options are ignored.
795 .UNINDENT
796 .INDENT 7.0
797 .TP
798 .B method upgrade(as pkg_specs, a{sv} options) -> ()
799 .INDENT 7.0
800 .TP
801 .B Arguments
802 .INDENT 7.0
803 .IP \(bu 2
804 \fBpkg_specs\fP (\fIas\fP) \-\- an array of package specifications to be upgraded on the system
805 .IP \(bu 2
806 \fBoptions\fP (\fIa{sv}\fP) \-\- an array of key/value pairs to modify upgrade behavior
807 .UNINDENT
808 .UNINDENT
809 .sp
810 Mark packages specified by @pkg_specs for upgrade.
811 .sp
812 Following @options are supported:
813 .INDENT 7.0
814 .INDENT 3.5
815 .INDENT 0.0
816 .IP \(bu 2
817 .INDENT 2.0
818 .TP
819 .B repo_ids: list of strings
820 Identifiers of the repos from which the packages could be upgraded.
821 .UNINDENT
822 .UNINDENT
823 .UNINDENT
824 .UNINDENT
825 .sp
826 Unknown options are ignored.
827 .UNINDENT
828 .INDENT 7.0
829 .TP
830 .B method remove(as pkg_specs, a{sv} options) -> ()
831 .INDENT 7.0
832 .TP
833 .B Arguments
834 .INDENT 7.0
835 .IP \(bu 2
836 \fBpkg_specs\fP (\fIas\fP) \-\- an array of package specifications to be removed on the system
837 .IP \(bu 2
838 \fBoptions\fP (\fIa{sv}\fP) \-\- an array of key/value pairs to modify remove behavior
839 .UNINDENT
840 .UNINDENT
841 .sp
842 Mark packages specified by @pkg_specs for removal.
843 .sp
844 Unknown options are ignored.
845 .UNINDENT
846 .INDENT 7.0
847 .TP
848 .B method distro_sync(as pkg_specs, a{sv} options) -> ()
849 .INDENT 7.0
850 .TP
851 .B Arguments
852 .INDENT 7.0
853 .IP \(bu 2
854 \fBpkg_specs\fP (\fIas\fP) \-\- array of package specifications to synchronize to the latest available versions
855 .IP \(bu 2
856 \fBoptions\fP (\fIa{sv}\fP) \-\- an array of key/value pairs to modify distro_sync behavior
857 .UNINDENT
858 .UNINDENT
859 .sp
860 Following @options are supported:
861 .sp
862 Unknown options are ignored.
863 .UNINDENT
864 .INDENT 7.0
865 .TP
866 .B method downgrade(as pkg_specs, a{sv} options) -> ()
867 .INDENT 7.0
868 .TP
869 .B Arguments
870 .INDENT 7.0
871 .IP \(bu 2
872 \fBpkg_specs\fP (\fIas\fP) \-\- an array of package specifications to be downgraded on the system
873 .IP \(bu 2
874 \fBoptions\fP (\fIa{sv}\fP) \-\- an array of key/value pairs to modify downgrade behavior
875 .UNINDENT
876 .UNINDENT
877 .sp
878 Mark packages specified by @pkg_specs for downgrade.
879 .sp
880 Following @options are supported:
881 .sp
882 Unknown options are ignored.
883 .UNINDENT
884 .INDENT 7.0
885 .TP
886 .B method reinstall(as pkg_specs, a{sv} options) -> ()
887 .INDENT 7.0
888 .TP
889 .B Arguments
890 .INDENT 7.0
891 .IP \(bu 2
892 \fBpkg_specs\fP (\fIas\fP) \-\- an array of package specifications to be reinstalled on the system
893 .IP \(bu 2
894 \fBoptions\fP (\fIa{sv}\fP) \-\- an array of key/value pairs to modify reinstall behavior
895 .UNINDENT
896 .UNINDENT
897 .sp
898 Mark packages specified by @pkg_specs for reinstall.
899 .sp
900 Following @options are supported:
901 .sp
902 Unknown options are ignored.
903 .UNINDENT
904 .INDENT 7.0
905 .TP
906 .B method system_upgrade(a{sv} options) -> ()
907 .INDENT 7.0
908 .TP
909 .B Arguments
910 .INDENT 7.0
911 .IP \(bu 2
912 \fBoptions\fP (\fIa{sv}\fP) \-\- an array of key/value pairs to modify system_upgrade behavior
913 .UNINDENT
914 .UNINDENT
915 .sp
916 Prepare a transaction for upgrade to the new distribution release. The prepared transaction should be executed during reboot (see \fIoffline\fP option of the \fIdo_transaction\fP method of the \fIGoal\fP interface).
917 The method relies on the \fIreleasever\fP option being correctly set to the new distribution release during the \fIopen_session()\fP call.
918 .sp
919 Following @options are supported:
920 .INDENT 7.0
921 .INDENT 3.5
922 .INDENT 0.0
923 .IP \(bu 2
924 .INDENT 2.0
925 .TP
926 .B mode: string (one of \(dqdistrosync\(dq, \(dqupgrade\(dq, default is \(dqdistrosync\(dq)
927 By default the system_upgrade behaves like \fIdnf distro\-sync\fP, always installing packages from the new release, even if they are older than the currently installed version. If set to \(dqupgrade\(dq, packages from the new release are not installed if they are older than what is currently installed (behave like \fIdnf upgrade\fP).
928 .UNINDENT
929 .IP \(bu 2
930 .INDENT 2.0
931 .TP
932 .B interactive: boolean, default true
933 Set to \(dqtrue\(dq, when the operation is done by a user, thus user interaction like password prompts can be done.
934 .UNINDENT
935 .UNINDENT
936 .UNINDENT
937 .UNINDENT
938 .sp
939 Unknown options are ignored.
940 .UNINDENT
941 .INDENT 7.0
942 .TP
943 .B signal transaction_elem_progress(o session_object_path, s nevra, t processed, t total)
944 .INDENT 7.0
945 .TP
946 .B Arguments
947 .INDENT 7.0
948 .IP \(bu 2
949 \fBsession_object_path\fP (\fIo\fP) \-\- object path of the dnf5daemon session
950 .IP \(bu 2
951 \fBnevra\fP (\fIs\fP) \-\- full NEVRA of the package
952 .IP \(bu 2
953 \fBprocessed\fP (\fIt\fP) \-\- amount already processed
954 .IP \(bu 2
955 \fBtotal\fP (\fIt\fP) \-\- total to process
956 .UNINDENT
957 .UNINDENT
958 .sp
959 Overall progress in transaction item processing. Called right before an item is processed.
960 .UNINDENT
961 .INDENT 7.0
962 .TP
963 .B signal transaction_before_begin(o session_object_path, t total)
964 .INDENT 7.0
965 .TP
966 .B Arguments
967 .INDENT 7.0
968 .IP \(bu 2
969 \fBsession_object_path\fP (\fIo\fP) \-\- object path of the dnf5daemon session
970 .IP \(bu 2
971 \fBtotal\fP (\fIt\fP) \-\- number of elements in the rpm transaction
972 .UNINDENT
973 .UNINDENT
974 .sp
975 Send right before the rpm transaction is run.
976 .UNINDENT
977 .INDENT 7.0
978 .TP
979 .B signal transaction_after_complete(o session_object_path, b success)
980 .INDENT 7.0
981 .TP
982 .B Arguments
983 .INDENT 7.0
984 .IP \(bu 2
985 \fBsession_object_path\fP (\fIo\fP) \-\- object path of the dnf5daemon session
986 .IP \(bu 2
987 \fBsuccess\fP (\fIb\fP) \-\- true if the rpm transaction was completed successfully
988 .UNINDENT
989 .UNINDENT
990 .sp
991 Send right after the rpm transaction run finished.
992 .UNINDENT
993 .INDENT 7.0
994 .TP
995 .B signal transaction_action_start(o session_object_path, s nevra, u action, t total)
996 .INDENT 7.0
997 .TP
998 .B Arguments
999 .INDENT 7.0
1000 .IP \(bu 2
1001 \fBsession_object_path\fP (\fIo\fP) \-\- object path of the dnf5daemon session
1002 .IP \(bu 2
1003 \fBnevra\fP (\fIs\fP) \-\- full NEVRA of the package
1004 .IP \(bu 2
1005 \fBaction\fP (\fIu\fP) \-\- one of the dnfdaemon::RpmTransactionItem::Actions enum
1006 .IP \(bu 2
1007 \fBtotal\fP (\fIt\fP) \-\- the disk space used/freed by the package after the action finishes
1008 .UNINDENT
1009 .UNINDENT
1010 .sp
1011 Processing (installation or removal) of the package has started.
1012 .UNINDENT
1013 .INDENT 7.0
1014 .TP
1015 .B signal transaction_action_progress(o session_object_path, s nevra, t processed, t total)
1016 .INDENT 7.0
1017 .TP
1018 .B Arguments
1019 .INDENT 7.0
1020 .IP \(bu 2
1021 \fBsession_object_path\fP (\fIo\fP) \-\- object path of the dnf5daemon session
1022 .IP \(bu 2
1023 \fBnevra\fP (\fIs\fP) \-\- full NEVRA of the package
1024 .IP \(bu 2
1025 \fBprocessed\fP (\fIt\fP) \-\- the portion of the package already installed/removed
1026 .IP \(bu 2
1027 \fBtotal\fP (\fIt\fP) \-\- the disk space used/freed by the package after the action finishes
1028 .UNINDENT
1029 .UNINDENT
1030 .sp
1031 Progress in processing of the package.
1032 Note that there is a hardcoded limit that prevents sending more than one signal every
1033 400 milliseconds to avoid overwhelming the user or D\-Bus with excessive signals.
1034 For smaller packages there might be no progress signals or only the starting
1035 progress signal with @processed equal to 0.
1036 .UNINDENT
1037 .INDENT 7.0
1038 .TP
1039 .B signal transaction_action_stop(o session_object_path, s nevra, t total)
1040 .INDENT 7.0
1041 .TP
1042 .B Arguments
1043 .INDENT 7.0
1044 .IP \(bu 2
1045 \fBsession_object_path\fP (\fIo\fP) \-\- object path of the dnf5daemon session
1046 .IP \(bu 2
1047 \fBnevra\fP (\fIs\fP) \-\- full NEVRA of the package
1048 .IP \(bu 2
1049 \fBtotal\fP (\fIt\fP) \-\- the disk space used/freed by the package after the action finishes
1050 .UNINDENT
1051 .UNINDENT
1052 .sp
1053 Processing of the package has finished.
1054 .UNINDENT
1055 .INDENT 7.0
1056 .TP
1057 .B signal transaction_script_start(o session_object_path, s nevra, u scriptlet_type)
1058 .INDENT 7.0
1059 .TP
1060 .B Arguments
1061 .INDENT 7.0
1062 .IP \(bu 2
1063 \fBsession_object_path\fP (\fIo\fP) \-\- object path of the dnf5daemon session
1064 .IP \(bu 2
1065 \fBnevra\fP (\fIs\fP) \-\- full NEVRA of the package script belongs to
1066 .IP \(bu 2
1067 \fBscriptlet_type\fP (\fIu\fP) \-\- scriptlet type that started (pre, post,...)
1068 .UNINDENT
1069 .UNINDENT
1070 .sp
1071 The scriptlet has started.
1072 .UNINDENT
1073 .INDENT 7.0
1074 .TP
1075 .B signal transaction_script_stop(o session_object_path, s nevra, u scriptlet_type, t return_code)
1076 .INDENT 7.0
1077 .TP
1078 .B Arguments
1079 .INDENT 7.0
1080 .IP \(bu 2
1081 \fBsession_object_path\fP (\fIo\fP) \-\- object path of the dnf5daemon session
1082 .IP \(bu 2
1083 \fBnevra\fP (\fIs\fP) \-\- full NEVRA of the package script belongs to
1084 .IP \(bu 2
1085 \fBscriptlet_type\fP (\fIu\fP) \-\- scriptlet type that started (pre, post,...)
1086 .IP \(bu 2
1087 \fBreturn_code\fP (\fIt\fP) \-\- return value of the script
1088 .UNINDENT
1089 .UNINDENT
1090 .sp
1091 The scriptlet has successfully finished.
1092 .UNINDENT
1093 .INDENT 7.0
1094 .TP
1095 .B signal transaction_script_error(o session_object_path, s nevra, u scriptlet_type, t return_code)
1096 .INDENT 7.0
1097 .TP
1098 .B Arguments
1099 .INDENT 7.0
1100 .IP \(bu 2
1101 \fBsession_object_path\fP (\fIo\fP) \-\- object path of the dnf5daemon session
1102 .IP \(bu 2
1103 \fBnevra\fP (\fIs\fP) \-\- full NEVRA of the package script belongs to
1104 .IP \(bu 2
1105 \fBscriptlet_type\fP (\fIu\fP) \-\- scriptlet type that started (pre, post,...)
1106 .IP \(bu 2
1107 \fBreturn_code\fP (\fIt\fP) \-\- return value of the script
1108 .UNINDENT
1109 .UNINDENT
1110 .sp
1111 The scriptlet has finished with an error.
1112 .UNINDENT
1113 .INDENT 7.0
1114 .TP
1115 .B signal transaction_verify_start(o session_object_path, t total)
1116 .INDENT 7.0
1117 .TP
1118 .B Arguments
1119 .INDENT 7.0
1120 .IP \(bu 2
1121 \fBsession_object_path\fP (\fIo\fP) \-\- object path of the dnf5daemon session
1122 .IP \(bu 2
1123 \fBtotal\fP (\fIt\fP) \-\- total to process
1124 .UNINDENT
1125 .UNINDENT
1126 .sp
1127 Package files verification has started.
1128 .UNINDENT
1129 .INDENT 7.0
1130 .TP
1131 .B signal transaction_verify_progress(o session_object_path, t processed, t total)
1132 .INDENT 7.0
1133 .TP
1134 .B Arguments
1135 .INDENT 7.0
1136 .IP \(bu 2
1137 \fBsession_object_path\fP (\fIo\fP) \-\- object path of the dnf5daemon session
1138 .IP \(bu 2
1139 \fBprocessed\fP (\fIt\fP) \-\- amount already processed
1140 .IP \(bu 2
1141 \fBtotal\fP (\fIt\fP) \-\- total to process
1142 .UNINDENT
1143 .UNINDENT
1144 .sp
1145 Progress in processing of the package.
1146 .UNINDENT
1147 .INDENT 7.0
1148 .TP
1149 .B signal transaction_verify_stop(o session_object_path, t total)
1150 .INDENT 7.0
1151 .TP
1152 .B Arguments
1153 .INDENT 7.0
1154 .IP \(bu 2
1155 \fBsession_object_path\fP (\fIo\fP) \-\- object path of the dnf5daemon session
1156 .IP \(bu 2
1157 \fBtotal\fP (\fIt\fP) \-\- total to process
1158 .UNINDENT
1159 .UNINDENT
1160 .sp
1161 Package files verification has finished.
1162 .UNINDENT
1163 .INDENT 7.0
1164 .TP
1165 .B signal transaction_transaction_start(o session_object_path, t total)
1166 .INDENT 7.0
1167 .TP
1168 .B Arguments
1169 .INDENT 7.0
1170 .IP \(bu 2
1171 \fBsession_object_path\fP (\fIo\fP) \-\- object path of the dnf5daemon session
1172 .IP \(bu 2
1173 \fBtotal\fP (\fIt\fP) \-\- total to process
1174 .UNINDENT
1175 .UNINDENT
1176 .sp
1177 Preparation of transaction packages has started.
1178 .UNINDENT
1179 .INDENT 7.0
1180 .TP
1181 .B signal transaction_transaction_progress(o session_object_path, t processed, t total)
1182 .INDENT 7.0
1183 .TP
1184 .B Arguments
1185 .INDENT 7.0
1186 .IP \(bu 2
1187 \fBsession_object_path\fP (\fIo\fP) \-\- object path of the dnf5daemon session
1188 .IP \(bu 2
1189 \fBprocessed\fP (\fIt\fP) \-\- amount already processed
1190 .IP \(bu 2
1191 \fBtotal\fP (\fIt\fP) \-\- total to process
1192 .UNINDENT
1193 .UNINDENT
1194 .sp
1195 Progress in preparation of transaction packages.
1196 .UNINDENT
1197 .INDENT 7.0
1198 .TP
1199 .B signal transaction_transaction_stop(o session_object_path, t total)
1200 .INDENT 7.0
1201 .TP
1202 .B Arguments
1203 .INDENT 7.0
1204 .IP \(bu 2
1205 \fBsession_object_path\fP (\fIo\fP) \-\- object path of the dnf5daemon session
1206 .IP \(bu 2
1207 \fBtotal\fP (\fIt\fP) \-\- total to process
1208 .UNINDENT
1209 .UNINDENT
1210 .sp
1211 Preparation of transaction packages has finished.
1212 .UNINDENT
1213 .INDENT 7.0
1214 .TP
1215 .B signal transaction_unpack_error(o session_object_path, s nevra)
1216 .INDENT 7.0
1217 .TP
1218 .B Arguments
1219 .INDENT 7.0
1220 .IP \(bu 2
1221 \fBsession_object_path\fP (\fIo\fP) \-\- object path of the dnf5daemon session
1222 .IP \(bu 2
1223 \fBnevra\fP (\fIs\fP) \-\- full NEVRA of the package
1224 .UNINDENT
1225 .UNINDENT
1226 .sp
1227 Error while unpacking the package.
1228 .UNINDENT
1229 .INDENT 7.0
1230 .TP
1231 .B signal write_to_fd_finished(b success, s transfer_id, s error_msg)
1232 .INDENT 7.0
1233 .TP
1234 .B Arguments
1235 .INDENT 7.0
1236 .IP \(bu 2
1237 \fBsuccess\fP (\fIb\fP) \-\- true if the transfer finished successfully
1238 .IP \(bu 2
1239 \fBtransfer_id\fP (\fIs\fP) \-\- id of the finished transfer
1240 .IP \(bu 2
1241 \fBerror_msg\fP (\fIs\fP) \-\- error message if the transfer was not successful.
1242 .UNINDENT
1243 .UNINDENT
1244 .sp
1245 Notify the user that writing to the file descriptor with given transfer_id has finished and the descriptor has been closed.
1246 .UNINDENT
1247 .UNINDENT
1248 .SS org.rpm.dnf.v0.Goal interface
1249 .INDENT 0.0
1250 .TP
1251 .B interface org.rpm.dnf.v0.Goal
1252 .INDENT 7.0
1253 .TP
1254 .B method resolve(a{sv} options) -> (a(sssa{sv}a{sv}) transaction_items, u result)
1255 .INDENT 7.0
1256 .TP
1257 .B Arguments
1258 .INDENT 7.0
1259 .IP \(bu 2
1260 \fBoptions\fP (\fIa{sv}\fP) \-\- an array of key/value pairs to modify dependency resolving
1261 .UNINDENT
1262 .TP
1263 .B Returns
1264 .INDENT 7.0
1265 .IP \(bu 2
1266 \fBtransaction_items\fP (\fIa(sssa{sv}a{sv})\fP) \-\- array of (object_type, action, reason, {transaction_item_attributes}, {object}) tuples. object_type is one of libdnf5::transaction::TransactionItemType, action is one of libdnf5::transaction::TransactionItemAction, reason is one of libdnf5::transaction::TransactionItemReason enums. Each of these enums are represented as strings using corresponding libdnf5::transaction::*_to_string() methods. transaction_item_attributes is a map {attribute: value}. Currently \(dqreason_change_group_id\(dq attribute is used for target group id in case the action is ReasonChange and the reason Group, and \(dqreplaces\(dq containing a vector of packages ids being replaced by this item. Finally the object is a map {attribute: value} and represents (according to object_type) package, group, environment, or module. These package attributes are returned: \(dqname\(dq, \(dqepoch\(dq, \(dqversion\(dq, \(dqrelease\(dq, \(dqarch\(dq, \(dqrepo_id\(dq, \(dqfrom_repo_id\(dq, \(dqpackage_size\(dq, \(dqinstall_size\(dq, \(dqevr\(dq, and \(dqreason\(dq. For groups the object contains \(dqgroupid\(dq and \(dqname\(dq attributes.
1267 .IP \(bu 2
1268 \fBresult\fP (\fIu\fP) \-\- problems detected during transaction resolving. Possible values are 0 \- no problem, 1 \- no problem, but some info / warnings are present or 2 \- resolving failed.
1269 .UNINDENT
1270 .UNINDENT
1271 .sp
1272 Resolve the transaction.
1273 .INDENT 7.0
1274 .TP
1275 .B Following @options are supported:
1276 .INDENT 7.0
1277 .IP \(bu 2
1278 .INDENT 2.0
1279 .TP
1280 .B allow_erasing: boolean, default false
1281 Whether removal of installed package is allowed to resolve the transaction.
1282 .UNINDENT
1283 .IP \(bu 2
1284 .INDENT 2.0
1285 .TP
1286 .B interactive: boolean, default false
1287 Set to \(dqtrue\(dq, when the operation is done by a user, thus user interaction like password prompts can be done.
1288 .UNINDENT
1289 .UNINDENT
1290 .UNINDENT
1291 .sp
1292 Unknown options are ignored.
1293 .UNINDENT
1294 .INDENT 7.0
1295 .TP
1296 .B method get_transaction_problems_string() -> (as problems)
1297 .INDENT 7.0
1298 .TP
1299 .B Returns
1300 .INDENT 7.0
1301 .IP \(bu 2
1302 \fBproblems\fP (\fIas\fP) \-\- array of strings containing all problems found during the transaction resolution.
1303 .UNINDENT
1304 .UNINDENT
1305 .sp
1306 Return all problems found during the transaction resolution as human readable messages.
1307 .UNINDENT
1308 .INDENT 7.0
1309 .TP
1310 .B method get_transaction_problems() -> (aa{sv} problems)
1311 .INDENT 7.0
1312 .TP
1313 .B Returns
1314 .INDENT 7.0
1315 .IP \(bu 2
1316 \fBproblems\fP (\fIaa{sv}\fP) \-\- array of {key: value} maps
1317 .UNINDENT
1318 .UNINDENT
1319 .sp
1320 Return all problems found during the transaction resolution as structures. This is the list of problem keys:
1321 always present:
1322 action \- see include/libdnf5/base/goal_elements.hpp: GoalAction
1323 problem \- see include/libdnf5/base/goal_elements.hpp: GoalProblem
1324 optional:
1325 goal_job_settings \- {string: variant}, settings used to resolve the goal
1326 spec \- string, usually nevra of affected package
1327 additional_data \- array of strings, more details on the problem
1328 solver_problems \- problems reported by underlying libsolv
1329 .UNINDENT
1330 .INDENT 7.0
1331 .TP
1332 .B method do_transaction(a{sv} options) -> ()
1333 .INDENT 7.0
1334 .TP
1335 .B Arguments
1336 .INDENT 7.0
1337 .IP \(bu 2
1338 \fBoptions\fP (\fIa{sv}\fP) \-\- an array of key/value pairs to modify transaction running
1339 .UNINDENT
1340 .UNINDENT
1341 .sp
1342 Perform the resolved transaction.
1343 .INDENT 7.0
1344 .TP
1345 .B Following @options are supported:
1346 .INDENT 7.0
1347 .IP \(bu 2
1348 .INDENT 2.0
1349 .TP
1350 .B comment: string
1351 Adds a comment to a transaction.
1352 .UNINDENT
1353 .IP \(bu 2
1354 .INDENT 2.0
1355 .TP
1356 .B offline: boolean, default false
1357 If true, the transaction will be prepared to run during the next reboot. Otherwise, it will run immediately.
1358 .UNINDENT
1359 .IP \(bu 2
1360 .INDENT 2.0
1361 .TP
1362 .B interactive: boolean, default true
1363 Set to \(dqtrue\(dq, when the operation is done by a user, thus user interaction like password prompts can be done.
1364 .UNINDENT
1365 .IP \(bu 2
1366 .INDENT 2.0
1367 .TP
1368 .B downloadonly: boolean, default false, since 5.2.16
1369 If true, only download the resolved package set without executing an RMP transaction. Along with the offline option, the offline transaction files are prepared, but the execution of the transaction is not initiated.
1370 .UNINDENT
1371 .UNINDENT
1372 .UNINDENT
1373 .sp
1374 Unknown options are ignored.
1375 .UNINDENT
1376 .INDENT 7.0
1377 .TP
1378 .B method cancel() -> (b success, s error_msg)
1379 .INDENT 7.0
1380 .TP
1381 .B Returns
1382 .INDENT 7.0
1383 .IP \(bu 2
1384 \fBsuccess\fP (\fIb\fP) \-\- true if the cancellation was successfully requested
1385 .IP \(bu 2
1386 \fBerror_msg\fP (\fIs\fP) \-\- error message if the cancellation was refused
1387 .UNINDENT
1388 .UNINDENT
1389 .sp
1390 Cancel the transaction that was initiated by \fIdo_transaction()\fP\&. The transaction can only be canceled during the package download phase. Once the RPM transaction has begun, cancellation is no longer permitted.
1391 .UNINDENT
1392 .INDENT 7.0
1393 .TP
1394 .B method reset() -> ()
1395 Reset the prepared rpm transaction. After this call the session is ready to perform another rpm transaction.
1396 .UNINDENT
1397 .UNINDENT
1398 .SS org.rpm.dnf.v0.Offline interface
1399 .INDENT 0.0
1400 .TP
1401 .B interface org.rpm.dnf.v0.Offline
1402 .INDENT 7.0
1403 .TP
1404 .B method get_status() -> (b pending, a{sv} transaction_status)
1405 .INDENT 7.0
1406 .TP
1407 .B Returns
1408 .INDENT 7.0
1409 .IP \(bu 2
1410 \fBpending\fP (\fIb\fP) \-\- boolean, true if there is a pending offline transaction
1411 .IP \(bu 2
1412 \fBtransaction_status\fP (\fIa{sv}\fP) \-\- the status of the current offline dnf5 transaction
1413 .UNINDENT
1414 .UNINDENT
1415 .sp
1416 Check whether there is an offline transaction configured for the next reboot initiated by dnf5 and return its status.
1417 .UNINDENT
1418 .INDENT 7.0
1419 .TP
1420 .B method cancel_with_options(a{sv} options) -> (b success, s error_msg)
1421 .INDENT 7.0
1422 .TP
1423 .B Arguments
1424 .INDENT 7.0
1425 .IP \(bu 2
1426 \fBoptions\fP (\fIa{sv}\fP) \-\- an array of key/value pairs to modify the call behavior
1427 .UNINDENT
1428 .TP
1429 .B Returns
1430 .INDENT 7.0
1431 .IP \(bu 2
1432 \fBsuccess\fP (\fIb\fP) \-\- boolean, returns \fIfalse\fP if there was an error during the transaction cancellation, or if the offline transaction was initiated by another tool than dnf5. Returns \fItrue\fP if the offline transaction was successfully cancelled or if no offline transaction was configured.
1433 .IP \(bu 2
1434 \fBerror_msg\fP (\fIs\fP) \-\- string, contains error encountered while cancelling the transaction
1435 .UNINDENT
1436 .UNINDENT
1437 .sp
1438 Cancel the dnf5 offline transaction configured for the next reboot. Offline updates scheduled by another tool are not cancelled.
1439 .INDENT 7.0
1440 .TP
1441 .B Following @options are supported:
1442 .INDENT 7.0
1443 .IP \(bu 2
1444 .INDENT 2.0
1445 .TP
1446 .B interactive: boolean, default true
1447 Set to \(dqtrue\(dq, when the operation is done by a user, thus user interaction like password prompts can be done.
1448 .UNINDENT
1449 .UNINDENT
1450 .UNINDENT
1451 .sp
1452 Unknown options are ignored.
1453 .UNINDENT
1454 .INDENT 7.0
1455 .TP
1456 .B method cancel() -> (b success, s error_msg)
1457 .INDENT 7.0
1458 .TP
1459 .B Returns
1460 .INDENT 7.0
1461 .IP \(bu 2
1462 \fBsuccess\fP (\fIb\fP) \-\- boolean, returns \fIfalse\fP if there was an error during the transaction cancellation, or if the offline transaction was initiated by another tool than dnf5. Returns \fItrue\fP if the offline transaction was successfully cancelled or if no offline transaction was configured.
1463 .IP \(bu 2
1464 \fBerror_msg\fP (\fIs\fP) \-\- string, contains error encountered while cancelling the transaction
1465 .UNINDENT
1466 .UNINDENT
1467 .sp
1468 Cancel the dnf5 offline transaction configured for the next reboot. Offline updates scheduled by another tool are not cancelled.
1469 .sp
1470 This is equivalent to call \(dqcancel_with_options()\(dq with empty options.
1471 .UNINDENT
1472 .INDENT 7.0
1473 .TP
1474 .B method clean_with_options() -> (b success, s error_msg)
1475 .INDENT 7.0
1476 .TP
1477 .B Returns
1478 .INDENT 7.0
1479 .IP \(bu 2
1480 \fBsuccess\fP (\fIb\fP) \-\- boolean, returns \fIfalse\fP if there was an error during the transaction cleanup. Returns \fItrue\fP if the offline transaction was successfully cleaned or if no offline transaction was configured.
1481 .IP \(bu 2
1482 \fBerror_msg\fP (\fIs\fP) \-\- string, contains error encountered while cleaning the transaction
1483 .UNINDENT
1484 .UNINDENT
1485 .sp
1486 Cancel the dnf5 offline transaction configured for the next reboot and remove all stored offline transaction data, including downloaded packages. Offline updates scheduled by another tool are not affected.
1487 .INDENT 7.0
1488 .TP
1489 .B Following @options are supported:
1490 .INDENT 7.0
1491 .IP \(bu 2
1492 .INDENT 2.0
1493 .TP
1494 .B interactive: boolean, default true
1495 Set to \(dqtrue\(dq, when the operation is done by a user, thus user interaction like password prompts can be done.
1496 .UNINDENT
1497 .UNINDENT
1498 .UNINDENT
1499 .sp
1500 Unknown options are ignored.
1501 .UNINDENT
1502 .INDENT 7.0
1503 .TP
1504 .B method clean(a{sv} options) -> (b success, s error_msg)
1505 .INDENT 7.0
1506 .TP
1507 .B Arguments
1508 .INDENT 7.0
1509 .IP \(bu 2
1510 \fBoptions\fP (\fIa{sv}\fP)
1511 .UNINDENT
1512 .TP
1513 .B Returns
1514 .INDENT 7.0
1515 .IP \(bu 2
1516 \fBsuccess\fP (\fIb\fP) \-\- boolean, returns \fIfalse\fP if there was an error during the transaction cleanup. Returns \fItrue\fP if the offline transaction was successfully cleaned or if no offline transaction was configured.
1517 .IP \(bu 2
1518 \fBerror_msg\fP (\fIs\fP) \-\- string, contains error encountered while cleaning the transaction
1519 .UNINDENT
1520 .UNINDENT
1521 .sp
1522 Cancel the dnf5 offline transaction configured for the next reboot and remove all stored offline transaction data, including downloaded packages. Offline updates scheduled by another tool are not affected.
1523 .sp
1524 This is equivalent to call \(dqclean_with_options()\(dq with empty options.
1525 .UNINDENT
1526 .INDENT 7.0
1527 .TP
1528 .B method set_finish_action_with_options(s action, a{sv} options) -> (b success, s error_msg)
1529 .INDENT 7.0
1530 .TP
1531 .B Arguments
1532 .INDENT 7.0
1533 .IP \(bu 2
1534 \fBaction\fP (\fIs\fP) \-\- string, one of \(dqpoweroff\(dq, or \(dqreboot\(dq. If set to \(dqpoweroff\(dq, the system will be powered off after applying the offline transaction. Otherwise the system will reboot.
1535 .IP \(bu 2
1536 \fBoptions\fP (\fIa{sv}\fP) \-\- an array of key/value pairs to modify the call behavior
1537 .UNINDENT
1538 .TP
1539 .B Returns
1540 .INDENT 7.0
1541 .IP \(bu 2
1542 \fBsuccess\fP (\fIb\fP) \-\- boolean, true if the action was successfully set
1543 .IP \(bu 2
1544 \fBerror_msg\fP (\fIs\fP) \-\- string, contains error encountered while setting the action
1545 .UNINDENT
1546 .UNINDENT
1547 .sp
1548 Set the action that should be performed after the offline transaction is applied. If the \fIaction\fP is \(dqpoweroff\(dq, the system will be powered off, otherwise it will be rebooted (which is default).
1549 The call might fail in case there is no scheduled offline transaction, or the transaction was not scheduled using libdnf5.
1550 .INDENT 7.0
1551 .TP
1552 .B Following @options are supported:
1553 .INDENT 7.0
1554 .IP \(bu 2
1555 .INDENT 2.0
1556 .TP
1557 .B interactive: boolean, default true
1558 Set to \(dqtrue\(dq, when the operation is done by a user, thus user interaction like password prompts can be done.
1559 .UNINDENT
1560 .UNINDENT
1561 .UNINDENT
1562 .sp
1563 Unknown options are ignored.
1564 .UNINDENT
1565 .INDENT 7.0
1566 .TP
1567 .B method set_finish_action(s action) -> (b success, s error_msg)
1568 .INDENT 7.0
1569 .TP
1570 .B Arguments
1571 .INDENT 7.0
1572 .IP \(bu 2
1573 \fBaction\fP (\fIs\fP) \-\- string, one of \(dqpoweroff\(dq, or \(dqreboot\(dq. If set to \(dqpoweroff\(dq, the system will be powered off after applying the offline transaction. Otherwise the system will reboot.
1574 .UNINDENT
1575 .TP
1576 .B Returns
1577 .INDENT 7.0
1578 .IP \(bu 2
1579 \fBsuccess\fP (\fIb\fP) \-\- boolean, true if the action was successfully set
1580 .IP \(bu 2
1581 \fBerror_msg\fP (\fIs\fP) \-\- string, contains error encountered while setting the action
1582 .UNINDENT
1583 .UNINDENT
1584 .sp
1585 Set the action that should be performed after the offline transaction is applied. If the \fIaction\fP is \(dqpoweroff\(dq, the system will be powered off, otherwise it will be rebooted (which is default).
1586 The call might fail in case there is no scheduled offline transaction, or the transaction was not scheduled using libdnf5.
1587 .sp
1588 This is equivalent to call \(dqset_finish_action_with_options()\(dq with empty options.
1589 .UNINDENT
1590 .INDENT 7.0
1591 .TP
1592 .B method schedule_for_next_boot(a{sv} options) -> (b success, s error_msg)
1593 .INDENT 7.0
1594 .TP
1595 .B Arguments
1596 .INDENT 7.0
1597 .IP \(bu 2
1598 \fBoptions\fP (\fIa{sv}\fP) \-\- an array of key/value pairs to modify the call behavior
1599 .UNINDENT
1600 .TP
1601 .B Returns
1602 .INDENT 7.0
1603 .IP \(bu 2
1604 \fBsuccess\fP (\fIb\fP) \-\- boolean, true if the offline transaction was successfully scheduled for the next boot
1605 .IP \(bu 2
1606 \fBerror_msg\fP (\fIs\fP) \-\- string, contains error encountered while scheduling the transaction
1607 .UNINDENT
1608 .UNINDENT
1609 .sp
1610 Schedule the prepared offline transaction for the next boot. This creates the magic symlink
1611 /system\-update and sets the transaction status to \(dqready\(dq. The system will not be rebooted;
1612 the caller is responsible for initiating the reboot when appropriate.
1613 .sp
1614 The call might fail if there is no offline transaction in the \(dqdownload\-complete\(dq or \(dqready\(dq state,
1615 or the transaction was not prepared using libdnf5.
1616 .INDENT 7.0
1617 .TP
1618 .B Following @options are supported:
1619 .INDENT 7.0
1620 .IP \(bu 2
1621 .INDENT 2.0
1622 .TP
1623 .B interactive: boolean, default true
1624 Set to \(dqtrue\(dq, when the operation is done by a user, thus user interaction like password prompts can be done.
1625 .UNINDENT
1626 .UNINDENT
1627 .UNINDENT
1628 .sp
1629 Unknown options are ignored.
1630 .UNINDENT
1631 .UNINDENT
1632 .SS org.rpm.dnf.v0.comps.Group interface
1633 .INDENT 0.0
1634 .TP
1635 .B interface org.rpm.dnf.v0.comps.Group
1636 .INDENT 7.0
1637 .TP
1638 .B method list(a{sv} options) -> (aa{sv} groups)
1639 .INDENT 7.0
1640 .TP
1641 .B Arguments
1642 .INDENT 7.0
1643 .IP \(bu 2
1644 \fBoptions\fP (\fIa{sv}\fP) \-\- an array of key/value pairs
1645 .UNINDENT
1646 .TP
1647 .B Returns
1648 .INDENT 7.0
1649 .IP \(bu 2
1650 \fBgroups\fP (\fIaa{sv}\fP) \-\- array of returned groups with requested attributes
1651 .UNINDENT
1652 .UNINDENT
1653 .sp
1654 Get list of groups that match to given filters.
1655 .sp
1656 Following options and filters are supported:
1657 .INDENT 7.0
1658 .INDENT 3.5
1659 .INDENT 0.0
1660 .IP \(bu 2
1661 .INDENT 2.0
1662 .TP
1663 .B attributes: list of strings
1664 list of group attributes that are returned
1665 .UNINDENT
1666 .IP \(bu 2
1667 .INDENT 2.0
1668 .TP
1669 .B match_group_id: bool (default true)
1670 match patterns against ids of the groups
1671 .UNINDENT
1672 .IP \(bu 2
1673 .INDENT 2.0
1674 .TP
1675 .B match_group_name: bool (default false)
1676 match patterns against names of the groups
1677 .UNINDENT
1678 .IP \(bu 2
1679 .INDENT 2.0
1680 .TP
1681 .B scope: string (default \(dqall\(dq)
1682 limit groups to one of \(dqall\(dq, \(dqinstalled\(dq, \(dqavailable\(dq
1683 .UNINDENT
1684 .IP \(bu 2
1685 .INDENT 2.0
1686 .TP
1687 .B with_hidden: bool (default false)
1688 include hidden groups into the result
1689 .UNINDENT
1690 .IP \(bu 2
1691 .INDENT 2.0
1692 .TP
1693 .B patterns: list of strings
1694 any group matching to any of patterns is returned
1695 .UNINDENT
1696 .IP \(bu 2
1697 .INDENT 2.0
1698 .TP
1699 .B contains_pkgs: list of strings
1700 include only groups containing given packages
1701 .UNINDENT
1702 .IP \(bu 2
1703 .INDENT 2.0
1704 .TP
1705 .B lang: string (default current locale)
1706 language code for translated_name and translated_description attributes
1707 .UNINDENT
1708 .IP \(bu 2
1709 .INDENT 2.0
1710 .TP
1711 .B interactive: boolean, default false
1712 Set to \(dqtrue\(dq, when the operation is done by a user, thus user interaction like password prompts can be done.
1713 .UNINDENT
1714 .UNINDENT
1715 .UNINDENT
1716 .UNINDENT
1717 .sp
1718 Unknown options are ignored.
1719 .UNINDENT
1720 .UNINDENT
1721 .SS org.rpm.dnf.v0.Advisory interface
1722 .INDENT 0.0
1723 .TP
1724 .B interface org.rpm.dnf.v0.Advisory
1725 .INDENT 7.0
1726 .TP
1727 .B method list(a{sv} options) -> (aa{sv} advisories)
1728 .INDENT 7.0
1729 .TP
1730 .B Arguments
1731 .INDENT 7.0
1732 .IP \(bu 2
1733 \fBoptions\fP (\fIa{sv}\fP) \-\- an array of key/value pairs
1734 .UNINDENT
1735 .TP
1736 .B Returns
1737 .INDENT 7.0
1738 .IP \(bu 2
1739 \fBadvisories\fP (\fIaa{sv}\fP) \-\- array of returned advisories with requested attributes
1740 .UNINDENT
1741 .UNINDENT
1742 .sp
1743 Get list of security advisories that match to given filters.
1744 .sp
1745 Following options and filters are supported:
1746 .INDENT 7.0
1747 .INDENT 3.5
1748 .INDENT 0.0
1749 .IP \(bu 2
1750 .INDENT 2.0
1751 .TP
1752 .B advisory_attrs: list of strings
1753 List of advisory attributes that are returned in \fIadvisories\fP array. Supported attributes are \(dqadvisoryid\(dq, \(dqname\(dq, \(dqtitle\(dq, \(dqtype\(dq, \(dqseverity\(dq, \(dqstatus\(dq, \(dqvendor\(dq, \(dqdescription\(dq, \(dqbuildtime\(dq, \(dqmessage\(dq, \(dqrights\(dq, \(dqcollections\(dq, and \(dqreferences\(dq.
1754 .UNINDENT
1755 .IP \(bu 2
1756 .INDENT 2.0
1757 .TP
1758 .B availability: string, default \(dqavailable\(dq
1759 Limit returned advisories based on their relation to installed packages. Accepted values are
1760 .INDENT 7.0
1761 .IP \(bu 2
1762 \(dqavailable\(dq to return only advisories containing newer versions of installed packages
1763 .IP \(bu 2
1764 \(dqall\(dq \- to return all advisories
1765 .IP \(bu 2
1766 \(dqinstalled\(dq \- to return only advisories containing equal or older versions of installed packages
1767 .IP \(bu 2
1768 \(dqupdates\(dq \- to return only advisories containing newer versions of installed packages for which an update is available
1769 .UNINDENT
1770 .UNINDENT
1771 .IP \(bu 2
1772 .INDENT 2.0
1773 .TP
1774 .B names: list of strings
1775 Consider only advisories with one of the given advisory identifiers. Values must be exact advisory IDs (e.g., \(dqFEDORA\-2025\-beb4c9a336\(dq or \(dqRHSA\-2024:1234\(dq). Globs/wildcards and package names are not accepted in this option.
1776 .UNINDENT
1777 .IP \(bu 2
1778 .INDENT 2.0
1779 .TP
1780 .B types: list of strings
1781 Consider only advisories of given types. Possible types are \(dqsecurity\(dq, \(dqbugfix\(dq, \(dqenhancement\(dq, and \(dqnewpackage\(dq.
1782 .UNINDENT
1783 .IP \(bu 2
1784 .INDENT 2.0
1785 .TP
1786 .B contains_pkgs: list of strings
1787 Consider only advisories containing packages with names matching one of given glob patterns. Matching is performed against package base names (for example \(dqkernel\(dq, \(dqbash\(dq, \(dqbuildah\(dq). NEVRA strings or name.arch forms are not supported.
1788 .UNINDENT
1789 .IP \(bu 2
1790 .INDENT 2.0
1791 .TP
1792 .B severities: list of strings
1793 Consider only advisories of given severity. Possible values are \(dqcritical\(dq, \(dqimportant\(dq, \(dqmoderate\(dq, \(dqlow\(dq, and \(dqnone\(dq.
1794 .UNINDENT
1795 .IP \(bu 2
1796 .INDENT 2.0
1797 .TP
1798 .B reference_bzs: list of strings
1799 Consider only advisories referencing given Bugzilla ticket ID. Expected values are numeric IDs, e.g. 123456.
1800 .UNINDENT
1801 .IP \(bu 2
1802 .INDENT 2.0
1803 .TP
1804 .B reference_cves: list of strings
1805 Consider only advisories referencing given CVE ID. Expected values are strings IDs in CVE format, e.g. CVE\-2201\-0123.
1806 .UNINDENT
1807 .IP \(bu 2
1808 .INDENT 2.0
1809 .TP
1810 .B with_bz: boolean, default False
1811 Consider only advisories referencing a Bugzilla ticket.
1812 .UNINDENT
1813 .IP \(bu 2
1814 .INDENT 2.0
1815 .TP
1816 .B with_cve: boolean, default False
1817 Consider only advisories referencing a CVE ticket.
1818 .UNINDENT
1819 .IP \(bu 2
1820 .INDENT 2.0
1821 .TP
1822 .B interactive: boolean, default false
1823 Set to \(dqtrue\(dq, when the operation is done by a user, thus user interaction like password prompts can be done.
1824 .UNINDENT
1825 .UNINDENT
1826 .UNINDENT
1827 .UNINDENT
1828 .sp
1829 Unknown options are ignored.
1830 .UNINDENT
1831 .UNINDENT
1832 .SS org.rpm.dnf.v0.History interface
1833 .INDENT 0.0
1834 .TP
1835 .B interface org.rpm.dnf.v0.History
1836 .INDENT 7.0
1837 .TP
1838 .B method recent_changes(a{sv} options) -> (a{saa{sv}} changeset)
1839 .INDENT 7.0
1840 .TP
1841 .B Arguments
1842 .INDENT 7.0
1843 .IP \(bu 2
1844 \fBoptions\fP (\fIa{sv}\fP) \-\- an array of key/value pairs
1845 .UNINDENT
1846 .TP
1847 .B Returns
1848 .INDENT 7.0
1849 .IP \(bu 2
1850 \fBchangeset\fP (\fIa{saa{sv}}\fP) \-\- a dictionary {\(dq<type_of_change>\(dq:[<package>,<package>,...]}
1851 .UNINDENT
1852 .UNINDENT
1853 .sp
1854 Get a list of packages that have been recently changed. The
1855 \(dqtype_of_change\(dq key in the output dictionary can be one of the
1856 following: \(dqinstalled\(dq, \(dqremoved\(dq, \(dqupgraded\(dq, or \(dqdowngraded\(dq. The
1857 packages in the output are represented as dictionaries containing the
1858 requested set of attributes for the changed packages.
1859 .sp
1860 For installed, upgraded, and downgraded packages, the currently
1861 installed version is returned.
1862 .sp
1863 For upgraded and downgraded packages, the \(dqoriginal_evr\(dq attribute
1864 is also included, containing the package EVR before the change.
1865 .sp
1866 If requested, upgraded packages may also include an \(dqadvisories\(dq list
1867 field, indicating the name of the updates that contain the upgraded
1868 (i.e., currently installed) version of the package. If the \(dqall_advisories\(dq
1869 option is set, advisories for all versions between the original and currently
1870 installed versions are also included.
1871 .sp
1872 For removed packages, only the name, arch, and evr of the removed
1873 version are provided.
1874 .sp
1875 Following options and filters are supported:
1876 .INDENT 7.0
1877 .INDENT 3.5
1878 .INDENT 0.0
1879 .IP \(bu 2
1880 .INDENT 2.0
1881 .TP
1882 .B upgraded_packages: boolean, default \(dqtrue\(dq
1883 Whether to include upgraded packages in the output.
1884 .UNINDENT
1885 .IP \(bu 2
1886 .INDENT 2.0
1887 .TP
1888 .B downgraded_packages: boolean, default \(dqtrue\(dq
1889 Whether to include downgraded packages in the output.
1890 .UNINDENT
1891 .IP \(bu 2
1892 .INDENT 2.0
1893 .TP
1894 .B installed_packages: boolean, default \(dqtrue\(dq
1895 Whether to include installed packages in the output.
1896 .UNINDENT
1897 .IP \(bu 2
1898 .INDENT 2.0
1899 .TP
1900 .B removed_packages: boolean, default \(dqtrue\(dq
1901 Whether to include removed packages in the output.
1902 .UNINDENT
1903 .IP \(bu 2
1904 .INDENT 2.0
1905 .TP
1906 .B include_advisory: boolean, default \(dqtrue\(dq
1907 Whether to include \(dqadvisories\(dq to upgraded packages attributes.
1908 .UNINDENT
1909 .IP \(bu 2
1910 .INDENT 2.0
1911 .TP
1912 .B all_advisories: boolean, default \(dqfalse\(dq
1913 Only make sense with include_advisory=true. Include also advisories
1914 for all versions between the original and currently installed.
1915 .UNINDENT
1916 .IP \(bu 2
1917 .INDENT 2.0
1918 .TP
1919 .B package_attrs: list of strings, default [\(dqname\(dq, \(dqsummary\(dq, \(dqevr\(dq, \(dqarch\(dq]
1920 List of package attributes that are returned for each changed
1921 package. Supported attributes are the same as in list() method of
1922 the Rpm interface.
1923 .UNINDENT
1924 .IP \(bu 2
1925 .INDENT 2.0
1926 .TP
1927 .B since: int64, unix timestamp
1928 Get changes since a given point in time.
1929 .UNINDENT
1930 .IP \(bu 2
1931 .INDENT 2.0
1932 .TP
1933 .B interactive: boolean, default false
1934 Set to \(dqtrue\(dq, when the operation is done by a user, thus user interaction like password prompts can be done.
1935 .UNINDENT
1936 .UNINDENT
1937 .UNINDENT
1938 .UNINDENT
1939 .sp
1940 Unknown options are ignored.
1941 .UNINDENT
1942 .UNINDENT
1943 .SH Author
1944 See AUTHORS.md in dnf5 source distribution.
1945 .SH Copyright
1946 Contributors to the dnf5 project.
1947 .\" End of generated man page.