salt.modules.chocolatey

A dead simple module wrapping calls to the Chocolatey package manager (http://chocolatey.org)

New in version 2014.1.0.

salt.modules.chocolatey.bootstrap(force=False)

Download and install the latest version of the Chocolatey package manager via the official bootstrap.

Chocolatey requires Windows PowerShell and the .NET v4.0 runtime. Depending on the host's version of Windows, chocolatey.bootstrap will attempt to ensure these prerequisites are met by downloading and executing the appropriate installers from Microsoft.

Note that if PowerShell is installed, you may have to restart the host machine for Chocolatey to work.

force
Run the bootstrap process even if Chocolatey is found in the path.

CLI Example:

salt '*' chocolatey.bootstrap
salt '*' chocolatey.bootstrap force=True
salt.modules.chocolatey.chocolatey_version()

New in version 2014.7.0.

Returns the version of Chocolatey installed on the minion.

CLI Example:

salt '*' chocolatey.chocolatey_version
salt.modules.chocolatey.install(name, version=None, source=None, force=False, install_args=None, override_args=False, force_x86=False)

Instructs Chocolatey to install a package.

name
The name of the package to be installed. Only accepts a single argument.
version
Install a specific version of the package. Defaults to latest version.
source
Chocolatey repository (directory, share or remote URL feed) the package comes from. Defaults to the official Chocolatey feed.
force
Reinstall the current version of an existing package.
install_args
A list of install arguments you want to pass to the installation process i.e product key or feature list
override_args
Set to true if you want to override the original install arguments (for the native installer)
in the package and use your own. When this is set to False install_args will be appended to the end of the default arguments
force_x86
Force x86 (32bit) installation on 64 bit systems. Defaults to false.

CLI Example:

salt '*' chocolatey.install <package name>
salt '*' chocolatey.install <package name> version=<package version>
salt '*' chocolatey.install <package name> install_args=<args> override_args=True
salt.modules.chocolatey.install_cygwin(name, install_args=None, override_args=False)

Instructs Chocolatey to install a package via Cygwin.

name
The name of the package to be installed. Only accepts a single argument.
install_args
A list of install arguments you want to pass to the installation process i.e product key or feature list
override_args
Set to true if you want to override the original install arguments (for the native installer)
in the package and use your own. When this is set to False install_args will be appended to the end of the default arguments

CLI Example:

salt '*' chocolatey.install_cygwin <package name>
salt '*' chocolatey.install_cygwin <package name> install_args=<args> override_args=True
salt.modules.chocolatey.install_gem(name, version=None, install_args=None, override_args=False)

Instructs Chocolatey to install a package via Ruby's Gems.

name
The name of the package to be installed. Only accepts a single argument.
version
Install a specific version of the package. Defaults to latest version available.
install_args
A list of install arguments you want to pass to the installation process i.e product key or feature list
override_args
Set to true if you want to override the original install arguments (for the native installer)
in the package and use your own. When this is set to False install_args will be appended to the end of the default arguments

CLI Example:

salt '*' chocolatey.install_gem <package name>
salt '*' chocolatey.install_gem <package name> version=<package version>
salt '*' chocolatey.install_gem <package name> install_args=<args> override_args=True
salt.modules.chocolatey.install_missing(name, version=None, source=None)

Instructs Chocolatey to install a package if it doesn't already exist.

Changed in version 2014.7.0: If the minion has Chocolatey >= 0.9.8.24 installed, this function calls chocolatey.install instead, as installmissing is deprecated as of that version and will be removed in Chocolatey 1.0.

name
The name of the package to be installed. Only accepts a single argument.
version
Install a specific version of the package. Defaults to latest version available.
source
Chocolatey repository (directory, share or remote URL feed) the package comes from. Defaults to the official Chocolatey feed.

CLI Example:

salt '*' chocolatey.install_missing <package name>
salt '*' chocolatey.install_missing <package name> version=<package version>
salt.modules.chocolatey.install_python(name, version=None, install_args=None, override_args=False)

Instructs Chocolatey to install a package via Python's easy_install.

name
The name of the package to be installed. Only accepts a single argument.
version
Install a specific version of the package. Defaults to latest version available.
install_args
A list of install arguments you want to pass to the installation process i.e product key or feature list
override_args
Set to true if you want to override the original install arguments (for the native installer)
in the package and use your own. When this is set to False install_args will be appended to the end of the default arguments

CLI Example:

salt '*' chocolatey.install_python <package name>
salt '*' chocolatey.install_python <package name> version=<package version>
salt '*' chocolatey.install_python <package name> install_args=<args> override_args=True
salt.modules.chocolatey.install_webpi(name, install_args=None, override_args=False)

Instructs Chocolatey to install a package via the Microsoft Web PI service.

name
The name of the package to be installed. Only accepts a single argument.
install_args
A list of install arguments you want to pass to the installation process i.e product key or feature list
override_args
Set to true if you want to override the original install arguments (for the native installer)
in the package and use your own. When this is set to False install_args will be appended to the end of the default arguments

CLI Example:

salt '*' chocolatey.install_webpi <package name>
salt '*' chocolatey.install_webpi <package name> install_args=<args> override_args=True
salt.modules.chocolatey.install_windowsfeatures(name)

Instructs Chocolatey to install a Windows Feature via the Deployment Image Servicing and Management tool.

name
The name of the feature to be installed. Only accepts a single argument.

CLI Example:

salt '*' chocolatey.install_windowsfeatures <package name>
salt.modules.chocolatey.list(narrow=None, all_versions=False, pre_versions=False, source=None, local_only=False)

Instructs Chocolatey to pull a vague package list from the repository.

narrow
Term used to narrow down results. Searches against name/description/tag.
all_versions
Display all available package versions in results. Defaults to False.
pre_versions
Display pre-release packages in results. Defaults to False.
source
Chocolatey repository (directory, share or remote URL feed) the package comes from. Defaults to the official Chocolatey feed.
local_only
Display packages only installed locally

CLI Example:

salt '*' chocolatey.list <narrow>
salt '*' chocolatey.list <narrow> all_versions=True
salt.modules.chocolatey.list_webpi()

Instructs Chocolatey to pull a full package list from the Microsoft Web PI repository.

CLI Example:

salt '*' chocolatey.list_webpi
salt.modules.chocolatey.list_windowsfeatures()

Instructs Chocolatey to pull a full package list from the Windows Features list, via the Deployment Image Servicing and Management tool.

CLI Example:

salt '*' chocolatey.list_windowsfeatures
salt.modules.chocolatey.uninstall(name, version=None, uninstall_args=None, override_args=False)

Instructs Chocolatey to uninstall a package.

name
The name of the package to be uninstalled. Only accepts a single argument.
version
Uninstalls a specific version of the package. Defaults to latest version installed.
uninstall_args
A list of uninstall arguments you want to pass to the uninstallation process i.e product key or feature list
override_args
Set to true if you want to override the original uninstall arguments (for the native uninstaller)
in the package and use your own. When this is set to False uninstall_args will be appended to the end of the default arguments

CLI Example:

salt '*' chocolatey.uninstall <package name>
salt '*' chocolatey.uninstall <package name> version=<package version>
salt '*' chocolatey.uninstall <package name> version=<package version> uninstall_args=<args> override_args=True
salt.modules.chocolatey.update(name, source=None, pre_versions=False)

Instructs Chocolatey to update packages on the system.

name
The name of the package to update, or "all" to update everything installed on the system.
source
Chocolatey repository (directory, share or remote URL feed) the package comes from. Defaults to the official Chocolatey feed.
pre_versions
Include pre-release packages in comparison. Defaults to False.

CLI Example:

salt "*" chocolatey.update all
salt "*" chocolatey.update <package name> pre_versions=True
salt.modules.chocolatey.version(name, check_remote=False, source=None, pre_versions=False)

Instructs Chocolatey to check an installed package version, and optionally compare it to one available from a remote feed.

name
The name of the package to check.
check_remote
Get the version number of the latest package from the remote feed. Defaults to False.
source
Chocolatey repository (directory, share or remote URL feed) the package comes from. Defaults to the official Chocolatey feed.
pre_versions
Include pre-release packages in comparison. Defaults to False.

CLI Example:

salt "*" chocolatey.version <package name>
salt "*" chocolatey.version <package name> check_remote=True