ansible-galaxy

collection download

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

--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

collection init

Создает каркас роли или коллекции, соответствующий формату метаданных 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

Задать дополнительные переменные в формате key=value или YAML/JSON; если указан файл, добавьте перед его именем символ @. Этот аргумент можно указать несколько раз.

-f, --force

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

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

URL-адрес сервера API Galaxy

collection build

Собрать артефакт коллекции 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

collection publish

Опубликовать коллекцию в Ansible Galaxy. Требуется указать путь к публикуемому tar-архиву коллекции.

--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

collection install

Установить одну или несколько ролей(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

==SUPPRESS==. Этот аргумент можно указать несколько раз.

--ignore-signature-status-codes

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

--keyring <KEYRING>

Связка ключей, используемая при проверке подписи

--no-cache

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

--offline

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

--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

collection list

Вывести список установленных коллекций или ролей

--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

==SUPPRESS==. Этот аргумент можно указать несколько раз.

--ignore-signature-status-codes

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

--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-адрес сервера API Galaxy

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

Задать дополнительные переменные в формате key=value или 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

role setup

Настроить интеграцию с 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

role info

выводит подробную информацию об установленной роли, а также сведения, доступные через 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

role install

Установить одну или несколько ролей(ansible-galaxy role install) либо одну или несколько коллекций(ansible-galaxy collection install). Можно передать список (ролей или коллекций) либо использовать параметр file, указанный ниже (эти варианты взаимоисключающие). Если передан список, его элементы могут быть именами (загружаемыми через 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