Use the windows_package resource to manage Microsoft Installer Package (MSI) packages for the Microsoft Windows platform.
A windows_package resource block manages a package on a node, typically by installing it. The simplest use of the windows_package resource is:
windows_package 'package_name'
which will install the named package using all of the default options and the default action (:install
).
The full syntax for all of the properties that are available to the windows_package resource is:
windows_package 'name' do checksum String installer_type Symbol notifies # see description options String provider Chef::Provider::Package::Windows remote_file_attributes Hash returns String, Integer, Array source String # defaults to 'name' if not specified subscribes # see description timeout String, Integer action Symbol # defaults to :install if not specified end
where
windows_package
tells the chef-client to manage a package'name'
is the name of the package:action
identifies which steps the chef-client will take to bring the node into the desired statechecksum
, installer_type
, options
, package_name
, provider
, remote_file_attributes
, returns
, source
, and timeout
are properties of this resource, with the Ruby type shown. See “Properties” section below for more information about all of the properties that may be used with this resource.This resource has the following actions:
:install
:nothing
:remove
This resource has the following properties:
checksum
Ruby Type: String
The SHA-256 checksum of the file. Use to prevent a file from being re-downloaded. When the local file matches the checksum, the chef-client does not download it. Use when a URL is specified by the source
property.
ignore_failure
Ruby Types: TrueClass, FalseClass
Continue running a recipe if a resource fails for any reason. Default value: false
.
installer_type
Ruby Type: Symbol
A symbol that specifies the type of package. Possible values: :custom
(such as installing a non-.msi file that embeds an .msi-based installer), :inno
(Inno Setup), :installshield
(InstallShield), :msi
(Microsoft Installer Package (MSI)), :nsis
(Nullsoft Scriptable Install System (NSIS)), :wise
(Wise).
notifies
Ruby Type: Symbol, ‘Chef::Resource[String]’
A resource may notify another resource to take action when its state changes. Specify a 'resource[name]'
, the :action
that resource should take, and then the :timer
for that action. A resource may notifiy more than one resource; use a notifies
statement for each resource to be notified.
A timer specifies the point during the chef-client run at which a notification is run. The following timers are available:
:before
:delayed
:immediate
, :immediately
The syntax for notifies
is:
notifies :action, 'resource[name]', :timer
options
Ruby Type: String
One (or more) additional options that are passed to the command.
provider
Ruby Type: Chef Class
Optional. Explicitly specifies a provider. See “Providers” section below for more information.
remote_file_attributes
Ruby Type: Hash
A package at a remote location define as a Hash of properties that modifes the properties of the remote_file resource.
retries
Ruby Type: Integer
The number of times to catch exceptions and retry the resource. Default value: 0
.
retry_delay
Ruby Type: Integer
The retry delay (in seconds). Default value: 2
.
returns
Ruby Types: String, Integer, Array
A comma-delimited list of return codes that indicate the success or failure of the command that was run remotely. This code signals a successful :install
action. Default value: 0
.
source
Ruby Type: String
Optional. The path to a package in the local file system. The location of the package may be at a URL. Default value: the name
of the resource block See “Syntax” section above for more information.
If the source
property is not specified, the package name MUST be exactly the same as the display name found in Add/Remove programs or exacty the same as the DisplayName
property in the appropriate registry key:
HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Uninstall HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Uninstall HKEY_LOCAL_MACHINE\Software\Wow6464Node\Microsoft\Windows\CurrentVersion\Uninstall
Note
If there are multiple versions of a package installed with the same display name, all of those packages will be removed unless a version is provided in the version
property or unless it can be discovered in the installer file specified by the source
property.
subscribes
Ruby Type: Symbol, ‘Chef::Resource[String]’
A resource may listen to another resource, and then take action if the state of the resource being listened to changes. Specify a 'resource[name]'
, the :action
to be taken, and then the :timer
for that action.
A timer specifies the point during the chef-client run at which a notification is run. The following timers are available:
:before
:delayed
:immediate
, :immediately
The syntax for subscribes
is:
subscribes :action, 'resource[name]', :timer
timeout
Ruby Types: String, Integer
The amount of time (in seconds) to wait before timing out. Default value: 600
(seconds).
Where a resource represents a piece of the system (and its desired state), a provider defines the steps that are needed to bring that piece of the system from its current state into the desired state.
The chef-client will determine the correct provider based on configuration data collected by Ohai at the start of the chef-client run. This configuration data is then mapped to a platform and an associated list of providers.
Generally, it’s best to let the chef-client choose the provider, and this is (by far) the most common approach. However, in some cases, specifying a provider may be desirable. There are two approaches:
yum_package "foo" do
instead of package "foo" do
, script "foo" do
instead of bash "foo" do
, and so on—when availableprovider
property within the resource block to specify the long name of the provider as a property of a resource. For example: provider Chef::Provider::Long::Name
This resource has the following providers:
Chef::Provider::Package
, package
Chef::Provider::Package::Windows
, windows_package
The following examples demonstrate various approaches for using resources in recipes. If you want to see examples of how Chef uses resources in recipes, take a closer look at the cookbooks that Chef authors and maintains: https://github.com/chef-cookbooks.
Install a package
windows_package '7zip' do action :install source 'C:\7z920.msi' end
Specify a URL for the source attribute
windows_package '7zip' do source 'http://www.7-zip.org/a/7z938-x64.msi' end
Specify path and checksum
windows_package '7zip' do source 'http://www.7-zip.org/a/7z938-x64.msi' checksum '7c8e873991c82ad9cfc123415254ea6101e9a645e12977dcd518979e50fdedf3' end
Modify remote_file resource attributes
The windows_package resource may specify a package at a remote location using the remote_file_attributes
property. This uses the remote_file resource to download the contents at the specified URL and passes in a Hash that modifes the properties of the remote_file resource.
For example:
windows_package '7zip' do source 'http://www.7-zip.org/a/7z938-x64.msi' remote_file_attributes ({ :path => 'C:\\7zip.msi', :checksum => '7c8e873991c82ad9cfc123415254ea6101e9a645e12977dcd518979e50fdedf3' }) end
Download a nsis (Nullsoft) package resource
windows_package 'Mercurial 3.6.1 (64-bit)' do source 'http://mercurial.selenic.com/release/windows/Mercurial-3.6.1-x64.exe' checksum 'febd29578cb6736163d232708b834a2ddd119aa40abc536b2c313fc5e1b5831d' end
Download a custom package
windows_package 'Microsoft Visual C++ 2005 Redistributable' do source 'https://download.microsoft.com/download/6/B/B/6BB661D6-A8AE-4819-B79F-236472F6070C/vcredist_x86.exe' installer_type :custom options '/Q' end
© Chef Software, Inc.
Licensed under the Creative Commons Attribution 3.0 Unported License.
The Chef™ Mark and Chef Logo are either registered trademarks/service marks or trademarks/servicemarks of Chef, in the United States and other countries and are used with Chef Inc's permission.
We are not affiliated with, endorsed or sponsored by Chef Inc.
https://docs-archive.chef.io/release/12-13/resource_windows_package.html