community.general.virtualbox – источник инвентаризации virtualbox

Примечание

Этот плагин входит в сборку community.general (версия 1.3.2).

Для его установки используйте: ansible-galaxy collection install community.general

Для использования в плейбуке укажите: community.general.virtualbox

Обзор
Параметры
Примеры

Обзор

Получение хостов инвентаризации из локальной установки VirtualBox.
Использует файл конфигурации YAML, который заканчивается на virtualbox.(yml|yaml) или vbox.(yml|yaml).
inventory_hostname всегда является значением «Name» экземпляра VirtualBox.

Параметры

Параметр	Варианты/Значения по умолчанию	Конфигурация	Комментарии
cache логический	Варианты: нет ← да	записи ini: [inventory] cache = нет переменная среды:ANSIBLE_INVENTORY_CACHE	Включает/выключает кэширование данных источника инвентаризации; требует настройки плагина кэша для работы.
cache_connection строка		записи ini: [defaults] fact_caching_connection = None [inventory] cache_connection = None переменная среды:ANSIBLE_CACHE_PLUGIN_CONNECTION переменная среды:ANSIBLE_INVENTORY_CACHE_CONNECTION	Данные или путь подключения к кэшу; см. документацию плагина кэша для получения подробной информации.
cache_plugin строка	По умолчанию: "память"	записи ini: [defaults] fact_caching = память [inventory] cache_plugin = память переменная среды:ANSIBLE_CACHE_PLUGIN переменная среды:ANSIBLE_INVENTORY_CACHE_PLUGIN	Плагин кэша для данных источника инвентаризации.
cache_prefix строка	По умолчанию: "ansible_inventory_"	записи ini: [default] fact_caching_prefix = ansible_inventory_ [inventory] cache_prefix = ansible_inventory_ переменная среды:ANSIBLE_CACHE_PLUGIN_PREFIX переменная среды:ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX	Префикс для использования в файлах/таблицах плагина кэша.
cache_timeout целое число	По умолчанию: 3600	записи ini: [defaults] fact_caching_timeout = 3600 [inventory] cache_timeout = 3600 переменная среды:ANSIBLE_CACHE_PLUGIN_TIMEOUT переменная среды:ANSIBLE_INVENTORY_CACHE_TIMEOUT	Срок действия кэша в секундах
compose словарь	По умолчанию: {}		Создание переменных из выражений Jinja2.
groups словарь	По умолчанию: {}		Добавление хостов в группу на основе условных выражений Jinja2.
keyed_groups список / элементы=строка	По умолчанию: []		Добавление хостов в группу на основе значений переменной.
network_info_path строка	По умолчанию: "/VirtualBox/GuestInfo/Net/0/V4/IP"		Путь к свойству для запроса сетевой информации (ansible_host).
plugin строка / обязательно	Варианты: virtualbox community.general.virtualbox		Токен, гарантирующий, что это файл источника для плагина 'virtualbox'.
query словарь	По умолчанию: {}		Создание переменных из свойств VirtualBox.
running_only логический	Варианты: нет ← да		Переключает отображение всех ВМ или только запущенных.
settings_password_file строка			Укажите файл, содержащий пароль настроек (эквивалентно --settingspwfile).
strict логический	Варианты: нет ← да		Если `yes`, то невалидные записи будут вызывать ошибку, в противном случае будут пропущены и обработка продолжится. Так как фактические данные могут использоваться в выражениях, они могут быть недоступны, и по умолчанию эти ошибки игнорируются.

Примеры

# file must be named vbox.yaml or vbox.yml
simple_config_file:
    plugin: community.general.virtualbox
    settings_password_file: /etc/virtulbox/secrets
    query:
      logged_in_users: /VirtualBox/GuestInfo/OS/LoggedInUsersList
    compose:
      ansible_connection: ('indows' in vbox_Guest_OS)|ternary('winrm', 'ssh')

# add hosts (all match with minishift vm) to the group container if any of the vms are in ansible_inventory'
plugin: community.general.virtualbox
groups:
  container: "'minis' in (inventory_hostname)"

Авторы

Неизвестно (!UNKNOWN)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/virtualbox_inventory.html