Spec-Zone.ru › Ansible 2.7

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

Новая версия с 2.0.

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

Обзор

  • Регистрация и удаление образов 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
boolean
добавлено в 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
boolean
    Варианты:
  • нет ←
  • да
Этот флаг используется для поиска существующих ISO. Если установлен в yes, будут отображаться только готовые к развертыванию ISO (т. е. успешно загруженные и установленные). Рекомендуется установить в no.
iso_filter
-
    Варианты:
  • featured
  • self ←
  • selfexecutable
  • sharedexecutable
  • executable
  • community
Имя фильтра, используемого для поиска ISO.
name
- / обязательно
Имя ISO.
os_type
-
Название ОС, наиболее точно описывающее ОС этого ISO. Если ISO загрузочный, этот параметр необходим. Требуется, если state присутствует.
poll_async
boolean
добавлено в 2.3
    Варианты:
  • нет
  • да ←
Проверять асинхронные задания до завершения.
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 в домашней директории пользователя. Дополнительно, можно задавать несколько учетных данных и конечных точек, используя разделы ini в cloudstack.ini. Для выбора имени раздела используйте аргумент api_region, по умолчанию используется cloudstack. Дополнительная информация на https://github.com/exoscale/cs.
  • Подробное руководство по модулям Cloudstack можно найти в Руководстве по облакам CloudStack.
  • Этот модуль поддерживает режим проверки.

Примеры

# 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.

Пример:
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.

Пример:
Successfully Installed
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.7/modules/cs_iso_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API