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 -	По умолчанию: "нет"	Снимок памяти, если установлено в значение «да».
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
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.7/modules/cs_vmsnapshot_module.html