os_user_facts – Получение фактов об одном или нескольких пользователях OpenStack
Новая в версии 2.1.
Описание
- Получение фактов об одном или нескольких пользователях OpenStack
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется данный модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout - | Сколько времени (в секундах) должна ожидать подсистема сокетов перед истечением времени ожидания для вызовов API. Если этот параметр опущен, он не будет передан в библиотеку запросов. | |
| 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 - | Имя или ID домена, содержащего пользователя, если облако поддерживает домены | |
| filters - | Словарь метаданных для дополнительной фильтрации. Элементы этого словаря могут быть дополнительными словарями. | |
| interface - добавлено в 2.3 |
| Тип URL-адреса конечной точки для извлечения из каталога услуг. псевдонимы: endpoint_type |
| key - | Путь к ключу клиента для использования в SSL-транзакции. | |
| name - / обязательно | Имя или ID пользователя | |
| region_name - | Имя региона. | |
| timeout - | По умолчанию: 180 | Сколько времени Ansible должно ждать запрошенного ресурса. |
| verify boolean |
| Нужно ли проверять запросы API SSL. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| wait boolean |
| Должен ли Ansible ждать, пока запрошенный ресурс будет завершен. |
Примечания
Примечание
- Можно использовать стандартные переменные среды OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об аутентификации управляется os-client-config, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, а затем из стандартных переменных среды, и, наконец, из явных параметров в задачах. Дополнительную информацию можно найти по адресу 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 complex | всегда, но может быть null | содержит все факты OpenStack о пользователях | |
| default_project_id строка | успех | Идентификатор проекта по умолчанию пользователя | |
| domain_id строка | успех | Идентификатор домена, содержащего пользователя | |
| email строка | успех | Электронный адрес пользователя | |
| enabled boolean | успех | Флаг, указывающий, включён ли пользователь | |
| id строка | успех | Уникальный UUID. | |
| name строка | успех | Имя пользователя. | |
| username строка | успех | Имя пользователя | |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.7/modules/os_user_facts_module.html
