windows_workgroup resource¶
Use the windows_workgroup resource to join or change the workgroup of a Windows host.
New in Chef Client 14.5.
Syntax¶
The windows_workgroup resource has the following syntax:
windows_workgroup 'name' do
password String
reboot Symbol # default value: immediate
sensitive true, false # default value: true
user String
workgroup_name String # default value: 'name' unless specified
action Symbol # defaults to :join if not specified
end
where:
windows_workgroup
is the resource.name
is the name given to the resource block.action
identifies which steps the chef-client will take to bring the node into the desired state.password
,reboot
,sensitive
,user
, andworkgroup_name
are the properties available to this resource.
Actions¶
The windows_workgroup resource has the following actions:
:join
- Update the workgroup.
: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¶
The windows_workgroup resource has the following properties:
password
Ruby Type: String
The password for the local administrator user.
reboot
Ruby Type: Symbol | Default Value:
immediate
Controls the system reboot behavior post workgroup joining. Reboot immediately, after the Chef run completes, or never. Note that a reboot is necessary for changes to take effect.
sensitive
- Ruby Type: true, false | Default Value:
true
user
Ruby Type: String
The local administrator user to use to change the workgroup.
workgroup_name
Ruby Type: String | Default Value:
'name'
The name of the workgroup for the computer.
Common Resource Functionality¶
Chef resources include common properties, notifications, and resource guards.
Common Properties¶
The following properties are common to every resource:
ignore_failure
Ruby Type: true, false | Default Value:
false
Continue running a recipe if a resource fails for any reason.
retries
Ruby Type: Integer | Default Value:
0
The number of times to catch exceptions and retry the resource.
retry_delay
Ruby Type: Integer | Default Value:
2
The retry delay (in seconds).
sensitive
Ruby Type: true, false | Default Value:
false
Ensure that sensitive resource data is not logged by the chef-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.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]', :timersubscribes
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 endIn this case the
subscribes
property reloads thenginx
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 examplenginx
) 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
Guards¶
A guard property can be used to evaluate the state of a node during the execution phase of the chef-client run. Based on the results of this evaluation, a guard property is then used to tell the chef-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 the chef-client to do nothing.
The following properties can be used to define a guard that is evaluated during the execution phase of the chef-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
.