openstack.cloud.os_keystone_role – Управление ролями идентификации OpenStack
Примечание
Этот плагин является частью коллекции openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud.
Для использования в книге задач укажите: openstack.cloud.os_keystone_role.
Обзор
- Управление ролями идентификации OpenStack.
Требования
Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 3.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должна ждать система сокетов, прежде чем истечёт время ожидания для вызовов API. Если это опущено, ничего не будет передано в библиотеку запросов. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую для стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password он должен содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать все параметры, необходимые данному подключаемому модулю авторизации. Этот параметр не требуется, если указано имя облака или присутствуют переменные среды OpenStack OS_*. | |
| auth_type строка | Имя подключаемого модуля авторизации для использования. Если облако использует что-то помимо парольной авторизации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone строка | Игнорируется. Присутствует для обратной совместимости | |
| ca_cert строка | Путь к пакету CA-сертификатов, который может использоваться для проверки запросов API SSL. алиасы: cacert | |
| client_cert строка | Путь к клиенту сертификата для использования в рамках транзакции SSL. алиасы: cert | |
| client_key строка | Путь к ключу клиента для использования в рамках транзакции SSL. алиасы: key | |
| cloud сырой | Наименованное облако или конфигурация облака для работы с ним. Если cloud — строка, она ссылается на конфигурацию облака, указанную в файле openstack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные среды OpenStack OS_* . Если cloud — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| interface строка |
| Тип URL-адреса конечной точки для получения из каталога служб. алиасы: endpoint_type |
| name строка / обязательно | Имя роли | |
| region_name строка | Имя региона. | |
| state строка |
| Ресурс должен быть present или absent. |
| timeout целое число | По умолчанию: 180 | Сколько времени Ansible должно ждать запрошенного ресурса. |
| validate_certs логический тип |
| Необходимо ли проверять запросы API SSL. До 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/
Примеры
# Create a role named "demo"
- openstack.cloud.identity_role:
cloud: mycloud
state: present
name: demo
# Delete the role named "demo"
- openstack.cloud.identity_role:
cloud: mycloud
state: absent
name: demo
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| role сложный | При успехе, когда state равен 'present'. | Словарь, описывающий роль. | |
| id строка | успех | Уникальный идентификатор роли. Пример: 677bfab34c844a01b88a217aa12ec4c2 | |
| name строка | успех | Имя роли. Пример: demo | |
Авторы
- OpenStack Ansible SIG
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/openstack/cloud/os_keystone_role_module.html
