Утилита ansible-inventory#

Описание#

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

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

ansible-inventory <options> <group>

Где:

<options> - опции;
<group> - группа хостов.

Настройка утилиты производится с помощью файлов, описанных в разделах:

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

Опции#

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

Опции `ansible-inventory`#
Опция	Описание
`--export`	Представить вывод в формате, оптимизированном для экспорта, а не как точное представление того, как Ansible Core его обработал, при выполнении `--list`
`--graph`	Создать граф inventory; если указан шаблон, он должен быть допустимым именем группы. Ограничения игнорируются
`--host '<host>'`	Вывести информацию о конкретном хосте; работает как скрипт inventory. Ограничения игнорируются
`--list`	Вывести информацию обо всех хостах; работает как скрипт inventory
`--output '<output_file>'`	При выполнении `--list` отправить inventory в файл вместо вывода на экран
`--playbook-dir '<basedir>'`	Использовать указанный аргумент как замену каталога playbooks; устанавливает относительный путь для многих функций, включая `roles/`, `group_vars/` и т.д.
`--toml`	Использовать формат TOML вместо стандартного JSON; игнорируется для `--graph`
`--vars`	Добавить переменные к отображению графа; игнорируется, если не используется с `--graph`
`--vault-id`	Указать идентификатор хранилища для использования; может быть указан несколько раз
`--vault-password-file`, `--vault-pass-file`	Указать файл пароля для хранилища
`--version`	Показать номер версии утилиты, местоположение конфигурационного файла, настроенный путь поиска модулей, местоположение модуля, местоположение исполняемого файла и выйти
`-J`, `--ask-vault-password`, `--ask-vault-pass`	Запросить пароль для хранилища
`-e`, `--extra-vars`	Установить дополнительные переменные в формате «ключ=значение» или YAML/JSON; если имя файла, то с префиксом `@`. Может быть указан несколько раз
`-h`, `--help`	Показать справку и выйти
`-i`, `--inventory`, `--inventory-file`	Указать путь к inventory хостов или список хостов, разделенных запятыми. Может быть указан несколько раз
`-l '<subset>'`, `--limit '<subset>'`	Ограничить выбранные хосты дополнительным шаблоном
`-v`, `--verbose`	Заставить Ansible Core выводить больше отладочных сообщений. Добавление нескольких `-v` увеличивает уровень подробности; разумный уровень для начала - `-vvv`, отладка соединения может потребовать `-vvvv`. Может быть указан несколько раз
`-y`, `--yaml`	Использовать формат YAML вместо стандартного JSON; игнорируется для `--graph`

Аргументом для опций может выступать group - имя группы в inventory, актуально при использовании --graph.

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

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

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

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

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

Отобразите стандартный inventory:
```
ansible-inventory --list
```

Отобразите пользовательский inventory:

ansible-inventory --list --inventory <path_to_file_or_script_or_directory>

Отобразите стандартный inventory в YAML:
```
ansible-inventory --list --yaml
```
Сохраните стандартный inventory в файл:
```
ansible-inventory --list --output <path_to_file>
```

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

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

ansible-inventory --help