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

Примечание

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

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

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

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

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

Краткое описание

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

Требования

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

python >= 3.6
openstacksdk >= 1.0.0

Параметры

Параметр	Комментарии
api_timeout целое число	Сколько времени уровень сокетов должен ожидать ответа перед тайм-аутом вызовов API. Если параметр не задан, в библиотеку requests ничего не передается.
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 передаются в OpenStack Identity API в качестве параметров запроса.
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

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

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