community.general.ovirt_storage_template_facts – Получение информации об одном или нескольких шаблонах oVirt/RHV, связанных с областью хранения.

Примечание

Этот плагин входит в коллекцию community.general (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.general.

Для использования в книге задач укажите: community.general.ovirt_storage_template_facts.

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

УСТАРЕЛО

Убрано в версии: версия 3.0.0
Почему: При миграции в коллекцию мы решили использовать только модули _info.
Альтернатива: Используйте ovirt.ovirt.ovirt_storage_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`.
max строка		Устанавливает максимальное количество возвращаемых шаблонов. Если не указано, возвращаются все шаблоны.
nested_attributes список / элементы=строка		Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только когда `fetch_nested` равен да.
storage_domain строка		Имя области хранения, в которой должны быть перечислены шаблоны.
unregistered boolean	Варианты: нет ← да	Флаг, указывающий, нужно ли получать не зарегистрированные шаблоны, которые содержат один или несколько дисков, находящихся в области хранения, или шаблоны без дисков.

Примечания

Примечание

Этот модуль возвращает переменную ovirt_storage_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 relate to a storage domain and are unregistered
  ovirt_storage_template_info:
    unregistered: yes
  register: result

- name: Print gathered information
  ansible.builtin.debug:
    msg: "{{ result.ovirt_storage_templates }}"

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

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

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

Статус

Этот модуль будет удален в версии 3.0.0. [устарел]
Дополнительную информацию см. в разделе УСТАРЕЛО.

Авторы

Maor Lipchuk (@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_storage_template_facts_module.html