cs_vmsnapshot - Управляет моментальными снимками ВМ в облаках на основе Apache CloudStack.

Новая версия с 2.0.

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

Обзор

Создание, удаление и откат ВМ из снимков.

Требования

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

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	Варианты: present ← absent revert	Состояние снимка.
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 переменные окружения. 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
  local_action:
    module: cs_vmsnapshot
    name: Snapshot before upgrade
    vm: web-01
    snapshot_memory: yes

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

- name: Remove a VM snapshot after successful upgrade
  local_action:
    module: 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

Статус

Этот модуль помечен как stableinterface, что означает, что разработчики гарантируют отсутствие несовместимых изменений интерфейса.

Автор

René Moser (@resmo)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ для улучшения.

END_OF_DOCUMENT_MARKER

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/cs_vmsnapshot_module.html