Чтение документации с ansible-doc

Команда ansible-doc показывает полную документацию модулей прямо в оболочке, поэтому Вам не придётся покидать терминал, чтобы найти нужную информацию.

Передайте имя модуля, чтобы прочитать его документацию: каждый параметр, его тип и информацию о том, является ли он обязательным. Это самый быстрый способ изучить модуль.

В выводе перечислены все параметры с описанием, значением по умолчанию и доступными вариантами. Так Вы точно узнаете, какие ключи принимает модуль.

Добавьте -s, чтобы вывести готовый для копирования фрагмент аргументов модуля. Это отличная отправная точка для нового задания.

Запустите команду с -l, чтобы вывести список всех установленных модулей с краткими описаниями в одну строку. Пропустите вывод через grep, чтобы найти нужный модуль.

Не уверены в названии? Выведите список модулей и отфильтруйте его по теме. Поиск по слову service быстро покажет подходящие модули.

Поскольку ansible-doc читает модули, установленные локально, документация всегда соответствует именно Вашей версии. Риск открыть устаревшую страницу в интернете отсутствует.

В документации также описано, что возвращает модуль, например changed или stdout. Это помогает, когда Вы регистрируете результаты для последующего использования.

Используйте -t, чтобы читать документацию и для других типов плагинов, а не только для модулей. Например, таким же способом можно найти плагин поиска или фильтра.

В заголовке документации указаны коллекция и краткое назначение модуля, поэтому перед написанием задания Вы знаете его полное имя.

Прежде чем угадывать аргумент, сначала проверьте ansible-doc. Десятисекундный поиск сэкономит Вам неудачный запуск и непонятное сообщение об ошибке.

Вам нужен быстрый фрагмент аргументов модуля для копирования и вставки, а не полное руководство.

ansible-doc показывает в терминале документацию для установленной версии: используйте его для поиска модуля, -s — для получения фрагмента, а -l — для вывода списка и поиска. 📚