ansible-doc

ansible-doc#

Утилита ansible-doc используется для просмотра документации по расширениям, модулям (как тип расширения) и другим компонентам Ansible прямо из командной строки.

В минимальном формате запуск утилиты ansible-doc выглядит следующим образом:

ansible-doc [ARGUMENTS] [PLUGIN]

где:

  • OPTIONS – аргументы ansible-doc.

  • PLUGIN – название расширения или модуля (тип расширения по умолчанию), для которого нужно вывести документацию.

    Если PLUGIN не указан, будет показан список доступных расширений.

Аргументы утилиты:

--metadata-dump#

Предупреждение

Только для тестовых сред!

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

--no-fail-on-errors#

Предупреждение

Только для тестовых сред!

Используется совместно с --metadata-dump.

Выполнение команды не завершается с ошибкой, если они возникли. Их вывод записывается в JSON.

--playbook-dir <BASEDIR>#

Каталог, который будет использоваться в качестве замены каталога сценариев. Замена влияет на относительные пути к ролям, групповыми переменным и другим ресурсам.

--version#

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

-F, --list_files#

Вывод списка названий расширений и соответствующих им файлов.

-M, --module-path#

Путь к каталогу с модулями Ansible.

Может быть указан несколько раз.

Значение по умолчанию: ~/.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#

Вывод фрагмента сценария. Работает для следующих типов расширений:

  • inventory;

  • lookup;

  • module.

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

Тип расширения, документацию по которому нужно отобразить.

Доступные типы:

Тип

Описание

become

Методы повышения привилегий.

cache

Расширения кеширования.

callback

Расширения типа callback.

cliconf

Расширения для настройки сетевого CLI.

connection

Расширения подключения.

httpapi

Расширения HTTP API.

inventory

Расширения инвентаря.

lookup

Расширения типа lookup.

netconf

Расширения Netconf.

shell

Расширения оболочки.

vars

Расширения переменных.

module

Расширения (по умолчанию).

strategy

Стратегии выполнения.

test

Тестовые расширения.

filter

Фильтры Jinja2.

role

Роли.

keyword

Ключевые слова набора сценариев.
-v, --verbose#

Включение подробного вывода, показывающего больше информации о выполнении команды.

Увеличение уровня детализации возможно при добавлении нескольких -v. Утилита может выводить до -vvvvvv. Рекомендуемый уровень для общей отладки – -vvv, для отладки соединений – -vvvv.

Примеры использования:

Получение документации по модулю file#
ansible-doc file
Вывод списка всех модулей#
ansible-doc -l
Вывод списка всех расширений типа callback#
ansible-doc -t callback -l
Фильтрация модулей по ключевому слову#
ansible-doc -k "copy"
Вывод примера использования модуля yum#
ansible-doc -s yum