community.general.ovirt_template_facts – Получение информации об одном или нескольких шаблонах oVirt/RHV
Примечание
Этот плагин входит в состав коллекции community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general
Для использования в плейбуке укажите: community.general.ovirt_template_facts
УСТЕРЕЛО
- Удалено в
-
версии 3.0.0
- Почему
-
При миграции в коллекцию было решено использовать только модули _info.
- Альтернатива
-
Используйте ovirt.ovirt.ovirt_template_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 равно true. | |
| pattern строка | Поисковый термин, который принимается бэкендом поиска oVirt/RHV. Например, для поиска шаблона X из центров данных Y используйте следующий шаблон: name=X and datacenter=Y |
Примечания
Примечание
- Этот модуль возвращает переменную
ovirt_templates, которая содержит список шаблонов. Для использования результата необходимо зарегистрировать его с помощью ключевого слова 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 templates which names start with centos and belongs to data center west
ovirt_template_info:
pattern: name=centos* and datacenter=west
register: result
- name: Print gathered information
ansible.builtin.debug:
msg: "{{ result.ovirt_templates }}"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ovirt_templates список / элементы=строка | При успехе. | Список словарей, описывающих шаблоны. Атрибуты шаблона сопоставлены с ключами словаря, все атрибуты шаблонов можно найти по следующему адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/template. |
Статус
- Этот модуль будет удален в версии 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_template_facts_module.html