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

Описание

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

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

--metadata-dump

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

--playbook-dir <BASEDIR>

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

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

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