windows_auto_run

[edit on GitHub]

Use the windows_auto_run resource to set applications to run at login.

New in Chef Client 14.0.

Syntax

This resource has the following syntax:

windows_auto_run 'name' do
  args                       String
  path                       String
  program_name               String # default value: 'name'
  notifies                   # see description
  root                       Symbol
  subscribes                 # see description
  action                     Symbol # defaults to :create if not specified
end

where:

  • windows_auto_run is the resource
  • 'name' is the name of the startup program, or the name of the resource block
  • args, path, program_name, notifies, root, and subscribes are the properties available to this resource

Actions

:create
Create an item to be run at login.
:remove
Remover an item that was previously configured to run at login.
:nothing
Define this resource block to do nothing until notified by another resource to take action. When this resource is notified, this resource block is either run immediately or it is queued up to be run at the end of the Chef Client run.

Properties

args

Ruby Type: String

Any arguments to be used with the program.

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 a notifies statement for each resource to be notified.

A timer specifies the point during the Chef 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 the Chef Client run.
:immediate, :immediately
Specifies that a notification should be run immediately, per resource notified.

The syntax for notifies is:

notifies :action, 'resource[name]', :timer
path

Ruby Type: String

The path to the program that will run at login.

program_name

Ruby Type: String | Default Value: 'name'

The name of the program to run at login, if it differs from the resource block name.

root

Ruby Type: Symbol | Default Value: :machine

The registry root key to put the entry under.

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.

A timer specifies the point during the Chef 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 the Chef Client run.
:immediate, :immediately
Specifies that a notification should be run immediately, per resource notified.

The syntax for subscribes is:

subscribes :action, 'resource[name]', :timer