ovirt_cluster_info – Получение информации об одном или нескольких кластерах oVirt/RHV

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

Получение информации об одном или нескольких кластерах oVirt/RHV.
Этот модуль назывался ovirt_cluster_facts до Ansible 2.9, возвращая ansible_facts. Обратите внимание, что модуль ovirt_cluster_info больше не возвращает ansible_facts!

Псевдонимы: ovirt_cluster_facts

Требования

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

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` равен true.
pattern -		Поисковый запрос, который принимается поисковым бэкэндом oVirt/RHV. Например, для поиска кластера X из дата-центра Y используйте следующий шаблон: name=X and datacenter=Y

Примечания

Примечание

Этот модуль возвращает переменную ovirt_clusters, которая содержит список кластеров. Вам нужно зарегистрировать результат с помощью ключевого слова register, чтобы использовать его.
Для использования этого модуля необходимо установить oVirt Python SDK. Для обеспечения установки с правильной версией можно создать следующую задачу: 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:

# Gather information about all clusters which names start with C<production>:
- ovirt_cluster_info:
    pattern:
      name: 'production*'
  register: result
- debug:
    msg: "{{ result.ovirt_clusters }}"

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

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

Ключ	Возвращаемое значение	Описание
ovirt_clusters список	При успехе.	Список словарей, описывающих кластеры. Атрибуты кластера сопоставлены с ключами словаря, все атрибуты кластеров можно найти по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/cluster.

Статус

Гарантируется, что у этого модуля не будет обратной совместимости. [preview]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.9/modules/ovirt_cluster_info_module.html