salt.modules.pkgin¶
Package support for pkgin based systems, inspired from freebsdpkg module
-
salt.modules.pkgin.
available_version
(*names, **kwargs)¶ Return the latest version of the named package available for upgrade or installation.
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 <package1> <package2> ...
-
salt.modules.pkgin.
file_dict
(package)¶ List the files that belong to a package.
CLI Examples:
salt '*' pkg.file_list nginx
-
salt.modules.pkgin.
file_list
(package)¶ List the files that belong to a package.
CLI Examples:
salt '*' pkg.file_list nginx
-
salt.modules.pkgin.
install
(name=None, refresh=False, fromrepo=None, pkgs=None, sources=None, **kwargs)¶ Install the passed package
- name
- The name of the package to be installed.
- refresh
- Whether or not to refresh the package database before installing.
- fromrepo
- Specify a package repository to install from.
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"]'
- sources
A list of 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.
CLI Example:
salt '*' pkg.install sources='[{"foo": "salt://foo.deb"},{"bar": "salt://bar.deb"}]'
Return a dict containing the new package names and versions:
{'<package>': {'old': '<old-version>', 'new': '<new-version>'}}
CLI Example:
salt '*' pkg.install <package name>
-
salt.modules.pkgin.
latest_version
(*names, **kwargs)¶ Return the latest version of the named package available for upgrade or installation.
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 <package1> <package2> ...
-
salt.modules.pkgin.
list_pkgs
(versions_as_list=False, **kwargs)¶ List the packages currently installed as a dict:
{'<package_name>': '<version>'}
CLI Example:
salt '*' pkg.list_pkgs
-
salt.modules.pkgin.
purge
(name=None, pkgs=None, **kwargs)¶ Package purges are not supported, this function is identical to
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.
New in version 0.16.0.
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.pkgin.
refresh_db
()¶ Use pkg update to get latest pkg_summary
CLI Example:
salt '*' pkg.refresh_db
-
salt.modules.pkgin.
rehash
()¶ Recomputes internal hash table for the PATH variable. Use whenever a new command is created during the current session.
CLI Example:
salt '*' pkg.rehash
-
salt.modules.pkgin.
remove
(name=None, pkgs=None, **kwargs)¶ - 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.
New in version 0.16.0.
Returns a list containing the removed packages.
CLI Example:
salt '*' pkg.remove <package name> salt '*' pkg.remove <package1>,<package2>,<package3> salt '*' pkg.remove pkgs='["foo", "bar"]'
-
salt.modules.pkgin.
search
(pkg_name)¶ Searches for an exact match using pkgin ^package$
CLI Example:
salt '*' pkg.search 'mysql-server'
-
salt.modules.pkgin.
upgrade
()¶ Run pkg upgrade, if pkgin used. Otherwise do nothing
Return a dict containing the new package names and versions:
{'<package>': {'old': '<old-version>', 'new': '<new-version>'}}
CLI Example:
salt '*' pkg.upgrade
-
salt.modules.pkgin.
version
(*names, **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> ...