community.general.virtualbox – virtualbox inventory source

Примечание

Этот плагин входит в коллекцию community.general (версия 2.0.1).

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

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

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

Обзор

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

Параметры

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

use_extra_vars

boolean

добавлен в 2.11 ansible.builtin

Варианты:

no ←
yes

записи ini:

[inventory_plugins]
use_extra_vars = no

переменная среды:ANSIBLE_INVENTORY_USE_EXTRA_VARS

Слияние дополнительных переменных в доступные переменные для композиции (наивысший приоритет).

Примеры

# 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/virtualbox_inventory.html