salt.modules.opkg
Support for Opkg
Important
If you feel that Salt should be using this module to manage packages on a minion, and it is using a different module (or gives an error similar to 'pkg.install' is not available), see here.
New in version 2016.3.0.
Note
For version comparison support on opkg < 0.3.4, the opkg-utils
package must be installed.
-
Return the latest version of the named package available for upgrade or installation. If more than one package name is specified, a dict of name/version pairs is returned.
If the latest version of a given package is already installed, an empty string will be returned for that package.
CLI Example:
salt '*' pkg.latest_version <package name> salt '*' pkg.latest_version <package name> salt '*' pkg.latest_version <package1> <package2> <package3> ...
salt.modules.opkg.available_version(*names, **kwargs)
-
Check if the installed package already has the given requirements. There's nothing do to here for nipkg.py, therefore it will always return True.
salt.modules.opkg.check_extra_requirements(pkgname, pkgver)
-
Delete a repo from
/etc/opkg/*.conf
If the file does not contain any other repo configuration, the file itself will be deleted.
CLI Examples:
salt '*' pkg.del_repo repo
salt.modules.opkg.del_repo(repo, **kwargs)
-
List the files that belong to a package, grouped by package. Not specifying any packages will return a list of _every_ file on the system's package database (not generally recommended).
CLI Examples:
salt '*' pkg.file_list httpd salt '*' pkg.file_list httpd postfix salt '*' pkg.file_list
salt.modules.opkg.file_dict(*packages, **kwargs)
-
List the files that belong to a package. Not specifying any packages will return a list of _every_ file on the system's package database (not generally recommended).
CLI Examples:
salt '*' pkg.file_list httpd salt '*' pkg.file_list httpd postfix salt '*' pkg.file_list
salt.modules.opkg.file_list(*packages, **kwargs)
-
Display a repo from the
/etc/opkg/*.conf
CLI Examples:
salt '*' pkg.get_repo repo
salt.modules.opkg.get_repo(repo, **kwargs)
-
Set package in 'hold' state, meaning it will not be upgraded.
- name
-
The name of the package, e.g., 'tmux'
CLI Example:
salt '*' pkg.hold <package name>
- pkgs
-
A list of packages to hold. Must be passed as a python list.
CLI Example:
salt '*' pkg.hold pkgs='["foo", "bar"]'
salt.modules.opkg.hold(name=None, pkgs=None, sources=None, **kwargs)
-
Return the information of the named package(s), installed on the system.
New in version 2017.7.0.
- Parameters
-
names -- Names of the packages to get information about. If none are specified, will return information for all installed packages.
-
attr --
Comma-separated package attributes. If no 'attr' is specified, all available attributes returned.
- Valid attributes are:
-
arch, conffiles, conflicts, depends, description, filename, group, install_date_time_t, md5sum, packager, provides, recommends, replaces, size, source, suggests, url, version
CLI Example:
salt '*' pkg.info_installed salt '*' pkg.info_installed attr=version,packager salt '*' pkg.info_installed <package1> salt '*' pkg.info_installed <package1> <package2> <package3> ... salt '*' pkg.info_installed <package1> attr=version,packager salt '*' pkg.info_installed <package1> <package2> <package3> ... attr=version,packager
salt.modules.opkg.info_installed(*names, **kwargs)
-
Install the passed package, add refresh=True to update the opkg database.
- name
-
The name of the package to be installed. Note that this parameter is ignored if either "pkgs" or "sources" is passed. Additionally, please note that this option can only be used to install packages from a software repository. To install a package file manually, use the "sources" option.
CLI Example:
salt '*' pkg.install <package name>
- refresh
-
Whether or not to refresh the package database before installing.
- version
-
Install a specific version of the package, e.g. 1.2.3~0ubuntu0. Ignored if "pkgs" or "sources" is passed.
New in version 2017.7.0.
- reinstallFalse
-
Specifying reinstall=True will use
opkg install --force-reinstall
rather than simplyopkg install
for requested packages that are already installed.If a version is specified with the requested package, then
opkg install --force-reinstall
will only be used if the installed version matches the requested version.New in version 2017.7.0.
Multiple Package Installation Options:
- pkgs
-
A list of packages to install from a software repository. Must be passed as a python list.
CLI Example:
salt '*' pkg.install pkgs='["foo", "bar"]' salt '*' pkg.install pkgs='["foo", {"bar": "1.2.3-0ubuntu0"}]'
- sources
-
A list of IPK packages to install. Must be passed as a list of dicts, with the keys being package names, and the values being the source URI or local path to the package. Dependencies are automatically resolved and marked as auto-installed.
CLI Example:
salt '*' pkg.install sources='[{"foo": "salt://foo.deb"},{"bar": "salt://bar.deb"}]'
- install_recommends
-
Whether to install the packages marked as recommended. Default is True.
- only_upgrade
-
Only upgrade the packages (disallow downgrades), if they are already installed. Default is False.
New in version 2017.7.0.
Returns a dict containing the new package names and versions:
{'<package>': {'old': '<old-version>', 'new': '<new-version>'}}
salt.modules.opkg.install(name=None, refresh=False, pkgs=None, sources=None, reinstall=False, **kwargs)
-
Return the latest version of the named package available for upgrade or installation. If more than one package name is specified, a dict of name/version pairs is returned.
If the latest version of a given package is already installed, an empty string will be returned for that package.
CLI Example:
salt '*' pkg.latest_version <package name> salt '*' pkg.latest_version <package name> salt '*' pkg.latest_version <package1> <package2> <package3> ...
salt.modules.opkg.latest_version(*names, **kwargs)
-
List the packages currently installed in a dict:
{'<package_name>': '<version>'}
CLI Example:
salt '*' pkg.list_pkgs salt '*' pkg.list_pkgs versions_as_list=True
salt.modules.opkg.list_pkgs(versions_as_list=False, **kwargs)
-
Lists all repos on
/etc/opkg/*.conf
CLI Example:
salt '*' pkg.list_repos
salt.modules.opkg.list_repos(**kwargs)
-
List all available package upgrades.
CLI Example:
salt '*' pkg.list_upgrades
salt.modules.opkg.list_upgrades(refresh=True, **kwargs)
-
Modify one or more values for a repo. If the repo does not exist, it will be created, so long as uri is defined.
The following options are available to modify a repo definition:
- repo
-
alias by which opkg refers to the repo.
- uri
-
the URI to the repo.
- compressed
-
defines (True or False) if the index file is compressed
- enabled
-
enable or disable (True or False) repository but do not remove if disabled.
- refresh
-
enable or disable (True or False) auto-refresh of the repositories
CLI Examples:
salt '*' pkg.mod_repo repo uri=http://new/uri salt '*' pkg.mod_repo repo enabled=False
salt.modules.opkg.mod_repo(repo, **kwargs)
-
Return the name of the package that owns the file. Multiple file paths can be passed. Like
pkg.version <salt.modules.opkg.version
, if a single path is passed, a string will be returned, and if multiple paths are passed, a dictionary of file/package name pairs will be returned.If the file is not owned by a package, or is not present on the minion, then an empty string will be returned for that path.
CLI Example:
salt '*' pkg.owner /usr/bin/apachectl salt '*' pkg.owner /usr/bin/apachectl /usr/bin/basename
salt.modules.opkg.owner(*paths, **kwargs)
-
Package purges are not supported by opkg, this function is identical to
pkg.remove
.- name
-
The name of the package to be deleted.
Multiple Package Options:
- pkgs
-
A list of packages to delete. Must be passed as a python list. The
name
parameter will be ignored if this option is passed.
Returns a dict containing the changes.
CLI Example:
salt '*' pkg.purge <package name> salt '*' pkg.purge <package1>,<package2>,<package3> salt '*' pkg.purge pkgs='["foo", "bar"]'
salt.modules.opkg.purge(name=None, pkgs=None, **kwargs)
-
Updates the opkg database to latest packages based upon repositories
Returns a dict, with the keys being package databases and the values being the result of the update attempt. Values can be one of the following:
True
: Database updated successfullyFalse
: Problem updating database
- failhard
-
If False, return results of failed lines as
False
for the package database that encountered the error. If True, raise an error with a list of the package databases that encountered errors.New in version 2018.3.0.
CLI Example:
salt '*' pkg.refresh_db
salt.modules.opkg.refresh_db(failhard=False, **kwargs)
-
Remove packages using
opkg remove
.- name
-
The name of the package to be deleted.
Multiple Package Options:
- pkgs
-
A list of packages to delete. Must be passed as a python list. The
name
parameter will be ignored if this option is passed. - remove_dependencies
-
Remove package and all dependencies
New in version 2019.2.0.
- auto_remove_deps
-
Remove packages that were installed automatically to satisfy dependencies
New in version 2019.2.0.
Returns a dict containing the changes.
CLI Example:
salt '*' pkg.remove <package name> salt '*' pkg.remove <package1>,<package2>,<package3> salt '*' pkg.remove pkgs='["foo", "bar"]' salt '*' pkg.remove pkgs='["foo", "bar"]' remove_dependencies=True auto_remove_deps=True
salt.modules.opkg.remove(name=None, pkgs=None, **kwargs)
-
Set package current in 'hold' state to install state, meaning it will be upgraded.
- name
-
The name of the package, e.g., 'tmux'
CLI Example:
salt '*' pkg.unhold <package name>
- pkgs
-
A list of packages to hold. Must be passed as a python list.
CLI Example:
salt '*' pkg.unhold pkgs='["foo", "bar"]'
salt.modules.opkg.unhold(name=None, pkgs=None, sources=None, **kwargs)
-
Upgrades all packages via
opkg upgrade
Returns a dictionary containing the changes:
{'<package>': {'old': '<old-version>', 'new': '<new-version>'}}
CLI Example:
salt '*' pkg.upgrade
salt.modules.opkg.upgrade(refresh=True, **kwargs)
-
Check whether or not an upgrade is available for a given package
CLI Example:
salt '*' pkg.upgrade_available <package name>
salt.modules.opkg.upgrade_available(name, **kwargs)
-
Returns a string representing the package version or an empty string if not installed. If more than one package name is specified, a dict of name/version pairs is returned.
CLI Example:
salt '*' pkg.version <package name> salt '*' pkg.version <package1> <package2> <package3> ...
salt.modules.opkg.version(*names, **kwargs)
-
Clean the version string removing extra data. There's nothing do to here for nipkg.py, therefore it will always return the given version.
salt.modules.opkg.version_clean(version)
-
Do a cmp-style comparison on two packages. Return -1 if pkg1 < pkg2, 0 if pkg1 == pkg2, and 1 if pkg1 > pkg2. Return None if there was a problem making the comparison.
- ignore_epochFalse
-
Set to
True
to ignore the epoch when comparing versionsNew in version 2016.3.4.
CLI Example:
salt '*' pkg.version_cmp '0.2.4-0' '0.2.4.1-0'
salt.modules.opkg.version_cmp(pkg1, pkg2, ignore_epoch=False, **kwargs)
© 2021 SaltStack.
Licensed under the Apache License, Version 2.0.
https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.opkg.html