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

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

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

Обзор

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

Псевдонимы: ovirt_snapshots

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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 boolean добавлен в 2.3	Варианты: no yes	Если True, модуль получит дополнительные данные из API. Он получит идентификаторы дисков ВМ, снимков и т. д. Пользователь может настроить получение других атрибутов вложенных сущностей, указав `nested_attributes`.
nested_attributes - добавлен в 2.3		Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только когда `fetch_nested` равен true.
poll_interval -	По умолчанию: 3	Количество секунд, которое модуль ожидает, прежде чем отправить другой запрос о статусе сущности.
snapshot_id -		Идентификатор моментального снимка для управления.
state -	Варианты: restore present ← absent	Моментальный снимок виртуальной машины должен быть restore/present/absent.
timeout -	По умолчанию: 180	Количество секунд, в течение которых модуль должен ждать, пока экземпляр не перейдет в нужное состояние.
use_memory boolean	Варианты: no yes	Если true и `state` является present, сохраняется память виртуальной машины, если она запущена. Если true и `state` является restore, восстанавливается память виртуальной машины. Обратите внимание, что виртуальная машина будет приостановлена во время сохранения памяти. псевдонимы: restore_memory, save_memory
vm_name - / обязательно		Имя виртуальной машины для управления.
wait boolean	Варианты: no yes ←	True, если модуль должен дождаться, пока сущность перейдет в нужное состояние.

Примечания

Примечание

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

Примеры

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

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

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

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

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

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

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

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

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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.7/modules/ovirt_snapshot_module.html