os_user_role – Ассоциирование пользователей и ролей OpenStack Identity
Обзор
- Предоставление и отмена ролей в контексте проекта или домена для пользователей OpenStack Identity.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должно ждать слои сокетов перед истечением времени ожидания для API-запросов. Если этот параметр опущен, в библиотеку requests ничего не будет передано. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, os_user_domain_name или os_project_domain_name), если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать необходимые параметры. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type строка | Имя подключаемого модуля авторизации, который необходимо использовать. Если облако использует что-то кроме аутентификации по паролю, здесь нужно указать имя подключаемого модуля, а содержимое параметра auth нужно обновить соответствующим образом. | |
| availability_zone - | Игнорируется. Присутствует для обратной совместимости. | |
| ca_cert строка | Путь к пакету CA-сертификатов, который можно использовать для проверки SSL-API-запросов. псевдонимы: cacert | |
| client_cert строка | Путь к клиенту сертификату, который используется в рамках SSL-транзакции. псевдонимы: cert | |
| client_key строка | Путь к ключу клиента, который используется в рамках SSL-транзакции. псевдонимы: key | |
| cloud raw | Наименованное облако или конфигурация облака для работы с ним. Если cloud является строкой, она ссылается на конфигурацию именованного облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или если присутствуют переменные окружения OpenStack OS_*. Если cloud является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| domain - | Имя или ID домена, для ограничения ассоциации роли. Действителен только с keystone версии 3 и требуется, если project не указан. | |
| group - | Имя или ID группы. Действителен только с keystone версии 3. Если group не указан, то требуется user. Оба параметра не могут быть указаны. | |
| interface строка |
| Тип URL конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type |
| project - | Имя или ID проекта, для ограничения ассоциации роли. Если используется keystone версия 2, то это значение обязательно. | |
| region_name строка | Имя региона. | |
| role - / обязательно | Имя или ID роли. | |
| state - |
| Роли должны быть присутствовать или отсутствовать у пользователя. |
| timeout целое число | Значение по умолчанию: 180 | Сколько времени Ansible должно ждать запрошенного ресурса. |
| user - | Имя или ID пользователя. Если user не указан, то требуется group. Оба параметра не могут быть указаны. | |
| validate_certs логическое |
| Необходимо ли проверять SSL-API-запросы. До Ansible 2.3 это по умолчанию было yes. псевдонимы: verify |
| wait логическое |
| Ansible должен ждать, пока запрошенный ресурс не будет завершен. |
Примечания
Примечание
- Можно использовать стандартные переменные окружения OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации управляется openstacksdk, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, а в последнюю очередь из явных параметров в задачах. Дополнительную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/
Примеры
# Grant an admin role on the user admin in the project project1
- os_user_role:
cloud: mycloud
user: admin
role: admin
project: project1
# Revoke the admin role from the user barney in the newyork domain
- os_user_role:
cloud: mycloud
state: absent
user: barney
role: admin
domain: newyork
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Monty Taylor (@emonty), David Shrewsbury (@Shrews)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/os_user_role_module.html
