Spec-Zone.ru › Ansible

ansible-galaxy

Выполнение различных операций с ролями и коллекциями.

  • Синтаксис
  • Описание
  • Общие параметры
  • Действия

    • collection

      • скачать коллекцию
      • инициализировать коллекцию
      • сборка коллекции
      • опубликовать коллекцию
      • установить коллекцию
      • список коллекций
      • проверить коллекцию
    • роль

      • инициализировать роль
      • удалить роль
      • удалить роль
      • список ролей
      • поиск ролей
      • импортировать роль
      • настроить роль
      • информация о роли
      • установить роль
  • Окружение
  • Файлы
  • Автор
  • Лицензия
  • См. также

Синтаксис

usage: ansible-galaxy [-h] [--version] [-v] TYPE ...

Описание

Команда для управления ролями и коллекциями Ansible.

Ни один из инструментов командной строки не предназначен для одновременного выполнения. Используйте внешний планировщик и/или блокировку, чтобы гарантировать отсутствие конфликтующих операций.

Общие параметры

--version

отобразить номер версии программы, расположение файла конфигурации, путь поиска модулей, расположение модулей, расположение исполняемого файла и выйти

-h, --help

отобразить это сообщение справки и выйти

-v, --verbose

Приводит к тому, что Ansible выводит больше сообщений отладки. Добавление нескольких -v увеличит подробность, встроенные плагины в настоящее время оценивают до -vvvvvv. Приемлемый уровень для начала -vvv, отладка соединения может потребовать -vvvv. Этот аргумент можно указать несколько раз.

Действия

коллекция

Выполнить действие над коллекцией Ansible Galaxy. Должно быть объединено с дополнительным действием, таким как init/install, как указано ниже.

скачать коллекцию

Загрузить коллекции и их зависимости в виде архива tarball для автономной установки.

--clear-response-cache

Очистить кэш ответов сервера.

--no-cache

Не использовать кэш ответов сервера.

--pre

Включить предварительные версии. Предварительные версии семантической версии по умолчанию игнорируются

--timeout <TIMEOUT>

Время ожидания операций с сервером Galaxy, по умолчанию 60 с.

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки проверки сертификата SSL.

-n, --no-deps

Не загружать коллекции, перечисленные в качестве зависимостей.

-p <DOWNLOAD_PATH>, --download-path <DOWNLOAD_PATH>

Директория для загрузки коллекций.

-r <REQUIREMENTS>, --requirements-file <REQUIREMENTS>

Файл, содержащий список коллекций для загрузки.

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy

создать коллекцию

Создаёт шаблон роли или коллекции, соответствующий формату метаданных Galaxy. Требует имя роли или коллекции. Имя коллекции должно быть в формате <namespace>.<collection>.

--collection-skeleton <COLLECTION_SKELETON>

Путь к шаблону коллекции, на основе которого должна быть создана новая коллекция.

--init-path <INIT_PATH>

Путь, в котором будет создана шаблонная коллекция. По умолчанию текущая рабочая директория.

--timeout <TIMEOUT>

Время ожидания операций с сервером Galaxy, по умолчанию 60 с.

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки проверки сертификата SSL.

-e, --extra-vars

Установить дополнительные переменные в формате ключ=значение или YAML/JSON, если имя файла начинается с @. Этот аргумент может быть указан несколько раз.

-f, --force

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

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy

собрать коллекцию

Собрать артефакт коллекции Ansible Galaxy, который может быть сохранён в центральном репозитории, таком как Ansible Galaxy. По умолчанию эта команда собирает из текущей рабочей директории. Вы можете дополнительно указать путь к входным данным коллекции (где находится файл galaxy.yml).

--output-path <OUTPUT_PATH>

Путь, в котором будет собрана коллекция. По умолчанию текущая рабочая директория.

--timeout <TIMEOUT>

Время ожидания операций с сервером Galaxy, по умолчанию 60 с.

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки проверки сертификата SSL.

-f, --force

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

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy

опубликовать коллекцию

Опубликовать коллекцию в Ansible Galaxy. Требуется путь к архиву tarball коллекции для публикации.

--import-timeout <IMPORT_TIMEOUT>

Время ожидания процесса импорта коллекции.

--no-wait

Не ждать результатов валидации импорта.

--timeout <TIMEOUT>

Время ожидания операций с сервером Galaxy, по умолчанию 60 с.

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки проверки сертификата SSL.

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy

