Ресурс windows_ad_join

Изменить эту страницу в репозитории Chef

Все страницы ресурсов Infra

Используйте ресурс windows_ad_join для присоединения к домену Windows Active Directory.

Новое в Chef Infra Client 14.0.

Синтаксис

Полный синтаксис всех свойств, доступных для ресурса windows_ad_join:

windows_ad_join 'name' do
  domain_name          String # default value: 'name' unless specified
  domain_password      String
  domain_user          String
  new_hostname         String
  ou_path              String
  reboot               Symbol # default value: :immediate
  reboot_delay         Integer # default value: 0
  workgroup_name       String
  action               Symbol # defaults to :join if not specified
end

где:

• windows_ad_join — это ресурс.
• name — это имя, заданное для блока ресурса.
• action определяет действия, которые Chef Infra Client предпримет, чтобы привести узел в желаемое состояние.
• domain_name, domain_password, domain_user, new_hostname, ou_path, reboot, reboot_delay, и workgroup_name — это доступные свойства для данного ресурса.

Действия

Ресурс windows_ad_join имеет следующие действия:

:join

Присоединение к домену Active Directory. (по умолчанию)

:leave

Выход из домена Active Directory и повторное подключение к рабочей группе.

:nothing

Этот блок ресурса не выполняет никаких действий, пока не получит уведомление от другого ресурса о необходимости выполнить действие. После получения уведомления этот блок ресурса либо выполняется немедленно, либо ставится в очередь для выполнения в конце выполнения Chef Infra Client.

Свойства

Ресурс windows_ad_join имеет следующие свойства:

domain_name

Тип Ruby: Строка | Значение по умолчанию: The resource block's name

Необязательное свойство для установки FQDN домена Active Directory для присоединения, если оно отличается от имени блока ресурса.

domain_password

Тип Ruby: Строка | REQUIRED

Пароль пользователя домена. Обратите внимание, что по умолчанию этот ресурс настроен на скрытие конфиденциальной информации.

domain_user

Тип Ruby: Строка | REQUIRED

Пользователь домена, который будет использоваться для присоединения к домену.

new_hostname

Тип Ruby: Строка

Указывает новое имя хоста в новом домене.

Новое в Chef Client 14.5

ou_path

Тип Ruby: Строка

Путь к организационной единице, где будет размещен хост.

reboot

Тип Ruby: Символ | Значение по умолчанию: :immediate Допустимые значения: :delayed, :immediate, :never, :reboot_now, :request_reboot

Управляет поведением перезагрузки системы после присоединения к домену. Немедленная перезагрузка, после завершения выполнения Chef Infra Client или никогда. Обратите внимание, что перезагрузка необходима для вступления изменений в силу.

reboot_delay

Тип Ruby: Целое число | Значение по умолчанию: 0

Время ожидания (в минутах) перед запросом перезагрузки.

Новое в Chef Infra Client 16.5

workgroup_name

Тип Ruby: Строка

Указывает имя рабочей группы, к которой компьютер добавляется при удалении из домена. Значение по умолчанию — WORKGROUP. Это свойство применимо только к действию :leave.

Новое в Chef Infra Client 15.4

Общие функциональные возможности ресурсов

Ресурсы Chef включают общие свойства, уведомления и защитные механизмы ресурсов.

Общие свойства

Следующие свойства являются общими для всех ресурсов:

compile_time

Тип Ruby: true, false | Значение по умолчанию: false

Управляет фазой, в которой ресурс выполняется на узле. Установите значение true, чтобы запустить ресурс во время построения коллекции ресурсов (compile phase). Установите значение false, чтобы запустить ресурс во время конфигурирования узла Chef Infra Client (converge phase).

ignore_failure

Тип Ruby: true, false, :quiet | Значение по умолчанию: false

Продолжать выполнение рецепта, если ресурс завершился ошибкой по какой-либо причине. :quiet не отобразит полный стек вызовов, и рецепт продолжит выполнение, если ресурс завершится ошибкой.

retries

Тип Ruby: Целое число | Значение по умолчанию: 0

Количество попыток перехватить исключения и повторить ресурс.

retry_delay

Тип Ruby: Целое число | Значение по умолчанию: 2

Задержка в секундах между попытками повтора.

sensitive

Тип Ruby: true, false | Значение по умолчанию: false

Обеспечить, чтобы конфиденциальные данные ресурса не регистрировались Chef Infra Client.

