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

Примечание

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

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

Для установки используйте: ansible-galaxy collection install microsoft.ad.

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

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

Описание

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

Примечание

У этого модуля есть соответствующий плагин действий.

Параметры

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

Атрибуты

Атрибут	Поддержка	Описание
action	Поддержка: полная	Указывает, что у данного атрибута есть соответствующий плагин действий, поэтому некоторые части настроек могут быть выполнены на контроллере
async	Поддержка: частичная Поддерживается во всех сценариях, кроме случаев с reboot=True.	Поддерживает использование со словом-ключом `async`
bypass_host_loop	Поддержка: отсутствует	Принудительно выполняет «глобальную» задачу, которая не выполняется на каждом узле; это обходит шаблон, серию, ограничение скорости и другие соображения по циклам на каждом узле Условные операторы будут работать так, как будто используется `run_once`, переменные будут взяты с первого доступного узла Это действие обычно не работает вне стратегий синхронного выполнения
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: Управление членством в домене/рабочей группе для хоста Windows.

Примеры

- 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/microsoft/ad/membership_module.html