wiki-decort-ansible/10.0.0/модуль-decort_vm_snapshot.md

Модуль decort_vm_snapshot

Обзор модуля

Модуль decort_vm_snapshot предназначен для выполнения следующих действий над снимками виртуальных машин:

• создать (см. параметр state и примеры)
• удалить (см. параметр state и примеры)
• отменить копирование данных из удаляемого снимка на СХД Shared (см. параметр state и примеры)
• получить основную информацию о снимке (см. возвращаемые значения и примеры)
• получить информацию о размере снимка (см. параметр usage, возвращаемые значения и примеры)

Параметры модуля

Ниже приведен список параметров для модуля decort_vm_snapshot (за исключением общих параметров авторизации):

Параметр						Тип	Описание
label						(str)	Метка снимка виртуальной машины. Если метка не указана при создании, она будет сгенерирована автоматически на основе даты и времени - vm_name_2024-12-10_16-40-52.
state						(str) Значения: absent merge_aborted present	Целевое состояние. absent - снимок удален. merge_aborted - копирование данных из удаляемого снимка на СХД Shared отменено. present - снимок существует.
usage						(bool) Default:false	Получить информацию о реальном размере снимка виртуальной машины.
vm_id						(int)	Идентификатор виртуальной машины. Обязательный параметр.

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

Модуль decort_vm_snapshot возвращает информацию о снимке виртуальной машины в виде словаря facts со следующими ключами:

Основная информация

Ключ						Тип данных	Описание
disks						list	Диски
guid						str	Идентификатор снимка
label						str	Метка снимка
timestamp						int	Временная метка создания снимка
vm_id						int	Идентификатор виртуальной машины

Размер снимка

Ключ						Тип данных	Описание
stored						float	Размер снимка

Примеры использования

Создать

С указанием метки

- name: Example
  hosts: localhost
  tasks:
    - name: Create snapshot
      decort_vm_snapshot:
        # Параметры для авторизации упущены
        vm_id: "{{ vm_id }}"
        label: "{{ snapshot_label }}"
        state: present

Без указания метки

- name: Example
  hosts: localhost
  tasks:
    - name: Create snapshot
      decort_vm_snapshot:
        # Параметры для авторизации упущены
        vm_id: "{{ vm_id }}"
        state: present

Удалить

- name: Example
  hosts: localhost
  tasks:
    - name: Delete snapshot
      decort_vm_snapshot:
        # Параметры для авторизации упущены
        vm_id: "{{ vm_id }}"
        label: "{{ snapshot_label }}"
        state: absent

Отменить копирование данных из удаляемого снимка на СХД Shared

- name: Example
  hosts: localhost
  tasks:
    - name: Abort merge
      decort_vm_snapshot:
        # Параметры для авторизации упущены
        vm_id: "{{ vm_id }}"
        label: "{{ snapshot_label }}"
        state: merge_aborted

Получить основную информацию о снимке

- name: Example
  hosts: localhost
  tasks:
    - name: Get basic snapshot info
      decort_vm_snapshot:
        # Параметры для авторизации упущены
        vm_id: "{{ vm_id }}"
        label: "{{ snapshot_label }}"

Получить информацию о размере снимка

- name: Example
  hosts: localhost
  tasks:
    - name: Get snapshot usage
      decort_vm_snapshot:
        # Параметры для авторизации упущены
        vm_id: "{{ vm_id }}"
        label: "{{ snapshot_label }}"
        usage: true