Модуль ngine_io.cloudstack.instance_snapshot — управление снимками экземпляров в облаках на базе Apache CloudStack.

Примечание

Этот модуль входит в коллекцию ngine_io.cloudstack (версия 3.0.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install ngine_io.cloudstack. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: ngine_io.cloudstack.instance_snapshot.

Новое в ngine_io.cloudstack 0.1.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Псевдонимы: cs_vmsnapshot

Требования

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

python >= 2.6
cs >= 0.9.0

Параметры

Параметр	Комментарии
account string	Учётная запись, к которой относится снимок виртуальной машины.
api_http_method string	Метод HTTP, используемый для запроса к конечной точке API. Если параметр не задан, используется переменная окружения `CLOUDSTACK_METHOD`. Варианты: `"get"` ← (по умолчанию) `"post"`
api_key string / обязательный	Ключ API CloudStack. Если параметр не задан, используется переменная окружения `CLOUDSTACK_KEY`.
api_secret string / обязательный	Секретный ключ API CloudStack. Если параметр не задан, используется переменная окружения `CLOUDSTACK_SECRET`.
api_timeout integer	Тайм-аут HTTP в секундах. Если параметр не задан, используется переменная окружения `CLOUDSTACK_TIMEOUT`. По умолчанию: `10`
api_url string / обязательный	URL API CloudStack, например https://cloud.example.com/client/api. Если параметр не задан, используется переменная окружения `CLOUDSTACK_ENDPOINT`.
api_verify_ssl_cert string	Проверять файл сертификата центра сертификации. Если параметр не задан, используется переменная окружения `CLOUDSTACK_VERIFY`.
description string	Описание снимка.
domain string	Домен, к которому относится снимок виртуальной машины.
name псевдонимы: display_name string / обязательный	Уникальное имя снимка. В терминологии CloudStack — отображаемое имя.
poll_async boolean	Ожидать завершения асинхронных заданий, опрашивая их состояние. Варианты: `false` `true` ← (по умолчанию)
project string	Имя проекта, которому назначена виртуальная машина.
snapshot_memory boolean	Создавать снимок памяти, если задано значение true. Варианты: `false` ← (по умолчанию) `true`
state string	Состояние снимка. Варианты: `"present"` ← (по умолчанию) `"absent"` `"revert"`
tags псевдоним: tag list / элементы=dictionary	Список тегов. Теги представляют собой список словарей с ключами key и value. Чтобы удалить все теги, задайте пустой список, например tags: [].
validate_certs boolean добавлено в ngine_io.cloudstack 2.4.0	Если задано значение `false`, SSL-сертификаты проверяться не будут. Если параметр не задан, используется переменная окружения `CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY`. Этот параметр следует использовать только на подконтрольных вам сайтах с самоподписанными сертификатами. Варианты: `false` `true` ← (по умолчанию)
vm string / обязательный	Имя виртуальной машины.
zone string / обязательный	Имя зоны, в которой находится виртуальная машина. Если не задано.

Примечания

Примечание

Подробное руководство по модулям CloudStack доступно в руководстве по облаку CloudStack.
Этот модуль поддерживает режим проверки.

Примеры

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

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

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

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

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

Ключ	Описание
account string	Учётная запись, к которой относится снимок виртуальной машины. Возвращается: при успехе Пример: `"example account"`
created string	Дата создания снимка. Возвращается: при успехе Пример: `"2015-03-29T14:57:06+0200"`
current boolean	true, если снимок является текущим Возвращается: при успехе Пример: `true`
description string	Описание снимка виртуальной машины Возвращается: при успехе Пример: `"snapshot brought to you by Ansible"`
display_name string	Отображаемое имя снимка. Возвращается: при успехе Пример: `"snapshot before update"`
domain string	Домен, к которому относится снимок виртуальной машины. Возвращается: при успехе Пример: `"example domain"`
id string	UUID снимка. Возвращается: при успехе Пример: `"a6f7a5fc-43f8-11e5-a151-feff819cdc9f"`
name string	Имя снимка. Возвращается: при успехе Пример: `"snapshot before update"`
project string	Имя проекта, к которому относится снимок виртуальной машины. Возвращается: при успехе Пример: `"Production"`
state string	Состояние снимка виртуальной машины Возвращается: при успехе Пример: `"Allocated"`
type string	Тип снимка виртуальной машины Возвращается: при успехе Пример: `"DiskAndMemory"`

Авторы

René Moser (@resmo)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/ngine_io/cloudstack/instance_snapshot_module.html