Уведомления

notifies

Тип Ruby: Символ, 'Chef::Resource[String]'

Ресурс может уведомить другой ресурс о действии при изменении его состояния. Укажите 'resource[name]', :action действие, которое должен выполнить ресурс, и затем :timer для этого действия. Один ресурс может уведомить о действиях более одного ресурса; используйте инструкцию notifies для каждого уведомляемого ресурса.

Если указанный ресурс не существует, возникает ошибка. В отличие от этого, subscribes не потерпит неудачу, если исходный ресурс не найден.

Таймер определяет момент во время выполнения Chef Infra Client, когда выполняется уведомление. Доступны следующие таймеры:

:before

Указывает, что действие над уведомленным ресурсом должно выполняться до обработки блока ресурса, в котором расположено уведомление.

:delayed

По умолчанию. Указывает, что уведомление должно быть поставлено в очередь и выполнено в конце выполнения Chef Infra Client.

:immediate, :immediately

Указывает, что уведомление должно быть выполнено немедленно для каждого уведомленного ресурса.

Синтаксис notifies:

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

subscribes

Тип Ruby: Символ, 'Chef::Resource[String]'

Ресурс может прослушивать другой ресурс и выполнять действие, если состояние прослушиваемого ресурса изменится. Укажите 'resource[name]', :action действие, которое должно быть выполнено, и затем :timer для этого действия.

Обратите внимание, что subscribes не применяет указанное действие к ресурсу, который он прослушивает — например:

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

В этом случае свойство subscribes перезагружает службу nginx всякий раз, когда файл сертификата, расположенный по пути /etc/nginx/ssl/example.crt, обновляется. subscribes не вносит никаких изменений в сам файл сертификата, а просто прослушивает изменения в файле и выполняет действие :reload для своего ресурса (в этом примере nginx) при обнаружении изменений.

Если другой ресурс не существует, подписка не вызовет ошибку. В отличие от более строгих семантик notifies, которые вызовут ошибку, если другой ресурс не существует.

Таймер определяет момент во время выполнения Chef Infra Client, когда выполняется уведомление. Доступны следующие таймеры:

:before

Указывает, что действие над уведомленным ресурсом должно выполняться до обработки блока ресурса, в котором расположено уведомление.

:delayed

По умолчанию. Указывает, что уведомление должно быть поставлено в очередь и выполнено в конце выполнения Chef Infra Client.

:immediate, :immediately

Указывает, что уведомление должно быть выполнено немедленно для каждого уведомленного ресурса.

Синтаксис subscribes:

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

Защитные механизмы

Свойство защитного механизма может использоваться для оценки состояния узла во время фазы выполнения Chef Infra Client. На основании результатов этой оценки свойство защитного механизма используется, чтобы указать Chef Infra Client, продолжать ли выполнение ресурса. Свойство защитного механизма принимает значение типа строка или Ruby-блок:

• Строка выполняется как команда оболочки. Если команда возвращает 0, защитный механизм применяется. Если команда возвращает любое другое значение, свойство защитного механизма не применяется. Строковые защитные механизмы в powershell_script выполняют команды Windows PowerShell и могут возвращать true в дополнение к 0.
• Блок выполняется как Ruby-код, который должен возвращать либо true или false. Если блок возвращает true, свойство защитного механизма применяется. Если блок возвращает false, свойство защитного механизма не применяется.

Свойство защитного механизма полезно для обеспечения идемпотентности ресурса, позволяя этому ресурсу проверять желаемое состояние во время его выполнения, а затем, если желаемое состояние присутствует, не предпринимать никаких действий Chef Infra Client.

Следующие свойства могут использоваться для определения защитного механизма, который оценивается во время фазы выполнения Chef Infra Client:

not_if

Препятствует выполнению ресурса, когда условие возвращает true.

only_if

Разрешает выполнение ресурса только в том случае, если условие возвращает true.

Примеры

Следующие примеры демонстрируют различные подходы к использованию ресурса windows_ad_join в рецептах:

Присоединение к домену

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

Присоединение к домену как win-workstation

windows_ad_join 'ad.example.org' do
  domain_user 'nick'
  domain_password 'p@ssw0rd1'
  new_hostname 'win-workstation'
end

Выход из текущего домена и повторное присоединение к рабочей группе local

windows_ad_join 'Leave domain' do
  action :leave
  workgroup 'local'
end