ansible-doc

инструмент документации плагинов

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

Обзор

ansible-doc [-l|-F|-s] [options] [-t <plugin type> ] [plugin]

Описание

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

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

--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’, ‘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),