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

Примечание

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

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

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

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

УСТЕРЕКШЕЕ

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

Примечания

Примечание

Этот модуль возвращает переменную ovirt_snapshots, которая содержит список снимков. Для использования результата необходимо зарегистрировать его с помощью ключевого слова 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 snapshots which description start with update for VM named centos7
  ovirt_snapshot_info:
    vm: centos7
    description: update*
  register: result

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

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

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

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

Статус

Этот модуль будет удален в версии 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_snapshot_facts_module.html