os_user — Управление пользователями OpenStack Identity
Новое в версии 2.0.
Обзор
- Управление пользователями OpenStack Identity. С помощью этого модуля можно создавать, обновлять или удалять пользователей. Пользователь будет обновлён, если name соответствует существующему пользователю и state присутствует. Значение name нельзя обновить без удаления и повторного создания пользователя.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- python >= 2.7
- shade
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout | Время ожидания сокетом перед истечением времени ожидания для вызовов API. Если этот параметр опущен, он не будет передан библиотеке requests. | |
| auth | Словарь, содержащий информацию об авторизации, необходимую для стратегии плагина авторизации облака. Для стандартного плагина password он будет содержать auth_url, username, password, project_name и любые данные о доменах, если облако их поддерживает. Для других плагинов этот параметр должен содержать требуемые параметры плагина авторизации. Этот параметр не требуется, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type | Имя плагина авторизации для использования. Если облако использует что-то помимо парольной аутентификации, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone | Игнорируется. Присутствует для обратной совместимости | |
| cacert | Путь к пакету сертификатов CA, который можно использовать для проверки запросов SSL API. | |
| cert | Путь к клиенту сертификат для использования в рамках транзакции SSL. | |
| cloud | Имя облака или конфигурация облака для работы. Если cloud — строка, она ссылается на конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные окружения OpenStack OS_*. Если cloud является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| default_project | По умолчанию: None | Имя или идентификатор проекта, с которым по умолчанию должен быть связан пользователь |
| description (добавлено в 2.4) | Описание пользователя | |
| domain | По умолчанию: None | Домен для создания пользователя, если облако поддерживает домены |
| По умолчанию: None | Адрес электронной почты пользователя | |
| enabled | По умолчанию: yes | Пользователь активен |
| interface (добавлено в 2.3) |
| Тип URL конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type |
| key | Путь к клиенту ключ для использования в рамках транзакции SSL. | |
| name обязательно | Имя пользователя | |
| password | По умолчанию: None | Пароль пользователя |
| region_name | Название региона. | |
| state |
| Ресурс должен быть присутствующим или отсутствующим. |
| timeout | По умолчанию: 180 | Время ожидания Ansible для запрошенного ресурса. |
| update_password (добавлено в 2.3) |
| always попытается обновить пароль. on_create установит пароль только для вновь созданных пользователей. |
| verify |
| Требовать ли проверку запросов SSL API. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| wait |
| Должен ли 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 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' | Словарь, описывающий пользователя. | |
| domain_id строка | Идентификатор домена пользователя. Присутствует только с Keystone >= v3. Пример: default | ||
| default_project_id строка | Идентификатор проекта по умолчанию для пользователя. Присутствует только с Keystone >= v3. Пример: 4427115787be45f08f0ec22a03bfc735 | ||
| id строка | Идентификатор пользователя Пример: f59382db809c43139982ca4189404650 | ||
| name строка | Имя пользователя Пример: demouser | ||
| email строка | Адрес электронной почты пользователя Пример: demo@example.com | ||
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Автор
- 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.5/modules/os_user_module.html
