Модуль vmware.vmware_rest.vcenter_host_info — возвращает информацию не более чем о 2500 видимых (с учетом проверок разрешений) хостах в vCenter, соответствующих Host.FilterSpec.

Примечание

Этот модуль входит в коллекцию 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_info.

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

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

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

Возвращает информацию не более чем о 2500 видимых (с учетом проверок разрешений) хостах в vCenter, соответствующих Host.FilterSpec.

Требования

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

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

Параметры

Параметр	Комментарии
clusters list / elements=string	Кластеры, в которых должны находиться хосты, чтобы соответствовать фильтру. Если параметр не задан или имеет пустое значение, фильтру соответствуют хосты из любых кластеров, а также хосты, не входящие в кластер. Если это поле не пустое, а значение standalone равно true, фильтру не будет соответствовать ни один хост. Если клиенты передают значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращенного vmware.vmware_rest.vcenter_cluster_info.
connection_states list / elements=string	Состояния подключения, в которых должен находиться хост, чтобы соответствовать фильтру (см. Если параметр не задан или имеет пустое значение, фильтру соответствуют хосты с любым состоянием подключения.
datacenters aliases: filter_datacenters list / elements=string	Центры обработки данных, в которых должны находиться хосты, чтобы соответствовать фильтру. Если параметр не задан или имеет пустое значение, фильтру соответствуют хосты из любых центров обработки данных. Если клиенты передают значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращенного vmware.vmware_rest.vcenter_datacenter_info.
folders aliases: filter_folders list / elements=string	Папки, в которых должны находиться хосты, чтобы соответствовать фильтру. Если параметр не задан или имеет пустое значение, фильтру соответствуют хосты из любых папок. Если клиенты передают значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращенного vmware.vmware_rest.vcenter_folder_info.
hosts list / elements=string	Идентификаторы хостов, которые могут соответствовать фильтру. Если параметр не задан или имеет пустое значение, фильтру соответствуют хосты с любыми идентификаторами. Если клиенты передают значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращенного vmware.vmware_rest.vcenter_host_info.
names aliases: filter_names list / elements=string	Имена, которыми должны называться хосты, чтобы соответствовать фильтру (см. name). Если параметр не задан или имеет пустое значение, фильтру соответствуют хосты с любыми именами.
session_timeout float добавлено в vmware.vmware_rest 2.1.0	Настройки времени ожидания для клиентского сеанса. Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 с.
standalone boolean	Если значение равно true, фильтру могут соответствовать только хосты, не входящие в кластер; если значение равно false, фильтру могут соответствовать только хосты, входящие в кластер. Если параметр не задан, хосты могут соответствовать фильтру независимо от того, входят ли они в кластер. Если это поле имеет значение true, а clusters не пустое, фильтру не будет соответствовать ни один хост. Варианты: `false` `true`
vcenter_hostname string / обязательный	Имя хоста или IP-адрес vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_HOST`.
vcenter_password string / обязательный	Пароль vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PASSWORD`.
vcenter_rest_log_file string	Этот необязательный параметр позволяет указать расположение файла журнала. Этот файл будет использоваться для записи взаимодействия по протоколу HTTP REST. Файл будет сохранен на хосте, на котором выполняется модуль. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_REST_LOG_FILE`.
vcenter_username string / обязательный	Имя пользователя vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_USER`.
vcenter_validate_certs boolean	Разрешает подключение при недействительных SSL-сертификатах. Установите значение `false`, если сертификаты не являются доверенными. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: Get a list of the hosts
  vmware.vmware_rest.vcenter_host_info:
  register: my_hosts

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

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

Ключ	Описание
value list / elements=string	Получить список хостов Возвращается: При успешном выполнении Пример: `[{"connection_state": "CONNECTED", "host": "host-1013", "name": "esxi1.test", "power_state": "POWERED_ON"}]`

Авторы

Команда 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_info_module.html