# salt.modules.apkpkg

Support for apk

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.

Added in version 2017.7.0.

salt.modules.apkpkg.file_dict(*packages, **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.apkpkg.file_list(*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.apkpkg.install(name=None, refresh=False, pkgs=None, sources=None, **kwargs)

  Install the passed package, add refresh=True to update the apk 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.

  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 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.

  Returns a dict containing the new package names and versions:

      {'<package>': {'old': '<old-version>',
                     'new': '<new-version>'}}

salt.modules.apkpkg.latest_version(*names, **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.apkpkg.list_pkgs(versions_as_list=False, **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.apkpkg.list_upgrades(refresh=True, **kwargs)

  List all available package upgrades.

  CLI Example:

      salt '*' pkg.list_upgrades

salt.modules.apkpkg.owner(*paths, **kwargs)

  Return the name of the package that owns the file. Multiple file paths can be passed. Like `pkg.version <salt.modules.apk.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.owns /usr/bin/apachectl
      salt '*' pkg.owns /usr/bin/apachectl /usr/bin/basename

salt.modules.apkpkg.purge(name=None, pkgs=None, **kwargs)

  Alias to remove

salt.modules.apkpkg.refresh_db(**kwargs)

  Updates the package list

  - `True`: Database updated successfully

  - `False`: Problem updating database

  CLI Example:

      salt '*' pkg.refresh_db

salt.modules.apkpkg.remove(name=None, pkgs=None, purge=False, **kwargs)

  Remove packages using `apk del`.

  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.remove <package name>
      salt '*' pkg.remove <package1>,<package2>,<package3>
      salt '*' pkg.remove pkgs='["foo", "bar"]'

salt.modules.apkpkg.upgrade(name=None, pkgs=None, refresh=True, **kwargs)

  Upgrades all packages via `apk upgrade` or a specific package if name or pkgs is specified. Name is ignored if pkgs is specified

  Returns a dict containing the changes.

  > {'<package>': {'old': '<old-version>',

  >   'new': '<new-version>'}}

  CLI Example:

      salt '*' pkg.upgrade

salt.modules.apkpkg.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> ...