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 API CloudStack. Если не указано, используется значение из переменной среды `CLOUDSTACK_KEY`. В качестве последнего варианта, значение берётся из файла конфигурации ini, см. также примечания.
api_region	По умолчанию: "cloudstack"	Имя раздела ini в файле `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, см. также примечания.
description		Описание роли.
id		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 строка	успех	Описание роли. Пример: Это описание моей роли
id строка	успех	UUID роли. Пример: 04589590-ac63-4ffc-93f5-b698b8ac38b6
name строка	успех	Имя роли. Пример: myrole
role_type строка	успех	Тип роли. Пример: Пользователь

Статус

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

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

Этот модуль помечен как 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_role_module.html