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 и любую информацию о доменах (например, os_user_domain_name или os_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 - | Имя или ID проекта, с которым по умолчанию должен быть связан пользователь. | |
| description - добавлен в 2.4 | Описание пользователя. | |
| domain - | Домен для создания пользователя, если облако поддерживает домены. | |
| email - | Адрес электронной почты пользователя. | |
| enabled логическое значение |
| Пользователь активирован? |
| interface строка добавлен в 2.3 |
| Тип URL конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type |
| name - / обязательно | Имя пользователя. | |
| password - | Пароль пользователя. | |
| region_name строка | Имя региона. | |
| state - |
| Ресурс должен быть присутствующим или отсутствующим. |
| timeout целое число | По умолчанию: 180 | Сколько времени Ansible должно ждать запрошенного ресурса. |
| update_password - добавлен в 2.3 |
| always Ansible будет пытаться обновить пароль. on_create Ansible будет устанавливать пароль только для вновь созданных пользователей. |
| 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
- 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
# Create a user without password
- os_user:
cloud: mycloud
state: present
name: demouser
email: demo@example.com
domain: default
default_project: demo
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| user complex | При успехе, когда state равно 'present' | Словарь, описывающий пользователя. | |
| default_project_id string | ID проекта по умолчанию пользователя. Присутствует только при Keystone >= v3. Пример: 4427115787be45f08f0ec22a03bfc735 | ||
| domain_id string | ID домена пользователя. Присутствует только при Keystone >= v3. Пример: default | ||
| email string | Электронный адрес пользователя Пример: demo@example.com | ||
| id string | ID пользователя Пример: f59382db809c43139982ca4189404650 | ||
| name string | Имя пользователя Пример: demouser | ||
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- David Shrewsbury (@Shrews)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/os_user_module.html
