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 строка | Имя хоста или IP-адрес сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_HOST. Поддержка переменных среды добавлена в версии 2.6. | |
| memory_dump логическое значение добавлен в 2.4 |
| Если установлено true, дамп памяти виртуальной машины также включен в моментальный снимок.Обратите внимание, что моментальные снимки памяти занимают время и ресурсы, что займёт больше времени для создания. Если виртуальная машина не предоставляет возможность создания моментального снимка памяти, этот флаг установлен в false. |
| name - | Имя виртуальной машины, с которой нужно работать. Этот параметр обязателен, если uuid не указан. | |
| name_match - |
| Если несколько ВМ соответствуют имени, используется первая или последняя найденная. |
| new_description - добавлен в 2.5 | Значение для изменения описания существующего моментального снимка. | |
| new_snapshot_name - добавлен в 2.5 | Значение для переименования существующего моментального снимка. | |
| password строка | Пароль сервера vCenter или ESXi vSphere. Если значение не указано в задаче, используется значение переменной среды VMWARE_PASSWORD. Поддержка переменных среды добавлена в версии 2.6. псевдонимы: pass, pwd | |
| port целое число добавлен в 2.5 | По умолчанию: 443 | Номер порта сервера vCenter или ESXi vSphere. Если значение не указано в задаче, используется значение переменной среды VMWARE_PORT. Поддержка переменных среды добавлена в версии 2.6. |
| quiesce логическое значение добавлен в 2.4 |
| Если установлено true, а виртуальная машина включена, будет заблокирована файловая система в виртуальной машине.Обратите внимание, что для этого флага необходимы VMware Tools. Если виртуальная машина выключена или VMware Tools недоступны, этот флаг установлен в false. Если виртуальная машина не поддерживает создание моментального снимка с блокировкой, этот флаг установлен в false. |
| remove_children логическое значение добавлен в 2.4 |
| Если установлено true, а состояние установлено в absent, вся поддеревья моментальных снимков устанавливаются для удаления. |
| snapshot_name - | Устанавливает имя моментального снимка для управления. Этот параметр требуется только в том случае, если состояние не remove_all.
| |
| state - / обязательно |
| Управление моментальными снимками, присоединенными к конкретной виртуальной машине. Если установлено present, а моментальный снимок отсутствует, создаётся новый моментальный снимок с заданным именем.Если установлено present, а моментальный снимок присутствует, никаких изменений не вносится.Если установлено absent, а моментальный снимок присутствует, моментальный снимок с заданным именем удаляется.Если установлено absent, а моментальный снимок отсутствует, никаких изменений не вносится.Если установлено revert, а моментальный снимок присутствует, состояние виртуальной машины возвращается к заданному моментальному снимку.Если установлено revert, а моментальный снимок отсутствует, никаких изменений не вносится.Если установлено remove_all, а моментальный снимок(и) присутствуют, все моментальные снимки будут удалены.Если установлено remove_all, а моментальный снимок(и) отсутствуют, никаких изменений не вносится. |
| username строка | Имя пользователя сервера vCenter или ESXi vSphere. Если значение не указано в задаче, используется значение переменной среды VMWARE_USER. Поддержка переменных среды добавлена в версии 2.6. псевдонимы: admin, user | |
| uuid - | UUID экземпляра для управления, если известен, это уникальный идентификатор VMware. Этот параметр обязателен, если name не указан. | |
| validate_certs логическое значение |
| Разрешает подключение, когда сертификаты 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: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
folder: /"{{ datacenter_name }}"/vm/
name: "{{ guest_name }}"
state: present
snapshot_name: snap1
description: snap1_description
delegate_to: localhost
- name: Remove a snapshot
vmware_guest_snapshot:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
folder: /"{{ datacenter_name }}"/vm/
name: "{{ guest_name }}"
state: absent
snapshot_name: snap1
delegate_to: localhost
- name: Revert to a snapshot
vmware_guest_snapshot:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
folder: /"{{ datacenter_name }}"/vm/
name: "{{ guest_name }}"
state: revert
snapshot_name: snap1
delegate_to: localhost
- name: Remove all snapshots of a VM
vmware_guest_snapshot:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
folder: /"{{ datacenter_name }}"/vm/
name: "{{ guest_name }}"
state: remove_all
delegate_to: localhost
- name: Take snapshot of a VM using quiesce and memory flag on
vmware_guest_snapshot:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
folder: /"{{ datacenter_name }}"/vm/
name: "{{ guest_name }}"
state: present
snapshot_name: dummy_vm_snap_0001
quiesce: yes
memory_dump: yes
delegate_to: localhost
- name: Remove a snapshot and snapshot subtree
vmware_guest_snapshot:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
folder: /"{{ datacenter_name }}"/vm/
name: "{{ guest_name }}"
state: absent
remove_children: yes
snapshot_name: snap1
delegate_to: localhost
- name: Rename a snapshot
vmware_guest_snapshot:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
folder: /"{{ datacenter_name }}"/vm/
name: "{{ guest_name }}"
state: present
snapshot_name: current_snap_name
new_snapshot_name: im_renamed
new_description: "{{ new_snapshot_description }}"
delegate_to: localhost
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| instance словарь | всегда | метаданные о новом снимке виртуальной машины Пример: None |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Лоик Блот (@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.7/modules/vmware_guest_snapshot_module.html