cs_vmsnapshot - Управление моментальными снимками ВМ на облаках Apache CloudStack.
Новая версия с 2.0.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Создание, удаление и восстановление ВМ из снимков.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.6
- cs >= 0.6.10
Параметры
| параметр | обязателен | значение по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| account | нет | Аккаунт, к которому относится моментальный снимок ВМ. | ||
| api_http_method | нет | get |
| Используемый HTTP-метод. |
| api_key | нет | API-ключ CloudStack API. | ||
| api_region | нет | cloudstack | Имя раздела ini в файле cloustack.ini. | |
| api_secret | нет | Секретный ключ CloudStack API. | ||
| api_timeout | нет | 10 | Таймаут HTTP-запроса. | |
| api_url | нет | URL CloudStack API, например https://cloud.example.com/client/api. | ||
| description | нет | Описание снимка. | ||
| domain | нет | Домен, к которому относится моментальный снимок ВМ. | ||
| name | да | Уникальное имя снимка. В CloudStack — отображаемое имя. псевдонимы: display_name | ||
| poll_async | нет | True | Ожидание завершения асинхронных задач. | |
| project | нет | Имя проекта, к которому назначена ВМ. | ||
| snapshot_memory | нет | Моментальный снимок памяти (если установлено в значение true). | ||
| state | нет | present |
| Состояние снимка. |
| tags (добавлено в 2.4)
| нет | Список тегов. Теги — список словарей с ключами key и value. Для удаления всех тегов задайте пустой список, например tags: [].псевдонимы: tag | ||
| vm | да | Имя виртуальной машины. | ||
| zone | нет | Имя зоны, в которой находится ВМ. Если не указано, используется зона по умолчанию. |
Примеры
- 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 | Аккаунт, к которому относится моментальный снимок ВМ. | успех | строка | пример аккаунта |
| 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 |
Примечания
Примечание
- Ansible использует метод конфигурации библиотеки
cs, если учетные данные не предоставлены аргументамиapi_url,api_key,api_secret. Конфигурация считывается из нескольких мест в следующем порядке. - Переменные окруженияCLOUDSTACK_ENDPOINT,CLOUDSTACK_KEY,CLOUDSTACK_SECRETиCLOUDSTACK_METHOD. - Переменная окруженияCLOUDSTACK_CONFIG, указывающая на файл.ini, - Файлcloudstack.iniв текущей рабочей директории. - Файл.cloudstack.iniв домашней директории пользователя. Дополнительно, можно указать несколько учетных данных и конечных точек, используя разделы ini вcloudstack.ini. Используйте аргументapi_regionдля выбора имени раздела, по умолчанию используетсяcloudstack. Дополнительная информация доступна на странице https://github.com/exoscale/cs. - Подробное руководство по модулям CloudStack можно найти на странице http://docs.ansible.com/ansible/guide_cloudstack.html
- Этот модуль поддерживает режим проверки.
Статус
Этот модуль отмечен как stableinterface, что означает, что авторы данного модуля гарантируют, что не будут внесены несовместимые изменения в интерфейс.
Для получения помощи в разработке модулей, если вы заинтересованы, пожалуйста, ознакомьтесь со страницами Информация о сообществе и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/cs_vmsnapshot_module.html
