salt.modules.zypper¶

Package support for openSUSE via the zypper package manager

depends:	`zypp` Python module. Install with `zypper install python-zypp`

salt.modules.zypper.add_lock(name=None, pkgs=None, **kwargs)¶

Add a package lock. Specify packages to lock by exact name.

CLI Example:

salt '*' pkg.add_lock <package name>
salt '*' pkg.add_lock <package1>,<package2>,<package3>
salt '*' pkg.add_lock pkgs='["foo", "bar"]'

salt.modules.zypper.clean_locks()¶

Remove unused locks that do not currently (with regard to repositories used) lock any package.

CLI Example:

salt '*' pkg.clean_locks

salt.modules.zypper.del_repo(repo)¶

Delete a repo.

CLI Examples:

salt '*' pkg.del_repo alias

salt.modules.zypper.diff(*paths)¶

Return a formatted diff between current files and original in a package. NOTE: this function includes all files (configuration and not), but does not work on binary content.

Parameters:	path -- Full path to the installed file
Returns:	Difference string or raises and exception if examined file is binary.

CLI example:

salt '*' pkg.diff /etc/apache2/httpd.conf /etc/sudoers

salt.modules.zypper.download(*packages)¶

Download packages to the local disk.

CLI example:

salt '*' pkg.download httpd
salt '*' pkg.download httpd postfix

salt.modules.zypper.file_dict(*packages)¶

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 rpm database (not generally recommended).

CLI Examples:

salt '*' pkg.file_list httpd
salt '*' pkg.file_list httpd postfix
salt '*' pkg.file_list

salt.modules.zypper.file_list(*packages)¶

List the files that belong to a package. Not specifying any packages will return a list of every file on the system's rpm database (not generally recommended).

CLI Examples:

salt '*' pkg.file_list httpd
salt '*' pkg.file_list httpd postfix
salt '*' pkg.file_list

salt.modules.zypper.get_repo(repo, **kwargs)¶

Display a repo.

CLI Example:

salt '*' pkg.get_repo alias

salt.modules.zypper.info(*names, **kwargs)¶

Return the information of the named package available for the system.

CLI example:

salt '*' pkg.info <package name>
salt '*' pkg.info <package1> <package2> <package3> ...

salt.modules.zypper.install(name=None, refresh=False, fromrepo=None, pkgs=None, sources=None, downloadonly=None, **kwargs)¶

Install the passed package(s), add refresh=True to run 'zypper refresh' 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.

CLI Example:

salt '*' pkg.install <package name>

refresh

Whether or not to refresh the package database before installing.

fromrepo

Specify a package repository to install from.

downloadonly

Only download the packages, do not install.

version

Can be either a version number, or the combination of a comparison operator (<, >, <=, >=, =) and a version number (ex. '>1.2.3-4'). This parameter is ignored if "pkgs" or "sources" is passed.

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. As with the version parameter above, comparison operators can be used to target a specific version of a package.

CLI Examples:

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

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.zypper.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 dict will be returned for that package.

CLI example:

salt '*' pkg.latest_version <package name>
salt '*' pkg.latest_version <package1> <package2> <package3> ...

salt.modules.zypper.list_installed_patterns()¶

List installed patterns on the system.

CLI Examples:

salt '*' pkg.list_installed_patterns

salt.modules.zypper.list_locks()¶

List current package locks.

Return a dict containing the locked package with attributes:

{'<package>': {'case_sensitive': '<case_sensitive>',
               'match_type': '<match_type>'
               'type': '<type>'}}

CLI Example:

salt '*' pkg.list_locks

salt.modules.zypper.list_patterns()¶

List all known patterns from available repos.

CLI Examples:

salt '*' pkg.list_patterns

salt.modules.zypper.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.zypper.list_products()¶

List all installed SUSE products.

CLI Examples:

salt '*' pkg.list_products

salt.modules.zypper.list_repos()¶

Lists all repos.

CLI Example:

salt '*' pkg.list_repos

salt.modules.zypper.list_upgrades(refresh=True)¶

List all available package upgrades on this system

CLI Example:

salt '*' pkg.list_upgrades

salt.modules.zypper.mod_repo(repo, **kwargs)¶

Modify one or more values for a repo. If the repo does not exist, it will be created, so long as the following values are specified:

repo or alias: alias by which the zypper refers to the repo
url, mirrorlist or baseurl: the URL for zypper to reference
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 repository.
cache: Enable or disable (True or False) RPM files caching.
gpgcheck: Enable or disable (True or False) GOG check for this repository.
gpgautoimport: Automatically trust and import new repository.

Key/Value pairs may also be removed from a repo's configuration by setting a key to a blank value. Bear in mind that a name cannot be deleted, and a url can only be deleted if a mirrorlist is specified (or vice versa).

CLI Examples:

salt '*' pkg.mod_repo alias alias=new_alias
salt '*' pkg.mod_repo alias url= mirrorlist=http://host.com/

salt.modules.zypper.modified(*packages, **flags)¶

List the modified files that belong to a package. Not specifying any packages will return a list of _all_ modified files on the system's RPM database.

New in version 2015.5.0.

Filtering by flags (True or False):

size: Include only files where size changed.
mode: Include only files which file's mode has been changed.
checksum: Include only files which MD5 checksum has been changed.
device: Include only files which major and minor numbers has been changed.
symlink: Include only files which are symbolic link contents.
owner: Include only files where owner has been changed.
group: Include only files where group has been changed.
time: Include only files where modification time of the file has been changed.
capabilities: Include only files where capabilities differ or not. Note: supported only on newer RPM versions.

CLI Examples:

salt '*' pkg.modified
salt '*' pkg.modified httpd
salt '*' pkg.modified httpd postfix
salt '*' pkg.modified httpd owner=True group=False

salt.modules.zypper.owner(*paths)¶

Return the name of the package that owns the file. Multiple file paths can be passed. 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 Examples:

salt '*' pkg.owner /usr/bin/apachectl
salt '*' pkg.owner /usr/bin/apachectl /etc/httpd/conf/httpd.conf

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

Recursively remove a package and all dependencies which were installed with it, this will call a zypper -n remove -u

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.zypper.refresh_db()¶

Just run a zypper refresh, return a dict:

{'<database name>': Bool}

CLI Example:

salt '*' pkg.refresh_db

salt.modules.zypper.remove(name=None, pkgs=None, **kwargs)¶

Remove packages with zypper -n 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.zypper.remove_lock(name=None, pkgs=None, **kwargs)¶

Remove specified package lock.

CLI Example:

salt '*' pkg.remove_lock <package name>
salt '*' pkg.remove_lock <package1>,<package2>,<package3>
salt '*' pkg.remove_lock pkgs='["foo", "bar"]'

salt.modules.zypper.search(criteria)¶

List known packags, available to the system.

CLI Examples:

salt '*' pkg.search <criteria>

salt.modules.zypper.upgrade(refresh=True)¶

Run a full system upgrade, a zypper 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.zypper.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.zypper.verify(*names, **kwargs)¶

Runs an rpm -Va on a system, and returns the results in a dict

Files with an attribute of config, doc, ghost, license or readme in the package header can be ignored using the ignore_types keyword argument

CLI Example:

salt '*' pkg.verify
salt '*' pkg.verify httpd
salt '*' pkg.verify 'httpd postfix'
salt '*' pkg.verify 'httpd postfix' ignore_types=['config','doc']

salt.modules.zypper.version(*names, **kwargs)¶

Returns a string representing the package version or an empty dict 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> ...