os_user - Управление пользователями OpenStack Identity
Новое в версии 2.0.
- Описание
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Описание
- Управление пользователями OpenStack Identity. Данный модуль позволяет создавать, обновлять или удалять пользователей. Пользователь будет обновлён, если name совпадает с существующим пользователем и state присутствует. Значение name не может быть обновлено без удаления и повторного создания пользователя.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.6
- python >= 2.7
- shade
Параметры
| параметр | обязательно | значение по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| api_timeout | нет | None | Сколько времени должна ждать подсистема сокетов, прежде чем истечёт время ожидания для API-вызовов. Если этот параметр опущен, он не будет передан библиотеке requests. | |
| auth | нет | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать параметры, необходимые этому подключаемому модулю. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | ||
| auth_type | нет | password | Имя подключаемого модуля авторизации для использования. Если облако использует что-то кроме парольной аутентификации, имя подключаемого модуля должно быть указано здесь, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone | нет | Игнорируется. Присутствует для обратной совместимости. | ||
| cacert | нет | None | Путь к пакету сертификатов CA, который может использоваться для проверки SSL API-запросов. | |
| cert | нет | None | Путь к клиенту сертификата для использования в рамках SSL-транзакции. | |
| cloud | нет | Именованное облако для работы. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если задан auth или присутствуют переменные окружения OpenStack OS_*. | ||
| default_project | нет | None | Имя или идентификатор проекта, с которым по умолчанию должен быть связан пользователь. | |
| description (добавлено в 2.4)
| нет | Описание пользователя. | ||
| domain | нет | None | Домен для создания пользователя, если облако поддерживает домены. | |
| email | нет | None | Адрес электронной почты пользователя. | |
| enabled | нет | True | Пользователь включен? | |
| endpoint_type | нет | public |
| Тип URL конечной точки для извлечения из каталога служб. |
| key | нет | None | Путь к ключу клиента для использования в рамках SSL-транзакции. | |
| name | да | Имя пользователя. | ||
| password | нет | None | Пароль пользователя. | |
| region_name | нет | Имя региона. | ||
| state | нет | present |
| Ресурс должен быть присутствовать или отсутствовать. |
| timeout | нет | 180 | Сколько времени Ansible должно ждать запрошенного ресурса. | |
| update_password (добавлено в 2.3)
| нет | always |
| always будет пытаться обновить пароль. on_create будет устанавливать пароль только для вновь созданных пользователей. |
| validate_certs | нет | Необходимо ли проверять SSL API-запросы. До версии 2.3 по умолчанию было True. псевдонимы: verify | ||
| wait | нет | yes |
| Ansible должен ожидать завершения запрошенного ресурса. |
Примеры
# 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 | Словарь, описывающий пользователя. | При успехе, когда I(state) равно 'present' | сложный | |||||||||||||||||||||||||||||||
| содержит: |
| |||||||||||||||||||||||||||||||||
Примечания
Примечание
- Стандартные переменные окружения 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
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантированно будет обратной совместимым.
Для помощи в разработке модулей, если вы заинтересованы, пожалуйста, ознакомьтесь с Информация о сообществе и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/os_user_module.html
