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

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

Обзор

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

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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, см. также примечания.
description строка		Описание снимка.
domain строка		Домен, к которому относится снимок виртуальной машины.
name строка / обязательно		Уникальное имя снимка. В CloudStack — отображаемое имя. псевдонимы: display_name
poll_async логическое	Варианты: нет да ←	Ожидать завершения асинхронных задач.
project строка		Имя проекта, к которому назначена виртуальная машина.
snapshot_memory логическое	Варианты: нет ← да	Снимать память, если значение равно true.
state строка	Варианты: наличие ← отсутствует восстановление	Состояние снимка.
tags список добавлено в 2.4		Список тегов. Теги — список словарей с ключами key и value. Чтобы удалить все теги, установите пустой список, например, tags: []. псевдонимы: tag
vm строка / обязательно		Имя виртуальной машины.
zone строка		Имя зоны, в которой находится виртуальная машина. Если не задано, используется зона по умолчанию.

Примечания

Примечание

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

Примеры

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

- name: Revert a VM to a snapshot after a failed upgrade
  cs_vmsnapshot:
    name: Snapshot before upgrade
    vm: web-01
    state: revert
  delegate_to: localhost

- name: Remove a VM snapshot after successful upgrade
  cs_vmsnapshot:
    name: Snapshot before upgrade
    vm: web-01
    state: absent
  delegate_to: localhost

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

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

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

Статус

Изменения интерфейса модуля гарантированно будут обратной совместимостью в будущем. [stableinterface]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.9/modules/cs_vmsnapshot_module.html