openstack.cloud.identity_user – Управление пользователями OpenStack Identity
Примечание
Этот плагин входит в состав коллекции openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud.
Для использования в книге задач, укажите: openstack.cloud.identity_user.
Обзор
- Управление пользователями OpenStack Identity. Пользователи могут быть созданы, обновлены или удалены с помощью данного модуля. Пользователь будет обновлен, если name соответствует существующему пользователю и state присутствует. Значение name не может быть обновлено без удаления и повторного создания пользователя.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 3.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должна ожидать сокетная часть перед истечением времени ожидания для вызовов API. Если это опущено, ничего не будет передано в библиотеку запросов. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую для стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password в него будет включена информация о auth_url, username, password, project_name и любая информация о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать любые параметры, необходимые этому подключаемому модулю авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type строка | Имя подключаемого модуля авторизации для использования. Если облако использует что-то отличное от парольной аутентификации, имя подключаемого модуля следует указать здесь, а содержимое параметра auth следует соответствующим образом обновить. | |
| availability_zone строка | Игнорируется. Присутствует для обратной совместимости | |
| ca_cert строка | Путь к пакету CA Cert, который может использоваться для проверки запросов API SSL. Псевдонимы: 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 строка | Описание пользователя | |
| domain строка | Домен для создания пользователя, если облако поддерживает домены | |
| email строка | Адрес электронной почты пользователя | |
| enabled булево |
| Пользователь активирован |
| interface строка |
| Тип URL конечной точки для извлечения из каталога служб. Псевдонимы: endpoint_type |
| name строка / обязательно | Имя пользователя | |
| password строка | Пароль пользователя | |
| region_name строка | Имя региона. | |
| state строка |
| Ресурс должен быть present или absent. |
| timeout целое число | Значение по умолчанию: 180 | Сколько времени Ansible должно ждать запрашиваемого ресурса. |
| update_password строка |
| 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, а затем из стандартных переменных окружения, и, наконец, из явных параметров в playbooks. Более подробную информацию можно найти на странице https://docs.openstack.org/openstacksdk/
Примеры
# Create a user
- openstack.cloud.identity_user:
cloud: mycloud
state: present
name: demouser
password: secret
email: demo@example.com
domain: default
default_project: demo
# Delete a user
- openstack.cloud.identity_user:
cloud: mycloud
state: absent
name: demouser
# Create a user but don't update password if user exists
- openstack.cloud.identity_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
- openstack.cloud.identity_user:
cloud: mycloud
state: present
name: demouser
email: demo@example.com
domain: default
default_project: demo
Значения возврата
Общие значения возврата описаны в этом разделе, ниже перечислены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| user сложный | При успешном выполнении, когда state равен 'present' | Словарь, описывающий пользователя. | |
| default_project_id строка | успех | ID проекта по умолчанию для пользователя. Присутствует только с Keystone >= v3. Пример: 4427115787be45f08f0ec22a03bfc735 | |
| domain_id строка | успех | ID домена пользователя. Присутствует только с Keystone >= v3. Пример: default | |
| email строка | успех | Адрес электронной почты пользователя Пример: demo@example.com | |
| id строка | успех | ID пользователя Пример: f59382db809c43139982ca4189404650 | |
| name строка | успех | Имя пользователя Пример: demouser | |
Авторы
- OpenStack Ansible SIG
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/openstack/cloud/identity_user_module.html
