модуль microsoft.ad.membership — управление членством в домене/рабочей группе для узла Windows

Примечание

Этот модуль входит в коллекцию microsoft.ad (версия 1.10.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install microsoft.ad.

Чтобы использовать её в плейбуке, укажите: microsoft.ad.membership.

Краткое описание
Параметры
Атрибуты
Примечания
См. также
Примеры
Возвращаемые значения

Краткое описание

Управляет членством узла Windows в домене или рабочей группе. Также поддерживает изменение имени узла.
Если были внесены изменения, после использования этого модуля может потребоваться выполнить действие ansible.windows.win_reboot.

Примечание

Этому модулю соответствует плагин действия.

Параметры

Параметр	Комментарии
dns_domain_name string	При state=domain это DNS-имя домена, к которому следует присоединить целевой узел Windows. Этот параметр нельзя задать, если указан offline_join_blob.
domain_admin_password string	Пароль указанного `domain_admin_user`. Этот параметр необходимо задать, если не указан offline_join_blob.
domain_admin_user string	Имя пользователя — администратора целевого домена (требуется для присоединения к домену или выхода из него). Этот параметр необходимо задать, если не указан offline_join_blob.
domain_ou_path string	Путь к требуемому подразделению OU для добавления объекта компьютера. Используется только при добавлении целевого узла в домен; если узел уже входит в домен, параметр игнорируется. Этот параметр нельзя задать, если указан offline_join_blob.
domain_server string добавлено в microsoft.ad 1.7.0	Указывает контроллер домена, который будет использоваться при присоединении к домену.
hostname string	Требуемое имя узла Windows. Этот параметр нельзя задать, если указан offline_join_blob.
offline_join_blob string	Строка в формате base64 с данными автономного присоединения к домену, используемая при присоединении узла к домену. Эти данные можно создать с помощью модуля microsoft.ad.offline_join. Этот параметр несовместим с domain_admin_user, dns_domain_name и domain_ou_path. Его также нельзя использовать вместе с hostname.
reboot boolean	Если `true`, узел будет перезагружен, если модулю потребовалась перезагрузка. Если `false`, узел не будет перезагружен, даже если перезагрузка требуется; вместо этого возвращаемому значению reboot_required будет присвоено `true`. Этот параметр нельзя использовать в асинхронном режиме. Варианты: `false` ← (по умолчанию) `true`
reboot_timeout integer добавлено в microsoft.ad 1.7.0	Максимальное время в секундах ожидания повторного появления компьютера после перезагрузки и ответа на тестовую команду. Это время ожидания отдельно отсчитывается для проверки перезагрузки и успешного выполнения тестовой команды, поэтому общее время ожидания может вдвое превышать это значение. По умолчанию: `600`
state string / обязательный	Определяет, должен ли целевой узел входить в домен или рабочую группу. При state=domain необходимо задать dns_domain_name, domain_admin_user и domain_admin_password либо offline_join_blob. При state=workgroup необходимо задать workgroup_name. Варианты: `"domain"` `"workgroup"`
workgroup_name string	При state=workgroup это имя рабочей группы, в которую должен входить узел Windows.

Атрибуты

Атрибут	Поддержка	Описание
action	Поддержка: полная	Указывает, что этому модулю соответствует плагин действия, поэтому некоторые параметры могут обрабатываться на контроллере
async	Поддержка: частичная Поддерживается во всех сценариях, кроме случаев с reboot=True.	Поддерживает использование с ключевым словом `async`
bypass_host_loop	Поддержка: отсутствует	Принудительно запускает «глобальную» задачу, которая выполняется не для каждого узла; при этом пропускаются обработка шаблонов для отдельных узлов, параметры serial, throttle и другие особенности циклов Условные выражения работают так, как если бы использовался `run_once`; переменные берутся из первого доступного узла Это действие обычно не работает вне стратегий lockstep
check_mode	Поддержка: полная	Может выполняться в режиме check_mode и возвращать прогноз изменения состояния без изменения целевого узла; если режим не поддерживается, действие будет пропущено.
diff_mode	Поддержка: полная	В режиме diff возвращает сведения об изменениях (или о том, что может потребоваться изменить в режиме check_mode)
platform	Платформа: windows	Целевые ОС/семейства ОС, для которых предназначен модуль

Примечания

Примечание

Этот модуль необходимо запускать на целевом узле Windows.
Если задано reboot=true и выполняется переход из домена в рабочую группу, для подключения следует использовать локальную учётную запись, которая сможет подключиться к узлу после его выхода из домена. Также убедитесь, что в задаче используется полное имя модуля или что коллекция указана в ключевом слове collections.

См. также

microsoft.ad.domain: Обеспечивает наличие домена Windows.
microsoft.ad.domain_controller: Управление состоянием контроллера домена/сервера-члена для узла Windows.
microsoft.ad.group: Управление объектами групп Active Directory.
microsoft.ad.offline_join: Получение BLOB-данных автономного присоединения к домену.
microsoft.ad.user: Управление пользователями Active Directory.
microsoft.ad.computer: Управление объектами компьютеров Active Directory.
ansible.windows.win_group: Добавление и удаление локальных групп.
ansible.windows.win_group_membership: Управление членством в локальных группах Windows.
ansible.windows.win_user: Управление локальными учётными записями пользователей Windows.
Руководство по миграции: Этот модуль заменяет ansible.windows.win_domain_membership. Подробнее см. в руководстве по миграции.
ansible.windows.win_domain_membership: Официальная документация по модулю ansible.windows.win_domain_membership.

Примеры

- name: join host to ansible.vagrant with automatic reboot
  microsoft.ad.membership:
    dns_domain_name: ansible.vagrant
    hostname: mydomainclient
    domain_admin_user: testguy@ansible.vagrant
    domain_admin_password: password123!
    domain_ou_path: "OU=Windows,OU=Servers,DC=ansible,DC=vagrant"
    state: domain
    reboot: true

- name: join host to workgroup with manual reboot in later task
  microsoft.ad.membership:
    workgroup_name: mywg
    domain_admin_user: '{{ win_domain_admin_user }}'
    domain_admin_password: '{{ win_domain_admin_password }}'
    state: workgroup
  register: workgroup_res

- name: reboot host after joining workgroup
  ansible.windows.win_reboot:
  when: workgroup_res.reboot_required

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
reboot_required boolean	Значение True, если были внесены изменения, требующие перезагрузки. Возвращается: всегда Пример: `true`

Авторы

Matt Davis (@nitzmahone)
Jordan Borean (@jborean93)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/microsoft/ad/membership_module.html