os_user – Управление пользователями OpenStack Identity
Новое в версии 2.0.
Обзор
- Управление пользователями OpenStack Identity. С помощью этого модуля можно создавать, обновлять или удалять пользователей. Пользователь будет обновлен, если name совпадает с существующим пользователем и state задано. Значение name нельзя обновить без удаления и повторного создания пользователя.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout - | Сколько времени должно ждать подключение перед истечением времени ожидания для вызовов API. Если это опущено, ничего не будет передано в библиотеку requests. | |
| auth - | Словарь, содержащий информацию об авторизации, необходимую стратегии подключа к облаку. Для подключа по умолчанию password, это будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других подключа, этот параметр должен содержать параметры, необходимые для данного подключа. Этот параметр не нужен, если задан параметр cloud или присутствуют переменные окружения 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. | |
| default_project - | Имя или идентификатор проекта, с которым пользователь должен быть связан по умолчанию | |
| description - добавлено в 2.4 | Описание пользователя | |
| domain - | Домен для создания пользователя, если облако поддерживает домены | |
| email - | Адрес электронной почты пользователя | |
| enabled boolean |
| Пользователь включен |
| interface - добавлено в 2.3 |
| Тип URL конечной точки для извлечения из каталога сервиса. псевдонимы: endpoint_type |
| key - | Путь к ключу клиента для использования в рамках транзакции SSL. | |
| name - / обязательно | Имя пользователя | |
| password - | Пароль пользователя | |
| region_name - | Имя региона. | |
| state - |
| Ресурс должен присутствовать или отсутствовать. |
| timeout - | По умолчанию: 180 | Сколько времени Ansible должно ждать запрошенного ресурса. |
| update_password - добавлено в 2.3 |
| always попытается обновить пароль. on_create будет устанавливать пароль только для вновь созданных пользователей. |
| verify boolean |
| Выполнять или нет проверку запросов API SSL. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| wait boolean |
| Должен ли Ansible ждать завершения запрошенного ресурса. |
Примечания
Примечание
- Можно использовать стандартные переменные окружения OpenStack, такие как
OS_USERNAME, вместо явного задания значений. - Информация об авторизации определяется os-client-config, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения и, наконец, из явных параметров в playbooks. Более подробную информацию можно найти по адресу http://docs.openstack.org/developer/os-client-config
Примеры
# Create a user
- os_user:
cloud: mycloud
state: present
name: demouser
password: secret
email: demo@example.com
domain: default
default_project: demo
# Delete a user
- os_user:
cloud: mycloud
state: absent
name: demouser
# Create a user but don't update password if user exists
- os_user:
cloud: mycloud
state: present
name: demouser
password: secret
update_password: on_create
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 | ||
Статус
- Модуль не гарантирует обратной совместимости интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- David Shrewsbury
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/os_user_module.html
