Spec-Zone.ru › Ansible 2.4

os_user_facts - Получение фактов об одном или нескольких пользователях OpenStack

Новое в версии 2.1.

  • Обзор
  • Требования (к хосту, на котором выполняется модуль)
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Примечания
    • Статус

Обзор

  • Получение фактов об одном или нескольких пользователях OpenStack

Требования (к хосту, на котором выполняется модуль)

  • python >= 2.6
  • python >= 2.7
  • shade

Параметры

параметр обязательно по умолчанию варианты примечания
api_timeout
нет None
Сколько времени слою сокетов следует ожидать перед истечением времени ожидания для вызовов API. Если это значение опущено, ничего не будет передано в библиотеку запросов.
auth
нет
Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других плагинов этот параметр должен содержать любые параметры, необходимые этому плагину авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type
нет password
Имя плагина авторизации для использования. Если облако использует что-то кроме парольной авторизации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone
нет
Игнорируется. Присутствует для обратной совместимости
cacert
нет None
Путь к пакету сертификатов CA, который может использоваться при проверке запросов API SSL.
cert
нет None
Путь к клиенту сертификату для использования в рамках транзакции SSL.
cloud
нет
Наименованное облако для работы. Обеспечивает значения по умолчанию для auth и auth_type. Этот параметр не нужен, если задан auth или присутствуют переменные окружения OpenStack OS_*.
domain
нет None
Имя или идентификатор домена, содержащего пользователя, если облако поддерживает домены
endpoint_type
нет public
  • public
  • internal
  • admin
Тип URL-адреса конечной точки для извлечения из каталога сервисов.
filters
нет None
Словарь метаданных для дальнейшего фильтрации. Элементы этого словаря могут быть дополнительными словарями.
key
нет None
Путь к ключу клиента для использования в рамках транзакции SSL.
name
да
Имя или идентификатор пользователя
region_name
нет
Имя региона.
timeout
нет 180
Сколько времени Ansible должно ждать запрошенного ресурса.
validate_certs
нет
Нужно ли проверять запросы API SSL. До версии 2.3 это значение по умолчанию было True.
псевдонимы: verify
wait
нет yes
  • yes
  • no
Должен ли Ansible ждать завершения запрошенного ресурса.

Примеры

# 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
содержит все факты OpenStack о пользователях
всегда, но может быть null сложный
содержит:
имя описание возвращается тип пример
username
Имя пользователя
успех строка
domain_id
Идентификатор домена, содержащего пользователя
успех строка
name
Имя пользователя.
успех строка
id
Уникальный UUID.
успех строка
enabled
Флаг, указывающий, разрешен ли пользователь
успех булево
email
Электронная почта пользователя
успех строка
default_project_id
Идентификатор проекта по умолчанию для пользователя
успех строка

Примечания

Примечание

  • Стандартные переменные окружения 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

Статус

Этот модуль помечен как бета, что означает, что он не гарантирует обратную совместимость интерфейса.

Для получения помощи в разработке модулей, если вы так решили, прочитайте Документацию по сообществу и участию в разработке, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/os_user_facts_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API