ovirt_snapshots - Модуль для управления моментальными снимками виртуальных машин в oVirt/RHV

Новое в версии 2.3.

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

Обзор

Модуль для управления моментальными снимками виртуальных машин в oVirt/RHV

Требования

Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.7
ovirt-engine-sdk-python >= 4.2.4

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth обязательно		Словарь со значениями, необходимыми для создания HTTP/HTTPS-соединения с oVirt: `username`[обязательно] - Имя пользователя, например, admin@internal. Значение по умолчанию задается переменной окружения OVIRT_USERNAME. `password`[обязательно] - Пароль пользователя. Значение по умолчанию задается переменной окружения OVIRT_PASSWORD. `url`[обязательно] - Строка, содержащая базовый URL сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию задается переменной окружения OVIRT_URL. `token` - Токен, используемый вместо входа с именем пользователя/паролем. Значение по умолчанию задается переменной окружения OVIRT_TOKEN. `insecure` - Флаговый параметр, указывающий, следует ли проверять сертификат TLS сервера и имя хоста. `ca_file` - PEM-файл, содержащий доверенные сертификаты CA. Сертификат, представленный сервером, будет проверен с помощью этих сертификатов CA. Если параметр ``ca_file`` не задан, используется системное хранилище сертификатов CA. Значение по умолчанию задается переменной окружения OVIRT_CAFILE. `kerberos` - Флаговый параметр, указывающий, следует ли использовать аутентификацию Kerberos вместо стандартной аутентификации. `headers` - Словарь HTTP-заголовков, которые должны быть добавлены к каждому API-запросу.
description		Описание моментального снимка.
fetch_nested (добавлено в 2.3)		Если True, модуль получит дополнительные данные из API. Будут получены идентификаторы дисков ВМ, снимков и т. д. Пользователь может настроить получение других атрибутов вложенных сущностей, указав `nested_attributes`.
nested_attributes (добавлено в 2.3)		Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только когда `fetch_nested` равен true.
poll_interval	Значение по умолчанию: 3	Количество секунд, которое модуль ожидает, прежде чем отправить другой запрос опроса о состоянии сущности.
snapshot_id		Идентификатор моментального снимка для управления.
state	Варианты: restore present ← absent	Нужно ли восстановить/сохранить/удалить моментальный снимок виртуальной машины.
timeout	Значение по умолчанию: 180	Количество секунд, которое модуль должен ждать, пока экземпляр не перейдет в нужное состояние.
use_memory		Если true и `state` присутствует, сохраняет память виртуальной машины, если она запущена. Если true и `state` равно restore, восстанавливает память виртуальной машины. Обратите внимание, что виртуальная машина будет приостановлена при сохранении памяти.
vm_name обязательно		Имя виртуальной машины для управления.
wait		True, если модуль должен ожидать, пока сущность не перейдет в нужное состояние.

Примечания

Примечание

Обратите внимание, что без агента гостевой системы данные на созданном снимке могут быть несогласованными.
Удаление снимка не удаляет никакую информацию из виртуальной машины — это просто удаляет точку возврата. Однако восстановление виртуальной машины из снимка удаляет любой контент, который был записан в виртуальную машину после того, как был сделан снимок.
Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.0.0

Примеры

# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:

# Create snapshot:
- ovirt_snapshots:
    vm_name: rhel7
    description: MySnapshot
  register: snapshot

# Create snapshot and save memory:
- ovirt_snapshots:
    vm_name: rhel7
    description: SnapWithMem
    use_memory: true
  register: snapshot

# Restore snapshot:
- ovirt_snapshots:
    state: restore
    vm_name: rhel7
    snapshot_id: "{{ snapshot.id }}"

# Remove snapshot:
- ovirt_snapshots:
    state: absent
    vm_name: rhel7
    snapshot_id: "{{ snapshot.id }}"

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

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

Ключ	Возвращаемое значение	Описание
id str	При успехе, если снимок найден.	Идентификатор снимка, который управляется Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c
snapshot dict	При успехе, если снимок найден.	Словарь всех атрибутов снимка. Атрибуты снимка можно найти на вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/snapshot.

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Автор

Ondra Machacek (@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.5/modules/ovirt_snapshots_module.html