модуль vmware.vmware_rest.vcenter_host — добавление нового автономного хоста в инвентарь vCenter

Примечание

Этот модуль входит в состав коллекции vmware.vmware_rest (версия 4.10.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install vmware.vmware_rest. Для использования этого модуля необходимы дополнительные требования; подробную информацию см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: vmware.vmware_rest.vcenter_host.

Добавлено в vmware.vmware_rest 0.1.0

УСТАРЕЛО
Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

УСТАРЕЛО

Удалён в:: версии 5.0.0
Причина:: Этот модуль перенесён в новую коллекцию vmware.vmware
Альтернатива:: Вместо него используйте vmware.vmware.esxi_host.

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

Добавление нового автономного хоста в инвентарь vCenter. Новый подключённый хост будет находиться в состоянии «подключён». Перед добавлением хоста в инвентарь сервер vCenter проверит SSL-сертификат. Если проверка SSL-сертификата невозможна, поскольку центр сертификации не распознан или сертификат является самоподписанным, сервер vCenter перейдёт в режим проверки отпечатка, определённый параметром Host.CreateSpec.ThumbprintVerification.

Требования

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

vSphere 7.0.3 или более поздней версии
python >= 3.6
aiohttp

Параметры

Параметр	Комментарии
folder строка	Папка хостов и кластеров, в которой следует создать новый автономный хост. В настоящее время это поле является обязательным. В будущем, если это поле не будет задано, система попытается выбрать подходящую папку для хоста; если выбрать папку не удастся, операция создания хоста завершится ошибкой. При передаче клиентами значения этой структуры в качестве параметра в поле должен быть указан идентификатор ресурса, возвращённого модулем vmware.vmware_rest.vcenter_folder_info.
force_add логическое значение	Следует ли добавлять хост на сервер vCenter, даже если им управляет другой сервер vCenter. Исходный сервер vCenter потеряет подключение к хосту. Если параметр не задан, значение forceAdd по умолчанию равно false. Варианты: `false` `true`
host строка	Идентификатор отключаемого хоста. В параметре должен быть указан идентификатор ресурса, возвращённого модулем vmware.vmware_rest.vcenter_host_info. Обязателен при state=[‘absent’, ‘connect’, ‘disconnect’]
hostname строка	IP-адрес или разрешаемое через DNS имя хоста. Обязателен при state=[‘present’]
password строка	Пароль учётной записи администратора на хосте. Обязателен при state=[‘present’]
port целое число	Порт хоста. Если параметр не задан, будет использоваться порт 443.
session_timeout число с плавающей точкой добавлено в vmware.vmware_rest 2.1.0	Настройки времени ожидания сеанса клиента. Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 с.
state строка	Варианты: `"absent"` `"connect"` `"disconnect"` `"present"` ← (по умолчанию)
thumbprint строка	Отпечаток SSL-сертификата, который должен быть у хоста. Отпечаток всегда вычисляется с использованием хеша SHA1 и представляет собой строковое представление этого хеша в формате: xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx, где «x» обозначает шестнадцатеричную цифру. Это поле необязательно и учитывается только тогда, когда значение thumbprint_verification равно THUMBPRINT.
thumbprint_verification строка	Перечисляемый тип thumbprint_verification задаёт способы проверки отпечатка SSL-сертификата хоста. Обязателен при state=[‘present’] Варианты: `"NONE"` `"THUMBPRINT"`
user_name строка	Учётная запись администратора на хосте. Обязателен при state=[‘present’]
vcenter_hostname строка / обязательно	Имя хоста или IP-адрес vSphere vCenter Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_HOST`.
vcenter_password строка / обязательно	Пароль vSphere vCenter Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PASSWORD`.
vcenter_rest_log_file строка	С помощью этого необязательного параметра можно задать расположение файла журнала. Этот файл будет использоваться для записи взаимодействия по HTTP REST. Файл будет сохранён на хосте, на котором выполняется модуль. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_REST_LOG_FILE`.
vcenter_username строка / обязательно	Имя пользователя vSphere vCenter Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_USER`.
vcenter_validate_certs логическое значение	Разрешает подключение, если SSL-сертификаты недействительны. Если сертификатам не доверяют, задайте значение `false`. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: Connect the host(s)
  vmware.vmware_rest.vcenter_host:
    hostname: "{{ lookup('env', 'ESXI1_HOSTNAME') }}"
    user_name: "{{ lookup('env', 'ESXI1_USERNAME') }}"
    password: "{{ lookup('env', 'ESXI1_PASSWORD') }}"
    thumbprint_verification: NONE
    folder: '{{ my_host_folder.folder }}'

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

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

Ключ	Описание
value строка	Подключение хоста (хостов) Возвращается: при успешном выполнении Пример: `"host-1013"`

Статус

Этот модуль будет удалён в версии 5.0.0. [устарело]
Дополнительную информацию см. в разделе УСТАРЕЛО.

Авторы

Команда Ansible Cloud (@ansible-collections)

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

© 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/vmware/vmware_rest/vcenter_host_module.html