ansible-doc

Синопсис

usage: ansible-doc [-h] [--version] [-v] [-M MODULE_PATH]
                [--playbook-dir BASEDIR]
                [-t {become,cache,callback,cliconf,connection,httpapi,inventory,lookup,netconf,shell,vars,module,strategy,test,filter,role,keyword}]
                [-j] [-r ROLES_PATH]
                [-e ENTRY_POINT | -s | -F | -l | --metadata-dump]
                [--no-fail-on-errors]
                [plugin ...]

Описание

отображает информацию о модулях, установленных в библиотеках Ansible. Он отображает краткий список плагинов и их кратких описаний, предоставляет вывод строк DOCUMENTATION и может создавать короткий «фрагмент», который можно вставить в книгу задач.

Общие опции

--metadata-dump

Только для внутреннего использования Вывод json метаданных для всех записей, игнорирует другие опции.

--no-fail-on-errors

Только для внутреннего использования Используется только для –metadata-dump. Не завершать работу при ошибках. Сообщать сообщение об ошибке в JSON вместо этого.

--playbook-dir <BASEDIR>

Поскольку этот инструмент не использует книги задач, используйте это в качестве замещающего каталога книги задач. Это устанавливает относительный путь для многих функций, включая роли/ group_vars/ и т. д.

--version

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

-F, --list_files

Показать имена плагинов и их исходные файлы без описаний (подразумевает –list). Предоставленный аргумент будет использоваться для фильтрации, может быть именем пространства имен или полным именем коллекции.

-M, --module-path

Добавляет двоеточие, разделенные пути к библиотеке модулей (по умолчанию={{ ANSIBLE_HOME ~ “/plugins/modules:/usr/share/ansible/plugins/modules” }}). Этот аргумент можно указывать несколько раз.

-e <ENTRY_POINT>, --entry-point <ENTRY_POINT>

Выберите точку входа для роли(ей).

-h, --help

отображает это сообщение справки и завершает работу

-j, --json

Изменить вывод на формат json.

-l, --list

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

-r, --roles-path

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

-s, --snippet

Показать фрагмент книги задач для этих типов плагинов: inventory, lookup, module

-t <TYPE>, --type <TYPE>

Выберите тип плагина (по умолчанию «module»). Доступные типы плагинов: (‘become’, ‘cache’, ‘callback’, ‘cliconf’, ‘connection’, ‘httpapi’, ‘inventory’, ‘lookup’, ‘netconf’, ‘shell’, ‘vars’, ‘module’, ‘strategy’, ‘test’, ‘filter’, ‘role’, ‘keyword’)

-v, --verbose

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

Окружение

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

ANSIBLE_LIBRARY – Переопределение пути к библиотеке модулей ansible по умолчанию

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

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

Файлы

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

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

Автор

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

См. файл AUTHORS для полного списка авторов.

Лицензия

Ansible выпущен по лицензии GPLv3+.

См. также

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