Модуль vmware.vmware_rest.vcenter_cluster_info — получение информации о кластере, соответствующем указанному кластеру.

Примечание

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

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

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

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

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

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

УСТАРЕЛО

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

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

Получение информации о кластере, соответствующем указанному кластеру.

Требования

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

vSphere 7.0.3 или новее
python >= 3.6
aiohttp

Параметры

Параметр	Комментарии
cluster string	Идентификатор кластера. Параметр должен содержать идентификатор ресурса, возвращаемого модулем vmware.vmware_rest.vcenter_cluster_info. Обязателен при state=[‘get’]
clusters list / elements=string	Идентификаторы кластеров, соответствующих фильтру. Если значение не задано или список пуст, фильтру соответствуют кластеры с любыми идентификаторами. При передаче клиентами значения этой структуры в качестве параметра поле должно содержать идентификаторы ресурсов, возвращаемых модулем vmware.vmware_rest.vcenter_cluster_info.
datacenters псевдонимы: filter_datacenters list / elements=string	Центры обработки данных, в которых должен находиться кластер, чтобы он соответствовал фильтру. Если значение не задано или список пуст, фильтру соответствуют кластеры из любых центров обработки данных. При передаче клиентами значения этой структуры в качестве параметра поле должно содержать идентификаторы ресурсов, возвращаемых модулем vmware.vmware_rest.vcenter_datacenter_info.
folders псевдонимы: filter_folders list / elements=string	Папки, в которых должен находиться кластер, чтобы он соответствовал фильтру. Если значение не задано или список пуст, фильтру соответствуют кластеры из любых папок. При передаче клиентами значения этой структуры в качестве параметра поле должно содержать идентификаторы ресурсов, возвращаемых модулем vmware.vmware_rest.vcenter_folder_info.
names псевдонимы: filter_names list / elements=string	Имена, которым должны соответствовать кластеры (см. name). Если значение не задано или список пуст, фильтру соответствуют кластеры с любыми именами.
session_timeout float добавлено в vmware.vmware_rest 2.1.0	Настройки времени ожидания сеанса клиента. Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 с.
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: Build a list of all the clusters
  vmware.vmware_rest.vcenter_cluster_info:
  register: all_the_clusters

- name: Retrieve details about the first cluster
  vmware.vmware_rest.vcenter_cluster_info:
    cluster: '{{ all_the_clusters.value[0].cluster }}'
  register: my_cluster_info

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

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

Ключ	Описание
id string	moid ресурса Возвращается: При успешном выполнении Пример: `"domain-c1006"`
value dictionary	Получение сведений о первом кластере Возвращается: При успешном выполнении Пример: `{"name": "my_cluster", "resource_pool": "resgroup-1007"}`

Статус

Этот модуль будет удалён в версии 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_cluster_info_module.html