cs_iso – Управляет образами ISO на облаках Apache CloudStack

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

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

Регистрация и удаление образов ISO.

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
account строка		Аккаунт, к которому относится ISO.
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, см. также примечания.
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. Если задано `yes`, будут показаны только готовые к развертыванию ISO (например, успешно загруженные и установленные). Рекомендуется установить `no`.
iso_filter строка	Варианты: featured self ← selfexecutable sharedexecutable executable community	Имя фильтра, используемого для поиска ISO.
name строка / обязательно		Имя ISO.
os_type строка		Имя ОС, которое лучше всего представляет ОС этого ISO. Если iso загрузочный, этот параметр должен быть передан. Требуется, если присутствует параметр state.
poll_async логическое значение	Варианты: нет да ←	Выполнять опрос асинхронных задач, пока задача не завершится.
project строка		Имя проекта, в котором необходимо зарегистрировать ISO.
state строка	Варианты: present ← absent	Состояние ISO.
tags список добавлен в 2.4		Список тегов. Теги представляют собой список словарей с ключами key и value. Для удаления всех тегов установите пустой список, например, tags: []. псевдонимы: tag
url строка		URL, откуда можно загрузить ISO. Требуется, если присутствует параметр state.
zone строка		Имя зоны, в которой вы хотите зарегистрировать или удалить ISO. Если не указано, будет использована первая найденная зона.

Примечания

Примечание

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: Register an ISO if ISO name does not already exist
  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)
  delegate_to: localhost

- name: Register an ISO with given name if ISO md5 checksum does not already exist
  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
  delegate_to: localhost

- name: Remove an ISO by name
  cs_iso:
    name: Debian 7 64-bit
    state: absent
  delegate_to: localhost

- name: Remove an ISO by checksum
  cs_iso:
    name: Debian 7 64-bit
    checksum: 0b31bccccb048d20b551f70830bb7ad0
    state: absent
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
account строка	успех	Аккаунт, к которому относится ISO. Пример: example account
bootable логическое значение добавлено в 2.4	успех	Истина, если ISO загрузочная. Пример: True
checksum строка	успех	MD5 контрольная сумма ISO. Пример: 0b31bccccb048d20b551f70830bb7ad0
created строка	успех	Дата регистрации. Пример: 2015-03-29T14:57:06+0200
cross_zones логическое значение добавлено в 2.4	успех	Истина, если ISO управляется во всех зонах, иначе ложь.
display_text строка	успех	Текст, который будет отображаться для ISO. Пример: Debian 7.7 64-bit minimal 2015-03-19
domain строка	успех	Домен, к которому относится ISO. Пример: example domain
format строка добавлено в 2.4	успех	Формат ISO. Пример: ISO
id строка	успех	UUID ISO. Пример: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
is_featured логическое значение добавлено в 2.4	успех	Истина, если ISO выделена. Пример: True
is_public логическое значение добавлено в 2.4	успех	Истина, если ISO публичная. Пример: True
is_ready логическое значение	успех	Истина, если ISO готова к развертыванию. Пример: True
name строка	успех	Имя ISO. Пример: Debian 7 64-bit
os_type строка добавлено в 2.4	успех	Тип ОС. Пример: CentOS 6.5 (64-bit)
project строка	успех	Проект, к которому относится ISO. Пример: example project
status строка	успех	Состояние ISO. Пример: Успешно установлено
tags словарь добавлено в 2.4	успех	Список тегов ресурсов, связанных с ISO. Пример: [ { "key": "foo", "value": "bar" } ]
zone строка	успех	Название зоны, в которой зарегистрирована ISO. Пример: zuerich

Статус

Данный модуль гарантированно будет иметь обратную совместимость в будущих изменениях. [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.9/modules/cs_iso_module.html