salt.modules.win_pkg

### Navigation

- index
- modules |
- next |
- previous |
- « SaltStack.org |
- Documentation home
- Full list of builtin execution modules »

# salt.modules.win_pkg

A module to manage software on Windows

`salt.modules.win_pkg.` `available_version`(name)

  The available version of the package in the repository

  CLI Example:

      salt '*' pkg.available_version <package name>

`salt.modules.win_pkg.` `install`(name, refresh=False, **kwargs)

  Install the passed package

  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.win_pkg.` `list_pkgs`(*args)

  List the packages currently installed in a dict:

      {'<package_name>': '<version>'}

  CLI Example:

      salt '*' pkg.list_pkgs

`salt.modules.win_pkg.` `list_upgrades`()

  List all available package upgrades on this system

  CLI Example:

      salt '*' pkg.list_upgrades

`salt.modules.win_pkg.` `purge`(name)

  Recursively remove a package and all dependencies which were installed with it

  Return a list containing the removed packages.

  CLI Example:

      salt '*' pkg.purge <package name>

`salt.modules.win_pkg.` `refresh_db`()

  Just recheck the repository and return a dict:

      {'<database name>': Bool}

  CLI Example:

      salt '*' pkg.refresh_db

`salt.modules.win_pkg.` `remove`(name)

  Remove a single package

  Return a list containing the removed packages.

  CLI Example:

      salt '*' pkg.remove <package name>

`salt.modules.win_pkg.` `upgrade`()

  Run a full system 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.win_pkg.` `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.win_pkg.` `version`(name)

  Returns a version if the package is installed, else returns an empty string

  CLI Example:

      salt '*' pkg.version <package name>

## Comments

comments powered by Disqus

### Navigation

- index
- modules |
- next |
- previous |
- « SaltStack.org |
- Documentation home
- Full list of builtin execution modules »