Установка коллекции

Установите одну или несколько ролей(ansible-galaxy role install), или одну или несколько коллекций(ansible-galaxy collection install). Вы можете передать список (ролей или коллекций) или использовать параметр файла, указанный ниже (они взаимоисключающие). Если вы передаете список, это может быть имя (которое будет загружено через API Galaxy и github), или это может быть локальный файл архива tar.

--clear-response-cache

Очистить кэш ответов сервера.

--disable-gpg-verify

Отключить проверку подписи GPG при установке коллекций с сервера Galaxy

--force-with-deps

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

--ignore-signature-status-code

==ПОДАВЛЕНИЕ==. Этот аргумент может быть указан несколько раз.

--ignore-signature-status-codes

Список статусных кодов, которые необходимо игнорировать во время проверки подписи (например, NO_PUBKEY FAILURE). Описания вариантов можно увидеть в L(https://github.com/gpg/gnupg/blob/master/doc/DETAILS#general-status-codes).Обратите: укажите их после позиционных аргументов или используйте – для разделения. Этот аргумент может быть указан несколько раз.

--keyring <KEYRING>

Используемый keyring во время проверки подписи.

--no-cache

Не использовать кэш ответов сервера.

--offline

Установить артефакты коллекции (tarball), не обращаясь к серверам дистрибуции. Это не относится к коллекциям в удаленных репозиториях Git или URL удаленных tarball.

--pre

Включить предварительные версии. Предварительные версии семантической версии по умолчанию игнорируются.

--required-valid-signature-count <REQUIRED_VALID_SIGNATURE_COUNT>

Количество подписей, которые должны успешно проверить коллекцию. Это должно быть положительное целое число или -1, чтобы указать, что все подписи должны быть использованы для проверки коллекции. Добавьте префикс + к значению, чтобы отказать, если для коллекции не найдено ни одной действительной подписи (например, +all).

--signature

Дополнительный источник подписей для проверки подлинности MANIFEST.json перед установкой коллекции с сервера Galaxy. Используйте в сочетании с позиционным именем коллекции (взаимоисключающе с –requirements-file). Этот аргумент может быть указан несколько раз.

--timeout <TIMEOUT>

Время ожидания операций с сервером Galaxy, по умолчанию 60 сек.

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-U, --upgrade

Обновить установленные артефакты коллекции. Это также обновит зависимости, если не указан –no-deps.

-c, --ignore-certs

Игнорировать ошибки проверки сертификатов SSL.

-f, --force

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

-i, --ignore-errors

Игнорировать ошибки во время установки и продолжить с следующей указанной коллекцией. Это не будет игнорировать ошибки конфликта зависимостей.

-n, --no-deps

Не загружать коллекции, указанные как зависимости.

-p <COLLECTIONS_PATH>, --collections-path <COLLECTIONS_PATH>

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

-r <REQUIREMENTS>, --requirements-file <REQUIREMENTS>

Файл, содержащий список коллекций для установки.

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy.

Список коллекций

Отобразить список установленных коллекций или ролей.

--format <OUTPUT_FORMAT>

Формат отображения списка коллекций.

--timeout <TIMEOUT>

Время ожидания операций с сервером Galaxy, по умолчанию 60 сек.

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки проверки сертификатов SSL.

-p, --collections-path

Один или несколько каталогов для поиска коллекций помимо стандартных путей COLLECTIONS_PATHS. Разделяйте несколько путей символом ‘:’. Этот аргумент может быть указан несколько раз.

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy.

collection verify

Сравните контрольные суммы с коллекцией(ями), найденной(ыми) на сервере и установленной копией. Это не проверяет зависимости.

--ignore-signature-status-code

==СУППРИСС==. Этот аргумент можно указывать несколько раз.

--ignore-signature-status-codes

Список кодов состояния, разделяемых пробелами, которые нужно игнорировать во время проверки подписи (например, NO_PUBKEY FAILURE). Описания вариантов можно увидеть в L(https://github.com/gpg/gnupg/blob/master/doc/DETAILS#general-status-codes).Примечание: укажите их после позиционных аргументов или используйте – для разделения. Этот аргумент можно указывать несколько раз.

--keyring <KEYRING>

Используемый keyring во время проверки подписи

--offline

Проверить целостность коллекции локально без обращения к серверу для получения хэша канонического манифеста.

--required-valid-signature-count <REQUIRED_VALID_SIGNATURE_COUNT>

Количество подписей, которые должны успешно проверить коллекцию. Это должно быть положительное целое число или all, чтобы указать, что для проверки коллекции должны быть использованы все подписи. Добавьте префикс + к значению, чтобы произошел отказ, если для коллекции не найдено ни одной действительной подписи (например, +all).

--signature

Дополнительный источник подписи для проверки подлинности MANIFEST.json перед использованием его для проверки остальной части содержимого коллекции с сервера Galaxy. Используйте вместе с позиционным именем коллекции (взаимоисключающе с –requirements-file). Этот аргумент можно указывать несколько раз.

--timeout <TIMEOUT>

Время ожидания операций с сервером Galaxy, по умолчанию 60 с.

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки проверки SSL-сертификатов.

-i, --ignore-errors

Игнорировать ошибки при проверке и продолжить с следующей указанной коллекцией.

-p, --collections-path

Один или несколько каталогов для поиска коллекций помимо стандартных COLLECTIONS_PATHS. Разделяйте несколько путей двоеточием. Этот аргумент можно указывать несколько раз.

-r <REQUIREMENTS>, --requirements-file <REQUIREMENTS>

Файл, содержащий список коллекций, которые нужно проверить.

-s <API_SERVER>, --server <API_SERVER>

URL сервера Galaxy API

роль

Выполнить действие с ролью Ansible Galaxy. Должно быть объединено с дополнительным действием, таким как delete/install/init, как указано ниже.

role init

Создаёт каркас роли или коллекции, соответствующей формату метаданных Galaxy. Требует имени роли или коллекции. Имя коллекции должно быть в формате <namespace>.<collection>.

--init-path <INIT_PATH>

Путь, в котором будет создана скелетная роль. По умолчанию используется текущая рабочая директория.

--offline

Не запрашивать API Galaxy при создании ролей.

--role-skeleton <ROLE_SKELETON>

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

--timeout <TIMEOUT>

Время ожидания операций с сервером Galaxy, по умолчанию 60 сек.

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

--type <ROLE_TYPE>

Инициализировать с использованием альтернативного типа роли. Допустимые типы включают: «container», «apb» и «network».

-c, --ignore-certs

Игнорировать ошибки валидации сертификатов SSL.

-e, --extra-vars

Установить дополнительные переменные в виде ключ=значение или YAML/JSON, если имя файла начинается с @. Этот аргумент можно указывать несколько раз.

-f, --force

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

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy.

role remove

Удаляет список ролей, переданных в качестве аргументов, с локальной системы.

--timeout <TIMEOUT>

Время ожидания операций с сервером Galaxy, по умолчанию 60 сек.

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки валидации сертификатов SSL.

-p, --roles-path

Путь к каталогу, содержащему ваши роли. По умолчанию используется первый доступный путь, настроенный через DEFAULT_ROLES_PATH: {{ ANSIBLE_HOME ~ “/roles:/usr/share/ansible/roles:/etc/ansible/roles” }}. Этот аргумент можно указывать несколько раз.

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy.

role delete

Удаляет роль из Ansible Galaxy.

--timeout <TIMEOUT>

Время ожидания операций с сервером Galaxy, по умолчанию 60 сек.

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки валидации сертификатов SSL.

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy.

role list

Отобразить список установленных коллекций или ролей.

--timeout <TIMEOUT>

Время ожидания операций с сервером Galaxy, по умолчанию 60 сек.

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки валидации сертификатов SSL.

-p, --roles-path

Путь к каталогу, содержащему ваши роли. По умолчанию используется первый доступный путь, настроенный через DEFAULT_ROLES_PATH: {{ ANSIBLE_HOME ~ “/roles:/usr/share/ansible/roles:/etc/ansible/roles” }}. Этот аргумент можно указывать несколько раз.

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy.

role search

Поиск ролей на сервере Ansible Galaxy.

--author <AUTHOR>

Имя пользователя GitHub.

--galaxy-tags <GALAXY_TAGS>

Список тегов Galaxy для фильтрации.

--platforms <PLATFORMS>

Список платформ ОС для фильтрации.

--timeout <TIMEOUT>

Время ожидания операций с сервером Galaxy, по умолчанию 60 сек.

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки валидации сертификатов SSL.

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy.

role import

Используется для импорта роли в Ansible Galaxy.

--branch <REFERENCE>

Имя ветки для импорта. По умолчанию используется основная ветвь репозитория (обычно master).

--no-wait

Не ждать результатов импорта.

--role-name <ROLE_NAME>

Имя роли, если оно отличается от имени репозитория.

--status

Проверить статус последнего запроса на импорт для данного github_user/github_repo.

--timeout <TIMEOUT>

Время ожидания операций с сервером Galaxy, по умолчанию 60 сек.

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки валидации сертификатов SSL.

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy.

Настройка ролей

Настройка интеграции с Github или Travis для ролей Ansible Galaxy

--list

Список всех ваших интеграций.

--remove <REMOVE_ID>

Удаление интеграции, соответствующей предоставленному значению ID. Используйте –list, чтобы увидеть значения ID.

--timeout <TIMEOUT>

Время ожидания операций с сервером galaxy, по умолчанию 60 с.

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки проверки SSL-сертификатов.

-p, --roles-path

Путь к каталогу, содержащему ваши роли. По умолчанию — первый доступный каталог, настроенный через DEFAULT_ROLES_PATH: {{ ANSIBLE_HOME ~ “/roles:/usr/share/ansible/roles:/etc/ansible/roles” }} . Этот аргумент можно указывать несколько раз.

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy

Сведения о роли

Выводит подробную информацию об установленной роли, а также информацию, доступную из API galaxy.

--offline

Не запрашивать API galaxy при создании ролей

--timeout <TIMEOUT>

Время ожидания операций с сервером galaxy, по умолчанию 60 с.

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки проверки SSL-сертификатов.

-p, --roles-path

Путь к каталогу, содержащему ваши роли. По умолчанию — первый доступный каталог, настроенный через DEFAULT_ROLES_PATH: {{ ANSIBLE_HOME ~ “/roles:/usr/share/ansible/roles:/etc/ansible/roles” }} . Этот аргумент можно указывать несколько раз.

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy

Установка ролей

Установка одной или нескольких ролей(ansible-galaxy role install), или одной или нескольких коллекций(ansible-galaxy collection install). Вы можете передать список (ролей или коллекций) или использовать параметр файла, указанный ниже (они взаимоисключающие). Если вы передаёте список, это может быть имя (которое будет загружено через API galaxy и github), или это может быть локальный архив tar.

--force-with-deps

Принудительная перезапись существующей роли и её зависимостей.

--timeout <TIMEOUT>

Время ожидания операций с сервером galaxy, по умолчанию 60 с.

--token <API_KEY>, --api-key <API_KEY>

Ключ API Ansible Galaxy, который можно найти по адресу https://galaxy.ansible.com/me/preferences.

-c, --ignore-certs

Игнорировать ошибки проверки SSL-сертификатов.

-f, --force

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

-g, --keep-scm-meta

Использовать tar вместо scm архива при упаковке роли.

-i, --ignore-errors

Игнорировать ошибки и продолжить с следующей указанной ролью.

-n, --no-deps

Не загружать роли, указанные как зависимости.

-p, --roles-path

Путь к каталогу, содержащему ваши роли. По умолчанию — первый доступный каталог, настроенный через DEFAULT_ROLES_PATH: {{ ANSIBLE_HOME ~ “/roles:/usr/share/ansible/roles:/etc/ansible/roles” }} . Этот аргумент можно указывать несколько раз.

-r <REQUIREMENTS>, --role-file <REQUIREMENTS>

Файл, содержащий список ролей для установки.

-s <API_SERVER>, --server <API_SERVER>

URL сервера API Galaxy

Окружение

Могут быть указаны следующие переменные среды.

ANSIBLE_CONFIG – Переопределяет файл конфигурации ansible по умолчанию

Множество других доступны для большинства опций в ansible.cfg

Файлы

/etc/ansible/ansible.cfg – Файл конфигурации, используется если присутствует

~/.ansible.cfg – Пользовательский файл конфигурации, переопределяет файл конфигурации по умолчанию, если присутствует

Автор

Ansible изначально был написан Майклом ДеХааном.

Полный список авторов см. в файле AUTHORS.

Лицензия

Ansible распространяется на условиях лицензии GPLv3+.

См. также

ansible(1), ansible-config(1), ansible-console(1), ansible-doc(1), ansible-inventory(1), ansible-playbook(1), ansible-pull(1), ansible-vault(1)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/cli/ansible-galaxy.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API