vmware_guest_snapshot - Управление снимками виртуальных машин в vCenter

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

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

Описание

Создание снимков виртуальных машин

Требования

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

python >= 2.6
PyVmomi

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
datacenter обязательно		Целевой центр обработки данных для операции развертывания
description	Значение по умолчанию:	Определение произвольного описания для добавления к снимку.
folder		Целевой каталог, абсолютный или относительный путь к существующему гостевому устройству. Это необходимо, если указано имя. Каталог должен содержать центр обработки данных. Центр обработки данных ESX - ha-datacenter Примеры: folder: /ha-datacenter/vm folder: ha-datacenter/vm folder: /datacenter1/vm folder: datacenter1/vm folder: /datacenter1/vm/folder1 folder: datacenter1/vm/folder1 folder: /folder1/datacenter1/vm folder: folder1/datacenter1/vm folder: /folder1/datacenter1/vm/folder2 folder: vm/folder2 folder: folder2
hostname		Имя хоста или IP-адрес сервера vSphere vCenter или ESXi. Если значение не указано в задаче, используется значение переменной среды `VMWARE_HOST`. Переменная среды поддерживается начиная с версии 2.6.
memory_dump (добавлено в 2.4)	Варианты: no ← yes	Если установлено значение `true`, в снимок также включается дамп памяти виртуальной машины. Обратите внимание, что снимки памяти занимают время и ресурсы; для их создания потребуется больше времени. Если виртуальная машина не предоставляет возможность создания снимка памяти, этот флаг устанавливается в `false`.
name		Имя виртуальной машины для работы Это необходимо, если uuid не указан.
name_match	Варианты: first ← last	Если найдено несколько виртуальных машин с совпадающим именем, используется первая или последняя найденная.
new_description (добавлено в 2.5)		Значение для изменения описания существующего снимка.
new_snapshot_name (добавлено в 2.5)		Значение для переименования существующего снимка.
password		Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задаче, используется значение переменной среды `VMWARE_PASSWORD`. Поддержка переменных среды добавлена в версии 2.6. Псевдонимы: pass, pwd
port (добавлено в 2.5)	Значение по умолчанию: 443	Порт сервера vSphere vCenter или ESXi. Если значение не указано в задаче, используется значение переменной среды `VMWARE_PORT`. Поддержка переменных среды добавлена в версии 2.6.
quiesce (добавлено в 2.4)	Варианты: no ← yes	Если установлено `true`, и виртуальная машина включена, система файлов в виртуальной машине будет приостановлена. Обратите внимание, что для этого флага необходимы VMware Tools. Если виртуальная машина выключена или VMware Tools недоступны, этот флаг устанавливается в `false`. Если виртуальная машина не предоставляет возможность создания снимка с приостановкой, этот флаг устанавливается в `false`.
remove_children (добавлено в 2.4)	Варианты: no ← yes	Если установлено `true`, и состояние установлено в `absent`, вся поддеревья снимков устанавливается для удаления.
snapshot_name		Устанавливает имя снимка для управления. Этот параметр требуется только в том случае, если состояние не `remove_all`
state обязательно	Варианты: present ← absent revert remove_all	Управление снимками, присоединенными к определенной виртуальной машине.
username		Имя пользователя сервера vSphere vCenter или ESXi. Если значение не указано в задаче, используется значение переменной среды `VMWARE_USER`. Поддержка переменных среды добавлена в версии 2.6. Псевдонимы: user, admin
uuid		UUID экземпляра для управления, если известен (уникальный идентификатор VMware). Это необходимо, если имя не указано.
validate_certs	Варианты: no yes Значение по умолчанию: True	Позволяет подключиться, когда сертификаты SSL недействительны. Установите значение `false`, если сертификаты не доверяются. Если значение не указано в задаче, используется значение переменной среды `VMWARE_VALIDATE_CERTS`. Поддержка переменных среды добавлена в версии 2.6.

Примечания

Примечание

Проверено на vSphere 5.5, 6.0

Примеры

- name: Create snapshot
  vmware_guest_snapshot:
    hostname: 192.168.1.209
    username: administrator@vsphere.local
    password: vmware
    datacenter: datacenter_name
    folder: /myfolder
    name: dummy_vm
    state: present
    snapshot_name: snap1
    description: snap1_description
  delegate_to: localhost

- name: Remove a snapshot
  vmware_guest_snapshot:
    hostname: 192.168.1.209
    username: administrator@vsphere.local
    password: vmware
    name: dummy_vm
    datacenter: datacenter_name
    folder: /myfolder
    state: remove
    snapshot_name: snap1
  delegate_to: localhost

- name: Revert to a snapshot
  vmware_guest_snapshot:
    hostname: 192.168.1.209
    username: administrator@vsphere.local
    password: vmware
    datacenter: datacenter_name
    folder: /myfolder
    name: dummy_vm
    state: revert
    snapshot_name: snap1
  delegate_to: localhost

- name: Remove all snapshots of a VM
  vmware_guest_snapshot:
    hostname: 192.168.1.209
    username: administrator@vsphere.local
    password: vmware
    datacenter: datacenter_name
    folder: /myfolder
    name: dummy_vm
    state: remove_all
  delegate_to: localhost

- name: Take snapshot of a VM using quiesce and memory flag on
  vmware_guest_snapshot:
    hostname: 192.168.1.209
    username: administrator@vsphere.local
    password: vmware
    name: dummy_vm
    state: present
    snapshot_name: dummy_vm_snap_0001
    quiesce: True
    memory_dump: True
  delegate_to: localhost

- name: Remove a snapshot and snapshot subtree
  vmware_guest_snapshot:
    hostname: 192.168.1.209
    username: administrator@vsphere.local
    password: vmware
    name: dummy_vm
    state: remove
    remove_children: True
    snapshot_name: snap1
  delegate_to: localhost

- name: Rename a snapshot
  vmware_guest_snapshot:
    hostname: 192.168.1.209
    username: administrator@vsphere.local
    password: vmware
    name: dummy_vm
    state: present
    snapshot_name: current_snap_name
    new_snapshot_name: im_renamed
    new_description: "renamed snapshot today"
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
instance dict	всегда	Метаданные о новой виртуальной машине Пример: None

Статус

Этот модуль помечен как экспериментальный, что означает, что его интерфейс не гарантируется обратной совместимостью.

Автор

James Tanner (@jctanner) <tanner.jc@gmail.com>
Loic Blot (@nerzhul) <loic.blot@unix-experience.fr>

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ для улучшения.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/vmware_guest_snapshot_module.html