os_keystone_role - Управление ролями OpenStack Identity
Новое в версии 2.1.
Обзор
- Управление ролями OpenStack Identity.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout | Сколько времени слой сокетов должен ждать перед истечением времени ожидания для вызовов API. Если этот параметр опущен, библиотеке requests ничего не будет передано. | |
| auth | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password он будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать параметры, необходимые этому подключаемому модулю. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type | Имя подключаемого модуля авторизации для использования. Если облако использует что-то кроме аутентификации по паролю, имя подключаемого модуля должно быть указано здесь, и содержимое параметра auth должно быть обновлено соответствующим образом. | |
| availability_zone | Игнорируется. Присутствует для обратной совместимости | |
| cacert | Путь к пакету сертификатов CA, который можно использовать для проверки запросов API SSL. | |
| 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 bool |
| Необходимо ли проверять запросы API SSL. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| wait bool |
| 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 | ||
Статус
Этот модуль помечен как preview, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Подробнее см. Поддержка и техническое обслуживание модулей.
Список других модулей, поддерживаемых сообществом 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.6/modules/os_keystone_role_module.html
