Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

Select Status


powershell (59) Versions 3.0.3

Installs/Configures PowerShell on the Windows platform

cookbook 'powershell', '= 3.0.3', :supermarket
cookbook 'powershell', '= 3.0.3'
knife supermarket install powershell
knife supermarket download powershell
Quality -%

Powershell Cookbook

Installs and configures PowerShell 2.0, 3.0 or 4.0.

For users of Chef 10 without the powershell_script built-in resource, this cookbook also includes a resource/provider for executing scripts using the PowerShell interpreter.



Not every version of Windows supports every version of Powershell. The following table illustrates Powershell support across the Windows family. Included means that the base installation of the operating system includes the indicated version of Powershell.

<th>Windows Version</th>
<th>PowerShell 2.0</th>
<th>PowerShell 3.0</th>
<th>PowerShell 4.0</th>
<td>Windows XP</td>
<td>Windows Server 2003 / 2003 R2</td>
<td>Windows Server 2008 / Vista</td>
<td>Windows Server 2008 R2</td>
<td>Windows Server 2012 / Windows 8</td>
<td>Windows Server 2012R2 / Windows 8.1</td>


  • windows

PowerShell also requires the appropriate version of the Microsoft .NET Framework to be installed, if the operating system does not ship with that version. The following community cookbooks are used to install the correct version of the .NET Framework:

  • ms_dotnet2
  • ms_dotnet4
  • ms_dotnet45


Note: In Chef 11, use the built-in powershell_script resource.


Execute a script using the PowerShell interpreter (much like the script resources for bash, csh, perl, python and ruby). A temporary file is created and executed like other script resources, rather than run inline. By their nature, Script resources are not idempotent, as they are completely up to the user's imagination. Use the not_if or only_if meta parameters to guard the resource for idempotence.


  • :run: run the script

Attribute Parameters

  • command: name attribute. Name of the command to execute.
  • code: quoted string of code to execute.
  • creates: a file this command creates - if the file exists, the command will not be run.
  • cwd: current working directory to run the command from.
  • flags: command line flags to pass to the interpreter when invoking.
  • environment: A hash of environment variables to set before running this command.
  • user: A user name or user ID that we should change to before running this command.
  • group: A group name or group ID that we should change to before running this command.
  • returns: The return value of the command (may be an array of accepted values). This resource raises an exception if the return value(s) do not match.
  • timeout: How many seconds to let the command run before timing it out.


# change the computer's hostname
powershell "rename hostname" do
  code <<-EOH
  $computer_name = Get-Content env:computername
  $new_name = 'test-hostname'
  $sysInfo = Get-WmiObject -Class Win32_ComputerSystem
# write out to an interpolated path
powershell "write-to-interpolated-path" do
  code <<-EOH
  $stream = [System.IO.StreamWriter] "#{Chef::Config[:file_cache_path]}/powershell-test.txt"
  $stream.WriteLine("In #{Chef::Config[:file_cache_path]}...word.")
# use the change working directory attribute
powershell "cwd-then-write" do
  cwd Chef::Config[:file_cache_path]
  code <<-EOH
  $stream = [System.IO.StreamWriter] "C:/powershell-test2.txt"
  $pwd = pwd
  $stream.WriteLine("This is the contents of: $pwd")
  $dirs = dir
  foreach ($dir in $dirs) {
# cwd to a winodws env variable
powershell "cwd-to-win-env-var" do
  cwd ENV['TEMP']
  code <<-EOH
  $stream = [System.IO.StreamWriter] "./temp-write-from-chef.txt"
  $stream.WriteLine("chef on windows rox yo!")
# pass an env var to script
powershell "read-env-var" do
  cwd Chef::Config[:file_cache_path]
  environment ({'foo' => 'BAZ'})
  code <<-EOH
  $stream = [System.IO.StreamWriter] "./test-read-env-var.txt"
  $stream.WriteLine("FOO is $env:foo")



Mixin to execute powershell commands during compile time. Most useful if needing powershell to drive LWRP behavior.


  • script: The powershell code to execute
  • options: The options hash to drive execution behavior. Same options available as in shell_out, with the addition of :architecture, which allows you to override the default architecture. Essentially allows you to run 32-bit powershell in 64-bit windows.


The following illustrates using options to require 32-bit AND run as a different user

# check if a user is a member of local admins
include Chef::Mixin::PowershellOut
script =<<-EOF
  $user = [Security.Principal.WindowsIdentity]::GetCurrent()
  (New-Object Security.Principal.WindowsPrincipal $user).IsInRole([Security.Principal.WindowsBuiltinRole]::Administrator)
cmd = powershell_out(script, {architecture: :i386, user: "vagrant", password: "vagrant"})


Note: The installation may require a restart of the node being configured before PowerShell can be used.


The default recipe does nothing.


Include the powershell2 recipe in a run list, to ensure PowerShell 2.0 is installed.

On the following versions of Windows the PowerShell 2.0 package will be downloaded from Microsoft and installed:

  • Windows XP
  • Windows Server 2003
  • Windows Server 2008
  • Windows Vista

On the following versions of Windows, PowerShell 2.0 is present and must just be enabled:

  • Windows 7
  • Windows Server 2008 R2
  • Windows Server 2008 R2 Core


Include the powershell3 recipe in a run list, to install PowerShell 3.0 is installed on applicable platforms. If a platform is not supported or if it already includes PowerShell 3.0, an exception will be raised.


Include the powershell4 recipe in a run list, to install PowerShell 4.0 is installed on applicable platforms. If a platform is not supported or if it already includes PowerShell 4.0, an exception will be raised.


License & Authors

Copyright:: 2011-2014, Chef Software, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.

Dependent cookbooks

windows >= 1.2.8
ms_dotnet45 >= 0.0.0
ms_dotnet4 >= 0.0.0
ms_dotnet2 >= 0.0.0

Contingent cookbooks

chocolatey Applicable Versions
chz-firewall Applicable Versions
dsc2 Applicable Versions
filebeat Applicable Versions
helios Applicable Versions
network_interfaces_v2 Applicable Versions
nuget_dsc Applicable Versions
powercli_install Applicable Versions
sitecore Applicable Versions
topbeat Applicable Versions
windows Applicable Versions
winrm Applicable Versions
winstaller Applicable Versions
wsus-client Applicable Versions
wsus-server Applicable Versions

No quality metric results found