community.vmware.vmware_guest_snapshot – Управление снимками виртуальных машин в vCenter
Примечание
Этот плагин входит в состав коллекции community.vmware (версия 1.6.0).
Для его установки используйте: ansible-galaxy collection install community.vmware.
Чтобы использовать его в книге задач, укажите: community.vmware.vmware_guest_snapshot.
Обзор
- Этот модуль можно использовать для создания, удаления и обновления снимков заданной виртуальной машины.
- Все параметры и имена объектов 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 | |
| hostname строка | Имя хоста или IP-адрес сервера vCenter vSphere или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_HOST. Поддержка переменных среды добавлена в Ansible 2.6. | |
| memory_dump логическое значение |
| Если установлено значение true, дамп памяти виртуальной машины также включён в снимок.Обратите внимание, что снимки памяти требуют времени и ресурсов; это займёт больше времени для создания. Если виртуальная машина не поддерживает создание снимков памяти, этот флаг устанавливается в значение false. |
| moid строка | Идентификатор управляемого объекта экземпляра для управления, если он известен. Это уникальный идентификатор только в рамках одного экземпляра vCenter. Требуется, если name или uuid не указаны. | |
| name строка | Имя виртуальной машины для работы. Этот параметр является обязательным, если uuid или moid не указаны. | |
| name_match строка |
| Если несколько виртуальных машин соответствуют имени, используется первая или последняя найденная. |
| new_description строка | Значение для изменения описания существующего снимка. | |
| new_snapshot_name строка | Значение для переименования существующего снимка. | |
| password строка | Пароль сервера vCenter vSphere или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PASSWORD. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: pass, pwd | |
| port целое число | По умолчанию: 443 | Номер порта сервера vCenter vSphere или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PORT.Поддержка переменных среды добавлена в Ansible 2.6. |
| proxy_host строка | Адрес прокси, который будет принимать все запросы HTTPS и перенаправлять их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PROXY_HOST. Эта функция зависит от версии pyvmomi, большей, чем v6.7.1.2018.12 | |
| proxy_port целое число | Порт HTTP-прокси, который будет принимать все запросы HTTPS и перенаправлять их. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PROXY_PORT. | |
| quiesce логическое значение |
| Если установлено значение true, и виртуальная машина включена, она приостановит файловую систему в виртуальной машине.Обратите внимание, что для этого флага необходимы VMware Tools. Если виртуальная машина выключена или VMware Tools недоступны, этот флаг устанавливается в значение false.Если виртуальная машина не поддерживает создание снимка с приостановкой, этот флаг устанавливается в значение false. |
| remove_children логическое значение |
| Если установлено значение true и состояние установлено в значение absent, вся поддеревовидная структура снимков устанавливается для удаления. |
| snapshot_name строка | Устанавливает имя снимка для управления. Этот параметр требуется только в том случае, если состояние не remove_all | |
| state строка |
| Управление снимком(ами), прикреплённым(ыми) к определённой виртуальной машине. Если установлено значение present, и снимок отсутствует, создаст новый снимок с указанным именем.Если установлено значение present, и снимок присутствует, изменений не вносится.Если установлено значение absent, и снимок присутствует, снимок с указанным именем удаляется.Если установлено значение absent, и снимок отсутствует, изменений не вносится.Если установлено значение revert, и снимок присутствует, состояние виртуальной машины возвращается к указанному снимку.Если установлено значение revert, и снимок отсутствует, изменений не вносится.Если установлено значение remove_all, и присутствуют снимок(и), все снимок(и) будут удалены.Если установлено значение remove_all, и снимок(и) отсутствуют, изменений не вносится. |
| use_instance_uuid логическое значение |
| Использовать идентификатор UUID экземпляра VMware вместо идентификатора UUID BIOS. |
| username строка | Имя пользователя сервера vCenter vSphere или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_USER. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: admin, user | |
| uuid строка | Идентификатор UUID экземпляра для управления, если он известен. По умолчанию это идентификатор UUID BIOS VMware. Требуется, если параметр name или moid не указан. | |
| validate_certs логическое значение |
| Разрешает подключение, когда сертификаты SSL недействительны. Устанавливается в значение false, когда сертификаты не доверяются.Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_VALIDATE_CERTS. Поддержка переменных среды добавлена в Ansible 2.6. Если установлено значение true, убедитесь, что на данном компьютере установлен Python >= 2.7.9. |
Примечания
Примечание
- Тестировалось на vSphere 5.5, 6.0 и 6.5
Примеры
- name: Create a snapshot
community.vmware.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
community.vmware.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
community.vmware.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
community.vmware.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: Remove all snapshots of a VM using MoID
community.vmware.vmware_guest_snapshot:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
folder: "/{{ datacenter_name }}/vm/"
moid: vm-42
state: remove_all
delegate_to: localhost
- name: Take snapshot of a VM using quiesce and memory flag on
community.vmware.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: true
memory_dump: true
delegate_to: localhost
- name: Remove a snapshot and snapshot subtree
community.vmware.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: true
snapshot_name: snap1
delegate_to: localhost
- name: Rename a snapshot
community.vmware.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': 'выключена'}]} |
Авторы
- Лоик Блот (@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.10/collections/community/vmware/vmware_guest_snapshot_module.html