summaryrefslogtreecommitdiff
path: root/lib/chef/resource/powershell_script.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/chef/resource/powershell_script.rb')
-rw-r--r--lib/chef/resource/powershell_script.rb8
1 files changed, 8 insertions, 0 deletions
diff --git a/lib/chef/resource/powershell_script.rb b/lib/chef/resource/powershell_script.rb
index b2bd6e718e..8ff58cfeab 100644
--- a/lib/chef/resource/powershell_script.rb
+++ b/lib/chef/resource/powershell_script.rb
@@ -19,6 +19,14 @@ require "chef/resource/windows_script"
class Chef
class Resource
+ # Use the powershell_script resource to execute a script using the Windows PowerShell interpreter, much like how the
+ # script and script-based resources—bash, csh, perl, python, and ruby—are used. The powershell_script is specific to
+ # the Microsoft Windows platform and the Windows PowerShell interpreter.
+ #
+ # The powershell_script resource creates and executes a temporary file (similar to how the script resource behaves),
+ # rather than running the command inline. Commands that are executed with this resource are (by their nature) not
+ # idempotent, as they are typically unique to the environment in which they are run. Use not_if and only_if to guard
+ # this resource for idempotence.
class PowershellScript < Chef::Resource::WindowsScript
provides :powershell_script, os: "windows"