windows_ad_join

[edit on GitHub]

Use the windows_ad_join resource to join a Windows Active Directory domain.

New in Chef Client 14.0.

Syntax

This resource has the following syntax:

windows_ad_join 'name' do
  domain_name                String # default value: 'name'
  domain_password            String # required
  domain_user                String # required
  notifies                   # see description
  ou_path                    String
  reboot                     Symbol # see description
  subscribes                 # see description
  action                     Symbol # defaults to :join if not specified
end

where:

  • windows_ad_join is the resource
  • 'name' is the Active Directory domain name, or the name of the resource block
  • domain_name, domain_password, domain_user, notifies, ou_path, reboot, and subscribes are the properties available to this resource

Actions

:join
Default. Join the Active Directory domain.
: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

domain_name

Ruby Type: String | Default Value: 'name'

The FQDN of the Active Directory domain to join.

domain_password

Ruby Type: String

Required. The password for the domain user. Note that this resource is set to hide sensitive information by default.

domain_user

Ruby Type: String

Required. The domain user that will be used to join the domain.

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
ou_path

Ruby Type: String

The path to the Organizational Unit where the host will be placed.

reboot

Ruby Type: Symbol | Default Value: :immediate

Controls the system reboot behavior after joining the domain, with the following options:

  • :immediate: reboot immediately
  • :delayed: reboot after the Chef Client run completes
  • :never: do not reboot

Note that a reboot is necessary for changes to take effect.

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

Examples

Join a domain

windows_ad_join 'ad.example.org' do
  domain_user 'nick'
  domain_password 'p@ssw0rd1'
end