Модуль community.general.ansible_galaxy_install – Установка ролей или коллекций Ansible с помощью ansible-galaxy
Примечание
Этот модуль является частью коллекции community.general (версия 9.5.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, запустите ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные компоненты, см. Требования для получения подробной информации.
Для использования в playbook, укажите: community.general.ansible_galaxy_install.
Новое в community.general 3.5.0
Краткое описание
- Этот модуль позволяет устанавливать коллекции или роли Ansible с помощью
ansible-galaxy.
Требования
Ниже приведены требования, необходимые на хосте, который выполняет этот модуль.
- ansible-core 2.11 или новее
Параметры
Параметр | Комментарии |
|---|---|
dest path | Путь к каталогу, содержащему ваши коллекции или роли, в соответствии со значением Обратите внимание, что |
force boolean | Принудительная перезапись существующих ролей и/или коллекций. Может использоваться для обновления, но вывод модуля всегда будет сообщать Использование Варианты:
|
name string | Имя устанавливаемой коллекции или роли. Версии могут быть указаны с помощью обычных форматов
|
no_deps boolean добавлено в community.general 4.5.0 | Воздерживаться от установки зависимостей. Варианты:
|
requirements_file path | Путь к файлу, содержащему список требований для установки. Работает для
|
state string добавлено в community.general 9.1.0 | Если В настоящее время Обратите внимание, что Варианты:
|
type string / required | Тип установки, выполняемый Если Однако обратное неверно: при использовании Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: отсутствует | Может работать в |
diff_mode | Поддержка: отсутствует | Возвращает подробную информацию о том, что изменилось (или что может потребовать изменения в |
Примечания
Примечание
- Поддержка Ansible 2.9/2.10 была удалена в community.general 8.0.0.
- Модуль будет пытаться запуститься, используя локаль
C.UTF-8. Если это не удастся, он попытается использоватьen_US.UTF-8. Если и это не удастся, модуль завершится с ошибкой.
См. также
См. также
- C(ansible-galaxy) страница руководства по команде
-
Страница руководства для команды.
Примеры
---
- name: Install collection community.network
community.general.ansible_galaxy_install:
type: collection
name: community.network
- name: Install role at specific path
community.general.ansible_galaxy_install:
type: role
name: ansistrano.deploy
dest: /ansible/roles
- name: Install collections and roles together
community.general.ansible_galaxy_install:
type: both
requirements_file: requirements.yml
- name: Force-install collection community.network at specific version
community.general.ansible_galaxy_install:
type: collection
name: community.network:3.0.2
force: true
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
dest строка | Значение параметра Возвращается: всегда |
force логическое | Значение параметра Возвращается: всегда |
installed_collections словарь | Если задан Если задан Возвращается: всегда при установке коллекций Пример: |
|
<путь> словарь |
Коллекции и версии для этого пути. Возвращается: успех |
installed_roles словарь | Если задан Если задан Возвращается: всегда при установке ролей Пример: |
|
<путь> словарь |
Роли и версии для этого пути. Возвращается: успех |
name строка | Значение параметра Возвращается: всегда |
new_collections словарь | Новые коллекции, установленные этим модулем. Возвращается: успех Пример: |
new_roles словарь | Новые роли, установленные этим модулем. Возвращается: успех Пример: |
requirements_file строка | Значение параметра Возвращается: всегда |
type строка | Значение параметра Возвращается: всегда |
Ссылки на коллекцию
© 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/ansible_galaxy_install_module.html