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,test,filter,role,keyword}]
                [-j] [-r ROLES_PATH] [-e ENTRY_POINT | -s | -F | -l |
                --metadata-dump] [--no-fail-on-errors]
                [plugin ...]

Описание

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

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

--metadata-dump

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

--no-fail-on-errors

Только для внутреннего использования Используется только с параметром –metadata-dump. Не завершать работу с ошибкой при возникновении ошибок. Вместо этого включить сообщение об ошибке в JSON.

--playbook-dir <BASEDIR>

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

--version

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

-F, --list_files

Показать имена плагинов и исходные файлы без кратких описаний (подразумевает –list). Указанный аргумент используется для фильтрации; это может быть пространство имён или полное имя коллекции.

-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

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

-r, --roles-path

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

-s, --snippet

Показать фрагмент плейбука для следующих типов плагинов: 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 выводить больше отладочных сообщений. Чем больше раз указан параметр -v, тем подробнее вывод; встроенные плагины в настоящее время поддерживают до -vvvvvv. Для начала разумно использовать уровень -vvv; для отладки соединения может потребоваться -vvvv. Этот аргумент можно указывать несколько раз.

Окружение

Можно указать следующие переменные окружения.

ANSIBLE_LIBRARY – Переопределяет путь к библиотеке модулей Ansible по умолчанию

ANSIBLE_CONFIG – Переопределяет файл конфигурации Ansible по умолчанию

Для большинства параметров в ansible.cfg доступны многие другие переменные

Файлы

/etc/ansible/ansible.cfg – Файл конфигурации, используется, если существует

~/.ansible.cfg – Пользовательский файл конфигурации; при наличии переопределяет конфигурацию по умолчанию

Автор

Первоначально Ansible был написан Майклом ДеХааном.

Полный список участников проекта приведён в файле AUTHORS.

Лицензия

Ansible распространяется на условиях лицензии GPLv3+.

См. также

ansible(1), ansible-config(1), ansible-console(1), ansible-galaxy(1), ansible-inventory(1), ansible-playbook(1), ansible-pull(1), ansible-vault(1)