os_user – Управление пользователями OpenStack Identity
Описание
- Управление пользователями OpenStack Identity. Этот модуль позволяет создавать, обновлять или удалять пользователей. Пользователь будет обновлен, если name совпадает с существующим пользователем и присутствует state. Значение name нельзя обновить без удаления и повторного создания пользователя.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Время ожидания сокетом перед истечением времени ожидания для API-вызовов. Если этот параметр опущен, он не будет передан в библиотеку запросов. | |
| 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 Cert, который может использоваться для проверки SSL API-запросов. алиасы: cacert | |
| client_cert строка | Путь к клиенту сертификат для использования в рамках SSL-транзакции. алиасы: cert | |
| client_key строка | Путь к ключу клиента для использования в рамках SSL-транзакции. алиасы: key | |
| cloud raw | Именованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Обеспечивает значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные среды OpenStack OS_*. Если cloud является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| default_project - | Имя или ID проекта, которому по умолчанию должен быть привязан пользователь | |
| description - добавлен в 2.4 | Описание пользователя | |
| domain - | Домен для создания пользователя, если облако поддерживает домены | |
| email - | Электронный адрес пользователя | |
| enabled boolean |
| Пользователь включен |
| interface строка |
| Тип URL-адреса конечной точки для извлечения из каталога служб. алиасы: endpoint_type |
| name - / обязательно | Имя пользователя | |
| password - | Пароль пользователя | |
| region_name строка | Название региона. | |
| state - |
| Ресурс должен быть присутствующим или отсутствующим. |
| timeout целое число | По умолчанию: 180 | Сколько времени Ansible должно ждать запрошенного ресурса. |
| update_password - |
| always будет пытаться обновить пароль. on_create будет устанавливать пароль только для вновь созданных пользователей. |
| validate_certs boolean |
| Нужно ли проверять SSL API-запросы. Перед Ansible 2.3 по умолчанию было yes. алиасы: verify |
| wait boolean |
| Должен ли 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 | Идентификатор проекта по умолчанию для пользователя. Присутствует только с Keystone >= v3. Пример: 4427115787be45f08f0ec22a03bfc735 | ||
| domain_id string | Идентификатор домена пользователя. Присутствует только с Keystone >= v3. Пример: default | ||
| email string | Адрес электронной почты пользователя Пример: demo@example.com | ||
| id string | Идентификатор пользователя Пример: f59382db809c43139982ca4189404650 | ||
| name string | Имя пользователя Пример: demouser | ||
Статус
- Данный модуль не гарантирует обратной совместимости интерфейса. [preview]
- Этот модуль поддерживается сообществом 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.9/modules/os_user_module.html
