community.general.collection_version lookup — получение версии установленной коллекции

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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.

Термины

Параметр	Комментарии
Terms list / elements=string / обязательный	Коллекции для поиска. Например, `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 string	Значение, возвращаемое, если у коллекции нет номера версии. Такое возможно для коллекций, установленных из git, в которых в `galaxy.yml` не указан номер версии. По умолчанию возвращается ``. По умолчанию:* `"*"`
result_not_found string	Значение, возвращаемое, если коллекцию не удалось найти. По умолчанию возвращается `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') }}"

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

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

Ключ

Описание

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

list / elements=string

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

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

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

Возвращается: при успехе

Авторы

Felix Fontein (@felixfontein)

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

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