ngine_io.cloudstack.cs_vmsnapshot – Управляет снимками виртуальных машин на облаках на базе Apache CloudStack.

Примечание

Этот плагин входит в коллекцию ngine_io.cloudstack (версия 1.1.0).

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

Чтобы использовать его в книге задач, укажите: ngine_io.cloudstack.cs_vmsnapshot.

Новое в версии 0.1.0: из ngine_io.cloudstack

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

Обзор

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

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

python >= 2.6
cs >= 0.9.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
account строка		Аккаунт, к которому относится снимок виртуальной машины.
api_http_method строка	Варианты: get post	HTTP-метод, используемый для запроса к API-точке. Если не указано, используется переменная окружения `CLOUDSTACK_METHOD`. В качестве последнего варианта используется значение из файла конфигурации ini, также см. примечания. Значение по умолчанию — `get`, если не указано.
api_key строка		API-ключ CloudStack API. Если не указано, используется переменная окружения `CLOUDSTACK_KEY`. В качестве последнего варианта используется значение из файла конфигурации ini, также см. примечания.
api_region строка	По умолчанию: "cloudstack"	Имя раздела ini в файле `cloustack.ini`. Если не указано, используется переменная окружения `CLOUDSTACK_REGION`.
api_secret строка		Секретный ключ CloudStack API. Если не задано, используется переменная окружения `CLOUDSTACK_SECRET`. В качестве последнего варианта используется значение из файла конфигурации ini, также см. примечания.
api_timeout целое число		Таймаут HTTP в секундах. Если не задано, используется переменная окружения `CLOUDSTACK_TIMEOUT`. В качестве последнего варианта используется значение из файла конфигурации ini, также см. примечания. Значение по умолчанию — 10 секунд, если не указано.
api_url строка		URL CloudStack API, например, https://cloud.example.com/client/api. Если не задано, используется переменная окружения `CLOUDSTACK_ENDPOINT`. В качестве последнего варианта используется значение из файла конфигурации ini, также см. примечания.
api_verify_ssl_cert строка		Файл сертификата авторитета CA. Если не указано, используется переменная окружения `CLOUDSTACK_VERIFY`. В качестве последнего варианта используется значение из файла конфигурации ini, также см. примечания. Значение по умолчанию — `null` если не указано.
description строка		Описание снимка.
domain строка		Домен, к которому относится снимок виртуальной машины.
name строка / обязательно		Уникальное имя снимка. В CloudStack — отображаемое имя. псевдонимы: display_name
poll_async булево	Варианты: no да ←	Опрашивать асинхронные задания до завершения.
project строка		Имя проекта, к которому присвоена виртуальная машина.
snapshot_memory булево	Варианты: нет ← да	Снимок памяти, если установлено в значение "true".
state строка	Варианты: present ← absent revert	Состояние снимка.
tags список / элементы=словарь		Список тегов. Теги — список словарей с ключами key и value. Для удаления всех тегов установите пустой список, например, tags: []. псевдонимы: tag
vm строка / обязательно		Имя виртуальной машины.
zone строка		Имя зоны, в которой находится виртуальная машина. Если не задано, используется зона по умолчанию.

Примечания

Примечание

Ansible использует метод конфигурации библиотеки cs, если учетные данные не предоставлены аргументами api_url, api_key, api_secret. Конфигурация считывается из нескольких источников в указанном порядке. CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET и CLOUDSTACK_METHOD. Переменные окружения CLOUDSTACK_TIMEOUT. Переменная окружения CLOUDSTACK_CONFIG, указывающая на файл .ini. Файл cloudstack.ini в текущей рабочей директории. Файл .cloudstack.ini в домашнем каталоге пользователя. Допускается указание нескольких учетных данных и конечных точек с помощью разделов ini в cloudstack.ini. Используйте аргумент api_region для выбора имени раздела, по умолчанию используется cloudstack. Для получения дополнительной информации см. https://github.com/exoscale/cs.
Подробное руководство по модулям Cloudstack можно найти в Руководстве по облаку CloudStack.
Этот модуль поддерживает режим проверки.

Примеры

- name: Create a VM snapshot of disk and memory before an upgrade
  ngine_io.cloudstack.cs_vmsnapshot:
    name: Snapshot before upgrade
    vm: web-01
    snapshot_memory: yes

- name: Revert a VM to a snapshot after a failed upgrade
  ngine_io.cloudstack.cs_vmsnapshot:
    name: Snapshot before upgrade
    vm: web-01
    state: revert

- name: Remove a VM snapshot after successful upgrade
  ngine_io.cloudstack.cs_vmsnapshot:
    name: Snapshot before upgrade
    vm: web-01
    state: absent

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для этого модуля:

Ключ	Возвращаемое значение	Описание
account строка	успешно	Аккаунт, к которому относится снимок виртуальной машины. Пример: example account
created строка	успешно	Дата создания снимка. Пример: 2015-03-29T14:57:06+0200
current булево	успешно	true, если снимок текущий. Пример: True
description строка	успешно	Описание снимка виртуальной машины. Пример: снимок, созданный Ansible
display_name строка	успешно	Отображаемое имя снимка. Пример: снимок до обновления
domain строка	успешно	Домен, к которому относится снимок виртуальной машины. Пример: example domain
id строка	успешно	UUID снимка. Пример: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
name строка	успешно	Имя снимка. Пример: снимок до обновления
project строка	успешно	Имя проекта, к которому относится снимок виртуальной машины. Пример: Производство
state строка	успешно	Состояние снимка виртуальной машины. Пример: Выделено
type строка	успешно	Тип снимка виртуальной машины. Пример: DiskAndMemory

Авторы

René Moser (@resmo)

© 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/ngine_io/cloudstack/cs_vmsnapshot_module.html