salt.modules.freebsdpkg

### Navigation

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

# 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.` `install`(name, refresh=False, repo='', **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.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)

  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)

  Remove a single package with pkg_delete

  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>

## Comments

comments powered by Disqus

### Navigation

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