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