# salt.modules.yumpkg5

Support for YUM

`salt.modules.yumpkg5.` `check_db`(*names, **kwargs)

  New in version 0.17.0.

  Returns a dict containing the following information for each specified package:

  1. A key `found`, which will be a boolean value denoting if a match was found in the package database.
  2. If `found` is `False`, then a second key called `suggestions` will be present, which will contain a list of possible matches.

  The `fromrepo`, `enablerepo`, and `disablerepo` arguments are supported, as used in pkg states.

  CLI Examples:

      salt '*' pkg.check_db <package1> <package2> <package3>
      salt '*' pkg.check_db <package1> <package2> <package3> fromrepo=epel-testing

`salt.modules.yumpkg5.` `install`(name=None, refresh=False, fromrepo=None, skip_verify=False, pkgs=None, sources=None, **kwargs)

  Install the passed package(s), add refresh=True to clean the yum database before package is installed.

  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.

    32-bit packages can be installed on 64-bit systems by appending the architecture designation (`.i686`, `.i586`, etc.) to the end of the package name.

    CLI Example:

        salt '*' pkg.install <package name>

  refresh
    Whether or not to update the yum database before executing.
  skip_verify
    Skip the GPG verification check (e.g., `--nogpgcheck`)
  version
    Install a specific version of the package, e.g. 1.2.3-4.el5. Ignored if "pkgs" or "sources" is passed.

  Repository Options:

  fromrepo
    Specify a package repository (or repositories) from which to install. (e.g., `yum --disablerepo='*' --enablerepo='somerepo'`)
  enablerepo (ignored if `fromrepo` is specified)
    Specify a disabled package repository (or repositories) to enable. (e.g., `yum --enablerepo='somerepo'`)
  disablerepo (ignored if `fromrepo` is specified)
    Specify an enabled package repository (or repositories) to disable. (e.g., `yum --disablerepo='somerepo'`)

  Multiple Package Installation Options:

  pkgs

    A list of packages to install from a software repository. Must be passed as a python list. A specific version number can be specified by using a single-element dict representing the package and its version.

    CLI Examples:

        salt '*' pkg.install pkgs='["foo", "bar"]'
        salt '*' pkg.install pkgs='["foo", {"bar": "1.2.3-4.el5"}]'

  sources

    A list of RPM 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.rpm"}, {"bar": "salt://bar.rpm"}]'

  Returns a dict containing the new package names and versions:

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

`salt.modules.yumpkg5.` `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.

  A specific repo can be requested using the `fromrepo` keyword argument.

  CLI Example:

      salt '*' pkg.latest_version <package name>
      salt '*' pkg.latest_version <package name> fromrepo=epel-testing
      salt '*' pkg.latest_version <package1> <package2> <package3> ...

`salt.modules.yumpkg5.` `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.modules.yumpkg5.` `list_upgrades`(refresh=True, **kwargs)

  Check whether or not an upgrade is available for all packages

  CLI Example:

      salt '*' pkg.list_upgrades

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

  Package purges are not supported by yum, 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.yumpkg5.` `refresh_db`()

  Since yum refreshes the database automatically, this runs a yum clean, so that the next yum operation will have a clean database

  CLI Example:

      salt '*' pkg.refresh_db

`salt.modules.yumpkg5.` `remove`(name=None, pkgs=None, **kwargs)

  Remove packages with `yum -q -y 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.remove <package name>
      salt '*' pkg.remove <package1>,<package2>,<package3>
      salt '*' pkg.remove pkgs='["foo", "bar"]'

`salt.modules.yumpkg5.` `upgrade`(refresh=True)

  Run a full system upgrade, a yum upgrade

  Return a dict containing the new package names and versions:

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

  CLI Example:

      salt '*' pkg.upgrade

`salt.modules.yumpkg5.` `upgrade_available`(name)

  Check whether or not an upgrade is available for a given package

  CLI Example:

      salt '*' pkg.upgrade_available <package name>

`salt.modules.yumpkg5.` `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> ...

Current Salt release: 0.17.1

#### Previous topic

salt.modules.yumpkg

#### Next topic

salt.modules.zfs

### Quick search

Enter search terms or a module, class or function name.

### Upcoming SaltStack Events

My conferences on Lanyrd