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. Поддержка переменных среды добавлена в Ansible 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. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: pass, pwd | |
| port целое число добавлен в 2.5 | По умолчанию: 443 | Порт сервера vCenter или ESXi-сервера vSphere. Если значение не указано в задаче, используется значение переменной среды VMWARE_PORT. Поддержка переменных среды добавлена в Ansible 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 и снимок(и) отсутствуют, никаких изменений не будет внесено. |
| use_instance_uuid логическое добавлен в 2.8 |
| Использовать идентификатор UUID экземпляра VMWare вместо идентификатора BIOS. |
| username строка | Имя пользователя сервера vCenter или ESXi сервера vSphere. Если значение не указано в задаче, используется значение переменной среды VMWARE_USER. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: admin, user | |
| uuid - | UUID экземпляра для управления, если известен; по умолчанию используется UUID BIOS VMware. Требуется, если параметр name не задан. | |
| validate_certs логическое |
| Разрешает подключение, когда сертификаты SSL недействительны. Установите в значение false, когда сертификаты ненадёжные.Если значение не указано в задаче, используется значение переменной среды VMWARE_VALIDATE_CERTS. Поддержка переменных среды добавлена в Ansible 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
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| snapshot_results словарь | всегда | метаданные о моментальных снимках виртуальной машины Пример: {'current_snapshot': {'creation_time': '2019-04-09T14:40:26.617427+00:00', 'description': 'Пример моментального снимка 4', 'id': 4, 'name': 'snapshot4', 'state': 'выключено'}, 'snapshots': [{'creation_time': '2019-04-09T14:38:24.667543+00:00', 'description': 'Пример моментального снимка 3', 'id': 3, 'name': 'snapshot3', 'state': 'выключено'}, {'creation_time': '2019-04-09T14:40:26.617427+00:00', 'description': 'Пример моментального снимка 4', 'id': 4, 'name': 'snapshot4', 'state': 'выключено'}]} |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.8/modules/vmware_guest_snapshot_module.html