ansible-doc

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

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

Cводка

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,role,keyword}]
                [-j] [-r ROLES_PATH]
                [-F | -l | -s | --metadata-dump | -e ENTRY_POINT]
                [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)

-e <ENTRY_POINT>, --entry-point <ENTRY_POINT>

Выбор точки входа для роли(ей).

-h, --help

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

-j, --json

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

-l, --list

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

-r, --roles-path

Путь к каталогу, содержащему ваши роли.

-s, --snippet

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

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

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

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