Spec-Zone.ru › Ansible 2.5

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

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

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

Описание

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

Требования

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

  • python >= 2.6
  • cs >= 0.6.10

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
account Значение по умолчанию:
None
Учетная запись, к которой относится ISO.
api_http_method
    Варианты:
  • get
  • post
Метод HTTP, используемый для запроса к API-точке.
Если не указан, рассматривается переменная среды CLOUDSTACK_METHOD.
В качестве последнего варианта, значение берется из файла конфигурации ini, также см. примечания.
Значение по умолчанию get, если не указано.
api_key
Ключ API CloudStack API.
Если не указан, рассматривается переменная среды CLOUDSTACK_KEY.
В качестве последнего варианта, значение берется из файла конфигурации ini, также см. примечания.
api_region Значение по умолчанию:
cloudstack
Имя раздела в файле конфигурации 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 Значение по умолчанию:
None
Зарегистрировать ISO для загрузки. Используется только если state присутствует.
checksum Значение по умолчанию:
None
Значение контрольной суммы MD5 этого ISO. Если задано, поиск выполняется по контрольной сумме вместо имени.
cross_zones
(добавлено в 2.4)
Значение по умолчанию:
no
Синхронизировать или удалить ISO по зонам.
Взаимоисключающее с zone.
display_text
(добавлено в 2.4)
Значение по умолчанию:
None
Текст отображения ISO.
Если не указано, используется name.
domain Значение по умолчанию:
None
Домен, к которому относится ISO.
is_dynamically_scalable Значение по умолчанию:
None
Зарегистрировать ISO с установленным инструментом XS/VMWare для поддержки динамического масштабирования процессора/памяти VM. Используется только если state присутствует.
is_featured Значение по умолчанию:
None
Зарегистрировать ISO для отображения. Используется только если state присутствует.
is_public Значение по умолчанию:
None
Зарегистрировать ISO для общего доступа для всех пользователей. Используется только если state присутствует.
is_ready Значение по умолчанию:
no
Флаг используется для поиска существующих ISO. Если установлено true, будут отображаться только ISO, готовые к развертыванию, например, успешно загруженные и установленные. Рекомендуется установить значение false.
iso_filter
    Варианты:
  • featured
  • self ←
  • selfexecutable
  • sharedexecutable
  • executable
  • community
Имя фильтра, используемого для поиска ISO.
name
обязательно
Имя ISO.
os_type Значение по умолчанию:
None
Имя ОС, которое наилучшим образом описывает ОС этого ISO. Если ISO загружаемый, этот параметр необходимо передать. Требуется, если state присутствует.
poll_async
(добавлено в 2.3)
Значение по умолчанию:
yes
Ожидание завершения асинхронных задач.
project Значение по умолчанию:
None
Имя проекта, в котором должен быть зарегистрирован ISO.
state
    Варианты:
  • present ←
  • absent
Состояние ISO.
tags
(добавлено в 2.4)
Значение по умолчанию:
None
Список тегов. Теги — список словарей, содержащих ключи key и value.
Чтобы удалить все теги, установите пустой список, например, tags: [].

псевдонимы: tag
url Значение по умолчанию:
None
URL для загрузки ISO. Требуется, если state присутствует.
zone Значение по умолчанию:
None
Имя зоны, в которой необходимо зарегистрировать или удалить 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
логическое
успех
True, если ISO загрузочный.

Пример:
True
checksum
строка
успех
MD5 контрольная сумма ISO.

Пример:
0b31bccccb048d20b551f70830bb7ad0
created
строка
успех
Дата регистрации.

Пример:
2015-03-29T14:57:06+0200
cross_zones
логическое
успех
true, если ISO управляется во всех зонах, иначе false.

display_text
строка
успех
Текст для отображения ISO.

Пример:
Debian 7.7 64-bit minimal 2015-03-19
domain
строка
успех
Домен, к которому относится ISO.

Пример:
example domain
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-bit
os_type
строка
успех
Тип ОС.

Пример:
CentOS 6.5 (64-bit)
project
строка
успех
Проект, к которому относится ISO.

Пример:
example project
status
строка
успех
Статус ISO.

Пример:
Успешно установлена
tags
словарь
успех
Список тегов ресурсов, связанных с ISO.

Пример:
[ { "key": "foo", "value": "bar" } ]
zone
строка
успех
Название зоны, в которой зарегистрирована ISO.

Пример:
zuerich


Статус

Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будут вноситься несовместимые изменения в интерфейс.

Автор

  • 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.5/modules/cs_iso_module.html

Spec-Zone.ru

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