summaryrefslogtreecommitdiff
path: root/lib/chef/resource/execute.rb
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2018-09-06 15:14:24 -0700
committerTim Smith <tsmith@chef.io>2018-09-06 15:38:31 -0700
commit990cca06ffee547aeda6a543e3cbf256f0b32bce (patch)
tree6d303ed79e59e8847d9cd241a4b2a011abafdb32 /lib/chef/resource/execute.rb
parent1f2bd56d781868cd259b71ce56e6b9bc992f0bea (diff)
downloadchef-990cca06ffee547aeda6a543e3cbf256f0b32bce.tar.gz
Add additional resource descriptions
Filling in more of the missing resource descriptions using the descriptions straight from the docs site. Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef/resource/execute.rb')
-rw-r--r--lib/chef/resource/execute.rb5
1 files changed, 4 insertions, 1 deletions
diff --git a/lib/chef/resource/execute.rb b/lib/chef/resource/execute.rb
index 93f8063d5d..1becbf50a7 100644
--- a/lib/chef/resource/execute.rb
+++ b/lib/chef/resource/execute.rb
@@ -98,9 +98,12 @@ class Chef
description: "Windows only: The password of the user specified by the user property. This property is mandatory if user is specified on Windows and may only be specified if user is specified. The sensitive property for this resource will automatically be set to true if password is specified."
# lazy used to set default value of sensitive to true if password is set
- property :sensitive, [ TrueClass, FalseClass ], default: lazy { |r| r.password ? true : false }
+ property :sensitive, [ TrueClass, FalseClass ],
+ description: "Ensure that sensitive resource data is not logged by the chef-client.",
+ default: lazy { |r| r.password ? true : false }
property :elevated, [ TrueClass, FalseClass ], default: false,
+ description: "Determines whether the script will run with elevated permissions to circumvent User Access Control (UAC) interactively blocking the process.\nThis will cause the process to be run under a batch login instead of an interactive login. The user running Chef needs the “Replace a process level token” and “Adjust Memory Quotas for a process” permissions. The user that is running the command needs the “Log on as a batch job” permission.\nBecause this requires a login, the user and password properties are required.",
introduced: "13.3"
def self.set_guard_inherited_attributes(*inherited_attributes)