Spec-Zone.ru › Ansible

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

Примечание

Этот модуль является частью коллекции 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_host_info.

Новое в vmware.vmware_rest 0.1.0

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

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

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

Требования

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

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

Параметры

Параметр

Комментарии

clusters

список / элементы=строка

Кластеры, которые должны содержать хосты, чтобы хосты соответствовали фильтру.

Если не задано или пусто, хосты в любом кластере и хосты, которые не находятся в кластере, соответствуют фильтру. Если это поле не пустое и standalone имеет значение true, ни один хост не будет соответствовать фильтру.

Когда клиенты передают значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурсов, возвращаемых vmware.vmware_rest.vcenter_cluster_info.

connection_states

список / элементы=строка

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

Если не задано или пусто, хосты в любом состоянии подключения соответствуют фильтру.

datacenters

псевдонимы: filter_datacenters

список / элементы=строка

Центры обработки данных, которые должны содержать хосты, чтобы хосты соответствовали фильтру.

Если не задано или пусто, хосты в любом центре обработки данных соответствуют фильтру.

Когда клиенты передают значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурсов, возвращаемых vmware.vmware_rest.vcenter_datacenter_info.

folders

псевдонимы: filter_folders

список / элементы=строка

Папки, которые должны содержать хосты, чтобы хосты соответствовали фильтру.

Если не задано или пусто, хосты в любой папке соответствуют фильтру.

Когда клиенты передают значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурсов, возвращаемых vmware.vmware_rest.vcenter_folder_info.

hosts

список / элементы=строка

Идентификаторы хостов, которые могут соответствовать фильтру.

Если не задано или пусто, хосты с любым идентификатором соответствуют фильтру.

Когда клиенты передают значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурсов, возвращаемых vmware.vmware_rest.vcenter_host_info.

names

псевдонимы: filter_names

список / элементы=строка

Имена, которые должны иметь хосты, чтобы соответствовать фильтру (см. name).

Если не задано или пусто, хосты с любым именем соответствуют фильтру.

session_timeout

число с плавающей точкой

добавлено в vmware.vmware_rest 2.1.0

Параметры времени ожидания для сеанса клиента.

Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и ответ.

Значение по умолчанию — 300 с.

standalone

логическое

Если true, только хосты, которые не являются частью кластера, могут соответствовать фильтру, а если false, только хосты, которые являются частью кластера, могут соответствовать фильтру.

Если не задано, хосты могут соответствовать фильтру независимо от того, являются ли они частью кластера или нет. Если это поле имеет значение true, а clusters не пусто, ни один хост не будет соответствовать фильтру.

Варианты:

  • false
  • true

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: 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 Team (@ansible-collections)

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

  • Система отслеживания ошибок
  • Домашняя страница
  • Репозиторий (Исходный код)

© 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_host_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API