chef_client_scheduled_task Resource
This page is generated from the Chef Infra Client source code.To suggest a change, edit the chef_client_scheduled_task.rb file and submit a pull request to the Chef Infra Client repository.
Use the chef_client_scheduled_task resource to setup the Chef Infra Client to run as a Windows scheduled task. This resource will also create the specified log directory if it doesn’t already exist.
New in Chef Infra Client 16.0.
Syntax
The full syntax for all of the properties that are available to the chef_client_scheduled_task resource is:
chef_client_scheduled_task 'name' do
accept_chef_license true, false # default value: false
chef_binary_path String # default value: "C:/opscode/chef/bin/chef-client"
config_directory String # default value: "/etc/chef"
daemon_options Array # default value: []
frequency String # default value: "minute"
frequency_modifier Integer, String # default value: "30 if frequency is 'minute', 1 otherwise"
log_directory String # default value: "CONFIG_DIRECTORY/log"
log_file_name String # default value: "client.log"
password String
priority Integer # default value: 7
run_on_battery true, false # default value: true
splay Integer, String # default value: 300
start_date String
start_time String
task_name String # default value: "chef-client"
use_consistent_splay true, false # default value: false
user String # default value: "System"
action Symbol # defaults to :add if not specified
end
where:
chef_client_scheduled_task
is the resource.name
is the name given to the resource block.action
identifies which steps Chef Infra Client will take to bring the node into the desired state.accept_chef_license
,chef_binary_path
,config_directory
,daemon_options
,frequency
,frequency_modifier
,log_directory
,log_file_name
,password
,priority
,run_on_battery
,splay
,start_date
,start_time
,task_name
,use_consistent_splay
, anduser
are the properties available to this resource.
Actions
The chef_client_scheduled_task resource has the following actions:
:add
- Add a Windows Scheduled Task that runs Chef Infra Client. (default)
:nothing
- This resource block does not act unless notified by another resource to take action. Once notified, this resource block either runs immediately or is queued up to run at the end of a Chef Infra Client run.
:remove
- Remove a Windows Scheduled Task that runs Chef Infra Client.
Properties
The chef_client_scheduled_task resource has the following properties:
accept_chef_license
- Ruby Type: true, false | Default Value:
false
Accept the Chef Online Master License and Services Agreement. See https://www.chef.io/online-master-agreement
chef_binary_path
- Ruby Type: String | Default Value:
C:/opscode/chef/bin/chef-client
The path to the chef-client binary.
config_directory
- Ruby Type: String | Default Value:
/etc/chef
The path of the config directory.
daemon_options
- Ruby Type: Array | Default Value:
[]
An array of options to pass to the chef-client command.
frequency
- Ruby Type: String | Default Value:
minute
Allowed Values:"daily", "hourly", "minute", "monthly", "on_idle", "on_logon", "once", "onstart"
Frequency with which to run the task.
frequency_modifier
- Ruby Type: Integer, String | Default Value:
30 if frequency is 'minute', 1 otherwise
Numeric value to go with the scheduled task frequency
log_directory
- Ruby Type: String | Default Value:
CONFIG_DIRECTORY/log
The path of the directory to create the log file in.
log_file_name
- Ruby Type: String | Default Value:
client.log
The name of the log file to use.
password
- Ruby Type: String
The password for the user that Chef Infra Client runs as.
priority
- Ruby Type: Integer | Default Value:
7
Use to set Priority Levels range from 0 to 10.
New in Chef Infra Client 17.5
run_on_battery
- Ruby Type: true, false | Default Value:
true
Run the Chef Infra Client task when the system is on batteries.
splay
- Ruby Type: Integer, String | Default Value:
300
A random number of seconds between 0 and X to add to interval so that all chef-client commands don’t execute at the same time.
start_date
- Ruby Type: String
The start date for the task in m:d:Y format (ex: 12/17/2020).
start_time
- Ruby Type: String
The start time for the task in HH:mm format (ex: 14:00). If the frequency is minute default start time will be Time.now plus the frequency_modifier number of minutes.
task_name
- Ruby Type: String | Default Value:
chef-client
The name of the scheduled task to create.
use_consistent_splay
- Ruby Type: true, false | Default Value:
false
Always use the same random splay amount for each node to ensure consistent frequencies between chef-client execution.
New in Chef Infra Client 17.5
user
- Ruby Type: String | Default Value:
System
The name of the user that Chef Infra Client runs as.
Common Resource Functionality
Chef resources include common properties, notifications, and resource guards.
Common Properties
The following properties are common to every resource:
compile_time
Ruby Type: true, false | Default Value:
false
Control the phase during which the resource is run on the node. Set to true to run while the resource collection is being built (the
compile phase
). Set to false to run while Chef Infra Client is configuring the node (theconverge phase
).ignore_failure
Ruby Type: true, false, :quiet | Default Value:
false
Continue running a recipe if a resource fails for any reason.
:quiet
will not display the full stack trace and the recipe will continue to run if a resource fails.retries
Ruby Type: Integer | Default Value:
0
The number of attempts to catch exceptions and retry the resource.
retry_delay
Ruby Type: Integer | Default Value:
2
The delay in seconds between retry attempts.
sensitive
Ruby Type: true, false | Default Value:
false
Ensure that sensitive resource data is not logged by Chef Infra Client.
Notifications
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 notify more than one resource; use anotifies
statement for each resource to be notified.If the referenced resource does not exist, an error is raised. In contrast,
subscribes
will not fail if the source resource is not found.
A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:
:before
Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.
:delayed
Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.
:immediate
,:immediately
Specifies that a notification should be run immediately, for each resource notified.
The syntax for notifies
is:
notifies :action, 'resource[name]', :timer
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.
Note that subscribes
does not apply the specified action to the
resource that it listens to - for example:
file '/etc/nginx/ssl/example.crt' do
mode '0600'
owner 'root'
end
service 'nginx' do
subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately
end
In this case the subscribes
property reloads the nginx
service
whenever its certificate file, located under
/etc/nginx/ssl/example.crt
, is updated. subscribes
does not make any
changes to the certificate file itself, it merely listens for a change
to the file, and executes the :reload
action for its resource (in this
example nginx
) when a change is detected.
If the other resource does not exist, the subscription will not raise an
error. Contrast this with the stricter semantics of notifies
, which
will raise an error if the other resource does not exist.
A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:
:before
Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.
:delayed
Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.
:immediate
,:immediately
Specifies that a notification should be run immediately, for each resource notified.
The syntax for subscribes
is:
subscribes :action, 'resource[name]', :timer
Guards
A guard property can be used to evaluate the state of a node during the execution phase of a Chef Infra Client run. Based on the results of this evaluation, a guard property is then used to tell Chef Infra Client if it should continue executing a resource. A guard property accepts either a string value or a Ruby block value:
- A string is executed as a shell command. If the command returns
0
, the guard is applied. If the command returns any other value, then the guard property is not applied. String guards in a powershell_script run Windows PowerShell commands and may returntrue
in addition to0
. - A block is executed as Ruby code that must return either
true
orfalse
. If the block returnstrue
, the guard property is applied. If the block returnsfalse
, the guard property is not applied.
A guard property is useful for ensuring that a resource is idempotent by allowing that resource to test for the desired state as it is being executed, and then if the desired state is present, for Chef Infra Client to do nothing.
PropertiesThe following properties can be used to define a guard that is evaluated during the execution phase of a Chef Infra Client run:
not_if
Prevent a resource from executing when the condition returns
true
.only_if
Allow a resource to execute only if the condition returns
true
.
Examples
The following examples demonstrate various approaches for using the chef_client_scheduled_task resource in recipes:
Setup Chef Infra Client to run using the default 30 minute cadence:
chef_client_scheduled_task 'Run Chef Infra Client as a scheduled task'
Run Chef Infra Client on system start:
chef_client_scheduled_task 'Chef Infra Client on start' do
frequency 'onstart'
end
Run Chef Infra Client with extra options passed to the client:
chef_client_scheduled_task 'Run an override recipe' do
daemon_options ['--override-runlist mycorp_base::default']
end
Run Chef Infra Client daily at 01:00 am, specifying a named run-list:
chef_client_scheduled_task 'Run chef-client named run-list daily' do
frequency 'daily'
start_time '01:00'
daemon_options ['-n audit_only']
end
Run Chef Infra Client with a persistent delay on every run calculated once, similar to how chef_client_cron resource works:
chef_client_scheduled_task 'Run chef-client with persistent splay' do
use_consistent_splay true
end