salt.modules.pkgng¶
Support for pkgng
-
salt.modules.pkgng.add(pkg_path)¶ Install a package from either a local source or remote one
CLI Example:
salt '*' pkgng.add /tmp/package.txz
-
salt.modules.pkgng.audit()¶ Audits installed packages against known vulnerabilities
CLI Example:
salt '*' pkgng.audit
-
salt.modules.pkgng.autoremove(dryrun=False)¶ Delete packages which were automatically installed as dependencies and are not required anymore.
- dryrun
- Dry-run mode. The list of changes to packages is always printed, but no changes are actually made.
CLI Example:
salt '*' pkgng.autoremove salt '*' pkgng.autoremove dryrun=True
-
salt.modules.pkgng.backup(file_name)¶ Export installed packages into yaml+mtree file
CLI Example:
salt '*' pkgng.backup /tmp/pkg
-
salt.modules.pkgng.check(depends=False, recompute=False, checksum=False)¶ Sanity checks installed packages
- depends
Check for and install missing dependencies.
CLI Example:
salt '*' pkgng.check recompute=True
- recompute
Recompute sizes and checksums of installed packages.
CLI Example:
salt '*' pkgng.check depends=True
- checksum
Find invalid checksums for installed packages.
CLI Example:
salt '*' pkgng.check checksum=True
-
salt.modules.pkgng.clean()¶ Cleans the local cache of fetched remote packages
CLI Example:
salt '*' pkgng.clean
-
salt.modules.pkgng.delete(pkg_name, all_installed=False, force=False, glob=False, dryrun=False, recurse=False, regex=False, pcre=False)¶ Delete a package from the database and system
CLI Example:
salt '*' pkgng.delete <package name>- all_installed
Deletes all installed packages from the system and empties the database. USE WITH CAUTION!
CLI Example:
salt '*' pkgng.delete all all_installed=True force=True
- force
Forces packages to be removed despite leaving unresolved dependencies.
CLI Example:
salt '*' pkgng.delete <package name> force=True
- glob
Treat the package names as shell glob patterns.
CLI Example:
salt '*' pkgng.delete <package name> glob=True
- dryrun
Dry run mode. The list of packages to delete is always printed, but no packages are actually deleted.
CLI Example:
salt '*' pkgng.delete <package name> dryrun=True
- recurse
Delete all packages that require the listed package as well.
CLI Example:
salt '*' pkgng.delete <package name> recurse=True
- regex
Treat the package names as regular expressions.
CLI Example:
salt '*' pkgng.delete <regular expression> regex=True
- pcre
Treat the package names as extended regular expressions.
CLI Example:
salt '*' pkgng.delete <extended regular expression> pcre=True
-
salt.modules.pkgng.fetch(pkg_name, all=False, quiet=False, reponame=None, glob=True, regex=False, pcre=False, local=False, depends=False)¶ Fetches remote packages
CLI Example:
salt '*' pkgng.fetch <package name>- all
Fetch all packages.
CLI Example:
salt '*' pkgng.fetch <package name> all=True
- quiet
Quiet mode. Show less output.
CLI Example:
salt '*' pkgng.fetch <package name> quiet=True
- reponame
Fetches packages from the given reponame if multiple repo support is enabled. See pkg.conf(5).
CLI Example:
salt '*' pkgng.fetch <package name> reponame=repo
- glob
Treat pkg_name as a shell glob pattern.
CLI Example:
salt '*' pkgng.fetch <package name> glob=True
- regex
Treat pkg_name as a regular expression.
CLI Example:
salt '*' pkgng.fetch <regular expression> regex=True
- pcre
Treat pkg_name is an extended regular expression.
CLI Example:
salt '*' pkgng.fetch <extended regular expression> pcre=True
- local
Skip updating the repository catalogues with pkg-update(8). Use the local cache only.
CLI Example:
salt '*' pkgng.fetch <package name> local=True
- depends
Fetch the package and its dependencies as well.
CLI Example:
salt '*' pkgng.fetch <package name> depends=True
-
salt.modules.pkgng.info(pkg_name=None)¶ Returns info on packages installed on system
CLI Example:
salt '*' pkgng.info salt '*' pkgng.info sudo
-
salt.modules.pkgng.install(pkg_name, orphan=False, force=False, glob=False, local=False, dryrun=False, quiet=False, require=False, reponame=None, regex=False, pcre=False)¶ Install package from repositories
CLI Example:
salt '*' pkgng.install <package name>- orphan
Mark the installed package as orphan. Will be automatically removed if no other packages depend on them. For more information please refer to pkg-autoremove(8).
CLI Example:
salt '*' pkgng.install <package name> orphan=True
- force
Force the reinstallation of the package if already installed.
CLI Example:
salt '*' pkgng.install <package name> force=True
- glob
Treat the package names as shell glob patterns.
CLI Example:
salt '*' pkgng.install <package name> glob=True
- local
Skip updating the repository catalogues with pkg-update(8). Use the locally cached copies only.
CLI Example:
salt '*' pkgng.install <package name> local=True
- dryrun
Dru-run mode. The list of changes to packages is always printed, but no changes are actually made.
CLI Example:
salt '*' pkgng.install <package name> dryrun=True
- quiet
Force quiet output, except when dryrun is used, where pkg install will always show packages to be installed, upgraded or deleted.
CLI Example:
salt '*' pkgng.install <package name> quiet=True
- require
When used with force, reinstalls any packages that require the given package.
CLI Example:
salt '*' pkgng.install <package name> require=True force=True
- reponame
In multi-repo mode, override the pkg.conf ordering and only attempt to download packages from the named repository.
CLI Example:
salt '*' pkgng.install <package name> reponame=repo
- regex
Treat the package names as a regular expression
CLI Example:
salt '*' pkgng.install <regular expression> regex=True
- pcre
Treat the package names as extended regular expressions.
CLI Example:
salt '*' pkgng.install <extended regular expression> pcre=True
-
salt.modules.pkgng.latest_version(pkg_name, **kwargs)¶ The available version of the package in the repository
CLI Example:
salt '*' pkgng.latest_version <package name>
-
salt.modules.pkgng.parse_config(file_name='/usr/local/etc/pkg.conf')¶ Return dict of uncommented global variables.
CLI Example:
salt '*' pkgng.parse_configNOTE:not working properly right now
-
salt.modules.pkgng.restore(file_name)¶ Reads archive created by pkg backup -d and recreates the database.
CLI Example:
salt '*' pkgng.restore /tmp/pkg
-
salt.modules.pkgng.search(pkg_name, exact=False, glob=False, regex=False, pcre=False, comment=False, desc=False, full=False, depends=False, size=False, quiet=False, origin=False, prefix=False)¶ Searches in remote package repositories
CLI Example:
salt '*' pkgng.search pattern- exact
Treat pattern as exact pattern.
CLI Example:
salt '*' pkgng.search pattern exact=True
- glob
Treat pattern as a shell glob pattern.
CLI Example:
salt '*' pkgng.search pattern glob=True
- regex
Treat pattern as a regular expression.
CLI Example:
salt '*' pkgng.search pattern regex=True
- pcre
Treat pattern as an extended regular expression.
CLI Example:
salt '*' pkgng.search pattern pcre=True
- comment
Search for pattern in the package comment one-line description.
CLI Example:
salt '*' pkgng.search pattern comment=True
- desc
Search for pattern in the package description.
CLI Example:
salt '*' pkgng.search pattern desc=True
- full
Displays full information about the matching packages.
CLI Example:
salt '*' pkgng.search pattern full=True
- depends
Displays the dependencies of pattern.
CLI Example:
salt '*' pkgng.search pattern depends=True
- size
Displays the size of the package
CLI Example:
salt '*' pkgng.search pattern size=True
- quiet
Be quiet. Prints only the requested information without displaying many hints.
CLI Example:
salt '*' pkgng.search pattern quiet=True
- origin
Displays pattern origin.
CLI Example:
salt '*' pkgng.search pattern origin=True
- prefix
Displays the installation prefix for each package matching pattern.
CLI Example:
salt '*' pkgng.search pattern prefix=True
-
salt.modules.pkgng.stats(local=False, remote=False)¶ Return pkgng stats.
CLI Example:
salt '*' pkgng.stats- local
Display stats only for the local package database.
CLI Example:
salt '*' pkgng.stats local=True
- remote
Display stats only for the remote package database(s).
CLI Example:
salt '*' pkgng.stats remote=True
-
salt.modules.pkgng.update(force=False)¶ Refresh PACKAGESITE contents
CLI Example:
salt '*' pkgng.update- force
Force a full download of the repository catalogue without regard to the respective ages of the local and remote copies of the catalogue.
CLI Example:
salt '*' pkgng.update force=True
-
salt.modules.pkgng.update_package_site(new_url)¶ Updates remote package repo URL, PACKAGESITE var to be exact.
Must be using http://, ftp://, or https// protos
CLI Example:
salt '*' pkgng.update_package_site http://127.0.0.1/
-
salt.modules.pkgng.updating(pkg_name, filedate=None, filename=None)¶ ' Displays UPDATING entries of software packages
CLI Example:
salt '*' pkgng.updating foo- filedate
Only entries newer than date are shown. Use a YYYYMMDD date format.
CLI Example:
salt '*' pkgng.updating foo filedate=20130101
- filename
Defines an alternative location of the UPDATING file.
CLI Example:
salt '*' pkgng.updating foo filename=/tmp/UPDATING
-
salt.modules.pkgng.upgrade(force=False, local=False, dryrun=False)¶ Upgrade all packages
CLI Example:
salt '*' pkgng.upgrade- force
Force reinstalling/upgrading the whole set of packages.
CLI Example:
salt '*' pkgng.upgrade force=True
- local
Skip updating the repository catalogues with
pkg-update(8). Use the local cache only.CLI Example:
salt '*' pkgng.update local=True
- dryrun
Dry-run mode: show what packages have updates available, but do not perform any upgrades. Repository catalogues will be updated as usual unless the local option is also given.
CLI Example:
salt '*' pkgng.update dryrun=True
-
salt.modules.pkgng.version()¶ Displays the current version of pkg
CLI Example:
salt '*' pkgng.version
-
salt.modules.pkgng.which(file_name, origin=False, quiet=False)¶ Displays which package installed a specific file
CLI Example:
salt '*' pkgng.which <file name>- origin
Shows the origin of the package instead of name-version.
CLI Example:
salt '*' pkgng.which <file name> origin=True
- quiet
Quiet output.
CLI Example:
salt '*' pkgng.which <file name> quiet=True