community.general.collection_version поиск – Возвращает версию установленной коллекции

Примечание

Этот плагин поиска входит в состав коллекции community.general (версия 9.5.0).

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

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

Чтобы использовать её в плейбуке, укажите: community.general.collection_version.

Новая в community.general 4.0.0

Обзор
Термины
Параметры ключевых слов
Примечания
Примеры
Значение возврата

Обзор

Этот поиск позволяет запросить версию установленной коллекции и определить, установлена ли коллекция вообще.
По умолчанию он возвращает none для несуществующих коллекций и * для коллекций без номера версии. Последнее должно происходить только в средах разработки или при установке коллекции из git, в которой нет номера версии в её galaxy.yml. Это поведение можно настроить, задав другие значения с помощью result_not_found и result_no_version.

Термины

Параметр	Комментарии
Термины список / элементы=строка / обязательно	Коллекции, которые нужно найти. Например, `community.general`.

Параметры ключевых слов

Это описывает параметры ключевых слов поиска. Это значения key1=value1, key2=value2 и так далее в следующих примерах: lookup('community.general.collection_version', key1=value1, key2=value2, ...) и query('community.general.collection_version', key1=value1, key2=value2, ...)

Параметр	Комментарии
result_no_version строка	Значение, возвращаемое, когда у коллекции нет номера версии. Это может произойти для коллекций, установленных из git, которые не содержат номер версии в `galaxy.yml`. По умолчанию возвращается ``. По умолчанию:* `"*"`
result_not_found строка	Значение, возвращаемое, когда коллекция не была найдена. По умолчанию возвращается `none`.

Примечания

Примечание

Когда параметры ключевых слов и позиционных параметров используются вместе, позиционные параметры должны быть указаны до параметров ключевых слов: lookup('community.general.collection_version', term1, term2, key1=value1, key2=value2) и query('community.general.collection_version', term1, term2, key1=value1, key2=value2)

Примеры

- name: Check version of community.general
  ansible.builtin.debug:
    msg: "community.general version {{ lookup('community.general.collection_version', 'community.general') }}"

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

Ключ	Описание
Значение возврата список / элементы=строка	Номер версии перечисленных в качестве входных данных коллекций. Если коллекция не найдена, возвращается значение, указанное в `result_not_found`. По умолчанию это `none`. Если коллекция найдена, но версия не определена, возвращается значение, указанное в `result_no_version`. По умолчанию это ``. Это может произойти для коллекций, установленных из git, которые не содержат номер версии в `galaxy.yml`. Возвращено:* успех

Ключ

Описание

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

список / элементы=строка

Номер версии перечисленных в качестве входных данных коллекций.

Если коллекция не найдена, возвращается значение, указанное в result_not_found. По умолчанию это none.

Если коллекция найдена, но версия не определена, возвращается значение, указанное в result_no_version. По умолчанию это *. Это может произойти для коллекций, установленных из git, которые не содержат номер версии в galaxy.yml.

Возвращено: успех

Авторы

Felix Fontein (@felixfontein)

Подсказка

Элементы конфигурации для каждого типа имеют порядок приоритета от низкого к высокому. Например, переменная, которая находится ниже в списке, переопределит переменную, расположенную выше.

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

© 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/community/general/collection_version_lookup.html