Модуль openstack.cloud.identity_user — управление пользователем идентификации OpenStack (Keystone)
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля необходимы дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.identity_user.
Краткое описание
- Создание, обновление или удаление пользователя идентификации OpenStack (Keystone).
Требования
На узле, на котором выполняется этот модуль, должны быть установлены следующие компоненты.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Комментарии |
|---|---|
api_timeout integer | Время ожидания перед истечением срока ожидания вызовов API на уровне сокетов. Если параметр не указан, в библиотеку requests ничего не передаётся. |
auth dictionary | Словарь с данными аутентификации, необходимыми для выбранной стратегии плагина аутентификации облака. Для плагина password, используемого по умолчанию, здесь указываются auth_url, username, password, project_name, а также сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать необходимые им параметры. Этот параметр не требуется, если указано именованное облако или заданы переменные среды OpenStack OS_*. |
auth_type string | Имя используемого плагина аутентификации. Если облако использует не аутентификацию по паролю, укажите здесь имя плагина и соответствующим образом настройте параметр auth. |
ca_cert псевдонимы: cacert string | Путь к пакету сертификатов центра сертификации, который можно использовать для проверки запросов API SSL. |
client_cert псевдонимы: cert string | Путь к сертификату клиента, используемому при SSL-транзакции. |
client_key псевдонимы: key string | Путь к ключу клиента, используемому при SSL-транзакции. |
cloud any | Именованное облако или конфигурация облака, с которыми выполняются операции. Если cloud — строка, она указывает на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если указан auth или заданы переменные среды OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, аналогичную разделу файла clouds.yaml. |
default_project string | Имя или идентификатор проекта, в котором следует создать пользователя. |
description string | Описание пользователя. |
domain string | Домен, в котором следует создать пользователя, если облако поддерживает домены. |
string | Адрес электронной почты пользователя. |
interface псевдонимы: endpoint_type string | Тип URL конечной точки, выбираемой из каталога служб. Варианты:
|
is_enabled псевдонимы: enabled boolean | Включён ли пользователь. Варианты:
|
name string / обязательный | Имя пользователя. Параметр name нельзя изменить без удаления пользователя и его повторного создания. |
password string | Пароль пользователя. |
region_name string | Название региона. |
sdk_log_level string | Уровень ведения журнала OpenStackSDK Варианты:
|
sdk_log_path string | Путь к файлу журнала OpenStackSDK. Если значение не задано, журнал не записывается. |
state string | Должен ли ресурс существовать или отсутствовать. Варианты:
|
timeout integer | Время ожидания Ansible для запрошенного ресурса. По умолчанию: |
update_password string | Если update_password имеет значение Если update_password имеет значение Варианты:
|
validate_certs псевдонимы: verify boolean | Следует ли проверять запросы API SSL. До Ansible 2.3 значением по умолчанию было Варианты:
|
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/
Примеры
- name: Create a user
openstack.cloud.identity_user:
cloud: mycloud
state: present
name: demouser
password: secret
email: demo@example.com
domain: default
default_project: demo
- name: Delete a user
openstack.cloud.identity_user:
cloud: mycloud
state: absent
name: demouser
- name: 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
- name: 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 dictionary | Словарь с описанием пользователя идентификации. Возвращается: при успешном выполнении, если state имеет значение |
|
default_project_id string |
Идентификатор проекта пользователя по умолчанию. Присутствует только в Keystone >= v3. Возвращается: при успешном выполнении Пример: |
|
description string |
Описание этого пользователя Возвращается: при успешном выполнении Пример: |
|
domain_id string |
Идентификатор домена пользователя. Присутствует только в Keystone >= v3. Возвращается: при успешном выполнении Пример: |
|
string |
Адрес электронной почты пользователя Возвращается: при успешном выполнении Пример: |
|
id string |
Идентификатор пользователя Возвращается: при успешном выполнении Пример: |
|
is_enabled boolean |
Указывает, включён ли пользователь Возвращается: при успешном выполнении |
|
links dictionary |
Ссылки на ресурс пользователя Возвращается: при успешном выполнении |
|
name string |
Уникальное имя пользователя в пределах принадлежащего ему домена Возвращается: при успешном выполнении Пример: |
|
password string |
Учётные данные, используемые при аутентификации Возвращается: при успешном выполнении |
|
password_expires_at string |
Дата и время истечения срока действия пароля. Часовой пояс — UTC. Значение none означает, что срок действия пароля не истекает. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/openstack/cloud/identity_user_module.html