os_project_facts – Получение фактов о одном или нескольких проектах OpenStack

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

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

Получить факты о одном или нескольких проектах OpenStack

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

openstacksdk
python >= 2.7

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени должна ждать подсистема сокетов перед истечением времени ожидания для вызовов API. Если этот параметр опущен, в библиотеку запросов ничего не будет передано.
auth словарь		Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, os_user_domain_name или os_project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать параметры, необходимые этому плагину авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*.
auth_type строка		Имя плагина авторизации, который следует использовать. Если облако использует что-то кроме парольной аутентификации, здесь следует указать имя плагина, и содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone -		Игнорируется. Присутствует для обратной совместимости
ca_cert строка		Путь к пакету сертификата CA, который может использоваться для проверки запросов SSL API. псевдонимы: cacert
client_cert строка		Путь к клиенту сертификата, который следует использовать в рамках SSL-транзакции. псевдонимы: cert
client_key строка		Путь к ключу клиента, который следует использовать в рамках SSL-транзакции. псевдонимы: key
cloud сырой		Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные среды OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, аналогично разделу в clouds.yaml.
domain -		Имя или идентификатор домена, содержащего проект, если облако поддерживает домены
filters -		Словарь метаданных для дальнейшего фильтрации. Элементы этого словаря могут быть дополнительными словарями.
interface строка добавлено в 2.3	Варианты: admin internal public ←	Тип URL-адреса конечной точки, который следует извлечь из каталога служб. псевдонимы: endpoint_type
name - / обязательно		Имя или идентификатор проекта
region_name строка		Имя региона.
timeout целое число	По умолчанию: 180	Сколько времени ansible должно ждать запрошенного ресурса.
validate_certs булево	Варианты: нет ← да	Следует ли проверять запросы API SSL. До Ansible 2.3 это по умолчанию было `yes`. псевдонимы: verify
wait булево	Варианты: нет да ←	Следует ли ansible ждать завершения запрошенного ресурса.

Примечания

Примечание

Можно использовать стандартные переменные среды OpenStack, такие как OS_USERNAME, вместо явного указания значений.
Информация об авторизации обрабатывается openstacksdk, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, а затем, в конечном счёте, из явных параметров в сценариях. Более подробную информацию можно найти на странице https://docs.openstack.org/openstacksdk/

Примеры

# Gather facts about previously created projects
- os_project_facts:
    cloud: awesomecloud
- debug:
    var: openstack_projects

# Gather facts about a previously created project by name
- os_project_facts:
    cloud: awesomecloud
    name: demoproject
- debug:
    var: openstack_projects

# Gather facts about a previously created project in a specific domain
- os_project_facts:
    cloud: awesomecloud
    name: demoproject
    domain: admindomain
- debug:
    var: openstack_projects

# Gather facts about a previously created project in a specific domain with filter
- os_project_facts:
    cloud: awesomecloud
    name: demoproject
    domain: admindomain
    filters:
      enabled: False
- debug:
    var: openstack_projects

Значения возврата

Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:

Ключ		Возвращаемое значение	Описание
openstack_projects сложное		всегда, но может быть null	Содержит все данные OpenStack о проектах
	description строка	успех	Описание проекта
	domain_id логическое значение	успех	Идентификатор домена, содержащий проект (только облака keystone v3)
	enabled логическое значение	успех	Флаг, указывающий, включен ли проект
	id строка	успех	Уникальный UUID.
	name строка	успех	Имя, присвоенное проекту.

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Данный модуль поддерживается сообществом 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.8/modules/os_project_facts_module.html