community.general.ovirt_cluster_facts – Получение информации об одном или нескольких кластерах oVirt/RHV
Примечание
Этот плагин входит в коллекцию community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general
Для использования в книге задач укажите: community.general.ovirt_cluster_facts
УСТАРЕВШЕ
- Удалено в
-
версии 3.0.0
- Почему
-
При миграции в коллекцию мы решили использовать только модули _info.
- Альтернатива
-
Используйте ovirt.ovirt.ovirt_cluster_info вместо этого.
Обзор
- Получение информации об одном или нескольких кластерах oVirt/RHV.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth словарь / обязательный | Словарь со значениями, необходимыми для создания подключения HTTP/HTTPS к oVirt: username[обязательный] - Имя пользователя, например, admin@internal. Значение по умолчанию задается переменной среды OVIRT_USERNAME.password[обязательный] - Пароль пользователя. Значение по умолчанию задается переменной среды OVIRT_PASSWORD.url- Строка, содержащая URL API сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию задается переменной среды OVIRT_URL. Требуется либо url, либо hostname. hostname - Строка, содержащая имя хоста сервера, обычно что-то вроде `server.example.com`. Значение по умолчанию задается переменной среды OVIRT_HOSTNAME. Требуется либо url, либо hostname. token - Токен, используемый вместо входа с именем пользователя/паролем. Значение по умолчанию задается переменной среды OVIRT_TOKEN.insecure - Логический флаг, указывающий, следует ли проверять сертификат TLS сервера и имя хоста.ca_file - Файл PEM, содержащий доверенные сертификаты CA. Представленный сервером сертификат будет проверен с помощью этих сертификатов CA. Если параметр `ca_file` не задан, используется системный хранилище сертификатов CA. Значение по умолчанию задается переменной среды OVIRT_CAFILE.kerberos - Логический флаг, указывающий, следует ли использовать аутентификацию Kerberos вместо стандартной аутентификации по имени пользователя/паролю.headers - Словарь HTTP-заголовков, которые необходимо добавить к каждому API-запросу. | |
| fetch_nested логический |
| Если да, модуль получит дополнительные данные из API. Он получит только идентификаторы вложенной сущности. Он не получает несколько уровней вложенных атрибутов. Только атрибуты текущей сущности. Пользователь может настроить запрос других атрибутов вложенных сущностей, указав nested_attributes. |
| nested_attributes список / элементы=строка | Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только когда fetch_nested равен истинно. | |
| pattern строка | Поисковый запрос, который поддерживается поисковым сервером oVirt/RHV. Например, для поиска кластера X из дата-центра Y используйте следующий шаблон: name=X and datacenter=Y |
Примечания
Примечание
- Этот модуль возвращает переменную
ovirt_clusters, которая содержит список кластеров. Вам необходимо зарегистрировать результат с помощью ключевого слова register, чтобы использовать его. - Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: ansible.builtin.pip: name=ovirt-engine-sdk-python version=4.3.0
Примеры
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
- name: Gather information about all clusters which names start with production
ovirt_cluster_info:
pattern:
name: 'production*'
register: result
- name: Print gathered information
ansible.builtin.debug:
msg: "{{ result.ovirt_clusters }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ovirt_clusters список / элементы=строка | При успехе. | Список словарей, описывающих кластеры. Атрибуты кластера отображаются в качестве ключей словаря, все атрибуты кластеров можно найти по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/cluster. |
Статус
- Этот модуль будет удален в версии 3.0.0. [устаревший]
- Для получения дополнительной информации см. УСТАРЕВШЕ.
Авторы
- Ondra Machacek (@machacekondra)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/ovirt_cluster_facts_module.html