Утилита ansible-doc#

Описание#

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

Синтаксис утилиты:

ansible-doc <options> <plugin ...>

Где:

<options> - опции;
<plugin> - плагин.

Настройка утилиты производится с помощью конфигурационного файла /etc/ansible/ansible.cfg, используемого при наличии, и файла конфигурации пользователя ~/.ansible.cfg, переопределяющего конфигурацию по умолчанию, если она присутствует, описанных в разделе «Конфигурационные файлы ansible.cfg».

Опции#

Опции утилиты представлены в таблице ниже.

Опции `ansible-doc`#
Опция	Описание
`--metadata-dump`	Выполнить дамп JSON-метаданных для всех записей; игнорировать другие опции
`--no-fail-on-errors`	Не завершать выполнение при ошибках; используется только для `--metadata-dump`; выводить сообщение об ошибке в JSON
`--playbook-dir <basedir>`	Использовать указанный каталог в качестве каталога playbooks; устанавливает относительный путь для многих функций, включая `roles/`, `group_vars/` и т.д.
`--version`	Показать номер версии утилиты, расположение конфигурационного файла, путь поиска модулей, расположение модуля, расположение исполняемого файла и выйти
`-F`, `--list_files`	Показать имена плагинов и их исходные файлы без сводок (подразумевает `--list`); предоставленный аргумент будет использоваться для фильтрации, может быть namespace или полным именем коллекции
`-M`, `--module-path`	Добавить путь(-и) к библиотеке модулей (по умолчанию `{{ ANSIBLE_HOME ~ "/plugins/modules:/usr/share/ansible/plugins/modules" }}`); этот аргумент может быть указан несколько раз
`-e <entry_point>`, `--entry-point <entry_point>`	Указать точку входа для роли(-ей)
`-h`, `--help`	Показать справочное сообщение и выйти
`-j`, `--json`	Изменить вывод на формат JSON
`-l`, `--list`	Перечислить доступные плагины; предоставленный аргумент будет использоваться для фильтрации, может быть namespace или полным именем коллекции
`-r`, `--roles-path`	Указать путь к каталогу, содержащему роли; этот аргумент может быть указан несколько раз
`-s`, `--snippet`	Показать фрагмент playbook для типов плагинов: `inventory`, `lookup`, `module`
`-t <type>`, `--type <type>`	Выбрать тип плагина (по умолчанию `module`); доступные типы плагинов: `become`, `cache`, `callback`, `cliconf`, `connection`, `httpapi`, `inventory`, `lookup`, `netconf`, `shell`, `vars`, `module`, `strategy`, `test`, `filter`, `role`, `keyword`
`-v`, `--verbose`	Заставить Ansible Core выводить больше отладочных сообщений; увеличение количества `-v` увеличивает уровень подробности, встроенные плагины в настоящее время оценивают до `-vvvvvv`; разумный уровень для начала `-vvv`, отладка подключения может потребовать `-vvvv`; этот аргумент может быть указан несколько раз

Переменные окружения#

Переменные окружения, влияющие на работу утилиты, представлены в таблице ниже.

Переменные окружения `ansible-doc`#
Переменная	Описание
`ANSIBLE_LIBRARY`	Переопределить путь к библиотеке модуля по умолчанию
`ANSIBLE_CONFIG`	Переопределить конфигурационный файл по умолчанию

Другие варианты доступны в качестве параметров ansible.cfg (подробнее - в разделе «Конфигурационные файлы ansible.cfg»).

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

Отобразите список всех доступных плагинов Ansible Core с их именами и исходными файлами:
```
ansible-doc -F
```
Отобразите список всех доступных модулей Ansible Core без подробной информации:
```
ansible-doc -t module -l
```

Дополнительная информация#

Дополнительную информацию можно получить, выполнив команду:

ansible-doc --help