community.general.ovirt_cluster_facts – Получение информации об одном или нескольких кластерах oVirt/RHV
Примечание
Этот плагин является частью коллекции community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в playbook укажите: 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 boolean |
| Если да, модуль получит дополнительные данные из 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/ovirt_cluster_facts_module.html