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,module,strategy,vars}]
                [-j] [-F | -l | -s | --metadata-dump]
                [plugin [plugin ...]]

Описание

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

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

--metadata-dump

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

--playbook-dir <BASEDIR>

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

--version

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

-F, --list_files

Отобразить имена плагинов и их исходные файлы без описаний (подразумевает –list)

-M, --module-path

добавляет двоеточием разделенные пути к библиотеке модулей (по умолчанию=~/.ansible/plugins/modules:/usr/share/ansible/plugins/modules)

-h, --help

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

-j, --json

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

-l, --list

Список доступных плагинов

-s, --snippet

Показать фрагмент книги задач для указанного(ых) плагина(ов)

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

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

-v, --verbose

режим подробного отображения (-vvv для большего, -vvvv для включения отладки соединения)

Окружение

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

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-galaxy(1), ansible-inventory(1), ansible-playbook(1), ansible-pull(1), ansible-vault(1),