Spec-Zone.ru › Ansible

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

Примечание

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

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

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

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

Обзор

  • Получение хостов инвентаризации из локальной установки VirtualBox.
  • Использует файл конфигурации YAML, который заканчивается на virtualbox.(yml|yaml) или vbox.(yml|yaml).
  • inventory_hostname всегда равен ‘Имя’ виртуальной машины VirtualBox.
  • Группам ВМ можно назначать группы, используя VBoxManage. Несколько групп можно назначить, используя / в качестве разделителя.
  • Отдельный параметр enable_advanced_group_parsing позволяет изменить поведение группировки. Подробности см. в документации по параметрам.

Параметры

Параметр

Комментарии

cache

boolean

Включить/выключить кеширование исходных данных инвентаризации, требует настройки плагина кеша для работы.

Выборы:

  • false ← (по умолчанию)
  • true

Настройка:

  • Запись INI:

    [inventory]
    cache = false
    
  • Переменная среды: ANSIBLE_INVENTORY_CACHE

cache_connection

string

Данные или путь соединения кеша, для подробностей см. документацию плагина кеша.

Настройка:

  • Записи INI:

    [defaults]
    fact_caching_connection = VALUE
    
    [inventory]
    cache_connection = VALUE
    
  • Переменная среды: ANSIBLE_CACHE_PLUGIN_CONNECTION
  • Переменная среды: ANSIBLE_INVENTORY_CACHE_CONNECTION

cache_plugin

string

Плагин кеша для использования с исходными данными инвентаризации.

По умолчанию: "memory"

Настройка:

  • Записи INI:

    [defaults]
    fact_caching = memory
    
    [inventory]
    cache_plugin = memory
    
  • Переменная среды: ANSIBLE_CACHE_PLUGIN
  • Переменная среды: ANSIBLE_INVENTORY_CACHE_PLUGIN

cache_prefix

string

Префикс для использования с файлами/таблицами плагина кеша

По умолчанию: "ansible_inventory_"

Настройка:

  • Записи INI:

    [defaults]
    fact_caching_prefix = ansible_inventory_
    
    [inventory]
    cache_prefix = ansible_inventory_
    
  • Переменная среды: ANSIBLE_CACHE_PLUGIN_PREFIX
  • Переменная среды: ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX

cache_timeout

integer

Время кеширования в секундах

По умолчанию: 3600

Настройка:

  • Записи INI:

    [defaults]
    fact_caching_timeout = 3600
    
    [inventory]
    cache_timeout = 3600
    
  • Переменная среды: ANSIBLE_CACHE_PLUGIN_TIMEOUT
  • Переменная среды: ANSIBLE_INVENTORY_CACHE_TIMEOUT

compose

dictionary

Создать переменные из выражений Jinja2.

По умолчанию: {}

enable_advanced_group_parsing

boolean

added in community.general 9.2.0

Правило парсинга групп по умолчанию (когда эта настройка установлена в false) заключается в разделении группы виртуальной машины VirtualBox по символу / и присвоении получившихся элементов списка в качестве группы Ansible.

Установка enable_advanced_group_parsing=true изменяет это поведение, чтобы соответствовать интерпретации групп VirtualBox в соответствии с https://www.virtualbox.org/manual/UserManual.html#gui-vmgroups. Группы теперь разделяются с помощью символа ,, а символ / обозначает вложенные группы.

При включении, виртуальная машина, настроенная с помощью VBoxManage modifyvm "vm01" --groups "/TestGroup/TestGroup2,/TestGroup3", приведет к тому, что группа TestGroup2 будет дочерней группой TestGroup; и виртуальная машина будет частью TestGroup2 и TestGroup3.

Выборы:

  • false ← (по умолчанию)
  • true

groups

dictionary

Добавление хостов в группу на основе условных выражений Jinja2.

По умолчанию: {}

keyed_groups

list / elements=dictionary

Добавление хостов в группу на основе значений переменной.

По умолчанию: []

default_value

string

added in ansible-core 2.12

Значение по умолчанию, когда значение переменной хоста пустая строка.

Этот параметр несовместим с keyed_groups[].trailing_separator.

key

string

Ключ из входного словаря, используемый для создания групп

parent_group

string

родительская группа для группировки по ключу

prefix

string

Имя группы по ключу начнётся с этого префикса

По умолчанию: ""

separator

string

Разделитель, используемый для создания имени группы по ключу

По умолчанию: "_"

trailing_separator

boolean

added in ansible-core 2.12

Установите это значение в False, чтобы исключить keyed_groups[].separator после переменной хоста, когда значение пустая строка.

Этот параметр взаимоисключающий с keyed_groups[].default_value.

Возможные значения:

  • false
  • true ← (по умолчанию)

leading_separator

boolean

added in ansible-core 2.11

Используется совместно с keyed_groups.

По умолчанию, группа с ключом, у которой нет префикса или разделителя, будет иметь имя, начинающееся с подчеркивания.

Это потому, что по умолчанию префикс — «» а разделитель «_».

Установите этот параметр в значение False, чтобы исключить ведущий подчеркивание (или другой разделитель), если не задан префикс.

Если имя группы получено из отображения, разделитель по-прежнему используется для конкатенации элементов.

Чтобы вообще не использовать разделитель в имени группы, установите разделитель для группы с ключом в пустую строку.

Возможные значения:

  • false
  • true ← (по умолчанию)

network_info_path

string

путь к свойству для запроса сетевой информации (ansible_host)

По умолчанию: "/VirtualBox/GuestInfo/Net/0/V4/IP"

plugin

string / обязательно

токен, который гарантирует, что это файл источника для плагина «virtualbox»

Возможные значения:

  • "virtualbox"
  • "community.general.virtualbox"

query

dictionary

создание переменных из свойств virtualbox

По умолчанию: {}

running_only

boolean

переключает отображение всех ВМ или только тех, которые в данный момент запущены

Возможные значения:

  • false ← (по умолчанию)
  • true

settings_password_file

string

предоставьте файл, содержащий пароль настроек (эквивалент –settingspwfile)

strict

boolean

Если yes делать недопустимые записи фатальной ошибкой, иначе пропустить и продолжить.

Так как возможно использовать факты в выражениях, они могут не всегда быть доступны, и мы игнорируем эти ошибки по умолчанию.

Возможные значения:

  • false ← (по умолчанию)
  • true

use_extra_vars

boolean

added in ansible-core 2.11

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

Возможные значения:

  • false ← (по умолчанию)
  • true

Настройка:

  • Запись INI:

    [inventory_plugins]
    use_extra_vars = false
    
  • Переменная среды: 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)"

Авторы

  • Неизвестно

Подсказка

Записи конфигурации для каждого типа записи имеют порядок приоритета снизу вверх. Например, переменная, которая находится ниже в списке, переопределит переменную, которая находится выше.

Ссылки на сборку

  • Система отслеживания ошибок
  • Репозиторий (источники)
  • Задать вопрос о помощи
  • Отправить отчет об ошибке
  • Запросить функцию
  • Общение

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API