ovirt_snapshots - Модуль для управления моментальными снимками виртуальных машин в oVirt/RHV
Новая версия 2.3.
- Обзор
- Требования (для хоста, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Модуль для управления моментальными снимками виртуальных машин в oVirt/RHV
Требования (для хоста, на котором выполняется модуль)
- python >= 2.7
- ovirt-engine-sdk-python >= 4.0.0
Параметры
| параметр | обязательный | по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| 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 | нет | present |
| Нужно ли восстановить/сохранить/удалить моментальный снимок виртуальной машины. |
| timeout | нет | 180 | Время в секундах, которое модуль должен ждать, пока экземпляр не перейдет в нужное состояние. | |
| use_memory | нет | Если true и state присутствует, сохраняется память виртуальной машины, если она запущена.Если true и state равно restore, восстанавливается память виртуальной машины.Обратите внимание, что виртуальная машина будет приостановлена во время сохранения памяти. | ||
| vm_name | да | Имя виртуальной машины для управления. | ||
| wait | нет |
True, если модуль должен ждать, пока сущность не перейдет в нужное состояние. |
Примеры
# 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 | Словарь всех атрибутов моментального снимка. Атрибуты моментального снимка можно найти на вашем экземпляре oVirt/RHV по следующему адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/snapshot. | При успехе, если снимок найден. | dict |
Примечания
Примечание
- Обратите внимание, что без гостевого агента данные о созданном моментальном снимке могут быть несогласованными.
- Удаление моментального снимка не удаляет никакой информации из виртуальной машины — это просто удаляет точку возврата. Однако восстановление виртуальной машины из моментального снимка удаляет все содержимое, которое было записано в виртуальную машину после того, как был сделан моментальный снимок.
- Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, вы можете создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.0.0
Статус
Этот модуль помечен как предварительная версия, что означает, что он не гарантирует обратную совместимость интерфейса.
Для получения помощи в разработке модулей, если вы это хотите сделать, пожалуйста, прочтите Информацию о сообществе и участии, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ovirt_snapshots_module.html
