Spec-Zone.ru › Ansible 2.5

cs_role — Управление ролями пользователей в облаках на основе Apache CloudStack.

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

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

Описание

  • Создание, обновление и удаление ролей пользователей.

Требования

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

  • python >= 2.6
  • cs >= 0.6.10

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
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
Секретный ключ API 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, см. также раздел «Примечания».
description Значение по умолчанию:
None
Описание роли.
id Значение по умолчанию:
None
ID роли.
Если указано, используется id в качестве ключа.

алиасы: uuid
name
обязательно
Имя роли.
role_type
    Варианты:
  • Пользователь ←
  • DomainAdmin
  • ResourceAdmin
  • Admin
Тип роли.
Учитывается только при создании.
state
    Варианты:
  • present ←
  • absent
Состояние роли.

Примечания

Примечание

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

Примеры

# Ensure an user role is present
- local_action:
    module: cs_role
    name: myrole_user

# Ensure a role having particular ID is named as myrole_user
- local_action:
    module: cs_role
    name: myrole_user
    id: 04589590-ac63-4ffc-93f5-b698b8ac38b6

# Ensure a role is absent
- local_action:
    module: cs_role
    name: myrole_user
    state: absent

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

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

Ключ Возвращаемое значение Описание
description
строка
success
Описание роли.

Пример:
Это описание моей роли
id
строка
success
UUID роли.

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

Пример:
myrole
role_type
строка
success
Тип роли.

Пример:
Пользователь


Статус

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

Автор

  • 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_role_module.html

Spec-Zone.ru

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