ansible-doc

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

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

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

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

Описание

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

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

--version

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

-F, --list_files

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

-M, --module-path

добавить двоеточием разделенные путь(и) к библиотеке модулей (по умолчанию [‘/root/.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 для полного списка авторов.

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

Авторские права © 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),