cs_iso - Управляет образами ISO в облаках на основе Apache CloudStack.
Новая версия с 2.0.
- Обзор
- Требования (на хосте, на котором выполняется модуль)
- Параметры
- Примеры
- Значения возврата
- Примечания
Обзор
- Регистрация и удаление образов ISO.
Требования (на хосте, на котором выполняется модуль)
- python >= 2.6
- cs >= 0.6.10
Параметры
| параметр | обязательно | по умолчанию | выбор | комментарии |
|---|---|---|---|---|
| account | нет | Аккаунт, к которому относится ISO. | ||
| 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. | ||
| bootable | нет | Зарегистрировать ISO как загрузочный. Используется только если state присутствует. | ||
| checksum | нет | Значение MD5 контрольной суммы этого ISO. Если задано, поиск выполняется по контрольной сумме, а не имени. | ||
| cross_zones (добавлен в 2.4)
| нет | Синхронизировать или удалить ISO по зонам. Взаимоисключающее с zone. | ||
| display_text (добавлен в 2.4)
| нет | Текст для отображения ISO. Если не указано, используется name. | ||
| domain | нет | Домен, к которому относится ISO. | ||
| is_dynamically_scalable | нет | Зарегистрировать ISO с установленными инструментами XS/VMWare для поддержки динамического масштабирования процессора/памяти виртуальной машины. Используется только если state присутствует. | ||
| is_featured | нет | Зарегистрировать ISO для выделения. Используется только если state присутствует. | ||
| is_public | нет | Зарегистрировать ISO для публичного доступа всем пользователям. Используется только если state присутствует. | ||
| is_ready | нет | Этот флаг используется для поиска существующих ISO. Если установлен в true, будут отображаться только готовые к развертыванию ISO, например, успешно загруженные и установленные. Рекомендуется установить в false. | ||
| iso_filter | нет | self |
| Имя фильтра, используемого для поиска ISO. |
| name | да | Имя ISO. | ||
| os_type | нет | Имя ОС, лучше всего представляющее ОС этого ISO. Если ISO загрузочный, этот параметр должен быть передан. Требуется, если state присутствует. | ||
| poll_async (добавлен в 2.3)
| нет | True | Ожидать завершения асинхронных задач. | |
| project | нет | Имя проекта, в котором должен быть зарегистрирован ISO. | ||
| state | нет | present |
| Состояние ISO. |
| tags (добавлен в 2.4)
| нет | Список тегов. Теги — это список словарей с ключами key и value. Чтобы удалить все теги, задайте пустой список, например, tags: []. псевдонимы: тег | ||
| url | нет | URL, откуда можно загрузить ISO. Требуется, если state присутствует. | ||
| zone | нет | Имя зоны, в которой нужно зарегистрировать или удалить ISO. Если не указано, будет использована первая найденная зона. |
Примеры
# Register an ISO if ISO name does not already exist.
- local_action:
module: cs_iso
name: Debian 7 64-bit
url: http://mirror.switch.ch/ftp/mirror/debian-cd/current/amd64/iso-cd/debian-7.7.0-amd64-netinst.iso
os_type: Debian GNU/Linux 7(64-bit)
# Register an ISO with given name if ISO md5 checksum does not already exist.
- local_action:
module: cs_iso
name: Debian 7 64-bit
url: http://mirror.switch.ch/ftp/mirror/debian-cd/current/amd64/iso-cd/debian-7.7.0-amd64-netinst.iso
os_type: Debian GNU/Linux 7(64-bit)
checksum: 0b31bccccb048d20b551f70830bb7ad0
# Remove an ISO by name
- local_action:
module: cs_iso
name: Debian 7 64-bit
state: absent
# Remove an ISO by checksum
- local_action:
module: cs_iso
name: Debian 7 64-bit
checksum: 0b31bccccb048d20b551f70830bb7ad0
state: absent
Значения возврата
Общие значения возврата документированы здесь Значения возврата, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| account | Аккаунт, к которому относится ISO. | успех | строка | пример аккаунта |
| bootable | True, если ISO загрузочный. | успех | булево | True |
| checksum | MD5 контрольная сумма ISO. | успех | строка | 0b31bccccb048d20b551f70830bb7ad0 |
| created | Дата регистрации. | успех | строка | 2015-03-29T14:57:06+0200 |
| cross_zones | true, если ISO управляется по всем зонам, иначе false. | успех | булево | False |
| display_text | Текст, отображаемый для ISO. | успех | строка | Debian 7.7 64-разрядный минимальный 2015-03-19 |
| domain | Домен, к которому относится ISO. | успех | строка | пример домена |
| format | Формат ISO. | успех | строка | ISO |
| id | UUID ISO. | успех | строка | a6f7a5fc-43f8-11e5-a151-feff819cdc9f |
| is_featured | True, если ISO выделен. | успех | булево | True |
| is_public | True, если ISO публичен. | успех | булево | True |
| is_ready | True, если ISO готов к развертыванию. | успех | булево | True |
| name | Имя ISO. | успех | строка | Debian 7 64-разрядный |
| os_type | Тип ОС. | успех | строка | CentOS 6.5 (64-разрядный) |
| project | Проект, к которому относится ISO. | успех | строка | пример проекта |
| status | Статус ISO. | успех | строка | Установлено успешно |
| tags | Список тегов ресурса, связанных с ISO. | успех | словарь | [ { "key": "foo", "value": "bar" } ] |
| zone | Имя зоны, в которой зарегистрирован ISO. | успех | строка | zuerich |
Примечания
Примечание
- 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 можно найти на http://docs.ansible.com/ansible/guide_cloudstack.html
- Этот модуль поддерживает режим проверки.
Статус
Этот модуль помечен как stableinterface, что означает, что авторы этого модуля гарантируют отсутствие несовместимых изменений интерфейса.
Для получения помощи в разработке модулей, если это вас интересует, пожалуйста, ознакомьтесь с Информация о сообществе и участие, Тестирование Ansible и Разработка модулей.
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.4/cs_iso_module.html