Spec-Zone.ru › Ansible 2.8

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

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

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

Описание

  • Модуль для управления моментальными снимками виртуальных машин в 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, установленный в значение «истина».
fetch_nested
булево
добавлено в 2.3
    Варианты:
  • нет
  • да
Если истина, модуль получит дополнительные данные из API.
Он получит идентификаторы дисков ВМ, моментальных снимков и т. д. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes.
keep_days_old
-
добавлено в 2.8
Количество дней, по истечении которых моментальный снимок должен быть удален.
Он проверит все моментальные снимки виртуальной машины и удалит их, если они старше.
nested_attributes
список
добавлено в 2.3
Указывает список атрибутов, которые должны быть получены из API.
Этот параметр применяется только если fetch_nested имеет значение истина.
poll_interval
целое число
Значение по умолчанию:
3
Количество секунд, которое модуль ждет, прежде чем отправить другой запрос опроса состояния сущности.
snapshot_id
-
Идентификатор моментального снимка для управления.
state
-
    Варианты:
  • восстановление
  • наличие ←
  • отсутствует
Моментальный снимок виртуальной машины должен быть восстановлен/наличием/отсутствовать.
timeout
целое число
Значение по умолчанию:
180
Время в секундах, которое модуль должен ждать, пока экземпляр не перейдет в нужное состояние.
upload_image_path
-
добавлено в 2.8
Путь к изображению диска, которое должно быть загружено.
use_memory
булево
    Варианты:
  • нет
  • да
Если истина и state присутствует, сохранить память виртуальной машины, если она запущена.
Если истина и 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.8/modules/ovirt_snapshot_module.html

Spec-Zone.ru

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