openstack.cloud.identity_role – Управление ролями OpenStack Identity
Примечание
Этот плагин входит в коллекцию openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud.
Для использования в книге задач укажите: openstack.cloud.identity_role.
Описание
- Управление ролями OpenStack Identity.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 3.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должна ждать сокет-слой перед таймаутом вызовов API. Если это значение опущено, оно не будет передано в библиотеку requests. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password, это будет содержать auth_url, username, password, project_name и любую информацию о домене (например, user_domain_name или 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 сырой | Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если указан auth или присутствуют переменные среды OpenStack OS_* . Если cloud — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| interface строка |
| Тип URL-адреса конечной точки для извлечения из каталога служб. Псевдонимы: endpoint_type |
| name строка / обязательно | Имя роли | |
| region_name строка | Имя региона. | |
| state строка |
| Должен ли ресурс присутствовать или отсутствовать. |
| timeout целое число | По умолчанию: 180 | Сколько времени Ansible должно ждать запрашиваемого ресурса. |
| 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/
Примеры
# 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/identity_role_module.html