ansible-doc

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

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

Краткое описание

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

Описание

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

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

--version

показать номер версии программы и выйти

-F, --list_files

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

-M, --module-path

предваряет двоеточием разделенные пути к библиотеке модулей (по умолчанию =[‘/home/jenkins/.ansible/plugins/modules’, ‘/usr/share/ansible/plugins/modules’])

-a, --all

Только для внутренних тестов Отобразить документацию для всех плагинов.

-h, --help

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

-j, --json

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

-l, --list

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

-s, --snippet

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

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

Выбор типа плагина (по умолчанию «модуль»)

-v, --verbose

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

Окружение

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

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

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

Файлы

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

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

Автор

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

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

Авторские права

Copyright © 2017 Red Hat, Inc | Ansible.

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