Модуль vmware.vmware_rest.vcenter_cluster_info – Получение информации о кластере, соответствующем кластеру.
Примечание
Этот модуль является частью коллекции vmware.vmware_rest (версия 3.2.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install vmware.vmware_rest. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.
Для использования в playbook, укажите: vmware.vmware_rest.vcenter_cluster_info.
Новое в vmware.vmware_rest 0.1.0
Краткое описание
- Получает информацию о кластере, соответствующем кластеру.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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 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. |
names aliases: filter_names list / elements=string | Имена, которые должны иметь кластеры, чтобы соответствовать фильтру (см. name). Если не указано или пусто, кластеры с любым именем соответствуют фильтру. |
session_timeout float добавлено в vmware.vmware_rest 2.1.0 | Параметры времени ожидания для сеанса клиента. Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и ответ. Значение по умолчанию — 300 с. |
vcenter_hostname string / required | Имя хоста или IP-адрес vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_password string / required | Пароль vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_rest_log_file string | Вы можете использовать этот необязательный параметр для установки местоположения файла журнала. Этот файл будет использоваться для записи взаимодействия HTTP REST. Файл будет храниться на хосте, на котором запущен модуль. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_username string / required | Имя пользователя vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_validate_certs boolean | Разрешает подключение, когда SSL-сертификаты недействительны. Установите в Если значение не указано в задаче, вместо него будет использовано значение переменной среды Варианты:
|
Примечания
Примечание
- Тестировалось на 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 строка | moid ресурса Возвращается: При успехе Пример: |
value словарь | Получение подробностей о первом кластере Возвращается: При успехе Пример: |
Ссылки на сборку
© 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/vmware/vmware_rest/vcenter_cluster_info_module.html