ovirt_cluster_facts - Получение фактов о кластерах oVirt/RHV
Новая версия 2.3.
Обзор
- Получение фактов о кластерах oVirt/RHV.
Псевдонимы: ovirt_clusters_facts
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.2.4
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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 (добавлено в 2.3) | Если True, модуль получит дополнительные данные из API. Он получит идентификаторы дисков, снимков и т.д. пользователей. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes. | |
| nested_attributes (добавлено в 2.3) | Указывает список атрибутов, которые должны быть получены из API. Этот параметр применим только если fetch_nested равен true. | |
| pattern | Исковое слово, которое поддерживается поисковым сервером oVirt/RHV. Например, для поиска кластера X в дата-центре Y используйте следующий шаблон: name=X and datacenter=Y |
Примечания
Примечание
- Этот модуль создаёт новый факт верхнего уровня
ovirt_clusters, который содержит список кластеров. - Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.2.4
Примеры
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# Gather facts about all clusters which names start with C<production>:
- ovirt_cluster_facts:
pattern:
name: 'production*'
- debug:
var: ovirt_clusters
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ovirt_clusters список | При успешном выполнении. | Список словарей, описывающих кластеры. Атрибуты кластера сопоставлены с ключами словаря, все атрибуты кластеров можно найти по следующему URL-адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/cluster. |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- Ondřej Machaček (@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.6/modules/ovirt_cluster_facts_module.html