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 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 (добавлен в 2.3) | Если True, модуль получит дополнительные данные из API. Он получит идентификаторы дисков ВМ, снимков и т. д. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes. | |
| nested_attributes (добавлен в 2.3) | Указывает список атрибутов, которые должны быть получены из API. Этот параметр применим только, если fetch_nested равен true. | |
| poll_interval | По умолчанию: 3 | Количество секунд, которое модуль ожидает до отправки следующего запроса на проверку состояния сущности. |
| snapshot_id | Идентификатор моментального снимка для управления. | |
| state |
| Моментальный снимок виртуальной машины должен быть восстановлен/существующим/отсутствующим. |
| timeout | По умолчанию: 180 | Время в секундах, которое модуль должен ожидать, пока экземпляр не перейдет в нужное состояние. |
| use_memory | Если true и state присутствует, сохранить память виртуальной машины, если она запущена.Если true и state равно восстановление, восстановить память виртуальной машины.Обратите внимание, что виртуальная машина будет приостановлена во время сохранения памяти. | |
| vm_name обязательно | Имя виртуальной машины для управления. | |
| wait |
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_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 строка | При успешном поиске снимка. | Идентификатор управляемого снимка. Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
| snapshot словарь | При успешном поиске снимка. | Словарь всех атрибутов снимка. Атрибуты снимка можно найти на вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/snapshot. |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробнее см. Поддержка и обслуживание модулей.
Список других модулей, поддерживаемых сообществом 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.6/modules/ovirt_snapshots_module.html
