vmware_guest_snapshot — Управление снимками виртуальных машин в vCenter
Новая в версии 2.3.
Обзор
- Этот модуль может использоваться для создания, удаления и обновления снимков заданной виртуальной машины.
- Все параметры и имена объектов VMware чувствительны к регистру.
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- PyVmomi
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| datacenter обязательно | Целевой центр обработки данных для операции развертывания. | |
| description | По умолчанию: "" | Определение произвольного описания для добавления к снимку. |
| folder | Целевой папки, абсолютный или относительный путь к существующему гостю. Это обязательный параметр, если name указан.Папка должна содержать центр обработки данных. Центр обработки данных 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 str | Имя хоста или IP-адрес сервера vCenter или ESXi vSphere. Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_HOST. Поддержка переменных окружения добавлена в версии 2.6. | |
| memory_dump bool (добавлено в 2.4) |
| Если установлено значение true, в снимок также включается дамп памяти виртуальной машины.Обратите внимание, что снимки памяти занимают время и ресурсы; это займет больше времени для создания. Если виртуальная машина не предоставляет возможность создания снимка памяти, этот флаг устанавливается в значение false. |
| name | Имя виртуальной машины, с которой нужно работать. Это обязательный параметр, если uuid не указан. | |
| name_match |
| Если существует несколько виртуальных машин, соответствующих имени, используется первая или последняя найденная. |
| new_description (добавлено в 2.5) | Значение для изменения описания существующего снимка. | |
| new_snapshot_name (добавлено в 2.5) | Значение для переименования существующего снимка. | |
| password str | Пароль сервера vCenter или ESXi vSphere. Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_PASSWORD. Поддержка переменных окружения добавлена в версии 2.6. псевдонимы: pass, pwd | |
| port int (добавлено в 2.5) | По умолчанию: 443 | Номер порта сервера vCenter или ESXi vSphere. Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_PORT. Поддержка переменных окружения добавлена в версии 2.6. |
| quiesce bool (добавлено в 2.4) |
| Если установлено true, и виртуальная машина включена, будет приостановлена файловая система виртуальной машины.Обратите внимание, что для этого флага требуется VMWare Tools. Если виртуальная машина выключена или VMware Tools недоступны, этот флаг устанавливается в false. Если виртуальная машина не предоставляет возможность создания снимка с приостановкой, этот флаг устанавливается в false. |
| remove_children bool (добавлено в 2.4) |
| Если установлено true, и состояние установлено в absent, вся поддерево снимков устанавливается для удаления. |
| snapshot_name | Устанавливает имя снимка для управления. Этот параметр требуется только в том случае, если состояние не remove_all | |
| state обязательно |
| Управление снимками, присоединенными к определенной виртуальной машине. Если установлено present, и снимок отсутствует, будет создан новый снимок с заданным именем.Если установлено present, и снимок присутствует, изменений не будет.Если установлено absent, и снимок присутствует, снимок с заданным именем будет удален.Если установлено absent, и снимок отсутствует, изменений не будет.Если установлено revert, и снимок присутствует, состояние виртуальной машины будет восстановлено до заданного снимка.Если установлено revert, и снимок отсутствует, изменений не будет.Если установлено remove_all, и снимки присутствуют, все снимки будут удалены.Если установлено remove_all, и снимки отсутствуют, изменений не будет. |
| username str | Имя пользователя сервера vCenter или ESXi vSphere. Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_USER. Поддержка переменных окружения добавлена в версии 2.6. псевдонимы: admin, user | |
| uuid | UUID экземпляра для управления, если известен. Это уникальный идентификатор VMware. Это обязательный параметр, если name не указан. | |
| validate_certs bool |
| Разрешает подключение, когда сертификаты SSL недействительны. Установите false при отсутствии доверия к сертификатам.Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_VALIDATE_CERTS. Поддержка переменных окружения добавлена в версии 2.6. Если установлено yes, убедитесь, что на данном компьютере установлен Python >= 2.7.9. |
Примечания
Примечание
- Проверено на vSphere 5.5, 6.0 и 6.5
Примеры
- name: Create 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: 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: absent
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: absent
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 |
Статус
Этот модуль помечен как предварительный просмотр, что означает, что его интерфейс не гарантируется как обратной совместимости.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- Лоик Блот (@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.6/modules/vmware_guest_snapshot_module.html
