ngine_io.cloudstack.cs_vmsnapshot – Управляет снимками виртуальных машин на облаках на базе Apache CloudStack.
Примечание
Этот плагин входит в коллекцию ngine_io.cloudstack (версия 2.0.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 строка |
| HTTP-метод, используемый для запроса к API-точке входа. Если не указано, используется значение переменной окружения CLOUDSTACK_METHOD. |
| api_key строка / обязательно | API-ключ API CloudStack. Если не указано, используется значение переменной окружения CLOUDSTACK_KEY. | |
| api_secret строка / обязательно | Секретный ключ API CloudStack. Если не указано, используется значение переменной окружения CLOUDSTACK_SECRET. | |
| api_timeout целое число | По умолчанию: 10 | Таймаут HTTP в секундах. Если не указано, используется значение переменной окружения CLOUDSTACK_TIMEOUT. |
| api_url строка / обязательно | URL API CloudStack, например, https://cloud.example.com/client/api. Если не указано, используется значение переменной окружения CLOUDSTACK_ENDPOINT. | |
| api_verify_ssl_cert строка | Проверка сертификата CA. Если не указано, используется значение переменной окружения CLOUDSTACK_VERIFY. | |
| description строка | Описание снимка. | |
| domain строка | Домен, к которому относится снимок виртуальной машины. | |
| name строка / обязательно | Уникальное имя снимка. В CloudStack — это имя для отображения. псевдонимы: display_name | |
| poll_async логическое |
| Проверка асинхронных задач до завершения. |
| project строка | Имя проекта, к которому назначена виртуальная машина. | |
| snapshot_memory логическое |
| Снимок памяти, если значение true. |
| state строка |
| Состояние снимка. |
| tags список / элементы=словарь | Список тегов. Теги — список словарей с ключами key и value. Для удаления всех тегов задайте пустой список, например, tags: []. псевдонимы: tag | |
| vm строка / обязательно | Имя виртуальной машины. | |
| zone строка / обязательно | Имя зоны, в которой находится виртуальная машина. Если не указано. |
Примечания
Примечание
- Подробное руководство по модулям Cloudstack можно найти в руководстве CloudStack Cloud.
- Этот модуль поддерживает режим проверки.
Примеры
- name: Create a VM snapshot of disk and memory before an upgrade
ngine_io.cloudstack.cs_vmsnapshot:
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.cs_vmsnapshot:
name: Snapshot before upgrade
vm: web-01
zone: zone01
state: revert
- name: Remove a VM snapshot after successful upgrade
ngine_io.cloudstack.cs_vmsnapshot:
name: Snapshot before upgrade
vm: web-01
zone: zone01
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| account строка | успех | Аккаунт, к которому относится снимок ВМ. Пример: пример аккаунта |
| created строка | успех | Дата создания снимка. Пример: 2015-03-29T14:57:06+0200 |
| current логическое | успех | true, если снимок является текущим Пример: True |
| description строка | успех | Описание снимка ВМ Пример: снимок, созданный Ansible |
| display_name строка | успех | Имя снимка для отображения. Пример: снимок перед обновлением |
| domain строка | успех | Домен, к которому относится снимок ВМ. Пример: пример домена |
| id строка | успех | UUID снимка. Пример: a6f7a5fc-43f8-11e5-a151-feff819cdc9f |
| name строка | успех | Имя снимка. Пример: снимок перед обновлением |
| project строка | успех | Имя проекта, к которому относится снимок ВМ. Пример: Производство |
| state строка | успех | Состояние снимка ВМ Пример: Размещён |
| type строка | успех | Тип снимка ВМ Пример: DiskAndMemory |
Авторы
- René Moser (@resmo)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ngine_io/cloudstack/cs_vmsnapshot_module.html
