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

Примечание

Этот модуль входит в коллекцию openstack.cloud (версия 2.2.0).

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для её установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля требуются дополнительные зависимости. Подробности см. в разделе Требования.

Чтобы использовать его в playbook, укажите: openstack.cloud.project_info.

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

Обзор

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

Требования

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

python >= 3.6
openstacksdk >= 1.0.0

Параметры

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

Примечания

Примечание

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

Примеры

- name: Fetch all Identity (Keystone) projects
  openstack.cloud.project_info:
    cloud: awesomecloud

- name: Fetch all projects with a name
  openstack.cloud.project_info:
    cloud: awesomecloud
    name: demoproject

- name: Fetch all projects with a name in a domain
  openstack.cloud.project_info:
    cloud: awesomecloud
    name: demoproject
    domain: admindomain

- name: Fetch all disabled projects
  openstack.cloud.project_info:
    cloud: awesomecloud
    filters:
      is_enabled: false

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

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

Ключ	Описание
projects список / элементы=словарь	Список словарей, описывающих проекты Identity (Keystone). Возвращается: всегда, но может быть пустым
description строка	Описание проекта Возвращается: успешно Пример: `"demodescription"`
domain_id строка	Идентификатор домена, к которому принадлежит проект Возвращается: успешно Пример: `"default"`
id строка	Идентификатор проекта Возвращается: успешно Пример: `"f59382db809c43139982ca4189404650"`
is_domain логическое значение	Указывает, является ли проект также доменом. Возвращается: успешно
is_enabled логическое значение	Указывает, включен ли проект Возвращается: успешно
name строка	Название проекта Возвращается: успешно Пример: `"demoproject"`
options словарь	Параметры ресурса для проекта Возвращается: успешно
parent_id строка	Идентификатор родительского проекта Возвращается: успешно
tags список / элементы=строка	Список связанных тегов Возвращается: успешно

Авторы

OpenStack Ansible SIG

Ссылки на коллекции

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