Модуль community.general.ansible_galaxy_install — установка ролей или коллекций Ansible с помощью ansible-galaxy

dest

путь

Путь к каталогу, содержащему ваши коллекции или роли, в соответствии со значением type.

Обратите внимание, что ansible-galaxy не устанавливает коллекции с помощью type=both, если requirements_file содержит и роли, и коллекции, а также указан параметр dest.

executable

путь

добавлено в community.general 12.5.0

Путь к исполняемому файлу ansible-galaxy.

Если параметр не указан, модуль использует ansible-galaxy, найденный Ansible.

force

логическое значение

Принудительно перезаписать существующие роли и/или коллекции.

Параметр можно использовать для обновления, но в выводе модуля всегда указывается changed=true.

При переходе на более раннюю версию необходимо использовать force=true.

Варианты:

• false ← (по умолчанию)
• true

name

строка

Имя устанавливаемой коллекции или роли.

Версии можно указать с помощью ansible-galaxy распространённых форматов. Например, коллекция community.docker:1.6.1 или роль ansistrano.deploy,3.8.0.

name и requirements_file нельзя использовать одновременно.

no_deps

логическое значение

добавлено в community.general 4.5.0

Не устанавливать зависимости.

Варианты:

• false ← (по умолчанию)
• true

requirements_file

путь

Путь к файлу со списком устанавливаемых требований.

Параметр работает, когда type равно collection и role.

name и requirements_file нельзя использовать одновременно.

state

строка

добавлено в community.general 9.1.0

Если задано state=present, коллекция или роль устанавливается. Обратите внимание, что при использовании этого параметра коллекции и роли не обновляются.

В настоящее время значение state=latest игнорируется, если не задано type=collection; оно гарантирует, что коллекция установлена и обновлена до последней доступной версии.

Обратите внимание, что force=true можно использовать для обновления независимо от type.

Варианты:

• "present" ← (по умолчанию)
• "latest"

type

строка / обязательный

Тип установки, выполняемой с помощью ansible-galaxy.

Если задано type=both, необходимо передать requirements_file; он может содержать и роли, и коллекции.

Однако обратное неверно: при использовании requirements_file параметр type может принимать любое из трёх значений.

Варианты:

• "collection"
• "role"
• "both"

check_mode

Поддержка: отсутствует

Может выполняться в режиме check_mode и возвращать прогноз изменения статуса без изменения целевого узла.

diff_mode

Поддержка: отсутствует

В режиме diff возвращает сведения об изменениях (или о возможных изменениях в check_mode).

dest

строка

Значение параметра dest.

Возвращается: всегда

force

логическое значение

Значение параметра force.

Возвращается: всегда

installed_collections

словарь

Если вместо этого указан requirements_file, возвращается словарь со всеми коллекциями, установленными в каждом каталоге.

Если указан name, возвращаются имя этой коллекции и установленная версия для каждого каталога.

Возвращается: всегда при установке коллекций

Пример: {"/custom/ansible/ansible_collections": {"community.general": "3.1.0"}, "/home/az/.ansible/collections/ansible_collections": {"community.docker": "1.6.0", "community.general": "3.0.2"}}

<path>

словарь

Коллекции и их версии для этого каталога.

Возвращается: при успешном выполнении

installed_roles

словарь

Если вместо этого указан requirements_file, возвращается словарь со всеми ролями, установленными в каждом каталоге.

Если указан name, возвращаются имя этой роли и установленная версия для каждого каталога.

Возвращается: всегда при установке ролей

Пример: {"/custom/ansible/roles": {"ansistrano.deploy": "3.8.0"}, "/home/user42/.ansible/roles": {"ansistrano.deploy": "3.9.0", "baztian.xfce": "v0.0.3"}}

<path>

словарь

Роли и их версии для этого каталога.

Возвращается: при успешном выполнении

name

строка

Значение параметра name.

Возвращается: всегда

new_collections

словарь

Новые коллекции, установленные этим модулем.

Возвращается: при успешном выполнении

Пример: {"community.docker": "1.6.1", "community.general": "3.1.0"}

new_roles

словарь

Новые роли, установленные этим модулем.

Возвращается: при успешном выполнении

Пример: {"ansistrano.deploy": "3.8.0", "baztian.xfce": "v0.0.3"}

requirements_file

строка

Значение параметра requirements_file.

Возвращается: всегда

type

строка

Значение параметра type.

Возвращается: всегда

version

строка

добавлено в community.general 10.0.0

Версия ansible-core для ansible-galaxy.

Возвращается: всегда

Пример: "2.17.4"