Ресурс windows_ad_join

Редактировать эту страницу в репозитории Chef

Страница справочника ресурсов

Используйте ресурс 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
  sensitive            true, false # default value: true
  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, sensitive, и 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

sensitive

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

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 InfraClient.

Уведомления

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]', действие, которое должно быть выполнено, и :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