os_user_facts - Получение фактов об одном или нескольких пользователях OpenStack
Новое в версии 2.1.
Описание
- Получение фактов об одном или нескольких пользователях OpenStack
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- python >= 2.7
- shade
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout | Сколько времени должно ждать соединение, прежде чем истечёт время ожидания для вызовов API. Если это значение опущено, оно не будет передано в библиотеку requests. | |
| auth | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password это будет включать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать параметры, необходимые для данного подключаемого модуля авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*. | |
| auth_type | Имя подключаемого модуля авторизации для использования. Если облако использует что-то помимо парольной аутентификации, имя подключаемого модуля должно быть указано здесь, и содержимое параметра auth должно быть обновлено соответственно. | |
| availability_zone | Игнорируется. Присутствует для обратной совместимости | |
| cacert | Путь к пакету сертификатов CA, который может быть использован для проверки запросов API SSL. | |
| cert | Путь к клиенту сертификату для использования в рамках транзакции SSL. | |
| cloud | Именованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен параметр auth или присутствуют переменные среды OpenStack OS_*. Если cloud является словарем, он содержит полную конфигурацию облака, как если бы она находилась в разделе clouds.yaml. | |
| domain | По умолчанию: None | Имя или идентификатор домена, содержащего пользователя, если облако поддерживает домены |
| filters | По умолчанию: None | Словарь метаданных для дальнейшего фильтрации. Элементы этого словаря могут быть дополнительными словарями. |
| interface (добавлен в 2.3) |
| Тип URL конечной точки для извлечения из каталога сервисов. Псевдонимы: endpoint_type |
| key | Путь к ключу клиента для использования в рамках транзакции SSL. | |
| name обязательно | Имя или идентификатор пользователя | |
| region_name | Имя региона. | |
| timeout | По умолчанию: 180 | Сколько времени Ansible должно ждать запрошенного ресурса. |
| verify |
| Должны ли быть проверены запросы API SSL. До версии 2.3 это значение по умолчанию было True. Псевдонимы: validate_certs |
| wait |
| Должен ли Ansible ждать, пока запрошенный ресурс не будет завершен. |
Примечания
Примечание
- Можно использовать стандартные переменные среды OpenStack, такие как
OS_USERNAME, вместо явных значений. - Информация об авторизации управляется os-client-config, что означает, что значения могут поступать из файла yaml конфигурации в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, а затем из стандартных переменных среды, и, наконец, из явных параметров в playbooks. Дополнительную информацию можно найти на странице http://docs.openstack.org/developer/os-client-config
Примеры
# Gather facts about previously created users
- os_user_facts:
cloud: awesomecloud
- debug:
var: openstack_users
# Gather facts about a previously created user by name
- os_user_facts:
cloud: awesomecloud
name: demouser
- debug:
var: openstack_users
# Gather facts about a previously created user in a specific domain
- os_user_facts:
cloud: awesomecloud
name: demouser
domain: admindomain
- debug:
var: openstack_users
# Gather facts about a previously created user in a specific domain with filter
- os_user_facts:
cloud: awesomecloud
name: demouser
domain: admindomain
filters:
enabled: False
- debug:
var: openstack_users
Возвращаемые значения
Общие возвращаемые значения описаны в этой статье. Ниже перечислены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| openstack_users сложное | всегда, но может быть null | содержит все факты OpenStack о пользователях | |
| username строка | успешно | Имя пользователя | |
| domain_id строка | успешно | Идентификатор домена, содержащего пользователя | |
| name строка | успешно | Имя пользователя. | |
| id строка | успешно | Уникальный UUID. | |
| enabled логическое значение | успешно | Флаг, указывающий, разрешён ли пользователь | |
| email строка | успешно | Электронный адрес пользователя | |
| default_project_id строка | успешно | Идентификатор проекта по умолчанию для пользователя | |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- Ricardo Carrillo Cruz (@rcarrillocruz)
Подсказка
Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать его, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/os_user_facts_module.html
