vmware_guest_snapshot – Управление моментальными снимками виртуальных машин в vCenter
Синопсис
- Этот модуль может использоваться для создания, удаления и обновления моментальных снимков заданной виртуальной машины.
- Все параметры и имена объектов 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 логическое добавлено в 2.4 |
| Если установлено в true, дамп памяти виртуальной машины также включен в снимок.Обратите внимание, что снимки памяти требуют времени и ресурсов, это займет больше времени для создания. Если виртуальная машина не предоставляет возможности создания снимка памяти, этот флаг устанавливается в false. |
| moid строка добавлено в 2.9 | Идентификатор управляемого объекта экземпляра для управления, если он известен. Это уникальный идентификатор только в пределах одного экземпляра vCenter. Требуется, если name или uuid не указаны. | |
| name строка | Имя виртуальной машины, с которой нужно работать. Этот параметр является обязательным, если uuid или moid не указаны. | |
| name_match строка |
| Если существует несколько виртуальных машин, соответствующих имени, используется первая или последняя найденная. |
| new_description строка добавлено в 2.5 | Значение для изменения описания существующего снимка. | |
| new_snapshot_name строка добавлено в 2.5 | Значение для переименования существующего снимка. | |
| password строка | Пароль сервера vCenter vSphere или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_PASSWORD. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: pass, pwd | |
| port целое число добавлено в 2.5 | По умолчанию: 443 | Номер порта сервера vCenter vSphere или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_PORT. Поддержка переменных среды добавлена в Ansible 2.6. |
| proxy_host строка добавлено в 2.9 | Адрес прокси-сервера, который будет получать все запросы HTTPS и перенаправлять их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_PROXY_HOST. Эта функция зависит от версии pyvmomi, большей чем v6.7.1.2018.12 | |
| proxy_port целое число добавлено в 2.9 | Порт HTTP-прокси, который будет получать все запросы HTTPS и перенаправлять их. Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_PROXY_PORT. | |
| quiesce логическое добавлено в 2.4 |
| Если установлено в true, и виртуальная машина включена, система файлов в виртуальной машине будет приведена в состояние покоя.Обратите внимание, что для этого флага требуется VMware Tools. Если виртуальная машина выключена или VMware Tools недоступны, этот флаг устанавливается в false.Если виртуальная машина не предоставляет возможность создания снимка quiesce, этот флаг устанавливается в 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 вместо 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. Если установлено в 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: Remove all snapshots of a VM using MoID
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
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': 'poweredOff'}, 'snapshots': [{'creation_time': '2019-04-09T14:38:24.667543+00:00', 'description': 'Пример снимка 3', 'id': 3, 'name': 'snapshot3', 'state': 'poweredOff'}, {'creation_time': '2019-04-09T14:40:26.617427+00:00', 'description': 'Пример снимка 4', 'id': 4, 'name': 'snapshot4', 'state': 'poweredOff'}]} |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.9/modules/vmware_guest_snapshot_module.html