community.vmware.vmware_host_active_directory – Подключает систему хоста ESXi к домену Active Directory или отключает её

Примечание

Этот плагин является частью коллекции community.vmware (версия 1.7.0).

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

Для использования в книге задач укажите: community.vmware.vmware_host_active_directory.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль можно использовать для подключения или отключения хоста ESXi к домену Active Directory.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.6
PyVmomi

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_domain строка		Домен Active Directory для подключения. псевдонимы: domain, domain_name
ad_password строка		Пароль для подключения к домену Active Directory.
ad_state строка	Варианты: present absent ←	Присоединена ли система хоста ESXi к домену Active Directory. псевдонимы: state
ad_user строка		Имя пользователя для подключения к домену Active Directory.
cluster_name строка		Имя кластера, все хосты которого будут использоваться. Этот параметр необходим, если `esxi_hostname` не указан.
esxi_hostname строка		Имя системы хоста, с которой необходимо работать. Этот параметр необходим, если `cluster_name` не указан.
hostname строка		Имя хоста или IP-адрес сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_HOST`. Поддержка переменных среды добавлена в Ansible 2.6.
password строка		Пароль сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PASSWORD`. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: pass, pwd
port целое число	Значение по умолчанию: 443	Номер порта сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PORT`. Поддержка переменных среды добавлена в Ansible 2.6.
proxy_host строка		Адрес прокси, который будет получать все запросы HTTPS и пересылать их. Формат - имя хоста или IP-адрес. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PROXY_HOST`. Эта функция зависит от версии pyvmomi, большей чем v6.7.1.2018.12
proxy_port целое число		Порт HTTP-прокси, который будет получать все запросы HTTPS и пересылать их. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PROXY_PORT`.
username строка		Имя пользователя сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_USER`. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: admin, user
validate_certs логическое значение	Варианты: no yes ←	Разрешает подключение, когда SSL-сертификаты недействительны. Установите в `false` при недоверии к сертификатам. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_VALIDATE_CERTS`. Поддержка переменных среды добавлена в Ansible 2.6. Если установлено `true`, убедитесь, что на данном компьютере установлен Python >= 2.7.9.

Примечания

Примечание

Проверено на vSphere 6.5

Примеры

- name: Join an AD domain
  community.vmware.vmware_host_active_directory:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
    ad_domain: example.local
    ad_user: adjoin
    ad_password: Password123$
    ad_state: present
  delegate_to: localhost

- name: Leave AD domain
  community.vmware.vmware_host_active_directory:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
    ad_state: absent
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
results словарь	всегда	Метаданные о состоянии подключения к домену Active Directory хост-системы. Пример: {'esxi01': {'ad_state': 'present', 'ad_state_current': 'present', 'ad_state_previous': 'absent', 'changed': True, 'domain': 'example.local', 'membership_state': 'ok', 'msg': 'Хост подключен к домену Active Directory'}}

Авторы

Christian Kotte (@ckotte)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/vmware/vmware_host_active_directory_module.html