Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

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

Параметры

Параметр

Комментарии

datacenter

string / required

Центр обработки данных назначения для операции развертывания.

description

string

Определите произвольное описание для прикрепления к снимку.

Default: ""

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 или ESXi.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_HOST.

memory_dump

boolean

Если установлено значение true, дамп памяти виртуальной машины также включается в снимок.

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

Если виртуальная машина не предоставляет возможности для создания снимка памяти, то этот флаг устанавливается в false.

Choices:

  • false ← (default)
  • true

moid

string

Идентификатор управляемого объекта экземпляра для управления, если известен, это уникальный идентификатор только в пределах одного экземпляра vCenter.

Это необходимо, если не указан name или uuid.

name

string

Имя виртуальной машины, с которой нужно работать.

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

name_match

string

Если несколько виртуальных машин соответствуют имени, используйте первую или последнюю найденную.

Choices:

  • "first" ← (default)
  • "last"

new_description

string

Значение для изменения описания существующего снимка.

new_snapshot_name

string

Значение для переименования существующего снимка.

password

aliases: pass, pwd

string

Пароль сервера vSphere vCenter или ESXi.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_PASSWORD.

port

integer

Номер порта сервера vSphere vCenter или ESXi.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_PORT.

Default: 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.

Choices:

  • false ← (default)
  • true

remove_children

boolean

Если установлено значение true и state=absent, то для удаления устанавливается все поддерево снимка.

Choices:

  • false ← (default)
  • true

snapshot_id

integer

added in 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 или ESXi.

Если значение не указано в задаче, используется значение переменной среды VMWARE_USER.

uuid

string

UUID экземпляра для управления, если известен. По умолчанию — UUID BIOS VMware.

Требуется, если параметр name или moid не указан.

validate_certs

boolean

Разрешает подключение, когда сертификаты SSL недействительны. Устанавливается в значение false, когда сертификаты ненадёжны.

Если значение не указано в задаче, используется значение переменной среды VMWARE_VALIDATE_CERTS.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Все модули требуют доступа к API для записи и поэтому не поддерживаются на бесплатной лицензии ESXi.
  • Все переменные и имена объектов VMware регистрозависимые.

Примеры

- 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

словарь

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

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

Пример: {"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"}]}

Авторы

  • Loic Blot (@nerzhul)

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

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (источники)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API