os_keystone_role - Управление ролями OpenStack Identity
Новое в версии 2.1.
Обзор
- Управление ролями OpenStack Identity.
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- python >= 2.7
- shade
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout | Сколько времени должен ждать уровень сокета, прежде чем истечёт время ожидания для вызовов API. Если это опущено, ничего не будет передано в библиотеку requests. | |
| auth | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемых модулей авторизации облака. Для стандартного подключаемого модуля password он должен содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать любые необходимые параметры. Этот параметр не нужен, если предоставлено имя облака или присутствуют переменные среды OpenStack OS_*. | |
| auth_type | Имя подключаемого модуля авторизации для использования. Если облако использует что-то отличное от парольной аутентификации, имя подключаемого модуля должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone | Игнорируется. Присутствует для обеспечения обратной совместимости. | |
| cacert | Путь к пакету сертификатов CA, который может использоваться при проверке запросов SSL API. | |
| cert | Путь к клиенту сертификат для использования в рамках транзакции SSL. | |
| cloud | Наименованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на конфигурацию облака с именем, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или присутствуют переменные среды OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| interface (добавлено в 2.3) |
| Тип URL конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type |
| key | Путь к ключу клиента для использования в рамках транзакции SSL. | |
| name обязательно | Имя роли | |
| region_name | Имя региона. | |
| state |
| Ресурс должен быть присутствующим или отсутствующим. |
| timeout | По умолчанию: 180 | Сколько времени Ansible должно ждать запрошенного ресурса. |
| verify |
| Подтверждать или нет запросы SSL API. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| wait |
| Ansible должно ждать, пока запрошенный ресурс не будет завершён. |
Примечания
Примечание
- Стандартные переменные окружения OpenStack, такие как
OS_USERNAME, могут быть использованы вместо явного указания значений. - Информация об авторизации управляется os-client-config, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, и, наконец, из явных параметров в задачах. Более подробную информацию можно найти на http://docs.openstack.org/developer/os-client-config
Примеры
# Create a role named "demo"
- os_keystone_role:
cloud: mycloud
state: present
name: demo
# Delete the role named "demo"
- os_keystone_role:
cloud: mycloud
state: absent
name: demo
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращённое значение | Описание | |
|---|---|---|---|
| role сложный | При успехе, когда state равен 'present'. | Словарь, описывающий роль. | |
| id строка | Уникальный идентификатор роли. Пример: 677bfab34c844a01b88a217aa12ec4c2 | ||
| name строка | Имя роли. Пример: demo | ||
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратной совместимости.
Автор
- 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.5/modules/os_keystone_role_module.html