os_keystone_role - Управление ролями OpenStack Identity
Новое в версии 2.1.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Управление ролями OpenStack Identity.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.6
- python >= 2.7
- shade
Параметры
| параметр | обязателен | значение по умолчанию | выбор | комментарии |
|---|---|---|---|---|
| api_timeout | нет | None | Сколько времени (в секундах) должно ждать сокетное подключение перед завершением вызова API. Если этот параметр опущен, он не будет передан в библиотеку requests. | |
| auth | нет | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password он будет содержать auth_url, username, password, project_name и любые сведения о доменах, если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать требуемые параметры. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | ||
| auth_type | нет | password | Имя используемого подключаемого модуля авторизации. Если облако использует что-то кроме парольной аутентификации, имя подключаемого модуля должно быть указано здесь, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone | нет | Игнорируется. Присутствует для обратной совместимости | ||
| cacert | нет | None | Путь к пакету сертификатов CA, который можно использовать для проверки запросов API SSL. | |
| cert | нет | None | Путь к клиенту сертификату, который следует использовать в рамках SSL транзакции. | |
| cloud | нет | Используемое облако. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или присутствуют переменные окружения OpenStack OS_*. | ||
| endpoint_type | нет | public |
| Тип URL-адреса конечной точки для извлечения из каталога сервисов. |
| key | нет | None | Путь к клиенту ключу для использования в рамках SSL транзакции. | |
| name | да | Имя роли | ||
| region_name | нет | Имя региона. | ||
| state | нет | present |
| Должен ли ресурс быть присутствующим или отсутствующим. |
| timeout | нет | 180 | Сколько времени Ansible должно ждать запрашиваемого ресурса. | |
| validate_certs | нет | Должны ли запросы API SSL проверяться. До версии 2.3 по умолчанию было True. алиасы: verify | ||
| wait | нет | yes |
| Должен ли Ansible ждать, пока запрашиваемый ресурс будет завершён. |
Примеры
# 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 | Словарь, описывающий роль. | При успехе, когда I(state) равен 'present'. | сложный | ||||||||||||||||
| содержит: |
| ||||||||||||||||||
Примечания
Примечание
- Можно использовать стандартные переменные окружения 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
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.
Для получения помощи в разработке модулей, если вы так заинтересованы, ознакомьтесь с Информация сообщества и участие, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/os_keystone_role_module.html
