Install the chef-client on Microsoft Windows

[edit on GitHub]

The chef-client can be installed on machines running Microsoft Windows in the following ways:

  • By using the knife windows plugin to bootstrap the chef-client; this process requires the target node be available via SSH (port 22) or by using the HTTP or HTTPS ports that are required by WinRM
  • By downloading the chef-client to the target node, and then running the Microsoft Installer Package (MSI) locally
  • By using an existing process already in place for managing Microsoft Windows machines, such as System Center

To run the chef-client at periodic intervals (so that it can check in with the Chef server automatically), configure the chef-client to run as a service or as a scheduled task. (The chef-client can be configured to run as a service during the setup process.)

Use knife windows

The knife windows subcommand is used to configure and interact with nodes that exist on server and/or desktop machines that are running Microsoft Windows. Nodes are configured using WinRM, which allows native objects—batch scripts, Windows PowerShell scripts, or scripting library variables—to be called by external applications. The knife windows subcommand supports NTLM and Kerberos methods of authentication.


WinRM requires that a target node be accessible via the ports configured to support access via HTTP or HTTPS.


Msiexec.exe is used to install the chef-client on a node as part of a bootstrap operation. The actual command that is run by the default bootstrap script is:

$ msiexec /qn /i "%LOCAL_DESTINATION_MSI_PATH%"

where /qn is used to set the user interface level to “No UI”, /i is used to define the location in which the chef-client is installed, and "%LOCAL_DESTINATION_MSI_PATH%" is a variable defined in the default windows-chef-client-msi.erb bootstrap template. See for more information about the options available to Msiexec.exe.


The ADDLOCAL parameter adds two setup options that are specific to the chef-client. These options can be passed along with an Msiexec.exe command:

Option Description
ChefClientFeature Use to install the chef-client.
ChefServiceFeature Use to configure the chef-client as a service in Microsoft Windows.
ChefPSModuleFeature Used to install the chef PowerShell module. This will enable chef command line utilities within PowerShell.

First install the chef-client, and then enable it to run as a service. For example:

$ msiexec /qn /i C:\inst\ ADDLOCAL="ChefClientFeature,ChefServiceFeature,ChefPSModuleFeature"

Use MSI Installer

A Microsoft Installer Package (MSI) is available for installing the chef-client on a Microsoft Windows machine.

To install the chef-client on Microsoft Windows, do the following:

  1. Go to

  2. Click the Chef Client tab.

  3. Select Windows, a version, and an architecture.

  4. Under Downloads, select the version of the chef-client to download, and then click the link that appears below to download the package.

  5. Ensure that the MSI is on the target node.

  6. Run the MSI package and use all the default options:







The chef-client must be run as a service for it to be able to regularly check in with the Chef server. Select the Chef Client Service option to have the MSI configure the chef-client as a service.







Run as a Service

To run the chef-client at periodic intervals (so that it can check in with the Chef server automatically), configure the chef-client to run as a service or as a scheduled task. This can be done via the MSI, by selecting the Chef Client Service option on the Custom Setup page or by running the following command after the chef-client is installed:

$ chef-service-manager -a install

and then start the chef-client as a service:

$ chef-service-manager -a start

After the chef-client is configured to run as a service, the default file path is: c:\chef\chef-client.log.

Run as a Scheduled Task

The chef-client can be run as a scheduled task. On the Microsoft Windows platform, a scheduled task provides more visibility, configurability, and reliability around log rotation and permissions, as compared to running the chef-client as a service. A scheduled task:

  • Prevents log rotation issues, such as filling a disk partition
  • Does not have an indeterminate status, such as a service for which only the watcher is “running”
  • Prevents insufficient permissions related to service context
  • Prevents issues related to a system reboot

Use an Existing Process

Many organizations already have processes in place for managing the applications and settings on various Microsoft Windows machines. For example, System Center. The chef-client can be installed using this method.

PATH System Variable

On Microsoft Windows, the chef-client must have two entries added to the PATH environment variable:

  • C:\opscode\chef\bin
  • C:\opscode\chef\embedded\bin

This is typically done during the installation of the chef-client automatically. If these values (for any reason) are not in the PATH environment variable, the chef-client will not run properly.


This value can be set from a recipe. For example, from the php cookbook:

#  the following code sample comes from the ``package`` recipe in the ``php`` cookbook:

if platform?('windows')

  include_recipe 'iis::mod_cgi'

  install_dir = File.expand_path(node['php']['conf_dir']).gsub('/', '\\')
  windows_package node['php']['windows']['msi_name'] do
    source node['php']['windows']['msi_source']
    installer_type :msi

    options %W[
    ].join(' ')


ENV['PATH'] += ";#{install_dir}"
windows_path install_dir