Spec-Zone.ru › Ansible 2.9

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

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

Обзор

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

Требования

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

  • python >= 2.7
  • ovirt-engine-sdk-python >= 4.3.0

Параметры

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

псевдонимы: restore_memory, save_memory
vm_name
- / обязательно
Имя виртуальной машины, подлежащей управлению.
wait
логическое значение
    Варианты:
  • нет
  • да ←
yes если модуль должен ждать, пока сущность перейдет в желаемое состояние.

Примечания

Примечание

  • Обратите внимание, что без агента гостевой ОС данные о созданном моментальном снимке могут быть несогласованными.
  • Удаление моментального снимка не удаляет никакую информацию из виртуальной машины — оно просто удаляет точку возврата. Однако восстановление виртуальной машины из моментального снимка удаляет любые данные, которые были записаны в виртуальную машину после момента создания моментального снимка.
  • Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: 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:

# 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 }}"

# Upload local image to disk and attach it to vm:
# Since Ansible 2.8
- ovirt_snapshot:
    name: mydisk
    vm_name: myvm
    upload_image_path: /path/to/mydisk.qcow2

# Download snapshot to local file system:
# Since Ansible 2.8
- ovirt_snapshot:
    snapshot_id: 7de90f31-222c-436c-a1ca-7e655bd5b60c
    disk_name: DiskName
    vm_name: myvm
    download_image_path: /home/user/mysnaphost.qcow2

# Delete all snapshots older than 2 days
- ovirt_snapshot:
    vm_name: test
    keep_days_old: 2

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

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

Ключ Возвращаемое значение Описание
id
строка
При успехе, если снимок найден.
Идентификатор управляемого снимка.

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

snapshots
список
При успехе возвращает удаленные снимки.
Список удаленных снимков, когда определен параметр keep_days_old и снимок старше заданных дней.



Статус

  • Этот модуль не гарантирует обратную совместимость. [превью]
  • Этот модуль поддерживается сообществом 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.9/modules/ovirt_snapshot_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API