openstack.cloud.os_project_info – Получение информации об одном или нескольких проектах OpenStack

Примечание

Этот плагин является частью коллекции openstack.cloud (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install openstack.cloud.

Для использования в playbook, укажите: openstack.cloud.os_project_info.

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

Обзор

Получение информации об одном или нескольких проектах OpenStack
Этот модуль назывался openstack.cloud.project_facts до Ansible 2.9, возвращая ansible_facts. Обратите внимание, что модуль openstack.cloud.project_info больше не возвращает ansible_facts!

Требования

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

openstacksdk
openstacksdk >= 0.12.0
python >= 3.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени должна ждать сокетная связь, прежде чем истечёт время ожидания для API-вызовов. Если это опущено, ничего не будет передано библиотеке requests.
auth словарь		Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля для авторизации облака. Для стандартного подключаемого модуля password он будет содержать auth_url, username, password, project_name и любые сведения о домене (например, user_domain_name или 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 строка	Варианты: admin internal public ←	Тип URL-адреса конечной точки для извлечения из каталога служб. алиасы: endpoint_type
name строка		Имя или идентификатор проекта
region_name строка		Имя региона.
timeout целое число	Значение по умолчанию: 180	Сколько времени Ansible должно ждать запрошенного ресурса.
validate_certs булево	Варианты: нет ← да	Нужно ли проверять SSL-API-запросы. До Ansible 2.3 это по умолчанию было `yes`. алиасы: verify
wait булево	Варианты: нет да ←	Ansible должен ждать, пока запрашиваемый ресурс не будет готов.

Примечания

Примечание

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

Примеры

# Gather information about previously created projects
- openstack.cloud.project_info:
    cloud: awesomecloud
  register: result
- debug:
    msg: "{{ result.openstack_projects }}"

# Gather information about a previously created project by name
- openstack.cloud.project_info:
    cloud: awesomecloud
    name: demoproject
  register: result
- debug:
    msg: "{{ result.openstack_projects }}"

# Gather information about a previously created project in a specific domain
- openstack.cloud.project_info:
    cloud: awesomecloud
    name: demoproject
    domain: admindomain
  register: result
- debug:
    msg: "{{ result.openstack_projects }}"

# Gather information about a previously created project in a specific domain with filter
- openstack.cloud.project_info:
    cloud: awesomecloud
    name: demoproject
    domain: admindomain
    filters:
      enabled: False
  register: result
- debug:
    msg: "{{ result.openstack_projects }}"

Возвращаемые значения

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

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

Авторы

OpenStack Ansible SIG

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