cs_role – Управляет ролями пользователей в облаках на основе Apache CloudStack.
Новое в версии 2.3.
Описание
- Создание, обновление, удаление ролей пользователей.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- cs >= 0.6.10
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_http_method - |
| 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, см. также примечания. | |
| description - | Описание роли. | |
| id - | ID роли. Если задан, используется id в качестве ключа.Псевдонимы: uuid | |
| name - / обязательно | Имя роли. | |
| role_type - |
| Тип роли. Учитывается только при создании. |
| state - |
| Состояние роли. |
Примечания
Примечание
- 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 строка | успех | Тип роли. Пример: Пользователь |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.7/modules/cs_role_module.html