dnf5daemon-dbus-api - Man Page

DBus API Reference for Dnf5daemon

Synopsis

Dbus methods and arguments. Generated from dbus XMLs.

Description

Interfaces

org.rpm.dnf.v0.Goal interface

interface org.rpm.dnf.v0.Goal
method resolve(a{sv} options) -> (a(ua{sv}) transaction, u result)
Arguments
  • options (a{sv}) -- an array of key/value pairs to modify dependency resolving
Returns
  • transaction (a(ua{sv})) -- array of (action, {package}) tuples where action is one of libdnf::transaction::TransactionItemAction enum and package is a map {atttibute: value}. These package attributes are returned: "name", "epoch", "version", "release", "arch", "repo", "package_size", "install_size", "evr".
  • result (u) -- problems detected during transaction resolving. Possible values are 0 - no problem, 1 - no problem, but some info / warnings are present or 2 - resolving failed.

Resolve the transaction.

Following @options are supported:
  • allow_erasing: boolean, default false

    Whether removal of installed package is allowed to resolve the transaction.

Unknown options are ignored.

method get_transaction_problems_string() -> (as problems)
Returns
  • problems (as) -- array of strings containing all problems found during the transaction resolution.

Return all problems found during the transaction resolution as human readable messages.

method get_transaction_problems() -> (a{sv} problems)
Returns
  • problems (a{sv}) -- array of {key: value} maps

Return all problems found during the transaction resolution as structures. This is the list of problem keys: always present: action - see include/libdnf/base/goal_elements.hpp: GoalAction problem - see include/libdnf/base/goal_elements.hpp: GoalProblem optional: goal_job_settings - {string: variant}, settings used to resolve the goal spec - string, usually nevra of affected package additional_data - array of strings, more details on the problem solver_problems - problems reported by underlying libsolv

method do_transaction(a{sv} options) -> ()
Arguments
  • options (a{sv}) -- an array of key/value pairs to modify transaction running

Perform the resolved transaction.

Following @options are supported:
  • comment: string

    Adds a comment to a transaction.

Unknown options are ignored.

org.rpm.dnf.v0.SessionManager interface

interface org.rpm.dnf.v0.SessionManager
method open_session(a{sv} options) -> (o path)
Arguments
  • options (a{sv}) --
Returns
  • path (o) -- object path to created Session object

Opens a new session.

Following configuration options are supported:

  • load_system_repo: bool, default true

    If true information about currently installed packages is loaded.

  • load_available_repos: bool, default true

    If true information about packages available in enabled repositories is loaded.

  • config: map {string: string}

    Override configuration options.

  • releasever: string

    Override releasever variable used for substitutions in repository configurations.

  • locale: string

    Override server locale for this session. Affects language used in various error messages.

Unknown options are ignored.

method close_session(o path) -> (b result)
Arguments
  • path (o) -- object path of session to close
Returns
  • result (b) -- bool whether the requested session was successfully closed

Close session on given object path.

org.rpm.dnf.v0.rpm.Repo interface

interface org.rpm.dnf.v0.rpm.Repo
method list(a{sv} options) -> (aa{sv} data)
Arguments
  • options (a{sv}) -- an array of key/value pairs
Returns
  • data (aa{sv}) -- array of returned repositories with requested attributes

Get list of repositories that match to given filters.

Following options are supported:

  • patterns: list of strings

    any repository with id matching to any of patterns is returned

  • repo_attrs: list of strings

    list of repository attributes that are returned

  • enable_disable: string (default "enabled")

    When set to "enabled" or "disabled", only enabled / disabled repositories are listed. Any other value means all repositories are returned.

Unknown options are ignored.

method confirm_key(s key_id, b confirmed) -> ()
Arguments
  • key_id (s) -- id of the key in question
  • confirmed (b) -- whether the key import is confirmed by user

Get list of repositories that match to given filters.

signal repo_load_start(o session_object_path, s repository_name)
Arguments
  • session_object_path (o) -- object path of the dnf5daemon session
  • repository_name (s) -- the name of repository

Repository metadata loading has started.

signal repo_load_progress(o session_object_path, t downloaded, t total)
Arguments
  • session_object_path (o) -- object path of the dnf5daemon session
  • downloaded (t) -- bytes already downloaded
  • total (t) -- total bytes to download

Progress in repository metadata downloading.

signal repo_load_end(o session_object_path)
Arguments
  • session_object_path (o) -- object path of the dnf5daemon session

Repository metadata loading has ended.

signal repo_key_import_request(o session_object_path, s key_id, s user_id, s key_fingerprint, s key_url, x timestamp)
Arguments
  • session_object_path (o) -- object path of the dnf5daemon session
  • key_id (s) -- GPG key id
  • user_id (s) -- User id
  • key_fingerprint (s) -- Fingerprint of the GPG key
  • key_url (s) -- URL of the GPG key
  • timestamp (x) -- timestamp when the key was created

Request for repository key import confirmation.

org.rpm.dnf.v0.rpm.Rpm interface

interface org.rpm.dnf.v0.rpm.Rpm
method list(a{sv} options) -> (aa{sv} data)
Arguments
  • options (a{sv}) -- an array of key/value pairs
Returns
  • data (aa{sv}) -- array of returned packages with requested attributes

Get list of packages that match to given filters.

