salt.modules.freebsdpkg

Package support for FreeBSD

salt.modules.freebsdpkg.available_version(name)

The available version of the package in the repository

CLI Example:

salt '*' pkg.available_version <package name>
salt.modules.freebsdpkg.compare(version1='', version2='')

Compare two version strings. Return -1 if version1 < version2, 0 if version1 == version2, and 1 if version1 > version2. Return None if there was a problem making the comparison.

CLI Example:

salt '*' pkg.compare '0.2.4-0' '0.2.4.1-0'
salt.modules.freebsdpkg.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.freebsdpkg.list_pkgs()

List the packages currently installed as a dict:

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

CLI Example:

salt '*' pkg.list_pkgs
salt.modules.freebsdpkg.purge(name, **kwargs)

Remove a single package with pkg_delete

Returns a list containing the removed packages.

CLI Example:

salt '*' pkg.purge <package name>
salt.modules.freebsdpkg.refresh_db()

Use pkg update to get latest repo.txz when using pkgng, else update the ports tree with portsnap otherwise. If the ports tree does not exist it will be downloaded and set up.

CLI Example:

salt '*' pkg.refresh_db
salt.modules.freebsdpkg.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.freebsdpkg.remove(name=None, pkgs=None, **kwargs)

Remove a single package.

name : None
The name of the package to be deleted.
pkgs : None

A list of packages to delete. Must be passed as a python list.

CLI Example:

salt '*' pkg.remove pkgs='["foo","bar"]'

Returns a list containing the removed packages.

CLI Example:

salt '*' pkg.remove <package name>
salt.modules.freebsdpkg.search(pkg_name)

Use pkg search if pkg is being used.

CLI Example:

salt '*' pkg.search 'mysql-server'
salt.modules.freebsdpkg.upgrade()

Run pkg upgrade, if pkgng 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.freebsdpkg.version(name)

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

CLI Example:

salt '*' pkg.version <package name>

Parent topic

Previous topic

salt.modules.freebsdkmod

Next topic

salt.modules.freebsdservice