Spec-Zone.ru › Ansible 2.11

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

Примечание

Этот плагин является частью коллекции community.vmware (версия 1.7.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 ←
  • absent
  • revert
  • remove_all
Управление снимками, прикрепленными к определенной виртуальной машине.
Если установлено значение present, и снимок отсутствует, создается новый снимок с заданным именем.
Если установлено значение present и снимок присутствует, изменения не производятся.
Если установлено значение absent и снимок присутствует, снимок с заданным именем удаляется.
Если установлено значение absent и снимок отсутствует, изменения не производятся.
Если установлено значение revert и снимок присутствует, состояние виртуальной машины возвращается к заданному снимку.
Если установлено значение revert и снимок отсутствует, изменения не производятся.
Если установлено значение remove_all и присутствует снимок(и), все снимки будут удалены.
Если установлено значение remove_all и снимков нет, изменения не производятся.
use_instance_uuid
логическое
    Варианты:
  • нет ←
  • да
Использовать идентификатор UUID экземпляра VMware вместо BIOS UUID.
username
строка
Имя пользователя сервера vCenter vSphere или ESXi.
Если значение не указано в задаче, используется значение переменной окружения VMWARE_USER.
Поддержка переменных среды добавлена в Ansible 2.6.

псевдонимы: admin, user
uuid
строка
UUID экземпляра для управления, если он известен, по умолчанию используется BIOS UUID 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': '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'}]}


Авторы

  • Лоик Блот (@nerzhul) <loic.blot@unix-experience.fr>

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

Spec-Zone.ru

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