os_project_facts - Получение фактов о проектах OpenStack

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

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

Описание

Получение фактов о проектах OpenStack

Требования

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

openstacksdk
python >= 2.7

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout		Время ожидания сокета в секундах перед истечением времени ожидания для API-вызовов. Если этот параметр опущен, он не будет передан в библиотеку requests.
auth		Словарь, содержащий информацию об авторизации, необходимую для стратегии подключаемого модуля аутентификации облака. Для стандартного плагина password это будет включать auth_url, username, password, project_name и любые сведения о доменах, если облако их поддерживает. Для других плагинов этот параметр должен содержать любые необходимые параметры. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*.
auth_type		Имя плагина аутентификации для использования. Если облако использует что-то кроме аутентификации по паролю, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone		Игнорируется. Присутствует для обратной совместимости
cacert		Путь к файлу с пакетом сертификатов CA, который может быть использован для проверки SSL API-запросов.
cert		Путь к клиенту сертификату для использования в рамках SSL-транзакции.
cloud		Наименованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные среды OpenStack OS_. Если cloud* является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
domain		Имя или ID домена, содержащего проект, если облако поддерживает домены
filters		Словарь метаданных для дальнейшего фильтрации. Элементы этого словаря могут быть дополнительными словарями.
interface (добавлено в 2.3)	Варианты: public ← internal admin	Тип URL конечной точки для получения из каталога служб. псевдонимы: endpoint_type
key		Путь к клиентскому ключу для использования в рамках SSL-транзакции.
name обязательно		Имя или ID проекта
region_name		Имя региона.
timeout	По умолчанию: 180	Время ожидания Ansible для запрошенного ресурса.
verify bool	Варианты: no yes	Проверка SSL API-запросов. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs
wait bool	Варианты: no yes ←	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 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 о проектах
	id строка	успех	Уникальный UUID.
	name строка	успех	Имя, присвоенное проекту.
	description строка	успех	Описание проекта
	enabled bool	успех	Флаг, указывающий, включен ли проект
	domain_id bool	успех	ID домена, содержащего проект (только облака keystone v3)

Статус

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

Обслуживание

Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. См. Поддержка модулей и обслуживание для получения дополнительной информации.

Список других модулей, также поддерживаемых сообществом 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.6/modules/os_project_facts_module.html