openstack.cloud.identity_user модуль — Управление пользователем OpenStack Identity (Keystone)
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.2.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: openstack.cloud.identity_user.
Обзор
- Создание, обновление или удаление пользователя OpenStack Identity (Keystone).
Требования
Ниже перечислены требования к хосту, на котором выполняется данный модуль.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Комментарии |
|---|---|
api_timeout integer | Сколько времени слой сокетов должен ожидать перед истечением времени ожидания для вызовов API. Если это пропущено, ничего не будет передано в библиотеку запросов. |
auth dictionary | Словарь, содержащий информацию об аутентификации, необходимую стратегии плагина аутентификации облака. Для плагина password по умолчанию это будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен будет содержать любые параметры, которые требуются этому плагину аутентификации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. |
auth_type string | Имя используемого плагина аутентификации. Если облако использует что-то другое, кроме парольной аутентификации, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть обновлено соответствующим образом. |
ca_cert aliases: cacert string | Путь к пакету сертификатов CA, который может использоваться в качестве части проверки запросов SSL API. |
client_cert aliases: cert string | Путь к клиентскому сертификату, используемому в качестве части транзакции SSL. |
client_key aliases: key string | Путь к клиентскому ключу, используемому в качестве части транзакции SSL. |
cloud any | Именованное облако или конфигурация облака, с которым нужно работать. Если cloud — это строка, она ссылается на именованную конфигурацию облака, определенную в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или если присутствуют переменные окружения OpenStack OS_*. Если cloud — это словарь, он содержит полную конфигурацию облака, как это было бы в разделе clouds.yaml. |
default_project string | Имя или ID проекта, в котором должен быть создан пользователь. |
description string | Описание пользователя. |
domain string | Домен для создания пользователя, если облако поддерживает домены. |
string | Адрес электронной почты пользователя. |
interface aliases: endpoint_type string | Тип URL-адреса конечной точки для извлечения из каталога служб. Варианты:
|
is_enabled aliases: enabled boolean | Включен ли пользователь или нет. Варианты:
|
name string / required | Имя пользователя. 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 aliases: verify boolean | Проверять ли запросы SSL API. В 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 словарь | Словарь, описывающий пользователя идентификации. Возвращается: При успехе, когда state имеет значение |
|
default_project_id строка |
ID проекта по умолчанию пользователя. Присутствует только с Keystone >= v3. Возвращается: успех Пример: |
|
description строка |
Описание этого пользователя Возвращается: успех Пример: |
|
domain_id строка |
ID домена пользователя. Присутствует только с Keystone >= v3. Возвращается: успех Пример: |
|
строка |
Электронный адрес пользователя Возвращается: успех Пример: |
|
id строка |
ID пользователя Возвращается: успех Пример: |
|
is_enabled boolean |
Указывает, включён ли пользователь Возвращается: успех |
|
links словарь |
Ссылки для ресурса пользователя Возвращается: успех |
|
name строка |
Уникальное имя пользователя в области владения Возвращается: успех Пример: |
|
password строка |
Идентификатор, используемый во время аутентификации Возвращается: успех |
|
password_expires_at строка |
Дата и время истечения срока действия пароля. Временная зона UTC. Значение null означает, что пароль никогда не истекает Возвращается: успех |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/openstack/cloud/identity_user_module.html