Spec-Zone.ru › Ansible 2.6

cs_project — Управляет проектами на облачных платформах Apache CloudStack.

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

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

Обзор

  • Создание, обновление, приостановка, активация и удаление проектов.

Требования

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

  • python >= 2.6
  • cs >= 0.6.10

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
account
Учетная запись, к которой относится проект.
api_http_method
    Варианты:
  • get
  • post
HTTP-метод, используемый для запроса к API-точке.
Если не задано, используется переменная среды CLOUDSTACK_METHOD.
В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания.
Значение по умолчанию — get, если не указано.
api_key
Ключ API API CloudStack.
Если не задано, используется переменная среды CLOUDSTACK_KEY.
В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания.
api_region По умолчанию:
"cloudstack"
Имя раздела в файле конфигурации cloustack.ini.
Если не задано, используется переменная среды CLOUDSTACK_REGION.
api_secret
Секретный ключ API CloudStack.
Если не задано, используется переменная среды CLOUDSTACK_SECRET.
В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания.
api_timeout
Таймаут HTTP-запроса в секундах.
Если не задано, используется переменная среды CLOUDSTACK_TIMEOUT.
В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания.
Значение по умолчанию — 10 секунд, если не указано.
api_url
URL API CloudStack, например, https://cloud.example.com/client/api.
Если не задано, используется переменная среды CLOUDSTACK_ENDPOINT.
В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания.
display_text
Текст для отображения проекта.
Если не указано, будет использоваться name, как display_text.
domain
Домен, к которому относится проект.
name
обязательно
Имя проекта.
poll_async
bool
    Варианты:
  • no
  • да ←
Проверять асинхронные задачи до завершения.
state
    Варианты:
  • present ←
  • absent
  • active
  • suspended
Состояние проекта.
tags
(добавлено в 2.2)
Список тегов. Теги представляют собой список словарей, содержащих ключи key и value.
Если нужно удалить все теги, установите пустой список, например, tags: [].

Примечания

Примечание

  • 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.
  • Этот модуль поддерживает режим проверки.

Примеры

# Create a project
- local_action:
    module: cs_project
    name: web
    tags:
      - { key: admin, value: john }
      - { key: foo,   value: bar }

# Rename a project
- local_action:
    module: cs_project
    name: web
    display_text: my web project

# Suspend an existing project
- local_action:
    module: cs_project
    name: web
    state: suspended

# Activate an existing project
- local_action:
    module: cs_project
    name: web
    state: active

# Remove a project
- local_action:
    module: cs_project
    name: web
    state: absent

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

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

Ключ Возвращаемое значение Описание
account
строка
успех
Учетная запись, к которой относится проект.

Пример:
пример учетной записи
display_text
строка
успех
Текст для отображения проекта.

Пример:
веб-проект
domain
строка
успех
Домен, к которому относится проект.

Пример:
пример домена
id
строка
успех
UUID проекта.

Пример:
04589590-ac63-4ffc-93f5-b698b8ac38b6
name
строка
успех
Имя проекта.

Пример:
веб-проект
state
строка
успех
Состояние проекта.

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

Пример:
[ { "key": "foo", "value": "bar" } ]


Статус

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

Техническое обслуживание

Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.

Автор

  • 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.6/modules/cs_project_module.html

Spec-Zone.ru

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