1DNF5DAEMON-DBUS-API(8) dnf5 DNF5DAEMON-DBUS-API(8)
2
6 dnf5daemon-dbus-api - DBus API Reference for Dnf5daemon
7
9 Dbus methods and arguments. Generated from dbus XMLs.
10
13 org.rpm.dnf.v0.Goal interface
14 interface org.rpm.dnf.v0.Goal
15 method resolve(a{sv} options) -> (a(sssa{sv}a{sv}) transac‐
17 tion_items, u result)
18 Arguments
20 • options (a{sv}) -- an array of key/value pairs
22 to modify dependency resolving
23 Returns
25 • transaction_items (a(sssa{sv}a{sv})) -- array of
27 (object_type, action, reason, {transac‐
28 tion_item_attributes}, {object}) tuples. ob‐
29 ject_type is one of libdnf5::transaction::Trans‐
30 actionItemType, action is one of libdnf5::trans‐
31 action::TransactionItemAction, reason is one of
32 libdnf5::transaction::TransactionItemReason
33 enums. Each of these enums are represented as
34 strings using corresponding libdnf5::transac‐
35 tion::
36 *
37 _to_string() methods. transaction_item_at‐
38 tributes is a map {attribute: value}. Currently
39 "reason_change_group_id" attribute is used for
40 target group id in case the action is Reason‐
41 Change and the reason Group, and "replaces" con‐
42 taining a vector of packages ids being replaced
43 by this item. Finally the object is a map {at‐
44 tribute: value} and represents (according to ob‐
45 ject_type) package, group, environment, or mod‐
46 ule. These package attributes are returned:
47 "name", "epoch", "version", "release", "arch",
48 "repo_id", "from_repo_id", "package_size", "in‐
49 stall_size", "evr", and "reason". For groups the
50 object contains "groupid" and "name" attributes.
51 • result (u) -- problems detected during transac‐
53 tion resolving. Possible values are 0 - no prob‐
54 lem, 1 - no problem, but some info / warnings
55 are present or 2 - resolving failed.
56 Resolve the transaction.
58 Following @options are supported:
60 •
62 allow_erasing: boolean, default false
64 Whether removal of installed package is
65 allowed to resolve the transaction.
66 Unknown options are ignored.
68 method get_transaction_problems_string() -> (as problems)
70 Returns
72 • problems (as) -- array of strings containing all
74 problems found during the transaction resolu‐
75 tion.
76 Return all problems found during the transaction resolu‐
78 tion as human readable messages.
79 method get_transaction_problems() -> (a{sv} problems)
81 Returns
83 • problems (a{sv}) -- array of {key: value} maps
85 Return all problems found during the transaction resolu‐
87 tion as structures. This is the list of problem keys: al‐
88 ways present: action - see include/libdnf5/base/goal_ele‐
89 ments.hpp: GoalAction problem - see in‐
90 clude/libdnf5/base/goal_elements.hpp: GoalProblem op‐
91 tional: goal_job_settings - {string: variant}, settings
92 used to resolve the goal spec - string, usually nevra of
93 affected package additional_data - array of strings, more
94 details on the problem solver_problems - problems re‐
95 ported by underlying libsolv
96 method do_transaction(a{sv} options) -> ()
98 Arguments
100 • options (a{sv}) -- an array of key/value pairs
102 to modify transaction running
103 Perform the resolved transaction.
105 Following @options are supported:
107 •
109 comment: string
111 Adds a comment to a transaction.
112 Unknown options are ignored.
114 org.rpm.dnf.v0.SessionManager interface
116 interface org.rpm.dnf.v0.SessionManager
117 method open_session(a{sv} options) -> (o path)
119 Arguments
121 • options (a{sv}) --
123 Returns
125 • path (o) -- object path to created Session ob‐
127 ject
128 Opens a new session.
130 Following configuration options are supported:
132 •
134 load_system_repo: bool, default true
136 If true information about currently installed
137 packages is loaded.
138 •
140 load_available_repos: bool, default true
142 If true information about packages available
143 in enabled repositories is loaded.
144 •
146 config: map {string: string}
148 Override configuration options.
149 •
151 releasever: string
153 Override releasever variable used for substi‐
154 tutions in repository configurations.
155 •
157 locale: string
159 Override server locale for this session. Af‐
160 fects language used in various error mes‐
161 sages.
162 Unknown options are ignored.
164 method close_session(o path) -> (b result)
166 Arguments
168 • path (o) -- object path of session to close
170 Returns
172 • result (b) -- bool whether the requested session
174 was successfully closed
175 Close session on given object path.
177 org.rpm.dnf.v0.rpm.Repo interface
179 interface org.rpm.dnf.v0.rpm.Repo
180 method list(a{sv} options) -> (aa{sv} data)
182 Arguments
184 • options (a{sv}) -- an array of key/value pairs
186 Returns
188 • data (aa{sv}) -- array of returned repositories
190 with requested attributes
191 Get list of repositories that match to given filters.
193 Following options are supported:
195 •
197 patterns: list of strings
199 any repository with id matching to any of
200 patterns is returned
201 •
203 repo_attrs: list of strings
205 list of repository attributes that are re‐
206 turned
207 •
209 enable_disable: string (default "enabled")
211 When set to "enabled" or "disabled", only en‐
212 abled / disabled repositories are listed. Any
213 other value means all repositories are re‐
214 turned.
215 Unknown options are ignored.
217 method confirm_key(s key_id, b confirmed) -> ()
219 Arguments
221 • key_id (s) -- id of the key in question
223 • confirmed (b) -- whether the key import is con‐
225 firmed by user
226 Get list of repositories that match to given filters.
228 org.rpm.dnf.v0.rpm.Rpm interface
230 interface org.rpm.dnf.v0.rpm.Rpm
231 method list(a{sv} options) -> (aa{sv} data)
233 Arguments
235 • options (a{sv}) -- an array of key/value pairs
237 Returns
239 • data (aa{sv}) -- array of returned packages with
241 requested attributes
242 Get list of packages that match to given filters.
244 Following options and filters are supported:
246 •
248 package_attrs: list of strings
250 list of package attributes that are returned
251 •
253 with_nevra: bool (default true)
255 match patterns against available packages
256 NEVRAs
257 •
259 with_provides: bool (default true)
261 match patterns against available packages
262 provides
263 •
265 with_filenames: bool (default true)
267 match patterns against names of the files in
268 available packages
269 •
271 with_binaries: bool (default true)
273 match patterns against names of the binaries
274 in /usr/(s)bin in available packages
275 •
277 with_src: bool (default true)
279 include source rpms into the results
280 •
282 icase: bool (default true)
284 ignore case while matching patterns
285 •
287 patterns: list of strings
289 any package matching to any of patterns is
290 returned
291 •
293 scope: string (default "all")
295 limit packages to one of "all", "installed",
296 "available", "upgrades", "upradable"
297 •
299 arch: list of strings
301 limit the resulting set only to packages of
302 given architectures
303 •
305 repo: list of strings
307 limit the resulting set only to packages from
308 given repositories
309 •
311 latest-limit: int
313 limit the resulting set to only <limit> of
314 latest packages for every name and architec‐
315 ture
316 •
318 whatprovides: list of strings
320 limit the resulting set only to packages that
321 provide any of given capabilities
322 •
324 whatdepends: list of strings
326 limit the resulting set only to packages that
327 require, enhance, recommend, suggest or sup‐
328 plement any of given capabilities
329 •
331 whatrequires: list of strings
333 limit the resulting set only to packages that
334 require any of given capabilities
335 •
337 whatrecommends: list of strings
339 limit the resulting set only to packages that
340 recommend any of given capabilities
341 •
343 whatenhances: list of strings
345 limit the resulting set only to packages that
346 enhance any of given capabilities
347 •
349 whatsuggests: list of strings
351 limit the resulting set only to packages that
352 suggest any of given capabilities
353 •
355 whatsupplements: list of strings
357 limit the resulting set only to packages that
358 supplement any of given capabilities
359 •
361 whatobsoletes: list of strings
363 limit the resulting set only to packages that
364 obsolete any of given capabilities
365 •
367 whatconflicts: list of strings
369 limit the resulting set only to packages that
370 conflict with any of given capabilities
371 Unknown options are ignored.
373 method install(as specs, a{sv} options) -> ()
375 Arguments
377 • specs (as) -- an array of package specifications
379 to be installed on the system
380 • options (a{sv}) -- an array of key/value pairs
382 to modify install behavior
383 Mark packages specified by @specs for installation.
385 Following @options are supported:
387 •
389 repo_ids: list of strings
391 Identifiers of the repos from which the pack‐
392 ages could be installed.
393 •
395 skip_broken: boolean, default false
397 Whether solver can skip packages with broken
398 dependencies to resolve transaction
399 •
401 skip_unavailable: boolean, default false
403 Whether nonexisting packages can be skipped.
404 Unknown options are ignored.
406 method upgrade(as specs, a{sv} options) -> ()
408 Arguments
410 • specs (as) -- an array of package specifications
412 to be upgraded on the system
413 • options (a{sv}) -- an array of key/value pairs
415 to modify upgrade behavior
416 Mark packages specified by @specs for upgrade.
418 Following @options are supported:
420 •
422 repo_ids: list of strings
424 Identifiers of the repos from which the pack‐
425 ages could be upgraded.
426 Unknown options are ignored.
428 method remove(as specs, a{sv} options) -> ()
430 Arguments
432 • specs (as) -- an array of package specifications
434 to be removed on the system
435 • options (a{sv}) -- an array of key/value pairs
437 to modify remove behavior
438 Mark packages specified by @specs for removal.
440 Unknown options are ignored.
442 method distro_sync(as specs, a{sv} options) -> ()
444 Arguments
446 • specs (as) -- array of package specifications to
448 synchronize to the latest available versions
449 • options (a{sv}) -- an array of key/value pairs
451 to modify distro_sync behavior
452 Following @options are supported:
454 Unknown options are ignored.
456 method downgrade(as specs, a{sv} options) -> ()
458 Arguments
460 • specs (as) -- an array of package specifications
462 to be downgraded on the system
463 • options (a{sv}) -- an array of key/value pairs
465 to modify downgrade behavior
466 Mark packages specified by @specs for downgrade.
468 Following @options are supported:
470 Unknown options are ignored.
472 method reinstall(as specs, a{sv} options) -> ()
474 Arguments
476 • specs (as) -- an array of package specifications
478 to be reinstalled on the system
479 • options (a{sv}) -- an array of key/value pairs
481 to modify reinstall behavior
482 Mark packages specified by @specs for reinstall.
484 Following @options are supported:
486 Unknown options are ignored.
488 signal transaction_action_start(s nevra, u action, t total)
490 Arguments
492 • nevra (s) -- full NEVRA of the package
494 • action (u) -- one of the dnfdaemon::RpmTransac‐
496 tionItem::Actions enum
497 • total (t) -- total to process
499 Processing of the item has started.
501 signal transaction_action_progress(s nevra, t amount, t total)
503 Arguments
505 • nevra (s) -- full NEVRA of the package
507 • amount (t) -- amount already processed
509 • total (t) -- total to process
511 Progress in processing of the package.
513 signal transaction_action_stop(s nevra, t total)
515 Arguments
517 • nevra (s) -- full NEVRA of the package
519 • total (t) -- total processed
521 Processing of the item has finished.
523 signal transaction_script_start(s nevra)
525 Arguments
527 • nevra (s) -- full NEVRA of the package script
529 belongs to
530 The scriptlet has started.
532 signal transaction_script_stop(s nevra, t return_code)
534 Arguments
536 • nevra (s) -- full NEVRA of the package script
538 belongs to
539 • return_code (t) -- return value of the script
541 The scriptlet has successfully finished.
543 signal transaction_script_error(s nevra, t return_code)
545 Arguments
547 • nevra (s) -- full NEVRA of the package script
549 belongs to
550 • return_code (t) -- return value of the script
552 The scriptlet has finished with an error.
554 signal transaction_verify_start(t total)
556 Arguments
558 • total (t) -- total to process
560 Package files verification has started.
562 signal transaction_verify_progress(t amount, t total)
564 Arguments
566 • amount (t) -- amount already processed
568 • total (t) -- total to process
570 Progress in processing of the package.
572 signal transaction_verify_stop(t total)
574 Arguments
576 • total (t) --
578 Package files verification has finished.
580 signal transaction_unpack_error(s nevra)
582 Arguments
584 • nevra (s) -- full NEVRA of the package
586 Error while unpacking the package.
588
590 See AUTHORS.md in dnf5 source distribution.
591
593 Contributors to the dnf5 project.
594 Nov 24, 2023 DNF5DAEMON-DBUS-API(8)