Following options and filters are supported:

  • package_attrs: list of strings

    list of package attributes that are returned

  • with_nevra: bool (default true)

    match patterns against available packages NEVRAs

  • with_provides: bool (default true)

    match patterns against available packages provides

  • with_filenames: bool (default true)

    match patterns against names of the files in available packages

  • with_src: bool (default true)

    include source rpms into the results

  • icase: bool (default true)

    ignore case while matching patterns

  • patterns: list of strings

    any package matching to any of patterns is returned

  • scope: string (default "all")

    limit packages to one of "all", "installed", "available", "upgrades", "upradable"

  • arch: list of strings

    limit the resulting set only to packages of given architectures

  • repo: list of strings

    limit the resulting set only to packages from given repositories

  • latest-limit: int

    limit the resulting set to only <limit> of latest packages for every name and architecture

  • whatprovides: list of strings

    limit the resulting set only to packages that provide any of given capabilities

  • whatdepends: list of strings

    limit the resulting set only to packages that require, enhance, recommend, suggest or supplement any of given capabilities

  • whatrequires: list of strings

    limit the resulting set only to packages that require any of given capabilities

  • whatrecommends: list of strings

    limit the resulting set only to packages that recommend any of given capabilities

  • whatenhances: list of strings

    limit the resulting set only to packages that enhance any of given capabilities

  • whatsuggests: list of strings

    limit the resulting set only to packages that suggest any of given capabilities

  • whatsupplements: list of strings

    limit the resulting set only to packages that supplement any of given capabilities

  • whatobsoletes: list of strings

    limit the resulting set only to packages that obsolete any of given capabilities

  • whatconflicts: list of strings

    limit the resulting set only to packages that conflict with any of given capabilities

Unknown options are ignored.

method install(as specs, a{sv} options) -> ()
Arguments
  • specs (as) -- an array of package specifications to be installed on the system
  • options (a{sv}) -- an array of key/value pairs to modify install behavior

Mark packages specified by @specs for installation.

Following @options are supported:

  • repo_ids: list of strings

    Identifiers of the repos from which the packages could be installed.

  • strict: boolean, default true

    Indicates whether existing but non-installable packages should be skipped (false) or cause transaction resolving fail (true).

Unknown options are ignored.

method upgrade(as specs, a{sv} options) -> ()
Arguments
  • specs (as) -- an array of package specifications to be upgraded on the system
  • options (a{sv}) -- an array of key/value pairs to modify upgrade behavior

Mark packages specified by @specs for upgrade.

Following @options are supported:

  • repo_ids: list of strings

    Identifiers of the repos from which the packages could be upgraded.

Unknown options are ignored.

method remove(as specs, a{sv} options) -> ()
Arguments
  • specs (as) -- an array of package specifications to be removed on the system
  • options (a{sv}) -- an array of key/value pairs to modify remove behavior

Mark packages specified by @specs for removal.

Unknown options are ignored.

method distro_sync(as specs, a{sv} options) -> ()
Arguments
  • specs (as) -- array of package specifications to synchronize to the latest available versions
  • options (a{sv}) -- an array of key/value pairs to modify distro_sync behavior

Following @options are supported:

Unknown options are ignored.

method downgrade(as specs, a{sv} options) -> ()
Arguments
  • specs (as) -- an array of package specifications to be downgraded on the system
  • options (a{sv}) -- an array of key/value pairs to modify downgrade behavior

Mark packages specified by @specs for downgrade.

Following @options are supported:

Unknown options are ignored.

method reinstall(as specs, a{sv} options) -> ()
Arguments
  • specs (as) -- an array of package specifications to be reinstalled on the system
  • options (a{sv}) -- an array of key/value pairs to modify reinstall behavior

Mark packages specified by @specs for reinstall.

Following @options are supported:

Unknown options are ignored.

signal transaction_action_start(s nevra, u action, t total)
Arguments
  • nevra (s) -- full NEVRA of the package
  • action (u) -- one of the dnfdaemon::RpmTransactionItem::Actions enum
  • total (t) -- total to process

Processing of the item has started.

signal transaction_action_progress(s nevra, t amount, t total)
Arguments
  • nevra (s) -- full NEVRA of the package
  • amount (t) -- amount already processed
  • total (t) -- total to process

Progress in processing of the package.

signal transaction_action_stop(s nevra, t total)
Arguments
  • nevra (s) -- full NEVRA of the package
  • total (t) -- total processed

Processing of the item has finished.

signal transaction_script_start(s nevra)
Arguments
  • nevra (s) -- full NEVRA of the package script belongs to

The scriptlet has started.

signal transaction_script_stop(s nevra, t return_code)
Arguments
  • nevra (s) -- full NEVRA of the package script belongs to
  • return_code (t) -- return value of the script

The scriptlet has successfully finished.

signal transaction_script_error(s nevra, t return_code)
Arguments
  • nevra (s) -- full NEVRA of the package script belongs to
  • return_code (t) -- return value of the script

The scriptlet has finished with an error.

signal transaction_verify_start(t total)
Arguments
  • total (t) -- total to process

Package files verification has started.

signal transaction_verify_progress(t amount, t total)
Arguments
  • amount (t) -- amount already processed
  • total (t) -- total to process

Progress in processing of the package.

signal transaction_verify_stop(t total)
Arguments
  • total (t) --

Package files verification has finished.

signal transaction_unpack_error(s nevra)
Arguments
  • nevra (s) -- full NEVRA of the package

Error while unpacking the package.

Author

See AUTHORS.md in dnf5 source distribution.

Info

Nov 02, 2022 dnf5