Модуль community.vmware.vmware_guest_snapshot — управление снимками виртуальных машин в vCenter

Примечание

Этот модуль входит в коллекцию community.vmware (версия 6.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.vmware.

Чтобы использовать её в плейбуке, укажите: community.vmware.vmware_guest_snapshot.

УСТАРЕЛО
Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

УСТАРЕЛО

Удалено в:: версии 8.0.0
Причина:: Этот модуль был перенесён в vmware.vmware
Альтернатива:: Вместо него используйте vmware.vmware.vm_snapshot.

Краткое описание

Этот модуль позволяет создавать, удалять и обновлять снимки указанной виртуальной машины.

Параметры

Параметр	Комментарии
datacenter string / обязательный	Целевой центр обработки данных для операции развёртывания.
description string	Задаёт произвольное описание для снимка. По умолчанию: `""`
folder string	Целевая папка — абсолютный или относительный путь для поиска существующей гостевой системы. Этот параметр обязателен, если указан `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 string	Имя хоста или IP-адрес сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_HOST`.
memory_dump boolean	Если задано значение `true`, в снимок также включается дамп памяти виртуальной машины. Создание снимков памяти требует времени и ресурсов, поэтому процесс займёт больше времени. Если виртуальная машина не поддерживает создание снимков памяти, этому флагу присваивается значение `false`. Варианты: `false` ← (по умолчанию) `true`
moid string	Идентификатор управляемого объекта экземпляра, если он известен. Этот уникальный идентификатор действует только в пределах одного экземпляра vCenter. Этот параметр обязателен, если не указан `name` или `uuid`.
name string	Имя виртуальной машины, с которой нужно работать. Этот параметр обязателен, если не указан `uuid` или `moid`.
name_match string	Если найдено несколько виртуальных машин с таким именем, использовать первую или последнюю найденную. Варианты: `"first"` ← (по умолчанию) `"last"`
new_description string	Новое описание существующего снимка.
new_snapshot_name string	Новое имя существующего снимка.
password псевдонимы: pass, pwd string	Пароль сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PASSWORD`.
port integer	Номер порта сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PORT`. По умолчанию: `443`
proxy_host string	Адрес прокси-сервера, который будет получать все HTTPS-запросы и пересылать их дальше. В качестве адреса можно указать имя хоста или IP-адрес. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PROXY_HOST`.
proxy_port integer	Порт HTTP-прокси, который будет получать все HTTPS-запросы и пересылать их дальше. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PROXY_PORT`.
quiesce boolean	Если задано значение `true` и виртуальная машина включена, файловая система виртуальной машины будет приведена в согласованное состояние. Для этого флага необходимы VMware Tools. Если виртуальная машина выключена или VMware Tools недоступны, этому флагу присваивается значение `false`. Если виртуальная машина не поддерживает создание согласованных снимков, этому флагу присваивается значение `false`. Варианты: `false` ← (по умолчанию) `true`
remove_children boolean	Если задано значение `true` и `state=absent`, для удаления будет помечено всё поддерево снимков. Варианты: `false` ← (по умолчанию) `true`
snapshot_id integer добавлено в community.vmware 3.10.0	Задаёт идентификатор снимка, которым нужно управлять. Этот параметр доступен, если `state=absent` или `state=revert`.
snapshot_name string	Задаёт имя снимка, которым нужно управлять. Этот параметр или `snapshot_id` обязателен только в том случае, если `state` не равно `remove_all`
state string	Управление снимками, связанными с указанной виртуальной машиной. Если задано значение `present` и снимок отсутствует, будет создан новый снимок с указанным именем. Если задано значение `present` и снимок существует, изменения не вносятся. Если задано значение `absent` и снимок существует, снимок с указанным именем удаляется. Если задано значение `absent` и снимок отсутствует, изменения не вносятся. Если задано значение `revert` и снимок существует, состояние виртуальной машины будет восстановлено до указанного снимка. Если задано значение `revert` и снимок отсутствует, изменения не вносятся. Если задано значение `remove_all` и снимки существуют, все снимки будут удалены. Если задано значение `remove_all` и снимки отсутствуют, изменения не вносятся. Варианты: `"present"` ← (по умолчанию) `"absent"` `"revert"` `"remove_all"`
use_instance_uuid boolean	Использовать UUID экземпляра VMware вместо UUID BIOS. Варианты: `false` ← (по умолчанию) `true`
username псевдонимы: admin, user string	Имя пользователя сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_USER`.
uuid string	UUID экземпляра, которым нужно управлять, если он известен; по умолчанию это UUID BIOS VMware. Этот параметр обязателен, если не указан параметр `name` или `moid`.
validate_certs boolean	Разрешает подключение, если SSL-сертификаты недействительны. Установите значение `false`, если сертификаты не являются доверенными. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Всем модулям необходим доступ к API на запись, поэтому они не поддерживаются бесплатной лицензией ESXi.
Все переменные и имена объектов VMware чувствительны к регистру.
Модули могут использовать библиотеку Python ‘requests’, которая по умолчанию не использует системное хранилище сертификатов. Указать хранилище сертификатов можно, задав переменную окружения REQUESTS_CA_BUNDLE. Обратите внимание: в некоторых случаях заданное значение этой переменной может привести к тому, что параметр ‘validate_certs’ со значением ‘false’ будет проигнорирован. Пример: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’

Примеры

- 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: Remove a snapshot with a snapshot id
  community.vmware.vmware_guest_snapshot:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    folder: "/{{ datacenter_name }}/vm/"
    name: "{{ guest_name }}"
    snapshot_id: 10
    state: absent
  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 dictionary	метаданные о снимках виртуальной машины Возвращается: всегда Пример: `{"current_snapshot": {"creation_time": "2019-04-09T14:40:26.617427+00:00", "description": "Snapshot 4 example", "id": 4, "name": "snapshot4", "state": "poweredOff"}, "snapshots": [{"creation_time": "2019-04-09T14:38:24.667543+00:00", "description": "Snapshot 3 example", "id": 3, "name": "snapshot3", "state": "poweredOff"}, {"creation_time": "2019-04-09T14:40:26.617427+00:00", "description": "Snapshot 4 example", "id": 4, "name": "snapshot4", "state": "poweredOff"}]}`

Ключ

Описание

snapshot_results

dictionary

метаданные о снимках виртуальной машины

Возвращается: всегда

Пример: {"current_snapshot": {"creation_time": "2019-04-09T14:40:26.617427+00:00", "description": "Snapshot 4 example", "id": 4, "name": "snapshot4", "state": "poweredOff"}, "snapshots": [{"creation_time": "2019-04-09T14:38:24.667543+00:00", "description": "Snapshot 3 example", "id": 3, "name": "snapshot3", "state": "poweredOff"}, {"creation_time": "2019-04-09T14:40:26.617427+00:00", "description": "Snapshot 4 example", "id": 4, "name": "snapshot4", "state": "poweredOff"}]}

Статус

Этот модуль будет удалён в версии 8.0.0. [устарело]
Дополнительную информацию см. в разделе УСТАРЕЛО.

Авторы

Loic Blot (@nerzhul)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/vmware/vmware_guest_snapshot_module.html