openstack.cloud.os_user – Управление пользователями OpenStack Identity
Примечание
Этот плагин входит в коллекцию openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud.
Для использования в книге задач укажите: openstack.cloud.os_user.
Обзор
- Управление пользователями OpenStack Identity. С помощью этого модуля можно создавать, обновлять или удалять пользователей. Пользователь будет обновлён, если name совпадает с существующим пользователем и state присутствует. Значение name нельзя обновить без удаления и повторного создания пользователя.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- 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. | |
| default_project строка | Имя или идентификатор проекта, которому пользователь должен быть связан по умолчанию | |
| description строка | Описание пользователя | |
| domain строка | Домен для создания пользователя, если облако поддерживает домены | |
| email строка | Электронный адрес пользователя | |
| enabled логический тип |
| Пользователь активирован |
| interface строка |
| Тип URL-адреса конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type |
| name строка / обязательный | Имя пользователя | |
| password строка | Пароль пользователя | |
| region_name строка | Имя региона. | |
| state строка |
| Ресурс должен присутствовать или отсутствовать. |
| timeout целое число | По умолчанию: 180 | Сколько времени Ansible должен ждать запрошенного ресурса. |
| update_password строка |
| always будет пытаться обновить пароль. on_create будет устанавливать пароль только для вновь созданных пользователей. |
| 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 user
- openstack.cloud.identity_user:
cloud: mycloud
state: present
name: demouser
password: secret
email: demo@example.com
domain: default
default_project: demo
# Delete a user
- openstack.cloud.identity_user:
cloud: mycloud
state: absent
name: demouser
# Create a user but don't update password if user exists
- openstack.cloud.identity_user:
cloud: mycloud
state: present
name: demouser
password: secret
update_password: on_create
email: demo@example.com
domain: default
default_project: demo
# Create a user without password
- openstack.cloud.identity_user:
cloud: mycloud
state: present
name: demouser
email: demo@example.com
domain: default
default_project: demo
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| user сложный | При успехе, когда state равен 'present' | Словарь, описывающий пользователя. | |
| default_project_id строка | успех | Идентификатор проекта пользователя по умолчанию. Присутствует только с Keystone >= v3. Пример: 4427115787be45f08f0ec22a03bfc735 | |
| domain_id строка | успех | Идентификатор домена пользователя. Присутствует только с Keystone >= v3. Пример: default | |
| email строка | успех | Электронный адрес пользователя Пример: demo@example.com | |
| id строка | успех | Идентификатор пользователя Пример: f59382db809c43139982ca4189404650 | |
| name строка | успех | Имя пользователя Пример: demouser | |
Авторы
- 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_user_module.html
